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

    27

#include "table/sprites.h"

    28

    29

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

    30

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

    31

    32

/**

    33

 * List of windows opened at the screen.

    34

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

    35

 * bottom window is at _z_windows[0]

    36

 */

    37

Window *_z_windows[MAX_NUMBER_OF_WINDOWS];

    38

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

    39

    40

byte _no_scroll;

    41

Point _cursorpos_drag_start;

    42

    43

int _scrollbar_start_pos;

    44

int _scrollbar_size;

    45

byte _scroller_click_timeout;

    46

    47

bool _scrolling_scrollbar;

    48

bool _scrolling_viewport;

    49

    50

byte _special_mouse_mode;

    51

    52

    53

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

    54

{

    55

	va_list wdg_list;

    56

    57

	va_start(wdg_list, widgets);

    58

    59

	while (widgets != WIDGET_LIST_END) {

    60

		SetWidgetDisabledState(widgets, disab_stat);

    61

		widgets = va_arg(wdg_list, int);

    62

	}

    63

    64

	va_end(wdg_list);

    65

}

    66

    67

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

    68

{

    69

	va_list wdg_list;

    70

    71

	va_start(wdg_list, widgets);

    72

    73

	while (widgets != WIDGET_LIST_END) {

    74

		SetWidgetHiddenState(widgets, hidden_stat);

    75

		widgets = va_arg(wdg_list, int);

    76

	}

    77

    78

	va_end(wdg_list);

    79

}

    80

    81

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

    82

{

    83

	va_list wdg_list;

    84

    85

	va_start(wdg_list, widgets);

    86

    87

	while (widgets != WIDGET_LIST_END) {

    88

		SetWidgetLoweredState(widgets, lowered_stat);

    89

		widgets = va_arg(wdg_list, int);

    90

	}

    91

    92

	va_end(wdg_list);

    93

}

    94

    95

void Window::RaiseButtons()

    96

{

    97

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

    98

		if (this->IsWidgetLowered(i)) {

    99

			this->RaiseWidget(i);

   100

			this->InvalidateWidget(i);

   101

		}

   102

	}

   103

}

   104

   105

void Window::InvalidateWidget(byte widget_index) const

   106

{

   107

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

   108

   109

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

   110

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

   111

   112

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

   113

}

   114

   115

void Window::HandleButtonClick(byte widget)

   116

{

   117

	this->LowerWidget(widget);

   118

	this->flags4 |= 5 << WF_TIMEOUT_SHL;

   119

	this->InvalidateWidget(widget);

   120

}

   121

   122

static void StartWindowDrag(Window *w);

   123

static void StartWindowSizing(Window *w);

   124

   125

/**

   126

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

   127

 * @param w Window to dispatch event in

   128

 * @param x X coordinate of the click

   129

 * @param y Y coordinate of the click

   130

 * @param double_click Was it a double click?

   131

 */

   132

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

   133

{

   134

	int widget = 0;

   135

	if (w->desc_flags & WDF_DEF_WIDGET) {

   136

		widget = GetWidgetFromPos(w, x, y);

   137

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

   138

   139

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

   140

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

   141

   142

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

   143

   144

		if (wi->type & WWB_MASK) {

   145

			/* special widget handling for buttons*/

   146

			switch (wi->type) {

   147

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   148

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   149

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   150

					w->HandleButtonClick(widget);

   151

					break;

   152

			}

   153

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

   154

			ScrollbarClickHandler(w, wi, x, y);

   155

		}

   156

   157

		if (w->desc_flags & WDF_STD_BTN) {

   158

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

   159

				delete w;

   160

				return;

   161

			}

   162

   163

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

   164

				StartWindowDrag(w);

   165

				return;

   166

			}

   167

		}

   168

   169

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

   170

			StartWindowSizing(w);

   171

			w->InvalidateWidget(widget);

   172

			return;

   173

		}

   174

   175

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

   176

			w->flags4 ^= WF_STICKY;

   177

			w->InvalidateWidget(widget);

   178

			return;

   179

		}

   180

	}

   181

   182

	Point pt = { x, y };

   183

   184

	if (double_click) {

   185

		w->OnDoubleClick(pt, widget);

   186

	} else {

   187

		w->OnClick(pt, widget);

   188

	}

   189

}

   190

   191

/**

   192

 * Dispatch right mouse-button click in window.

   193

 * @param w Window to dispatch event in

   194

 * @param x X coordinate of the click

   195

 * @param y Y coordinate of the click

   196

 */

   197

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

   198

{

   199

	int widget = 0;

   200

   201

	/* default tooltips handler? */

   202

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   203

		widget = GetWidgetFromPos(w, x, y);

   204

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

   205

   206

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

   207

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

   208

			return;

   209

		}

   210

	}

   211

   212

	Point pt = { x, y };

   213

	w->OnRightClick(pt, widget);

   214

}

   215

   216

/**

   217

 * Dispatch the mousewheel-action to the window.

   218

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

   219

 * @param w Window

   220

 * @param widget the widget where the scrollwheel was used

   221

 * @param wheel scroll up or down

   222

 */

   223

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

   224

{

   225

	if (widget < 0) return;

   226

   227

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

   228

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

   229

   230

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

   231

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

   232

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

   233

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

   234

	Scrollbar *sb;

   235

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

   236

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

   237

   238

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

   239

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

   240

			if (pos != sb->pos) {

   241

				sb->pos = pos;

   242

				w->SetDirty();

   243

			}

   244

		}

   245

	}

   246

}

   247

   248

