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

    16

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

    17

static Point _drag_delta;

    18

    19

void HandleButtonClick(Window *w, byte widget)

    20

{

    21

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

    22

	w->flags4 |= 5 << WF_TIMEOUT_SHL;

    23

	InvalidateWidget(w, widget);

    24

}

    25

    26

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

    27

{

    28

	WindowEvent e;

    29

	const Widget *wi;

    30

    31

	e.click.pt.x = x;

    32

	e.click.pt.y = y;

    33

	e.event = WE_CLICK;

    34

    35

	if (w->desc_flags & WDF_DEF_WIDGET) {

    36

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

    37

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

    38

    39

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

    40

    41

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

    42

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

    43

			return;

    44

    45

		if (wi->type & 0xE0) {

    46

			/* special widget handling for buttons*/

    47

			switch(wi->type) {

    48

			case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

    49

			case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

    50

				HandleButtonClick(w, e.click.widget);

    51

				break;

    52

			case WWT_NODISTXTBTN:

    53

				break;

    54

			}

    55

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

    56

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

    57

		}

    58

    59

		if (w->desc_flags & WDF_STD_BTN) {

    60

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

    61

				DeleteWindow(w);

    62

				return;

    63

			}

    64

    65

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

    66

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

    67

				return;

    68

			}

    69

		}

    70

    71

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

    72

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

    73

			return;

    74

		}

    75

    76

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

    77

			TOGGLEBIT(w->click_state, e.click.widget);

    78

			w->flags4 ^= WF_STICKY;

    79

			InvalidateWidget(w, e.click.widget);

    80

			return;

    81

		}

    82

	}

    83

    84

	w->wndproc(w, &e);

    85

}

    86

    87

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

    88

{

    89

	WindowEvent e;

    90

    91

	/* default tooltips handler? */

    92

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

    93

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

    94

		if (e.click.widget < 0)

    95

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

    96

    97

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

    98

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

    99

			return;

   100

		}

   101

	}

   102

   103

	e.event = WE_RCLICK;

   104

	e.click.pt.x = x;

   105

	e.click.pt.y = y;

   106

	w->wndproc(w, &e);

   107

}

   108

   109

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

   110

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

   111

 * @param *w Window

   112

 * @param widget the widget where the scrollwheel was used

   113

 * @param wheel scroll up or down

   114

 */

   115

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

   116

{

   117

	const Widget *wi1, *wi2;

   118

	Scrollbar *sb;

   119

   120

	if (widget < 0) return;

   121

   122

	wi1 = &w->widget[widget];

   123

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

   124

   125

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

   126

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

   127

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

   128

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

   129

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

   130

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

   131

   132

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

   133

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

   134

			if (pos != sb->pos) {

   135

				sb->pos = pos;

   136

				SetWindowDirty(w);

   137

			}

   138

		}

   139

	}

   140

}

   141

   142

   143

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

   144

{

   145

	Window *w;

   146

	DrawPixelInfo bk;

   147

	_cur_dpi = &bk;

   148

   149

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

   150

		if (right > w->left &&

   151

				bottom > w->top &&

   152

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

   153

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

   154

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

   155

		}

   156

	}

   157

}

   158

   159

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

   160

{

   161

	const Window* v = w;

   162

	int x;

   163

   164

	while (++v != _last_window) {

   165

		if (right > v->left &&

   166

				bottom > v->top &&

   167

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

   168

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

   169

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

   170

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

   171

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

   172

				return;

   173

			}

   174

   175

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

   176

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

   177

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

   178

				return;

   179

			}

   180

   181

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

   182

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

   183

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

   184

				return;

   185

			}

   186

   187

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

   188

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

   189

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

   190

				return;

   191

			}

   192

   193

			return;

   194

		}

   195

	}

   196

   197

	{

   198

		DrawPixelInfo *dp = _cur_dpi;

   199

		dp->width = right - left;

   200

		dp->height = bottom - top;

   201

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

   202

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

   203

		dp->pitch = _screen.pitch;

   204

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

   205

		dp->zoom = 0;

   206

		CallWindowEventNP(w, WE_PAINT);

   207

	}

   208

}

   209

   210

void CallWindowEventNP(Window *w, int event)

   211

{

   212

	WindowEvent e;

   213

   214

	e.event = event;

   215

	w->wndproc(w, &e);

   216

}

   217

   218

void SetWindowDirty(const Window* w)

   219

{

   220

	if (w == NULL) return;

   221

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

   222

}

   223

   224

void DeleteWindow(Window *w)

   225

{

   226

	WindowClass wc;

   227

	WindowNumber wn;

   228

	ViewPort *vp;

   229

	Window *v;

   230

	int count;

   231

   232

	if (w == NULL) return;

   233

   234

	if (_thd.place_mode != 0 && _thd.window_class == w->window_class && _thd.window_number == w->window_number) {

   235

		ResetObjectToPlace();

   236

	}

   237

   238

	wc = w->window_class;

   239

	wn = w->window_number;

   240

   241

	CallWindowEventNP(w, WE_DESTROY);

   242

   243

	w = FindWindowById(wc, wn);

   244

   245

	vp = w->viewport;

   246

	w->viewport = NULL;

   247

	if (vp != NULL) {

   248

		_active_viewports &= ~(1 << (vp - _viewports));

   249

		vp->width = 0;

   250

	}

   251

   252

	SetWindowDirty(w);

   253

   254

	free(w->widget);

   255

   256

	v = --_last_window;

   257

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

   258

	memmove(w, w + 1, count);

   259

}

   260

   261

Window *FindWindowById(WindowClass cls, WindowNumber number)

   262

