1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include <stdarg.h>

     5

#include "openttd.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "map.h"

     9

#include "player.h"

    10

#include "window.h"

    11

#include "gfx.h"

    12

#include "viewport.h"

    13

#include "console.h"

    14

#include "variables.h"

    15

#include "table/sprites.h"

    16

#include "genworld.h"

    17

    18

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

    19

static Point _drag_delta;

    20

    21

void CDECL SetWindowWidgetsDisabledState(Window *w, bool disab_stat, int widgets, ...)

    22

{

    23

	va_list wdg_list;

    24

    25

	va_start(wdg_list, widgets);

    26

    27

	while (widgets != WIDGET_LIST_END) {

    28

		SetWindowWidgetDisabledState(w, widgets, disab_stat);

    29

		widgets = va_arg(wdg_list, int);

    30

	}

    31

    32

	va_end(wdg_list);

    33

}

    34

    35

void CDECL SetWindowWidgetsHiddenState(Window *w, bool hidden_stat, int widgets, ...)

    36

{

    37

	va_list wdg_list;

    38

    39

	va_start(wdg_list, widgets);

    40

    41

	while (widgets != WIDGET_LIST_END) {

    42

		SetWindowWidgetHiddenState(w, widgets, hidden_stat);

    43

		widgets = va_arg(wdg_list, int);

    44

	}

    45

    46

	va_end(wdg_list);

    47

}

    48

    49

void CDECL SetWindowWidgetsLoweredState(Window *w, bool lowered_stat, int widgets, ...)

    50

{

    51

	va_list wdg_list;

    52

    53

	va_start(wdg_list, widgets);

    54

    55

	while (widgets != WIDGET_LIST_END) {

    56

		SetWindowWidgetLoweredState(w, widgets, lowered_stat);

    57

		widgets = va_arg(wdg_list, int);

    58

	}

    59

    60

	va_end(wdg_list);

    61

}

    62

    63

void RaiseWindowButtons(Window *w)

    64

{

    65

	const Widget *wi = w->widget;

    66

	uint i = 0;

    67

    68

	for (i = 0; wi->type != WWT_LAST; i++, wi++) {

    69

		if (IsWindowWidgetLowered(w, i)) {

    70

			RaiseWindowWidget(w, i);

    71

			InvalidateWidget(w, i);

    72

		}

    73

	}

    74

}

    75

    76

void HandleButtonClick(Window *w, byte widget)

    77

{

    78

	LowerWindowWidget(w, widget);

    79

	w->flags4 |= 5 << WF_TIMEOUT_SHL;

    80

	InvalidateWidget(w, widget);

    81

}

    82

    83

    84

static Window *StartWindowDrag(Window *w);

    85

static Window *StartWindowSizing(Window *w);

    86

    87

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

    88

{

    89

	WindowEvent e;

    90

	const Widget *wi;

    91

    92

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

    93

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

    94

	e.event = WE_CLICK;

    95

    96

	if (w->desc_flags & WDF_DEF_WIDGET) {

    97

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

    98

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

    99

   100

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

   101

   102

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

   103

		if (IsWidgetDisabled(wi)) return;

   104

   105

		if (wi->type & 0xE0) {

   106

			/* special widget handling for buttons*/

   107

			switch (wi->type) {

   108

			case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

   109

			case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

   110

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

   111

				break;

   112

			case WWT_NODISTXTBTN:

   113

				break;

   114

			}

   115

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

   116

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

   117

		}

   118

   119

		if (w->desc_flags & WDF_STD_BTN) {

   120

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

   121

				DeleteWindow(w);

   122

				return;

   123

			}

   124

   125

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

   126

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

   127

				return;

   128

			}

   129

		}

   130

   131

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

   132

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

   133

			return;

   134

		}

   135

   136

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

   137

			w->flags4 ^= WF_STICKY;

   138

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

   139

			return;

   140

		}

   141

	}

   142

   143

	w->wndproc(w, &e);

   144

}

   145

   146

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

   147

