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

#include "helpers.hpp"

    18

    19

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

    20

static Point _drag_delta;

    21

    22

static Window _windows[25];

    23

Window *_z_windows[lengthof(_windows)];

    24

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

    25

    26

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

    27

{

    28

	va_list wdg_list;

    29

    30

	va_start(wdg_list, widgets);

    31

    32

	while (widgets != WIDGET_LIST_END) {

    33

		SetWindowWidgetDisabledState(w, widgets, disab_stat);

    34

		widgets = va_arg(wdg_list, int);

    35

	}

    36

    37

	va_end(wdg_list);

    38

}

    39

    40

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

    41

{

    42

	va_list wdg_list;

    43

    44

	va_start(wdg_list, widgets);

    45

    46

	while (widgets != WIDGET_LIST_END) {

    47

		SetWindowWidgetHiddenState(w, widgets, hidden_stat);

    48

		widgets = va_arg(wdg_list, int);

    49

	}

    50

    51

	va_end(wdg_list);

    52

}

    53

    54

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

    55

{

    56

	va_list wdg_list;

    57

    58

	va_start(wdg_list, widgets);

    59

    60

	while (widgets != WIDGET_LIST_END) {

    61

		SetWindowWidgetLoweredState(w, widgets, lowered_stat);

    62

		widgets = va_arg(wdg_list, int);

    63

	}

    64

    65

	va_end(wdg_list);

    66

}

    67

    68

void RaiseWindowButtons(Window *w)

    69

{

    70

	uint i;

    71

    72

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

    73

		if (IsWindowWidgetLowered(w, i)) {

    74

			RaiseWindowWidget(w, i);

    75

			InvalidateWidget(w, i);

    76

		}

    77

	}

    78

}

    79

    80

void HandleButtonClick(Window *w, byte widget)

    81

{

    82

	LowerWindowWidget(w, widget);

    83

	w->flags4 |= 5 << WF_TIMEOUT_SHL;

    84

	InvalidateWidget(w, widget);

    85

}

    86

    87

    88

static void StartWindowDrag(Window *w);

    89

static void StartWindowSizing(Window *w);

    90

    91

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

    92

{

    93

	WindowEvent e;

    94

	const Widget *wi;

    95

    96

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

    97

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

    98

	e.event = WE_CLICK;

    99

   100

	if (w->desc_flags & WDF_DEF_WIDGET) {

   101

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

   102

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

   103

   104

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

   105

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

   106

   107

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

   108

   109

		if (wi->type & WWB_MASK) {

   110

			/* special widget handling for buttons*/

   111

			switch (wi->type) {

   112

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   113

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   114

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   115

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

   116

					break;

   117

			}

   118

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

   119

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

   120

		}

   121

   122

		if (w->desc_flags & WDF_STD_BTN) {

   123

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

   124

				DeleteWindow(w);

   125

				return;

   126

			}

   127

   128

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

   129

				StartWindowDrag(w);

   130

				return;

   131

			}

   132

		}

   133

   134

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

   135

			StartWindowSizing(w);

   136

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

   137

			return;

   138

		}

   139

   140

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

   141

			w->flags4 ^= WF_STICKY;

   142

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

   143

			return;

   144

		}

   145

	}

   146

   147

	w->wndproc(w, &e);

   148

}

   149

   150

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

   151

{

   152

	WindowEvent e;

   153

   154

	/* default tooltips handler? */

   155

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   156

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

   157

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

   158

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

   159

   160

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

   161

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

   162

			return;

   163

		}

   164

	}

   165

   166

	e.event = WE_RCLICK;

   167

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

   168

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

   169

	w->wndproc(w, &e);

   170

}

   171

   172

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

   173

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

   174

 * @param *w Window

   175

 * @param widget the widget where the scrollwheel was used

   176

 * @param wheel scroll up or down

   177

 */

   178

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

   179

{

   180

	const Widget *wi1, *wi2;

   181

	Scrollbar *sb;

   182

   183

	if (widget < 0) return;

   184

   185

	wi1 = &w->widget[widget];

   186

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

   187

   188

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

   189

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

   190

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

   191

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

   192

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

   193

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

   194

   195

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

   196

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

   197

			if (pos != sb->pos) {

   198

				sb->pos = pos;

   199

				SetWindowDirty(w);

   200

			}

   201

		}

   202

	}

   203

}

   204

   205

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

   206

   207

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

   208

{

   209

	Window* const *wz;

   210

	DrawPixelInfo bk;

   211

	_cur_dpi = &bk;

   212

   213

	FOR_ALL_WINDOWS(wz) {

   214

		const Window *w = *wz;

   215

		if (right > w->left &&

   216

				bottom > w->top &&

   217

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

   218

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

   219

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

   220

		}

   221

	}

   222

}

   223

   224

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

   225

{

   226

	Window* const *vz = wz;

   227

	int x;

   228

   229

	while (++vz != _last_z_window) {

   230

		const Window *v = *vz;

   231

   232

		if (right > v->left &&

   233

				bottom > v->top &&

   234

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

   235

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

   236

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

   237

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

   238

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

   239

				return;

   240

			}

   241

   242

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

   243

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

   244

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

   245

				return;

   246

			}

   247

   248

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

   249

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

   250

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

   251

				return;

   252

			}

   253

   254

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

   255

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

   256

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

   257

				return;

   258

			}

   259

   260

			return;

   261

		}

   262

	}

   263

   264

	{

   265

		DrawPixelInfo *dp = _cur_dpi;

   266

		dp->width = right - left;

   267

		dp->height = bottom - top;

   268

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

   269

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

   270

		dp->pitch = _screen.pitch;

   271

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

   272

		dp->zoom = 0;

   273

		CallWindowEventNP(*wz, WE_PAINT);

   274

	}

   275

}

   276

   277

