tron@2186: /* $Id$ */
tron@2186: 
rubidium@10429: /** @file signs_gui.cpp The GUI for signs. */
belugas@6916: 
truelight@0: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
truelight@0: #include "gui.h"
rubidium@8603: #include "textbuf_gui.h"
rubidium@8603: #include "window_gui.h"
rubidium@8750: #include "player_gui.h"
smatz@10947: #include "player_func.h"
rubidium@9286: #include "signs_base.h"
rubidium@9286: #include "signs_func.h"
truelight@1575: #include "debug.h"
tron@2159: #include "variables.h"
rubidium@8612: #include "command_func.h"
rubidium@8610: #include "strings_func.h"
rubidium@8626: #include "core/alloc_func.hpp"
rubidium@8627: #include "window_func.h"
rubidium@8635: #include "map_func.h"
rubidium@8720: #include "gfx_func.h"
rubidium@8720: #include "viewport_func.h"
rubidium@10499: #include "querystring_gui.h"
truelight@0: 
rubidium@8760: #include "table/strings.h"
rubidium@8760: #include "table/sprites.h"
rubidium@8760: 
tron@4353: static const Sign **_sign_sort;
tron@4353: static uint _num_sign_sort;
truelight@1575: 
truelight@1575: static char _bufcache[64];
tron@4353: static const Sign *_last_sign;
truelight@1575: 
truelight@1575: static int CDECL SignNameSorter(const void *a, const void *b)
truelight@1575: {
tron@4353: 	const Sign *sign0 = *(const Sign**)a;
tron@4353: 	const Sign *sign1 = *(const Sign**)b;
truelight@1575: 	char buf1[64];
truelight@1575: 
peter1138@8754: 	SetDParam(0, sign0->index);
peter1138@8754: 	GetString(buf1, STR_SIGN_NAME, lastof(buf1));
truelight@1575: 
tron@4353: 	if (sign1 != _last_sign) {
tron@4353: 		_last_sign = sign1;
peter1138@8754: 		SetDParam(0, sign1->index);
peter1138@8754: 		GetString(_bufcache, STR_SIGN_NAME, lastof(_bufcache));
truelight@1575: 	}
truelight@1575: 
belugas@3801: 	return strcmp(buf1, _bufcache); // sort by name
truelight@1575: }
truelight@1575: 
rubidium@6573: static void GlobalSortSignList()
truelight@1575: {
truelight@4349: 	const Sign *si;
tron@4353: 	uint n = 0;
truelight@1575: 
truelight@1575: 	/* Create array for sorting */
KUDr@5860: 	_sign_sort = ReallocT(_sign_sort, GetMaxSignIndex() + 1);
truelight@1575: 
tron@4353: 	FOR_ALL_SIGNS(si) _sign_sort[n++] = si;
tron@4353: 	_num_sign_sort = n;
tron@4353: 
tron@4353: 	qsort((void*)_sign_sort, n, sizeof(_sign_sort[0]), SignNameSorter);
truelight@1575: 
truelight@1575: 	_sign_sort_dirty = false;
truelight@1575: 
Darkvater@5568: 	DEBUG(misc, 3, "Resorting global signs list");
truelight@1575: }
truelight@1575: 
rubidium@10640: struct SignListWindow : Window {
rubidium@10640: 	SignListWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)
rubidium@10640: 	{
rubidium@10640: 		this->vscroll.cap = 12;
rubidium@10640: 		this->resize.step_height = 10;
rubidium@10640: 		this->resize.height = this->height - 10 * 7; // minimum if 5 in the list
truelight@1575: 
rubidium@10640: 		this->FindWindowPlacementAndResize(desc);
rubidium@10640: 	}
truelight@1575: 
rubidium@10640: 	virtual void OnPaint()
rubidium@10640: 	{
rubidium@10640: 		if (_sign_sort_dirty) GlobalSortSignList();
truelight@1575: 
rubidium@10640: 		SetVScrollCount(this, _num_sign_sort);
rubidium@10166: 
rubidium@10640: 		SetDParam(0, this->vscroll.count);
rubidium@10640: 		this->DrawWidgets();
rubidium@10640: 
rubidium@10640: 		/* No signs? */
rubidium@10640: 		int y = 16; // offset from top of widget
rubidium@10640: 		if (this->vscroll.count == 0) {
rubidium@10640: 			DrawString(2, y, STR_304A_NONE, TC_FROMSTRING);
rubidium@10640: 			return;
rubidium@10640: 		}
rubidium@10640: 
rubidium@10640: 		/* Start drawing the signs */
rubidium@10640: 		for (uint16 i = this->vscroll.pos; i < this->vscroll.cap + this->vscroll.pos && i < this->vscroll.count; i++) {
rubidium@10640: 			const Sign *si = _sign_sort[i];
rubidium@10640: 
rubidium@10640: 			if (si->owner != OWNER_NONE) DrawPlayerIcon(si->owner, 4, y + 1);
rubidium@10640: 
rubidium@10640: 			SetDParam(0, si->index);
rubidium@10640: 			DrawString(22, y, STR_SIGN_NAME, TC_YELLOW);
rubidium@10640: 			y += 10;
rubidium@10640: 		}
truelight@1575: 	}
rubidium@10640: 
rubidium@10640: 	virtual void OnClick(Point pt, int widget)
rubidium@10640: 	{
rubidium@10640: 		if (widget == 3) {
rubidium@10640: 			uint32 id_v = (pt.y - 15) / 10;
rubidium@10640: 
rubidium@10640: 			if (id_v >= this->vscroll.cap) return;
rubidium@10640: 			id_v += this->vscroll.pos;
rubidium@10640: 			if (id_v >= this->vscroll.count) return;
rubidium@10640: 
rubidium@10640: 			const Sign *si = _sign_sort[id_v];
rubidium@10640: 			ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
rubidium@10640: 		}
rubidium@10640: 	}
rubidium@10640: 
rubidium@10640: 	virtual void OnResize(Point new_size, Point delta)
rubidium@10640: 	{
rubidium@10640: 		this->vscroll.cap += delta.y / 10;
rubidium@10640: 	}
rubidium@10640: };
truelight@1575: 
truelight@1575: static const Widget _sign_list_widget[] = {
rubidium@4344: {   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,              STR_018B_CLOSE_WINDOW},
rubidium@4344: {    WWT_CAPTION,  RESIZE_RIGHT,    14,    11,   345,     0,    13, STR_SIGN_LIST_CAPTION, STR_018C_WINDOW_TITLE_DRAG_THIS},
rubidium@4344: {  WWT_STICKYBOX,     RESIZE_LR,    14,   346,   357,     0,    13, 0x0,                   STR_STICKY_BUTTON},
rubidium@4344: {      WWT_PANEL,     RESIZE_RB,    14,     0,   345,    14,   137, 0x0,                   STR_NULL},
rubidium@4344: {  WWT_SCROLLBAR,    RESIZE_LRB,    14,   346,   357,    14,   125, 0x0,                   STR_0190_SCROLL_BAR_SCROLLS_LIST},
rubidium@4344: {  WWT_RESIZEBOX,   RESIZE_LRTB,    14,   346,   357,   126,   137, 0x0,                   STR_RESIZE_BUTTON},
truelight@1575: {   WIDGETS_END},
truelight@1575: };
truelight@1575: 
truelight@1575: static const WindowDesc _sign_list_desc = {
rubidium@7837: 	WDP_AUTO, WDP_AUTO, 358, 138, 358, 138,
rubidium@6144: 	WC_SIGN_LIST, WC_NONE,
truelight@1575: 	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_STICKY_BUTTON | WDF_RESIZABLE,
truelight@1575: 	_sign_list_widget,
truelight@1575: };
truelight@1575: 
truelight@1575: 
rubidium@6573: void ShowSignList()
truelight@1575: {
rubidium@10640: 	AllocateWindowDescFront<SignListWindow>(&_sign_list_desc, 0);
truelight@1575: }
peter1138@7623: 
rubidium@10499: static void RenameSign(SignID index, const char *text)
rubidium@10499: {
rubidium@10499: 	_cmd_text = text;
rubidium@10499: 	DoCommandP(0, index, 0, NULL, CMD_RENAME_SIGN | CMD_MSG(STR_280C_CAN_T_CHANGE_SIGN_NAME));
rubidium@10499: }
peter1138@7623: 
peter1138@7623: enum QueryEditSignWidgets {
peter1138@7623: 	QUERY_EDIT_SIGN_WIDGET_TEXT = 3,
peter1138@7623: 	QUERY_EDIT_SIGN_WIDGET_OK,
peter1138@7623: 	QUERY_EDIT_SIGN_WIDGET_CANCEL,
peter1138@7623: 	QUERY_EDIT_SIGN_WIDGET_DELETE,
peter1138@7623: 	QUERY_EDIT_SIGN_WIDGET_PREVIOUS = QUERY_EDIT_SIGN_WIDGET_DELETE + 2,
peter1138@7623: 	QUERY_EDIT_SIGN_WIDGET_NEXT,
peter1138@7623: };
peter1138@7623: 
rubidium@10499: struct SignWindow : QueryStringBaseWindow {
rubidium@10499: 	SignID cur_sign;
peter1138@7623: 
rubidium@10499: 	SignWindow(const WindowDesc *desc, const Sign *si) : QueryStringBaseWindow(desc)
rubidium@10499: 	{
rubidium@10499: 		SetBit(_no_scroll, SCROLL_EDIT);
rubidium@10499: 		this->caption = STR_280B_EDIT_SIGN_TEXT;
rubidium@10499: 		this->afilter = CS_ALPHANUMERAL;
rubidium@10499: 		this->LowerWidget(QUERY_EDIT_SIGN_WIDGET_TEXT);
peter1138@7623: 
rubidium@10499: 		UpdateSignEditWindow(si);
rubidium@10629: 		this->FindWindowPlacementAndResize(desc);
rubidium@10499: 	}
peter1138@7623: 
rubidium@10499: 	~SignWindow()
rubidium@10499: 	{
rubidium@10499: 		ClrBit(_no_scroll, SCROLL_EDIT);
rubidium@10499: 	}
peter1138@7623: 
rubidium@10499: 	void UpdateSignEditWindow(const Sign *si)
rubidium@10499: 	{
rubidium@10499: 		/* Display an empty string when the sign hasnt been edited yet */
rubidium@10499: 		if (si->name != NULL) {
rubidium@10499: 			SetDParam(0, si->index);
rubidium@10499: 			GetString(this->edit_str_buf, STR_SIGN_NAME, lastof(this->edit_str_buf));
rubidium@10499: 		} else {
rubidium@10499: 			GetString(this->edit_str_buf, STR_EMPTY, lastof(this->edit_str_buf));
rubidium@10499: 		}
rubidium@10499: 		this->edit_str_buf[lengthof(this->edit_str_buf) - 1] = '\0';
peter1138@7623: 
rubidium@10499: 		this->cur_sign = si->index;
rubidium@10499: 		InitializeTextBuffer(&this->text, this->edit_str_buf, 31, 255); // Allow 31 characters (including \0)
peter1138@7623: 
rubidium@10499: 		this->InvalidateWidget(QUERY_EDIT_SIGN_WIDGET_TEXT);
peter1138@7623: 	}
rubidium@10499: 
rubidium@10499: 	virtual void OnPaint()
rubidium@10499: 	{
rubidium@10499: 		SetDParam(0, this->caption);
rubidium@10595: 		this->DrawWidgets();
rubidium@10499: 		this->DrawEditBox(QUERY_EDIT_SIGN_WIDGET_TEXT);
rubidium@10499: 	}
rubidium@10499: 
rubidium@10499: 	virtual void OnClick(Point pt, int widget)
rubidium@10499: 	{
rubidium@10499: 		switch (widget) {
rubidium@10499: 			case QUERY_EDIT_SIGN_WIDGET_PREVIOUS: {
rubidium@10499: 				if (_sign_sort_dirty) GlobalSortSignList();
rubidium@10499: 				SignID sign_index = _sign_sort[_num_sign_sort - 1]->index;
rubidium@10499: 				for (uint i = 1; i < _num_sign_sort; i++) {
rubidium@10499: 					if (this->cur_sign == _sign_sort[i]->index) {
rubidium@10499: 						sign_index = _sign_sort[i - 1]->index;
rubidium@10499: 						break;
rubidium@10499: 					}
rubidium@10499: 				}
rubidium@10499: 				const Sign *si = GetSign(sign_index);
rubidium@10499: 
rubidium@10499: 				/* Scroll to sign and reopen window */
rubidium@10499: 				ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
rubidium@10499: 				UpdateSignEditWindow(si);
rubidium@10499: 			} break;
rubidium@10499: 
rubidium@10499: 			case QUERY_EDIT_SIGN_WIDGET_NEXT: {
rubidium@10499: 				if (_sign_sort_dirty) GlobalSortSignList();
rubidium@10499: 				SignID sign_index = _sign_sort[0]->index;
rubidium@10499: 				for (uint i = 0; i < _num_sign_sort - 1; i++) {
rubidium@10499: 					if (this->cur_sign == _sign_sort[i]->index) {
rubidium@10499: 						sign_index = _sign_sort[i + 1]->index;
rubidium@10499: 						break;
rubidium@10499: 					}
rubidium@10499: 				}
rubidium@10499: 				const Sign *si = GetSign(sign_index);
rubidium@10499: 
rubidium@10499: 				/* Scroll to sign and reopen window */
rubidium@10499: 				ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
rubidium@10499: 				UpdateSignEditWindow(si);
rubidium@10499: 			} break;
rubidium@10499: 
rubidium@10499: 			case QUERY_EDIT_SIGN_WIDGET_TEXT:
rubidium@10499: 				ShowOnScreenKeyboard(this, widget, QUERY_EDIT_SIGN_WIDGET_CANCEL, QUERY_EDIT_SIGN_WIDGET_OK);
rubidium@10499: 				break;
rubidium@10499: 
rubidium@10499: 			case QUERY_EDIT_SIGN_WIDGET_DELETE:
rubidium@10499: 				/* Only need to set the buffer to null, the rest is handled as the OK button */
rubidium@10499: 				DeleteTextBufferAll(&this->text);
rubidium@10499: 				/* FALL THROUGH */
rubidium@10499: 
rubidium@10499: 			case QUERY_EDIT_SIGN_WIDGET_OK:
rubidium@10499: 				RenameSign(this->cur_sign, this->text.buf);
rubidium@10499: 				/* FALL THROUGH */
rubidium@10499: 
rubidium@10499: 			case QUERY_EDIT_SIGN_WIDGET_CANCEL:
rubidium@10499: 				delete this;
rubidium@10499: 				break;
rubidium@10499: 		}
rubidium@10499: 	}
rubidium@10499: 
rubidium@10607: 	virtual EventState OnKeyPress(uint16 key, uint16 keycode)
rubidium@10499: 	{
rubidium@10607: 		EventState state = ES_NOT_HANDLED;
rubidium@10607: 		switch (this->HandleEditBoxKey(QUERY_EDIT_SIGN_WIDGET_TEXT, key, keycode, state)) {
rubidium@10499: 			case 1: // Enter pressed, confirms change
rubidium@10499: 				RenameSign(this->cur_sign, this->text.buf);
rubidium@10499: 				/* FALL THROUGH */
rubidium@10499: 
rubidium@10499: 			case 2: // ESC pressed, closes window, abandons changes
rubidium@10499: 				delete this;
rubidium@10499: 				break;
rubidium@10499: 		}
rubidium@10607: 		return state;
rubidium@10499: 	}
rubidium@10499: 
rubidium@10499: 	virtual void OnMouseLoop()
rubidium@10499: 	{
rubidium@10499: 		this->HandleEditBox(QUERY_EDIT_SIGN_WIDGET_TEXT);
rubidium@10499: 	}
rubidium@10499: };
peter1138@7623: 
peter1138@7623: static const Widget _query_sign_edit_widgets[] = {
rubidium@9233: { WWT_CLOSEBOX, RESIZE_NONE,  14,   0,  10,   0,  13, STR_00C5,          STR_018B_CLOSE_WINDOW},
rubidium@9233: {  WWT_CAPTION, RESIZE_NONE,  14,  11, 259,   0,  13, STR_012D,          STR_NULL },
rubidium@9233: {    WWT_PANEL, RESIZE_NONE,  14,   0, 259,  14,  29, STR_NULL,          STR_NULL },
rubidium@9233: {  WWT_EDITBOX, RESIZE_NONE,  14,   2, 257,  16,  27, STR_SIGN_OSKTITLE, STR_NULL },  // Text field
rubidium@9233: {  WWT_TEXTBTN, RESIZE_NONE,  14,   0,  60,  30,  41, STR_012F_OK,       STR_NULL },
rubidium@9233: {  WWT_TEXTBTN, RESIZE_NONE,  14,  61, 120,  30,  41, STR_012E_CANCEL,   STR_NULL },
rubidium@9233: {  WWT_TEXTBTN, RESIZE_NONE,  14, 121, 180,  30,  41, STR_0290_DELETE,   STR_NULL },
rubidium@9233: {    WWT_PANEL, RESIZE_NONE,  14, 181, 237,  30,  41, STR_NULL,          STR_NULL },
rubidium@9233: {  WWT_TEXTBTN, RESIZE_NONE,  14, 238, 248,  30,  41, STR_6819,          STR_PREVIOUS_SIGN_TOOLTIP },
rubidium@9233: {  WWT_TEXTBTN, RESIZE_NONE,  14, 249, 259,  30,  41, STR_681A,          STR_NEXT_SIGN_TOOLTIP },
peter1138@7623: { WIDGETS_END },
peter1138@7623: };
peter1138@7623: 
peter1138@7623: static const WindowDesc _query_sign_edit_desc = {
rubidium@7837: 	190, 170, 260, 42, 260, 42,
peter1138@7623: 	WC_QUERY_STRING, WC_NONE,
belugas@8515: 	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,
peter1138@7623: 	_query_sign_edit_widgets,
peter1138@7623: };
peter1138@7623: 
smatz@10947: void HandleClickOnSign(const Sign *si)
smatz@10947: {
smatz@10947: 	if (_ctrl_pressed && si->owner == _local_player) {
smatz@10947: 		RenameSign(si->index, "");
smatz@10947: 		return;
smatz@10947: 	}
smatz@10947: 	ShowRenameSignWindow(si);
smatz@10947: }
smatz@10947: 
peter1138@7623: void ShowRenameSignWindow(const Sign *si)
peter1138@7623: {
peter1138@7623: 	/* Delete all other edit windows and the save window */
peter1138@7623: 	DeleteWindowById(WC_QUERY_STRING, 0);
peter1138@7623: 	DeleteWindowById(WC_SAVELOAD, 0);
peter1138@7623: 
rubidium@10499: 	new SignWindow(&_query_sign_edit_desc, si);
peter1138@7623: }