1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "map.h"

     8

#include "player.h"

     9

#include "window.h"

    10

#include "gfx.h"

    11

#include "viewport.h"

    12

#include "console.h"

    13

#include "variables.h"

    14

    15

// delta between mouse cursor and upper left corner of dragged window

    16

static Point _drag_delta;

    17

    18

void HandleButtonClick(Window *w, byte widget)

    19

{

    20

	w->click_state |= (1 << widget);

    21

	w->flags4 |= 5 << WF_TIMEOUT_SHL;

    22

	InvalidateWidget(w, widget);

    23

}

    24

    25

void DispatchLeftClickEvent(Window *w, int x, int y) {

    26

	WindowEvent e;

    27

	const Widget *wi;

    28

    29

	e.click.pt.x = x;

    30

	e.click.pt.y = y;

    31

	e.event = WE_CLICK;

    32

    33

	if (w->desc_flags & WDF_DEF_WIDGET) {

    34

		e.click.widget = GetWidgetFromPos(w, x, y);

    35

		if (e.click.widget < 0) return; /* exit if clicked outside of widgets */

    36

    37

		wi = &w->widget[e.click.widget];

    38

    39

		/* don't allow any interaction if the button has been disabled */

    40

		if (HASBIT(w->disabled_state, e.click.widget))

    41

			return;

    42

    43

		if (wi->type & 0xE0) {

    44

			/* special widget handling for buttons*/

    45

			switch(wi->type) {

    46

			case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

    47

			case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

    48

				HandleButtonClick(w, e.click.widget);

    49

				break;

    50

			case WWT_NODISTXTBTN:

    51

				break;

    52

			}

    53

		} else if (wi->type == WWT_SCROLLBAR || wi->type == WWT_SCROLL2BAR || wi->type == WWT_HSCROLLBAR) {

    54

			ScrollbarClickHandler(w, wi, e.click.pt.x, e.click.pt.y);

    55

		}

    56

    57

		if (w->desc_flags & WDF_STD_BTN) {

    58

			if (e.click.widget == 0) { /* 'X' */

    59

				DeleteWindow(w);

    60

				return;

    61

			}

    62

    63

			if (e.click.widget == 1) { /* 'Title bar' */

    64

				StartWindowDrag(w); // if not return then w = StartWindowDrag(w); to get correct pointer

    65

				return;

    66

			}

    67

		}

    68

    69

		if (w->desc_flags & WDF_RESIZABLE && wi->type == WWT_RESIZEBOX) {

    70

			StartWindowSizing(w); // if not return then w = StartWindowSizing(w); to get correct pointer

    71

			return;

    72

		}

    73

    74

		if (w->desc_flags & WDF_STICKY_BUTTON && wi->type == WWT_STICKYBOX) {

    75

			TOGGLEBIT(w->click_state, e.click.widget);

    76

			w->flags4 ^= WF_STICKY;

    77

			InvalidateWidget(w, e.click.widget);

    78

			return;

    79

		}

    80

	}

    81

    82

	w->wndproc(w, &e);

    83

}

    84

    85

void DispatchRightClickEvent(Window *w, int x, int y) {

    86

	WindowEvent e;

    87

    88

	/* default tooltips handler? */

    89

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

    90

		e.click.widget = GetWidgetFromPos(w, x, y);

    91

		if (e.click.widget < 0)

    92

			return; /* exit if clicked outside of widgets */

    93

    94

		if (w->widget[e.click.widget].tooltips != 0) {

    95

			GuiShowTooltips(w->widget[e.click.widget].tooltips);

    96

			return;

    97

		}

    98

	}

    99

   100

	e.event = WE_RCLICK;

   101

	e.click.pt.x = x;

   102

	e.click.pt.y = y;

   103

	w->wndproc(w, &e);

   104

}

   105

   106

/** Dispatch the mousewheel-action to the window which will scroll any

   107

 * compatible scrollbars if the mouse is pointed over the bar or its contents

   108

 * @param *w Window

   109

 * @param widget the widget where the scrollwheel was used

   110

 * @param wheel scroll up or down

   111

 */

   112

void DispatchMouseWheelEvent(Window *w, int widget, int wheel)

   113

