1

/* $Id$ */

     2

     3

/** @file window.cpp Windowing system, widgets and events */

     4

     5

#include "stdafx.h"

     6

#include <stdarg.h>

     7

#include "openttd.h"

     8

#include "debug.h"

     9

#include "player_func.h"

    10

#include "gfx_func.h"

    11

#include "console_func.h"

    12

#include "console_gui.h"

    13

#include "viewport_func.h"

    14

#include "variables.h"

    15

#include "genworld.h"

    16

#include "blitter/factory.hpp"

    17

#include "window_gui.h"

    18

#include "zoom_func.h"

    19

#include "core/alloc_func.hpp"

    20

#include "map_func.h"

    21

#include "vehicle_base.h"

    22

#include "settings_type.h"

    23

#include "cheat_func.h"

    24

#include "window_func.h"

    25

#include "tilehighlight_func.h"

    26

#include "network/network.h"

    27

    28

#include "table/sprites.h"

    29

    30

static Point _drag_delta; ///< delta between mouse cursor and upper left corner of dragged window

    31

static Window *_mouseover_last_w = NULL; ///< Window of the last MOUSEOVER event

    32

    33

/**

    34

 * List of windows opened at the screen.

    35

 * Uppermost window is at  _z_windows[_last_z_window - 1],

    36

 * bottom window is at _z_windows[0]

    37

 */

    38

Window *_z_windows[MAX_NUMBER_OF_WINDOWS];

    39

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

    40

    41

byte _no_scroll;

    42

Point _cursorpos_drag_start;

    43

    44

int _scrollbar_start_pos;

    45

int _scrollbar_size;

    46

byte _scroller_click_timeout;

    47

    48

bool _scrolling_scrollbar;

    49

bool _scrolling_viewport;

    50

    51

byte _special_mouse_mode;

    52

    53

    54

void CDECL Window::SetWidgetsDisabledState(bool disab_stat, int widgets, ...)

    55

{

    56

	va_list wdg_list;

    57

    58

	va_start(wdg_list, widgets);

    59

    60

	while (widgets != WIDGET_LIST_END) {

    61

		SetWidgetDisabledState(widgets, disab_stat);

    62

		widgets = va_arg(wdg_list, int);

    63

	}

    64

    65

	va_end(wdg_list);

    66

}

    67

    68

void CDECL Window::SetWidgetsHiddenState(bool hidden_stat, int widgets, ...)

    69

{

    70

	va_list wdg_list;

    71

    72

	va_start(wdg_list, widgets);

    73

    74

	while (widgets != WIDGET_LIST_END) {

    75

		SetWidgetHiddenState(widgets, hidden_stat);

    76

		widgets = va_arg(wdg_list, int);

    77

	}

    78

    79

	va_end(wdg_list);

    80

}

    81

    82

void CDECL Window::SetWidgetsLoweredState(bool lowered_stat, int widgets, ...)

    83

{

    84

	va_list wdg_list;

    85

    86

	va_start(wdg_list, widgets);

    87

    88

	while (widgets != WIDGET_LIST_END) {

    89

		SetWidgetLoweredState(widgets, lowered_stat);

    90

		widgets = va_arg(wdg_list, int);

    91

	}

    92

    93

	va_end(wdg_list);

    94

}

    95

    96

void Window::RaiseButtons()

    97

{

    98

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

    99

		if (this->IsWidgetLowered(i)) {

   100

			this->RaiseWidget(i);

   101

			this->InvalidateWidget(i);

   102

		}

   103

	}

   104

}

   105

   106

void Window::InvalidateWidget(byte widget_index) const

   107

{

   108

	const Widget *wi = &this->widget[widget_index];

   109

   110

	/* Don't redraw the window if the widget is invisible or of no-type */

   111

	if (wi->type == WWT_EMPTY || IsWidgetHidden(widget_index)) return;

   112

   113

	SetDirtyBlocks(this->left + wi->left, this->top + wi->top, this->left + wi->right + 1, this->top + wi->bottom + 1);

   114

}

   115

   116

void Window::HandleButtonClick(byte widget)

   117

{

   118

	this->LowerWidget(widget);

   119

	this->flags4 |= 5 << WF_TIMEOUT_SHL;

   120

	this->InvalidateWidget(widget);

   121

}

   122

   123

static void StartWindowDrag(Window *w);

   124

static void StartWindowSizing(Window *w);

   125

   126

/**

   127

 * Dispatch left mouse-button (possibly double) click in window.

   128

 * @param w Window to dispatch event in

   129

 * @param x X coordinate of the click

   130

 * @param y Y coordinate of the click

   131

 * @param double_click Was it a double click?

   132

 */

   133

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

   134

