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

			w->flags4 ^= WF_STICKY;

    78

			InvalidateWidget(w, e.click.widget);

    79

			return;

    80

		}

    81

	}

    82

    83

	w->wndproc(w, &e);

    84

}

    85

    86

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

    87

{

    88

	WindowEvent e;

    89

    90

	/* default tooltips handler? */

    91

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

    92

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

    93

		if (e.click.widget < 0)

    94

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

    95

    96

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

    97

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

    98

			return;

    99

		}

   100

	}

   101

   102

	e.event = WE_RCLICK;

   103

	e.click.pt.x = x;

   104

	e.click.pt.y = y;

   105

	w->wndproc(w, &e);

   106

}

   107

   108

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

   109

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

   110

 * @param *w Window

   111

 * @param widget the widget where the scrollwheel was used

   112

 * @param wheel scroll up or down

   113

 */

   114

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

   115

{

   116

	const Widget *wi1, *wi2;

   117

	Scrollbar *sb;

   118

   119

	if (widget < 0) return;

   120

   121

	wi1 = &w->widget[widget];

   122

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

   123

   124

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

   125

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

   126

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

   127

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

   128

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

   129

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

   130

   131

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

   132

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

   133

			if (pos != sb->pos) {

   134

				sb->pos = pos;

   135

				SetWindowDirty(w);

   136

			}

   137

		}

   138

	}

   139

}

   140

   141

   142

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

   143

{

   144

	Window *w;

   145

	DrawPixelInfo bk;

   146

	_cur_dpi = &bk;

   147

   148

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

   149

		if (right > w->left &&

   150

				bottom > w->top &&

   151

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

   152

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

   153

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

   154

		}

   155

	}

   156

}

   157

   158

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

   159

{

   160

	const Window* v = w;

   161

	int x;

   162

   163

	while (++v != _last_window) {

   164

		if (right > v->left &&

   165

				bottom > v->top &&

   166

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

   167

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

   168

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

   169

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

   170

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

   171

				return;

   172

			}

   173

   174

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

   175

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

   176

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

   177

				return;

   178

			}

   179

   180

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

   181

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

   182

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

   183

				return;

   184

			}

   185

   186

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

   187

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

   188

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

   189

				return;

   190

			}

   191

   192

			return;

   193

		}

   194

	}

   195

   196

	{

   197

		DrawPixelInfo *dp = _cur_dpi;

   198

		dp->width = right - left;

   199

		dp->height = bottom - top;

   200

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

   201

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

   202

		dp->pitch = _screen.pitch;

   203

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

   204

		dp->zoom = 0;

   205

		CallWindowEventNP(w, WE_PAINT);

   206

	}

   207

}

   208

   209

void CallWindowEventNP(Window *w, int event)

   210

{

   211

	WindowEvent e;

   212

   213

	e.event = event;

   214

	w->wndproc(w, &e);

   215

}

   216

   217

void SetWindowDirty(const Window* w)

   218

{

   219

	if (w == NULL) return;

   220

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

   221

}

   222

   223

void DeleteWindow(Window *w)

   224

{

   225

	WindowClass wc;

   226

	WindowNumber wn;

   227

	ViewPort *vp;

   228

	Window *v;

   229

	int count;

   230

   231

	if (w == NULL) return;

   232

   233

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

   234

		ResetObjectToPlace();

   235

	}

   236

   237

	wc = w->window_class;

   238

	wn = w->window_number;

   239

   240

	CallWindowEventNP(w, WE_DESTROY);

   241

   242

	w = FindWindowById(wc, wn);

   243

   244

	vp = w->viewport;

   245

	w->viewport = NULL;

   246

	if (vp != NULL) {

   247

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

   248

		vp->width = 0;

   249

	}

   250

   251

	SetWindowDirty(w);

   252

   253

	free(w->widget);

   254

   255

	v = --_last_window;

   256

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

   257

	memmove(w, w + 1, count);

   258

}

   259

   260

Window *FindWindowById(WindowClass cls, WindowNumber number)

   261

{

   262

	Window *w;

   263

   264

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

   265

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

   266

	}

   267

   268

	return NULL;

   269

}

   270

   271

void DeleteWindowById(WindowClass cls, WindowNumber number)

   272

{

   273

	DeleteWindow(FindWindowById(cls, number));

   274

}

   275

   276

void DeleteWindowByClass(WindowClass cls)

   277

{

   278

	Window *w;

   279

   280

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

   281

		if (w->window_class == cls) {

   282

			DeleteWindow(w);

   283

			w = _windows;

   284

		} else {

   285

			w++;

   286

		}

   287

	}

   288

}

   289

   290

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   291

