1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include <stdarg.h>

     5

#include "openttd.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "map.h"

     9

#include "player.h"

    10

#include "window.h"

    11

#include "gfx.h"

    12

#include "viewport.h"

    13

#include "console.h"

    14

#include "variables.h"

    15

#include "table/sprites.h"

    16

#include "genworld.h"

    17

    18

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

    19

static Point _drag_delta;

    20

    21

static Window _windows[25];

    22

Window *_z_windows[lengthof(_windows)];

    23

Window **_last_z_window; ///< always points to the next free space in the z-array

    24

    25

void CDECL SetWindowWidgetsDisabledState(Window *w, bool disab_stat, int widgets, ...)

    26

{

    27

	va_list wdg_list;

    28

    29

	va_start(wdg_list, widgets);

    30

    31

	while (widgets != WIDGET_LIST_END) {

    32

		SetWindowWidgetDisabledState(w, widgets, disab_stat);

    33

		widgets = va_arg(wdg_list, int);

    34

	}

    35

    36

	va_end(wdg_list);

    37

}

    38

    39

void CDECL SetWindowWidgetsHiddenState(Window *w, bool hidden_stat, int widgets, ...)

    40

{

    41

	va_list wdg_list;

    42

    43

	va_start(wdg_list, widgets);

    44

    45

	while (widgets != WIDGET_LIST_END) {

    46

		SetWindowWidgetHiddenState(w, widgets, hidden_stat);

    47

		widgets = va_arg(wdg_list, int);

    48

	}

    49

    50

	va_end(wdg_list);

    51

}

    52

    53

void CDECL SetWindowWidgetsLoweredState(Window *w, bool lowered_stat, int widgets, ...)

    54

{

    55

	va_list wdg_list;

    56

    57

	va_start(wdg_list, widgets);

    58

    59

	while (widgets != WIDGET_LIST_END) {

    60

		SetWindowWidgetLoweredState(w, widgets, lowered_stat);

    61

		widgets = va_arg(wdg_list, int);

    62

	}

    63

    64

	va_end(wdg_list);

    65

}

    66

    67

void RaiseWindowButtons(Window *w)

    68

{

    69

	uint i;

    70

    71

	for (i = 0; i < w->widget_count; i++) {

    72

		if (IsWindowWidgetLowered(w, i)) {

    73

			RaiseWindowWidget(w, i);

    74

			InvalidateWidget(w, i);

    75

		}

    76

	}

    77

}

    78

    79

void HandleButtonClick(Window *w, byte widget)

    80

{

    81

	LowerWindowWidget(w, widget);

    82

	w->flags4 |= 5 << WF_TIMEOUT_SHL;

    83

	InvalidateWidget(w, widget);

    84

}

    85

    86

    87

static void StartWindowDrag(Window *w);

    88

static void StartWindowSizing(Window *w);

    89

    90

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

    91

{

    92

	WindowEvent e;

    93

	const Widget *wi;

    94

    95

	e.we.click.pt.x = x;

    96

	e.we.click.pt.y = y;

    97

	e.event = WE_CLICK;

    98

    99

	if (w->desc_flags & WDF_DEF_WIDGET) {

   100

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

   101

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

   102

   103

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

   104

		if (IsWindowWidgetDisabled(w, e.we.click.widget)) return;

   105

   106

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

   107

   108

		if (wi->type & WWB_MASK) {

   109

			/* special widget handling for buttons*/

   110

			switch (wi->type) {

   111

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   112

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   113

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   114

					HandleButtonClick(w, e.we.click.widget);

   115

					break;

   116

			}

   117

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

   118

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

   119

		}

   120

   121

		if (w->desc_flags & WDF_STD_BTN) {

   122

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

   123

				DeleteWindow(w);

   124

				return;

   125

			}

   126

   127

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

   128

				StartWindowDrag(w);

   129

				return;

   130

			}

   131

		}

   132

   133

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

   134

			StartWindowSizing(w);

   135

			InvalidateWidget(w, e.we.click.widget);

   136

			return;

   137

		}

   138

   139

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

   140

			w->flags4 ^= WF_STICKY;

   141

			InvalidateWidget(w, e.we.click.widget);

   142

			return;

   143

		}

   144

	}

   145

   146

	w->wndproc(w, &e);

   147

}

   148

   149

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

   150

{

   151

	WindowEvent e;

   152

   153

	/* default tooltips handler? */

   154

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   155

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

   156

		if (e.we.click.widget < 0)

   157

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

   158

   159

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

   160

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

   161

			return;

   162

		}

   163

	}

   164

   165

	e.event = WE_RCLICK;

   166

	e.we.click.pt.x = x;

   167

	e.we.click.pt.y = y;

   168

	w->wndproc(w, &e);

   169

}

   170

   171

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

   172

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

   173

 * @param *w Window

   174

 * @param widget the widget where the scrollwheel was used

   175

 * @param wheel scroll up or down

   176

 */

   177

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

   178