{

   263

	Window *w;

   264

   265

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

   266

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

   267

	}

   268

   269

	return NULL;

   270

}

   271

   272

void DeleteWindowById(WindowClass cls, WindowNumber number)

   273

{

   274

	DeleteWindow(FindWindowById(cls, number));

   275

}

   276

   277

void DeleteWindowByClass(WindowClass cls)

   278

{

   279

	Window *w;

   280

   281

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

   282

		if (w->window_class == cls) {

   283

			DeleteWindow(w);

   284

			w = _windows;

   285

		} else {

   286

			w++;

   287

		}

   288

	}

   289

}

   290

   291

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   292

{

   293

	Window *w = FindWindowById(cls, number);

   294

   295

	if (w != NULL) {

   296

		w->flags4 |= WF_WHITE_BORDER_MASK;

   297

		SetWindowDirty(w);

   298

		w = BringWindowToFront(w);

   299

	}

   300

   301

	return w;

   302

}

   303

   304

static inline bool IsVitalWindow(const Window *w)

   305

{

   306

	WindowClass wc = w->window_class;

   307

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

   308

}

   309

   310

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

   311

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

   312

 * - Toolbar, Statusbar (always on)

   313

 * - New window, Chatbar (only if open)

   314

 * @param w window that is put into the foreground

   315

 */

   316

Window *BringWindowToFront(Window *w)

   317

{

   318

	Window *v;

   319

	Window temp;

   320

   321

	v = _last_window;

   322

	do {

   323

		if (--v < _windows) return w;

   324

	} while (IsVitalWindow(v));

   325

   326

	if (w == v) return w;

   327

   328

	assert(w < v);

   329

   330

	temp = *w;

   331

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

   332

	*v = temp;

   333

   334

	SetWindowDirty(v);

   335

   336

	return v;

   337

}

   338

   339

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

   340

 * Keep all important windows intact. These are

   341

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

   342

 * - News window, Chatbar (when on)

   343

 * - Any sticked windows since we wanted to keep these

   344

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

   345

 */

   346

static Window *FindDeletableWindow(void)

   347

{

   348

	Window *w;

   349

   350

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

   351

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

   352

			return w;

   353

		}

   354

	}

   355

	return NULL;

   356

}

   357

   358

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

   359

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

   360

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

   361

 * @see FindDeletableWindow()

   362

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

   363

 */

   364

static Window *ForceFindDeletableWindow(void)

   365

{

   366

	Window *w;

   367

   368

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

   369

		assert(w < _last_window);

   370

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

   371

	}

   372

}

   373

   374

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

   375

{

   376

	return (w->original_widget == widget);

   377

}

   378

   379

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

   380

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

   381

{

   382

	w->original_widget = widget;

   383

   384

	if (widget != NULL) {

   385

		uint index = 1;

   386

		const Widget* wi;

   387

   388

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

   389

   390

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

   391

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

   392

	} else {

   393

		w->widget = NULL;

   394

	}

   395

}

   396

   397

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

   398

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

   399

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

   400

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

   401

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

   402

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

   403

 * @param width width in pixels of the window

   404

 * @param height height in pixels of the window

   405

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

   406

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

   407

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

   408

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

   409

 */

   410

Window *AllocateWindow(

   411

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

   412

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

   413

{

   414

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

   415

   416

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

   417

	if (w >= endof(_windows)) {

   418

		w = FindDeletableWindow();

   419

   420

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

   421

   422

		DeleteWindow(w);

   423

		w = _last_window;

   424

	}

   425

   426

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

   427

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

   428

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

   429

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

   430

	 * to de-braindeadize */

   431

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

   432

		Window *v;

   433

   434

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

   435

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

   436

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

   437

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

   438

		v = FindWindowById(WC_MAIN_TOOLBAR, 0);

   439

		if (v != NULL) {

   440

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

   441

			w = v;

   442

		}

   443

   444

		v = FindWindowById(WC_STATUS_BAR, 0);

   445

		if (v != NULL) {

   446

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

   447

			w = v;

   448

		}

   449

   450

		v = FindWindowById(WC_NEWS_WINDOW, 0);

   451

		if (v != NULL) {

   452

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

   453

			w = v;

   454

		}

   455

	}

   456

   457

	// Set up window properties

   458

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

   459

	w->window_class = cls;

   460

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

   461

	w->caption_color = 0xFF;

   462

	w->left = x;

   463

	w->top = y;

   464

	w->width = width;

   465

	w->height = height;

   466

	w->wndproc = proc;

   467

	AssignWidgetToWindow(w, widget);

   468

	w->resize.width = width;

   469

	w->resize.height = height;

   470

	w->resize.step_width = 1;

   471

	w->resize.step_height = 1;

   472

   473

	_last_window++;

   474

   475

	SetWindowDirty(w);

   476

   477

	CallWindowEventNP(w, WE_CREATE);

   478

   479

	return w;

   480

}

   481

   482

Window *AllocateWindowAutoPlace2(

   483

	WindowClass exist_class,

   484

	WindowNumber exist_num,

   485

	int width,

   486

	int height,

   487

	WindowProc *proc,

   488

	WindowClass cls,

   489

	const Widget *widget)

   490

{

   491

	Window *w;

   492

	int x;

   493

   494

	w = FindWindowById(exist_class, exist_num);

   495

	if (w == NULL || w->left >= (_screen.width-20) || w->left <= -60 || w->top >= (_screen.height-20)) {

   496

		return AllocateWindowAutoPlace(width,height,proc,cls,widget);

   497

	}

   498

   499

	x = w->left;

   500

	if (x > _screen.width - width) x = _screen.width - width - 20;

   501