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.h"

    12

#include "viewport_func.h"

    13

#include "variables.h"

    14

#include "genworld.h"

    15

#include "blitter/factory.hpp"

    16

#include "window_gui.h"

    17

#include "zoom_func.h"

    18

#include "core/alloc_func.hpp"

    19

#include "map_func.h"

    20

#include "vehicle_base.h"

    21

#include "settings_type.h"

    22

#include "cheat_func.h"

    23

#include "window_func.h"

    24

#include "tilehighlight_func.h"

    25

    26

#include "table/sprites.h"

    27

    28

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

    29

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

    30

    31

/**

    32

 * List of windows opened at the screen.

    33

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

    34

 * bottom window is at _z_windows[0]

    35

 */

    36

Window *_z_windows[MAX_NUMBER_OF_WINDOWS];

    37

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

    38

    39

Point _cursorpos_drag_start;

    40

    41

int _scrollbar_start_pos;

    42

int _scrollbar_size;

    43

byte _scroller_click_timeout;

    44

    45

bool _scrolling_scrollbar;

    46

bool _scrolling_viewport;

    47

    48

byte _special_mouse_mode;

    49

    50

    51

/**

    52

 * Call the window event handler for handling event \a e

    53

 * @param e Window event to handle

    54

 */

    55

void Window::HandleWindowEvent(WindowEvent *e)

    56

{

    57

	if (wndproc != NULL) wndproc(this, e);

    58

}

    59

    60

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

    61

{

    62

	va_list wdg_list;

    63

    64

	va_start(wdg_list, widgets);

    65

    66

	while (widgets != WIDGET_LIST_END) {

    67

		SetWidgetDisabledState(widgets, disab_stat);

    68

		widgets = va_arg(wdg_list, int);

    69

	}

    70

    71

	va_end(wdg_list);

    72

}

    73

    74

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

    75

{

    76

	va_list wdg_list;

    77

    78

	va_start(wdg_list, widgets);

    79

    80

	while (widgets != WIDGET_LIST_END) {

    81

		SetWidgetHiddenState(widgets, hidden_stat);

    82

		widgets = va_arg(wdg_list, int);

    83

	}

    84

    85

	va_end(wdg_list);

    86

}

    87

    88

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

    89

{

    90

	va_list wdg_list;

    91

    92

	va_start(wdg_list, widgets);

    93

    94

	while (widgets != WIDGET_LIST_END) {

    95

		SetWidgetLoweredState(widgets, lowered_stat);

    96

		widgets = va_arg(wdg_list, int);

    97

	}

    98

    99

	va_end(wdg_list);

   100

}

   101

   102

void Window::RaiseButtons()

   103

{

   104

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

   105

		if (this->IsWidgetLowered(i)) {

   106

			this->RaiseWidget(i);

   107

			this->InvalidateWidget(i);

   108

		}

   109

	}

   110

}

   111

   112

void Window::InvalidateWidget(byte widget_index) const

   113

{

   114

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

   115

   116

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

   117

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

   118

   119

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

   120

}

   121

   122

void Window::HandleButtonClick(byte widget)

   123

{

   124

	this->LowerWidget(widget);

   125

	this->flags4 |= 5 << WF_TIMEOUT_SHL;

   126

	this->InvalidateWidget(widget);

   127

}

   128

   129

static void StartWindowDrag(Window *w);

   130

static void StartWindowSizing(Window *w);

   131

   132

/**

   133

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

   134

 * @param w Window to dispatch event in

   135

 * @param x X coordinate of the click

   136

 * @param y Y coordinate of the click

   137

 * @param double_click Was it a double click?

   138

 */

   139

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

   140

