4 * This file is part of OpenTTD.
5 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
10 /** @file signs_gui.cpp The GUI for signs. */
13 #include "company_gui.h"
14 #include "company_func.h"
15 #include "signs_base.h"
16 #include "signs_func.h"
18 #include "command_func.h"
19 #include "strings_func.h"
20 #include "window_func.h"
22 #include "viewport_func.h"
23 #include "querystring_gui.h"
24 #include "sortlist_type.h"
25 #include "stringfilter_type.h"
26 #include "string_func.h"
27 #include "core/geometry_func.hpp"
29 #include "transparency.h"
31 #include "widgets/sign_widget.h"
33 #include "table/strings.h"
34 #include "table/sprites.h"
36 #include "safeguards.h"
40 * A GUIList contains signs and uses a StringFilter for filtering.
42 typedef GUIList
<const Sign
*, StringFilter
&> GUISignList
;
44 static const Sign
*last_sign
;
47 StringFilter string_filter
; ///< The match string to be used when the GUIList is (re)-sorted.
48 static bool match_case
; ///< Should case sensitive matching be used?
51 * Creates a SignList with filtering disabled by default.
53 SignList() : string_filter(&match_case
)
59 if (!this->signs
.NeedRebuild()) return;
61 DEBUG(misc
, 3, "Building sign list");
66 FOR_ALL_SIGNS(si
) *this->signs
.Append() = si
;
68 this->signs
.SetFilterState(true);
69 this->FilterSignList();
70 this->signs
.Compact();
71 this->signs
.RebuildDone();
74 /** Sort signs by their name */
75 static int CDECL
SignNameSorter(const Sign
* const *a
, const Sign
* const *b
)
77 static char buf_cache
[64];
80 SetDParam(0, (*a
)->index
);
81 GetString(buf
, STR_SIGN_NAME
, lastof(buf
));
83 if (*b
!= last_sign
) {
85 SetDParam(0, (*b
)->index
);
86 GetString(buf_cache
, STR_SIGN_NAME
, lastof(buf_cache
));
89 int r
= strnatcmp(buf
, buf_cache
); // Sort by name (natural sorting).
91 return r
!= 0 ? r
: ((*a
)->index
- (*b
)->index
);
96 if (!this->signs
.Sort(&SignNameSorter
)) return;
98 /* Reset the name sorter sort cache */
99 this->last_sign
= NULL
;
102 /** Filter sign list by sign name */
103 static bool CDECL
SignNameFilter(const Sign
* const *a
, StringFilter
&filter
)
105 /* Get sign string */
106 char buf1
[MAX_LENGTH_SIGN_NAME_CHARS
* MAX_CHAR_LENGTH
];
107 SetDParam(0, (*a
)->index
);
108 GetString(buf1
, STR_SIGN_NAME
, lastof(buf1
));
111 filter
.AddLine(buf1
);
112 return filter
.GetState();
115 /** Filter sign list excluding OWNER_DEITY */
116 static bool CDECL
OwnerDeityFilter(const Sign
* const *a
, StringFilter
&filter
)
118 /* You should never be able to edit signs of owner DEITY */
119 return (*a
)->owner
!= OWNER_DEITY
;
122 /** Filter sign list by owner */
123 static bool CDECL
OwnerVisibilityFilter(const Sign
* const *a
, StringFilter
&filter
)
125 assert(!HasBit(_display_opt
, DO_SHOW_COMPETITOR_SIGNS
));
126 /* Hide sign if non-own signs are hidden in the viewport */
127 return (*a
)->owner
== _local_company
|| (*a
)->owner
== OWNER_DEITY
;
130 /** Filter out signs from the sign list that does not match the name filter */
131 void FilterSignList()
133 this->signs
.Filter(&SignNameFilter
, this->string_filter
);
134 if (_game_mode
!= GM_EDITOR
) this->signs
.Filter(&OwnerDeityFilter
, this->string_filter
);
135 if (!HasBit(_display_opt
, DO_SHOW_COMPETITOR_SIGNS
)) {
136 this->signs
.Filter(&OwnerVisibilityFilter
, this->string_filter
);
141 const Sign
*SignList::last_sign
= NULL
;
142 bool SignList::match_case
= false;
144 /** Enum referring to the Hotkeys in the sign list window */
145 enum SignListHotkeys
{
146 SLHK_FOCUS_FILTER_BOX
, ///< Focus the edit box for editing the filter string
149 struct SignListWindow
: Window
, SignList
{
150 QueryString filter_editbox
; ///< Filter editbox;
151 int text_offset
; ///< Offset of the sign text relative to the left edge of the WID_SIL_LIST widget.
154 SignListWindow(WindowDesc
*desc
, WindowNumber window_number
) : Window(desc
), filter_editbox(MAX_LENGTH_SIGN_NAME_CHARS
* MAX_CHAR_LENGTH
, MAX_LENGTH_SIGN_NAME_CHARS
)
156 this->CreateNestedTree();
157 this->vscroll
= this->GetScrollbar(WID_SIL_SCROLLBAR
);
158 this->FinishInitNested(window_number
);
159 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN
, SignList::match_case
);
161 /* Initialize the text edit widget */
162 this->querystrings
[WID_SIL_FILTER_TEXT
] = &this->filter_editbox
;
163 this->filter_editbox
.cancel_button
= QueryString::ACTION_CLEAR
;
165 /* Initialize the filtering variables */
166 this->SetFilterString("");
168 /* Create initial list. */
169 this->signs
.ForceRebuild();
170 this->signs
.ForceResort();
171 this->BuildSortSignList();
175 * This function sets the filter string of the sign list. The contents of
176 * the edit widget is not updated by this function. Depending on if the
177 * new string is zero-length or not the clear button is made
178 * disabled/enabled. The sign list is updated according to the new filter.
180 void SetFilterString(const char *new_filter_string
)
182 /* check if there is a new filter string */
183 this->string_filter
.SetFilterTerm(new_filter_string
);
185 /* Rebuild the list of signs */
186 this->InvalidateData();
189 virtual void OnPaint()
191 if (this->signs
.NeedRebuild()) this->BuildSortSignList();
195 virtual void DrawWidget(const Rect
&r
, int widget
) const
199 uint y
= r
.top
+ WD_FRAMERECT_TOP
; // Offset from top of widget.
201 if (this->vscroll
->GetCount() == 0) {
202 DrawString(r
.left
+ WD_FRAMETEXT_LEFT
, r
.right
- WD_FRAMETEXT_RIGHT
, y
, STR_STATION_LIST_NONE
);
206 bool rtl
= _current_text_dir
== TD_RTL
;
207 int sprite_offset_y
= (FONT_HEIGHT_NORMAL
- 10) / 2 + 1;
208 uint icon_left
= 4 + (rtl
? r
.right
- this->text_offset
: r
.left
);
209 uint text_left
= r
.left
+ (rtl
? WD_FRAMERECT_LEFT
: this->text_offset
);
210 uint text_right
= r
.right
- (rtl
? this->text_offset
: WD_FRAMERECT_RIGHT
);
212 /* At least one sign available. */
213 for (uint16 i
= this->vscroll
->GetPosition(); this->vscroll
->IsVisible(i
) && i
< this->vscroll
->GetCount(); i
++) {
214 const Sign
*si
= this->signs
[i
];
216 if (si
->owner
!= OWNER_NONE
) DrawCompanyIcon(si
->owner
, icon_left
, y
+ sprite_offset_y
);
218 SetDParam(0, si
->index
);
219 DrawString(text_left
, text_right
, y
, STR_SIGN_NAME
, TC_YELLOW
);
220 y
+= this->resize
.step_height
;
227 virtual void SetStringParameters(int widget
) const
229 if (widget
== WID_SIL_CAPTION
) SetDParam(0, this->vscroll
->GetCount());
232 virtual void OnClick(Point pt
, int widget
, int click_count
)
236 uint id_v
= this->vscroll
->GetScrolledRowFromWidget(pt
.y
, this, WID_SIL_LIST
, WD_FRAMERECT_TOP
);
237 if (id_v
== INT_MAX
) return;
239 const Sign
*si
= this->signs
[id_v
];
240 ScrollMainWindowToTile(TileVirtXY(si
->x
, si
->y
));
244 case WID_SIL_FILTER_ENTER_BTN
:
245 if (this->signs
.Length() >= 1) {
246 const Sign
*si
= this->signs
[0];
247 ScrollMainWindowToTile(TileVirtXY(si
->x
, si
->y
));
251 case WID_SIL_FILTER_MATCH_CASE_BTN
:
252 SignList::match_case
= !SignList::match_case
; // Toggle match case
253 this->SetWidgetLoweredState(WID_SIL_FILTER_MATCH_CASE_BTN
, SignList::match_case
); // Toggle button pushed state
254 this->InvalidateData(); // Rebuild the list of signs
259 virtual void OnResize()
261 this->vscroll
->SetCapacityFromWidget(this, WID_SIL_LIST
, WD_FRAMERECT_TOP
+ WD_FRAMERECT_BOTTOM
);
264 virtual void UpdateWidgetSize(int widget
, Dimension
*size
, const Dimension
&padding
, Dimension
*fill
, Dimension
*resize
)
268 Dimension spr_dim
= GetSpriteSize(SPR_COMPANY_ICON
);
269 this->text_offset
= WD_FRAMETEXT_LEFT
+ spr_dim
.width
+ 2; // 2 pixels space between icon and the sign text.
270 resize
->height
= max
<uint
>(FONT_HEIGHT_NORMAL
, spr_dim
.height
);
271 Dimension d
= {(uint
)(this->text_offset
+ WD_FRAMETEXT_RIGHT
), WD_FRAMERECT_TOP
+ 5 * resize
->height
+ WD_FRAMERECT_BOTTOM
};
272 *size
= maxdim(*size
, d
);
276 case WID_SIL_CAPTION
:
277 SetDParamMaxValue(0, Sign::GetPoolSize(), 3);
278 *size
= GetStringBoundingBox(STR_SIGN_LIST_CAPTION
);
279 size
->height
+= padding
.height
;
280 size
->width
+= padding
.width
;
285 virtual EventState
OnHotkey(int hotkey
)
288 case SLHK_FOCUS_FILTER_BOX
:
289 this->SetFocusedWidget(WID_SIL_FILTER_TEXT
);
290 SetFocusedWindow(this); // The user has asked to give focus to the text box, so make sure this window is focused.
294 return ES_NOT_HANDLED
;
300 virtual void OnEditboxChanged(int widget
)
302 if (widget
== WID_SIL_FILTER_TEXT
) this->SetFilterString(this->filter_editbox
.text
.buf
);
305 void BuildSortSignList()
307 if (this->signs
.NeedRebuild()) {
308 this->BuildSignsList();
309 this->vscroll
->SetCount(this->signs
.Length());
310 this->SetWidgetDirty(WID_SIL_CAPTION
);
312 this->SortSignsList();
315 virtual void OnHundredthTick()
317 this->BuildSortSignList();
322 * Some data on this window has become invalid.
323 * @param data Information about the changed data.
324 * @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
326 virtual void OnInvalidateData(int data
= 0, bool gui_scope
= true)
328 /* When there is a filter string, we always need to rebuild the list even if
329 * the amount of signs in total is unchanged, as the subset of signs that is
330 * accepted by the filter might has changed. */
331 if (data
== 0 || data
== -1 || !this->string_filter
.IsEmpty()) { // New or deleted sign, changed visibility setting or there is a filter string
332 /* This needs to be done in command-scope to enforce rebuilding before resorting invalid data */
333 this->signs
.ForceRebuild();
334 } else { // Change of sign contents while there is no filter string
335 this->signs
.ForceResort();
339 static HotkeyList hotkeys
;
343 * Handler for global hotkeys of the SignListWindow.
344 * @param hotkey Hotkey
345 * @return ES_HANDLED if hotkey was accepted.
347 static EventState
SignListGlobalHotkeys(int hotkey
)
349 if (_game_mode
== GM_MENU
) return ES_NOT_HANDLED
;
350 Window
*w
= ShowSignList();
351 if (w
== NULL
) return ES_NOT_HANDLED
;
352 return w
->OnHotkey(hotkey
);
355 static Hotkey signlist_hotkeys
[] = {
356 Hotkey('F', "focus_filter_box", SLHK_FOCUS_FILTER_BOX
),
359 HotkeyList
SignListWindow::hotkeys("signlist", signlist_hotkeys
, SignListGlobalHotkeys
);
361 static const NWidgetPart _nested_sign_list_widgets
[] = {
362 NWidget(NWID_HORIZONTAL
),
363 NWidget(WWT_CLOSEBOX
, COLOUR_GREY
),
364 NWidget(WWT_CAPTION
, COLOUR_GREY
, WID_SIL_CAPTION
), SetDataTip(STR_SIGN_LIST_CAPTION
, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS
),
365 NWidget(WWT_SHADEBOX
, COLOUR_GREY
),
366 NWidget(WWT_DEFSIZEBOX
, COLOUR_GREY
),
367 NWidget(WWT_STICKYBOX
, COLOUR_GREY
),
369 NWidget(NWID_HORIZONTAL
),
370 NWidget(NWID_VERTICAL
),
371 NWidget(WWT_PANEL
, COLOUR_GREY
, WID_SIL_LIST
), SetMinimalSize(WD_FRAMETEXT_LEFT
+ 16 + 255 + WD_FRAMETEXT_RIGHT
, 50),
372 SetResize(1, 10), SetFill(1, 0), SetScrollbar(WID_SIL_SCROLLBAR
), EndContainer(),
373 NWidget(NWID_HORIZONTAL
),
374 NWidget(WWT_PANEL
, COLOUR_GREY
), SetFill(1, 1),
375 NWidget(WWT_EDITBOX
, COLOUR_GREY
, WID_SIL_FILTER_TEXT
), SetMinimalSize(80, 12), SetResize(1, 0), SetFill(1, 0), SetPadding(2, 2, 2, 2),
376 SetDataTip(STR_LIST_FILTER_OSKTITLE
, STR_LIST_FILTER_TOOLTIP
),
378 NWidget(WWT_TEXTBTN
, COLOUR_GREY
, WID_SIL_FILTER_MATCH_CASE_BTN
), SetDataTip(STR_SIGN_LIST_MATCH_CASE
, STR_SIGN_LIST_MATCH_CASE_TOOLTIP
),
381 NWidget(NWID_VERTICAL
),
382 NWidget(NWID_VERTICAL
), SetFill(0, 1),
383 NWidget(NWID_VSCROLLBAR
, COLOUR_GREY
, WID_SIL_SCROLLBAR
),
385 NWidget(WWT_RESIZEBOX
, COLOUR_GREY
),
390 static WindowDesc
_sign_list_desc(
391 WDP_AUTO
, "list_signs", 358, 138,
392 WC_SIGN_LIST
, WC_NONE
,
394 _nested_sign_list_widgets
, lengthof(_nested_sign_list_widgets
),
395 &SignListWindow::hotkeys
399 * Open the sign list window
401 * @return newly opened sign list window, or NULL if the window could not be opened.
403 Window
*ShowSignList()
405 return AllocateWindowDescFront
<SignListWindow
>(&_sign_list_desc
, 0);
409 * Actually rename the sign.
410 * @param index the sign to rename.
411 * @param text the new name.
412 * @return true if the window will already be removed after returning.
414 static bool RenameSign(SignID index
, const char *text
)
416 bool remove
= StrEmpty(text
);
417 DoCommandP(0, index
, 0, CMD_RENAME_SIGN
| (StrEmpty(text
) ? CMD_MSG(STR_ERROR_CAN_T_DELETE_SIGN
) : CMD_MSG(STR_ERROR_CAN_T_CHANGE_SIGN_NAME
)), NULL
, text
);
421 struct SignWindow
: Window
, SignList
{
422 QueryString name_editbox
;
425 SignWindow(WindowDesc
*desc
, const Sign
*si
) : Window(desc
), name_editbox(MAX_LENGTH_SIGN_NAME_CHARS
* MAX_CHAR_LENGTH
, MAX_LENGTH_SIGN_NAME_CHARS
)
427 this->querystrings
[WID_QES_TEXT
] = &this->name_editbox
;
428 this->name_editbox
.caption
= STR_EDIT_SIGN_CAPTION
;
429 this->name_editbox
.cancel_button
= WID_QES_CANCEL
;
430 this->name_editbox
.ok_button
= WID_QES_OK
;
432 this->InitNested(WN_QUERY_STRING_SIGN
);
434 UpdateSignEditWindow(si
);
435 this->SetFocusedWidget(WID_QES_TEXT
);
438 void UpdateSignEditWindow(const Sign
*si
)
440 /* Display an empty string when the sign hasn't been edited yet */
441 if (si
->name
!= NULL
) {
442 SetDParam(0, si
->index
);
443 this->name_editbox
.text
.Assign(STR_SIGN_NAME
);
445 this->name_editbox
.text
.DeleteAll();
448 this->cur_sign
= si
->index
;
450 this->SetWidgetDirty(WID_QES_TEXT
);
451 this->SetFocusedWidget(WID_QES_TEXT
);
455 * Returns a pointer to the (alphabetically) previous or next sign of the current sign.
456 * @param next false if the previous sign is wanted, true if the next sign is wanted
457 * @return pointer to the previous/next sign
459 const Sign
*PrevNextSign(bool next
)
461 /* Rebuild the sign list */
462 this->signs
.ForceRebuild();
463 this->signs
.NeedResort();
464 this->BuildSignsList();
465 this->SortSignsList();
467 /* Search through the list for the current sign, excluding
468 * - the first sign if we want the previous sign or
469 * - the last sign if we want the next sign */
470 uint end
= this->signs
.Length() - (next
? 1 : 0);
471 for (uint i
= next
? 0 : 1; i
< end
; i
++) {
472 if (this->cur_sign
== this->signs
[i
]->index
) {
473 /* We've found the current sign, so return the sign before/after it */
474 return this->signs
[i
+ (next
? 1 : -1)];
477 /* If we haven't found the current sign by now, return the last/first sign */
478 return this->signs
[next
? 0 : this->signs
.Length() - 1];
481 virtual void SetStringParameters(int widget
) const
484 case WID_QES_CAPTION
:
485 SetDParam(0, this->name_editbox
.caption
);
490 virtual void OnClick(Point pt
, int widget
, int click_count
)
493 case WID_QES_PREVIOUS
:
495 const Sign
*si
= this->PrevNextSign(widget
== WID_QES_NEXT
);
497 /* Rebuild the sign list */
498 this->signs
.ForceRebuild();
499 this->signs
.NeedResort();
500 this->BuildSignsList();
501 this->SortSignsList();
503 /* Scroll to sign and reopen window */
504 ScrollMainWindowToTile(TileVirtXY(si
->x
, si
->y
));
505 UpdateSignEditWindow(si
);
510 /* Only need to set the buffer to null, the rest is handled as the OK button */
511 RenameSign(this->cur_sign
, "");
512 /* don't delete this, we are deleted in Sign::~Sign() -> DeleteRenameSignWindow() */
516 if (RenameSign(this->cur_sign
, this->name_editbox
.text
.buf
)) break;
526 static const NWidgetPart _nested_query_sign_edit_widgets
[] = {
527 NWidget(NWID_HORIZONTAL
),
528 NWidget(WWT_CLOSEBOX
, COLOUR_GREY
),
529 NWidget(WWT_CAPTION
, COLOUR_GREY
, WID_QES_CAPTION
), SetDataTip(STR_WHITE_STRING
, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS
),
531 NWidget(WWT_PANEL
, COLOUR_GREY
),
532 NWidget(WWT_EDITBOX
, COLOUR_GREY
, WID_QES_TEXT
), SetMinimalSize(256, 12), SetDataTip(STR_EDIT_SIGN_SIGN_OSKTITLE
, STR_NULL
), SetPadding(2, 2, 2, 2),
534 NWidget(NWID_HORIZONTAL
),
535 NWidget(WWT_PUSHTXTBTN
, COLOUR_GREY
, WID_QES_OK
), SetMinimalSize(61, 12), SetDataTip(STR_BUTTON_OK
, STR_NULL
),
536 NWidget(WWT_PUSHTXTBTN
, COLOUR_GREY
, WID_QES_CANCEL
), SetMinimalSize(60, 12), SetDataTip(STR_BUTTON_CANCEL
, STR_NULL
),
537 NWidget(WWT_PUSHTXTBTN
, COLOUR_GREY
, WID_QES_DELETE
), SetMinimalSize(60, 12), SetDataTip(STR_TOWN_VIEW_DELETE_BUTTON
, STR_NULL
),
538 NWidget(WWT_PANEL
, COLOUR_GREY
), SetFill(1, 1), EndContainer(),
539 NWidget(WWT_PUSHARROWBTN
, COLOUR_GREY
, WID_QES_PREVIOUS
), SetMinimalSize(11, 12), SetDataTip(AWV_DECREASE
, STR_EDIT_SIGN_PREVIOUS_SIGN_TOOLTIP
),
540 NWidget(WWT_PUSHARROWBTN
, COLOUR_GREY
, WID_QES_NEXT
), SetMinimalSize(11, 12), SetDataTip(AWV_INCREASE
, STR_EDIT_SIGN_NEXT_SIGN_TOOLTIP
),
544 static WindowDesc
_query_sign_edit_desc(
545 WDP_CENTER
, "query_sign", 0, 0,
546 WC_QUERY_STRING
, WC_NONE
,
548 _nested_query_sign_edit_widgets
, lengthof(_nested_query_sign_edit_widgets
)
552 * Handle clicking on a sign.
553 * @param si The sign that was clicked on.
555 void HandleClickOnSign(const Sign
*si
)
557 if (_ctrl_pressed
&& (si
->owner
== _local_company
|| (si
->owner
== OWNER_DEITY
&& _game_mode
== GM_EDITOR
))) {
558 RenameSign(si
->index
, NULL
);
561 ShowRenameSignWindow(si
);
565 * Show the window to change the text of a sign.
566 * @param si The sign to show the window for.
568 void ShowRenameSignWindow(const Sign
*si
)
570 /* Delete all other edit windows */
571 DeleteWindowByClass(WC_QUERY_STRING
);
573 new SignWindow(&_query_sign_edit_desc
, si
);
577 * Close the sign window associated with the given sign.
578 * @param sign The sign to close the window for.
580 void DeleteRenameSignWindow(SignID sign
)
582 SignWindow
*w
= dynamic_cast<SignWindow
*>(FindWindowById(WC_QUERY_STRING
, WN_QUERY_STRING_SIGN
));
584 if (w
!= NULL
&& w
->cur_sign
== sign
) delete w
;