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

    26

    27

static Window _windows[MAX_NUMBER_OF_WINDOWS];

    28

    29

/**

    30

 * List of windows opened at the screen.

    31

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

    32

 * bottom window is at _z_windows[0]

    33

 */

    34

Window *_z_windows[lengthof(_windows)];

    35

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

    36

    37

Point _cursorpos_drag_start;

    38

    39

int _scrollbar_start_pos;

    40

int _scrollbar_size;

    41

byte _scroller_click_timeout;

    42

    43

bool _scrolling_scrollbar;

    44

bool _scrolling_viewport;

    45

bool _popup_menu_active;

    46

    47

byte _special_mouse_mode;

    48

    49

    50

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

    51

{

    52

	va_list wdg_list;

    53

    54

	va_start(wdg_list, widgets);

    55

    56

	while (widgets != WIDGET_LIST_END) {

    57

		SetWidgetDisabledState(widgets, disab_stat);

    58

		widgets = va_arg(wdg_list, int);

    59

	}

    60

    61

	va_end(wdg_list);

    62

}

    63

    64

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

    65

{

    66

	va_list wdg_list;

    67

    68

	va_start(wdg_list, widgets);

    69

    70

	while (widgets != WIDGET_LIST_END) {

    71

		SetWidgetHiddenState(widgets, hidden_stat);

    72

		widgets = va_arg(wdg_list, int);

    73

	}

    74

    75

	va_end(wdg_list);

    76

}

    77

    78

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

    79

{

    80

	va_list wdg_list;

    81

    82

	va_start(wdg_list, widgets);

    83

    84

	while (widgets != WIDGET_LIST_END) {

    85

		SetWidgetLoweredState(widgets, lowered_stat);

    86

		widgets = va_arg(wdg_list, int);

    87

	}

    88

    89

	va_end(wdg_list);

    90

}

    91

    92

void Window::RaiseButtons()

    93

{

    94

	uint i;

    95

    96

	for (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

	WindowEvent e;

   134

	const Widget *wi;

   135

   136

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

   137

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

   138

	e.event = double_click ? WE_DOUBLE_CLICK : WE_CLICK;

   139

   140

	if (w->desc_flags & WDF_DEF_WIDGET) {

   141

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

   142

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

   143

   144

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

   145

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

   146

   147

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

   148

   149

		if (wi->type & WWB_MASK) {

   150

			/* special widget handling for buttons*/

   151

			switch (wi->type) {

   152

				case WWT_PANEL   | WWB_PUSHBUTTON: /* WWT_PUSHBTN */

   153

				case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   154

				case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   155

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

   156

					break;

   157

			}

   158

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

   159

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

   160

		}

   161

   162

		if (w->desc_flags & WDF_STD_BTN) {

   163

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

   164

				DeleteWindow(w);

   165

				return;

   166

			}

   167

   168

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

   169

				StartWindowDrag(w);

   170

				return;

   171

			}

   172

		}

   173

   174

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

   175

			StartWindowSizing(w);

   176

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

   177

			return;

   178

		}

   179

   180

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

   181

			w->flags4 ^= WF_STICKY;

   182

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

   183

			return;

   184

		}

   185

	}

   186

   187

	w->wndproc(w, &e);

   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

	WindowEvent e;

   199

   200

	/* default tooltips handler? */

   201

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   202

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

   203

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

   204

			return; // exit if clicked outside of widgets

   205

   206

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

   207

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

   208

			return;

   209

		}

   210

	}

   211

   212

	e.event = WE_RCLICK;

   213

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

   214

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

   215

	w->wndproc(w, &e);

   216

}

   217

   218

/**

   219

 * Dispatch the mousewheel-action to the window.

   220

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

   221

 * @param w Window

   222

 * @param widget the widget where the scrollwheel was used

   223

 * @param wheel scroll up or down

   224

 */

   225

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

   226

{

   227

	const Widget *wi1, *wi2;

   228

	Scrollbar *sb;

   229

   230

	if (widget < 0) return;

   231

   232

	wi1 = &w->widget[widget];

   233

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

   234

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

   242

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

   243

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

   244

			if (pos != sb->pos) {

   245

				sb->pos = pos;

   246

				SetWindowDirty(w);

   247

			}

   248

		}

   249

	}

   250

}

   251

   252

/**

   253

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

   254

 *

   255

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

   256

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

   257

 *

   258

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

   259

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

   260

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

   261

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

   262

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

   263

 */

   264

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

   265