{

   179

	const Widget *wi1, *wi2;

   180

	Scrollbar *sb;

   181

   182

	if (widget < 0) return;

   183

   184

	wi1 = &w->widget[widget];

   185

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

   186

   187

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

   188

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

   189

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

   190

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

   191

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

   192

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

   193

   194

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

   195

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

   196

			if (pos != sb->pos) {

   197

				sb->pos = pos;

   198

				SetWindowDirty(w);

   199

			}

   200

		}

   201

	}

   202

}

   203

   204

static void DrawOverlappedWindow(Window* const *wz, int left, int top, int right, int bottom);

   205

   206

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

   207

{

   208

	Window* const *wz;

   209

	DrawPixelInfo bk;

   210

	_cur_dpi = &bk;

   211

   212

	FOR_ALL_WINDOWS(wz) {

   213

		const Window *w = *wz;

   214

		if (right > w->left &&

   215

				bottom > w->top &&

   216

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

   217

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

   218

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

   219

		}

   220

	}

   221

}

   222

   223

static void DrawOverlappedWindow(Window* const *wz, int left, int top, int right, int bottom)

   224

{

   225

	Window* const *vz = wz;

   226

	int x;

   227

   228

	while (++vz != _last_z_window) {

   229

		const Window *v = *vz;

   230

   231

		if (right > v->left &&

   232

				bottom > v->top &&

   233

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

   234

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

   235

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

   236

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

   237

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

   238

				return;

   239

			}

   240

   241

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

   242

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

   243

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

   244

				return;

   245

			}

   246

   247

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

   248

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

   249

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

   250

				return;

   251

			}

   252

   253

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

   254

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

   255

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

   256

				return;

   257

			}

   258

   259

			return;

   260

		}

   261

	}

   262

   263

	{

   264

		DrawPixelInfo *dp = _cur_dpi;

   265

		dp->width = right - left;

   266

		dp->height = bottom - top;

   267

		dp->left = left - (*wz)->left;

   268

		dp->top = top - (*wz)->top;

   269

		dp->pitch = _screen.pitch;

   270

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

   271

		dp->zoom = 0;

   272

		CallWindowEventNP(*wz, WE_PAINT);

   273

	}

   274

}

   275

   276

void CallWindowEventNP(Window *w, int event)

   277

{

   278

	WindowEvent e;

   279

   280

	e.event = event;

   281

	w->wndproc(w, &e);

   282

}

   283

   284

void SetWindowDirty(const Window *w)

   285

{

   286

	if (w == NULL) return;

   287

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

   288

}

   289

   290

/** Find the Window whose parent pointer points to this window

   291

 * @parent w Window to find child of

   292

 * @return return a Window pointer that is the child of w, or NULL otherwise */

   293

static Window *FindChildWindow(const Window *w)

   294

{

   295

	Window* const *wz;

   296

   297

	FOR_ALL_WINDOWS(wz) {

   298

		Window *v = *wz;

   299

		if (v->parent == w) return v;

   300

	}

   301

   302

	return NULL;

   303

}

   304

   305

/** Find the z-value of a window. A window must already be open

   306

 * or the behaviour is undefined but function should never fail */

   307

Window **FindWindowZPosition(const Window *w)

   308

{

   309

	Window **wz;

   310

   311

	for (wz = _z_windows; wz != _last_z_window; wz++) {

   312

		if (*wz == w) return wz;

   313

	}

   314

   315

	DEBUG(misc, 3, "Window (class %d, number %d) is not open, probably removed by recursive calls",

   316

		w->window_class, w->window_number);

   317

	return NULL;

   318

}

   319

   320

void DeleteWindow(Window *w)

   321

{

   322

	Window *v;

   323

	Window **wz;

   324

	if (w == NULL) return;

   325

   326

	/* Delete any children a window might have in a head-recursive manner */

   327

	v = FindChildWindow(w);

   328

	if (v != NULL) DeleteWindow(v);

   329

   330

	if (_thd.place_mode != VHM_NONE &&

   331

			_thd.window_class == w->window_class &&

   332

			_thd.window_number == w->window_number) {

   333

		ResetObjectToPlace();

   334

	}

   335

   336

	CallWindowEventNP(w, WE_DESTROY);

   337

	if (w->viewport != NULL) DeleteWindowViewport(w);

   338

   339

	SetWindowDirty(w);

   340

	free(w->widget);

   341

	w->widget = NULL;

   342

	w->widget_count = 0;

   343

	w->parent = NULL;

   344

   345

	/* Find the window in the z-array, and effectively remove it

   346

	 * by moving all windows after it one to the left */

   347

	wz = FindWindowZPosition(w);

   348

	if (wz == NULL) return;

   349

	memmove(wz, wz + 1, (byte*)_last_z_window - (byte*)wz);

   350

	_last_z_window--;

   351

}

   352

   353

Window *FindWindowById(WindowClass cls, WindowNumber number)

   354

