tron@2186: /* $Id$ */
tron@2186: 
rubidium@9111: /** @file signs_gui.cpp The GUI for signs. */
belugas@6420: 
truelight@0: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
truelight@0: #include "gui.h"
rubidium@8107: #include "textbuf_gui.h"
rubidium@8107: #include "window_gui.h"
rubidium@10208: #include "company_gui.h"
rubidium@10208: #include "company_func.h"
rubidium@8790: #include "signs_base.h"
rubidium@8790: #include "signs_func.h"
truelight@1575: #include "debug.h"
tron@2159: #include "variables.h"
rubidium@8116: #include "command_func.h"
rubidium@8114: #include "strings_func.h"
rubidium@8130: #include "core/alloc_func.hpp"
rubidium@8131: #include "window_func.h"
rubidium@8139: #include "map_func.h"
rubidium@8224: #include "gfx_func.h"
rubidium@8224: #include "viewport_func.h"
rubidium@9179: #include "querystring_gui.h"
peter1138@9734: #include "sortlist_type.h"
smatz@10087: #include "string_func.h"
truelight@0: 
rubidium@8264: #include "table/strings.h"
rubidium@8264: #include "table/sprites.h"
rubidium@8264: 
peter1138@9734: struct SignList {
peter1138@9734: 	typedef GUIList<const Sign *> GUISignList;
truelight@1575: 
peter1138@9734: 	static const Sign *last_sign;
peter1138@9734: 	GUISignList signs;
truelight@1575: 
peter1138@9734: 	void BuildSignsList()
peter1138@9734: 	{
peter1138@9734: 		if (!this->signs.NeedRebuild()) return;
truelight@1575: 
peter1138@9734: 		DEBUG(misc, 3, "Building sign list");
peter1138@9734: 
peter1138@9734: 		this->signs.Clear();
peter1138@9734: 
peter1138@9734: 		const Sign *si;
peter1138@9734: 		FOR_ALL_SIGNS(si) *this->signs.Append() = si;
peter1138@9734: 
peter1138@9734: 		this->signs.Compact();
peter1138@9734: 		this->signs.RebuildDone();
truelight@1575: 	}
truelight@1575: 
peter1138@9734: 	/** Sort signs by their name */
peter1138@9734: 	static int CDECL SignNameSorter(const Sign* const *a, const Sign* const *b)
peter1138@9734: 	{
peter1138@9734: 		static char buf_cache[64];
peter1138@9734: 		char buf[64];
truelight@1575: 
peter1138@9734: 		SetDParam(0, (*a)->index);
peter1138@9734: 		GetString(buf, STR_SIGN_NAME, lastof(buf));
truelight@1575: 
peter1138@9734: 		if (*b != last_sign) {
peter1138@9734: 			last_sign = *b;
peter1138@9734: 			SetDParam(0, (*b)->index);
peter1138@9734: 			GetString(buf_cache, STR_SIGN_NAME, lastof(buf_cache));
peter1138@9734: 		}
truelight@1575: 
peter1138@9734: 		return strcasecmp(buf, buf_cache);
peter1138@9734: 	}
truelight@1575: 
peter1138@9734: 	void SortSignsList()
peter1138@9734: 	{
peter1138@9734: 		if (!this->signs.Sort(&SignNameSorter)) return;
peter1138@9734: 
peter1138@9734: 		/* Reset the name sorter sort cache */
peter1138@9734: 		this->last_sign = NULL;
peter1138@9734: 	}
peter1138@9734: };
peter1138@9734: 
peter1138@9734: const Sign *SignList::last_sign = NULL;
peter1138@9734: 
peter1138@9734: struct SignListWindow : Window, SignList {
rubidium@9316: 	SignListWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)
rubidium@9316: 	{
rubidium@9316: 		this->vscroll.cap = 12;
rubidium@9316: 		this->resize.step_height = 10;
rubidium@9316: 		this->resize.height = this->height - 10 * 7; // minimum if 5 in the list
truelight@1575: 
peter1138@9734: 		this->signs.ForceRebuild();
peter1138@9734: 		this->signs.NeedResort();
peter1138@9734: 
rubidium@9316: 		this->FindWindowPlacementAndResize(desc);
rubidium@9316: 	}
truelight@1575: 
rubidium@9316: 	virtual void OnPaint()
rubidium@9316: 	{
peter1138@9734: 		BuildSignsList();
peter1138@9734: 		SortSignsList();
truelight@1575: 
peter1138@9734: 		SetVScrollCount(this, this->signs.Length());
rubidium@8927: 
rubidium@9316: 		SetDParam(0, this->vscroll.count);
rubidium@9316: 		this->DrawWidgets();
rubidium@9316: 
rubidium@9316: 		/* No signs? */
rubidium@9316: 		int y = 16; // offset from top of widget
rubidium@9316: 		if (this->vscroll.count == 0) {
rubidium@9316: 			DrawString(2, y, STR_304A_NONE, TC_FROMSTRING);
rubidium@9316: 			return;
rubidium@9316: 		}
rubidium@9316: 
rubidium@9316: 		/* Start drawing the signs */
rubidium@9316: 		for (uint16 i = this->vscroll.pos; i < this->vscroll.cap + this->vscroll.pos && i < this->vscroll.count; i++) {
peter1138@9734: 			const Sign *si = this->signs[i];
rubidium@9316: 
rubidium@10207: 			if (si->owner != OWNER_NONE) DrawCompanyIcon(si->owner, 4, y + 1);
rubidium@9316: 
rubidium@9316: 			SetDParam(0, si->index);
rubidium@9316: 			DrawString(22, y, STR_SIGN_NAME, TC_YELLOW);
rubidium@9316: 			y += 10;
rubidium@9316: 		}
truelight@1575: 	}
rubidium@9316: 
rubidium@9316: 	virtual void OnClick(Point pt, int widget)
rubidium@9316: 	{
rubidium@9316: 		if (widget == 3) {
rubidium@9316: 			uint32 id_v = (pt.y - 15) / 10;
rubidium@9316: 
rubidium@9316: 			if (id_v >= this->vscroll.cap) return;
rubidium@9316: 			id_v += this->vscroll.pos;
rubidium@9316: 			if (id_v >= this->vscroll.count) return;
rubidium@9316: 
peter1138@9734: 			const Sign *si = this->signs[id_v];
rubidium@9316: 			ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
rubidium@9316: 		}
rubidium@9316: 	}
rubidium@9316: 
rubidium@9316: 	virtual void OnResize(Point new_size, Point delta)
rubidium@9316: 	{
rubidium@9316: 		this->vscroll.cap += delta.y / 10;
rubidium@9316: 	}
peter1138@9734: 
peter1138@9734: 	virtual void OnInvalidateData(int data)
peter1138@9734: 	{
peter1138@9734: 		if (data == 0) {
peter1138@9734: 			this->signs.ForceRebuild();
peter1138@9734: 		} else {
peter1138@9734: 			this->signs.ForceResort();
peter1138@9734: 		}
peter1138@9734: 	}
rubidium@9316: };
truelight@1575: 
truelight@1575: static const Widget _sign_list_widget[] = {
belugas@9764: {   WWT_CLOSEBOX,   RESIZE_NONE,  COLOUR_GREY,     0,    10,     0,    13, STR_00C5,              STR_018B_CLOSE_WINDOW},
belugas@9764: {    WWT_CAPTION,  RESIZE_RIGHT,  COLOUR_GREY,    11,   345,     0,    13, STR_SIGN_LIST_CAPTION, STR_018C_WINDOW_TITLE_DRAG_THIS},
belugas@9764: {  WWT_STICKYBOX,     RESIZE_LR,  COLOUR_GREY,   346,   357,     0,    13, 0x0,                   STR_STICKY_BUTTON},
belugas@9764: {      WWT_PANEL,     RESIZE_RB,  COLOUR_GREY,     0,   345,    14,   137, 0x0,                   STR_NULL},
belugas@9764: {  WWT_SCROLLBAR,    RESIZE_LRB,  COLOUR_GREY,   346,   357,    14,   125, 0x0,                   STR_0190_SCROLL_BAR_SCROLLS_LIST},
belugas@9764: {  WWT_RESIZEBOX,   RESIZE_LRTB,  COLOUR_GREY,   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@7341: 	WDP_AUTO, WDP_AUTO, 358, 138, 358, 138,
rubidium@5893: 	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@6247: void ShowSignList()
truelight@1575: {
rubidium@9316: 	AllocateWindowDescFront<SignListWindow>(&_sign_list_desc, 0);
truelight@1575: }
peter1138@7127: 
rubidium@10182: /**
rubidium@10182:  * Actually rename the sign.
rubidium@10182:  * @param index the sign to rename.
rubidium@10182:  * @param text  the new name.
rubidium@10182:  * @return true if the window will already be removed after returning.
rubidium@10182:  */
rubidium@10182: static bool RenameSign(SignID index, const char *text)
rubidium@9179: {
rubidium@10182: 	bool remove = StrEmpty(text);
rubidium@9179: 	_cmd_text = text;
smatz@10087: 	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)));
rubidium@10182: 	return remove;
rubidium@9179: }
peter1138@7127: 
peter1138@7127: enum QueryEditSignWidgets {
peter1138@7127: 	QUERY_EDIT_SIGN_WIDGET_TEXT = 3,
peter1138@7127: 	QUERY_EDIT_SIGN_WIDGET_OK,
peter1138@7127: 	QUERY_EDIT_SIGN_WIDGET_CANCEL,
peter1138@7127: 	QUERY_EDIT_SIGN_WIDGET_DELETE,
peter1138@7127: 	QUERY_EDIT_SIGN_WIDGET_PREVIOUS = QUERY_EDIT_SIGN_WIDGET_DELETE + 2,
peter1138@7127: 	QUERY_EDIT_SIGN_WIDGET_NEXT,
peter1138@7127: };
peter1138@7127: 
peter1138@9734: struct SignWindow : QueryStringBaseWindow, SignList {
rubidium@9179: 	SignID cur_sign;
peter1138@7127: 
rubidium@9913: 	SignWindow(const WindowDesc *desc, const Sign *si) : QueryStringBaseWindow(MAX_LENGTH_SIGN_NAME_BYTES, desc)
rubidium@9179: 	{
rubidium@9179: 		SetBit(_no_scroll, SCROLL_EDIT);
rubidium@9179: 		this->caption = STR_280B_EDIT_SIGN_TEXT;
rubidium@9179: 		this->afilter = CS_ALPHANUMERAL;
rubidium@9179: 		this->LowerWidget(QUERY_EDIT_SIGN_WIDGET_TEXT);
peter1138@7127: 
rubidium@9179: 		UpdateSignEditWindow(si);
rubidium@9305: 		this->FindWindowPlacementAndResize(desc);
rubidium@9179: 	}
peter1138@7127: 
rubidium@9179: 	~SignWindow()
rubidium@9179: 	{
rubidium@9179: 		ClrBit(_no_scroll, SCROLL_EDIT);
rubidium@9179: 	}
peter1138@7127: 
rubidium@9179: 	void UpdateSignEditWindow(const Sign *si)
rubidium@9179: 	{
smatz@10276: 		char *last_of = &this->edit_str_buf[this->edit_str_size - 1]; // points to terminating '\0'
rubidium@9897: 
rubidium@9179: 		/* Display an empty string when the sign hasnt been edited yet */
rubidium@9179: 		if (si->name != NULL) {
rubidium@9179: 			SetDParam(0, si->index);
rubidium@9897: 			GetString(this->edit_str_buf, STR_SIGN_NAME, last_of);
rubidium@9179: 		} else {
rubidium@9897: 			GetString(this->edit_str_buf, STR_EMPTY, last_of);
rubidium@9179: 		}
rubidium@9897: 		*last_of = '\0';
peter1138@7127: 
rubidium@9179: 		this->cur_sign = si->index;
rubidium@9913: 		InitializeTextBuffer(&this->text, this->edit_str_buf, this->edit_str_size, MAX_LENGTH_SIGN_NAME_PIXELS);
peter1138@7127: 
rubidium@9179: 		this->InvalidateWidget(QUERY_EDIT_SIGN_WIDGET_TEXT);
peter1138@7127: 	}
rubidium@9179: 
smatz@10157: 	/**
smatz@10157: 	 * Returns a pointer to the (alphabetically) previous or next sign of the current sign.
smatz@10157: 	 * @param next false if the previous sign is wanted, true if the next sign is wanted
smatz@10157: 	 * @return pointer to the previous/next sign
smatz@10157: 	 */
smatz@10157: 	const Sign *PrevNextSign(bool next)
smatz@10157: 	{
smatz@10157: 		/* Rebuild the sign list */
smatz@10157: 		this->signs.ForceRebuild();
smatz@10157: 		this->signs.NeedResort();
smatz@10157: 		this->BuildSignsList();
smatz@10157: 		this->SortSignsList();
smatz@10157: 
smatz@10157: 		/* Search through the list for the current sign, excluding
smatz@10157: 		 * - the first sign if we want the previous sign or
smatz@10157: 		 * - the last sign if we want the next sign */
smatz@10157: 		uint end = this->signs.Length() - (next ? 1 : 0);
smatz@10157: 		for (uint i = next ? 0 : 1; i < end; i++) {
smatz@10157: 			if (this->cur_sign == this->signs[i]->index) {
smatz@10157: 				/* We've found the current sign, so return the sign before/after it */
smatz@10157: 				return this->signs[i + (next ? 1 : -1)];
smatz@10157: 			}
smatz@10157: 		}
smatz@10157: 		/* If we haven't found the current sign by now, return the last/first sign */
smatz@10157: 		return this->signs[next ? 0 : this->signs.Length() - 1];
smatz@10157: 	}
smatz@10157: 
rubidium@9179: 	virtual void OnPaint()
rubidium@9179: 	{
rubidium@9179: 		SetDParam(0, this->caption);
rubidium@9273: 		this->DrawWidgets();
rubidium@9179: 		this->DrawEditBox(QUERY_EDIT_SIGN_WIDGET_TEXT);
rubidium@9179: 	}
rubidium@9179: 
rubidium@9179: 	virtual void OnClick(Point pt, int widget)
rubidium@9179: 	{
rubidium@9179: 		switch (widget) {
smatz@10157: 			case QUERY_EDIT_SIGN_WIDGET_PREVIOUS:
smatz@10157: 			case QUERY_EDIT_SIGN_WIDGET_NEXT: {
smatz@10157: 				const Sign *si = this->PrevNextSign(widget == QUERY_EDIT_SIGN_WIDGET_NEXT);
smatz@10157: 
peter1138@9734: 				/* Rebuild the sign list */
peter1138@9734: 				this->signs.ForceRebuild();
peter1138@9734: 				this->signs.NeedResort();
peter1138@9734: 				this->BuildSignsList();
peter1138@9734: 				this->SortSignsList();
peter1138@9734: 
rubidium@9179: 				/* Scroll to sign and reopen window */
rubidium@9179: 				ScrollMainWindowToTile(TileVirtXY(si->x, si->y));
rubidium@9179: 				UpdateSignEditWindow(si);
peter1138@9734: 				break;
peter1138@9734: 			}
rubidium@9179: 
rubidium@9179: 			case QUERY_EDIT_SIGN_WIDGET_TEXT:
rubidium@9179: 				ShowOnScreenKeyboard(this, widget, QUERY_EDIT_SIGN_WIDGET_CANCEL, QUERY_EDIT_SIGN_WIDGET_OK);
rubidium@9179: 				break;
rubidium@9179: 
rubidium@9179: 			case QUERY_EDIT_SIGN_WIDGET_DELETE:
rubidium@9179: 				/* Only need to set the buffer to null, the rest is handled as the OK button */
smatz@10156: 				RenameSign(this->cur_sign, "");
smatz@10156: 				/* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
smatz@10156: 				break;
rubidium@9179: 
rubidium@9179: 			case QUERY_EDIT_SIGN_WIDGET_OK:
rubidium@10182: 				if (RenameSign(this->cur_sign, this->text.buf)) break;
rubidium@9179: 				/* FALL THROUGH */
rubidium@9179: 
rubidium@9179: 			case QUERY_EDIT_SIGN_WIDGET_CANCEL:
rubidium@9179: 				delete this;
rubidium@9179: 				break;
rubidium@9179: 		}
rubidium@9179: 	}
rubidium@9179: 
rubidium@9285: 	virtual EventState OnKeyPress(uint16 key, uint16 keycode)
rubidium@9179: 	{
rubidium@9285: 		EventState state = ES_NOT_HANDLED;
rubidium@9285: 		switch (this->HandleEditBoxKey(QUERY_EDIT_SIGN_WIDGET_TEXT, key, keycode, state)) {
glx@10295: 			default: break;
glx@10295: 
glx@10295: 			case HEBR_CONFIRM:
rubidium@10182: 				if (RenameSign(this->cur_sign, this->text.buf)) break;
rubidium@9179: 				/* FALL THROUGH */
rubidium@9179: 
glx@10295: 			case HEBR_CANCEL: // close window, abandon changes
rubidium@9179: 				delete this;
rubidium@9179: 				break;
rubidium@9179: 		}
rubidium@9285: 		return state;
rubidium@9179: 	}
rubidium@9179: 
rubidium@9179: 	virtual void OnMouseLoop()
rubidium@9179: 	{
rubidium@9179: 		this->HandleEditBox(QUERY_EDIT_SIGN_WIDGET_TEXT);
rubidium@9179: 	}
rubidium@9179: };
peter1138@7127: 
peter1138@7127: static const Widget _query_sign_edit_widgets[] = {
belugas@9764: { WWT_CLOSEBOX, RESIZE_NONE,  COLOUR_GREY,   0,  10,   0,  13, STR_00C5,          STR_018B_CLOSE_WINDOW},
belugas@9764: {  WWT_CAPTION, RESIZE_NONE,  COLOUR_GREY,  11, 259,   0,  13, STR_012D,          STR_NULL },
belugas@9764: {    WWT_PANEL, RESIZE_NONE,  COLOUR_GREY,   0, 259,  14,  29, STR_NULL,          STR_NULL },
belugas@9764: {  WWT_EDITBOX, RESIZE_NONE,  COLOUR_GREY,   2, 257,  16,  27, STR_SIGN_OSKTITLE, STR_NULL },  // Text field
belugas@9764: {  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY,   0,  60,  30,  41, STR_012F_OK,       STR_NULL },
belugas@9764: {  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY,  61, 120,  30,  41, STR_012E_CANCEL,   STR_NULL },
belugas@9764: {  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY, 121, 180,  30,  41, STR_0290_DELETE,   STR_NULL },
belugas@9764: {    WWT_PANEL, RESIZE_NONE,  COLOUR_GREY, 181, 237,  30,  41, STR_NULL,          STR_NULL },
belugas@9764: {  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY, 238, 248,  30,  41, STR_6819,          STR_PREVIOUS_SIGN_TOOLTIP },
belugas@9764: {  WWT_TEXTBTN, RESIZE_NONE,  COLOUR_GREY, 249, 259,  30,  41, STR_681A,          STR_NEXT_SIGN_TOOLTIP },
peter1138@7127: { WIDGETS_END },
peter1138@7127: };
peter1138@7127: 
peter1138@7127: static const WindowDesc _query_sign_edit_desc = {
rubidium@7341: 	190, 170, 260, 42, 260, 42,
peter1138@7127: 	WC_QUERY_STRING, WC_NONE,
belugas@8019: 	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET,
peter1138@7127: 	_query_sign_edit_widgets,
peter1138@7127: };
peter1138@7127: 
smatz@9510: void HandleClickOnSign(const Sign *si)
smatz@9510: {
rubidium@10207: 	if (_ctrl_pressed && si->owner == _local_company) {
smatz@10087: 		RenameSign(si->index, NULL);
smatz@9510: 		return;
smatz@9510: 	}
smatz@9510: 	ShowRenameSignWindow(si);
smatz@9510: }
smatz@9510: 
peter1138@7127: void ShowRenameSignWindow(const Sign *si)
peter1138@7127: {
peter1138@7127: 	/* Delete all other edit windows and the save window */
peter1138@7127: 	DeleteWindowById(WC_QUERY_STRING, 0);
peter1138@7127: 	DeleteWindowById(WC_SAVELOAD, 0);
peter1138@7127: 
rubidium@9179: 	new SignWindow(&_query_sign_edit_desc, si);
peter1138@7127: }
smatz@10156: 
smatz@10156: void DeleteRenameSignWindow(SignID sign)
smatz@10156: {
smatz@10156: 	SignWindow *w = dynamic_cast<SignWindow *>(FindWindowById(WC_QUERY_STRING, 0));
smatz@10156: 
smatz@10156: 	if (w != NULL && w->cur_sign == sign) delete w;
smatz@10156: }