1

/* $Id$ */

     2

     3

/** @file signs_gui.cpp The GUI for signs. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "gui.h"

     8

#include "textbuf_gui.h"

     9

#include "window_gui.h"

    10

#include "player_gui.h"

    11

#include "player_func.h"

    12

#include "signs_base.h"

    13

#include "signs_func.h"

    14

#include "debug.h"

    15

#include "variables.h"

    16

#include "command_func.h"

    17

#include "strings_func.h"

    18

#include "core/alloc_func.hpp"

    19

#include "window_func.h"

    20

#include "map_func.h"

    21

#include "gfx_func.h"

    22

#include "viewport_func.h"

    23

#include "querystring_gui.h"

    24

#include "sortlist_type.h"

    25

#include "string_func.h"

    26

    27

#include "table/strings.h"

    28

#include "table/sprites.h"

    29

    30

struct SignList {

    31

	typedef GUIList<const Sign *> GUISignList;

    32

    33

	static const Sign *last_sign;

    34

	GUISignList signs;

    35

    36

	void BuildSignsList()

    37

	{

    38

		if (!this->signs.NeedRebuild()) return;

    39

    40

		DEBUG(misc, 3, "Building sign list");

    41

    42

		this->signs.Clear();

    43

    44

		const Sign *si;

    45

		FOR_ALL_SIGNS(si) *this->signs.Append() = si;

    46

    47

		this->signs.Compact();

    48

		this->signs.RebuildDone();

    49

	}

    50

    51

	/** Sort signs by their name */

    52

	static int CDECL SignNameSorter(const Sign* const *a, const Sign* const *b)

    53

	{

    54

		static char buf_cache[64];

    55

		char buf[64];

    56

    57

		SetDParam(0, (*a)->index);

    58

		GetString(buf, STR_SIGN_NAME, lastof(buf));

    59

    60

		if (*b != last_sign) {

    61

			last_sign = *b;

    62

			SetDParam(0, (*b)->index);

    63

			GetString(buf_cache, STR_SIGN_NAME, lastof(buf_cache));

    64

		}

    65

    66

		return strcasecmp(buf, buf_cache);

    67

	}

    68

    69

	void SortSignsList()

    70

	{

    71

		if (!this->signs.Sort(&SignNameSorter)) return;

    72

    73

		/* Reset the name sorter sort cache */

    74

		this->last_sign = NULL;

    75

	}

    76

};

    77

    78

const Sign *SignList::last_sign = NULL;

    79

    80

struct SignListWindow : Window, SignList {

    81

	SignListWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

    82

	{

    83

		this->vscroll.cap = 12;

    84

		this->resize.step_height = 10;

    85

		this->resize.height = this->height - 10 * 7; // minimum if 5 in the list

    86

    87

		this->signs.ForceRebuild();

    88

		this->signs.NeedResort();

    89

    90

		this->FindWindowPlacementAndResize(desc);

    91

	}

    92

    93

	virtual void OnPaint()

    94

	{

    95

		BuildSignsList();

    96

		SortSignsList();

    97

    98

		SetVScrollCount(this, this->signs.Length());

    99

   100

		SetDParam(0, this->vscroll.count);

   101

		this->DrawWidgets();

   102

   103

		/* No signs? */

   104

		int y = 16; // offset from top of widget

   105

		if (this->vscroll.count == 0) {

   106

			DrawString(2, y, STR_304A_NONE, TC_FROMSTRING);

   107

			return;

   108

		}

   109

   110

		/* Start drawing the signs */

   111

		for (uint16 i = this->vscroll.pos; i < this->vscroll.cap + this->vscroll.pos && i < this->vscroll.count; i++) {

   112

			const Sign *si = this->signs[i];

   113

   114

			if (si->owner != OWNER_NONE) DrawPlayerIcon(si->owner, 4, y + 1);

   115

   116

			SetDParam(0, si->index);

   117

			DrawString(22, y, STR_SIGN_NAME, TC_YELLOW);

   118

			y += 10;

   119

		}

   120

	}

   121

   122

	virtual void OnClick(Point pt, int widget)

   123