{

   114

	const Widget *wi1, *wi2;

   115

	Scrollbar *sb;

   116

   117

	if (widget < 0) return;

   118

   119

	wi1 = &w->widget[widget];

   120

	wi2 = &w->widget[widget + 1];

   121

   122

	/* The listbox can only scroll if scrolling was done on the scrollbar itself,

   123

	 * or on the listbox (and the next item is (must be) the scrollbar)

   124

	 * XXX - should be rewritten as a widget-dependent scroller but that's

   125

	 * not happening until someone rewrites the whole widget-code */

   126

	if ((sb = &w->vscroll,  wi1->type == WWT_SCROLLBAR)  || (sb = &w->vscroll2, wi1->type == WWT_SCROLL2BAR)  ||

   127

			(sb = &w->vscroll2, wi2->type == WWT_SCROLL2BAR) || (sb = &w->vscroll, wi2->type == WWT_SCROLLBAR) ) {

   128

   129

		if (sb->count > sb->cap) {

   130

			int pos = clamp(sb->pos + wheel, 0, sb->count - sb->cap);

   131

			if (pos != sb->pos) {

   132

				sb->pos = pos;

   133

				SetWindowDirty(w);

   134

			}

   135

		}

   136

	}

   137

}

   138

   139

   140

void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)

   141

{

   142

	Window *w;

   143

	DrawPixelInfo bk;

   144

	_cur_dpi = &bk;

   145

   146

	for(w=_windows; w!=_last_window; w++) {

   147

		if (right > w->left &&

   148

				bottom > w->top &&

   149

				left < w->left + w->width &&

   150

				top < w->top + w->height) {

   151

				DrawOverlappedWindow(w, left, top, right, bottom);

   152

			}

   153

	}

   154

}

   155

   156

void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom)

   157

{

   158

	Window *v = w;

   159

	int x;

   160

   161

	while (++v != _last_window) {

   162

		if (right > v->left &&

   163

				bottom > v->top &&

   164

				left < v->left + v->width &&

   165

				top < v->top + v->height) {

   166

   167

			if (left < (x=v->left)) {

   168

				DrawOverlappedWindow(w, left, top, x, bottom);

   169

				DrawOverlappedWindow(w, x, top, right, bottom);

   170

				return;

   171

			}

   172

   173

			if (right > (x=v->left + v->width)) {

   174

				DrawOverlappedWindow(w, left, top, x, bottom);

   175

				DrawOverlappedWindow(w, x, top, right, bottom);

   176

				return;

   177

			}

   178

   179

			if (top < (x=v->top)) {

   180

				DrawOverlappedWindow(w, left, top, right, x);

   181

				DrawOverlappedWindow(w, left, x, right, bottom);

   182

				return;

   183

			}

   184

   185

			if (bottom > (x=v->top + v->height)) {

   186

				DrawOverlappedWindow(w, left, top, right, x);

   187

				DrawOverlappedWindow(w, left, x, right, bottom);

   188

				return;

   189

			}

   190

   191

			return;

   192

		}

   193

	}

   194

   195

	{

   196

		DrawPixelInfo *dp = _cur_dpi;

   197

		dp->width = right - left;

   198

		dp->height = bottom - top;

   199

		dp->left = left - w->left;

   200

		dp->top = top - w->top;

   201

		dp->pitch = _screen.pitch;

   202

		dp->dst_ptr = _screen.dst_ptr + top * _screen.pitch + left;

   203

		dp->zoom = 0;

   204

		CallWindowEventNP(w, WE_PAINT);

   205

	}

   206

}

   207

   208

void CallWindowEventNP(Window *w, int event)

   209

{

   210

	WindowEvent e;

   211

   212

	e.event = event;

   213

	w->wndproc(w, &e);

   214

}

   215

   216

void SetWindowDirty(Window *w)

   217

{

   218

	if (w == NULL)

   219

		return;

   220

   221

	SetDirtyBlocks(w->left, w->top, w->left + w->width, w->top + w->height);

   222

}

   223

   224

void DeleteWindow(Window *w)

   225

{

   226

	WindowClass wc;

   227

	WindowNumber wn;

   228

	ViewPort *vp;

   229

	Window *v;

   230

	int count;

   231

   232

	if (w == NULL)

   233

		return;

   234

   235

	if (_thd.place_mode != 0 && _thd.window_class == w->window_class && _thd.window_number == w->window_number) {

   236

		ResetObjectToPlace();

   237

	}

   238

   239

	wc = w->window_class;

   240

	wn = w->window_number;

   241

   242

	CallWindowEventNP(w, WE_DESTROY);

   243

   244

	w = FindWindowById(wc, wn);

   245

   246

	vp = w->viewport;

   247

	w->viewport = NULL;

   248

	if (vp != NULL) {

   249

		_active_viewports &= ~(1 << (vp - _viewports));

   250

		vp->width = 0;

   251

	}

   252

   253

	SetWindowDirty(w);

   254

   255

	free(w->widget);

   256

   257

	v = --_last_window;

   258

	count = (byte*)v - (byte*)w;

   259

	memmove(w, w + 1, count);

   260

}

   261

   262

