OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

window.cpp
Go to the documentation of this file.
1 /* $Id: window.cpp 27425 2015-10-30 17:23:16Z frosch $ */
2
3 /*
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/>.
8 */
9
12 #include "stdafx.h"
13 #include <stdarg.h>
14 #include "company_func.h"
15 #include "gfx_func.h"
16 #include "console_func.h"
17 #include "console_gui.h"
18 #include "viewport_func.h"
19 #include "progress.h"
20 #include "blitter/factory.hpp"
21 #include "zoom_func.h"
22 #include "vehicle_base.h"
23 #include "window_func.h"
24 #include "tilehighlight_func.h"
25 #include "network/network.h"
26 #include "querystring_gui.h"
27 #include "widgets/dropdown_func.h"
28 #include "strings_func.h"
29 #include "settings_type.h"
30 #include "settings_func.h"
31 #include "ini_type.h"
32 #include "newgrf_debug.h"
33 #include "hotkeys.h"
34 #include "toolbar_gui.h"
35 #include "statusbar_gui.h"
36 #include "error.h"
37 #include "game/game.hpp"
38 #include "video/video_driver.hpp"
39
40 #include "safeguards.h"
41
43 enum ViewportAutoscrolling {
44 VA_DISABLED,
45 VA_MAIN_VIEWPORT_FULLSCREEN,
46 VA_MAIN_VIEWPORT,
47 VA_EVERY_VIEWPORT,
48 };
49
50 static Point _drag_delta;
51 static Window *_mouseover_last_w = NULL;
52 static Window *_last_scroll_window = NULL;
53
55 Window *_z_front_window = NULL;
57 Window *_z_back_window = NULL;
58
60 bool _window_highlight_colour = false;
61
62 /*
63 * Window that currently has focus. - The main purpose is to generate
64 * #FocusLost events, not to give next window in z-order focus when a
65 * window is closed.
66 */
67 Window *_focused_window;
68
69 Point _cursorpos_drag_start;
70
71 int _scrollbar_start_pos;
72 int _scrollbar_size;
73 byte _scroller_click_timeout = 0;
74
75 bool _scrolling_viewport;
76 bool _mouse_hovering;
77
78 SpecialMouseMode _special_mouse_mode;
79
84 static SmallVector<WindowDesc*, 16> *_window_descs = NULL;
85
87 char *_windows_file;
88
90 WindowDesc::WindowDesc(WindowPosition def_pos, const char *ini_key, int16 def_width_trad, int16 def_height_trad,
91 WindowClass window_class, WindowClass parent_class, uint32 flags,
92 const NWidgetPart *nwid_parts, int16 nwid_length, HotkeyList *hotkeys) :
93 default_pos(def_pos),
94 cls(window_class),
95 parent_cls(parent_class),
96 ini_key(ini_key),
97 flags(flags),
98 nwid_parts(nwid_parts),
99 nwid_length(nwid_length),
100 hotkeys(hotkeys),
101 pref_sticky(false),
102 pref_width(0),
103 pref_height(0),
104 default_width_trad(def_width_trad),
105 default_height_trad(def_height_trad)
106 {
107 if (_window_descs == NULL) _window_descs = new SmallVector<WindowDesc*, 16>();
108 *_window_descs->Append() = this;
109 }
110
111 WindowDesc::~WindowDesc()
112 {
113 _window_descs->Erase(_window_descs->Find(this));
114 }
115
121 int16 WindowDesc::GetDefaultWidth() const
122 {
123 return this->pref_width != 0 ? this->pref_width : ScaleGUITrad(this->default_width_trad);
124 }
125
131 int16 WindowDesc::GetDefaultHeight() const
132 {
133 return this->pref_height != 0 ? this->pref_height : ScaleGUITrad(this->default_height_trad);
134 }
135
139 void WindowDesc::LoadFromConfig()
140 {
141 IniFile *ini = new IniFile();
142 ini->LoadFromDisk(_windows_file, BASE_DIR);
143 for (WindowDesc **it = _window_descs->Begin(); it != _window_descs->End(); ++it) {
144 if ((*it)->ini_key == NULL) continue;
145 IniLoadWindowSettings(ini, (*it)->ini_key, *it);
146 }
147 delete ini;
148 }
149
153 static int CDECL DescSorter(WindowDesc * const *a, WindowDesc * const *b)
154 {
155 if ((*a)->ini_key != NULL && (*b)->ini_key != NULL) return strcmp((*a)->ini_key, (*b)->ini_key);
156 return ((*b)->ini_key != NULL ? 1 : 0) - ((*a)->ini_key != NULL ? 1 : 0);
157 }
158
162 void WindowDesc::SaveToConfig()
163 {
164 /* Sort the stuff to get a nice ini file on first write */
165 QSortT(_window_descs->Begin(), _window_descs->Length(), DescSorter);
166
167 IniFile *ini = new IniFile();
168 ini->LoadFromDisk(_windows_file, BASE_DIR);
169 for (WindowDesc **it = _window_descs->Begin(); it != _window_descs->End(); ++it) {
170 if ((*it)->ini_key == NULL) continue;
171 IniSaveWindowSettings(ini, (*it)->ini_key, *it);
172 }
173 ini->SaveToDisk(_windows_file);
174 delete ini;
175 }
176
180 void Window::ApplyDefaults()
181 {
182 if (this->nested_root != NULL && this->nested_root->GetWidgetOfType(WWT_STICKYBOX) != NULL) {
183 if (this->window_desc->pref_sticky) this->flags |= WF_STICKY;
184 } else {
185 /* There is no stickybox; clear the preference in case someone tried to be funny */
186 this->window_desc->pref_sticky = false;
187 }
188 }
189
199 int Window::GetRowFromWidget(int clickpos, int widget, int padding, int line_height) const
200 {
201 const NWidgetBase *wid = this->GetWidget<NWidgetBase>(widget);
202 if (line_height < 0) line_height = wid->resize_y;
203 if (clickpos < (int)wid->pos_y + padding) return INT_MAX;
204 return (clickpos - (int)wid->pos_y - padding) / line_height;
205 }
206
210 void Window::DisableAllWidgetHighlight()
211 {
212 for (uint i = 0; i < this->nested_array_size; i++) {
213 NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
214 if (nwid == NULL) continue;
215
216 if (nwid->IsHighlighted()) {
217 nwid->SetHighlighted(TC_INVALID);
218 this->SetWidgetDirty(i);
219 }
220 }
221
222 CLRBITS(this->flags, WF_HIGHLIGHTED);
223 }
224
230 void Window::SetWidgetHighlight(byte widget_index, TextColour highlighted_colour)
231 {
232 assert(widget_index < this->nested_array_size);
233
234 NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
235 if (nwid == NULL) return;
236
237 nwid->SetHighlighted(highlighted_colour);
238 this->SetWidgetDirty(widget_index);
239
240 if (highlighted_colour != TC_INVALID) {
241 /* If we set a highlight, the window has a highlight */
242 this->flags |= WF_HIGHLIGHTED;
243 } else {
244 /* If we disable a highlight, check all widgets if anyone still has a highlight */
245 bool valid = false;
246 for (uint i = 0; i < this->nested_array_size; i++) {
247 NWidgetBase *nwid = this->GetWidget<NWidgetBase>(i);
248 if (nwid == NULL) continue;
249 if (!nwid->IsHighlighted()) continue;
250
251 valid = true;
252 }
253 /* If nobody has a highlight, disable the flag on the window */
254 if (!valid) CLRBITS(this->flags, WF_HIGHLIGHTED);
255 }
256 }
257
263 bool Window::IsWidgetHighlighted(byte widget_index) const
264 {
265 assert(widget_index < this->nested_array_size);
266
267 const NWidgetBase *nwid = this->GetWidget<NWidgetBase>(widget_index);
268 if (nwid == NULL) return false;
269
270 return nwid->IsHighlighted();
271 }
272
280 void Window::OnDropdownClose(Point pt, int widget, int index, bool instant_close)
281 {
282 if (widget < 0) return;
283
284 if (instant_close) {
285 /* Send event for selected option if we're still
286 * on the parent button of the dropdown (behaviour of the dropdowns in the main toolbar). */
287 if (GetWidgetFromPos(this, pt.x, pt.y) == widget) {
288 this->OnDropdownSelect(widget, index);
289 }
290 }
291
292 /* Raise the dropdown button */
293 NWidgetCore *nwi2 = this->GetWidget<NWidgetCore>(widget);
294 if ((nwi2->type & WWT_MASK) == NWID_BUTTON_DROPDOWN) {
295 nwi2->disp_flags &= ~ND_DROPDOWN_ACTIVE;
296 } else {
297 this->RaiseWidget(widget);
298 }
299 this->SetWidgetDirty(widget);
300 }
301
307 const Scrollbar *Window::GetScrollbar(uint widnum) const
308 {
309 return this->GetWidget<NWidgetScrollbar>(widnum);
310 }
311
317 Scrollbar *Window::GetScrollbar(uint widnum)
318 {
319 return this->GetWidget<NWidgetScrollbar>(widnum);
320 }
321
327 const QueryString *Window::GetQueryString(uint widnum) const
328 {
329 const SmallMap<int, QueryString*>::Pair *query = this->querystrings.Find(widnum);
330 return query != this->querystrings.End() ? query->second : NULL;
331 }
332
338 QueryString *Window::GetQueryString(uint widnum)
339 {
340 SmallMap<int, QueryString*>::Pair *query = this->querystrings.Find(widnum);
341 return query != this->querystrings.End() ? query->second : NULL;
342 }
343
348 /* virtual */ const char *Window::GetFocusedText() const
349 {
350 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
351 return this->GetQueryString(this->nested_focus->index)->GetText();
352 }
353
354 return NULL;
355 }
356
361 /* virtual */ const char *Window::GetCaret() const
362 {
363 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
364 return this->GetQueryString(this->nested_focus->index)->GetCaret();
365 }
366
367 return NULL;
368 }
369
375 /* virtual */ const char *Window::GetMarkedText(size_t *length) const
376 {
377 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
378 return this->GetQueryString(this->nested_focus->index)->GetMarkedText(length);
379 }
380
381 return NULL;
382 }
383
388 /* virtual */ Point Window::GetCaretPosition() const
389 {
390 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
391 return this->GetQueryString(this->nested_focus->index)->GetCaretPosition(this, this->nested_focus->index);
392 }
393
394 Point pt = {0, 0};
395 return pt;
396 }
397
404 /* virtual */ Rect Window::GetTextBoundingRect(const char *from, const char *to) const
405 {
406 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
407 return this->GetQueryString(this->nested_focus->index)->GetBoundingRect(this, this->nested_focus->index, from, to);
408 }
409
410 Rect r = {0, 0, 0, 0};
411 return r;
412 }
413
419 /* virtual */ const char *Window::GetTextCharacterAtPosition(const Point &pt) const
420 {
421 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) {
422 return this->GetQueryString(this->nested_focus->index)->GetCharAtPosition(this, this->nested_focus->index, pt);
423 }
424
425 return NULL;
426 }
427
432 void SetFocusedWindow(Window *w)
433 {
434 if (_focused_window == w) return;
435
436 /* Invalidate focused widget */
437 if (_focused_window != NULL) {
438 if (_focused_window->nested_focus != NULL) _focused_window->nested_focus->SetDirty(_focused_window);
439 }
440
441 /* Remember which window was previously focused */
442 Window *old_focused = _focused_window;
443 _focused_window = w;
444
445 /* So we can inform it that it lost focus */
446 if (old_focused != NULL) old_focused->OnFocusLost();
447 if (_focused_window != NULL) _focused_window->OnFocus();
448 }
449
455 bool EditBoxInGlobalFocus()
456 {
457 if (_focused_window == NULL) return false;
458
459 /* The console does not have an edit box so a special case is needed. */
460 if (_focused_window->window_class == WC_CONSOLE) return true;
461
462 return _focused_window->nested_focus != NULL && _focused_window->nested_focus->type == WWT_EDITBOX;
463 }
464
468 void Window::UnfocusFocusedWidget()
469 {
470 if (this->nested_focus != NULL) {
471 if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
472
473 /* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
474 this->nested_focus->SetDirty(this);
475 this->nested_focus = NULL;
476 }
477 }
478
484 bool Window::SetFocusedWidget(int widget_index)
485 {
486 /* Do nothing if widget_index is already focused, or if it wasn't a valid widget. */
487 if ((uint)widget_index >= this->nested_array_size) return false;
488
489 assert(this->nested_array[widget_index] != NULL); // Setting focus to a non-existing widget is a bad idea.
490 if (this->nested_focus != NULL) {
491 if (this->GetWidget<NWidgetCore>(widget_index) == this->nested_focus) return false;
492
493 /* Repaint the widget that lost focus. A focused edit box may else leave the caret on the screen. */
494 this->nested_focus->SetDirty(this);
495 if (this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
496 }
497 this->nested_focus = this->GetWidget<NWidgetCore>(widget_index);
498 return true;
499 }
500
504 void Window::OnFocusLost()
505 {
506 if (this->nested_focus != NULL && this->nested_focus->type == WWT_EDITBOX) VideoDriver::GetInstance()->EditBoxLostFocus();
507 }
508
516 void CDECL Window::SetWidgetsDisabledState(bool disab_stat, int widgets, ...)
517 {
518 va_list wdg_list;
519
520 va_start(wdg_list, widgets);
521
522 while (widgets != WIDGET_LIST_END) {
523 SetWidgetDisabledState(widgets, disab_stat);
524 widgets = va_arg(wdg_list, int);
525 }
526
527 va_end(wdg_list);
528 }
529
535 void CDECL Window::SetWidgetsLoweredState(bool lowered_stat, int widgets, ...)
536 {
537 va_list wdg_list;
538
539 va_start(wdg_list, widgets);
540
541 while (widgets != WIDGET_LIST_END) {
542 SetWidgetLoweredState(widgets, lowered_stat);
543 widgets = va_arg(wdg_list, int);
544 }
545
546 va_end(wdg_list);
547 }
548
553 void Window::RaiseButtons(bool autoraise)
554 {
555 for (uint i = 0; i < this->nested_array_size; i++) {
556 if (this->nested_array[i] == NULL) continue;
557 WidgetType type = this->nested_array[i]->type;
558 if (((type & ~WWB_PUSHBUTTON) < WWT_LAST || type == NWID_PUSHBUTTON_DROPDOWN) &&
559 (!autoraise || (type & WWB_PUSHBUTTON) || type == WWT_EDITBOX) && this->IsWidgetLowered(i)) {
560 this->RaiseWidget(i);
561 this->SetWidgetDirty(i);
562 }
563 }
564
565 /* Special widgets without widget index */
566 NWidgetCore *wid = this->nested_root != NULL ? (NWidgetCore*)this->nested_root->GetWidgetOfType(WWT_DEFSIZEBOX) : NULL;
567 if (wid != NULL) {
568 wid->SetLowered(false);
569 wid->SetDirty(this);
570 }
571 }
572
577 void Window::SetWidgetDirty(byte widget_index) const
578 {
579 /* Sometimes this function is called before the window is even fully initialized */
580 if (this->nested_array == NULL) return;
581
582 this->nested_array[widget_index]->SetDirty(this);
583 }
584
590 EventState Window::OnHotkey(int hotkey)
591 {
592 if (hotkey < 0) return ES_NOT_HANDLED;
593
594 NWidgetCore *nw = this->GetWidget<NWidgetCore>(hotkey);
595 if (nw == NULL || nw->IsDisabled()) return ES_NOT_HANDLED;
596
597 if (nw->type == WWT_EDITBOX) {
598 if (this->IsShaded()) return ES_NOT_HANDLED;
599
600 /* Focus editbox */
601 this->SetFocusedWidget(hotkey);
602 SetFocusedWindow(this);
603 } else {
604 /* Click button */
605 this->OnClick(Point(), hotkey, 1);
606 }
607 return ES_HANDLED;
608 }
609
615 void Window::HandleButtonClick(byte widget)
616 {
617 this->LowerWidget(widget);
618 this->SetTimeout();
619 this->SetWidgetDirty(widget);
620 }
621
622 static void StartWindowDrag(Window *w);
623 static void StartWindowSizing(Window *w, bool to_left);
624
632 static void DispatchLeftClickEvent(Window *w, int x, int y, int click_count)
633 {
634 NWidgetCore *nw = w->nested_root->GetWidgetFromPos(x, y);
635 WidgetType widget_type = (nw != NULL) ? nw->type : WWT_EMPTY;
636
637 bool focused_widget_changed = false;
638 /* If clicked on a window that previously did dot have focus */
639 if (_focused_window != w && // We already have focus, right?
640 (w->window_desc->flags & WDF_NO_FOCUS) == 0 && // Don't lose focus to toolbars
641 widget_type != WWT_CLOSEBOX) { // Don't change focused window if 'X' (close button) was clicked
642 focused_widget_changed = true;
643 SetFocusedWindow(w);
644 }
645
646 if (nw == NULL) return; // exit if clicked outside of widgets
647
648 /* don't allow any interaction if the button has been disabled */
649 if (nw->IsDisabled()) return;
650
651 int widget_index = nw->index;
652
653 /* Clicked on a widget that is not disabled.
654 * So unless the clicked widget is the caption bar, change focus to this widget.
655 * Exception: In the OSK we always want the editbox to stay focussed. */
656 if (widget_type != WWT_CAPTION && w->window_class != WC_OSK) {
657 /* focused_widget_changed is 'now' only true if the window this widget
658 * is in gained focus. In that case it must remain true, also if the
659 * local widget focus did not change. As such it's the logical-or of
660 * both changed states.
661 *
662 * If this is not preserved, then the OSK window would be opened when
663 * a user has the edit box focused and then click on another window and
664 * then back again on the edit box (to type some text).
665 */
666 focused_widget_changed |= w->SetFocusedWidget(widget_index);
667 }
668
669 /* Close any child drop down menus. If the button pressed was the drop down
670 * list's own button, then we should not process the click any further. */
671 if (HideDropDownMenu(w) == widget_index && widget_index >= 0) return;
672
673 if ((widget_type & ~WWB_PUSHBUTTON) < WWT_LAST && (widget_type & WWB_PUSHBUTTON)) w->HandleButtonClick(widget_index);
674
675 Point pt = { x, y };
676
677 switch (widget_type) {
678 case NWID_VSCROLLBAR:
679 case NWID_HSCROLLBAR:
680 ScrollbarClickHandler(w, nw, x, y);
681 break;
682
683 case WWT_EDITBOX: {
684 QueryString *query = w->GetQueryString(widget_index);
685 if (query != NULL) query->ClickEditBox(w, pt, widget_index, click_count, focused_widget_changed);
686 break;
687 }
688
689 case WWT_CLOSEBOX: // 'X'
690 delete w;
691 return;
692
693 case WWT_CAPTION: // 'Title bar'
694 StartWindowDrag(w);
695 return;
696
697 case WWT_RESIZEBOX:
698 /* When the resize widget is on the left size of the window
699 * we assume that that button is used to resize to the left. */
700 StartWindowSizing(w, (int)nw->pos_x < (w->width / 2));
701 nw->SetDirty(w);
702 return;
703
704 case WWT_DEFSIZEBOX: {
705 if (_ctrl_pressed) {
706 w->window_desc->pref_width = w->width;
707 w->window_desc->pref_height = w->height;
708 } else {
709 int16 def_width = max<int16>(min(w->window_desc->GetDefaultWidth(), _screen.width), w->nested_root->smallest_x);
710 int16 def_height = max<int16>(min(w->window_desc->GetDefaultHeight(), _screen.height - 50), w->nested_root->smallest_y);
711
712 int dx = (w->resize.step_width == 0) ? 0 : def_width - w->width;
713 int dy = (w->resize.step_height == 0) ? 0 : def_height - w->height;
714 /* dx and dy has to go by step.. calculate it.
715 * The cast to int is necessary else dx/dy are implicitly casted to unsigned int, which won't work. */
716 if (w->resize.step_width > 1) dx -= dx % (int)w->resize.step_width;
717 if (w->resize.step_height > 1) dy -= dy % (int)w->resize.step_height;
718 ResizeWindow(w, dx, dy, false);
719 }
720
721 nw->SetLowered(true);
722 nw->SetDirty(w);
723 w->SetTimeout();
724 break;
725 }
726
727 case WWT_DEBUGBOX:
728 w->ShowNewGRFInspectWindow();
729 break;
730
731 case WWT_SHADEBOX:
732 nw->SetDirty(w);
733 w->SetShaded(!w->IsShaded());
734 return;
735
736 case WWT_STICKYBOX:
737 w->flags ^= WF_STICKY;
738 nw->SetDirty(w);
739 if (_ctrl_pressed) w->window_desc->pref_sticky = (w->flags & WF_STICKY) != 0;
740 return;
741
742 default:
743 break;
744 }
745
746 /* Widget has no index, so the window is not interested in it. */
747 if (widget_index < 0) return;
748
749 /* Check if the widget is highlighted; if so, disable highlight and dispatch an event to the GameScript */
750 if (w->IsWidgetHighlighted(widget_index)) {
751 w->SetWidgetHighlight(widget_index, TC_INVALID);
752 Game::NewEvent(new ScriptEventWindowWidgetClick((ScriptWindow::WindowClass)w->window_class, w->window_number, widget_index));
753 }
754
755 w->OnClick(pt, widget_index, click_count);
756 }
757
764 static void DispatchRightClickEvent(Window *w, int x, int y)
765 {
766 NWidgetCore *wid = w->nested_root->GetWidgetFromPos(x, y);
767 if (wid == NULL) return;
768
769 /* No widget to handle, or the window is not interested in it. */
770 if (wid->index >= 0) {
771 Point pt = { x, y };
772 if (w->OnRightClick(pt, wid->index)) return;
773 }
774
775 if (_settings_client.gui.hover_delay_ms == 0 && wid->tool_tip != 0) GuiShowTooltips(w, wid->tool_tip, 0, NULL, TCC_RIGHT_CLICK);
776 }
777
784 static void DispatchHoverEvent(Window *w, int x, int y)
785 {
786 NWidgetCore *wid = w->nested_root->GetWidgetFromPos(x, y);
787
788 /* No widget to handle */
789 if (wid == NULL) return;
790
791 /* Show the tooltip if there is any */
792 if (wid->tool_tip != 0) {
793 GuiShowTooltips(w, wid->tool_tip);
794 return;
795 }
796
797 /* Widget has no index, so the window is not interested in it. */
798 if (wid->index < 0) return;
799
800 Point pt = { x, y };
801 w->OnHover(pt, wid->index);
802 }
803
811 static void DispatchMouseWheelEvent(Window *w, NWidgetCore *nwid, int wheel)
812 {
813 if (nwid == NULL) return;
814
815 /* Using wheel on caption/shade-box shades or unshades the window. */
816 if (nwid->type == WWT_CAPTION || nwid->type == WWT_SHADEBOX) {
817 w->SetShaded(wheel < 0);
818 return;
819 }
820
821 /* Wheeling a vertical scrollbar. */
822 if (nwid->type == NWID_VSCROLLBAR) {
823 NWidgetScrollbar *sb = static_cast<NWidgetScrollbar *>(nwid);
824 if (sb->GetCount() > sb->GetCapacity()) {
825 sb->UpdatePosition(wheel);
826 w->SetDirty();
827 }
828 return;
829 }
830
831 /* Scroll the widget attached to the scrollbar. */
832 Scrollbar *sb = (nwid->scrollbar_index >= 0 ? w->GetScrollbar(nwid->scrollbar_index) : NULL);
833 if (sb != NULL && sb->GetCount() > sb->GetCapacity()) {
834 sb->UpdatePosition(wheel);
835 w->SetDirty();
836 }
837 }
838
844 static bool MayBeShown(const Window *w)
845 {
846 /* If we're not modal, everything is okay. */
847 if (!HasModalProgress()) return true;
848
849 switch (w->window_class) {
850 case WC_MAIN_WINDOW:
851 case WC_MODAL_PROGRESS:
852 case WC_CONFIRM_POPUP_QUERY:
853 return true;
854
855 default:
856 return false;
857 }
858 }
859
872 static void DrawOverlappedWindow(Window *w, int left, int top, int right, int bottom)
873 {
874 const Window *v;
875 FOR_ALL_WINDOWS_FROM_BACK_FROM(v, w->z_front) {
876 if (MayBeShown(v) &&
877 right > v->left &&
878 bottom > v->top &&
879 left < v->left + v->width &&
880 top < v->top + v->height) {
881 /* v and rectangle intersect with each other */
882 int x;
883
884 if (left < (x = v->left)) {
885 DrawOverlappedWindow(w, left, top, x, bottom);
886 DrawOverlappedWindow(w, x, top, right, bottom);
887 return;
888 }
889
890 if (right > (x = v->left + v->width)) {
891 DrawOverlappedWindow(w, left, top, x, bottom);
892 DrawOverlappedWindow(w, x, top, right, bottom);
893 return;
894 }
895
896 if (top < (x = v->top)) {
897 DrawOverlappedWindow(w, left, top, right, x);
898 DrawOverlappedWindow(w, left, x, right, bottom);
899 return;
900 }
901
902 if (bottom > (x = v->top + v->height)) {
903 DrawOverlappedWindow(w, left, top, right, x);
904 DrawOverlappedWindow(w, left, x, right, bottom);
905 return;
906 }
907
908 return;
909 }
910 }
911
912 /* Setup blitter, and dispatch a repaint event to window *wz */
913 DrawPixelInfo *dp = _cur_dpi;
914 dp->width = right - left;
915 dp->height = bottom - top;
916 dp->left = left - w->left;
917 dp->top = top - w->top;
918 dp->pitch = _screen.pitch;
919 dp->dst_ptr = BlitterFactory::GetCurrentBlitter()->MoveTo(_screen.dst_ptr, left, top);
920 dp->zoom = ZOOM_LVL_NORMAL;
921 w->OnPaint();
922 }
923
932 void DrawOverlappedWindowForAll(int left, int top, int right, int bottom)
933 {
934 Window *w;
935 DrawPixelInfo bk;
936 _cur_dpi = &bk;
937
938 FOR_ALL_WINDOWS_FROM_BACK(w) {
939 if (MayBeShown(w) &&
940 right > w->left &&
941 bottom > w->top &&
942 left < w->left + w->width &&
943 top < w->top + w->height) {
944 /* Window w intersects with the rectangle => needs repaint */
945 DrawOverlappedWindow(w, left, top, right, bottom);
946 }
947 }
948 }
949
954 void Window::SetDirty() const
955 {
956 SetDirtyBlocks(this->left, this->top, this->left + this->width, this->top + this->height);
957 }
958
965 void Window::ReInit(int rx, int ry)
966 {
967 this->SetDirty(); // Mark whole current window as dirty.
968
969 /* Save current size. */
970 int window_width = this->width;
971 int window_height = this->height;
972
973 this->OnInit();
974 /* Re-initialize the window from the ground up. No need to change the nested_array, as all widgets stay where they are. */
975 this->nested_root->SetupSmallestSize(this, false);
976 this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
977 this->width = this->nested_root->smallest_x;
978 this->height = this->nested_root->smallest_y;
979 this->resize.step_width = this->nested_root->resize_x;
980 this->resize.step_height = this->nested_root->resize_y;
981
982 /* Resize as close to the original size + requested resize as possible. */
983 window_width = max(window_width + rx, this->width);
984 window_height = max(window_height + ry, this->height);
985 int dx = (this->resize.step_width == 0) ? 0 : window_width - this->width;
986 int dy = (this->resize.step_height == 0) ? 0 : window_height - this->height;
987 /* dx and dy has to go by step.. calculate it.
988 * The cast to int is necessary else dx/dy are implicitly casted to unsigned int, which won't work. */
989 if (this->resize.step_width > 1) dx -= dx % (int)this->resize.step_width;
990 if (this->resize.step_height > 1) dy -= dy % (int)this->resize.step_height;
991
992 ResizeWindow(this, dx, dy);
993 /* ResizeWindow() does this->SetDirty() already, no need to do it again here. */
994 }
995
1001 void Window::SetShaded(bool make_shaded)
1002 {
1003 if (this->shade_select == NULL) return;
1004
1005 int desired = make_shaded ? SZSP_HORIZONTAL : 0;
1006 if (this->shade_select->shown_plane != desired) {
1007 if (make_shaded) {
1008 if (this->nested_focus != NULL) this->UnfocusFocusedWidget();
1009 this->unshaded_size.width = this->width;
1010 this->unshaded_size.height = this->height;
1011 this->shade_select->SetDisplayedPlane(desired);
1012 this->ReInit(0, -this->height);
1013 } else {
1014 this->shade_select->SetDisplayedPlane(desired);
1015 int dx = ((int)this->unshaded_size.width > this->width) ? (int)this->unshaded_size.width - this->width : 0;
1016 int dy = ((int)this->unshaded_size.height > this->height) ? (int)this->unshaded_size.height - this->height : 0;
1017 this->ReInit(dx, dy);
1018 }
1019 }
1020 }
1021
1028 static Window *FindChildWindow(const Window *w, WindowClass wc)
1029 {
1030 Window *v;
1031 FOR_ALL_WINDOWS_FROM_BACK(v) {
1032 if ((wc == WC_INVALID || wc == v->window_class) && v->parent == w) return v;
1033 }
1034
1035 return NULL;
1036 }
1037
1042 void Window::DeleteChildWindows(WindowClass wc) const
1043 {
1044 Window *child = FindChildWindow(this, wc);
1045 while (child != NULL) {
1046 delete child;
1047 child = FindChildWindow(this, wc);
1048 }
1049 }
1050
1054 Window::~Window()
1055 {
1056 if (_thd.window_class == this->window_class &&
1057 _thd.window_number == this->window_number) {
1058 ResetObjectToPlace();
1059 }
1060
1061 /* Prevent Mouseover() from resetting mouse-over coordinates on a non-existing window */
1062 if (_mouseover_last_w == this) _mouseover_last_w = NULL;
1063
1064 /* We can't scroll the window when it's closed. */
1065 if (_last_scroll_window == this) _last_scroll_window = NULL;
1066
1067 /* Make sure we don't try to access this window as the focused window when it doesn't exist anymore. */
1068 if (_focused_window == this) {
1069 this->OnFocusLost();
1070 _focused_window = NULL;
1071 }
1072
1073 this->DeleteChildWindows();
1074
1075 if (this->viewport != NULL) DeleteWindowViewport(this);
1076
1077 this->SetDirty();
1078
1079 free(this->nested_array); // Contents is released through deletion of #nested_root.
1080 delete this->nested_root;
1081
1082 /*
1083 * Make fairly sure that this is written, and not "optimized" away.
1084 * The delete operator is overwritten to not delete it; the deletion
1085 * happens at a later moment in time after the window has been
1086 * removed from the list of windows to prevent issues with items
1087 * being removed during the iteration as not one but more windows
1088 * may be removed by a single call to ~Window by means of the
1089 * DeleteChildWindows function.
1090 */
1091 const_cast<volatile WindowClass &>(this->window_class) = WC_INVALID;
1092 }
1093
1100 Window *FindWindowById(WindowClass cls, WindowNumber number)
1101 {
1102 Window *w;
1103 FOR_ALL_WINDOWS_FROM_BACK(w) {
1104 if (w->window_class == cls && w->window_number == number) return w;
1105 }
1106
1107 return NULL;
1108 }
1109
1116 Window *FindWindowByClass(WindowClass cls)
1117 {
1118 Window *w;
1119 FOR_ALL_WINDOWS_FROM_BACK(w) {
1120 if (w->window_class == cls) return w;
1121 }
1122
1123 return NULL;
1124 }
1125
1132 void DeleteWindowById(WindowClass cls, WindowNumber number, bool force)
1133 {
1134 Window *w = FindWindowById(cls, number);
1135 if (force || w == NULL ||
1136 (w->flags & WF_STICKY) == 0) {
1137 delete w;
1138 }
1139 }
1140
1145 void DeleteWindowByClass(WindowClass cls)
1146 {
1147 Window *w;
1148
1149 restart_search:
1150 /* When we find the window to delete, we need to restart the search
1151 * as deleting this window could cascade in deleting (many) others
1152 * anywhere in the z-array */
1153 FOR_ALL_WINDOWS_FROM_BACK(w) {
1154 if (w->window_class == cls) {
1155 delete w;
1156 goto restart_search;
1157 }
1158 }
1159 }
1160
1167 void DeleteCompanyWindows(CompanyID id)
1168 {
1169 Window *w;
1170
1171 restart_search:
1172 /* When we find the window to delete, we need to restart the search
1173 * as deleting this window could cascade in deleting (many) others
1174 * anywhere in the z-array */
1175 FOR_ALL_WINDOWS_FROM_BACK(w) {
1176 if (w->owner == id) {
1177 delete w;
1178 goto restart_search;
1179 }
1180 }
1181
1182 /* Also delete the company specific windows that don't have a company-colour. */
1183 DeleteWindowById(WC_BUY_COMPANY, id);
1184 }
1185
1193 void ChangeWindowOwner(Owner old_owner, Owner new_owner)
1194 {
1195 Window *w;
1196 FOR_ALL_WINDOWS_FROM_BACK(w) {
1197 if (w->owner != old_owner) continue;
1198
1199 switch (w->window_class) {
1200 case WC_COMPANY_COLOUR:
1201 case WC_FINANCES:
1202 case WC_STATION_LIST:
1203 case WC_TRAINS_LIST:
1204 case WC_ROADVEH_LIST:
1205 case WC_SHIPS_LIST:
1206 case WC_AIRCRAFT_LIST:
1207 case WC_BUY_COMPANY:
1208 case WC_COMPANY:
1209 case WC_COMPANY_INFRASTRUCTURE:
1210 case WC_VEHICLE_ORDERS: // Changing owner would also require changing WindowDesc, which is not possible; however keeping the old one crashes because of missing widgets etc.. See ShowOrdersWindow().
1211 continue;
1212
1213 default:
1214 w->owner = new_owner;
1215 break;
1216 }
1217 }
1218 }
1219
1220 static void BringWindowToFront(Window *w);
1221
1229 Window *BringWindowToFrontById(WindowClass cls, WindowNumber number)
1230 {
1231 Window *w = FindWindowById(cls, number);
1232
1233 if (w != NULL) {
1234 if (w->IsShaded()) w->SetShaded(false); // Restore original window size if it was shaded.
1235
1236 w->SetWhiteBorder();
1237 BringWindowToFront(w);
1238 w->SetDirty();
1239 }
1240
1241 return w;
1242 }
1243
1244 static inline bool IsVitalWindow(const Window *w)
1245 {
1246 switch (w->window_class) {
1247 case WC_MAIN_TOOLBAR:
1248 case WC_STATUS_BAR:
1249 case WC_NEWS_WINDOW:
1250 case WC_SEND_NETWORK_MSG:
1251 return true;
1252
1253 default:
1254 return false;
1255 }
1256 }
1257
1266 static uint GetWindowZPriority(const Window *w)
1267 {
1268 assert(w->window_class != WC_INVALID);
1269
1270 uint z_priority = 0;
1271
1272 switch (w->window_class) {
1273 case WC_ENDSCREEN:
1274 ++z_priority;
1275
1276 case WC_HIGHSCORE:
1277 ++z_priority;
1278
1279 case WC_TOOLTIPS:
1280 ++z_priority;
1281
1282 case WC_DROPDOWN_MENU:
1283 ++z_priority;
1284
1285 case WC_MAIN_TOOLBAR:
1286 case WC_STATUS_BAR:
1287 ++z_priority;
1288
1289 case WC_OSK:
1290 ++z_priority;
1291
1292 case WC_QUERY_STRING:
1293 case WC_SEND_NETWORK_MSG:
1294 ++z_priority;
1295
1296 case WC_ERRMSG:
1297 case WC_CONFIRM_POPUP_QUERY:
1298 case WC_MODAL_PROGRESS:
1299 case WC_NETWORK_STATUS_WINDOW:
1300 case WC_SAVE_PRESET:
1301 ++z_priority;
1302
1303 case WC_GENERATE_LANDSCAPE:
1304 case WC_SAVELOAD:
1305 case WC_GAME_OPTIONS:
1306 case WC_CUSTOM_CURRENCY:
1307 case WC_NETWORK_WINDOW:
1308 case WC_GRF_PARAMETERS:
1309 case WC_AI_LIST:
1310 case WC_AI_SETTINGS:
1311 case WC_TEXTFILE:
1312 ++z_priority;
1313
1314 case WC_CONSOLE:
1315 ++z_priority;
1316
1317 case WC_NEWS_WINDOW:
1318 ++z_priority;
1319
1320 default:
1321 ++z_priority;
1322
1323 case WC_MAIN_WINDOW:
1324 return z_priority;
1325 }
1326 }
1327
1332 static void AddWindowToZOrdering(Window *w)
1333 {
1334 assert(w->z_front == NULL && w->z_back == NULL);
1335
1336 if (_z_front_window == NULL) {
1337 /* It's the only window. */
1338 _z_front_window = _z_back_window = w;
1339 w->z_front = w->z_back = NULL;
1340 } else {
1341 /* Search down the z-ordering for its location. */
1342 Window *v = _z_front_window;
1343 uint last_z_priority = UINT_MAX;
1344 while (v != NULL && (v->window_class == WC_INVALID || GetWindowZPriority(v) > GetWindowZPriority(w))) {
1345 if (v->window_class != WC_INVALID) {
1346 /* Sanity check z-ordering, while we're at it. */
1347 assert(last_z_priority >= GetWindowZPriority(v));
1348 last_z_priority = GetWindowZPriority(v);
1349 }
1350
1351 v = v->z_back;
1352 }
1353
1354 if (v == NULL) {
1355 /* It's the new back window. */
1356 w->z_front = _z_back_window;
1357 w->z_back = NULL;
1358 _z_back_window->z_back = w;
1359 _z_back_window = w;
1360 } else if (v == _z_front_window) {
1361 /* It's the new front window. */
1362 w->z_front = NULL;
1363 w->z_back = _z_front_window;
1364 _z_front_window->z_front = w;
1365 _z_front_window = w;
1366 } else {
1367 /* It's somewhere else in the z-ordering. */
1368 w->z_front = v->z_front;
1369 w->z_back = v;
1370 v->z_front->z_back = w;
1371 v->z_front = w;
1372 }
1373 }
1374 }
1375
1376
1381 static void RemoveWindowFromZOrdering(Window *w)
1382 {
1383 if (w->z_front == NULL) {
1384 assert(_z_front_window == w);
1385 _z_front_window = w->z_back;
1386 } else {
1387 w->z_front->z_back = w->z_back;
1388 }
1389
1390 if (w->z_back == NULL) {
1391 assert(_z_back_window == w);
1392 _z_back_window = w->z_front;
1393 } else {
1394 w->z_back->z_front = w->z_front;
1395 }
1396
1397 w->z_front = w->z_back = NULL;
1398 }
1399
1405 static void BringWindowToFront(Window *w)
1406 {
1407 RemoveWindowFromZOrdering(w);
1408 AddWindowToZOrdering(w);
1409
1410 w->SetDirty();
1411 }
1412
1421 void Window::InitializeData(WindowNumber window_number)
1422 {
1423 /* Set up window properties; some of them are needed to set up smallest size below */
1424 this->window_class = this->window_desc->cls;
1425 this->SetWhiteBorder();
1426 if (this->window_desc->default_pos == WDP_CENTER) this->flags |= WF_CENTERED;
1427 this->owner = INVALID_OWNER;
1428 this->nested_focus = NULL;
1429 this->window_number = window_number;
1430
1431 this->OnInit();
1432 /* Initialize nested widget tree. */
1433 if (this->nested_array == NULL) {
1434 this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1435 this->nested_root->SetupSmallestSize(this, true);
1436 } else {
1437 this->nested_root->SetupSmallestSize(this, false);
1438 }
1439 /* Initialize to smallest size. */
1440 this->nested_root->AssignSizePosition(ST_SMALLEST, 0, 0, this->nested_root->smallest_x, this->nested_root->smallest_y, _current_text_dir == TD_RTL);
1441
1442 /* Further set up window properties,
1443 * this->left, this->top, this->width, this->height, this->resize.width, and this->resize.height are initialized later. */
1444 this->resize.step_width = this->nested_root->resize_x;
1445 this->resize.step_height = this->nested_root->resize_y;
1446
1447 /* Give focus to the opened window unless a text box
1448 * of focused window has focus (so we don't interrupt typing). But if the new
1449 * window has a text box, then take focus anyway. */
1450 if (!EditBoxInGlobalFocus() || this->nested_root->GetWidgetOfType(WWT_EDITBOX) != NULL) SetFocusedWindow(this);
1451
1452 /* Insert the window into the correct location in the z-ordering. */
1453 AddWindowToZOrdering(this);
1454 }
1455
1463 void Window::InitializePositionSize(int x, int y, int sm_width, int sm_height)
1464 {
1465 this->left = x;
1466 this->top = y;
1467 this->width = sm_width;
1468 this->height = sm_height;
1469 }
1470
1481 void Window::FindWindowPlacementAndResize(int def_width, int def_height)
1482 {
1483 def_width = max(def_width, this->width); // Don't allow default size to be smaller than smallest size
1484 def_height = max(def_height, this->height);
1485 /* Try to make windows smaller when our window is too small.
1486 * w->(width|height) is normally the same as min_(width|height),
1487 * but this way the GUIs can be made a little more dynamic;
1488 * one can use the same spec for multiple windows and those
1489 * can then determine the real minimum size of the window. */
1490 if (this->width != def_width || this->height != def_height) {
1491 /* Think about the overlapping toolbars when determining the minimum window size */
1492 int free_height = _screen.height;
1493 const Window *wt = FindWindowById(WC_STATUS_BAR, 0);
1494 if (wt != NULL) free_height -= wt->height;
1495 wt = FindWindowById(WC_MAIN_TOOLBAR, 0);
1496 if (wt != NULL) free_height -= wt->height;
1497
1498 int enlarge_x = max(min(def_width - this->width, _screen.width - this->width), 0);
1499 int enlarge_y = max(min(def_height - this->height, free_height - this->height), 0);
1500
1501 /* X and Y has to go by step.. calculate it.
1502 * The cast to int is necessary else x/y are implicitly casted to
1503 * unsigned int, which won't work. */
1504 if (this->resize.step_width > 1) enlarge_x -= enlarge_x % (int)this->resize.step_width;
1505 if (this->resize.step_height > 1) enlarge_y -= enlarge_y % (int)this->resize.step_height;
1506
1507 ResizeWindow(this, enlarge_x, enlarge_y);
1508 /* ResizeWindow() calls this->OnResize(). */
1509 } else {
1510 /* Always call OnResize; that way the scrollbars and matrices get initialized. */
1511 this->OnResize();
1512 }
1513
1514 int nx = this->left;
1515 int ny = this->top;
1516
1517 if (nx + this->width > _screen.width) nx -= (nx + this->width - _screen.width);
1518
1519 const Window *wt = FindWindowById(WC_MAIN_TOOLBAR, 0);
1520 ny = max(ny, (wt == NULL || this == wt || this->top == 0) ? 0 : wt->height);
1521 nx = max(nx, 0);
1522
1523 if (this->viewport != NULL) {
1524 this->viewport->left += nx - this->left;
1525 this->viewport->top += ny - this->top;
1526 }
1527 this->left = nx;
1528 this->top = ny;
1529
1530 this->SetDirty();
1531 }
1532
1544 static bool IsGoodAutoPlace1(int left, int top, int width, int height, Point &pos)
1545 {
1546 int right = width + left;
1547 int bottom = height + top;
1548
1549 const Window *main_toolbar = FindWindowByClass(WC_MAIN_TOOLBAR);
1550 if (left < 0 || (main_toolbar != NULL && top < main_toolbar->height) || right > _screen.width || bottom > _screen.height) return false;
1551
1552 /* Make sure it is not obscured by any window. */
1553 const Window *w;
1554 FOR_ALL_WINDOWS_FROM_BACK(w) {
1555 if (w->window_class == WC_MAIN_WINDOW) continue;
1556
1557 if (right > w->left &&
1558 w->left + w->width > left &&
1559 bottom > w->top &&
1560 w->top + w->height > top) {
1561 return false;
1562 }
1563 }
1564
1565 pos.x = left;
1566 pos.y = top;
1567 return true;
1568 }
1569
1581 static bool IsGoodAutoPlace2(int left, int top, int width, int height, Point &pos)
1582 {
1583 /* Left part of the rectangle may be at most 1/4 off-screen,
1584 * right part of the rectangle may be at most 1/2 off-screen
1585 */
1586 if (left < -(width >> 2) || left > _screen.width - (width >> 1)) return false;
1587 /* Bottom part of the rectangle may be at most 1/4 off-screen */
1588 if (top < 22 || top > _screen.height - (height >> 2)) return false;
1589
1590 /* Make sure it is not obscured by any window. */
1591 const Window *w;
1592 FOR_ALL_WINDOWS_FROM_BACK(w) {
1593 if (w->window_class == WC_MAIN_WINDOW) continue;
1594
1595 if (left + width > w->left &&
1596 w->left + w->width > left &&
1597 top + height > w->top &&
1598 w->top + w->height > top) {
1599 return false;
1600 }
1601 }
1602
1603 pos.x = left;
1604 pos.y = top;
1605 return true;
1606 }
1607
1614 static Point GetAutoPlacePosition(int width, int height)
1615 {
1616 Point pt;
1617
1618 /* First attempt, try top-left of the screen */
1619 const Window *main_toolbar = FindWindowByClass(WC_MAIN_TOOLBAR);
1620 if (IsGoodAutoPlace1(0, main_toolbar != NULL ? main_toolbar->height + 2 : 2, width, height, pt)) return pt;
1621
1622 /* Second attempt, try around all existing windows with a distance of 2 pixels.
1623 * The new window must be entirely on-screen, and not overlap with an existing window.
1624 * Eight starting points are tried, two at each corner.
1625 */
1626 const Window *w;
1627 FOR_ALL_WINDOWS_FROM_BACK(w) {
1628 if (w->window_class == WC_MAIN_WINDOW) continue;
1629
1630 if (IsGoodAutoPlace1(w->left + w->width + 2, w->top, width, height, pt)) return pt;
1631 if (IsGoodAutoPlace1(w->left - width - 2, w->top, width, height, pt)) return pt;
1632 if (IsGoodAutoPlace1(w->left, w->top + w->height + 2, width, height, pt)) return pt;
1633 if (IsGoodAutoPlace1(w->left, w->top - height - 2, width, height, pt)) return pt;
1634 if (IsGoodAutoPlace1(w->left + w->width + 2, w->top + w->height - height, width, height, pt)) return pt;
1635 if (IsGoodAutoPlace1(w->left - width - 2, w->top + w->height - height, width, height, pt)) return pt;
1636 if (IsGoodAutoPlace1(w->left + w->width - width, w->top + w->height + 2, width, height, pt)) return pt;
1637 if (IsGoodAutoPlace1(w->left + w->width - width, w->top - height - 2, width, height, pt)) return pt;
1638 }
1639
1640 /* Third attempt, try around all existing windows with a distance of 2 pixels.
1641 * The new window may be partly off-screen, and must not overlap with an existing window.
1642 * Only four starting points are tried.
1643 */
1644 FOR_ALL_WINDOWS_FROM_BACK(w) {
1645 if (w->window_class == WC_MAIN_WINDOW) continue;
1646
1647 if (IsGoodAutoPlace2(w->left + w->width + 2, w->top, width, height, pt)) return pt;
1648 if (IsGoodAutoPlace2(w->left - width - 2, w->top, width, height, pt)) return pt;
1649 if (IsGoodAutoPlace2(w->left, w->top + w->height + 2, width, height, pt)) return pt;
1650 if (IsGoodAutoPlace2(w->left, w->top - height - 2, width, height, pt)) return pt;
1651 }
1652
1653 /* Fourth and final attempt, put window at diagonal starting from (0, 24), try multiples
1654 * of (+5, +5)
1655 */
1656 int left = 0, top = 24;
1657
1658 restart:
1659 FOR_ALL_WINDOWS_FROM_BACK(w) {
1660 if (w->left == left && w->top == top) {
1661 left += 5;
1662 top += 5;
1663 goto restart;
1664 }
1665 }
1666
1667 pt.x = left;
1668 pt.y = top;
1669 return pt;
1670 }
1671
1678 Point GetToolbarAlignedWindowPosition(int window_width)
1679 {
1680 const Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);
1681 assert(w != NULL);
1682 Point pt = { _current_text_dir == TD_RTL ? w->left : (w->left + w->width) - window_width, w->top + w->height };
1683 return pt;
1684 }
1685
1703 static Point LocalGetWindowPlacement(const WindowDesc *desc, int16 sm_width, int16 sm_height, int window_number)
1704 {
1705 Point pt;
1706 const Window *w;
1707
1708 int16 default_width = max(desc->GetDefaultWidth(), sm_width);
1709 int16 default_height = max(desc->GetDefaultHeight(), sm_height);
1710
1711 if (desc->parent_cls != 0 /* WC_MAIN_WINDOW */ &&
1712 (w = FindWindowById(desc->parent_cls, window_number)) != NULL &&
1713 w->left < _screen.width - 20 && w->left > -60 && w->top < _screen.height - 20) {
1714
1715 pt.x = w->left + ((desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) ? 0 : 10);
1716 if (pt.x > _screen.width + 10 - default_width) {
1717 pt.x = (_screen.width + 10 - default_width) - 20;
1718 }
1719 pt.y = w->top + ((desc->parent_cls == WC_BUILD_TOOLBAR || desc->parent_cls == WC_SCEN_LAND_GEN) ? w->height : 10);
1720 return pt;
1721 }
1722
1723 switch (desc->default_pos) {
1724 case WDP_ALIGN_TOOLBAR: // Align to the toolbar
1725 return GetToolbarAlignedWindowPosition(default_width);
1726
1727 case WDP_AUTO: // Find a good automatic position for the window
1728 return GetAutoPlacePosition(default_width, default_height);
1729
1730 case WDP_CENTER: // Centre the window horizontally
1731 pt.x = (_screen.width - default_width) / 2;
1732 pt.y = (_screen.height - default_height) / 2;
1733 break;
1734
1735 case WDP_MANUAL:
1736 pt.x = 0;
1737 pt.y = 0;
1738 break;
1739
1740 default:
1741 NOT_REACHED();
1742 }
1743
1744 return pt;
1745 }
1746
1747 /* virtual */ Point Window::OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
1748 {
1749 return LocalGetWindowPlacement(this->window_desc, sm_width, sm_height, window_number);
1750 }
1751
1759 void Window::CreateNestedTree(bool fill_nested)
1760 {
1761 int biggest_index = -1;
1762 this->nested_root = MakeWindowNWidgetTree(this->window_desc->nwid_parts, this->window_desc->nwid_length, &biggest_index, &this->shade_select);
1763 this->nested_array_size = (uint)(biggest_index + 1);
1764
1765 if (fill_nested) {
1766 this->nested_array = CallocT<NWidgetBase *>(this->nested_array_size);
1767 this->nested_root->FillNestedArray(this->nested_array, this->nested_array_size);
1768 }
1769 }
1770
1775 void Window::FinishInitNested(WindowNumber window_number)
1776 {
1777 this->InitializeData(window_number);
1778 this->ApplyDefaults();
1779 Point pt = this->OnInitialPosition(this->nested_root->smallest_x, this->nested_root->smallest_y, window_number);
1780 this->InitializePositionSize(pt.x, pt.y, this->nested_root->smallest_x, this->nested_root->smallest_y);
1781 this->FindWindowPlacementAndResize(this->window_desc->GetDefaultWidth(), this->window_desc->GetDefaultHeight());
1782 }
1783
1788 void Window::InitNested(WindowNumber window_number)
1789 {
1790 this->CreateNestedTree(false);
1791 this->FinishInitNested(window_number);
1792 }
1793
1798 Window::Window(WindowDesc *desc) : window_desc(desc), scrolling_scrollbar(-1)
1799 {
1800 }
1801
1809 Window *FindWindowFromPt(int x, int y)
1810 {
1811 Window *w;
1812 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1813 if (MayBeShown(w) && IsInsideBS(x, w->left, w->width) && IsInsideBS(y, w->top, w->height)) {
1814 return w;
1815 }
1816 }
1817
1818 return NULL;
1819 }
1820
1824 void InitWindowSystem()
1825 {
1826 IConsoleClose();
1827
1828 _z_back_window = NULL;
1829 _z_front_window = NULL;
1830 _focused_window = NULL;
1831 _mouseover_last_w = NULL;
1832 _last_scroll_window = NULL;
1833 _scrolling_viewport = false;
1834 _mouse_hovering = false;
1835
1836 NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
1837 NWidgetScrollbar::InvalidateDimensionCache();
1838
1839 ShowFirstError();
1840 }
1841
1845 void UnInitWindowSystem()
1846 {
1847 UnshowCriticalError();
1848
1849 Window *w;
1850 FOR_ALL_WINDOWS_FROM_FRONT(w) delete w;
1851
1852 for (w = _z_front_window; w != NULL; /* nothing */) {
1853 Window *to_del = w;
1854 w = w->z_back;
1855 free(to_del);
1856 }
1857
1858 _z_front_window = NULL;
1859 _z_back_window = NULL;
1860 }
1861
1865 void ResetWindowSystem()
1866 {
1867 UnInitWindowSystem();
1868 InitWindowSystem();
1869 _thd.Reset();
1870 }
1871
1872 static void DecreaseWindowCounters()
1873 {
1874 Window *w;
1875 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1876 if (_scroller_click_timeout == 0) {
1877 /* Unclick scrollbar buttons if they are pressed. */
1878 for (uint i = 0; i < w->nested_array_size; i++) {
1879 NWidgetBase *nwid = w->nested_array[i];
1880 if (nwid != NULL && (nwid->type == NWID_HSCROLLBAR || nwid->type == NWID_VSCROLLBAR)) {
1881 NWidgetScrollbar *sb = static_cast<NWidgetScrollbar*>(nwid);
1882 if (sb->disp_flags & (ND_SCROLLBAR_UP | ND_SCROLLBAR_DOWN)) {
1883 sb->disp_flags &= ~(ND_SCROLLBAR_UP | ND_SCROLLBAR_DOWN);
1884 w->scrolling_scrollbar = -1;
1885 sb->SetDirty(w);
1886 }
1887 }
1888 }
1889 }
1890
1891 /* Handle editboxes */
1892 for (SmallMap<int, QueryString*>::Pair *it = w->querystrings.Begin(); it != w->querystrings.End(); ++it) {
1893 it->second->HandleEditBox(w, it->first);
1894 }
1895
1896 w->OnMouseLoop();
1897 }
1898
1899 FOR_ALL_WINDOWS_FROM_FRONT(w) {
1900 if ((w->flags & WF_TIMEOUT) && --w->timeout_timer == 0) {
1901 CLRBITS(w->flags, WF_TIMEOUT);
1902
1903 w->OnTimeout();
1904 w->RaiseButtons(true);
1905 }
1906 }
1907 }
1908
1909 static void HandlePlacePresize()
1910 {
1911 if (_special_mouse_mode != WSM_PRESIZE) return;
1912
1913 Window *w = _thd.GetCallbackWnd();
1914 if (w == NULL) return;
1915
1916 Point pt = GetTileBelowCursor();
1917 if (pt.x == -1) {
1918 _thd.selend.x = -1;
1919 return;
1920 }
1921
1922 w->OnPlacePresize(pt, TileVirtXY(pt.x, pt.y));
1923 }
1924
1929 static EventState HandleMouseDragDrop()
1930 {
1931 if (_special_mouse_mode != WSM_DRAGDROP) return ES_NOT_HANDLED;
1932
1933 if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED; // Dragging, but the mouse did not move.
1934
1935 Window *w = _thd.GetCallbackWnd();
1936 if (w != NULL) {
1937 /* Send an event in client coordinates. */
1938 Point pt;
1939 pt.x = _cursor.pos.x - w->left;
1940 pt.y = _cursor.pos.y - w->top;
1941 if (_left_button_down) {
1942 w->OnMouseDrag(pt, GetWidgetFromPos(w, pt.x, pt.y));
1943 } else {
1944 w->OnDragDrop(pt, GetWidgetFromPos(w, pt.x, pt.y));
1945 }
1946 }
1947
1948 if (!_left_button_down) ResetObjectToPlace(); // Button released, finished dragging.
1949 return ES_HANDLED;
1950 }
1951
1953 static void HandleMouseOver()
1954 {
1955 Window *w = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
1956
1957 /* We changed window, put a MOUSEOVER event to the last window */
1958 if (_mouseover_last_w != NULL && _mouseover_last_w != w) {
1959 /* Reset mouse-over coordinates of previous window */
1960 Point pt = { -1, -1 };
1961 _mouseover_last_w->OnMouseOver(pt, 0);
1962 }
1963
1964 /* _mouseover_last_w will get reset when the window is deleted, see DeleteWindow() */
1965 _mouseover_last_w = w;
1966
1967 if (w != NULL) {
1968 /* send an event in client coordinates. */
1969 Point pt = { _cursor.pos.x - w->left, _cursor.pos.y - w->top };
1970 const NWidgetCore *widget = w->nested_root->GetWidgetFromPos(pt.x, pt.y);
1971 if (widget != NULL) w->OnMouseOver(pt, widget->index);
1972 }
1973 }
1974
1976 static const int MIN_VISIBLE_TITLE_BAR = 13;
1977
1979 enum PreventHideDirection {
1980 PHD_UP,
1981 PHD_DOWN,
1982 };
1983
1994 static void PreventHiding(int *nx, int *ny, const Rect &rect, const Window *v, int px, PreventHideDirection dir)
1995 {
1996 if (v == NULL) return;
1997
1998 int v_bottom = v->top + v->height;
1999 int v_right = v->left + v->width;
2000 int safe_y = (dir == PHD_UP) ? (v->top - MIN_VISIBLE_TITLE_BAR - rect.top) : (v_bottom + MIN_VISIBLE_TITLE_BAR - rect.bottom); // Compute safe vertical position.
2001
2002 if (*ny + rect.top <= v->top - MIN_VISIBLE_TITLE_BAR) return; // Above v is enough space
2003 if (*ny + rect.bottom >= v_bottom + MIN_VISIBLE_TITLE_BAR) return; // Below v is enough space
2004
2005 /* Vertically, the rectangle is hidden behind v. */
2006 if (*nx + rect.left + MIN_VISIBLE_TITLE_BAR < v->left) { // At left of v.
2007 if (v->left < MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // But enough room, force it to a safe position.
2008 return;
2009 }
2010 if (*nx + rect.right - MIN_VISIBLE_TITLE_BAR > v_right) { // At right of v.
2011 if (v_right > _screen.width - MIN_VISIBLE_TITLE_BAR) *ny = safe_y; // Not enough room, force it to a safe position.
2012 return;
2013 }
2014
2015 /* Horizontally also hidden, force movement to a safe area. */
2016 if (px + rect.left < v->left && v->left >= MIN_VISIBLE_TITLE_BAR) { // Coming from the left, and enough room there.
2017 *nx = v->left - MIN_VISIBLE_TITLE_BAR - rect.left;
2018 } else if (px + rect.right > v_right && v_right <= _screen.width - MIN_VISIBLE_TITLE_BAR) { // Coming from the right, and enough room there.
2019 *nx = v_right + MIN_VISIBLE_TITLE_BAR - rect.right;
2020 } else {
2021 *ny = safe_y;
2022 }
2023 }
2024
2032 static void EnsureVisibleCaption(Window *w, int nx, int ny)
2033 {
2034 /* Search for the title bar rectangle. */
2035 Rect caption_rect;
2036 const NWidgetBase *caption = w->nested_root->GetWidgetOfType(WWT_CAPTION);
2037 if (caption != NULL) {
2038 caption_rect.left = caption->pos_x;
2039 caption_rect.right = caption->pos_x + caption->current_x;
2040 caption_rect.top = caption->pos_y;
2041 caption_rect.bottom = caption->pos_y + caption->current_y;
2042
2043 /* Make sure the window doesn't leave the screen */
2044 nx = Clamp(nx, MIN_VISIBLE_TITLE_BAR - caption_rect.right, _screen.width - MIN_VISIBLE_TITLE_BAR - caption_rect.left);
2045 ny = Clamp(ny, 0, _screen.height - MIN_VISIBLE_TITLE_BAR);
2046
2047 /* Make sure the title bar isn't hidden behind the main tool bar or the status bar. */
2048 PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_MAIN_TOOLBAR, 0), w->left, PHD_DOWN);
2049 PreventHiding(&nx, &ny, caption_rect, FindWindowById(WC_STATUS_BAR, 0), w->left, PHD_UP);
2050 }
2051
2052 if (w->viewport != NULL) {
2053 w->viewport->left += nx - w->left;
2054 w->viewport->top += ny - w->top;
2055 }
2056
2057 w->left = nx;
2058 w->top = ny;
2059 }
2060
2071 void ResizeWindow(Window *w, int delta_x, int delta_y, bool clamp_to_screen)
2072 {
2073 if (delta_x != 0 || delta_y != 0) {
2074 if (clamp_to_screen) {
2075 /* Determine the new right/bottom position. If that is outside of the bounds of
2076 * the resolution clamp it in such a manner that it stays within the bounds. */
2077 int new_right = w->left + w->width + delta_x;
2078 int new_bottom = w->top + w->height + delta_y;
2079 if (new_right >= (int)_cur_resolution.width) delta_x -= Ceil(new_right - _cur_resolution.width, max(1U, w->nested_root->resize_x));
2080 if (new_bottom >= (int)_cur_resolution.height) delta_y -= Ceil(new_bottom - _cur_resolution.height, max(1U, w->nested_root->resize_y));
2081 }
2082
2083 w->SetDirty();
2084
2085 uint new_xinc = max(0, (w->nested_root->resize_x == 0) ? 0 : (int)(w->nested_root->current_x - w->nested_root->smallest_x) + delta_x);
2086 uint new_yinc = max(0, (w->nested_root->resize_y == 0) ? 0 : (int)(w->nested_root->current_y - w->nested_root->smallest_y) + delta_y);
2087 assert(w->nested_root->resize_x == 0 || new_xinc % w->nested_root->resize_x == 0);
2088 assert(w->nested_root->resize_y == 0 || new_yinc % w->nested_root->resize_y == 0);
2089
2090 w->nested_root->AssignSizePosition(ST_RESIZE, 0, 0, w->nested_root->smallest_x + new_xinc, w->nested_root->smallest_y + new_yinc, _current_text_dir == TD_RTL);
2091 w->width = w->nested_root->current_x;
2092 w->height = w->nested_root->current_y;
2093 }
2094
2095 EnsureVisibleCaption(w, w->left, w->top);
2096
2097 /* Always call OnResize to make sure everything is initialised correctly if it needs to be. */
2098 w->OnResize();
2099 w->SetDirty();
2100 }
2101
2107 int GetMainViewTop()
2108 {
2109 Window *w = FindWindowById(WC_MAIN_TOOLBAR, 0);
2110 return (w == NULL) ? 0 : w->top + w->height;
2111 }
2112
2118 int GetMainViewBottom()
2119 {
2120 Window *w = FindWindowById(WC_STATUS_BAR, 0);
2121 return (w == NULL) ? _screen.height : w->top;
2122 }
2123
2124 static bool _dragging_window;
2125
2130 static EventState HandleWindowDragging()
2131 {
2132 /* Get out immediately if no window is being dragged at all. */
2133 if (!_dragging_window) return ES_NOT_HANDLED;
2134
2135 /* If button still down, but cursor hasn't moved, there is nothing to do. */
2136 if (_left_button_down && _cursor.delta.x == 0 && _cursor.delta.y == 0) return ES_HANDLED;
2137
2138 /* Otherwise find the window... */
2139 Window *w;
2140 FOR_ALL_WINDOWS_FROM_BACK(w) {
2141 if (w->flags & WF_DRAGGING) {
2142 /* Stop the dragging if the left mouse button was released */
2143 if (!_left_button_down) {
2144 w->flags &= ~WF_DRAGGING;
2145 break;
2146 }
2147
2148 w->SetDirty();
2149
2150 int x = _cursor.pos.x + _drag_delta.x;
2151 int y = _cursor.pos.y + _drag_delta.y;
2152 int nx = x;
2153 int ny = y;
2154
2155 if (_settings_client.gui.window_snap_radius != 0) {
2156 const Window *v;
2157
2158 int hsnap = _settings_client.gui.window_snap_radius;
2159 int vsnap = _settings_client.gui.window_snap_radius;
2160 int delta;
2161
2162 FOR_ALL_WINDOWS_FROM_BACK(v) {
2163 if (v == w) continue; // Don't snap at yourself
2164
2165 if (y + w->height > v->top && y < v->top + v->height) {
2166 /* Your left border <-> other right border */
2167 delta = abs(v->left + v->width - x);
2168 if (delta <= hsnap) {
2169 nx = v->left + v->width;
2170 hsnap = delta;
2171 }
2172
2173 /* Your right border <-> other left border */
2174 delta = abs(v->left - x - w->width);
2175 if (delta <= hsnap) {
2176 nx = v->left - w->width;
2177 hsnap = delta;
2178 }
2179 }
2180
2181 if (w->top + w->height >= v->top && w->top <= v->top + v->height) {
2182 /* Your left border <-> other left border */
2183 delta = abs(v->left - x);
2184 if (delta <= hsnap) {
2185 nx = v->left;
2186 hsnap = delta;
2187 }
2188
2189 /* Your right border <-> other right border */
2190 delta = abs(v->left + v->width - x - w->width);
2191 if (delta <= hsnap) {
2192 nx = v->left + v->width - w->width;
2193 hsnap = delta;
2194 }
2195 }
2196
2197 if (x + w->width > v->left && x < v->left + v->width) {
2198 /* Your top border <-> other bottom border */
2199 delta = abs(v->top + v->height - y);
2200 if (delta <= vsnap) {
2201 ny = v->top + v->height;
2202 vsnap = delta;
2203 }
2204
2205 /* Your bottom border <-> other top border */
2206 delta = abs(v->top - y - w->height);
2207 if (delta <= vsnap) {
2208 ny = v->top - w->height;
2209 vsnap = delta;
2210 }
2211 }
2212
2213 if (w->left + w->width >= v->left && w->left <= v->left + v->width) {
2214 /* Your top border <-> other top border */
2215 delta = abs(v->top - y);
2216 if (delta <= vsnap) {
2217 ny = v->top;
2218 vsnap = delta;
2219 }
2220
2221 /* Your bottom border <-> other bottom border */
2222 delta = abs(v->top + v->height - y - w->height);
2223 if (delta <= vsnap) {
2224 ny = v->top + v->height - w->height;
2225 vsnap = delta;
2226 }
2227 }
2228 }
2229 }
2230
2231 EnsureVisibleCaption(w, nx, ny);
2232
2233 w->SetDirty();
2234 return ES_HANDLED;
2235 } else if (w->flags & WF_SIZING) {
2236 /* Stop the sizing if the left mouse button was released */
2237 if (!_left_button_down) {
2238 w->flags &= ~WF_SIZING;
2239 w->SetDirty();
2240 break;
2241 }
2242
2243 /* Compute difference in pixels between cursor position and reference point in the window.
2244 * If resizing the left edge of the window, moving to the left makes the window bigger not smaller.
2245 */
2246 int x, y = _cursor.pos.y - _drag_delta.y;
2247 if (w->flags & WF_SIZING_LEFT) {
2248 x = _drag_delta.x - _cursor.pos.x;
2249 } else {
2250 x = _cursor.pos.x - _drag_delta.x;
2251 }
2252
2253 /* resize.step_width and/or resize.step_height may be 0, which means no resize is possible. */
2254 if (w->resize.step_width == 0) x = 0;
2255 if (w->resize.step_height == 0) y = 0;
2256
2257 /* Check the resize button won't go past the bottom of the screen */
2258 if (w->top + w->height + y > _screen.height) {
2259 y = _screen.height - w->height - w->top;
2260 }
2261
2262 /* X and Y has to go by step.. calculate it.
2263 * The cast to int is necessary else x/y are implicitly casted to
2264 * unsigned int, which won't work. */
2265 if (w->resize.step_width > 1) x -= x % (int)w->resize.step_width;
2266 if (w->resize.step_height > 1) y -= y % (int)w->resize.step_height;
2267
2268 /* Check that we don't go below the minimum set size */
2269 if ((int)w->width + x < (int)w->nested_root->smallest_x) {
2270 x = w->nested_root->smallest_x - w->width;
2271 }
2272 if ((int)w->height + y < (int)w->nested_root->smallest_y) {
2273 y = w->nested_root->smallest_y - w->height;
2274 }
2275
2276 /* Window already on size */
2277 if (x == 0 && y == 0) return ES_HANDLED;
2278
2279 /* Now find the new cursor pos.. this is NOT _cursor, because we move in steps. */
2280 _drag_delta.y += y;
2281 if ((w->flags & WF_SIZING_LEFT) && x != 0) {
2282 _drag_delta.x -= x; // x > 0 -> window gets longer -> left-edge moves to left -> subtract x to get new position.
2283 w->SetDirty();
2284 w->left -= x; // If dragging left edge, move left window edge in opposite direction by the same amount.
2285 /* ResizeWindow() below ensures marking new position as dirty. */
2286 } else {
2287 _drag_delta.x += x;
2288 }
2289
2290 /* ResizeWindow sets both pre- and after-size to dirty for redrawal */
2291 ResizeWindow(w, x, y);
2292 return ES_HANDLED;
2293 }
2294 }
2295
2296 _dragging_window = false;
2297 return ES_HANDLED;
2298 }
2299
2304 static void StartWindowDrag(Window *w)
2305 {
2306 w->flags |= WF_DRAGGING;
2307 w->flags &= ~WF_CENTERED;
2308 _dragging_window = true;
2309
2310 _drag_delta.x = w->left - _cursor.pos.x;
2311 _drag_delta.y = w->top - _cursor.pos.y;
2312
2313 BringWindowToFront(w);
2314 DeleteWindowById(WC_DROPDOWN_MENU, 0);
2315 }
2316
2322 static void StartWindowSizing(Window *w, bool to_left)
2323 {
2324 w->flags |= to_left ? WF_SIZING_LEFT : WF_SIZING_RIGHT;
2325 w->flags &= ~WF_CENTERED;
2326 _dragging_window = true;
2327
2328 _drag_delta.x = _cursor.pos.x;
2329 _drag_delta.y = _cursor.pos.y;
2330
2331 BringWindowToFront(w);
2332 DeleteWindowById(WC_DROPDOWN_MENU, 0);
2333 }
2334
2339 static EventState HandleScrollbarScrolling()
2340 {
2341 Window *w;
2342 FOR_ALL_WINDOWS_FROM_BACK(w) {
2343 if (w->scrolling_scrollbar >= 0) {
2344 /* Abort if no button is clicked any more. */
2345 if (!_left_button_down) {
2346 w->scrolling_scrollbar = -1;
2347 w->SetDirty();
2348 return ES_HANDLED;
2349 }
2350
2351 int i;
2352 NWidgetScrollbar *sb = w->GetWidget<NWidgetScrollbar>(w->scrolling_scrollbar);
2353 bool rtl = false;
2354
2355 if (sb->type == NWID_HSCROLLBAR) {
2356 i = _cursor.pos.x - _cursorpos_drag_start.x;
2357 rtl = _current_text_dir == TD_RTL;
2358 } else {
2359 i = _cursor.pos.y - _cursorpos_drag_start.y;
2360 }
2361
2362 if (sb->disp_flags & ND_SCROLLBAR_BTN) {
2363 if (_scroller_click_timeout == 1) {
2364 _scroller_click_timeout = 3;
2365 sb->UpdatePosition(rtl == HasBit(sb->disp_flags, NDB_SCROLLBAR_UP) ? 1 : -1);
2366 w->SetDirty();
2367 }
2368 return ES_HANDLED;
2369 }
2370
2371 /* Find the item we want to move to and make sure it's inside bounds. */
2372 int pos = min(max(0, i + _scrollbar_start_pos) * sb->GetCount() / _scrollbar_size, max(0, sb->GetCount() - sb->GetCapacity()));
2373 if (rtl) pos = max(0, sb->GetCount() - sb->GetCapacity() - pos);
2374 if (pos != sb->GetPosition()) {
2375 sb->SetPosition(pos);
2376 w->SetDirty();
2377 }
2378 return ES_HANDLED;
2379 }
2380 }
2381
2382 return ES_NOT_HANDLED;
2383 }
2384
2389 static EventState HandleViewportScroll()
2390 {
2391 bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2392
2393 if (!_scrolling_viewport) return ES_NOT_HANDLED;
2394
2395 /* When we don't have a last scroll window we are starting to scroll.
2396 * When the last scroll window and this are not the same we went
2397 * outside of the window and should not left-mouse scroll anymore. */
2398 if (_last_scroll_window == NULL) _last_scroll_window = FindWindowFromPt(_cursor.pos.x, _cursor.pos.y);
2399
2400 if (_last_scroll_window == NULL || !(_right_button_down || scrollwheel_scrolling || (_settings_client.gui.left_mouse_btn_scrolling && _left_button_down))) {
2401 _cursor.fix_at = false;
2402 _scrolling_viewport = false;
2403 _last_scroll_window = NULL;
2404 return ES_NOT_HANDLED;
2405 }
2406
2407 if (_last_scroll_window == FindWindowById(WC_MAIN_WINDOW, 0) && _last_scroll_window->viewport->follow_vehicle != INVALID_VEHICLE) {
2408 /* If the main window is following a vehicle, then first let go of it! */
2409 const Vehicle *veh = Vehicle::Get(_last_scroll_window->viewport->follow_vehicle);
2410 ScrollMainWindowTo(veh->x_pos, veh->y_pos, veh->z_pos, true); // This also resets follow_vehicle
2411 return ES_NOT_HANDLED;
2412 }
2413
2414 Point delta;
2415 if (_settings_client.gui.reverse_scroll || (_settings_client.gui.left_mouse_btn_scrolling && _left_button_down)) {
2416 delta.x = -_cursor.delta.x;
2417 delta.y = -_cursor.delta.y;
2418 } else {
2419 delta.x = _cursor.delta.x;
2420 delta.y = _cursor.delta.y;
2421 }
2422
2423 if (scrollwheel_scrolling) {
2424 /* We are using scrollwheels for scrolling */
2425 delta.x = _cursor.h_wheel;
2426 delta.y = _cursor.v_wheel;
2427 _cursor.v_wheel = 0;
2428 _cursor.h_wheel = 0;
2429 }
2430
2431 /* Create a scroll-event and send it to the window */
2432 if (delta.x != 0 || delta.y != 0) _last_scroll_window->OnScroll(delta);
2433
2434 _cursor.delta.x = 0;
2435 _cursor.delta.y = 0;
2436 return ES_HANDLED;
2437 }
2438
2449 static bool MaybeBringWindowToFront(Window *w)
2450 {
2451 bool bring_to_front = false;
2452
2453 if (w->window_class == WC_MAIN_WINDOW ||
2454 IsVitalWindow(w) ||
2455 w->window_class == WC_TOOLTIPS ||
2456 w->window_class == WC_DROPDOWN_MENU) {
2457 return true;
2458 }
2459
2460 /* Use unshaded window size rather than current size for shaded windows. */
2461 int w_width = w->width;
2462 int w_height = w->height;
2463 if (w->IsShaded()) {
2464 w_width = w->unshaded_size.width;
2465 w_height = w->unshaded_size.height;
2466 }
2467
2468 Window *u;
2469 FOR_ALL_WINDOWS_FROM_BACK_FROM(u, w->z_front) {
2470 /* A modal child will prevent the activation of the parent window */
2471 if (u->parent == w && (u->window_desc->flags & WDF_MODAL)) {
2472 u->SetWhiteBorder();
2473 u->SetDirty();
2474 return false;
2475 }
2476
2477 if (u->window_class == WC_MAIN_WINDOW ||
2478 IsVitalWindow(u) ||
2479 u->window_class == WC_TOOLTIPS ||
2480 u->window_class == WC_DROPDOWN_MENU) {
2481 continue;
2482 }
2483
2484 /* Window sizes don't interfere, leave z-order alone */
2485 if (w->left + w_width <= u->left ||
2486 u->left + u->width <= w->left ||
2487 w->top + w_height <= u->top ||
2488 u->top + u->height <= w->top) {
2489 continue;
2490 }
2491
2492 bring_to_front = true;
2493 }
2494
2495 if (bring_to_front) BringWindowToFront(w);
2496 return true;
2497 }
2498
2507 EventState Window::HandleEditBoxKey(int wid, WChar key, uint16 keycode)
2508 {
2509 QueryString *query = this->GetQueryString(wid);
2510 if (query == NULL) return ES_NOT_HANDLED;
2511
2512 int action = QueryString::ACTION_NOTHING;
2513
2514 switch (query->text.HandleKeyPress(key, keycode)) {
2515 case HKPR_EDITING:
2516 this->SetWidgetDirty(wid);
2517 this->OnEditboxChanged(wid);
2518 break;
2519
2520 case HKPR_CURSOR:
2521 this->SetWidgetDirty(wid);
2522 /* For the OSK also invalidate the parent window */
2523 if (this->window_class == WC_OSK) this->InvalidateData();
2524 break;
2525
2526 case HKPR_CONFIRM:
2527 if (this->window_class == WC_OSK) {
2528 this->OnClick(Point(), WID_OSK_OK, 1);
2529 } else if (query->ok_button >= 0) {
2530 this->OnClick(Point(), query->ok_button, 1);
2531 } else {
2532 action = query->ok_button;
2533 }
2534 break;
2535
2536 case HKPR_CANCEL:
2537 if (this->window_class == WC_OSK) {
2538 this->OnClick(Point(), WID_OSK_CANCEL, 1);
2539 } else if (query->cancel_button >= 0) {
2540 this->OnClick(Point(), query->cancel_button, 1);
2541 } else {
2542 action = query->cancel_button;
2543 }
2544 break;
2545
2546 case HKPR_NOT_HANDLED:
2547 return ES_NOT_HANDLED;
2548
2549 default: break;
2550 }
2551
2552 switch (action) {
2553 case QueryString::ACTION_DESELECT:
2554 this->UnfocusFocusedWidget();
2555 break;
2556
2557 case QueryString::ACTION_CLEAR:
2558 if (query->text.bytes <= 1) {
2559 /* If already empty, unfocus instead */
2560 this->UnfocusFocusedWidget();
2561 } else {
2562 query->text.DeleteAll();
2563 this->SetWidgetDirty(wid);
2564 this->OnEditboxChanged(wid);
2565 }
2566 break;
2567
2568 default:
2569 break;
2570 }
2571
2572 return ES_HANDLED;
2573 }
2574
2580 void HandleKeypress(uint keycode, WChar key)
2581 {
2582 /* World generation is multithreaded and messes with companies.
2583 * But there is no company related window open anyway, so _current_company is not used. */
2584 assert(HasModalProgress() || IsLocalCompany());
2585
2586 /*
2587 * The Unicode standard defines an area called the private use area. Code points in this
2588 * area are reserved for private use and thus not portable between systems. For instance,
2589 * Apple defines code points for the arrow keys in this area, but these are only printable
2590 * on a system running OS X. We don't want these keys to show up in text fields and such,
2591 * and thus we have to clear the unicode character when we encounter such a key.
2592 */
2593 if (key >= 0xE000 && key <= 0xF8FF) key = 0;
2594
2595 /*
2596 * If both key and keycode is zero, we don't bother to process the event.
2597 */
2598 if (key == 0 && keycode == 0) return;
2599
2600 /* Check if the focused window has a focused editbox */
2601 if (EditBoxInGlobalFocus()) {
2602 /* All input will in this case go to the focused editbox */
2603 if (_focused_window->window_class == WC_CONSOLE) {
2604 if (_focused_window->OnKeyPress(key, keycode) == ES_HANDLED) return;
2605 } else {
2606 if (_focused_window->HandleEditBoxKey(_focused_window->nested_focus->index, key, keycode) == ES_HANDLED) return;
2607 }
2608 }
2609
2610 /* Call the event, start with the uppermost window, but ignore the toolbar. */
2611 Window *w;
2612 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2613 if (w->window_class == WC_MAIN_TOOLBAR) continue;
2614 if (w->window_desc->hotkeys != NULL) {
2615 int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2616 if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2617 }
2618 if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2619 }
2620
2621 w = FindWindowById(WC_MAIN_TOOLBAR, 0);
2622 /* When there is no toolbar w is null, check for that */
2623 if (w != NULL) {
2624 if (w->window_desc->hotkeys != NULL) {
2625 int hotkey = w->window_desc->hotkeys->CheckMatch(keycode);
2626 if (hotkey >= 0 && w->OnHotkey(hotkey) == ES_HANDLED) return;
2627 }
2628 if (w->OnKeyPress(key, keycode) == ES_HANDLED) return;
2629 }
2630
2631 HandleGlobalHotkeys(key, keycode);
2632 }
2633
2637 void HandleCtrlChanged()
2638 {
2639 /* Call the event, start with the uppermost window. */
2640 Window *w;
2641 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2642 if (w->OnCTRLStateChange() == ES_HANDLED) return;
2643 }
2644 }
2645
2651 /* virtual */ void Window::InsertTextString(int wid, const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2652 {
2653 QueryString *query = this->GetQueryString(wid);
2654 if (query == NULL) return;
2655
2656 if (query->text.InsertString(str, marked, caret, insert_location, replacement_end) || marked) {
2657 this->SetWidgetDirty(wid);
2658 this->OnEditboxChanged(wid);
2659 }
2660 }
2661
2668 void HandleTextInput(const char *str, bool marked, const char *caret, const char *insert_location, const char *replacement_end)
2669 {
2670 if (!EditBoxInGlobalFocus()) return;
2671
2672 _focused_window->InsertTextString(_focused_window->window_class == WC_CONSOLE ? 0 : _focused_window->nested_focus->index, str, marked, caret, insert_location, replacement_end);
2673 }
2674
2681 static int _input_events_this_tick = 0;
2682
2687 static void HandleAutoscroll()
2688 {
2689 if (_game_mode == GM_MENU || HasModalProgress()) return;
2690 if (_settings_client.gui.auto_scrolling == VA_DISABLED) return;
2691 if (_settings_client.gui.auto_scrolling == VA_MAIN_VIEWPORT_FULLSCREEN && !_fullscreen) return;
2692
2693 int x = _cursor.pos.x;
2694 int y = _cursor.pos.y;
2695 Window *w = FindWindowFromPt(x, y);
2696 if (w == NULL || w->flags & WF_DISABLE_VP_SCROLL) return;
2697 if (_settings_client.gui.auto_scrolling != VA_EVERY_VIEWPORT && w->window_class != WC_MAIN_WINDOW) return;
2698
2699 ViewPort *vp = IsPtInWindowViewport(w, x, y);
2700 if (vp == NULL) return;
2701
2702 x -= vp->left;
2703 y -= vp->top;
2704
2705 /* here allows scrolling in both x and y axis */
2706 #define scrollspeed 3
2707 if (x - 15 < 0) {
2708 w->viewport->dest_scrollpos_x += ScaleByZoom((x - 15) * scrollspeed, vp->zoom);
2709 } else if (15 - (vp->width - x) > 0) {
2710 w->viewport->dest_scrollpos_x += ScaleByZoom((15 - (vp->width - x)) * scrollspeed, vp->zoom);
2711 }
2712 if (y - 15 < 0) {
2713 w->viewport->dest_scrollpos_y += ScaleByZoom((y - 15) * scrollspeed, vp->zoom);
2714 } else if (15 - (vp->height - y) > 0) {
2715 w->viewport->dest_scrollpos_y += ScaleByZoom((15 - (vp->height - y)) * scrollspeed, vp->zoom);
2716 }
2717 #undef scrollspeed
2718 }
2719
2720 enum MouseClick {
2721 MC_NONE = 0,
2722 MC_LEFT,
2723 MC_RIGHT,
2724 MC_DOUBLE_LEFT,
2725 MC_HOVER,
2726
2727 MAX_OFFSET_DOUBLE_CLICK = 5,
2728 TIME_BETWEEN_DOUBLE_CLICK = 500,
2729 MAX_OFFSET_HOVER = 5,
2730 };
2731 extern EventState VpHandlePlaceSizingDrag();
2732
2733 static void ScrollMainViewport(int x, int y)
2734 {
2735 if (_game_mode != GM_MENU) {
2736 Window *w = FindWindowById(WC_MAIN_WINDOW, 0);
2737 assert(w);
2738
2739 w->viewport->dest_scrollpos_x += ScaleByZoom(x, w->viewport->zoom);
2740 w->viewport->dest_scrollpos_y += ScaleByZoom(y, w->viewport->zoom);
2741 }
2742 }
2743
2753 static const int8 scrollamt[16][2] = {
2754 { 0, 0},
2755 {-2, 0},
2756 { 0, -2},
2757 {-2, -1},
2758 { 2, 0},
2759 { 0, 0},
2760 { 2, -1},
2761 { 0, -2},
2762 { 0, 2},
2763 {-2, 1},
2764 { 0, 0},
2765 {-2, 0},
2766 { 2, 1},
2767 { 0, 2},
2768 { 2, 0},
2769 { 0, 0},
2770 };
2771
2772 static void HandleKeyScrolling()
2773 {
2774 /*
2775 * Check that any of the dirkeys is pressed and that the focused window
2776 * doesn't have an edit-box as focused widget.
2777 */
2778 if (_dirkeys && !EditBoxInGlobalFocus()) {
2779 int factor = _shift_pressed ? 50 : 10;
2780 ScrollMainViewport(scrollamt[_dirkeys][0] * factor, scrollamt[_dirkeys][1] * factor);
2781 }
2782 }
2783
2784 static void MouseLoop(MouseClick click, int mousewheel)
2785 {
2786 /* World generation is multithreaded and messes with companies.
2787 * But there is no company related window open anyway, so _current_company is not used. */
2788 assert(HasModalProgress() || IsLocalCompany());
2789
2790 HandlePlacePresize();
2791 UpdateTileSelection();
2792
2793 if (VpHandlePlaceSizingDrag() == ES_HANDLED) return;
2794 if (HandleMouseDragDrop() == ES_HANDLED) return;
2795 if (HandleWindowDragging() == ES_HANDLED) return;
2796 if (HandleScrollbarScrolling() == ES_HANDLED) return;
2797 if (HandleViewportScroll() == ES_HANDLED) return;
2798
2799 HandleMouseOver();
2800
2801 bool scrollwheel_scrolling = _settings_client.gui.scrollwheel_scrolling == 1 && (_cursor.v_wheel != 0 || _cursor.h_wheel != 0);
2802 if (click == MC_NONE && mousewheel == 0 && !scrollwheel_scrolling) return;
2803
2804 int x = _cursor.pos.x;
2805 int y = _cursor.pos.y;
2806 Window *w = FindWindowFromPt(x, y);
2807 if (w == NULL) return;
2808
2809 if (click != MC_HOVER && !MaybeBringWindowToFront(w)) return;
2810 ViewPort *vp = IsPtInWindowViewport(w, x, y);
2811
2812 /* Don't allow any action in a viewport if either in menu or when having a modal progress window */
2813 if (vp != NULL && (_game_mode == GM_MENU || HasModalProgress())) return;
2814
2815 if (mousewheel != 0) {
2816 /* Send mousewheel event to window */
2817 w->OnMouseWheel(mousewheel);
2818
2819 /* Dispatch a MouseWheelEvent for widgets if it is not a viewport */
2820 if (vp == NULL) DispatchMouseWheelEvent(w, w->nested_root->GetWidgetFromPos(x - w->left, y - w->top), mousewheel);
2821 }
2822
2823 if (vp != NULL) {
2824 if (scrollwheel_scrolling) click = MC_RIGHT; // we are using the scrollwheel in a viewport, so we emulate right mouse button
2825 switch (click) {
2826 case MC_DOUBLE_LEFT:
2827 case MC_LEFT:
2828 DEBUG(misc, 2, "Cursor: 0x%X (%d)", _cursor.sprite, _cursor.sprite);
2829 if (!HandleViewportClicked(vp, x, y) &&
2830 !(w->flags & WF_DISABLE_VP_SCROLL) &&
2831 _settings_client.gui.left_mouse_btn_scrolling) {
2832 _scrolling_viewport = true;
2833 _cursor.fix_at = false;
2834 }
2835 break;
2836
2837 case MC_RIGHT:
2838 if (!(w->flags & WF_DISABLE_VP_SCROLL)) {
2839 _scrolling_viewport = true;
2840 _cursor.fix_at = true;
2841
2842 /* clear 2D scrolling caches before we start a 2D scroll */
2843 _cursor.h_wheel = 0;
2844 _cursor.v_wheel = 0;
2845 }
2846 break;
2847
2848 default:
2849 break;
2850 }
2851 } else {
2852 switch (click) {
2853 case MC_LEFT:
2854 case MC_DOUBLE_LEFT:
2855 DispatchLeftClickEvent(w, x - w->left, y - w->top, click == MC_DOUBLE_LEFT ? 2 : 1);
2856 break;
2857
2858 default:
2859 if (!scrollwheel_scrolling || w == NULL || w->window_class != WC_SMALLMAP) break;
2860 /* We try to use the scrollwheel to scroll since we didn't touch any of the buttons.
2861 * Simulate a right button click so we can get started. */
2862 /* FALL THROUGH */
2863
2864 case MC_RIGHT: DispatchRightClickEvent(w, x - w->left, y - w->top); break;
2865
2866 case MC_HOVER: DispatchHoverEvent(w, x - w->left, y - w->top); break;
2867 }
2868 }
2869 }
2870
2874 void HandleMouseEvents()
2875 {
2876 /* World generation is multithreaded and messes with companies.
2877 * But there is no company related window open anyway, so _current_company is not used. */
2878 assert(HasModalProgress() || IsLocalCompany());
2879
2880 static int double_click_time = 0;
2881 static Point double_click_pos = {0, 0};
2882
2883 /* Mouse event? */
2884 MouseClick click = MC_NONE;
2885 if (_left_button_down && !_left_button_clicked) {
2886 click = MC_LEFT;
2887 if (double_click_time != 0 && _realtime_tick - double_click_time < TIME_BETWEEN_DOUBLE_CLICK &&
2888 double_click_pos.x != 0 && abs(_cursor.pos.x - double_click_pos.x) < MAX_OFFSET_DOUBLE_CLICK &&
2889 double_click_pos.y != 0 && abs(_cursor.pos.y - double_click_pos.y) < MAX_OFFSET_DOUBLE_CLICK) {
2890 click = MC_DOUBLE_LEFT;
2891 }
2892 double_click_time = _realtime_tick;
2893 double_click_pos = _cursor.pos;
2894 _left_button_clicked = true;
2895 _input_events_this_tick++;
2896 } else if (_right_button_clicked) {
2897 _right_button_clicked = false;
2898 click = MC_RIGHT;
2899 _input_events_this_tick++;
2900 }
2901
2902 int mousewheel = 0;
2903 if (_cursor.wheel) {
2904 mousewheel = _cursor.wheel;
2905 _cursor.wheel = 0;
2906 _input_events_this_tick++;
2907 }
2908
2909 static uint32 hover_time = 0;
2910 static Point hover_pos = {0, 0};
2911
2912 if (_settings_client.gui.hover_delay_ms > 0) {
2913 if (!_cursor.in_window || click != MC_NONE || mousewheel != 0 || _left_button_down || _right_button_down ||
2914 hover_pos.x == 0 || abs(_cursor.pos.x - hover_pos.x) >= MAX_OFFSET_HOVER ||
2915 hover_pos.y == 0 || abs(_cursor.pos.y - hover_pos.y) >= MAX_OFFSET_HOVER) {
2916 hover_pos = _cursor.pos;
2917 hover_time = _realtime_tick;
2918 _mouse_hovering = false;
2919 } else {
2920 if (hover_time != 0 && _realtime_tick > hover_time + _settings_client.gui.hover_delay_ms) {
2921 click = MC_HOVER;
2922 _input_events_this_tick++;
2923 _mouse_hovering = true;
2924 }
2925 }
2926 }
2927
2928 /* Handle sprite picker before any GUI interaction */
2929 if (_newgrf_debug_sprite_picker.mode == SPM_REDRAW && _newgrf_debug_sprite_picker.click_time != _realtime_tick) {
2930 /* Next realtime tick? Then redraw has finished */
2931 _newgrf_debug_sprite_picker.mode = SPM_NONE;
2932 InvalidateWindowData(WC_SPRITE_ALIGNER, 0, 1);
2933 }
2934
2935 if (click == MC_LEFT && _newgrf_debug_sprite_picker.mode == SPM_WAIT_CLICK) {
2936 /* Mark whole screen dirty, and wait for the next realtime tick, when drawing is finished. */
2937 Blitter *blitter = BlitterFactory::GetCurrentBlitter();
2938 _newgrf_debug_sprite_picker.clicked_pixel = blitter->MoveTo(_screen.dst_ptr, _cursor.pos.x, _cursor.pos.y);
2939 _newgrf_debug_sprite_picker.click_time = _realtime_tick;
2940 _newgrf_debug_sprite_picker.sprites.Clear();
2941 _newgrf_debug_sprite_picker.mode = SPM_REDRAW;
2942 MarkWholeScreenDirty();
2943 } else {
2944 MouseLoop(click, mousewheel);
2945 }
2946
2947 /* We have moved the mouse the required distance,
2948 * no need to move it at any later time. */
2949 _cursor.delta.x = 0;
2950 _cursor.delta.y = 0;
2951 }
2952
2956 static void CheckSoftLimit()
2957 {
2958 if (_settings_client.gui.window_soft_limit == 0) return;
2959
2960 for (;;) {
2961 uint deletable_count = 0;
2962 Window *w, *last_deletable = NULL;
2963 FOR_ALL_WINDOWS_FROM_FRONT(w) {
2964 if (w->window_class == WC_MAIN_WINDOW || IsVitalWindow(w) || (w->flags & WF_STICKY)) continue;
2965
2966 last_deletable = w;
2967 deletable_count++;
2968 }
2969
2970 /* We've not reached the soft limit yet. */
2971 if (deletable_count <= _settings_client.gui.window_soft_limit) break;
2972
2973 assert(last_deletable != NULL);
2974 delete last_deletable;
2975 }
2976 }
2977
2981 void InputLoop()
2982 {
2983 /* World generation is multithreaded and messes with companies.
2984 * But there is no company related window open anyway, so _current_company is not used. */
2985 assert(HasModalProgress() || IsLocalCompany());
2986
2987 CheckSoftLimit();
2988 HandleKeyScrolling();
2989
2990 /* Do the actual free of the deleted windows. */
2991 for (Window *v = _z_front_window; v != NULL; /* nothing */) {
2992 Window *w = v;
2993 v = v->z_back;
2994
2995 if (w->window_class != WC_INVALID) continue;
2996
2997 RemoveWindowFromZOrdering(w);
2998 free(w);
2999 }
3000
3001 if (_scroller_click_timeout != 0) _scroller_click_timeout--;
3002 DecreaseWindowCounters();
3003
3004 if (_input_events_this_tick != 0) {
3005 /* The input loop is called only once per GameLoop() - so we can clear the counter here */
3006 _input_events_this_tick = 0;
3007 /* there were some inputs this tick, don't scroll ??? */
3008 return;
3009 }
3010
3011 /* HandleMouseEvents was already called for this tick */
3012 HandleMouseEvents();
3013 HandleAutoscroll();
3014 }
3015
3019 void UpdateWindows()
3020 {
3021 Window *w;
3022
3023 static int highlight_timer = 1;
3024 if (--highlight_timer == 0) {
3025 highlight_timer = 15;
3026 _window_highlight_colour = !_window_highlight_colour;
3027 }
3028
3029 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3030 w->ProcessScheduledInvalidations();
3031 w->ProcessHighlightedInvalidations();
3032 }
3033
3034 static int we4_timer = 0;
3035 int t = we4_timer + 1;
3036
3037 if (t >= 100) {
3038 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3039 w->OnHundredthTick();
3040 }
3041 t = 0;
3042 }
3043 we4_timer = t;
3044
3045 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3046 if ((w->flags & WF_WHITE_BORDER) && --w->white_border_timer == 0) {
3047 CLRBITS(w->flags, WF_WHITE_BORDER);
3048 w->SetDirty();
3049 }
3050 }
3051
3052 DrawDirtyBlocks();
3053
3054 FOR_ALL_WINDOWS_FROM_BACK(w) {
3055 /* Update viewport only if window is not shaded. */
3056 if (w->viewport != NULL && !w->IsShaded()) UpdateViewportPosition(w);
3057 }
3058 NetworkDrawChatMessage();
3059 /* Redraw mouse cursor in case it was hidden */
3060 DrawMouseCursor();
3061 }
3062
3068 void SetWindowDirty(WindowClass cls, WindowNumber number)
3069 {
3070 const Window *w;
3071 FOR_ALL_WINDOWS_FROM_BACK(w) {
3072 if (w->window_class == cls && w->window_number == number) w->SetDirty();
3073 }
3074 }
3075
3082 void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
3083 {
3084 const Window *w;
3085 FOR_ALL_WINDOWS_FROM_BACK(w) {
3086 if (w->window_class == cls && w->window_number == number) {
3087 w->SetWidgetDirty(widget_index);
3088 }
3089 }
3090 }
3091
3096 void SetWindowClassesDirty(WindowClass cls)
3097 {
3098 Window *w;
3099 FOR_ALL_WINDOWS_FROM_BACK(w) {
3100 if (w->window_class == cls) w->SetDirty();
3101 }
3102 }
3103
3109 void Window::InvalidateData(int data, bool gui_scope)
3110 {
3111 this->SetDirty();
3112 if (!gui_scope) {
3113 /* Schedule GUI-scope invalidation for next redraw. */
3114 *this->scheduled_invalidation_data.Append() = data;
3115 }
3116 this->OnInvalidateData(data, gui_scope);
3117 }
3118
3122 void Window::ProcessScheduledInvalidations()
3123 {
3124 for (int *data = this->scheduled_invalidation_data.Begin(); this->window_class != WC_INVALID && data != this->scheduled_invalidation_data.End(); data++) {
3125 this->OnInvalidateData(*data, true);
3126 }
3127 this->scheduled_invalidation_data.Clear();
3128 }
3129
3133 void Window::ProcessHighlightedInvalidations()
3134 {
3135 if ((this->flags & WF_HIGHLIGHTED) == 0) return;
3136
3137 for (uint i = 0; i < this->nested_array_size; i++) {
3138 if (this->IsWidgetHighlighted(i)) this->SetWidgetDirty(i);
3139 }
3140 }
3141
3168 void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
3169 {
3170 Window *w;
3171 FOR_ALL_WINDOWS_FROM_BACK(w) {
3172 if (w->window_class == cls && w->window_number == number) {
3173 w->InvalidateData(data, gui_scope);
3174 }
3175 }
3176 }
3177
3186 void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
3187 {
3188 Window *w;
3189
3190 FOR_ALL_WINDOWS_FROM_BACK(w) {
3191 if (w->window_class == cls) {
3192 w->InvalidateData(data, gui_scope);
3193 }
3194 }
3195 }
3196
3200 void CallWindowTickEvent()
3201 {
3202 Window *w;
3203 FOR_ALL_WINDOWS_FROM_FRONT(w) {
3204 w->OnTick();
3205 }
3206 }
3207
3214 void DeleteNonVitalWindows()
3215 {
3216 Window *w;
3217
3218 restart_search:
3219 /* When we find the window to delete, we need to restart the search
3220 * as deleting this window could cascade in deleting (many) others
3221 * anywhere in the z-array */
3222 FOR_ALL_WINDOWS_FROM_BACK(w) {
3223 if (w->window_class != WC_MAIN_WINDOW &&
3224 w->window_class != WC_SELECT_GAME &&
3225 w->window_class != WC_MAIN_TOOLBAR &&
3226 w->window_class != WC_STATUS_BAR &&
3227 w->window_class != WC_TOOLTIPS &&
3228 (w->flags & WF_STICKY) == 0) { // do not delete windows which are 'pinned'
3229
3230 delete w;
3231 goto restart_search;
3232 }
3233 }
3234 }
3235
3243 void DeleteAllNonVitalWindows()
3244 {
3245 Window *w;
3246
3247 /* Delete every window except for stickied ones, then sticky ones as well */
3248 DeleteNonVitalWindows();
3249
3250 restart_search:
3251 /* When we find the window to delete, we need to restart the search
3252 * as deleting this window could cascade in deleting (many) others
3253 * anywhere in the z-array */
3254 FOR_ALL_WINDOWS_FROM_BACK(w) {
3255 if (w->flags & WF_STICKY) {
3256 delete w;
3257 goto restart_search;
3258 }
3259 }
3260 }
3261
3266 void DeleteConstructionWindows()
3267 {
3268 Window *w;
3269
3270 restart_search:
3271 /* When we find the window to delete, we need to restart the search
3272 * as deleting this window could cascade in deleting (many) others
3273 * anywhere in the z-array */
3274 FOR_ALL_WINDOWS_FROM_BACK(w) {
3275 if (w->window_desc->flags & WDF_CONSTRUCTION) {
3276 delete w;
3277 goto restart_search;
3278 }
3279 }
3280
3281 FOR_ALL_WINDOWS_FROM_BACK(w) w->SetDirty();
3282 }
3283
3285 void HideVitalWindows()
3286 {
3287 DeleteWindowById(WC_MAIN_TOOLBAR, 0);
3288 DeleteWindowById(WC_STATUS_BAR, 0);
3289 }
3290
3292 void ReInitAllWindows()
3293 {
3294 NWidgetLeaf::InvalidateDimensionCache(); // Reset cached sizes of several widgets.
3295 NWidgetScrollbar::InvalidateDimensionCache();
3296
3297 extern void InitDepotWindowBlockSizes();
3298 InitDepotWindowBlockSizes();
3299
3300 Window *w;
3301 FOR_ALL_WINDOWS_FROM_BACK(w) {
3302 w->ReInit();
3303 }
3304 #ifdef ENABLE_NETWORK
3305 void NetworkReInitChatBoxSize();
3306 NetworkReInitChatBoxSize();
3307 #endif
3308
3309 /* Make sure essential parts of all windows are visible */
3310 RelocateAllWindows(_cur_resolution.width, _cur_resolution.height);
3311 MarkWholeScreenDirty();
3312 }
3313
3321 static int PositionWindow(Window *w, WindowClass clss, int setting)
3322 {
3323 if (w == NULL || w->window_class != clss) {
3324 w = FindWindowById(clss, 0);
3325 }
3326 if (w == NULL) return 0;
3327
3328 int old_left = w->left;
3329 switch (setting) {
3330 case 1: w->left = (_screen.width - w->width) / 2; break;
3331 case 2: w->left = _screen.width - w->width; break;
3332 default: w->left = 0; break;
3333 }
3334 if (w->viewport != NULL) w->viewport->left += w->left - old_left;
3335 SetDirtyBlocks(0, w->top, _screen.width, w->top + w->height); // invalidate the whole row
3336 return w->left;
3337 }
3338
3344 int PositionMainToolbar(Window *w)
3345 {
3346 DEBUG(misc, 5, "Repositioning Main Toolbar...");
3347 return PositionWindow(w, WC_MAIN_TOOLBAR, _settings_client.gui.toolbar_pos);
3348 }
3349
3355 int PositionStatusbar(Window *w)
3356 {
3357 DEBUG(misc, 5, "Repositioning statusbar...");
3358 return PositionWindow(w, WC_STATUS_BAR, _settings_client.gui.statusbar_pos);
3359 }
3360
3366 int PositionNewsMessage(Window *w)
3367 {
3368 DEBUG(misc, 5, "Repositioning news message...");
3369 return PositionWindow(w, WC_NEWS_WINDOW, _settings_client.gui.statusbar_pos);
3370 }
3371
3377 int PositionNetworkChatWindow(Window *w)
3378 {
3379 DEBUG(misc, 5, "Repositioning network chat window...");
3380 return PositionWindow(w, WC_SEND_NETWORK_MSG, _settings_client.gui.statusbar_pos);
3381 }
3382
3383
3389 void ChangeVehicleViewports(VehicleID from_index, VehicleID to_index)
3390 {
3391 Window *w;
3392 FOR_ALL_WINDOWS_FROM_BACK(w) {
3393 if (w->viewport != NULL && w->viewport->follow_vehicle == from_index) {
3394 w->viewport->follow_vehicle = to_index;
3395 w->SetDirty();
3396 }
3397 }
3398 }
3399
3400
3406 void RelocateAllWindows(int neww, int newh)
3407 {
3408 Window *w;
3409
3410 FOR_ALL_WINDOWS_FROM_BACK(w) {
3411 int left, top;
3412 /* XXX - this probably needs something more sane. For example specifying
3413 * in a 'backup'-desc that the window should always be centered. */
3414 switch (w->window_class) {
3415 case WC_MAIN_WINDOW:
3416 case WC_BOOTSTRAP:
3417 ResizeWindow(w, neww, newh);
3418 continue;
3419
3420 case WC_MAIN_TOOLBAR:
3421 ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3422
3423 top = w->top;
3424 left = PositionMainToolbar(w); // changes toolbar orientation
3425 break;
3426
3427 case WC_NEWS_WINDOW:
3428 top = newh - w->height;
3429 left = PositionNewsMessage(w);
3430 break;
3431
3432 case WC_STATUS_BAR:
3433 ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3434
3435 top = newh - w->height;
3436 left = PositionStatusbar(w);
3437 break;
3438
3439 case WC_SEND_NETWORK_MSG:
3440 ResizeWindow(w, min(neww, _toolbar_width) - w->width, 0, false);
3441
3442 top = newh - w->height - FindWindowById(WC_STATUS_BAR, 0)->height;
3443 left = PositionNetworkChatWindow(w);
3444 break;
3445
3446 case WC_CONSOLE:
3447 IConsoleResize(w);
3448 continue;
3449
3450 default: {
3451 if (w->flags & WF_CENTERED) {
3452 top = (newh - w->height) >> 1;
3453 left = (neww - w->width) >> 1;
3454 break;
3455 }
3456
3457 left = w->left;
3458 if (left + (w->width >> 1) >= neww) left = neww - w->width;
3459 if (left < 0) left = 0;
3460
3461 top = w->top;
3462 if (top + (w->height >> 1) >= newh) top = newh - w->height;
3463 break;
3464 }
3465 }
3466
3467 EnsureVisibleCaption(w, left, top);
3468 }
3469 }
3470
3476 PickerWindowBase::~PickerWindowBase()
3477 {
3478 this->window_class = WC_INVALID; // stop the ancestor from freeing the already (to be) child
3479 ResetObjectToPlace();
3480 }