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

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

    27

	WindowEvent e;

    28

	const Widget *wi;

    29

    30

	e.click.pt.x = x;

    31

	e.click.pt.y = y;

    32

	e.event = WE_CLICK;

    33

    34

	if (w->desc_flags & WDF_DEF_WIDGET) {

    35

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

    36

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

    37

    38

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

    39

    40

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

    41

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

    42

			return;

    43

    44

		if (wi->type & 0xE0) {

    45

			/* special widget handling for buttons*/

    46

			switch(wi->type) {

    47

			case WWT_IMGBTN  | WWB_PUSHBUTTON: /* WWT_PUSHIMGBTN */

    48

			case WWT_TEXTBTN | WWB_PUSHBUTTON: /* WWT_PUSHTXTBTN */

    49

				HandleButtonClick(w, e.click.widget);

    50

				break;

    51

			case WWT_NODISTXTBTN:

    52

				break;

    53

			}

    54

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

    55

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

    56

		}

    57

    58

		if (w->desc_flags & WDF_STD_BTN) {

    59

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

    60

				DeleteWindow(w);

    61

				return;

    62

			}

    63

    64

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

    65

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

    66

				return;

    67

			}

    68

		}

    69

    70

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

    71

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

    72

			return;

    73

		}

    74

    75

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

    76

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

    77

			w->flags4 ^= WF_STICKY;

    78

			InvalidateWidget(w, e.click.widget);

    79

			return;

    80

		}

    81

	}

    82

    83

	w->wndproc(w, &e);

    84

}

    85

    86

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

    87

	WindowEvent e;

    88

    89

	/* default tooltips handler? */

    90

	if (w->desc_flags & WDF_STD_TOOLTIPS) {

    91

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

    92

		if (e.click.widget < 0)

    93

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

    94

    95

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

    96

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

    97

			return;

    98

		}

    99

	}

   100

   101

	e.event = WE_RCLICK;

   102

	e.click.pt.x = x;

   103

	e.click.pt.y = y;

   104

	w->wndproc(w, &e);

   105

}

   106

   107

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

   108

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

   109

 * @param *w Window

   110

 * @param widget the widget where the scrollwheel was used

   111

 * @param wheel scroll up or down

   112

 */

   113

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

   114

{

   115

	const Widget *wi1, *wi2;

   116

	Scrollbar *sb;

   117

   118

	if (widget < 0) return;

   119

   120

	wi1 = &w->widget[widget];

   121

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

   122

   123

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

   124

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

   125

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

   126

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

   127

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

   128

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

   129

   130

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

   131

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

   132

			if (pos != sb->pos) {

   133

				sb->pos = pos;

   134

				SetWindowDirty(w);

   135

			}

   136

		}

   137

	}

   138

}

   139

   140

   141

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

   142

{

   143

	Window *w;

   144

	DrawPixelInfo bk;

   145

	_cur_dpi = &bk;

   146

   147

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

   148

		if (right > w->left &&

   149

				bottom > w->top &&

   150

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

   151

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

   152

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

   153

			}

   154

	}

   155

}

   156

   157

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

   158

{

   159

	Window *v = w;

   160

	int x;

   161

   162

	while (++v != _last_window) {

   163

		if (right > v->left &&

   164

				bottom > v->top &&

   165

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

   166

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

   167

   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

   218

{

   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)

   232

		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 &&

   267

			  w->window_number == number) {

   268

			return w;

   269

		}

   270

	}

   271

   272

	return NULL;

   273

}

   274

   275

void DeleteWindowById(WindowClass cls, WindowNumber number)

   276

{

   277

	DeleteWindow(FindWindowById(cls, number));

   278

}

   279

   280

void DeleteWindowByClass(WindowClass cls)

   281

{

   282

	Window *w;

   283

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

   284

		if (w->window_class == cls) {

   285

			DeleteWindow(w);

   286

			w = _windows;

   287

		} else

   288

			w++;

   289

	}

   290

}

   291

   292

Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)

   293

{

   294

	Window *w = FindWindowById(cls, number);

   295

   296

	if (w != NULL) {

   297

		w->flags4 |= WF_WHITE_BORDER_MASK;

   298

		SetWindowDirty(w);

   299

		w = BringWindowToFront(w);

   300

	}

   301

   302

	return w;

   303

}

   304

   305

static inline bool IsVitalWindow(const Window *w)

   306