{

   141

	WindowEvent e;

   142

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

   143

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

   144

	e.event = double_click ? WE_DOUBLE_CLICK : WE_CLICK;

   145

   146

	if (w->desc_flags & WDF_DEF_WIDGET) {

   147

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

   148

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

   149

   150

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

   151

		if (w->IsWidgetDisabled(e.we.click.widget)) return;

   152

   153

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

   154

   155

		if (wi->type & WWB_MASK) {

   156

			/* special widget handling for buttons*/

   157

			switch (wi->type) {

   158

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   159

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   160

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   161

					w->HandleButtonClick(e.we.click.widget);

   162

					break;

   163

			}

   164

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

   165

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

   166

		}

   167

   168

		if (w->desc_flags & WDF_STD_BTN) {

   169

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

   170

				delete w;

   171

				return;

   172

			}

   173

   174

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

   175

				StartWindowDrag(w);

   176

				return;

   177

			}

   178

		}

   179

   180

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

   181

			StartWindowSizing(w);

   182

			w->InvalidateWidget(e.we.click.widget);

   183

			return;

   184

		}

   185

   186

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

   187

			w->flags4 ^= WF_STICKY;

   188

			w->InvalidateWidget(e.we.click.widget);

   189

			return;

   190

		}

   191

	}

   192

   193

	w->HandleWindowEvent(&e);

   194

}

   195

   196

/**

   197

 * Dispatch right mouse-button click in window.

   198

 * @param w Window to dispatch event in

   199

 * @param x X coordinate of the click

   200

 * @param y Y coordinate of the click

   201

 */

   202

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

   203

{

   204

	WindowEvent e;

   205

   206

	/* default tooltips handler? */

   207

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   208

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

   209

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

   210

   211

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

   212

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

   213

			return;

   214

		}

   215

	}

   216

   217

	e.event = WE_RCLICK;

   218

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

   219

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

   220

	w->HandleWindowEvent(&e);

   221

}

   222

   223

/**

   224

 * Dispatch the mousewheel-action to the window.

   225

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

   226

 * @param w Window

   227

 * @param widget the widget where the scrollwheel was used

   228

 * @param wheel scroll up or down

   229

 */

   230

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

   231

{

   232

	if (widget < 0) return;

   233

   234

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

   235

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

   236

   237

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

   238

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

   239

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

   240

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

   241

	Scrollbar *sb;

   242

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

   243

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

   244

   245

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

   246

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

   247

			if (pos != sb->pos) {

   248

				sb->pos = pos;

   249

				w->SetDirty();

   250

			}

   251

		}

   252

	}

   253

}

   254

   255

/**

   256

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

   257

 *

   258

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

   259

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

   260

 *

   261

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

   262

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

   263

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

   264

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

   265

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

   266

 */

   267

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

   268

{

   269

	Window* const *vz = wz;

   270

   271

	while (++vz != _last_z_window) {

   272

		const Window *v = *vz;

   273

   274

		if (right > v->left &&

   275

				bottom > v->top &&

   276

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

   277

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

   278

			/* v and rectangle intersect with eeach other */

   279

			int x;

   280

   281

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

   282

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

   283

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

   284

				return;

   285

			}

   286

   287

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

   288

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

   289

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

   290

				return;

   291

			}

   292

   293

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

   294

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

   295

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

   296

				return;

   297

			}

   298

   299

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

   300

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

   301

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

   302

				return;

   303

			}

   304

   305

			return;

   306

		}

   307

	}

   308

   309

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

   310

	DrawPixelInfo *dp = _cur_dpi;

   311

	dp->width = right - left;

   312

	dp->height = bottom - top;

   313

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

   314

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

   315

	dp->pitch = _screen.pitch;

   316

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

   317

	dp->zoom = ZOOM_LVL_NORMAL;

   318

	CallWindowEventNP(*wz, WE_PAINT);

   319

}

   320

   321

/**

   322

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

   323

 * These windows should be re-painted.

   324

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

   325

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

   326

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

   327

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

   328

 */

   329

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

   330