/**

   249

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

   250

 *

   251

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

   252

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

   253

 *

   254

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

   255

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

   256

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

   257

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

   258

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

   259

 */

   260

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

   261

{

   262

	Window* const *vz = wz;

   263

   264

	while (++vz != _last_z_window) {

   265

		const Window *v = *vz;

   266

   267

		if (right > v->left &&

   268

				bottom > v->top &&

   269

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

   270

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

   271

			/* v and rectangle intersect with eeach other */

   272

			int x;

   273

   274

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

   275

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

   276

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

   277

				return;

   278

			}

   279

   280

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

   281

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

   282

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

   283

				return;

   284

			}

   285

   286

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

   287

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

   288

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

   289

				return;

   290

			}

   291

   292

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

   293

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

   294

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

   295

				return;

   296

			}

   297

   298

			return;

   299

		}

   300

	}

   301

   302

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

   303

	DrawPixelInfo *dp = _cur_dpi;

   304

	dp->width = right - left;

   305

	dp->height = bottom - top;

   306

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

   307

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

   308

	dp->pitch = _screen.pitch;

   309

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

   310

	dp->zoom = ZOOM_LVL_NORMAL;

   311

	(*wz)->OnPaint();

   312

}

   313

   314

/**

   315

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

   316

 * These windows should be re-painted.

   317

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

   318

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

   319

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

   320

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

   321

 */

   322

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

   323

{

   324

	Window* const *wz;

   325

	DrawPixelInfo bk;

   326

	_cur_dpi = &bk;

   327

   328

	FOR_ALL_WINDOWS(wz) {

   329

		const Window *w = *wz;

   330

		if (right > w->left &&

   331

				bottom > w->top &&

   332

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

   333

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

   334

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

   335

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

   336

		}

   337

	}

   338

}

   339

   340

/**

   341

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

   342

 * @param w Window to redraw

   343

 * @ingroup dirty

   344

 */

   345

void Window::SetDirty() const

   346

{

   347

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

   348

}

   349

   350

/**

   351

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

   352

 * @param w Window to redraw

   353

 * @ingroup dirty

   354

 */

   355

void SetWindowDirty(const Window *w)

   356

{

   357

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

   358

}

   359

   360

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

   361

 * @param w parent Window to find child of

   362

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

   363

static Window *FindChildWindow(const Window *w)

   364

{

   365

	Window* const *wz;

   366

   367

	FOR_ALL_WINDOWS(wz) {

   368

		Window *v = *wz;

   369

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

   370

	}

   371

   372

	return NULL;

   373

}

   374

   375

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

   376

 * or the behaviour is undefined but function should never fail

   377

 * @param w window to query Z Position

   378

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

   379

 */

   380

Window **FindWindowZPosition(const Window *w)

   381

{

   382

	Window **wz;

   383

   384

	FOR_ALL_WINDOWS(wz) {

   385

		if (*wz == w) return wz;

   386

	}

   387

   388

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

   389

		w->window_class, w->window_number);

   390

	return NULL;

   391

}

   392

   393

/**

   394

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

   395

 */

   396

Window::~Window()

   397

{

   398

	if (_thd.place_mode != VHM_NONE &&

   399

			_thd.window_class == this->window_class &&

   400

			_thd.window_number == this->window_number) {

   401

		ResetObjectToPlace();

   402

	}

   403

   404

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

   405

	if (_mouseover_last_w == this) _mouseover_last_w = NULL;

   406

   407

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

   408

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

   409

	 * done before removing the child so we cannot cause recursion

   410

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

   411

	Window **wz = FindWindowZPosition(this);

   412

	if (wz == NULL) return;

   413

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

   414

	_last_z_window--;

   415

   416

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

   417

	Window *child = FindChildWindow(this);

   418

	while (child != NULL) {

   419

		delete child;

   420

		child = FindChildWindow(this);

   421

	}

   422

   423

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

   424

   425

	this->SetDirty();

   426

	free(this->widget);

   427

}

   428

   429

/**

   430

 * Find a window by its class and window number

   431

 * @param cls Window class

   432

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

   433

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

   434

 */

   435

Window *FindWindowById(WindowClass cls, WindowNumber number)

   436

{

   437

	Window* const *wz;

   438

   439

	FOR_ALL_WINDOWS(wz) {

   440

		Window *w = *wz;

   441

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

   442

	}

   443

   444

	return NULL;

   445

}

   446

   447

/**

   448

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

   449

 * @param cls Window class

   450

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

   451

 */

   452

void DeleteWindowById(WindowClass cls, WindowNumber number)

   453

{

   454

	delete FindWindowById(cls, number);

   455

}

   456

   457

/**

   458

 * Delete all windows of a given class

   459

 * @param cls Window class of windows to delete

   460

 */

   461

void DeleteWindowByClass(WindowClass cls)

   462

{

   463

	Window* const *wz;

   464

   465

restart_search:

   466

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

   467

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

   468

	 * anywhere in the z-array */

   469

	FOR_ALL_WINDOWS(wz) {

   470

		Window *w = *wz;

   471

		if (w->window_class == cls) {

   472

			delete w;

   473

			goto restart_search;

   474

		}

   475

	}

   476

}

   477

   478

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

   479

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

   480

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

   481

 * @param id PlayerID player identifier */

   482

void DeletePlayerWindows(PlayerID id)

   483

{

   484

	Window* const *wz;

   485

   486

restart_search:

   487

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

   488

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