{

   135

	int widget = 0;

   136

	if (w->desc_flags & WDF_DEF_WIDGET) {

   137

		widget = GetWidgetFromPos(w, x, y);

   138

		if (widget < 0) return; // exit if clicked outside of widgets

   139

   140

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

   141

		if (w->IsWidgetDisabled(widget)) return;

   142

   143

		const Widget *wi = &w->widget[widget];

   144

   145

		if (wi->type & WWB_MASK) {

   146

			/* special widget handling for buttons*/

   147

			switch (wi->type) {

   148

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   149

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   150

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   151

					w->HandleButtonClick(widget);

   152

					break;

   153

			}

   154

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

   155

			ScrollbarClickHandler(w, wi, x, y);

   156

		}

   157

   158

		if (w->desc_flags & WDF_STD_BTN) {

   159

			if (widget == 0) { /* 'X' */

   160

				delete w;

   161

				return;

   162

			}

   163

   164

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

   165

				StartWindowDrag(w);

   166

				return;

   167

			}

   168

		}

   169

   170

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

   171

			StartWindowSizing(w);

   172

			w->InvalidateWidget(widget);

   173

			return;

   174

		}

   175

   176

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

   177

			w->flags4 ^= WF_STICKY;

   178

			w->InvalidateWidget(widget);

   179

			return;

   180

		}

   181

	}

   182

   183

	Point pt = { x, y };

   184

   185

	if (double_click) {

   186

		w->OnDoubleClick(pt, widget);

   187

	} else {

   188

		w->OnClick(pt, widget);

   189

	}

   190

}

   191

   192

/**

   193

 * Dispatch right mouse-button click in window.

   194

 * @param w Window to dispatch event in

   195

 * @param x X coordinate of the click

   196

 * @param y Y coordinate of the click

   197

 */

   198

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

   199

{

   200

	int widget = 0;

   201

   202

	/* default tooltips handler? */

   203

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   204

		widget = GetWidgetFromPos(w, x, y);

   205

		if (widget < 0) return; // exit if clicked outside of widgets

   206

   207

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

   208

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

   209

			return;

   210

		}

   211

	}

   212

   213

	Point pt = { x, y };

   214

	w->OnRightClick(pt, widget);

   215

}

   216

   217

/**

   218

 * Dispatch the mousewheel-action to the window.

   219

 * The window will scroll any compatible scrollbars if the mouse is pointed over the bar or its contents

   220

 * @param w Window

   221

 * @param widget the widget where the scrollwheel was used

   222

 * @param wheel scroll up or down

   223

 */

   224

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

   225

{

   226

	if (widget < 0) return;

   227

   228

	const Widget *wi1 = &w->widget[widget];

   229

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

   230

   231

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

   232

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

   233

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

   234

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

   235

	Scrollbar *sb;

   236

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

   237

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

   238

   239

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

   240

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

   241

			if (pos != sb->pos) {

   242

				sb->pos = pos;

   243

				w->SetDirty();

   244

			}

   245

		}

   246

	}

   247

}

   248

   249

/**

   250

 * Generate repaint events for the visible part of window *wz within the rectangle.

   251

 *

   252

 * The function goes recursively upwards in the window stack, and splits the rectangle

   253

 * into multiple pieces at the window edges, so obscured parts are not redrawn.

   254

 *

   255

 * @param wz Pointer into window stack, pointing at the window that needs to be repainted

   256

 * @param left Left edge of the rectangle that should be repainted

   257

 * @param top Top edge of the rectangle that should be repainted

   258

 * @param right Right edge of the rectangle that should be repainted

   259

 * @param bottom Bottom edge of the rectangle that should be repainted

   260

 */

   261

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

   262

{

   263

	Window* const *vz = wz;

   264

   265

	while (++vz != _last_z_window) {

   266

		const Window *v = *vz;

   267

   268

		if (right > v->left &&

   269

				bottom > v->top &&

   270

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

   271

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

   272

			/* v and rectangle intersect with eeach other */

   273

			int x;

   274

   275

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

   276

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

   277

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

   278

				return;

   279

			}

   280

   281

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

   282

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

   283

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

   284

				return;

   285

			}

   286

   287

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

   288

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

   289

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

   290

				return;

   291

			}

   292

   293

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

   294

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

   295

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

   296

				return;

   297

			}

   298

   299

			return;

   300

		}

   301

	}

   302

   303

	/* Setup blitter, and dispatch a repaint event to window *wz */

   304

	DrawPixelInfo *dp = _cur_dpi;

   305

	dp->width = right - left;

   306

	dp->height = bottom - top;

   307

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

   308

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

   309

	dp->pitch = _screen.pitch;

   310

	dp->dst_ptr = BlitterFactoryBase::GetCurrentBlitter()->MoveTo(_screen.dst_ptr, left, top);

   311

	dp->zoom = ZOOM_LVL_NORMAL;

   312

	(*wz)->OnPaint();

   313

}

   314

   315