	{

   124

		if (widget == 3) {

   125

			uint32 id_v = (pt.y - 15) / 10;

   126

   127

			if (id_v >= this->vscroll.cap) return;

   128

			id_v += this->vscroll.pos;

   129

			if (id_v >= this->vscroll.count) return;

   130

   131

			const Sign *si = this->signs[id_v];

   132

			ScrollMainWindowToTile(TileVirtXY(si->x, si->y));

   133

		}

   134

	}

   135

   136

	virtual void OnResize(Point new_size, Point delta)

   137

	{

   138

		this->vscroll.cap += delta.y / 10;

   139

	}

   140

   141

	virtual void OnInvalidateData(int data)

   142

	{

   143

		if (data == 0) {

   144

			this->signs.ForceRebuild();

   145

		} else {

   146

			this->signs.ForceResort();

   147

		}

   148

	}

   149

};

   150

   151

static const Widget _sign_list_widget[] = {

   152

{   WWT_CLOSEBOX,   RESIZE_NONE,  COLOUR_GREY,     0,    10,     0,    13, STR_00C5,              STR_018B_CLOSE_WINDOW},

   153

{    WWT_CAPTION,  RESIZE_RIGHT,  COLOUR_GREY,    11,   345,     0,    13, STR_SIGN_LIST_CAPTION, STR_018C_WINDOW_TITLE_DRAG_THIS},

   154

{  WWT_STICKYBOX,     RESIZE_LR,  COLOUR_GREY,   346,   357,     0,    13, 0x0,                   STR_STICKY_BUTTON},

   155

{      WWT_PANEL,     RESIZE_RB,  COLOUR_GREY,     0,   345,    14,   137, 0x0,                   STR_NULL},

   156

{  WWT_SCROLLBAR,    RESIZE_LRB,  COLOUR_GREY,   346,   357,    14,   125, 0x0,                   STR_0190_SCROLL_BAR_SCROLLS_LIST},

   157

{  WWT_RESIZEBOX,   RESIZE_LRTB,  COLOUR_GREY,   346,   357,   126,   137, 0x0,                   STR_RESIZE_BUTTON},

   158

{   WIDGETS_END},

   159

};

   160

   161

static const WindowDesc _sign_list_desc = {

   162

	WDP_AUTO, WDP_AUTO, 358, 138, 358, 138,

   163

	WC_SIGN_LIST, WC_NONE,

   164

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_STICKY_BUTTON | WDF_RESIZABLE,

   165

	_sign_list_widget,

   166

};

   167

   168

   169

void ShowSignList()

   170

{

   171

	AllocateWindowDescFront<SignListWindow>(&_sign_list_desc, 0);

   172

}

   173

   174

/**

   175

 * Actually rename the sign.

   176

 * @param index the sign to rename.

   177

 * @param text  the new name.

   178

 * @return true if the window will already be removed after returning.

   179

 */

   180

static bool RenameSign(SignID index, const char *text)

   181

{

   182

	bool remove = StrEmpty(text);

   183

	_cmd_text = text;

   184

	DoCommandP(0, index, 0, NULL, CMD_RENAME_SIGN | (StrEmpty(text) ? CMD_MSG(STR_CAN_T_DELETE_SIGN) : CMD_MSG(STR_280C_CAN_T_CHANGE_SIGN_NAME)));

   185

	return remove;

   186

}

   187

   188

enum QueryEditSignWidgets {

   189

	QUERY_EDIT_SIGN_WIDGET_TEXT = 3,

   190

	QUERY_EDIT_SIGN_WIDGET_OK,

   191

	QUERY_EDIT_SIGN_WIDGET_CANCEL,

   192

	QUERY_EDIT_SIGN_WIDGET_DELETE,

   193

	QUERY_EDIT_SIGN_WIDGET_PREVIOUS = QUERY_EDIT_SIGN_WIDGET_DELETE + 2,

   194

	QUERY_EDIT_SIGN_WIDGET_NEXT,

   195

};

   196

   197

struct SignWindow : QueryStringBaseWindow, SignList {

   198

	SignID cur_sign;

   199

   200

	SignWindow(const WindowDesc *desc, const Sign *si) : QueryStringBaseWindow(MAX_LENGTH_SIGN_NAME_BYTES, desc)

   201

