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

	const Widget *wi = w->widget;

    70

	uint i = 0;

    71

    72

	for (i = 0; wi->type != WWT_LAST; i++, wi++) {

    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

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

   105

   106

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

   107

		if (IsWidgetDisabled(wi)) return;

   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

			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 z-value of a window. A window must already be open

   291

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

   292

Window **FindWindowZPosition(const Window *w)

   293

{

   294

	Window **wz;

   295

   296

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

   297

		assert(wz < _last_z_window);

   298

		if (*wz == w) return wz;

   299

	}

   300

}

   301

   302

void DeleteWindow(Window *w)

   303

{

   304

	Window **wz;

   305

	if (w == NULL) return;

   306

   307

	if (_thd.place_mode != VHM_NONE &&

   308

			_thd.window_class == w->window_class &&

   309

			_thd.window_number == w->window_number) {

   310

		ResetObjectToPlace();

   311

	}

   312

   313

	CallWindowEventNP(w, WE_DESTROY);

   314

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

   315

   316

	SetWindowDirty(w);

   317

	free(w->widget);

   318

	w->widget = NULL;

   319

   320

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

   321

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

   322

	wz = FindWindowZPosition(w);

   323

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

   324

	_last_z_window--;

   325

}

   326

   327

Window *FindWindowById(WindowClass cls, WindowNumber number)

   328

{

   329

	Window* const *wz;

   330

   331

	FOR_ALL_WINDOWS(wz) {

   332

		Window *w = *wz;

   333

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

   334

	}

   335

   336

	return NULL;

   337

}

   338

   339

void DeleteWindowById(WindowClass cls, WindowNumber number)

   340

{

   341

	DeleteWindow(FindWindowById(cls, number));

   342

}

   343

   344

void DeleteWindowByClass(WindowClass cls)

   345

{

   346

	Window* const *wz;

   347

   348

restart_search:

   349

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

   350

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

   351

	 * anywhere in the z-array */

   352

	FOR_ALL_WINDOWS(wz) {

   353

		Window *w = *wz;

   354

		if (w->window_class == cls) {

   355

			DeleteWindow(w);

   356

			goto restart_search;

   357

		}

   358

	}

   359

}

   360

   361

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

   362

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

   363

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

   364

 * @param id PlayerID player identifier */

   365

void DeletePlayerWindows(PlayerID id)

   366

{

   367

	Window* const *wz;

   368

   369

restart_search:

   370

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

   371

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

   372

	 * anywhere in the z-array */

   373

	FOR_ALL_WINDOWS(wz) {

   374

		Window *w = *wz;

   375

		if (w->caption_color == id) {

   376

			DeleteWindow(w);

   377

			goto restart_search;

   378

		}

   379

	}

   380

   381

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

   382

	DeleteWindowById(WC_BUY_COMPANY, id);

   383

}

   384

   385

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

   386

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

   387

 * that need to be deleted once takeover is complete

   388

 * @param old_player PlayerID of original owner of the window

   389

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

   390

void ChangeWindowOwner(PlayerID old_player, PlayerID new_player)

   391

{

   392

	Window* const *wz;

   393

   394

	FOR_ALL_WINDOWS(wz) {

   395

		Window *w = *wz;

   396

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

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

   407

   408

		w->caption_color = new_player;

   409

	}

   410

}

   411

   412

static void BringWindowToFront(const Window *w);

   413

   414

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

   415

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

   416

 * "activation"

   417

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

   418

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   419

{

   420

	Window *w = FindWindowById(cls, number);

   421

   422

	if (w != NULL) {

   423

		w->flags4 |= WF_WHITE_BORDER_MASK;

   424

		BringWindowToFront(w);

   425

		SetWindowDirty(w);

   426

	}

   427

   428

	return w;

   429

}

   430

   431

static inline bool IsVitalWindow(const Window *w)

   432

{

   433

	WindowClass wc = w->window_class;

   434

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

   435

}

   436

   437

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

   438

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

   439

 * - Toolbar, Statusbar (always on)

   440

 * - New window, Chatbar (only if open)

   441

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

   442

 * @param w window that is put into the foreground

   443

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

   444

 */

   445

static void BringWindowToFront(const Window *w)

   446

{

   447

	Window *tempz;

   448

	Window **wz = FindWindowZPosition(w);

   449

	Window **vz = _last_z_window;

   450

   451

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

   452

	do {

   453

		if (--vz < _z_windows) return;

   454

	} while (IsVitalWindow(*vz));

   455

   456

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

   457

	assert(wz < vz);

   458

   459

	tempz = *wz;

   460

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

   461

	*vz = tempz;

   462

   463

	SetWindowDirty(w);

   464

}

   465

   466

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

   467

 * Keep all important windows intact. These are

   468

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

   469

 * - News window, Chatbar (when on)

   470

 * - Any sticked windows since we wanted to keep these

   471

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

   472

 */

   473

static Window *FindDeletableWindow(void)

   474

{

   475

	Window* const *wz;

   476

   477

	FOR_ALL_WINDOWS(wz) {

   478

		Window *w = *wz;

   479

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

   480

			return w;

   481

		}

   482

	}

   483

	return NULL;

   484

}

   485

   486

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

   487

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

   488

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

   489

 * Start finding an appropiate candidate from the lowest z-values (bottom)

   490

 * @see FindDeletableWindow()

   491

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

   492