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