void CallWindowEventNP(Window *w, int event)

   278

{

   279

	WindowEvent e;

   280

   281

	e.event = event;

   282

	w->wndproc(w, &e);

   283

}

   284

   285

void SetWindowDirty(const Window *w)

   286

{

   287

	if (w == NULL) return;

   288

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

   289

}

   290

   291

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

   292

 * @parent w Window to find child of

   293

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

   294

static Window *FindChildWindow(const Window *w)

   295

{

   296

	Window* const *wz;

   297

   298

	FOR_ALL_WINDOWS(wz) {

   299

		Window *v = *wz;

   300

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

   301

	}

   302

   303

	return NULL;

   304

}

   305

   306

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

   307

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

   308

Window **FindWindowZPosition(const Window *w)

   309

{

   310

	Window **wz;

   311

   312

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

   313

		if (*wz == w) return wz;

   314

	}

   315

   316

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

   317

		w->window_class, w->window_number);

   318

	return NULL;

   319

}

   320

   321

void DeleteWindow(Window *w)

   322

{

   323

	Window *v;

   324

	Window **wz;

   325

	if (w == NULL) return;

   326

   327

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

   328

	v = FindChildWindow(w);

   329

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

   330

   331

	if (_thd.place_mode != VHM_NONE &&

   332

			_thd.window_class == w->window_class &&

   333

			_thd.window_number == w->window_number) {

   334

		ResetObjectToPlace();

   335

	}

   336

   337

	CallWindowEventNP(w, WE_DESTROY);

   338

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

   339

   340

	SetWindowDirty(w);

   341

	free(w->widget);

   342

	w->widget = NULL;

   343

	w->widget_count = 0;

   344

	w->parent = NULL;

   345

   346

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

   347

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

   348

	wz = FindWindowZPosition(w);

   349

	if (wz == NULL) return;

   350

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

   351

	_last_z_window--;

   352

}

   353

   354

Window *FindWindowById(WindowClass cls, WindowNumber number)

   355

{

   356

	Window* const *wz;

   357

   358

	FOR_ALL_WINDOWS(wz) {

   359

		Window *w = *wz;

   360

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

   361

	}

   362

   363

	return NULL;

   364

}

   365

   366

void DeleteWindowById(WindowClass cls, WindowNumber number)

   367

{

   368

	DeleteWindow(FindWindowById(cls, number));

   369

}

   370

   371

void DeleteWindowByClass(WindowClass cls)

   372

{

   373

	Window* const *wz;

   374

   375

restart_search:

   376

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

   377

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

   378

	 * anywhere in the z-array */

   379

	FOR_ALL_WINDOWS(wz) {

   380

		Window *w = *wz;

   381

		if (w->window_class == cls) {

   382

			DeleteWindow(w);

   383

			goto restart_search;

   384

		}

   385

	}

   386

}

   387

   388

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

   389

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

   390

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

   391

 * @param id PlayerID player identifier */

   392

void DeletePlayerWindows(PlayerID id)

   393

{

   394

	Window* const *wz;

   395

   396

restart_search:

   397

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

   398

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

   399

	 * anywhere in the z-array */

   400

	FOR_ALL_WINDOWS(wz) {

   401

		Window *w = *wz;

   402

		if (w->caption_color == id) {

   403

			DeleteWindow(w);

   404

			goto restart_search;

   405

		}

   406

	}

   407

   408

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

   409

	DeleteWindowById(WC_BUY_COMPANY, id);

   410

}

   411

   412

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

   413

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

   414

 * that need to be deleted once takeover is complete

   415

 * @param old_player PlayerID of original owner of the window

   416

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

   417

void ChangeWindowOwner(PlayerID old_player, PlayerID new_player)

   418

{

   419

	Window* const *wz;

   420

   421

	FOR_ALL_WINDOWS(wz) {

   422

		Window *w = *wz;

   423

   424

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

   425

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

   426

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

   427

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

   428

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

   429

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

   430

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

   431

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

   432

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

   433

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

   434

   435

		w->caption_color = new_player;

   436

	}

   437

}

   438

   439

static void BringWindowToFront(const Window *w);

   440

   441

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

   442

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

   443

 * "activation"

   444

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

   445

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   446

{

   447

	Window *w = FindWindowById(cls, number);

   448

   449

	if (w != NULL) {

   450

		w->flags4 |= WF_WHITE_BORDER_MASK;

   451

		BringWindowToFront(w);

   452

		SetWindowDirty(w);

   453

	}

   454

   455

	return w;

   456

}

   457

   458

static inline bool IsVitalWindow(const Window *w)

   459

{

   460

	WindowClass wc = w->window_class;

   461

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

   462

}

   463

   464

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

   465

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

   466

 * - Toolbar, Statusbar (always on)

   467

 * - New window, Chatbar (only if open)

   468

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

   469

 * @param w window that is put into the foreground

   470

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

   471

 */

   472

static void BringWindowToFront(const Window *w)

   473

{

   474

	Window *tempz;

   475

	Window **wz = FindWindowZPosition(w);

   476

	Window **vz = _last_z_window;

   477

   478

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

   479

	do {

   480

		if (--vz < _z_windows) return;

   481

	} while (IsVitalWindow(*vz));

   482

   483

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

   484

	assert(wz < vz);

   485

   486

	tempz = *wz;

   487

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

   488

	*vz = tempz;

   489

   490

	SetWindowDirty(w);

   491

}