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"

    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

Point _cursorpos_drag_start;

    41

    42

int _scrollbar_start_pos;

    43

int _scrollbar_size;

    44

byte _scroller_click_timeout;

    45

    46

bool _scrolling_scrollbar;

    47

bool _scrolling_viewport;

    48

    49

byte _special_mouse_mode;

    50

    51

    52

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

    53

{

    54

	va_list wdg_list;

    55

    56

	va_start(wdg_list, widgets);

    57

    58

	while (widgets != WIDGET_LIST_END) {

    59

		SetWidgetDisabledState(widgets, disab_stat);

    60

		widgets = va_arg(wdg_list, int);

    61

	}

    62

    63

	va_end(wdg_list);

    64

}

    65

    66

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

    67

{

    68

	va_list wdg_list;

    69

    70

	va_start(wdg_list, widgets);

    71

    72

	while (widgets != WIDGET_LIST_END) {

    73

		SetWidgetHiddenState(widgets, hidden_stat);

    74

		widgets = va_arg(wdg_list, int);

    75

	}

    76

    77

	va_end(wdg_list);

    78

}

    79

    80

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

    81

{

    82

	va_list wdg_list;

    83

    84

	va_start(wdg_list, widgets);

    85

    86

	while (widgets != WIDGET_LIST_END) {

    87

		SetWidgetLoweredState(widgets, lowered_stat);

    88

		widgets = va_arg(wdg_list, int);

    89

	}

    90

    91

	va_end(wdg_list);

    92

}

    93

    94

void Window::RaiseButtons()

    95

{

    96

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

    97

		if (this->IsWidgetLowered(i)) {

    98

			this->RaiseWidget(i);

    99

			this->InvalidateWidget(i);

   100

		}

   101

	}

   102

}

   103

   104

void Window::InvalidateWidget(byte widget_index) const

   105

{

   106

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

   107

   108

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

   109

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

   110

   111

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

   112

}

   113

   114

void Window::HandleButtonClick(byte widget)

   115

{

   116

	this->LowerWidget(widget);

   117

	this->flags4 |= 5 << WF_TIMEOUT_SHL;

   118

	this->InvalidateWidget(widget);

   119

}

   120

   121

static void StartWindowDrag(Window *w);

   122

static void StartWindowSizing(Window *w);

   123

   124

/**

   125

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

   126

 * @param w Window to dispatch event in

   127

 * @param x X coordinate of the click

   128

 * @param y Y coordinate of the click

   129

 * @param double_click Was it a double click?

   130

 */

   131

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

   132

{

   133

	int widget = 0;

   134

	if (w->desc_flags & WDF_DEF_WIDGET) {

   135

		widget = GetWidgetFromPos(w, x, y);

   136

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

   137

   138

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

   139

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

   140

   141

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

   142

   143

		if (wi->type & WWB_MASK) {

   144

			/* special widget handling for buttons*/

   145

			switch (wi->type) {

   146

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   147

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   148

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   149

					w->HandleButtonClick(widget);

   150

					break;

   151

			}

   152

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

   153

			ScrollbarClickHandler(w, wi, x, y);

   154

		}

   155

   156

		if (w->desc_flags & WDF_STD_BTN) {

   157

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

   158

				delete w;

   159

				return;

   160

			}

   161

   162

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

   163

				StartWindowDrag(w);

   164

				return;

   165

			}

   166

		}

   167

   168

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

   169

			StartWindowSizing(w);

   170

			w->InvalidateWidget(widget);

   171

			return;

   172

		}

   173

   174

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

   175

			w->flags4 ^= WF_STICKY;

   176

			w->InvalidateWidget(widget);

   177

			return;

   178

		}

   179

	}

   180

   181

	Point pt = { x, y };

   182

   183

	if (double_click) {

   184

		w->OnDoubleClick(pt, widget);

   185

	} else {

   186

		w->OnClick(pt, widget);

   187

	}

   188

}

   189

   190

/**

   191

 * Dispatch right mouse-button click in window.

   192

 * @param w Window to dispatch event in

   193

 * @param x X coordinate of the click

   194

 * @param y Y coordinate of the click

   195

 */

   196

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

   197

{

   198

	int widget = 0;

   199

   200

	/* default tooltips handler? */

   201

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   202

		widget = GetWidgetFromPos(w, x, y);

   203

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

   204

   205

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

   206

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

   207

			return;

   208

		}

   209

	}

   210

   211

	Point pt = { x, y };

   212

	w->OnRightClick(pt, widget);

   213

}

   214

   215

/**

   216

 * Dispatch the mousewheel-action to the window.

   217

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

   218

 * @param w Window

   219

 * @param widget the widget where the scrollwheel was used

   220

 * @param wheel scroll up or down

   221

 */

   222

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

   223

{

   224

	if (widget < 0) return;

   225

   226

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

   227

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

   228

   229

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

   230

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

   231

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

   232

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

   233

	Scrollbar *sb;

   234

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

   235

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

   236

   237

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

   238

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

   239

			if (pos != sb->pos) {

   240

				sb->pos = pos;

   241

				w->SetDirty();

   242

			}

   243

		}

   244

	}

   245

}

   246

   247

/**

   248

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

   249

 *

   250

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

   251

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

   252

 *

   253

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

   254

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

   255

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

   256

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

   257

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

   258

 */

   259

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

   260