Window *FindWindowById(WindowClass cls, WindowNumber number)

   263

{

   264

	Window *w;

   265

   266

	for(w=_windows; w!=_last_window; w++) {

   267

		if (w->window_class == cls &&

   268

			  w->window_number == number) {

   269

			return w;

   270

		}

   271

	}

   272

   273

	return NULL;

   274

}

   275

   276

void DeleteWindowById(WindowClass cls, WindowNumber number)

   277

{

   278

	DeleteWindow(FindWindowById(cls, number));

   279

}

   280

   281

void DeleteWindowByClass(WindowClass cls)

   282

{

   283

	Window *w;

   284

	for (w = _windows; w != _last_window;) {

   285

		if (w->window_class == cls) {

   286

			DeleteWindow(w);

   287

			w = _windows;

   288

		} else

   289

			w++;

   290

	}

   291

}

   292

   293

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   294

{

   295

	Window *w = FindWindowById(cls, number);

   296

   297

	if (w != NULL) {

   298

		w->flags4 |= WF_WHITE_BORDER_MASK;

   299

		SetWindowDirty(w);

   300

		w = BringWindowToFront(w);

   301

	}

   302

   303

	return w;

   304

}

   305

   306

static inline bool IsVitalWindow(const Window *w)

   307

{

   308

	WindowClass wc = w->window_class;

   309

	return (wc == WC_MAIN_TOOLBAR || wc == WC_STATUS_BAR || wc == WC_NEWS_WINDOW || wc == WC_SEND_NETWORK_MSG);

   310

}

   311

   312

/** On clicking on a window, make it the frontmost window of all. However

   313

 * there are certain windows that always need to be on-top; these include

   314

 * - Toolbar, Statusbar (always on)

   315

 * - New window, Chatbar (only if open)

   316

 * @param w window that is put into the foreground

   317

 */

   318

Window *BringWindowToFront(Window *w)

   319

{

   320

	Window *v;

   321

	Window temp;

   322

   323

	v = _last_window;

   324

	do {

   325

		if (--v < _windows)

   326

			return w;

   327

	} while (IsVitalWindow(v));

   328

   329

	if (w == v)

   330

		return w;

   331

   332

	assert(w < v);

   333

   334

	temp = *w;

   335

	memmove(w, w + 1, (v - w) * sizeof(Window));

   336

	*v = temp;

   337

   338

	SetWindowDirty(v);

   339

   340

	return v;

   341

}

   342

   343

/** We have run out of windows, so find a suitable candidate for replacement.

   344

 * Keep all important windows intact. These are

   345

 * - Main window (gamefield), Toolbar, Statusbar (always on)

   346

 * - News window, Chatbar (when on)

   347

 * - Any sticked windows since we wanted to keep these

   348

 * @return w pointer to the window that is going to be deleted

   349

 */

   350

static Window *FindDeletableWindow(void)

   351

{

   352

	Window *w;

   353

	for (w = _windows; w < endof(_windows); w++) {

   354

		if (w->window_class != WC_MAIN_WINDOW && !IsVitalWindow(w) && !(w->flags4 & WF_STICKY) )

   355

				return w;

   356

	}

   357

	return NULL;

   358

}

   359

   360

/** A window must be freed, and all are marked as important windows. Ease the

   361

 * restriction a bit by allowing to delete sticky windows. Keep important/vital

   362

 * windows intact (Main window, Toolbar, Statusbar, News Window, Chatbar)

   363

 * @see FindDeletableWindow()

   364

 * @return w Pointer to the window that is being deleted

   365

 */

   366

static Window *ForceFindDeletableWindow(void)

   367

{

   368

	Window *w;

   369

	for (w = _windows;; w++) {

   370

		assert(w < _last_window);

   371

   372

		if (w->window_class != WC_MAIN_WINDOW && !IsVitalWindow(w))

   373

				return w;

   374

	}

   375

}

   376

   377

bool IsWindowOfPrototype(Window *w, const Widget *widget)

   378

{

   379

	return (w->original_widget == widget);

   380

}

   381

   382

/* Copies 'widget' to 'w->widget' to allow for resizable windows */

   383

void AssignWidgetToWindow(Window *w, const Widget *widget)

   384