{

   148

	WindowEvent e;

   149

   150

	/* default tooltips handler? */

   151

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

   152

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

   153

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

   154

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

   155

   156

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

   157

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

   158

			return;

   159

		}

   160

	}

   161

   162

	e.event = WE_RCLICK;

   163

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

   164

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

   165

	w->wndproc(w, &e);

   166

}

   167

   168

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

   169

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

   170

 * @param *w Window

   171

 * @param widget the widget where the scrollwheel was used

   172

 * @param wheel scroll up or down

   173

 */

   174

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

   175

{

   176

	const Widget *wi1, *wi2;

   177

	Scrollbar *sb;

   178

   179

	if (widget < 0) return;

   180

   181

	wi1 = &w->widget[widget];

   182

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

   183

   184

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

   185

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

   186

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

   187

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

   188

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

   189

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

   190

   191

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

   192

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

   193

			if (pos != sb->pos) {

   194

				sb->pos = pos;

   195

				SetWindowDirty(w);

   196

			}

   197

		}

   198

	}

   199

}

   200

   201

   202

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

   203

   204

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

   205

{

   206

	Window *w;

   207

	DrawPixelInfo bk;

   208

	_cur_dpi = &bk;

   209

   210

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

   211

		if (right > w->left &&

   212

				bottom > w->top &&

   213

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

   214

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

   215

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

   216

		}

   217

	}

   218

}

   219

   220

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

   221

{

   222

	const Window *v = w;

   223

	int x;

   224

   225

	while (++v != _last_window) {

   226

		if (right > v->left &&

   227

				bottom > v->top &&

   228

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

   229

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

   230

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

   231

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

   232

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

   233

				return;

   234

			}

   235

   236

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

   237

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

   238

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

   239

				return;

   240

			}

   241

   242

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

   243

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

   244

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

   245

				return;

   246

			}

   247

   248

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

   249

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

   250

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

   251

				return;

   252

			}

   253

   254

			return;

   255

		}

   256

	}

   257

   258

	{

   259

		DrawPixelInfo *dp = _cur_dpi;

   260

		dp->width = right - left;

   261

		dp->height = bottom - top;

   262

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

   263

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

   264

		dp->pitch = _screen.pitch;

   265

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

   266

		dp->zoom = 0;

   267

		CallWindowEventNP(w, WE_PAINT);

   268

	}

   269

}

   270

   271

void CallWindowEventNP(Window *w, int event)

   272

{

   273

	WindowEvent e;

   274

   275

	e.event = event;

   276

	w->wndproc(w, &e);

   277

}

   278

   279

void SetWindowDirty(const Window *w)

   280

{

   281

	if (w == NULL) return;

   282

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

   283

}

   284

   285

void DeleteWindow(Window *w)

   286

{

   287

	WindowClass wc;

   288

	WindowNumber wn;

   289

	Window *v;

   290

	int count;

   291

   292

	if (w == NULL) return;

   293

   294

	if (_thd.place_mode != VHM_NONE &&

   295

			_thd.window_class == w->window_class &&

   296

			_thd.window_number == w->window_number) {

   297

		ResetObjectToPlace();

   298

	}

   299

   300

	wc = w->window_class;

   301

	wn = w->window_number;

   302

   303

	CallWindowEventNP(w, WE_DESTROY);

   304

   305

	w = FindWindowById(wc, wn);

   306

   307

	if (w->viewport != NULL) {

   308

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

   309

		w->viewport->width = 0;

   310

		w->viewport = NULL;

   311

	}

   312

   313

	SetWindowDirty(w);

   314

   315

	free(w->widget);

   316

   317

	v = --_last_window;

   318

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

   319

	memmove(w, w + 1, count);

   320

}

   321

   322

Window *FindWindowById(WindowClass cls, WindowNumber number)

   323