{

   331

	Window* const *wz;

   332

	DrawPixelInfo bk;

   333

	_cur_dpi = &bk;

   334

   335

	FOR_ALL_WINDOWS(wz) {

   336

		const Window *w = *wz;

   337

		if (right > w->left &&

   338

				bottom > w->top &&

   339

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

   340

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

   341

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

   342

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

   343

		}

   344

	}

   345

}

   346

   347

/**

   348

 * Dispatch an event to a possibly non-existing window.

   349

 * If the window pointer w is \c NULL, the event is not dispatched

   350

 * @param w Window to dispatch the event to, may be \c NULL

   351

 * @param event Event to dispatch

   352

 */

   353

void CallWindowEventNP(Window *w, int event)

   354

{

   355

	WindowEvent e;

   356

   357

	e.event = event;

   358

	w->HandleWindowEvent(&e);

   359

}

   360

   361

/**

   362

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

   363

 * @param w Window to redraw

   364

 * @ingroup dirty

   365

 */

   366

void Window::SetDirty() const

   367

{

   368

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

   369

}

   370

   371

/**

   372

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

   373

 * @param w Window to redraw

   374

 * @ingroup dirty

   375

 */

   376

void SetWindowDirty(const Window *w)

   377

{

   378

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

   379

}

   380

   381

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

   382

 * @param w parent Window to find child of

   383

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

   384

static Window *FindChildWindow(const Window *w)

   385

{

   386

	Window* const *wz;

   387

   388

	FOR_ALL_WINDOWS(wz) {

   389

		Window *v = *wz;

   390

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

   391

	}

   392

   393

	return NULL;

   394

}

   395

   396

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

   397

 * or the behaviour is undefined but function should never fail

   398

 * @param w window to query Z Position

   399

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

   400

 */

   401

Window **FindWindowZPosition(const Window *w)

   402

{

   403

	Window **wz;

   404

   405

	FOR_ALL_WINDOWS(wz) {

   406

		if (*wz == w) return wz;

   407

	}

   408

   409

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

   410

		w->window_class, w->window_number);

   411

	return NULL;

   412

}

   413

   414

/**

   415

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

   416

 */

   417

Window::~Window()

   418

{

   419

	if (_thd.place_mode != VHM_NONE &&

   420

			_thd.window_class == this->window_class &&

   421

			_thd.window_number == this->window_number) {

   422

		ResetObjectToPlace();

   423

	}

   424

   425

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

   426

	if (_mouseover_last_w == this) _mouseover_last_w = NULL;

   427

   428

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

   429

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

   430

	 * done before removing the child so we cannot cause recursion

   431

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

   432

	Window **wz = FindWindowZPosition(this);

   433

	if (wz == NULL) return;

   434

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

   435

	_last_z_window--;

   436

   437

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

   438

	delete FindChildWindow(this);

   439

   440

	CallWindowEventNP(this, WE_DESTROY);

   441

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

   442

   443

	this->SetDirty();

   444

	free(this->widget);

   445

}

   446

   447

/**

   448

 * Find a window by its class and window number

   449

 * @param cls Window class

   450

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

   451

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

   452

 */

   453

Window *FindWindowById(WindowClass cls, WindowNumber number)

   454

{

   455

	Window* const *wz;

   456

   457

	FOR_ALL_WINDOWS(wz) {

   458

		Window *w = *wz;

   459

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

   460

	}

   461

   462

	return NULL;

   463

}

   464

   465

/**

   466

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

   467

 * @param cls Window class

   468

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

   469

 */

   470

void DeleteWindowById(WindowClass cls, WindowNumber number)

   471

{

   472

	delete FindWindowById(cls, number);

   473

}

   474

   475

/**

   476

 * Delete all windows of a given class

   477

 * @param cls Window class of windows to delete

   478

 */

   479

void DeleteWindowByClass(WindowClass cls)

   480

{

   481

	Window* const *wz;

   482

   483

restart_search:

   484

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

   485

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

   486

	 * anywhere in the z-array */

   487

	FOR_ALL_WINDOWS(wz) {

   488

		Window *w = *wz;