	{

   202

		SetBit(_no_scroll, SCROLL_EDIT);

   203

		this->caption = STR_280B_EDIT_SIGN_TEXT;

   204

		this->afilter = CS_ALPHANUMERAL;

   205

		this->LowerWidget(QUERY_EDIT_SIGN_WIDGET_TEXT);

   206

   207

		UpdateSignEditWindow(si);

   208

		this->FindWindowPlacementAndResize(desc);

   209

	}

   210

   211

	~SignWindow()

   212

	{

   213

		ClrBit(_no_scroll, SCROLL_EDIT);

   214

	}

   215

   216

	void UpdateSignEditWindow(const Sign *si)

   217

	{

   218

		char *last_of = &this->edit_str_buf[this->edit_str_size - 1];

   219

   220

		/* Display an empty string when the sign hasnt been edited yet */

   221

		if (si->name != NULL) {

   222

			SetDParam(0, si->index);

   223

			GetString(this->edit_str_buf, STR_SIGN_NAME, last_of);

   224

		} else {

   225

			GetString(this->edit_str_buf, STR_EMPTY, last_of);

   226

		}

   227

		*last_of = '\0';

   228

   229

		this->cur_sign = si->index;

   230

		InitializeTextBuffer(&this->text, this->edit_str_buf, this->edit_str_size, MAX_LENGTH_SIGN_NAME_PIXELS);

   231

   232

		this->InvalidateWidget(QUERY_EDIT_SIGN_WIDGET_TEXT);

   233

	}

   234

   235

	/**

   236

	 * Returns a pointer to the (alphabetically) previous or next sign of the current sign.

   237

	 * @param next false if the previous sign is wanted, true if the next sign is wanted

   238

	 * @return pointer to the previous/next sign

   239

	 */

   240

	const Sign *PrevNextSign(bool next)

   241

	{

   242

		/* Rebuild the sign list */

   243

		this->signs.ForceRebuild();

   244

		this->signs.NeedResort();

   245

		this->BuildSignsList();

   246

		this->SortSignsList();

   247

   248

		/* Search through the list for the current sign, excluding

   249

		 * - the first sign if we want the previous sign or

   250

		 * - the last sign if we want the next sign */

   251

		uint end = this->signs.Length() - (next ? 1 : 0);

   252

		for (uint i = next ? 0 : 1; i < end; i++) {

   253

			if (this->cur_sign == this->signs[i]->index) {

   254

				/* We've found the current sign, so return the sign before/after it */

   255

				return this->signs[i + (next ? 1 : -1)];

   256

			}

   257

		}

   258

		/* If we haven't found the current sign by now, return the last/first sign */

   259

		return this->signs[next ? 0 : this->signs.Length() - 1];

   260

	}

   261

   262

	virtual void OnPaint()

   263

	{

   264

		SetDParam(0, this->caption);

   265

		this->DrawWidgets();

   266

		this->DrawEditBox(QUERY_EDIT_SIGN_WIDGET_TEXT);

   267

	}

   268

   269

	virtual void OnClick(Point pt, int widget)

   270

	{

   271

		switch (widget) {

   272

			case QUERY_EDIT_SIGN_WIDGET_PREVIOUS:

   273

			case QUERY_EDIT_SIGN_WIDGET_NEXT: {

   274

				const Sign *si = this->PrevNextSign(widget == QUERY_EDIT_SIGN_WIDGET_NEXT);

   275

   276

				/* Rebuild the sign list */

   277

				this->signs.ForceRebuild();

   278

				this->signs.NeedResort();

   279

				this->BuildSignsList();

   280

				this->SortSignsList();

   281

   282

				/* Scroll to sign and reopen window */

   283

				ScrollMainWindowToTile(TileVirtXY(si->x, si->y));

   284

				UpdateSignEditWindow(si);

   285

				break;

   286

			}

   287

   288

			case QUERY_EDIT_SIGN_WIDGET_TEXT:

   289

				ShowOnScreenKeyboard(this, widget, QUERY_EDIT_SIGN_WIDGET_CANCEL, QUERY_EDIT_SIGN_WIDGET_OK);

   290

				break;

   291

   292

			case QUERY_EDIT_SIGN_WIDGET_DELETE:

   293

				/* Only need to set the buffer to null, the rest is handled as the OK button */

   294

				RenameSign(this->cur_sign, "");

   295

				/* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */

   296

				break;

   297

   298

			case QUERY_EDIT_SIGN_WIDGET_OK:

   299

				if (RenameSign(this->cur_sign, this->text.buf)) break;

   300

				/* FALL THROUGH */

   301

   302

			case QUERY_EDIT_SIGN_WIDGET_CANCEL:

   303

				delete this;

   304

				break;

   305

		}

   306

	}