{

   292

	Window *w = FindWindowById(cls, number);

   293

   294

	if (w != NULL) {

   295

		w->flags4 |= WF_WHITE_BORDER_MASK;

   296

		SetWindowDirty(w);

   297

		w = BringWindowToFront(w);

   298

	}

   299

   300

	return w;

   301

}

   302

   303

static inline bool IsVitalWindow(const Window *w)

   304

{

   305

	WindowClass wc = w->window_class;

   306

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

   307

}

   308

   309

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

   310

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

   311

 * - Toolbar, Statusbar (always on)

   312

 * - New window, Chatbar (only if open)

   313

 * @param w window that is put into the foreground

   314

 */

   315

Window *BringWindowToFront(Window *w)

   316

{

   317

	Window *v;

   318

	Window temp;

   319

   320

	v = _last_window;

   321

	do {

   322

		if (--v < _windows) return w;

   323

	} while (IsVitalWindow(v));

   324

   325

	if (w == v) return w;

   326

   327

	assert(w < v);

   328

   329

	temp = *w;

   330

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

   331

	*v = temp;

   332

   333

	SetWindowDirty(v);

   334

   335

	return v;

   336

}

   337

   338

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

   339

 * Keep all important windows intact. These are

   340

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

   341

 * - News window, Chatbar (when on)

   342

 * - Any sticked windows since we wanted to keep these

   343

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

   344

 */

   345

static Window *FindDeletableWindow(void)

   346

{

   347

	Window *w;

   348

   349

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

   350

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

   351

			return w;

   352

		}

   353

	}

   354

	return NULL;

   355

}

   356

   357

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

   358

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

   359

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

   360

 * @see FindDeletableWindow()

   361

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

   362

 */

   363

static Window *ForceFindDeletableWindow(void)

   364

{

   365

	Window *w;

   366

   367

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

   368

		assert(w < _last_window);

   369

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

   370

	}

   371

}

   372

   373

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

   374

{

   375

	return (w->original_widget == widget);

   376

}

   377

   378

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

   379

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

   380

{

   381

	w->original_widget = widget;

   382

   383

	if (widget != NULL) {

   384

		uint index = 1;

   385

		const Widget* wi;

   386

   387

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

   388

   389

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

   390

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

   391

	} else {

   392

		w->widget = NULL;

   393

	}

   394

}

   395

   396

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

   397

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

   398

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

   399

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

   400

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

   401

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

   402

 * @param width width in pixels of the window

   403

 * @param height height in pixels of the window

   404

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

   405

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

   406

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

   407

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

   408

 */

   409

Window *AllocateWindow(

   410

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

   411

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

   412

{

   413

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

   414

   415

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

   416

	if (w >= endof(_windows)) {

   417

		w = FindDeletableWindow();

   418

   419

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

   420

   421

		DeleteWindow(w);

   422

		w = _last_window;

   423

	}

   424

   425

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

   426

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

   427

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

   428

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

   429

	 * to de-braindeadize */

   430

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

   431

		Window *v;

   432

   433

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

   434

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

   435

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

   436

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

   437

		v = FindWindowById(WC_MAIN_TOOLBAR, 0);

   438

		if (v != NULL) {

   439

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

   440

			w = v;

   441

		}

   442

   443

		v = FindWindowById(WC_STATUS_BAR, 0);

   444

		if (v != NULL) {

   445

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

   446

			w = v;

   447

		}

   448

   449

		v = FindWindowById(WC_NEWS_WINDOW, 0);

   450

		if (v != NULL) {

   451

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

   452

			w = v;

   453

		}

   454

	}

   455

   456

	// Set up window properties

   457

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

   458

	w->window_class = cls;

   459

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

   460

	w->caption_color = 0xFF;

   461

	w->left = x;

   462

	w->top = y;

   463

	w->width = width;

   464

	w->height = height;

   465

	w->wndproc = proc;

   466

	AssignWidgetToWindow(w, widget);

   467

	w->resize.width = width;

   468

	w->resize.height = height;

   469

	w->resize.step_width = 1;

   470

	w->resize.step_height = 1;

   471

   472

	_last_window++;

   473

   474

	SetWindowDirty(w);

   475

   476

	CallWindowEventNP(w, WE_CREATE);

   477

   478

	return w;

   479

}

   480

   481

Window *AllocateWindowAutoPlace2(

   482

	WindowClass exist_class,

   483

	WindowNumber exist_num,

   484

	int width,

   485

	int height,

   486

	WindowProc *proc,

   487

	WindowClass cls,

   488

	const Widget *widget)

   489

{

   490

	Window *w;

   491

	int x;

   492

   493

	w = FindWindowById(exist_class, exist_num);

   494

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

   495

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

   496

	}

   497

   498

	x = w->left;

   499

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

   500

   501

	return AllocateWindow(x + 10, w->top + 10, width, height, proc, cls, widget);