{

   266

	Window* const *vz = wz;

   267

   268

	while (++vz != _last_z_window) {

   269

		const Window *v = *vz;

   270

   271

		if (right > v->left &&

   272

				bottom > v->top &&

   273

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

   274

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

   275

			/* v and rectangle intersect with eeach other */

   276

			int x;

   277

   278

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

   279

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

   280

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

   281

				return;

   282

			}

   283

   284

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

   285

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

   286

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

   287

				return;

   288

			}

   289

   290

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

   291

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

   292

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

   293

				return;

   294

			}

   295

   296

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

   297

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

   298

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

   299

				return;

   300

			}

   301

   302

			return;

   303

		}

   304

	}

   305

   306

	DrawPixelInfo *dp = _cur_dpi;

   307

	dp->width = right - left;

   308

	dp->height = bottom - top;

   309

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

   310

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

   311

	dp->pitch = _screen.pitch;

   312

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

   313

	dp->zoom = ZOOM_LVL_NORMAL;

   314

	CallWindowEventNP(*wz, WE_PAINT);

   315

}

   316

   317

/**

   318

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

   319

 * These windows should be re-painted.

   320

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

   321

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

   322

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

   323

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

   324

 */

   325

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

   326

{

   327

	Window* const *wz;

   328

	DrawPixelInfo bk;

   329

	_cur_dpi = &bk;

   330

   331

	FOR_ALL_WINDOWS(wz) {

   332

		const Window *w = *wz;

   333

		if (right > w->left &&

   334

				bottom > w->top &&

   335

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

   336

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

   337

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

   338

		}

   339

	}

   340

}

   341

   342

/**

   343

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

   344

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

   345

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

   346

 * @param event Event to dispatch

   347

 */

   348

void CallWindowEventNP(Window *w, int event)

   349

{

   350

	WindowEvent e;

   351

   352

	e.event = event;

   353

	w->wndproc(w, &e);

   354

}

   355

   356

/**

   357

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

   358

 * @param w Window to redraw

   359

 * @ingroup dirty

   360

 */

   361

void SetWindowDirty(const Window *w)

   362

{

   363

	if (w == NULL) return;

   364

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

   365

}

   366

   367

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

   368

 * @param w parent Window to find child of

   369

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

   370

static Window *FindChildWindow(const Window *w)

   371

{

   372

	Window* const *wz;

   373

   374

	FOR_ALL_WINDOWS(wz) {

   375

		Window *v = *wz;

   376

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

   377

	}

   378

   379

	return NULL;

   380

}

   381

   382

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

   383

 * or the behaviour is undefined but function should never fail

   384

 * @param w window to query Z Position

   385

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

   386

 */

   387

Window **FindWindowZPosition(const Window *w)

   388

{

   389

	Window **wz;

   390

   391

	FOR_ALL_WINDOWS(wz) {

   392

		if (*wz == w) return wz;

   393

	}

   394

   395

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

   396

		w->window_class, w->window_number);

   397

	return NULL;

   398

}

   399

   400

/**

   401

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

   402

 */

   403

void DeleteWindow(Window *w)

   404

{

   405

	if (w == NULL) return;

   406

   407

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

   408

	Window *v = FindChildWindow(w);

   409

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

   410

   411

	if (_thd.place_mode != VHM_NONE &&

   412

			_thd.window_class == w->window_class &&

   413

			_thd.window_number == w->window_number) {

   414

		ResetObjectToPlace();

   415

	}

   416

   417

	CallWindowEventNP(w, WE_DESTROY);

   418

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

   419

   420

	SetWindowDirty(w);

   421

	free(w->widget);

   422

	w->widget = NULL;

   423

	w->widget_count = 0;

   424

	w->parent = NULL;

   425

   426

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

   427

	 * by moving all windows after it one to the left */

   428

	Window **wz = FindWindowZPosition(w);

   429

	if (wz == NULL) return;

   430

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

   431

	_last_z_window--;

   432

}

   433

   434

/**

   435

 * Find a window by its class and window number

   436

 * @param cls Window class

   437

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

   438

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

   439

 */

   440

Window *FindWindowById(WindowClass cls, WindowNumber number)

   441

{

   442

	Window* const *wz;

   443

   444

	FOR_ALL_WINDOWS(wz) {

   445

		Window *w = *wz;

   446

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

   447

	}

   448

   449

	return NULL;

   450

}

   451

   452

/**

   453

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

   454

 * @param cls Window class

   455

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

   456

 */

   457

void DeleteWindowById(WindowClass cls, WindowNumber number)

   458

{

   459

	DeleteWindow(FindWindowById(cls, number));

   460

}

   461

   462

/**

   463

 * Delete all windows of a given class

   464

 * @param cls Window class of windows to delete

   465

 */

   466

void DeleteWindowByClass(WindowClass cls)

   467

{

   468

	Window* const *wz;

   469

   470

restart_search:

   471

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

   472

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

   473

	 * anywhere in the z-array */

   474

	FOR_ALL_WINDOWS(wz) {

   475

		Window *w = *wz;

   476

		if (w->window_class == cls) {

   477

			DeleteWindow(w);

   478

			goto restart_search;

   479

		}

   480

	}

   481

}

   482

   483

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

   484

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

   485

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

   486

 * @param id PlayerID player identifier */

   487

void DeletePlayerWindows(PlayerID id)

   488

{

   489

	Window* const *wz;