   307

   308

	virtual EventState OnKeyPress(uint16 key, uint16 keycode)

   309

	{

   310

		EventState state = ES_NOT_HANDLED;

   311

		switch (this->HandleEditBoxKey(QUERY_EDIT_SIGN_WIDGET_TEXT, key, keycode, state)) {

   312

			case 1: // Enter pressed, confirms change

   313

				if (RenameSign(this->cur_sign, this->text.buf)) break;

   314

				/* FALL THROUGH */

   315

   316

			case 2: // ESC pressed, closes window, abandons changes

   317

				delete this;

   318

				break;

   319

		}

   320

		return state;

   321

	}

   322

   323

	virtual void OnMouseLoop()

   324

	{

   325

		this->HandleEditBox(QUERY_EDIT_SIGN_WIDGET_TEXT);

   326

	}

   327

};

   328

   329

static const Widget _query_sign_edit_widgets[] = {

   330

{ WWT_CLOSEBOX, RESIZE_NONE,  COLOUR_GREY,   0,  10,   0,  13, STR_00C5,          STR_018B_CLOSE_WINDOW},

   331

{  WWT_CAPTION, RESIZE_NONE,  COLOUR_GREY,  11, 259,   0,  13, STR_012D,          STR_NULL },

   332

{    WWT_PANEL, RESIZE_NONE,  COLOUR_GREY,   0, 259,  14,  29, STR_NULL,          STR_NULL },

   333

{  WWT_EDITBOX, RESIZE_NONE,  COLOUR_GREY,   2, 257,  16,  27, STR_SIGN_OSKTITLE, STR_NULL },  // Text field

   334

{  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY,   0,  60,  30,  41, STR_012F_OK,       STR_NULL },

   335

{  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY,  61, 120,  30,  41, STR_012E_CANCEL,   STR_NULL },

   336

{  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY, 121, 180,  30,  41, STR_0290_DELETE,   STR_NULL },

   337

{    WWT_PANEL, RESIZE_NONE,  COLOUR_GREY, 181, 237,  30,  41, STR_NULL,          STR_NULL },

   338

{  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY, 238, 248,  30,  41, STR_6819,          STR_PREVIOUS_SIGN_TOOLTIP },

   339

{  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY, 249, 259,  30,  41, STR_681A,          STR_NEXT_SIGN_TOOLTIP },

   340

{ WIDGETS_END },

   341

};

   342

   343

static const WindowDesc _query_sign_edit_desc = {

   344

	190, 170, 260, 42, 260, 42,

   345

	WC_QUERY_STRING, WC_NONE,

   346

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,

   347

	_query_sign_edit_widgets,

   348

};

   349

   350

void HandleClickOnSign(const Sign *si)

   351

{

   352

	if (_ctrl_pressed && si->owner == _local_player) {

   353

		RenameSign(si->index, NULL);

   354

		return;

   355

	}

   356

	ShowRenameSignWindow(si);

   357

}

   358

   359

void ShowRenameSignWindow(const Sign *si)

   360

{

   361

	/* Delete all other edit windows and the save window */

   362

	DeleteWindowById(WC_QUERY_STRING, 0);

   363

	DeleteWindowById(WC_SAVELOAD, 0);

   364

   365

	new SignWindow(&_query_sign_edit_desc, si);

   366

}

   367

   368

void DeleteRenameSignWindow(SignID sign)

   369

{

   370

	SignWindow *w = dynamic_cast<SignWindow *>(FindWindowById(WC_QUERY_STRING, 0));

   371

   372

	if (w != NULL && w->cur_sign == sign) delete w;

   373

}