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

    23

#include "table/sprites.h"

    24

    25

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

    26

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

    27

    28

/**

    29

 * List of windows opened at the screen.

    30

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

    31

 * bottom window is at _z_windows[0]

    32

 */

    33

Window *_z_windows[MAX_NUMBER_OF_WINDOWS];

    34

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

    35

    36

Point _cursorpos_drag_start;

    37

    38

int _scrollbar_start_pos;

    39

int _scrollbar_size;

    40

byte _scroller_click_timeout;

    41

    42

bool _scrolling_scrollbar;

    43

bool _scrolling_viewport;

    44

bool _popup_menu_active;

    45

    46

byte _special_mouse_mode;

    47

    48

    49

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

    50

{

    51

	va_list wdg_list;

    52

    53

	va_start(wdg_list, widgets);

    54

    55

	while (widgets != WIDGET_LIST_END) {

    56

		SetWidgetDisabledState(widgets, disab_stat);

    57

		widgets = va_arg(wdg_list, int);

    58

	}

    59

    60

	va_end(wdg_list);

    61

}

    62

    63

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

    64

{

    65

	va_list wdg_list;

    66

    67

	va_start(wdg_list, widgets);

    68

    69

	while (widgets != WIDGET_LIST_END) {

    70

		SetWidgetHiddenState(widgets, hidden_stat);

    71

		widgets = va_arg(wdg_list, int);

    72

	}

    73

    74

	va_end(wdg_list);

    75

}

    76

    77

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

    78

{

    79

	va_list wdg_list;

    80

    81

	va_start(wdg_list, widgets);

    82

    83

	while (widgets != WIDGET_LIST_END) {

    84

		SetWidgetLoweredState(widgets, lowered_stat);

    85

		widgets = va_arg(wdg_list, int);

    86

	}

    87

    88

	va_end(wdg_list);

    89

}

    90

    91

void Window::RaiseButtons()

    92

{

    93

	uint i;

    94

    95

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

    96

		if (this->IsWidgetLowered(i)) {

    97

			this->RaiseWidget(i);

    98

			this->InvalidateWidget(i);

    99

		}

   100

	}

   101

}

   102

   103

void Window::InvalidateWidget(byte widget_index) const

   104

{

   105

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

   106

   107

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

   108

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

   109

   110

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

   111

}

   112

   113

void Window::HandleButtonClick(byte widget)

   114

{

   115

	this->LowerWidget(widget);

   116

	this->flags4 |= 5 << WF_TIMEOUT_SHL;

   117

	this->InvalidateWidget(widget);

   118

}

   119

   120

static void StartWindowDrag(Window *w);

   121

static void StartWindowSizing(Window *w);

   122

   123

/**

   124

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

   125

 * @param w Window to dispatch event in

   126

 * @param x X coordinate of the click

   127

 * @param y Y coordinate of the click

   128

 * @param double_click Was it a double click?

   129

 */

   130

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

   131

{

   132

	WindowEvent e;

   133

	const Widget *wi;

   134

   135

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

   136

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

   137

	e.event = double_click ? WE_DOUBLE_CLICK : WE_CLICK;

   138

   139

	if (w->desc_flags & WDF_DEF_WIDGET) {

   140

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

   141

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

   142

   143

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

   144

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

   145

   146

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

   147

   148

		if (wi->type & WWB_MASK) {

   149

			/* special widget handling for buttons*/

   150

			switch (wi->type) {

   151

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   152

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   153

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   154

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

   155

					break;

   156

			}

   157

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

   158

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

   159

		}

   160

   161

		if (w->desc_flags & WDF_STD_BTN) {

   162

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

   163

				DeleteWindow(w);

   164

				return;

   165

			}

   166

   167

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

   168

				StartWindowDrag(w);

   169

				return;

   170

			}

   171

		}

   172

   173

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

   174

			StartWindowSizing(w);

   175

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

   176

			return;

   177

		}

   178

   179

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

   180

			w->flags4 ^= WF_STICKY;

   181

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

   182

			return;

   183

		}

   184

	}

   185

   186

	w->wndproc(w, &e);

   187

}

   188

   189

/**

   190

 * Dispatch right mouse-button click in window.

   191

 * @param w Window to dispatch event in

   192

 * @param x X coordinate of the click

   193

 * @param y Y coordinate of the click

   194

 */

   195

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

   196

{

   197

	WindowEvent e;

   198

   199

	/* default tooltips handler? */

   200

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   201

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

   202

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

   203

			return; // exit if clicked outside of widgets

   204

   205

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

   206

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

   207

			return;

   208

		}

   209

	}

   210

   211

	e.event = WE_RCLICK;

   212

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

   213

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

   214

	w->wndproc(w, &e);

   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

	const Widget *wi1, *wi2;

   227

	Scrollbar *sb;

   228

   229

	if (widget < 0) return;

   230

   231

	wi1 = &w->widget[widget];

   232

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

   233

   234

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

   235

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

   236

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

   237

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

   238

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

   239

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

   240

   241

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

   242

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

   243

			if (pos != sb->pos) {

   244

				sb->pos = pos;

   245

				SetWindowDirty(w);

   246

			}

   247

		}

   248

	}

   249

}

   250

   251

/**

   252

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

   253

 *

   254

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

   255

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

   256

 *

   257

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

   258

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

   259

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

   260

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

   261

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

   262

 */

   263

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

   264