{

   307

	WindowClass wc = w->window_class;

   308

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

   309

}

   310

   311

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

   312

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

   313

 * - Toolbar, Statusbar (always on)

   314

 * - New window, Chatbar (only if open)

   315

 * @param w window that is put into the foreground

   316

 */

   317

Window *BringWindowToFront(Window *w)

   318

{

   319

	Window *v;

   320

	Window temp;

   321

   322

	v = _last_window;

   323

	do {

   324

		if (--v < _windows)

   325

			return w;

   326

	} while (IsVitalWindow(v));

   327

   328

	if (w == v)

   329

		return w;

   330

   331

	assert(w < v);

   332

   333

	temp = *w;

   334

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

   335

	*v = temp;

   336

   337

	SetWindowDirty(v);

   338

   339

	return v;

   340

}

   341

   342

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

   343

 * Keep all important windows intact. These are

   344

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

   345

 * - News window, Chatbar (when on)

   346

 * - Any sticked windows since we wanted to keep these

   347

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

   348

 */

   349

static Window *FindDeletableWindow(void)

   350

{

   351

	Window *w;

   352

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

   353

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

   354

				return w;

   355

	}

   356

	return NULL;

   357

}

   358

   359

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

   360

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

   361

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

   362

 * @see FindDeletableWindow()

   363

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

   364

 */

   365

static Window *ForceFindDeletableWindow(void)

   366

{

   367

	Window *w;

   368

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

   369

		assert(w < _last_window);

   370

   371

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

   372

				return w;

   373

	}

   374

}

   375

   376

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

   377

{

   378

	return (w->original_widget == widget);

   379

}

   380

   381

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

   382

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

   383

{

   384

	w->original_widget = widget;

   385

   386

	if (widget != NULL) {

   387

		const Widget *wi = widget;

   388

		uint index = 1;

   389

		while (wi->type != WWT_LAST) {

   390

			wi++;

   391

			index++;

   392

		}

   393

   394

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

   395

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

   396

	} else

   397

		w->widget = NULL;

   398

}

   399

   400

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

   401

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

   402

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

   403

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

   404

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

   405

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

   406

 * @param width width in pixels of the window

   407

 * @param height height in pixels of the window

   408

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

   409

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

   410

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

   411

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

   412

 */

   413

Window *AllocateWindow(

   414

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

   415

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

   416

{

   417

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

   418

   419

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

   420

	if (w >= endof(_windows)) {

   421

		w = FindDeletableWindow();

   422

   423

		if (w == NULL) // no window found, force it!

   424

			w = ForceFindDeletableWindow();

   425

   426

		DeleteWindow(w);

   427

		w = _last_window;

   428

	}

   429

   430

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

   431

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

   432

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

   433

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

   434

	 * to de-braindeadize */

   435

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

   436

		Window *v;

   437

   438

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

   439

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

   440

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

   441

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

   442

		v = FindWindowById(WC_MAIN_TOOLBAR, 0);

   443

		if (v != NULL) {

   444

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

   445

			w = v;

   446

		}

   447

   448

		v = FindWindowById(WC_STATUS_BAR, 0);

   449

		if (v != NULL) {

   450

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

   451

			w = v;

   452

		}

   453

   454

		v = FindWindowById(WC_NEWS_WINDOW, 0);

   455

		if (v != NULL) {

   456

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

   457

			w = v;

   458

		}

   459

	}

   460

   461

	// Set up window properties

   462

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

   463

	w->window_class = cls;

   464

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

   465

	w->caption_color = 0xFF;

   466

	w->left = x;

   467

	w->top = y;

   468

	w->width = width;

   469

	w->height = height;

   470

	w->wndproc = proc;

   471

	AssignWidgetToWindow(w, widget);

   472

	w->resize.width = width;

   473

	w->resize.height = height;

   474

	w->resize.step_width = 1;

   475

	w->resize.step_height = 1;

   476

   477

	_last_window++;

   478

   479

	SetWindowDirty(w);

   480

   481

	CallWindowEventNP(w, WE_CREATE);

   482

   483

	return w;

   484

}

   485

   486

Window *AllocateWindowAutoPlace2(

   487

	WindowClass exist_class,

   488

	WindowNumber exist_num,

   489

	int width,

   490

	int height,

   491

	WindowProc *proc,

   492

	WindowClass cls,

   493

	const Widget *widget)

   494

{

   495

	Window *w;

   496

	int x;

   497

   498

	w = FindWindowById(exist_class, exist_num);

   499

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

   500

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

   501

	}

   502

   503

	x = w->left;