{

   261

	Window* const *vz = wz;

   262

   263

	while (++vz != _last_z_window) {

   264

		const Window *v = *vz;

   265

   266

		if (right > v->left &&

   267

				bottom > v->top &&

   268

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

   269

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

   270

			/* v and rectangle intersect with eeach other */

   271

			int x;

   272

   273

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

   274

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

   275

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

   276

				return;

   277

			}

   278

   279

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

   280

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

   281

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

   282

				return;

   283

			}

   284

   285

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

   286

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

   287

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

   288

				return;

   289

			}

   290

   291

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

   292

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

   293

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

   294

				return;

   295

			}

   296

   297

			return;

   298

		}

   299

	}

   300

   301

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

   302

	DrawPixelInfo *dp = _cur_dpi;

   303

	dp->width = right - left;

   304

	dp->height = bottom - top;

   305

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

   306

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

   307

	dp->pitch = _screen.pitch;

   308

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

   309

	dp->zoom = ZOOM_LVL_NORMAL;

   310

	(*wz)->OnPaint();

   311

}

   312

   313

/**

   314

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

   315

 * These windows should be re-painted.

   316

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

   317

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

   318

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

   319

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

   320

 */

   321

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

   322

{

   323

	Window* const *wz;

   324

	DrawPixelInfo bk;

   325

	_cur_dpi = &bk;

   326

   327

	FOR_ALL_WINDOWS(wz) {

   328

		const Window *w = *wz;

   329

		if (right > w->left &&

   330

				bottom > w->top &&

   331

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

   332

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

   333

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

   334

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

   335

		}

   336

	}

   337

}

   338

   339

/**

   340

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

   341

 * @param w Window to redraw

   342

 * @ingroup dirty

   343

 */

   344

void Window::SetDirty() const

   345

{

   346

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

   347

}

   348

   349

/**

   350

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

   351

 * @param w Window to redraw

   352

 * @ingroup dirty

   353

 */

   354

void SetWindowDirty(const Window *w)

   355

{

   356

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

   357

}

   358

   359

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

   360

 * @param w parent Window to find child of

   361

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

   362

static Window *FindChildWindow(const Window *w)

   363

{

   364

	Window* const *wz;

   365

   366

	FOR_ALL_WINDOWS(wz) {

   367

		Window *v = *wz;

   368

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

   369

	}

   370

   371

	return NULL;

   372

}

   373

   374

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

   375

 * or the behaviour is undefined but function should never fail

   376

 * @param w window to query Z Position

   377

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

   378

 */

   379

Window **FindWindowZPosition(const Window *w)

   380

{

   381

	Window **wz;

   382

   383

	FOR_ALL_WINDOWS(wz) {

   384

		if (*wz == w) return wz;

   385

	}

   386

   387

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

   388

		w->window_class, w->window_number);

   389

	return NULL;

   390

}

   391

   392

/**

   393

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

   394

 */

   395

Window::~Window()

   396

{

   397

	if (_thd.place_mode != VHM_NONE &&

   398

			_thd.window_class == this->window_class &&

   399

			_thd.window_number == this->window_number) {

   400

		ResetObjectToPlace();

   401

	}

   402

   403

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

   404

	if (_mouseover_last_w == this) _mouseover_last_w = NULL;

   405

   406

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

   407

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

   408

	 * done before removing the child so we cannot cause recursion

   409

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

   410

	Window **wz = FindWindowZPosition(this);

   411

	if (wz == NULL) return;

   412

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

   413

	_last_z_window--;

   414

   415

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

   416

	Window *child = FindChildWindow(this);

   417

	while (child != NULL) {

   418

		delete child;

   419

		child = FindChildWindow(this);

   420

	}

   421

   422

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

   423

   424

	this->SetDirty();

   425

	free(this->widget);

   426

}

   427

   428

/**

   429

 * Find a window by its class and window number

   430

 * @param cls Window class

   431

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

   432

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

   433

 */

   434

Window *FindWindowById(WindowClass cls, WindowNumber number)

   435

{

   436

	Window* const *wz;

   437

   438

	FOR_ALL_WINDOWS(wz) {

   439

		Window *w = *wz;

   440

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

   441

	}

   442

   443

	return NULL;

   444

}

   445

   446

/**

   447

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

   448

 * @param cls Window class

   449

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

   450

 */

   451

void DeleteWindowById(WindowClass cls, WindowNumber number)

   452

{

   453

	delete FindWindowById(cls, number);

   454

}

   455

   456

/**

   457

 * Delete all windows of a given class

   458

 * @param cls Window class of windows to delete

   459

 */

   460

void DeleteWindowByClass(WindowClass cls)

   461

{

   462

	Window* const *wz;

   463

   464

restart_search:

   465

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

   466

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

   467

	 * anywhere in the z-array */

   468

	FOR_ALL_WINDOWS(wz) {

   469

		Window *w = *wz;

   470

		if (w->window_class == cls) {

   471

			delete w;

   472

			goto restart_search;

   473

		}

   474

	}

   475

}

   476

   477

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

   478

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

   479

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

   480

 * @param id PlayerID player identifier */

   481

void DeletePlayerWindows(PlayerID id)

   482

{

   483

	Window* const *wz;

   484

   485

restart_search:

   486

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

   487

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

   488