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 news_gui.cpp GUI functions related to news messages. */
9
10 #include "stdafx.h"
11 #include "gui.h"
12 #include "viewport_func.h"
13 #include "strings_func.h"
14 #include "window_func.h"
15 #include "date_func.h"
16 #include "vehicle_base.h"
17 #include "vehicle_func.h"
18 #include "vehicle_gui.h"
19 #include "roadveh.h"
20 #include "station_base.h"
21 #include "industry.h"
22 #include "town.h"
23 #include "sound_func.h"
24 #include "string_func.h"
25 #include "widgets/dropdown_func.h"
26 #include "statusbar_gui.h"
27 #include "company_manager_face.h"
28 #include "company_func.h"
29 #include "engine_base.h"
30 #include "engine_gui.h"
31 #include "core/geometry_func.hpp"
32 #include "command_func.h"
33 #include "company_base.h"
34 #include "settings_internal.h"
35 #include "guitimer_func.h"
36 #include "group_gui.h"
37 #include "zoom_func.h"
38
39 #include "widgets/news_widget.h"
40
41 #include "table/strings.h"
42
43 #include "safeguards.h"
44
45 const NewsItem *_statusbar_news_item = nullptr;
46
47 static uint MIN_NEWS_AMOUNT = 30; ///< preferred minimum amount of news messages
48 static uint MAX_NEWS_AMOUNT = 1 << 10; ///< Do not exceed this number of news messages
49 static uint _total_news = 0; ///< current number of news items
50 static NewsItem *_oldest_news = nullptr; ///< head of news items queue
51 NewsItem *_latest_news = nullptr; ///< tail of news items queue
52
53 /**
54 * Forced news item.
55 * Users can force an item by accessing the history or "last message".
56 * If the message being shown was forced by the user, a pointer is stored
57 * in _forced_news. Otherwise, \a _forced_news variable is nullptr.
58 */
59 static const NewsItem *_forced_news = nullptr;
60
61 /** Current news item (last item shown regularly). */
62 static const NewsItem *_current_news = nullptr;
63
64
65 /**
66 * Get the position a news-reference is referencing.
67 * @param reftype The type of reference.
68 * @param ref The reference.
69 * @return A tile for the referenced object, or INVALID_TILE if none.
70 */
GetReferenceTile(NewsReferenceType reftype,uint32 ref)71 static TileIndex GetReferenceTile(NewsReferenceType reftype, uint32 ref)
72 {
73 switch (reftype) {
74 case NR_TILE: return (TileIndex)ref;
75 case NR_STATION: return Station::Get((StationID)ref)->xy;
76 case NR_INDUSTRY: return Industry::Get((IndustryID)ref)->location.tile + TileDiffXY(1, 1);
77 case NR_TOWN: return Town::Get((TownID)ref)->xy;
78 default: return INVALID_TILE;
79 }
80 }
81
82 /* Normal news items. */
83 static const NWidgetPart _nested_normal_news_widgets[] = {
84 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
85 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
86 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
87 NWidget(NWID_SPACER), SetFill(1, 0),
88 NWidget(NWID_VERTICAL),
89 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_DATE), SetDataTip(STR_DATE_LONG_SMALL, STR_NULL),
90 NWidget(NWID_SPACER), SetFill(0, 1),
91 EndContainer(),
92 EndContainer(),
93 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(428, 154), SetPadding(0, 5, 1, 5),
94 EndContainer(),
95 };
96
97 static WindowDesc _normal_news_desc(
98 WDP_MANUAL, nullptr, 0, 0,
99 WC_NEWS_WINDOW, WC_NONE,
100 0,
101 _nested_normal_news_widgets, lengthof(_nested_normal_news_widgets)
102 );
103
104 /* New vehicles news items. */
105 static const NWidgetPart _nested_vehicle_news_widgets[] = {
106 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
107 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
108 NWidget(NWID_VERTICAL),
109 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
110 NWidget(NWID_SPACER), SetFill(0, 1),
111 EndContainer(),
112 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_VEH_TITLE), SetFill(1, 1), SetMinimalSize(419, 55), SetDataTip(STR_EMPTY, STR_NULL),
113 EndContainer(),
114 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_VEH_BKGND), SetPadding(0, 25, 1, 25),
115 NWidget(NWID_VERTICAL),
116 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_NAME), SetMinimalSize(369, 33), SetFill(1, 0),
117 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_SPR), SetMinimalSize(369, 32), SetFill(1, 0),
118 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_INFO), SetMinimalSize(369, 46), SetFill(1, 0),
119 EndContainer(),
120 EndContainer(),
121 EndContainer(),
122 };
123
124 static WindowDesc _vehicle_news_desc(
125 WDP_MANUAL, nullptr, 0, 0,
126 WC_NEWS_WINDOW, WC_NONE,
127 0,
128 _nested_vehicle_news_widgets, lengthof(_nested_vehicle_news_widgets)
129 );
130
131 /* Company news items. */
132 static const NWidgetPart _nested_company_news_widgets[] = {
133 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
134 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
135 NWidget(NWID_VERTICAL),
136 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
137 NWidget(NWID_SPACER), SetFill(0, 1),
138 EndContainer(),
139 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_TITLE), SetFill(1, 1), SetMinimalSize(410, 20), SetDataTip(STR_EMPTY, STR_NULL),
140 EndContainer(),
141 NWidget(NWID_HORIZONTAL), SetPadding(0, 1, 1, 1),
142 NWidget(NWID_VERTICAL),
143 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MGR_FACE), SetMinimalSize(93, 119), SetPadding(2, 6, 2, 1),
144 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MGR_NAME), SetMinimalSize(93, 24), SetPadding(0, 0, 0, 1),
145 NWidget(NWID_SPACER), SetFill(0, 1),
146 EndContainer(),
147 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_COMPANY_MSG), SetFill(1, 1), SetMinimalSize(328, 150),
148 EndContainer(),
149 EndContainer(),
150 };
151
152 static WindowDesc _company_news_desc(
153 WDP_MANUAL, nullptr, 0, 0,
154 WC_NEWS_WINDOW, WC_NONE,
155 0,
156 _nested_company_news_widgets, lengthof(_nested_company_news_widgets)
157 );
158
159 /* Thin news items. */
160 static const NWidgetPart _nested_thin_news_widgets[] = {
161 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
162 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
163 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
164 NWidget(NWID_SPACER), SetFill(1, 0),
165 NWidget(NWID_VERTICAL),
166 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_DATE), SetDataTip(STR_DATE_LONG_SMALL, STR_NULL),
167 NWidget(NWID_SPACER), SetFill(0, 1),
168 EndContainer(),
169 EndContainer(),
170 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(428, 48), SetFill(1, 0), SetPadding(0, 5, 0, 5),
171 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(426, 70), SetPadding(1, 2, 2, 2),
172 EndContainer(),
173 };
174
175 static WindowDesc _thin_news_desc(
176 WDP_MANUAL, nullptr, 0, 0,
177 WC_NEWS_WINDOW, WC_NONE,
178 0,
179 _nested_thin_news_widgets, lengthof(_nested_thin_news_widgets)
180 );
181
182 /* Small news items. */
183 static const NWidgetPart _nested_small_news_widgets[] = {
184 /* Caption + close box. The caption is no WWT_CAPTION as the window shall not be moveable and so on. */
185 NWidget(NWID_HORIZONTAL),
186 NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE, WID_N_CLOSEBOX),
187 NWidget(WWT_EMPTY, COLOUR_LIGHT_BLUE, WID_N_CAPTION), SetFill(1, 0),
188 NWidget(WWT_TEXTBTN, COLOUR_LIGHT_BLUE, WID_N_SHOW_GROUP), SetMinimalSize(14, 11), SetResize(1, 0),
189 SetDataTip(STR_NULL /* filled in later */, STR_NEWS_SHOW_VEHICLE_GROUP_TOOLTIP),
190 EndContainer(),
191
192 /* Main part */
193 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_N_HEADLINE),
194 NWidget(WWT_INSET, COLOUR_LIGHT_BLUE, WID_N_INSET), SetPadding(2, 2, 2, 2),
195 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(274, 47), SetFill(1, 0),
196 EndContainer(),
197 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(275, 20), SetFill(1, 0), SetPadding(0, 5, 0, 5),
198 EndContainer(),
199 };
200
201 static WindowDesc _small_news_desc(
202 WDP_MANUAL, nullptr, 0, 0,
203 WC_NEWS_WINDOW, WC_NONE,
204 0,
205 _nested_small_news_widgets, lengthof(_nested_small_news_widgets)
206 );
207
208 /**
209 * Window layouts for news items.
210 */
211 static WindowDesc* _news_window_layout[] = {
212 &_thin_news_desc, ///< NF_THIN
213 &_small_news_desc, ///< NF_SMALL
214 &_normal_news_desc, ///< NF_NORMAL
215 &_vehicle_news_desc, ///< NF_VEHICLE
216 &_company_news_desc, ///< NF_COMPANY
217 };
218
GetNewsWindowLayout(NewsFlag flags)219 WindowDesc* GetNewsWindowLayout(NewsFlag flags)
220 {
221 uint layout = GB(flags, NFB_WINDOW_LAYOUT, NFB_WINDOW_LAYOUT_COUNT);
222 assert(layout < lengthof(_news_window_layout));
223 return _news_window_layout[layout];
224 }
225
226 /**
227 * Per-NewsType data
228 */
229 static NewsTypeData _news_type_data[] = {
230 /* name, age, sound, */
231 NewsTypeData("news_display.arrival_player", 60, SND_1D_APPLAUSE ), ///< NT_ARRIVAL_COMPANY
232 NewsTypeData("news_display.arrival_other", 60, SND_1D_APPLAUSE ), ///< NT_ARRIVAL_OTHER
233 NewsTypeData("news_display.accident", 90, SND_BEGIN ), ///< NT_ACCIDENT
234 NewsTypeData("news_display.company_info", 60, SND_BEGIN ), ///< NT_COMPANY_INFO
235 NewsTypeData("news_display.open", 90, SND_BEGIN ), ///< NT_INDUSTRY_OPEN
236 NewsTypeData("news_display.close", 90, SND_BEGIN ), ///< NT_INDUSTRY_CLOSE
237 NewsTypeData("news_display.economy", 30, SND_BEGIN ), ///< NT_ECONOMY
238 NewsTypeData("news_display.production_player", 30, SND_BEGIN ), ///< NT_INDUSTRY_COMPANY
239 NewsTypeData("news_display.production_other", 30, SND_BEGIN ), ///< NT_INDUSTRY_OTHER
240 NewsTypeData("news_display.production_nobody", 30, SND_BEGIN ), ///< NT_INDUSTRY_NOBODY
241 NewsTypeData("news_display.advice", 150, SND_BEGIN ), ///< NT_ADVICE
242 NewsTypeData("news_display.new_vehicles", 30, SND_1E_NEW_ENGINE), ///< NT_NEW_VEHICLES
243 NewsTypeData("news_display.acceptance", 90, SND_BEGIN ), ///< NT_ACCEPTANCE
244 NewsTypeData("news_display.subsidies", 180, SND_BEGIN ), ///< NT_SUBSIDIES
245 NewsTypeData("news_display.general", 60, SND_BEGIN ), ///< NT_GENERAL
246 };
247
248 static_assert(lengthof(_news_type_data) == NT_END);
249
250 /**
251 * Return the news display option.
252 * @return display options
253 */
GetDisplay() const254 NewsDisplay NewsTypeData::GetDisplay() const
255 {
256 const SettingDesc *sd = GetSettingFromName(this->name);
257 assert(sd != nullptr && sd->IsIntSetting());
258 return (NewsDisplay)sd->AsIntSetting()->Read(nullptr);
259 }
260
261 /** Window class displaying a news item. */
262 struct NewsWindow : Window {
263 uint16 chat_height; ///< Height of the chat window.
264 uint16 status_height; ///< Height of the status bar window
265 const NewsItem *ni; ///< News item to display.
266 static int duration; ///< Remaining time for showing the current news message (may only be access while a news item is displayed).
267
268 GUITimer timer;
269
NewsWindowNewsWindow270 NewsWindow(WindowDesc *desc, const NewsItem *ni) : Window(desc), ni(ni)
271 {
272 NewsWindow::duration = 16650;
273 const Window *w = FindWindowByClass(WC_SEND_NETWORK_MSG);
274 this->chat_height = (w != nullptr) ? w->height : 0;
275 this->status_height = FindWindowById(WC_STATUS_BAR, 0)->height;
276
277 this->flags |= WF_DISABLE_VP_SCROLL;
278
279 this->timer.SetInterval(15);
280
281 this->CreateNestedTree();
282
283 /* For company news with a face we have a separate headline in param[0] */
284 if (desc == &_company_news_desc) this->GetWidget<NWidgetCore>(WID_N_TITLE)->widget_data = this->ni->params[0];
285
286 NWidgetCore *nwid = this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP);
287 if (ni->reftype1 == NR_VEHICLE && nwid != nullptr) {
288 const Vehicle *v = Vehicle::Get(ni->ref1);
289 switch (v->type) {
290 case VEH_TRAIN:
291 nwid->widget_data = STR_TRAIN;
292 break;
293 case VEH_ROAD:
294 nwid->widget_data = RoadVehicle::From(v)->IsBus() ? STR_BUS : STR_LORRY;
295 break;
296 case VEH_SHIP:
297 nwid->widget_data = STR_SHIP;
298 break;
299 case VEH_AIRCRAFT:
300 nwid->widget_data = STR_PLANE;
301 break;
302 default:
303 break; // Do nothing
304 }
305 }
306
307 this->FinishInitNested(0);
308
309 /* Initialize viewport if it exists. */
310 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
311 if (nvp != nullptr) {
312 nvp->InitializeViewport(this, ni->reftype1 == NR_VEHICLE ? 0x80000000 | ni->ref1 : GetReferenceTile(ni->reftype1, ni->ref1), ZOOM_LVL_NEWS);
313 if (this->ni->flags & NF_NO_TRANSPARENT) nvp->disp_flags |= ND_NO_TRANSPARENCY;
314 if ((this->ni->flags & NF_INCOLOUR) == 0) {
315 nvp->disp_flags |= ND_SHADE_GREY;
316 } else if (this->ni->flags & NF_SHADE) {
317 nvp->disp_flags |= ND_SHADE_DIMMED;
318 }
319 }
320
321 PositionNewsMessage(this);
322 }
323
DrawNewsBorderNewsWindow324 void DrawNewsBorder(const Rect &r) const
325 {
326 GfxFillRect(r.left, r.top, r.right, r.bottom, PC_WHITE);
327
328 GfxFillRect(r.left, r.top, r.left, r.bottom, PC_BLACK);
329 GfxFillRect(r.right, r.top, r.right, r.bottom, PC_BLACK);
330 GfxFillRect(r.left, r.top, r.right, r.top, PC_BLACK);
331 GfxFillRect(r.left, r.bottom, r.right, r.bottom, PC_BLACK);
332 }
333
OnInitialPositionNewsWindow334 Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
335 {
336 Point pt = { 0, _screen.height };
337 return pt;
338 }
339
UpdateWidgetSizeNewsWindow340 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
341 {
342 StringID str = STR_NULL;
343 switch (widget) {
344 case WID_N_CAPTION: {
345 /* Caption is not a real caption (so that the window cannot be moved)
346 * thus it doesn't get the default sizing of a caption. */
347 Dimension d2 = GetStringBoundingBox(STR_NEWS_MESSAGE_CAPTION);
348 d2.height += WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM;
349 *size = maxdim(*size, d2);
350 return;
351 }
352
353 case WID_N_MGR_FACE:
354 *size = maxdim(*size, GetSpriteSize(SPR_GRADIENT));
355 break;
356
357 case WID_N_MGR_NAME:
358 SetDParamStr(0, static_cast<const CompanyNewsInformation *>(this->ni->data.get())->president_name);
359 str = STR_JUST_RAW_STRING;
360 break;
361
362 case WID_N_MESSAGE:
363 CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
364 str = this->ni->string_id;
365 break;
366
367 case WID_N_COMPANY_MSG:
368 str = this->GetCompanyMessageString();
369 break;
370
371 case WID_N_VEH_NAME:
372 case WID_N_VEH_TITLE:
373 str = this->GetNewVehicleMessageString(widget);
374 break;
375
376 case WID_N_VEH_INFO: {
377 assert(this->ni->reftype1 == NR_ENGINE);
378 EngineID engine = this->ni->ref1;
379 str = GetEngineInfoString(engine);
380 break;
381 }
382
383 case WID_N_SHOW_GROUP:
384 if (this->ni->reftype1 == NR_VEHICLE) {
385 Dimension d2 = GetStringBoundingBox(this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP)->widget_data);
386 d2.height += WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM;
387 d2.width += WD_CAPTIONTEXT_LEFT + WD_CAPTIONTEXT_RIGHT;
388 *size = d2;
389 } else {
390 /* Hide 'Show group window' button if this news is not about a vehicle. */
391 size->width = 0;
392 size->height = 0;
393 resize->width = 0;
394 resize->height = 0;
395 fill->width = 0;
396 fill->height = 0;
397 }
398 return;
399
400 default:
401 return; // Do nothing
402 }
403
404 /* Update minimal size with length of the multi-line string. */
405 Dimension d = *size;
406 d.width = (d.width >= padding.width) ? d.width - padding.width : 0;
407 d.height = (d.height >= padding.height) ? d.height - padding.height : 0;
408 d = GetStringMultiLineBoundingBox(str, d);
409 d.width += padding.width;
410 d.height += padding.height;
411 *size = maxdim(*size, d);
412 }
413
SetStringParametersNewsWindow414 void SetStringParameters(int widget) const override
415 {
416 if (widget == WID_N_DATE) SetDParam(0, this->ni->date);
417 }
418
DrawWidgetNewsWindow419 void DrawWidget(const Rect &r, int widget) const override
420 {
421 switch (widget) {
422 case WID_N_CAPTION:
423 DrawCaption(r, COLOUR_LIGHT_BLUE, this->owner, TC_FROMSTRING, STR_NEWS_MESSAGE_CAPTION, SA_CENTER);
424 break;
425
426 case WID_N_PANEL:
427 this->DrawNewsBorder(r);
428 break;
429
430 case WID_N_MESSAGE:
431 CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
432 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->ni->string_id, TC_FROMSTRING, SA_CENTER);
433 break;
434
435 case WID_N_MGR_FACE: {
436 const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
437 DrawCompanyManagerFace(cni->face, cni->colour, r.left, r.top);
438 GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
439 break;
440 }
441 case WID_N_MGR_NAME: {
442 const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
443 SetDParamStr(0, cni->president_name);
444 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_JUST_RAW_STRING, TC_FROMSTRING, SA_CENTER);
445 break;
446 }
447 case WID_N_COMPANY_MSG:
448 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetCompanyMessageString(), TC_FROMSTRING, SA_CENTER);
449 break;
450
451 case WID_N_VEH_BKGND:
452 GfxFillRect(r.left, r.top, r.right, r.bottom, PC_GREY);
453 break;
454
455 case WID_N_VEH_NAME:
456 case WID_N_VEH_TITLE:
457 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetNewVehicleMessageString(widget), TC_FROMSTRING, SA_CENTER);
458 break;
459
460 case WID_N_VEH_SPR: {
461 assert(this->ni->reftype1 == NR_ENGINE);
462 EngineID engine = this->ni->ref1;
463 DrawVehicleEngine(r.left, r.right, (r.left + r.right) / 2, (r.top + r.bottom) / 2, engine, GetEnginePalette(engine, _local_company), EIT_PREVIEW);
464 GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
465 break;
466 }
467 case WID_N_VEH_INFO: {
468 assert(this->ni->reftype1 == NR_ENGINE);
469 EngineID engine = this->ni->ref1;
470 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, GetEngineInfoString(engine), TC_FROMSTRING, SA_CENTER);
471 break;
472 }
473 }
474 }
475
OnClickNewsWindow476 void OnClick(Point pt, int widget, int click_count) override
477 {
478 switch (widget) {
479 case WID_N_CLOSEBOX:
480 NewsWindow::duration = 0;
481 this->Close();
482 _forced_news = nullptr;
483 break;
484
485 case WID_N_CAPTION:
486 if (this->ni->reftype1 == NR_VEHICLE) {
487 const Vehicle *v = Vehicle::Get(this->ni->ref1);
488 ShowVehicleViewWindow(v);
489 }
490 break;
491
492 case WID_N_VIEWPORT:
493 break; // Ignore clicks
494
495 case WID_N_SHOW_GROUP:
496 if (this->ni->reftype1 == NR_VEHICLE) {
497 const Vehicle *v = Vehicle::Get(this->ni->ref1);
498 ShowCompanyGroupForVehicle(v);
499 }
500 break;
501 default:
502 if (this->ni->reftype1 == NR_VEHICLE) {
503 const Vehicle *v = Vehicle::Get(this->ni->ref1);
504 ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
505 } else {
506 TileIndex tile1 = GetReferenceTile(this->ni->reftype1, this->ni->ref1);
507 TileIndex tile2 = GetReferenceTile(this->ni->reftype2, this->ni->ref2);
508 if (_ctrl_pressed) {
509 if (tile1 != INVALID_TILE) ShowExtraViewportWindow(tile1);
510 if (tile2 != INVALID_TILE) ShowExtraViewportWindow(tile2);
511 } else {
512 if ((tile1 == INVALID_TILE || !ScrollMainWindowToTile(tile1)) && tile2 != INVALID_TILE) {
513 ScrollMainWindowToTile(tile2);
514 }
515 }
516 }
517 break;
518 }
519 }
520
521 /**
522 * Some data on this window has become invalid.
523 * @param data Information about the changed data.
524 * @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.
525 */
OnInvalidateDataNewsWindow526 void OnInvalidateData(int data = 0, bool gui_scope = true) override
527 {
528 if (!gui_scope) return;
529 /* The chatbar has notified us that is was either created or closed */
530 int newtop = this->top + this->chat_height - data;
531 this->chat_height = data;
532 this->SetWindowTop(newtop);
533 }
534
OnRealtimeTickNewsWindow535 void OnRealtimeTick(uint delta_ms) override
536 {
537 int count = this->timer.CountElapsed(delta_ms);
538 if (count > 0) {
539 /* Scroll up newsmessages from the bottom */
540 int newtop = std::max(this->top - 2 * count, _screen.height - this->height - this->status_height - this->chat_height);
541 this->SetWindowTop(newtop);
542 }
543
544 /* Decrement the news timer. We don't need to action an elapsed event here,
545 * so no need to use TimerElapsed(). */
546 if (NewsWindow::duration > 0) NewsWindow::duration -= delta_ms;
547 }
548
549 private:
550 /**
551 * Moves the window to a new #top coordinate. Makes screen dirty where needed.
552 * @param newtop new top coordinate
553 */
SetWindowTopNewsWindow554 void SetWindowTop(int newtop)
555 {
556 if (this->top == newtop) return;
557
558 int mintop = std::min(newtop, this->top);
559 int maxtop = std::max(newtop, this->top);
560 if (this->viewport != nullptr) this->viewport->top += newtop - this->top;
561 this->top = newtop;
562
563 AddDirtyBlock(this->left, mintop, this->left + this->width, maxtop + this->height);
564 }
565
GetCompanyMessageStringNewsWindow566 StringID GetCompanyMessageString() const
567 {
568 /* Company news with a face have a separate headline, so the normal message is shifted by two params */
569 CopyInDParam(0, this->ni->params + 2, lengthof(this->ni->params) - 2);
570 return this->ni->params[1];
571 }
572
GetNewVehicleMessageStringNewsWindow573 StringID GetNewVehicleMessageString(int widget) const
574 {
575 assert(this->ni->reftype1 == NR_ENGINE);
576 EngineID engine = this->ni->ref1;
577
578 switch (widget) {
579 case WID_N_VEH_TITLE:
580 SetDParam(0, GetEngineCategoryName(engine));
581 return STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE;
582
583 case WID_N_VEH_NAME:
584 SetDParam(0, engine);
585 return STR_NEWS_NEW_VEHICLE_TYPE;
586
587 default:
588 NOT_REACHED();
589 }
590 }
591 };
592
593 /* static */ int NewsWindow::duration = 0; // Instance creation.
594
595 /** Open up an own newspaper window for the news item */
ShowNewspaper(const NewsItem * ni)596 static void ShowNewspaper(const NewsItem *ni)
597 {
598 SoundFx sound = _news_type_data[ni->type].sound;
599 if (sound != 0 && _settings_client.sound.news_full) SndPlayFx(sound);
600
601 new NewsWindow(GetNewsWindowLayout(ni->flags), ni);
602 }
603
604 /** Show news item in the ticker */
ShowTicker(const NewsItem * ni)605 static void ShowTicker(const NewsItem *ni)
606 {
607 if (_settings_client.sound.news_ticker) SndPlayFx(SND_16_NEWS_TICKER);
608
609 _statusbar_news_item = ni;
610 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);
611 }
612
613 /** Initialize the news-items data structures */
InitNewsItemStructs()614 void InitNewsItemStructs()
615 {
616 for (NewsItem *ni = _oldest_news; ni != nullptr; ) {
617 NewsItem *next = ni->next;
618 delete ni;
619 ni = next;
620 }
621
622 _total_news = 0;
623 _oldest_news = nullptr;
624 _latest_news = nullptr;
625 _forced_news = nullptr;
626 _current_news = nullptr;
627 _statusbar_news_item = nullptr;
628 NewsWindow::duration = 0;
629 }
630
631 /**
632 * Are we ready to show another ticker item?
633 * Only if nothing is in the newsticker is displayed
634 */
ReadyForNextTickerItem()635 static bool ReadyForNextTickerItem()
636 {
637 const NewsItem *ni = _statusbar_news_item;
638 if (ni == nullptr) return true;
639
640 /* Ticker message
641 * Check if the status bar message is still being displayed? */
642 return !IsNewsTickerShown();
643 }
644
645 /**
646 * Are we ready to show another news item?
647 * Only if no newspaper is displayed
648 */
ReadyForNextNewsItem()649 static bool ReadyForNextNewsItem()
650 {
651 const NewsItem *ni = _forced_news == nullptr ? _current_news : _forced_news;
652 if (ni == nullptr) return true;
653
654 /* neither newsticker nor newspaper are running */
655 return (NewsWindow::duration <= 0 || FindWindowById(WC_NEWS_WINDOW, 0) == nullptr);
656 }
657
658 /** Move to the next ticker item */
MoveToNextTickerItem()659 static void MoveToNextTickerItem()
660 {
661 /* There is no status bar, so no reason to show news;
662 * especially important with the end game screen when
663 * there is no status bar but possible news. */
664 if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
665
666 /* if we're not at the last item, then move on */
667 while (_statusbar_news_item != _latest_news) {
668 _statusbar_news_item = (_statusbar_news_item == nullptr) ? _oldest_news : _statusbar_news_item->next;
669 const NewsItem *ni = _statusbar_news_item;
670 const NewsType type = ni->type;
671
672 /* check the date, don't show too old items */
673 if (_date - _news_type_data[type].age > ni->date) continue;
674
675 switch (_news_type_data[type].GetDisplay()) {
676 default: NOT_REACHED();
677 case ND_OFF: // Off - show nothing only a small reminder in the status bar
678 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_REMINDER);
679 break;
680
681 case ND_SUMMARY: // Summary - show ticker
682 ShowTicker(ni);
683 break;
684
685 case ND_FULL: // Full - show newspaper, skipped here
686 continue;
687 }
688 return;
689 }
690 }
691
692 /** Move to the next news item */
MoveToNextNewsItem()693 static void MoveToNextNewsItem()
694 {
695 /* There is no status bar, so no reason to show news;
696 * especially important with the end game screen when
697 * there is no status bar but possible news. */
698 if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
699
700 CloseWindowById(WC_NEWS_WINDOW, 0); // close the newspapers window if shown
701 _forced_news = nullptr;
702
703 /* if we're not at the last item, then move on */
704 while (_current_news != _latest_news) {
705 _current_news = (_current_news == nullptr) ? _oldest_news : _current_news->next;
706 const NewsItem *ni = _current_news;
707 const NewsType type = ni->type;
708
709 /* check the date, don't show too old items */
710 if (_date - _news_type_data[type].age > ni->date) continue;
711
712 switch (_news_type_data[type].GetDisplay()) {
713 default: NOT_REACHED();
714 case ND_OFF: // Off - show nothing only a small reminder in the status bar, skipped here
715 continue;
716
717 case ND_SUMMARY: // Summary - show ticker, skipped here
718 continue;
719
720 case ND_FULL: // Full - show newspaper
721 ShowNewspaper(ni);
722 break;
723 }
724 return;
725 }
726 }
727
728 /** Delete a news item from the queue */
DeleteNewsItem(NewsItem * ni)729 static void DeleteNewsItem(NewsItem *ni)
730 {
731 /* Delete the news from the news queue. */
732 if (ni->prev != nullptr) {
733 ni->prev->next = ni->next;
734 } else {
735 assert(_oldest_news == ni);
736 _oldest_news = ni->next;
737 }
738
739 if (ni->next != nullptr) {
740 ni->next->prev = ni->prev;
741 } else {
742 assert(_latest_news == ni);
743 _latest_news = ni->prev;
744 }
745
746 _total_news--;
747
748 if (_forced_news == ni || _current_news == ni) {
749 /* When we're the current news, go to the previous item first;
750 * we just possibly made that the last news item. */
751 if (_current_news == ni) _current_news = ni->prev;
752
753 /* About to remove the currently forced item (shown as newspapers) ||
754 * about to remove the currently displayed item (newspapers) */
755 MoveToNextNewsItem();
756 }
757
758 if (_statusbar_news_item == ni) {
759 /* When we're the current news, go to the previous item first;
760 * we just possibly made that the last news item. */
761 _statusbar_news_item = ni->prev;
762
763 /* About to remove the currently displayed item (ticker, or just a reminder) */
764 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
765 MoveToNextTickerItem();
766 }
767
768 delete ni;
769
770 SetWindowDirty(WC_MESSAGE_HISTORY, 0);
771 }
772
773 /**
774 * Create a new newsitem to be shown.
775 * @param string_id String to display.
776 * @param type The type of news.
777 * @param flags Flags related to how to display the news.
778 * @param reftype1 Type of ref1.
779 * @param ref1 Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted.
780 * @param reftype2 Type of ref2.
781 * @param ref2 Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted.
782 * @param data Pointer to data that must be released once the news message is cleared.
783 *
784 * @see NewsSubtype
785 */
NewsItem(StringID string_id,NewsType type,NewsFlag flags,NewsReferenceType reftype1,uint32 ref1,NewsReferenceType reftype2,uint32 ref2,const NewsAllocatedData * data)786 NewsItem::NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data) :
787 string_id(string_id), date(_date), type(type), flags(flags), reftype1(reftype1), reftype2(reftype2), ref1(ref1), ref2(ref2), data(data)
788 {
789 /* show this news message in colour? */
790 if (_cur_year >= _settings_client.gui.coloured_news_year) this->flags |= NF_INCOLOUR;
791 CopyOutDParam(this->params, 0, lengthof(this->params));
792 }
793
794 /**
795 * Add a new newsitem to be shown.
796 * @param string String to display
797 * @param type news category
798 * @param flags display flags for the news
799 * @param reftype1 Type of ref1
800 * @param ref1 Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted.
801 * @param reftype2 Type of ref2
802 * @param ref2 Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted.
803 * @param data Pointer to data that must be released once the news message is cleared.
804 *
805 * @see NewsSubtype
806 */
AddNewsItem(StringID string,NewsType type,NewsFlag flags,NewsReferenceType reftype1,uint32 ref1,NewsReferenceType reftype2,uint32 ref2,const NewsAllocatedData * data)807 void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data)
808 {
809 if (_game_mode == GM_MENU) return;
810
811 /* Create new news item node */
812 NewsItem *ni = new NewsItem(string, type, flags, reftype1, ref1, reftype2, ref2, data);
813
814 if (_total_news++ == 0) {
815 assert(_oldest_news == nullptr);
816 _oldest_news = ni;
817 ni->prev = nullptr;
818 } else {
819 assert(_latest_news->next == nullptr);
820 _latest_news->next = ni;
821 ni->prev = _latest_news;
822 }
823
824 ni->next = nullptr;
825 _latest_news = ni;
826
827 /* Keep the number of stored news items to a managable number */
828 if (_total_news > MAX_NEWS_AMOUNT) {
829 DeleteNewsItem(_oldest_news);
830 }
831
832 SetWindowDirty(WC_MESSAGE_HISTORY, 0);
833 }
834
835 /**
836 * Create a new custom news item.
837 * @param tile unused
838 * @param flags type of operation
839 * @param p1 various bitstuffed elements
840 * - p1 = (bit 0 - 7) - NewsType of the message.
841 * - p1 = (bit 8 - 15) - NewsReferenceType of first reference.
842 * - p1 = (bit 16 - 23) - Company this news message is for.
843 * @param p2 First reference of the news message.
844 * @param text The text of the news message.
845 * @return the cost of this operation or an error
846 */
CmdCustomNewsItem(TileIndex tile,DoCommandFlag flags,uint32 p1,uint32 p2,const std::string & text)847 CommandCost CmdCustomNewsItem(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
848 {
849 if (_current_company != OWNER_DEITY) return CMD_ERROR;
850
851 NewsType type = (NewsType)GB(p1, 0, 8);
852 NewsReferenceType reftype1 = (NewsReferenceType)GB(p1, 8, 8);
853 CompanyID company = (CompanyID)GB(p1, 16, 8);
854
855 if (company != INVALID_OWNER && !Company::IsValidID(company)) return CMD_ERROR;
856 if (type >= NT_END) return CMD_ERROR;
857 if (text.empty()) return CMD_ERROR;
858
859 switch (reftype1) {
860 case NR_NONE: break;
861 case NR_TILE:
862 if (!IsValidTile(p2)) return CMD_ERROR;
863 break;
864
865 case NR_VEHICLE:
866 if (!Vehicle::IsValidID(p2)) return CMD_ERROR;
867 break;
868
869 case NR_STATION:
870 if (!Station::IsValidID(p2)) return CMD_ERROR;
871 break;
872
873 case NR_INDUSTRY:
874 if (!Industry::IsValidID(p2)) return CMD_ERROR;
875 break;
876
877 case NR_TOWN:
878 if (!Town::IsValidID(p2)) return CMD_ERROR;
879 break;
880
881 case NR_ENGINE:
882 if (!Engine::IsValidID(p2)) return CMD_ERROR;
883 break;
884
885 default: return CMD_ERROR;
886 }
887
888 if (company != INVALID_OWNER && company != _local_company) return CommandCost();
889
890 if (flags & DC_EXEC) {
891 NewsStringData *news = new NewsStringData(text);
892 SetDParamStr(0, news->string);
893 AddNewsItem(STR_NEWS_CUSTOM_ITEM, type, NF_NORMAL, reftype1, p2, NR_NONE, UINT32_MAX, news);
894 }
895
896 return CommandCost();
897 }
898
899 /**
900 * Delete a news item type about a vehicle.
901 * When the news item type is INVALID_STRING_ID all news about the vehicle gets deleted.
902 * @param vid The vehicle to remove the news for.
903 * @param news The news type to remove.
904 */
DeleteVehicleNews(VehicleID vid,StringID news)905 void DeleteVehicleNews(VehicleID vid, StringID news)
906 {
907 NewsItem *ni = _oldest_news;
908
909 while (ni != nullptr) {
910 NewsItem *next = ni->next;
911 if (((ni->reftype1 == NR_VEHICLE && ni->ref1 == vid) || (ni->reftype2 == NR_VEHICLE && ni->ref2 == vid)) &&
912 (news == INVALID_STRING_ID || ni->string_id == news)) {
913 DeleteNewsItem(ni);
914 }
915 ni = next;
916 }
917 }
918
919 /**
920 * Remove news regarding given station so there are no 'unknown station now accepts Mail'
921 * or 'First train arrived at unknown station' news items.
922 * @param sid station to remove news about
923 */
DeleteStationNews(StationID sid)924 void DeleteStationNews(StationID sid)
925 {
926 NewsItem *ni = _oldest_news;
927
928 while (ni != nullptr) {
929 NewsItem *next = ni->next;
930 if ((ni->reftype1 == NR_STATION && ni->ref1 == sid) || (ni->reftype2 == NR_STATION && ni->ref2 == sid)) {
931 DeleteNewsItem(ni);
932 }
933 ni = next;
934 }
935 }
936
937 /**
938 * Remove news regarding given industry
939 * @param iid industry to remove news about
940 */
DeleteIndustryNews(IndustryID iid)941 void DeleteIndustryNews(IndustryID iid)
942 {
943 NewsItem *ni = _oldest_news;
944
945 while (ni != nullptr) {
946 NewsItem *next = ni->next;
947 if ((ni->reftype1 == NR_INDUSTRY && ni->ref1 == iid) || (ni->reftype2 == NR_INDUSTRY && ni->ref2 == iid)) {
948 DeleteNewsItem(ni);
949 }
950 ni = next;
951 }
952 }
953
954 /**
955 * Remove engine announcements for invalid engines.
956 */
DeleteInvalidEngineNews()957 void DeleteInvalidEngineNews()
958 {
959 NewsItem *ni = _oldest_news;
960
961 while (ni != nullptr) {
962 NewsItem *next = ni->next;
963 if ((ni->reftype1 == NR_ENGINE && (!Engine::IsValidID(ni->ref1) || !Engine::Get(ni->ref1)->IsEnabled())) ||
964 (ni->reftype2 == NR_ENGINE && (!Engine::IsValidID(ni->ref2) || !Engine::Get(ni->ref2)->IsEnabled()))) {
965 DeleteNewsItem(ni);
966 }
967 ni = next;
968 }
969 }
970
RemoveOldNewsItems()971 static void RemoveOldNewsItems()
972 {
973 NewsItem *next;
974 for (NewsItem *cur = _oldest_news; _total_news > MIN_NEWS_AMOUNT && cur != nullptr; cur = next) {
975 next = cur->next;
976 if (_date - _news_type_data[cur->type].age * _settings_client.gui.news_message_timeout > cur->date) DeleteNewsItem(cur);
977 }
978 }
979
980 /**
981 * Report a change in vehicle IDs (due to autoreplace) to affected vehicle news.
982 * @note Viewports of currently displayed news is changed via #ChangeVehicleViewports
983 * @param from_index the old vehicle ID
984 * @param to_index the new vehicle ID
985 */
ChangeVehicleNews(VehicleID from_index,VehicleID to_index)986 void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
987 {
988 for (NewsItem *ni = _oldest_news; ni != nullptr; ni = ni->next) {
989 if (ni->reftype1 == NR_VEHICLE && ni->ref1 == from_index) ni->ref1 = to_index;
990 if (ni->reftype2 == NR_VEHICLE && ni->ref2 == from_index) ni->ref2 = to_index;
991 if (ni->flags & NF_VEHICLE_PARAM0 && ni->params[0] == from_index) ni->params[0] = to_index;
992 }
993 }
994
NewsLoop()995 void NewsLoop()
996 {
997 /* no news item yet */
998 if (_total_news == 0) return;
999
1000 static byte _last_clean_month = 0;
1001
1002 if (_last_clean_month != _cur_month) {
1003 RemoveOldNewsItems();
1004 _last_clean_month = _cur_month;
1005 }
1006
1007 if (ReadyForNextTickerItem()) MoveToNextTickerItem();
1008 if (ReadyForNextNewsItem()) MoveToNextNewsItem();
1009 }
1010
1011 /** Do a forced show of a specific message */
ShowNewsMessage(const NewsItem * ni)1012 static void ShowNewsMessage(const NewsItem *ni)
1013 {
1014 assert(_total_news != 0);
1015
1016 /* Delete the news window */
1017 CloseWindowById(WC_NEWS_WINDOW, 0);
1018
1019 /* setup forced news item */
1020 _forced_news = ni;
1021
1022 if (_forced_news != nullptr) {
1023 CloseWindowById(WC_NEWS_WINDOW, 0);
1024 ShowNewspaper(ni);
1025 }
1026 }
1027
1028 /**
1029 * Close active news message window
1030 * @return true if a window was closed.
1031 */
HideActiveNewsMessage()1032 bool HideActiveNewsMessage() {
1033 NewsWindow *w = (NewsWindow*)FindWindowById(WC_NEWS_WINDOW, 0);
1034 if (w == nullptr) return false;
1035 w->Close();
1036 return true;
1037 }
1038
1039 /** Show previous news item */
ShowLastNewsMessage()1040 void ShowLastNewsMessage()
1041 {
1042 const NewsItem *ni = nullptr;
1043 if (_total_news == 0) {
1044 return;
1045 } else if (_forced_news == nullptr) {
1046 /* Not forced any news yet, show the current one, unless a news window is
1047 * open (which can only be the current one), then show the previous item */
1048 if (_current_news == nullptr) {
1049 /* No news were shown yet resp. the last shown one was already deleted.
1050 * Threat this as if _forced_news reached _oldest_news; so, wrap around and start anew with the latest. */
1051 ni = _latest_news;
1052 } else {
1053 const Window *w = FindWindowById(WC_NEWS_WINDOW, 0);
1054 ni = (w == nullptr || (_current_news == _oldest_news)) ? _current_news : _current_news->prev;
1055 }
1056 } else if (_forced_news == _oldest_news) {
1057 /* We have reached the oldest news, start anew with the latest */
1058 ni = _latest_news;
1059 } else {
1060 /* 'Scrolling' through news history show each one in turn */
1061 ni = _forced_news->prev;
1062 }
1063 bool wrap = false;
1064 for (;;) {
1065 if (_news_type_data[ni->type].GetDisplay() != ND_OFF) {
1066 ShowNewsMessage(ni);
1067 break;
1068 }
1069
1070 ni = ni->prev;
1071 if (ni == nullptr) {
1072 if (wrap) break;
1073 /* We have reached the oldest news, start anew with the latest */
1074 ni = _latest_news;
1075 wrap = true;
1076 }
1077 }
1078 }
1079
1080
1081 /**
1082 * Draw an unformatted news message truncated to a maximum length. If
1083 * length exceeds maximum length it will be postfixed by '...'
1084 * @param left the left most location for the string
1085 * @param right the right most location for the string
1086 * @param y position of the string
1087 * @param colour the colour the string will be shown in
1088 * @param *ni NewsItem being printed
1089 */
DrawNewsString(uint left,uint right,int y,TextColour colour,const NewsItem * ni)1090 static void DrawNewsString(uint left, uint right, int y, TextColour colour, const NewsItem *ni)
1091 {
1092 char buffer[512], buffer2[512];
1093 StringID str;
1094
1095 CopyInDParam(0, ni->params, lengthof(ni->params));
1096 str = ni->string_id;
1097
1098 GetString(buffer, str, lastof(buffer));
1099 /* Copy the just gotten string to another buffer to remove any formatting
1100 * from it such as big fonts, etc. */
1101 const char *ptr = buffer;
1102 char *dest = buffer2;
1103 WChar c_last = '\0';
1104 for (;;) {
1105 WChar c = Utf8Consume(&ptr);
1106 if (c == 0) break;
1107 /* Make a space from a newline, but ignore multiple newlines */
1108 if (c == '\n' && c_last != '\n') {
1109 dest[0] = ' ';
1110 dest++;
1111 } else if (c == '\r') {
1112 dest[0] = dest[1] = dest[2] = dest[3] = ' ';
1113 dest += 4;
1114 } else if (IsPrintable(c)) {
1115 dest += Utf8Encode(dest, c);
1116 }
1117 c_last = c;
1118 }
1119
1120 *dest = '\0';
1121 /* Truncate and show string; postfixed by '...' if necessary */
1122 DrawString(left, right, y, buffer2, colour);
1123 }
1124
1125 struct MessageHistoryWindow : Window {
1126 static const int top_spacing; ///< Additional spacing at the top of the #WID_MH_BACKGROUND widget.
1127 static const int bottom_spacing; ///< Additional spacing at the bottom of the #WID_MH_BACKGROUND widget.
1128
1129 int line_height; /// < Height of a single line in the news history window including spacing.
1130 int date_width; /// < Width needed for the date part.
1131
1132 Scrollbar *vscroll;
1133
MessageHistoryWindowMessageHistoryWindow1134 MessageHistoryWindow(WindowDesc *desc) : Window(desc)
1135 {
1136 this->CreateNestedTree();
1137 this->vscroll = this->GetScrollbar(WID_MH_SCROLLBAR);
1138 this->FinishInitNested(); // Initializes 'this->line_height' and 'this->date_width'.
1139 this->OnInvalidateData(0);
1140 }
1141
UpdateWidgetSizeMessageHistoryWindow1142 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1143 {
1144 if (widget == WID_MH_BACKGROUND) {
1145 this->line_height = FONT_HEIGHT_NORMAL + 2;
1146 resize->height = this->line_height;
1147
1148 /* Months are off-by-one, so it's actually 8. Not using
1149 * month 12 because the 1 is usually less wide. */
1150 SetDParam(0, ConvertYMDToDate(ORIGINAL_MAX_YEAR, 7, 30));
1151 this->date_width = GetStringBoundingBox(STR_SHORT_DATE).width;
1152
1153 size->height = 4 * resize->height + this->top_spacing + this->bottom_spacing; // At least 4 lines are visible.
1154 size->width = std::max(200u, size->width); // At least 200 pixels wide.
1155 }
1156 }
1157
OnPaintMessageHistoryWindow1158 void OnPaint() override
1159 {
1160 this->OnInvalidateData(0);
1161 this->DrawWidgets();
1162 }
1163
DrawWidgetMessageHistoryWindow1164 void DrawWidget(const Rect &r, int widget) const override
1165 {
1166 if (widget != WID_MH_BACKGROUND || _total_news == 0) return;
1167
1168 /* Find the first news item to display. */
1169 NewsItem *ni = _latest_news;
1170 for (int n = this->vscroll->GetPosition(); n > 0; n--) {
1171 ni = ni->prev;
1172 if (ni == nullptr) return;
1173 }
1174
1175 /* Fill the widget with news items. */
1176 int y = r.top + this->top_spacing;
1177 bool rtl = _current_text_dir == TD_RTL;
1178 uint date_left = rtl ? r.right - WD_FRAMERECT_RIGHT - this->date_width : r.left + WD_FRAMERECT_LEFT;
1179 uint date_right = rtl ? r.right - WD_FRAMERECT_RIGHT : r.left + WD_FRAMERECT_LEFT + this->date_width;
1180 uint news_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.left + WD_FRAMERECT_LEFT + this->date_width + WD_FRAMERECT_RIGHT + ScaleFontTrad(5);
1181 uint news_right = rtl ? r.right - WD_FRAMERECT_RIGHT - this->date_width - WD_FRAMERECT_RIGHT - ScaleFontTrad(5) : r.right - WD_FRAMERECT_RIGHT;
1182 for (int n = this->vscroll->GetCapacity(); n > 0; n--) {
1183 SetDParam(0, ni->date);
1184 DrawString(date_left, date_right, y, STR_SHORT_DATE);
1185
1186 DrawNewsString(news_left, news_right, y, TC_WHITE, ni);
1187 y += this->line_height;
1188
1189 ni = ni->prev;
1190 if (ni == nullptr) return;
1191 }
1192 }
1193
1194 /**
1195 * Some data on this window has become invalid.
1196 * @param data Information about the changed data.
1197 * @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.
1198 */
OnInvalidateDataMessageHistoryWindow1199 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1200 {
1201 if (!gui_scope) return;
1202 this->vscroll->SetCount(_total_news);
1203 }
1204
OnClickMessageHistoryWindow1205 void OnClick(Point pt, int widget, int click_count) override
1206 {
1207 if (widget == WID_MH_BACKGROUND) {
1208 NewsItem *ni = _latest_news;
1209 if (ni == nullptr) return;
1210
1211 for (int n = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_MH_BACKGROUND, WD_FRAMERECT_TOP); n > 0; n--) {
1212 ni = ni->prev;
1213 if (ni == nullptr) return;
1214 }
1215
1216 ShowNewsMessage(ni);
1217 }
1218 }
1219
OnResizeMessageHistoryWindow1220 void OnResize() override
1221 {
1222 this->vscroll->SetCapacityFromWidget(this, WID_MH_BACKGROUND);
1223 }
1224 };
1225
1226 const int MessageHistoryWindow::top_spacing = WD_FRAMERECT_TOP + 4;
1227 const int MessageHistoryWindow::bottom_spacing = WD_FRAMERECT_BOTTOM;
1228
1229 static const NWidgetPart _nested_message_history[] = {
1230 NWidget(NWID_HORIZONTAL),
1231 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1232 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MESSAGE_HISTORY, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1233 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1234 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1235 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1236 EndContainer(),
1237
1238 NWidget(NWID_HORIZONTAL),
1239 NWidget(WWT_PANEL, COLOUR_BROWN, WID_MH_BACKGROUND), SetMinimalSize(200, 125), SetDataTip(0x0, STR_MESSAGE_HISTORY_TOOLTIP), SetResize(1, 12), SetScrollbar(WID_MH_SCROLLBAR),
1240 EndContainer(),
1241 NWidget(NWID_VERTICAL),
1242 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_MH_SCROLLBAR),
1243 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1244 EndContainer(),
1245 EndContainer(),
1246 };
1247
1248 static WindowDesc _message_history_desc(
1249 WDP_AUTO, "list_news", 400, 140,
1250 WC_MESSAGE_HISTORY, WC_NONE,
1251 0,
1252 _nested_message_history, lengthof(_nested_message_history)
1253 );
1254
1255 /** Display window with news messages history */
ShowMessageHistory()1256 void ShowMessageHistory()
1257 {
1258 CloseWindowById(WC_MESSAGE_HISTORY, 0);
1259 new MessageHistoryWindow(&_message_history_desc);
1260 }
1261