/**

   316

 * From a rectangle that needs redrawing, find the windows that intersect with the rectangle.

   317

 * These windows should be re-painted.

   318

 * @param left Left edge of the rectangle that should be repainted

   319

 * @param top Top edge of the rectangle that should be repainted

   320

 * @param right Right edge of the rectangle that should be repainted

   321

 * @param bottom Bottom edge of the rectangle that should be repainted

   322

 */

   323

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

   324

{

   325

	Window* const *wz;

   326

	DrawPixelInfo bk;

   327

	_cur_dpi = &bk;

   328

   329

	FOR_ALL_WINDOWS(wz) {

   330

		const Window *w = *wz;

   331

		if (right > w->left &&

   332

				bottom > w->top &&

   333

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

   334

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

   335

			/* Window w intersects with the rectangle => needs repaint */

   336

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

   337

		}

   338

	}

   339

}

   340

   341

/**

   342

 * Mark entire window as dirty (in need of re-paint)

   343

 * @param w Window to redraw

   344

 * @ingroup dirty

   345

 */

   346

void Window::SetDirty() const

   347

{

   348

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

   349

}

   350

   351

/**

   352

 * Mark entire window as dirty (in need of re-paint)

   353

 * @param w Window to redraw

   354

 * @ingroup dirty

   355

 */

   356

void SetWindowDirty(const Window *w)

   357

{

   358

	if (w != NULL) w->SetDirty();

   359

}

   360

   361

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

   362

 * @param w parent Window to find child of

   363

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

   364

static Window *FindChildWindow(const Window *w)

   365

{

   366

	Window* const *wz;

   367

   368

	FOR_ALL_WINDOWS(wz) {

   369

		Window *v = *wz;

   370

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

   371

	}

   372

   373

	return NULL;

   374

}

   375

   376

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

   377

 * or the behaviour is undefined but function should never fail

   378

 * @param w window to query Z Position

   379

 * @return Pointer into the window-list at the position of \a w

   380

 */

   381

Window **FindWindowZPosition(const Window *w)

   382

{

   383

	Window **wz;

   384

   385

	FOR_ALL_WINDOWS(wz) {

   386

		if (*wz == w) return wz;

   387

	}

   388

   389

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

   390

		w->window_class, w->window_number);

   391

	return NULL;

   392

}

   393

   394

/**

   395

 * Remove window and all its child windows from the window stack.

   396

 */

   397

Window::~Window()

   398

{

   399

	if (_thd.place_mode != VHM_NONE &&

   400

			_thd.window_class == this->window_class &&

   401

			_thd.window_number == this->window_number) {

   402

		ResetObjectToPlace();

   403

	}

   404

   405

	/* Prevent Mouseover() from resetting mouse-over coordinates on a non-existing window */

   406

	if (_mouseover_last_w == this) _mouseover_last_w = NULL;

   407

   408

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

   409

	 * by moving all windows after it one to the left. This must be

   410

	 * done before removing the child so we cannot cause recursion

   411

	 * between the deletion of the parent and the child. */

   412

	Window **wz = FindWindowZPosition(this);

   413

	if (wz == NULL) return;

   414

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

   415

	_last_z_window--;

   416

   417

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

   418

	Window *child = FindChildWindow(this);

   419

	while (child != NULL) {

   420

		delete child;

   421

		child = FindChildWindow(this);

   422

	}

   423

   424

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

   425

   426

	this->SetDirty();

   427

	free(this->widget);

   428

}

   429

   430

/**

   431

 * Find a window by its class and window number

   432

 * @param cls Window class

   433

 * @param number Number of the window within the window class

   434

 * @return Pointer to the found window, or \c NULL if not available

   435

 */

   436

Window *FindWindowById(WindowClass cls, WindowNumber number)

   437

{

   438

	Window* const *wz;

   439

   440

	FOR_ALL_WINDOWS(wz) {

   441

		Window *w = *wz;

   442

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

   443

	}

   444

   445

	return NULL;

   446

}

   447

   448

/**

   449

 * Delete a window by its class and window number (if it is open).

   450

 * @param cls Window class

   451

 * @param number Number of the window within the window class

   452

 */

   453

void DeleteWindowById(WindowClass cls, WindowNumber number)

   454

{

   455

	delete FindWindowById(cls, number);

   456

}

   457

   458

/**

   459

 * Delete all windows of a given class

   460

 * @param cls Window class of windows to delete

   461

 */

   462

void DeleteWindowByClass(WindowClass cls)

   463

{

   464

	Window* const *wz;

   465

   466

restart_search:

   467

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

   468

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

   469

	 * anywhere in the z-array */

   470

	FOR_ALL_WINDOWS(wz) {

   471

		Window *w = *wz;

   472

		if (w->window_class == cls) {

   473

			delete w;

   474

			goto restart_search;

   475

		}

   476

	}

   477

}

   478

   479

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

   480

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

   481

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

   482

 * @param id PlayerID player identifier */

   483

void DeletePlayerWindows(PlayerID id)

   484

{

   485

	Window* const *wz;

   486

   487

restart_search:

   488

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