{

   324

	Window *w;

   325

   326

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

   327

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

   328

	}

   329

   330

	return NULL;

   331

}

   332

   333

void DeleteWindowById(WindowClass cls, WindowNumber number)

   334

{

   335

	DeleteWindow(FindWindowById(cls, number));

   336

}

   337

   338

void DeleteWindowByClass(WindowClass cls)

   339

{

   340

	Window *w;

   341

   342

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

   343

		if (w->window_class == cls) {

   344

			DeleteWindow(w);

   345

			w = _windows;

   346

		} else {

   347

			w++;

   348

		}

   349

	}

   350

}

   351

   352

   353

static Window *BringWindowToFront(Window *w);

   354

   355

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   356

{

   357

	Window *w = FindWindowById(cls, number);

   358

   359

	if (w != NULL) {

   360

		w->flags4 |= WF_WHITE_BORDER_MASK;

   361

		SetWindowDirty(w);

   362

		w = BringWindowToFront(w);

   363

	}

   364

   365

	return w;

   366

}

   367

   368

static inline bool IsVitalWindow(const Window *w)

   369

{

   370

	WindowClass wc = w->window_class;

   371

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

   372

}

   373

   374

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

   375

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

   376

 * - Toolbar, Statusbar (always on)

   377

 * - New window, Chatbar (only if open)

   378

 * @param w window that is put into the foreground

   379

 */

   380

static Window *BringWindowToFront(Window *w)

   381

{

   382

	Window *v;

   383

	Window temp;

   384

   385

	v = _last_window;

   386

	do {

   387

		if (--v < _windows) return w;

   388

	} while (IsVitalWindow(v));

   389

   390

	if (w == v) return w;

   391

   392

	assert(w < v);

   393

   394

	temp = *w;

   395

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

   396

	*v = temp;

   397

   398

	SetWindowDirty(v);

   399

   400

	return v;

   401

}

   402

   403

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

   404

 * Keep all important windows intact. These are

   405

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

   406

 * - News window, Chatbar (when on)

   407

 * - Any sticked windows since we wanted to keep these

   408

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

   409

 */

   410

static Window *FindDeletableWindow(void)

   411

{

   412

	Window *w;

   413

   414

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

   415

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

   416

			return w;

   417

		}

   418

	}

   419

	return NULL;

   420

}

   421

   422

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

   423

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

   424

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

   425

 * @see FindDeletableWindow()

   426

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

   427

 */

   428

static Window *ForceFindDeletableWindow(void)

   429

{

   430

	Window *w;

   431

   432

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

   433

		assert(w < _last_window);

   434

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

   435

	}

   436

}

   437

   438

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

   439

{

   440

	return (w->original_widget == widget);

   441

}

   442

   443

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

   444

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

   445

{

   446

	w->original_widget = widget;

   447

   448

	if (widget != NULL) {

   449

		uint index = 1;

   450

		const Widget *wi;

   451

   452

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

   453

   454

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

   455

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

   456

	} else {

   457

		w->widget = NULL;

   458

	}

   459

}

   460

   461

/* Open a new window.

   462

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

   463

 * See descriptions for those functions for usage

   464

 * See AllocateWindow() for description of arguments.

   465

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

   466

 */

   467

static Window *LocalAllocateWindow(

   468

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

   469

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

   470

{

   471

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

   472

   473

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

   474

	if (w >= endof(_windows)) {

   475

		w = FindDeletableWindow();

   476

   477

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

   478

   479

		DeleteWindow(w);

   480

		w = _last_window;

   481

	}

   482

   483

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

   484

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

   485

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

   486

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

   487

	 * to de-braindeadize */

   488

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

   489

		Window *v;

   490

   491

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

   492

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

   493

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

   494

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

   495

		v = FindWindowById(WC_MAIN_TOOLBAR, 0);

   496

		if (v != NULL) {