1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
8 /** @file statusbar_gui.cpp The GUI for the bottom status bar. */
9
10 #include "stdafx.h"
11 #include "date_func.h"
12 #include "gfx_func.h"
13 #include "news_func.h"
14 #include "company_func.h"
15 #include "string_func.h"
16 #include "strings_func.h"
17 #include "company_base.h"
18 #include "tilehighlight_func.h"
19 #include "news_gui.h"
20 #include "company_gui.h"
21 #include "window_gui.h"
22 #include "saveload/saveload.h"
23 #include "window_func.h"
24 #include "statusbar_gui.h"
25 #include "toolbar_gui.h"
26 #include "core/geometry_func.hpp"
27 #include "guitimer_func.h"
28 #include "zoom_func.h"
29
30 #include "widgets/statusbar_widget.h"
31
32 #include "table/strings.h"
33 #include "table/sprites.h"
34
35 #include "safeguards.h"
36
DrawScrollingStatusText(const NewsItem * ni,int scroll_pos,int left,int right,int top,int bottom)37 static bool DrawScrollingStatusText(const NewsItem *ni, int scroll_pos, int left, int right, int top, int bottom)
38 {
39 CopyInDParam(0, ni->params, lengthof(ni->params));
40 StringID str = ni->string_id;
41
42 char buf[512];
43 GetString(buf, str, lastof(buf));
44 const char *s = buf;
45
46 char buffer[256];
47 char *d = buffer;
48 const char *last = lastof(buffer);
49
50 for (;;) {
51 WChar c = Utf8Consume(&s);
52 if (c == 0) {
53 break;
54 } else if (c == '\n') {
55 if (d + 4 >= last) break;
56 d[0] = d[1] = d[2] = d[3] = ' ';
57 d += 4;
58 } else if (IsPrintable(c)) {
59 if (d + Utf8CharLen(c) >= last) break;
60 d += Utf8Encode(d, c);
61 }
62 }
63 *d = '\0';
64
65 DrawPixelInfo tmp_dpi;
66 if (!FillDrawPixelInfo(&tmp_dpi, left, top, right - left, bottom)) return true;
67
68 int width = GetStringBoundingBox(buffer).width;
69 int pos = (_current_text_dir == TD_RTL) ? (scroll_pos - width) : (right - scroll_pos - left);
70
71 DrawPixelInfo *old_dpi = _cur_dpi;
72 _cur_dpi = &tmp_dpi;
73 DrawString(pos, INT16_MAX, 0, buffer, TC_LIGHT_BLUE, SA_LEFT | SA_FORCE);
74 _cur_dpi = old_dpi;
75
76 return (_current_text_dir == TD_RTL) ? (pos < right - left) : (pos + width > 0);
77 }
78
79 struct StatusBarWindow : Window {
80 bool saving;
81 int ticker_scroll;
82 GUITimer ticker_timer;
83 GUITimer reminder_timeout;
84
85 static const int TICKER_STOP = 1640; ///< scrolling is finished when counter reaches this value
86 static const int REMINDER_START = 1350; ///< time in ms for reminder notification (red dot on the right) to stay
87 static const int REMINDER_STOP = 0; ///< reminder disappears when counter reaches this value
88 static const int COUNTER_STEP = 2; ///< this is subtracted from active counters every tick
89
StatusBarWindowStatusBarWindow90 StatusBarWindow(WindowDesc *desc) : Window(desc)
91 {
92 this->ticker_scroll = TICKER_STOP;
93 this->ticker_timer.SetInterval(15);
94 this->reminder_timeout.SetInterval(REMINDER_STOP);
95
96 this->InitNested();
97 CLRBITS(this->flags, WF_WHITE_BORDER);
98 PositionStatusbar(this);
99 }
100
OnInitialPositionStatusBarWindow101 Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
102 {
103 Point pt = { 0, _screen.height - sm_height };
104 return pt;
105 }
106
FindWindowPlacementAndResizeStatusBarWindow107 void FindWindowPlacementAndResize(int def_width, int def_height) override
108 {
109 Window::FindWindowPlacementAndResize(_toolbar_width, def_height);
110 }
111
UpdateWidgetSizeStatusBarWindow112 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
113 {
114 Dimension d;
115 switch (widget) {
116 case WID_S_LEFT:
117 SetDParamMaxValue(0, MAX_YEAR * DAYS_IN_YEAR);
118 d = GetStringBoundingBox(STR_WHITE_DATE_LONG);
119 break;
120
121 case WID_S_RIGHT: {
122 int64 max_money = UINT32_MAX;
123 for (const Company *c : Company::Iterate()) max_money = std::max<int64>(c->money, max_money);
124 SetDParam(0, 100LL * max_money);
125 d = GetStringBoundingBox(STR_COMPANY_MONEY);
126 break;
127 }
128
129 default:
130 return;
131 }
132
133 d.width += padding.width;
134 d.height += padding.height;
135 *size = maxdim(d, *size);
136 }
137
DrawWidgetStatusBarWindow138 void DrawWidget(const Rect &r, int widget) const override
139 {
140 int text_offset = std::max(0, ((int)(r.bottom - r.top + 1) - FONT_HEIGHT_NORMAL) / 2); // Offset for rendering the text vertically centered
141 int text_top = r.top + text_offset;
142 switch (widget) {
143 case WID_S_LEFT:
144 /* Draw the date */
145 SetDParam(0, _date);
146 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_WHITE_DATE_LONG, TC_FROMSTRING, SA_HOR_CENTER);
147 break;
148
149 case WID_S_RIGHT: {
150 if (_local_company == COMPANY_SPECTATOR) {
151 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_STATUSBAR_SPECTATOR, TC_FROMSTRING, SA_HOR_CENTER);
152 } else {
153 /* Draw company money, if any */
154 const Company *c = Company::GetIfValid(_local_company);
155 if (c != nullptr) {
156 SetDParam(0, c->money);
157 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_COMPANY_MONEY, TC_FROMSTRING, SA_HOR_CENTER);
158 }
159 }
160 break;
161 }
162
163 case WID_S_MIDDLE:
164 /* Draw status bar */
165 if (this->saving) { // true when saving is active
166 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_STATUSBAR_SAVING_GAME, TC_FROMSTRING, SA_HOR_CENTER | SA_VERT_CENTER);
167 } else if (_do_autosave) {
168 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_STATUSBAR_AUTOSAVE, TC_FROMSTRING, SA_HOR_CENTER);
169 } else if (_pause_mode != PM_UNPAUSED) {
170 StringID msg = (_pause_mode & PM_PAUSED_LINK_GRAPH) ? STR_STATUSBAR_PAUSED_LINK_GRAPH : STR_STATUSBAR_PAUSED;
171 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, msg, TC_FROMSTRING, SA_HOR_CENTER);
172 } else if (this->ticker_scroll < TICKER_STOP && _statusbar_news_item != nullptr && _statusbar_news_item->string_id != 0) {
173 /* Draw the scrolling news text */
174 if (!DrawScrollingStatusText(_statusbar_news_item, ScaleGUITrad(this->ticker_scroll), r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, r.top + WD_FRAMERECT_TOP, r.bottom)) {
175 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED);
176 if (Company::IsValidID(_local_company)) {
177 /* This is the default text */
178 SetDParam(0, _local_company);
179 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_STATUSBAR_COMPANY_NAME, TC_FROMSTRING, SA_HOR_CENTER);
180 }
181 }
182 } else {
183 if (Company::IsValidID(_local_company)) {
184 /* This is the default text */
185 SetDParam(0, _local_company);
186 DrawString(r.left + WD_FRAMERECT_LEFT, r.right - WD_FRAMERECT_RIGHT, text_top, STR_STATUSBAR_COMPANY_NAME, TC_FROMSTRING, SA_HOR_CENTER);
187 }
188 }
189
190 if (!this->reminder_timeout.HasElapsed()) {
191 Dimension icon_size = GetSpriteSize(SPR_UNREAD_NEWS);
192 DrawSprite(SPR_UNREAD_NEWS, PAL_NONE, r.right - WD_FRAMERECT_RIGHT - icon_size.width, r.top + std::max(0, ((int)(r.bottom - r.top + 1) - (int)icon_size.height) / 2));
193 }
194 break;
195 }
196 }
197
198 /**
199 * Some data on this window has become invalid.
200 * @param data Information about the changed data.
201 * @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.
202 */
OnInvalidateDataStatusBarWindow203 void OnInvalidateData(int data = 0, bool gui_scope = true) override
204 {
205 if (!gui_scope) return;
206 switch (data) {
207 default: NOT_REACHED();
208 case SBI_SAVELOAD_START: this->saving = true; break;
209 case SBI_SAVELOAD_FINISH: this->saving = false; break;
210 case SBI_SHOW_TICKER: this->ticker_scroll = 0; break;
211 case SBI_SHOW_REMINDER: this->reminder_timeout.SetInterval(REMINDER_START); break;
212 case SBI_NEWS_DELETED:
213 this->ticker_scroll = TICKER_STOP; // reset ticker ...
214 this->reminder_timeout.SetInterval(REMINDER_STOP); // ... and reminder
215 break;
216 }
217 }
218
OnClickStatusBarWindow219 void OnClick(Point pt, int widget, int click_count) override
220 {
221 switch (widget) {
222 case WID_S_MIDDLE: ShowLastNewsMessage(); break;
223 case WID_S_RIGHT: if (_local_company != COMPANY_SPECTATOR) ShowCompanyFinances(_local_company); break;
224 default: ResetObjectToPlace();
225 }
226 }
227
OnRealtimeTickStatusBarWindow228 void OnRealtimeTick(uint delta_ms) override
229 {
230 if (_pause_mode != PM_UNPAUSED) return;
231
232 if (this->ticker_scroll < TICKER_STOP) { // Scrolling text
233 uint count = this->ticker_timer.CountElapsed(delta_ms);
234 if (count > 0) {
235 this->ticker_scroll += count;
236 this->SetWidgetDirty(WID_S_MIDDLE);
237 }
238 }
239
240 // Red blot to show there are new unread newsmessages
241 if (this->reminder_timeout.Elapsed(delta_ms)) {
242 this->SetWidgetDirty(WID_S_MIDDLE);
243 }
244 }
245 };
246
247 static const NWidgetPart _nested_main_status_widgets[] = {
248 NWidget(NWID_HORIZONTAL),
249 NWidget(WWT_PANEL, COLOUR_GREY, WID_S_LEFT), SetMinimalSize(140, 12), EndContainer(),
250 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_S_MIDDLE), SetMinimalSize(40, 12), SetDataTip(0x0, STR_STATUSBAR_TOOLTIP_SHOW_LAST_NEWS), SetResize(1, 0),
251 NWidget(WWT_PUSHBTN, COLOUR_GREY, WID_S_RIGHT), SetMinimalSize(140, 12),
252 EndContainer(),
253 };
254
255 static WindowDesc _main_status_desc(
256 WDP_MANUAL, nullptr, 0, 0,
257 WC_STATUS_BAR, WC_NONE,
258 WDF_NO_FOCUS,
259 _nested_main_status_widgets, lengthof(_nested_main_status_widgets)
260 );
261
262 /**
263 * Checks whether the news ticker is currently being used.
264 */
IsNewsTickerShown()265 bool IsNewsTickerShown()
266 {
267 const StatusBarWindow *w = dynamic_cast<StatusBarWindow*>(FindWindowById(WC_STATUS_BAR, 0));
268 return w != nullptr && w->ticker_scroll < StatusBarWindow::TICKER_STOP;
269 }
270
271 /**
272 * Show our status bar.
273 */
ShowStatusBar()274 void ShowStatusBar()
275 {
276 new StatusBarWindow(&_main_status_desc);
277 }
278