1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "map.h"

     8

#include "player.h"

     9

#include "window.h"

    10

#include "gfx.h"

    11

#include "viewport.h"

    12

#include "console.h"

    13

#include "variables.h"

    14

#include "table/sprites.h"

    15

#include "genworld.h"

    16

    17

// delta between mouse cursor and upper left corner of dragged window

    18

static Point _drag_delta;

    19

    20

void HandleButtonClick(Window *w, byte widget)

    21

{

    22

	w->click_state |= (1 << widget);

    23

	w->flags4 |= 5 << WF_TIMEOUT_SHL;

    24

	InvalidateWidget(w, widget);

    25

}

    26

    27

    28

static Window *StartWindowDrag(Window *w);

    29

static Window *StartWindowSizing(Window *w);

    30

    31

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

    32

{

    33

	WindowEvent e;

    34

	const Widget *wi;

    35

    36

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

    37

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

    38

	e.event = WE_CLICK;

    39

    40

	if (w->desc_flags & WDF_DEF_WIDGET) {

    41

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

    42

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

    43

    44

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

    45

    46

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

    47

		if (HASBIT(w->disabled_state, e.we.click.widget)) return;

    48

    49

		if (wi->type & 0xE0) {

    50

			/* special widget handling for buttons*/

    51

			switch (wi->type) {

    52

			case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

    53

			case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

    54

				HandleButtonClick(w, e.we.click.widget);

    55

				break;

    56

			case WWT_NODISTXTBTN:

    57

				break;

    58

			}

    59

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

    60

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

    61

		}

    62

    63

		if (w->desc_flags & WDF_STD_BTN) {

    64

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

    65

				DeleteWindow(w);

    66

				return;

    67

			}

    68

    69

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

    70

				StartWindowDrag(w); // if not return then w = StartWindowDrag(w); to get correct pointer

    71

				return;

    72

			}

    73

		}

    74

    75

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

    76

			StartWindowSizing(w); // if not return then w = StartWindowSizing(w); to get correct pointer

    77

			return;

    78

		}

    79

    80

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

    81

			w->flags4 ^= WF_STICKY;

    82

			InvalidateWidget(w, e.we.click.widget);

    83

			return;

    84

		}

    85

	}

    86

    87

	w->wndproc(w, &e);

    88

}

    89

    90

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

    91

{

    92

	WindowEvent e;

    93

    94

	/* default tooltips handler? */

    95

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

    96

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

    97

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

    98

			return; /* exit if clicked outside of widgets */

    99

   100

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

   101

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

   102

			return;

   103

		}

   104

	}

   105

   106

	e.event = WE_RCLICK;

   107

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

   108

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

   109

	w->wndproc(w, &e);

   110

}

   111

   112

/** Dispatch the mousewheel-action to the window which will scroll any

   113

 * compatible scrollbars if the mouse is pointed over the bar or its contents

   114

 * @param *w Window

   115

 * @param widget the widget where the scrollwheel was used

   116

 * @param wheel scroll up or down

   117

 */

   118

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

   119

{

   120

	const Widget *wi1, *wi2;

   121

	Scrollbar *sb;

   122

   123

	if (widget < 0) return;

   124

   125

	wi1 = &w->widget[widget];

   126

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

   127

   128

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

   129

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

   130

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

   131

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

   132

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

   133

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

   134

   135

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

   136

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

   137

			if (pos != sb->pos) {

   138

				sb->pos = pos;

   139

				SetWindowDirty(w);

   140

			}

   141

		}

   142

	}

   143

}

   144

   145

   146

static void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom);

   147

   148

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

   149

{

   150

	Window *w;

   151

	DrawPixelInfo bk;

   152

	_cur_dpi = &bk;

   153

   154

	for (w = _windows; w != _last_window; w++) {

   155

		if (right > w->left &&

   156

				bottom > w->top &&

   157

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

   158

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

   159

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

   160

		}

   161

	}

   162

}

   163

   164

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

   165

{

   166

	const Window *v = w;

   167

	int x;

   168

   169

	while (++v != _last_window) {

   170

		if (right > v->left &&

   171

				bottom > v->top &&

   172

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

   173

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

   174

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

   175

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

   176

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

   177

				return;

   178

			}

   179

   180

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

   181

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

   182

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

   183

				return;

   184

			}

   185

   186

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

   187

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

   188

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

   189

				return;

   190

			}

   191

   192

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

   193

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

   194

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

   195

				return;

   196

			}

   197

   198

			return;

   199

		}

   200

	}

   201

   202

	{

   203

		DrawPixelInfo *dp = _cur_dpi;

   204

		dp->width = right - left;

   205

		dp->height = bottom - top;

   206

		dp->left = left - w->left;

   207

		dp->top = top - w->top;

   208

		dp->pitch = _screen.pitch;

   209

		dp->dst_ptr = _screen.dst_ptr + top * _screen.pitch + left;

   210

		dp->zoom = 0;

   211

		CallWindowEventNP(w, WE_PAINT);

   212

	}

   213

}

   214

   215