{

   355

	Window* const *wz;

   356

   357

	FOR_ALL_WINDOWS(wz) {

   358

		Window *w = *wz;

   359

		if (w->window_class == cls && w->window_number == number) return w;

   360

	}

   361

   362

	return NULL;

   363

}

   364

   365

void DeleteWindowById(WindowClass cls, WindowNumber number)

   366

{

   367

	DeleteWindow(FindWindowById(cls, number));

   368

}

   369

   370

void DeleteWindowByClass(WindowClass cls)

   371

{

   372

	Window* const *wz;

   373

   374

restart_search:

   375

	/* When we find the window to delete, we need to restart the search

   376

	 * as deleting this window could cascade in deleting (many) others

   377

	 * anywhere in the z-array */

   378

	FOR_ALL_WINDOWS(wz) {

   379

		Window *w = *wz;

   380

		if (w->window_class == cls) {

   381

			DeleteWindow(w);

   382

			goto restart_search;

   383

		}

   384

	}

   385

}

   386

   387

/** Delete all windows of a player. We identify windows of a player

   388

 * by looking at the caption colour. If it is equal to the player ID

   389

 * then we say the window belongs to the player and should be deleted

   390

 * @param id PlayerID player identifier */

   391

void DeletePlayerWindows(PlayerID id)

   392

{

   393

	Window* const *wz;

   394

   395

restart_search:

   396

	/* When we find the window to delete, we need to restart the search

   397

	 * as deleting this window could cascade in deleting (many) others

   398

	 * anywhere in the z-array */

   399

	FOR_ALL_WINDOWS(wz) {

   400

		Window *w = *wz;

   401

		if (w->caption_color == id) {

   402

			DeleteWindow(w);

   403

			goto restart_search;

   404

		}

   405

	}

   406

   407

	/* Also delete the player specific windows, that don't have a player-colour */

   408

	DeleteWindowById(WC_BUY_COMPANY, id);

   409

}

   410

   411

/** Change the owner of all the windows one player can take over from another

   412

 * player in the case of a company merger. Do not change ownership of windows

   413

 * that need to be deleted once takeover is complete

   414

 * @param old_player PlayerID of original owner of the window

   415

 * @param new_player PlayerID of the new owner of the window */

   416

void ChangeWindowOwner(PlayerID old_player, PlayerID new_player)

   417

{

   418

	Window* const *wz;

   419

   420

	FOR_ALL_WINDOWS(wz) {

   421

		Window *w = *wz;

   422

   423

		if (w->caption_color != old_player)      continue;

   424

		if (w->window_class == WC_PLAYER_COLOR)  continue;

   425

		if (w->window_class == WC_FINANCES)      continue;

   426

		if (w->window_class == WC_STATION_LIST)  continue;

   427

		if (w->window_class == WC_TRAINS_LIST)   continue;

   428

		if (w->window_class == WC_ROADVEH_LIST)  continue;

   429

		if (w->window_class == WC_SHIPS_LIST)    continue;

   430

		if (w->window_class == WC_AIRCRAFT_LIST) continue;

   431

		if (w->window_class == WC_BUY_COMPANY)   continue;

   432

		if (w->window_class == WC_COMPANY)       continue;

   433

   434

		w->caption_color = new_player;

   435

	}

   436

}

   437

   438

static void BringWindowToFront(const Window *w);

   439

   440

/** Find a window and make it the top-window on the screen. The window

   441

 * gets a white border for a brief period of time to visualize its

   442

 * "activation"

   443

 * @return a pointer to the window thus activated */

   444

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   445

{

   446

	Window *w = FindWindowById(cls, number);

   447

   448

	if (w != NULL) {

   449

		w->flags4 |= WF_WHITE_BORDER_MASK;

   450

		BringWindowToFront(w);

   451

		SetWindowDirty(w);

   452

	}

   453

   454

	return w;

   455

}

   456

   457

static inline bool IsVitalWindow(const Window *w)

   458

{

   459

	WindowClass wc = w->window_class;

   460

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

   461

}

   462

   463

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

   464

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

   465

 * - Toolbar, Statusbar (always on)

   466

 * - New window, Chatbar (only if open)

   467

 * The window is marked dirty for a repaint if the window is actually moved

   468

 * @param w window that is put into the foreground

   469

 * @return pointer to the window, the same as the input pointer

   470

 */

   471

static void BringWindowToFront(const Window *w)

   472

{

   473

	Window *tempz;

   474

	Window **wz = FindWindowZPosition(w);

   475

	Window **vz = _last_z_window;

   476

   477

	/* Bring the window just below the vital windows */

   478

	do {

   479

		if (--vz < _z_windows) return;

   480

	} while (IsVitalWindow(*vz));

   481

   482

	if (wz == vz) return; // window is already in the right position

   483

	assert(wz < vz);

   484

   485

	tempz = *wz;

   486

	memmove(wz, wz + 1, (byte*)vz - (byte*)wz);

   487

	*vz = tempz;

   488

   489

	SetWindowDirty(w);

   490

}

   491

   492