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"

    24

    25

#include "table/sprites.h"

    26

    27

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

    28

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

    29

    30

/**

    31

 * List of windows opened at the screen.

    32

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

    33

 * bottom window is at _z_windows[0]

    34

 */

    35

Window *_z_windows[MAX_NUMBER_OF_WINDOWS];

    36

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

    37

    38

Point _cursorpos_drag_start;

    39

    40

int _scrollbar_start_pos;

    41

int _scrollbar_size;

    42

byte _scroller_click_timeout;

    43

    44

bool _scrolling_scrollbar;

    45

bool _scrolling_viewport;

    46

bool _popup_menu_active;

    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

	uint i;

   105

   106

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

   107

		if (this->IsWidgetLowered(i)) {

   108

			this->RaiseWidget(i);

   109

			this->InvalidateWidget(i);

   110

		}

   111

	}

   112

}

   113

   114

void Window::InvalidateWidget(byte widget_index) const

   115

{

   116

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

   117

   118

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

   119

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

   120

   121

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

   122

}

   123

   124

void Window::HandleButtonClick(byte widget)

   125

{

   126

	this->LowerWidget(widget);

   127

	this->flags4 |= 5 << WF_TIMEOUT_SHL;

   128

	this->InvalidateWidget(widget);

   129

}

   130

   131

static void StartWindowDrag(Window *w);

   132

static void StartWindowSizing(Window *w);

   133

   134

/**

   135

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

   136

 * @param w Window to dispatch event in

   137

 * @param x X coordinate of the click

   138

 * @param y Y coordinate of the click

   139

 * @param double_click Was it a double click?

   140

 */

   141

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

   142

{

   143

	WindowEvent e;

   144

	const Widget *wi;

   145

   146

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

   147

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

   148

	e.event = double_click ? WE_DOUBLE_CLICK : WE_CLICK;

   149

   150

	if (w->desc_flags & WDF_DEF_WIDGET) {

   151

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

   152

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

   153

   154

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

   155

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

   156

   157

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

   158

   159

		if (wi->type & WWB_MASK) {

   160

			/* special widget handling for buttons*/

   161

			switch (wi->type) {

   162

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   163

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   164

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   165

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

   166

					break;

   167

			}

   168

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

   169

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

   170

		}

   171

   172

		if (w->desc_flags & WDF_STD_BTN) {

   173

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

   174

				delete w;

   175

				return;

   176

			}

   177

   178

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

   179

				StartWindowDrag(w);

   180

				return;

   181

			}

   182

		}

   183

   184

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

   185

			StartWindowSizing(w);

   186

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

   187

			return;

   188

		}

   189

   190

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

   191

			w->flags4 ^= WF_STICKY;

   192

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

   193

			return;

   194

		}

   195

	}

   196

   197

	w->HandleWindowEvent(&e);

   198

}

   199

   200

/**

   201

 * Dispatch right mouse-button click in window.

   202

 * @param w Window to dispatch event in

   203

 * @param x X coordinate of the click

   204

 * @param y Y coordinate of the click

   205

 */

   206

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

   207

{

   208

	WindowEvent e;

   209

   210

	/* default tooltips handler? */

   211

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   212

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

   213

		if (e.we.click.widget < 0)

   214

			return; // exit if clicked outside of widgets

   215

   216

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

   217

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

   218

			return;

   219

		}

   220

	}

   221

   222

	e.event = WE_RCLICK;

   223

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

   224

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

   225

	w->HandleWindowEvent(&e);

   226

}

   227

   228

/**

   229

 * Dispatch the mousewheel-action to the window.

   230

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

   231

 * @param w Window

   232

 * @param widget the widget where the scrollwheel was used

   233

 * @param wheel scroll up or down

   234

 */

   235

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

   236

{

   237

	const Widget *wi1, *wi2;

   238

	Scrollbar *sb;

   239

   240

	if (widget < 0) return;

   241

   242

	wi1 = &w->widget[widget];

   243

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

   244

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

   252

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

   253

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

   254

			if (pos != sb->pos) {

   255

				sb->pos = pos;

   256

				w->SetDirty();

   257

			}

   258

		}

   259

	}

   260

}

   261

   262

/**

   263

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

   264

 *

   265

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

   266

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

   267

 *

   268

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

   269

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

   270

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

   271

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

   272

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

   273

 */

   274

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

   275