void CallWindowEventNP(Window *w, int event)

   216

{

   217

	WindowEvent e;

   218

   219

	e.event = event;

   220

	w->wndproc(w, &e);

   221

}

   222

   223

void SetWindowDirty(const Window *w)

   224

{

   225

	if (w == NULL) return;

   226

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

   227

}

   228

   229

void DeleteWindow(Window *w)

   230

{

   231

	WindowClass wc;

   232

	WindowNumber wn;

   233

	Window *v;

   234

	int count;

   235

   236

	if (w == NULL) return;

   237

   238

	if (_thd.place_mode != VHM_NONE &&

   239

			_thd.window_class == w->window_class &&

   240

			_thd.window_number == w->window_number) {

   241

		ResetObjectToPlace();

   242

	}

   243

   244

	wc = w->window_class;

   245

	wn = w->window_number;

   246

   247

	CallWindowEventNP(w, WE_DESTROY);

   248

   249

	w = FindWindowById(wc, wn);

   250

   251

	if (w->viewport != NULL) {

   252

		CLRBIT(_active_viewports, w->viewport - _viewports);

   253

		w->viewport->width = 0;

   254

		w->viewport = NULL;

   255

	}

   256

   257

	SetWindowDirty(w);

   258

   259

	free(w->widget);

   260

   261

	v = --_last_window;

   262

	count = (byte*)v - (byte*)w;

   263

	memmove(w, w + 1, count);

   264

}

   265

   266

Window *FindWindowById(WindowClass cls, WindowNumber number)

   267

{

   268

	Window *w;

   269

   270

	for (w = _windows; w != _last_window; w++) {

   271

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

   272

	}

   273

   274

	return NULL;

   275

}

   276

   277

void DeleteWindowById(WindowClass cls, WindowNumber number)

   278

{

   279

	DeleteWindow(FindWindowById(cls, number));

   280

}

   281

   282

void DeleteWindowByClass(WindowClass cls)

   283

{

   284

	Window *w;

   285

   286

	for (w = _windows; w != _last_window;) {

   287

		if (w->window_class == cls) {

   288

			DeleteWindow(w);

   289

			w = _windows;

   290

		} else {

   291

			w++;

   292

		}

   293

	}

   294

}

   295

   296

   297

static Window *BringWindowToFront(Window *w);

   298

   299

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   300

{

   301

	Window *w = FindWindowById(cls, number);

   302

   303

	if (w != NULL) {

   304

		w->flags4 |= WF_WHITE_BORDER_MASK;

   305

		SetWindowDirty(w);

   306

		w = BringWindowToFront(w);

   307

	}

   308

   309

	return w;

   310

}

   311

   312

static inline bool IsVitalWindow(const Window *w)

   313

{

   314

	WindowClass wc = w->window_class;

   315

	return (wc == WC_MAIN_TOOLBAR || wc == WC_STATUS_BAR || wc == WC_NEWS_WINDOW || wc == WC_SEND_NETWORK_MSG);

   316

}

   317

   318

/** On clicking on a window, make it the frontmost window of all. However

   319

 * there are certain windows that always need to be on-top; these include

   320

 * - Toolbar, Statusbar (always on)

   321

 * - New window, Chatbar (only if open)

   322

 * @param w window that is put into the foreground

   323

 */

   324

static Window *BringWindowToFront(Window *w)

   325

{

   326

	Window *v;

   327

	Window temp;

   328

   329

	v = _last_window;

   330

	do {

   331

		if (--v < _windows) return w;

   332

	} while (IsVitalWindow(v));

   333

   334

	if (w == v) return w;

   335

   336

	assert(w < v);

   337

   338

	temp = *w;

   339

	memmove(w, w + 1, (v - w) * sizeof(Window));

   340

	*v = temp;

   341

   342

	SetWindowDirty(v);

   343

   344

	return v;

   345

}

   346

   347

/** We have run out of windows, so find a suitable candidate for replacement.

   348

 * Keep all important windows intact. These are

   349

 * - Main window (gamefield), Toolbar, Statusbar (always on)

   350

 * - News window, Chatbar (when on)

   351

 * - Any sticked windows since we wanted to keep these

   352

 * @return w pointer to the window that is going to be deleted

   353

 */

   354

static Window *FindDeletableWindow(void)

   355

{

   356

	Window *w;

   357

   358

	for (w = _windows; w < endof(_windows); w++) {

   359

		if (w->window_class != WC_MAIN_WINDOW && !IsVitalWindow(w) && !(w->flags4 & WF_STICKY)) {

   360

			return w;

   361

		}

   362

	}

   363

	return NULL;

   364

}

   365

   366

/** A window must be freed, and all are marked as important windows. Ease the

   367

 * restriction a bit by allowing to delete sticky windows. Keep important/vital

   368

 * windows intact (Main window, Toolbar, Statusbar, News Window, Chatbar)

   369

 * @see FindDeletableWindow()

   370

 * @return w Pointer to the window that is being deleted

   371

 */

   372

static Window *ForceFindDeletableWindow(void)

   373