{

   385

	w->original_widget = widget;

   386

   387

	if (widget != NULL) {

   388

		const Widget *wi = widget;

   389

		uint index = 1;

   390

		while (wi->type != WWT_LAST) {

   391

			wi++;

   392

			index++;

   393

		}

   394

   395

		w->widget = realloc(w->widget, sizeof(Widget) * index);

   396

		memcpy(w->widget, widget, sizeof(Widget) * index);

   397

	} else

   398

		w->widget = NULL;

   399

}

   400

   401

/** Open a new window. If there is no space for a new window, close an open

   402

 * window. Try to avoid stickied windows, but if there is no else, close one of

   403

 * those as well. Then make sure all created windows are below some always-on-top

   404

 * ones. Finally set all variables and call the WE_CREATE event

   405

 * @param x offset in pixels from the left of the screen

   406

 * @param y offset in pixels from the top of the screen

   407

 * @param width width in pixels of the window

   408

 * @param height height in pixels of the window

   409

 * @param *proc @see WindowProc function to call when any messages/updates happen to the window

   410

 * @param cls @see WindowClass class of the window, used for identification and grouping

   411

 * @param *widget @see Widget pointer to the window layout and various elements

   412

 * @return @see Window pointer of the newly created window

   413

 */

   414

Window *AllocateWindow(

   415

							int x, int y, int width, int height,

   416

							WindowProc *proc, WindowClass cls, const Widget *widget)

   417

{

   418

	Window *w = _last_window; // last window keeps track of the highest open window

   419

   420

	// We have run out of windows, close one and use that as the place for our new one

   421

	if (w >= endof(_windows)) {

   422

		w = FindDeletableWindow();

   423

   424

		if (w == NULL) // no window found, force it!

   425

			w = ForceFindDeletableWindow();

   426

   427

		DeleteWindow(w);

   428

		w = _last_window;

   429

	}

   430

   431

	/* XXX - This very strange construction makes sure that the chatbar is always

   432

	 * on top of other windows. Why? It is created as last_window (so, on top).

   433

	 * Any other window will go below toolbar/statusbar/news window, which implicitely

   434

	 * also means it is below the chatbar. Very likely needs heavy improvement

   435

	 * to de-braindeadize */

   436

	if (w != _windows && cls != WC_SEND_NETWORK_MSG) {

   437

		Window *v;

   438

   439

		/* XXX - if not this order (toolbar/statusbar and then news), game would

   440

		 * crash because it will try to copy a negative size for the news-window.

   441

		 * Eg. window was already moved BELOW news (which is below toolbar/statusbar)

   442

		 * and now needs to move below those too. That is a negative move. */

   443

		v = FindWindowById(WC_MAIN_TOOLBAR, 0);

   444

		if (v != NULL) {

   445

			memmove(v+1, v, (byte*)w - (byte*)v);

   446

			w = v;

   447

		}

   448

   449

		v = FindWindowById(WC_STATUS_BAR, 0);

   450

		if (v != NULL) {

   451

			memmove(v+1, v, (byte*)w - (byte*)v);

   452

			w = v;

   453

		}

   454

   455

		v = FindWindowById(WC_NEWS_WINDOW, 0);

   456

		if (v != NULL) {

   457

			memmove(v+1, v, (byte*)w - (byte*)v);

   458

			w = v;

   459

		}

   460

	}

   461

   462

	// Set up window properties

   463

	memset(w, 0, sizeof(Window));

   464

	w->window_class = cls;

   465

	w->flags4 = WF_WHITE_BORDER_MASK; // just opened windows have a white border

   466

	w->caption_color = 0xFF;

   467

	w->left = x;

   468

	w->top = y;

   469

	w->width = width;

   470

	w->height = height;

   471

	w->wndproc = proc;

   472

	AssignWidgetToWindow(w, widget);

   473

	w->resize.width = width;

   474

	w->resize.height = height;

   475

	w->resize.step_width = 1;

   476

	w->resize.step_height = 1;

   477

   478

	_last_window++;

   479

   480

	SetWindowDirty(w);

   481

   482

	CallWindowEventNP(w, WE_CREATE);

   483

   484

	return w;

   485

}

   486

   487

Window *AllocateWindowAutoPlace2(

   488

	WindowClass exist_class,

   489

	WindowNumber exist_num,

   490

	int width,

   491

	int height,

   492

	WindowProc *proc,

   493

	WindowClass cls,

   494

	const Widget *widget)

   495

{

   496

	Window *w;

   497

	int x;

   498

   499

	w = FindWindowById(exist_class, exist_num);

   500

	if (w == NULL || w->left >= (_screen.width-20) || w->left <= -60 || w->top >= (_screen.height-20)) {

   501

		return AllocateWindowAutoPlace(width,height,proc,cls,widget);

   502

	}

   503

   504

	x = w->left;