{

   276

	Window* const *vz = wz;

   277

   278

	while (++vz != _last_z_window) {

   279

		const Window *v = *vz;

   280

   281

		if (right > v->left &&

   282

				bottom > v->top &&

   283

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

   284

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

   285

			/* v and rectangle intersect with eeach other */

   286

			int x;

   287

   288

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

   289

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

   290

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

   291

				return;

   292

			}

   293

   294

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

   295

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

   296

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

   297

				return;

   298

			}

   299

   300

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

   301

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

   302

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

   303

				return;

   304

			}

   305

   306

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

   307

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

   308

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

   309

				return;

   310

			}

   311

   312

			return;

   313

		}

   314

	}

   315

   316

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

   317

	DrawPixelInfo *dp = _cur_dpi;

   318

	dp->width = right - left;

   319

	dp->height = bottom - top;

   320

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

   321

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

   322

	dp->pitch = _screen.pitch;

   323

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

   324

	dp->zoom = ZOOM_LVL_NORMAL;

   325

	CallWindowEventNP(*wz, WE_PAINT);

   326

}

   327

   328

/**

   329

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

   330

 * These windows should be re-painted.

   331

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

   332

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

   333

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

   334

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

   335

 */

   336

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

   337

{

   338

	Window* const *wz;

   339

	DrawPixelInfo bk;

   340

	_cur_dpi = &bk;

   341

   342

	FOR_ALL_WINDOWS(wz) {

   343

		const Window *w = *wz;

   344

		if (right > w->left &&

   345

				bottom > w->top &&

   346

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

   347

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

   348

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

   349

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

   350

		}

   351

	}

   352

}

   353

   354

/**

   355

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

   356

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

   357

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

   358

 * @param event Event to dispatch

   359

 */

   360

void CallWindowEventNP(Window *w, int event)

   361

{

   362

	WindowEvent e;

   363

   364

	e.event = event;

   365

	w->HandleWindowEvent(&e);

   366

}

   367

   368

/**

   369

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

   370

 * @param w Window to redraw

   371

 * @ingroup dirty

   372

 */

   373

void Window::SetDirty() const

   374

{

   375

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

   376

}

   377

   378

/**

   379

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

   380

 * @param w Window to redraw

   381

 * @ingroup dirty

   382

 */

   383

void SetWindowDirty(const Window *w)

   384

{

   385

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

   386

}

   387

   388

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

   389

 * @param w parent Window to find child of

   390

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

   391

static Window *FindChildWindow(const Window *w)

   392

{

   393

	Window* const *wz;

   394

   395

	FOR_ALL_WINDOWS(wz) {

   396

		Window *v = *wz;

   397

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

   398

	}

   399

   400

	return NULL;

   401

}

   402

   403

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

   404

 * or the behaviour is undefined but function should never fail

   405

 * @param w window to query Z Position

   406

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

   407

 */

   408

Window **FindWindowZPosition(const Window *w)

   409

{

   410

	Window **wz;

   411

   412

	FOR_ALL_WINDOWS(wz) {

   413

		if (*wz == w) return wz;

   414

	}

   415

   416

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

   417

		w->window_class, w->window_number);

   418

	return NULL;

   419

}

   420

   421

/**

   422

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

   423

 */

   424

Window::~Window()

   425

{

   426

	if (_thd.place_mode != VHM_NONE &&

   427

			_thd.window_class == this->window_class &&

   428

			_thd.window_number == this->window_number) {

   429

		ResetObjectToPlace();

   430

	}

   431

   432

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

   433

	if (_mouseover_last_w == this) _mouseover_last_w = NULL;

   434

   435

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

   436

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

   437

	 * done before removing the child so we cannot cause recursion

   438

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

   439

	Window **wz = FindWindowZPosition(this);

   440

	if (wz == NULL) return;

   441

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

   442

	_last_z_window--;

   443

   444

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

   445

	delete FindChildWindow(this);

   446

   447

	CallWindowEventNP(this, WE_DESTROY);

   448

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

   449

   450

	this->SetDirty();

   451

	free(this->widget);

   452

}

   453

   454

/**

   455

 * Find a window by its class and window number

   456

 * @param cls Window class

   457

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

   458

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

   459

 */

   460

Window *FindWindowById(WindowClass cls, WindowNumber number)

   461

{

   462

	Window* const *wz;

   463

   464

	FOR_ALL_WINDOWS(wz) {

   465

		Window *w = *wz;

   466

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

   467

	}

   468

   469

	return NULL;

   470

}

   471

   472

/**

   473

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

   474

 * @param cls Window class

   475

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

   476

 */

   477

void DeleteWindowById(WindowClass cls, WindowNumber number)

   478

{

   479

	delete FindWindowById(cls, number);

   480

}

   481

   482

/**

   483

 * Delete all windows of a given class

   484

 * @param cls Window class of windows to delete

   485

 */

   486

void DeleteWindowByClass(WindowClass cls)

   487

{

   488

	Window* const *wz;

   489