{

   374

	Window *w;

   375

   376

	for (w = _windows;; w++) {

   377

		assert(w < _last_window);

   378

		if (w->window_class != WC_MAIN_WINDOW && !IsVitalWindow(w)) return w;

   379

	}

   380

}

   381

   382

bool IsWindowOfPrototype(const Window *w, const Widget *widget)

   383

{

   384

	return (w->original_widget == widget);

   385

}

   386

   387

/* Copies 'widget' to 'w->widget' to allow for resizable windows */

   388

void AssignWidgetToWindow(Window *w, const Widget *widget)

   389

{

   390

	w->original_widget = widget;

   391

   392

	if (widget != NULL) {

   393

		uint index = 1;

   394

		const Widget *wi;

   395

   396

		for (wi = widget; wi->type != WWT_LAST; wi++) index++;

   397

   398

		w->widget = realloc(w->widget, sizeof(*w->widget) * index);

   399

		memcpy(w->widget, widget, sizeof(*w->widget) * index);

   400

	} else {

   401

		w->widget = NULL;

   402

	}

   403

}

   404

   405

/* Open a new window.

   406

 * This function is called from AllocateWindow() or AllocateWindowDesc()

   407

 * See descriptions for those functions for usage

   408

 * See AllocateWindow() for description of arguments.

   409

 * Only addition here is window_number, which is the window_number being assigned to the new window

   410

 */

   411

static Window *LocalAllocateWindow(

   412

							int x, int y, int width, int height,

   413

							WindowProc *proc, WindowClass cls, const Widget *widget, int window_number)

   414

{

   415

	Window *w = _last_window; // last window keeps track of the highest open window

   416

   417

	// We have run out of windows, close one and use that as the place for our new one

   418

	if (w >= endof(_windows)) {

   419

		w = FindDeletableWindow();

   420

   421

		if (w == NULL) w = ForceFindDeletableWindow();

   422

   423

		DeleteWindow(w);

   424

		w = _last_window;

   425

	}

   426

   427

	/* XXX - This very strange construction makes sure that the chatbar is always

   428

	 * on top of other windows. Why? It is created as last_window (so, on top).

   429

	 * Any other window will go below toolbar/statusbar/news window, which implicitely

   430

	 * also means it is below the chatbar. Very likely needs heavy improvement

   431

	 * to de-braindeadize */

   432

	if (w != _windows && cls != WC_SEND_NETWORK_MSG) {

   433

		Window *v;

   434

   435

		/* XXX - if not this order (toolbar/statusbar and then news), game would

   436

		 * crash because it will try to copy a negative size for the news-window.

   437

		 * Eg. window was already moved BELOW news (which is below toolbar/statusbar)

   438

		 * and now needs to move below those too. That is a negative move. */

   439

		v = FindWindowById(WC_MAIN_TOOLBAR, 0);

   440

		if (v != NULL) {

   441

			memmove(v+1, v, (byte*)w - (byte*)v);

   442

			w = v;

   443

		}

   444

   445

		v = FindWindowById(WC_STATUS_BAR, 0);

   446

		if (v != NULL) {

   447

			memmove(v+1, v, (byte*)w - (byte*)v);

   448

			w = v;

   449

		}

   450

   451

		v = FindWindowById(WC_NEWS_WINDOW, 0);

   452

		if (v != NULL) {

   453

			memmove(v+1, v, (byte*)w - (byte*)v);

   454

			w = v;

   455

		}

   456

	}

   457

   458

	// Set up window properties

   459

	memset(w, 0, sizeof(Window));

   460

	w->window_class = cls;

   461

	w->flags4 = WF_WHITE_BORDER_MASK; // just opened windows have a white border

   462

	w->caption_color = 0xFF;

   463

	w->left = x;

   464

	w->top = y;

   465

	w->width = width;

   466

	w->height = height;

   467

	w->wndproc = proc;

   468

	AssignWidgetToWindow(w, widget);

   469

	w->resize.width = width;

   470

	w->resize.height = height;

   471

	w->resize.step_width = 1;

   472

	w->resize.step_height = 1;

   473

	w->window_number = window_number;

   474

   475

	_last_window++;

   476

   477

	SetWindowDirty(w);

   478

   479

	CallWindowEventNP(w, WE_CREATE);

   480

   481

	return w;

   482

}

   483

   484

/**

   485

 * Open a new window. If there is no space for a new window, close an open

   486

 * window. Try to avoid stickied windows, but if there is no else, close one of

   487

 * those as well. Then make sure all created windows are below some always-on-top

   488

 * ones. Finally set all variables and call the WE_CREATE event

   489

 * @param x offset in pixels from the left of the screen

   490

 * @param y offset in pixels from the top of the screen

   491

 * @param width width in pixels of the window

   492

 * @param height height in pixels of the window

   493

 * @param *proc @see WindowProc function to call when any messages/updates happen to the window

   494

 * @param cls @see WindowClass class of the window, used for identification and grouping

   495

 * @param *widget @see Widget pointer to the window layout and various elements

   496

 * @return @see Window pointer of the newly created window

   497

 */