{

   265

	Window* const *vz = wz;

   266

   267

	while (++vz != _last_z_window) {

   268

		const Window *v = *vz;

   269

   270

		if (right > v->left &&

   271

				bottom > v->top &&

   272

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

   273

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

   274

			/* v and rectangle intersect with eeach other */

   275

			int x;

   276

   277

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

   278

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

   279

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

   280

				return;

   281

			}

   282

   283

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

   284

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

   285

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

   286

				return;

   287

			}

   288

   289

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

   290

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

   291

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

   292

				return;

   293

			}

   294

   295

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

   296

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

   297

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

   298

				return;

   299

			}

   300

   301

			return;

   302

		}

   303

	}

   304

   305

	DrawPixelInfo *dp = _cur_dpi;

   306

	dp->width = right - left;

   307

	dp->height = bottom - top;

   308

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

   309

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

   310

	dp->pitch = _screen.pitch;

   311

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

   312

	dp->zoom = ZOOM_LVL_NORMAL;

   313

	CallWindowEventNP(*wz, WE_PAINT);

   314

}

   315

   316

/**

   317

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

   318

 * These windows should be re-painted.

   319

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

   320

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

   321

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

   322

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

   323

 */

   324

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

   325

{

   326

	Window* const *wz;

   327

	DrawPixelInfo bk;

   328

	_cur_dpi = &bk;

   329

   330

	FOR_ALL_WINDOWS(wz) {

   331

		const Window *w = *wz;

   332

		if (right > w->left &&

   333

				bottom > w->top &&

   334

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

   335

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

   336

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

   337

		}

   338

	}

   339

}

   340

   341

/**

   342

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

   343

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

   344

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

   345

 * @param event Event to dispatch

   346

 */

   347

void CallWindowEventNP(Window *w, int event)

   348

{

   349

	WindowEvent e;

   350

   351

	e.event = event;

   352

	w->wndproc(w, &e);

   353

}

   354

   355

/**

   356

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

   357

 * @param w Window to redraw

   358

 * @ingroup dirty

   359

 */

   360

void SetWindowDirty(const Window *w)

   361

{

   362

	if (w == NULL) return;

   363

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

   364

}

   365

   366

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

   367

 * @param w parent Window to find child of

   368

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

   369

static Window *FindChildWindow(const Window *w)

   370

{

   371

	Window* const *wz;

   372

   373

	FOR_ALL_WINDOWS(wz) {

   374

		Window *v = *wz;

   375

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

   376

	}

   377

   378

	return NULL;

   379

}

   380

   381

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

   382

 * or the behaviour is undefined but function should never fail

   383

 * @param w window to query Z Position

   384

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

   385

 */

   386

Window **FindWindowZPosition(const Window *w)

   387

{

   388

	Window **wz;

   389

   390

	FOR_ALL_WINDOWS(wz) {

   391

		if (*wz == w) return wz;

   392

	}

   393

   394

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

   395

		w->window_class, w->window_number);

   396

	return NULL;

   397

}

   398

   399

/**

   400

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

   401

 */

   402

void DeleteWindow(Window *w)

   403

{

   404

	if (w == NULL) return;

   405

   406

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

   407

	Window *v = FindChildWindow(w);

   408

	if (v != NULL) DeleteWindow(v);

   409

   410

	if (_thd.place_mode != VHM_NONE &&

   411

			_thd.window_class == w->window_class &&

   412

			_thd.window_number == w->window_number) {

   413

		ResetObjectToPlace();

   414

	}

   415

   416

	CallWindowEventNP(w, WE_DESTROY);

   417

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

   418

   419

	SetWindowDirty(w);

   420

	free(w->widget);

   421

	w->widget = NULL;

   422

	w->widget_count = 0;

   423

	w->parent = NULL;

   424

   425

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

   426

	if (_mouseover_last_w == w) _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 */

   430

	Window **wz = FindWindowZPosition(w);

   431

	if (wz == NULL) return;

   432

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

   433

	_last_z_window--;

   434

   435

	delete w;

   436

}

   437

   438

/**

   439

 * Find a window by its class and window number

   440

 * @param cls Window class

   441

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

   442

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

   443

 */

   444

Window *FindWindowById(WindowClass cls, WindowNumber number)

   445

{

   446

	Window* const *wz;

   447

   448

	FOR_ALL_WINDOWS(wz) {

   449

		Window *w = *wz;

   450

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

   451

	}

   452

   453

	return NULL;

   454

}

   455

   456

/**

   457

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

   458

 * @param cls Window class

   459

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

   460

 */

   461

void DeleteWindowById(WindowClass cls, WindowNumber number)

   462

{

   463

	DeleteWindow(FindWindowById(cls, number));

   464

}

   465

   466

/**

   467

 * Delete all windows of a given class

   468

 * @param cls Window class of windows to delete

   469

 */

   470

void DeleteWindowByClass(WindowClass cls)

   471

{

   472

	Window* const *wz;

   473

   474

restart_search:

   475

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

   476

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

   477

	 * anywhere in the z-array */

   478

	FOR_ALL_WINDOWS(wz) {

   479

		Window *w = *wz;

   480

		if (w->window_class == cls) {

   481

			DeleteWindow(w);

   482

			goto restart_search;

   483

		}

   484

	}

   485

}

   486

   487

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

   488

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

   489

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

   490