cpp/openttd-patchpack/source Changeset - r24823:6a09ecd63560

Changeset - r24823:6a09ecd63560

Parent rev.

Child rev.

[Not reviewed]

master

0 1 0

Jonathan G Rennison - 3 years ago 2021-02-18 11:17:51
j.g.rennison@gmail.com

Fix: Unnecessary status bar redraws when there is no news to show (#8691)

InvalidateWindowData with mode SBI_NEWS_DELETED was called on the
status bar when checking for a new item of news to be shown in the
ticker, even if there is no news queued and no change occurs.

1 file changed with 1 insertions and 2 deletions:

src/news_gui.cpp

0 comments (0 inline, 0 general)

src/news_gui.cpp

➞

Show inline comments

@@ @@ -285,868 +285,867 @@ struct NewsWindow : Window { @@
 		/* For company news with a face we have a separate headline in param[0] */
 		if (desc == &_company_news_desc) this->GetWidget<NWidgetCore>(WID_N_TITLE)->widget_data = this->ni->params[0];
 		NWidgetCore *nwid = this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP);
 		if (ni->reftype1 == NR_VEHICLE && nwid != nullptr) {
 			const Vehicle *v = Vehicle::Get(ni->ref1);
 			switch (v->type) {
 				case VEH_TRAIN:
 					nwid->widget_data = STR_TRAIN;
 					break;
 				case VEH_ROAD:
 					nwid->widget_data = RoadVehicle::From(v)->IsBus() ? STR_BUS : STR_LORRY;
 					break;
 				case VEH_SHIP:
 					nwid->widget_data = STR_SHIP;
 					break;
 				case VEH_AIRCRAFT:
 					nwid->widget_data = STR_PLANE;
 					break;
 				default:
 					break; // Do nothing
+			}
+		}
 		this->FinishInitNested(0);
 		/* Initialize viewport if it exists. */
 		NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
 		if (nvp != nullptr) {
 			nvp->InitializeViewport(this, ni->reftype1 == NR_VEHICLE ? 0x80000000 | ni->ref1 : GetReferenceTile(ni->reftype1, ni->ref1), ZOOM_LVL_NEWS);
 			if (this->ni->flags & NF_NO_TRANSPARENT) nvp->disp_flags |= ND_NO_TRANSPARENCY;
 			if ((this->ni->flags & NF_INCOLOUR) == 0) {
 				nvp->disp_flags |= ND_SHADE_GREY;
 			} else if (this->ni->flags & NF_SHADE) {
 				nvp->disp_flags |= ND_SHADE_DIMMED;
+			}
+		}
 		PositionNewsMessage(this);
+	}
 	void DrawNewsBorder(const Rect &r) const
+	{
 		GfxFillRect(r.left,  r.top,    r.right, r.bottom, PC_WHITE);
 		GfxFillRect(r.left,  r.top,    r.left,  r.bottom, PC_BLACK);
 		GfxFillRect(r.right, r.top,    r.right, r.bottom, PC_BLACK);
 		GfxFillRect(r.left,  r.top,    r.right, r.top,    PC_BLACK);
 		GfxFillRect(r.left,  r.bottom, r.right, r.bottom, PC_BLACK);
+	}
 	Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
+	{
 		Point pt = { 0, _screen.height };
 		return pt;
+	}
 	void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
+	{
 		StringID str = STR_NULL;
 		switch (widget) {
 			case WID_N_CAPTION: {
 				/* Caption is not a real caption (so that the window cannot be moved)
 				 * thus it doesn't get the default sizing of a caption. */
 				Dimension d2 = GetStringBoundingBox(STR_NEWS_MESSAGE_CAPTION);
 				d2.height += WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM;
 				*size = maxdim(*size, d2);
 				return;
+			}
 			case WID_N_MGR_FACE:
 				*size = maxdim(*size, GetSpriteSize(SPR_GRADIENT));
 				break;
 			case WID_N_MGR_NAME:
 				SetDParamStr(0, static_cast<const CompanyNewsInformation *>(this->ni->free_data)->president_name);
 				str = STR_JUST_RAW_STRING;
 				break;
 			case WID_N_MESSAGE:
 				CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
 				str = this->ni->string_id;
 				break;
 			case WID_N_COMPANY_MSG:
 				str = this->GetCompanyMessageString();
 				break;
 			case WID_N_VEH_NAME:
 			case WID_N_VEH_TITLE:
 				str = this->GetNewVehicleMessageString(widget);
 				break;
 			case WID_N_VEH_INFO: {
 				assert(this->ni->reftype1 == NR_ENGINE);
 				EngineID engine = this->ni->ref1;
 				str = GetEngineInfoString(engine);
 				break;
+			}
 			case WID_N_SHOW_GROUP:
 				if (this->ni->reftype1 == NR_VEHICLE) {
 					Dimension d2 = GetStringBoundingBox(this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP)->widget_data);
 					d2.height += WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM;
 					d2.width += WD_CAPTIONTEXT_LEFT + WD_CAPTIONTEXT_RIGHT;
 					*size = d2;
 				} else {
 					/* Hide 'Show group window' button if this news is not about a vehicle. */
 					size->width = 0;
 					size->height = 0;
 					resize->width = 0;
 					resize->height = 0;
 					fill->width = 0;
 					fill->height = 0;
+				}
 				return;
 			default:
 				return; // Do nothing
+		}
 		/* Update minimal size with length of the multi-line string. */
 		Dimension d = *size;
 		d.width = (d.width >= padding.width) ? d.width - padding.width : 0;
 		d.height = (d.height >= padding.height) ? d.height - padding.height : 0;
 		d = GetStringMultiLineBoundingBox(str, d);
 		d.width += padding.width;
 		d.height += padding.height;
 		*size = maxdim(*size, d);
+	}
 	void SetStringParameters(int widget) const override
+	{
 		if (widget == WID_N_DATE) SetDParam(0, this->ni->date);
+	}
 	void DrawWidget(const Rect &r, int widget) const override
+	{
 		switch (widget) {
 			case WID_N_CAPTION:
 				DrawCaption(r, COLOUR_LIGHT_BLUE, this->owner, STR_NEWS_MESSAGE_CAPTION);
 				break;
 			case WID_N_PANEL:
 				this->DrawNewsBorder(r);
 				break;
 			case WID_N_MESSAGE:
 				CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
 				DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->ni->string_id, TC_FROMSTRING, SA_CENTER);
 				break;
 			case WID_N_MGR_FACE: {
 				const CompanyNewsInformation *cni = (const CompanyNewsInformation*)this->ni->free_data;
 				DrawCompanyManagerFace(cni->face, cni->colour, r.left, r.top);
 				GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
 				break;
+			}
 			case WID_N_MGR_NAME: {
 				const CompanyNewsInformation *cni = (const CompanyNewsInformation*)this->ni->free_data;
 				SetDParamStr(0, cni->president_name);
 				DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_JUST_RAW_STRING, TC_FROMSTRING, SA_CENTER);
 				break;
+			}
 			case WID_N_COMPANY_MSG:
 				DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetCompanyMessageString(), TC_FROMSTRING, SA_CENTER);
 				break;
 			case WID_N_VEH_BKGND:
 				GfxFillRect(r.left, r.top, r.right, r.bottom, PC_GREY);
 				break;
 			case WID_N_VEH_NAME:
 			case WID_N_VEH_TITLE:
 				DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetNewVehicleMessageString(widget), TC_FROMSTRING, SA_CENTER);
 				break;
 			case WID_N_VEH_SPR: {
 				assert(this->ni->reftype1 == NR_ENGINE);
 				EngineID engine = this->ni->ref1;
 				DrawVehicleEngine(r.left, r.right, (r.left + r.right) / 2, (r.top + r.bottom) / 2, engine, GetEnginePalette(engine, _local_company), EIT_PREVIEW);
 				GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
 				break;
+			}
 			case WID_N_VEH_INFO: {
 				assert(this->ni->reftype1 == NR_ENGINE);
 				EngineID engine = this->ni->ref1;
 				DrawStringMultiLine(r.left, r.right, r.top, r.bottom, GetEngineInfoString(engine), TC_FROMSTRING, SA_CENTER);
 				break;
+			}
+		}
+	}
 	void OnClick(Point pt, int widget, int click_count) override
+	{
 		switch (widget) {
 			case WID_N_CLOSEBOX:
 				NewsWindow::duration = 0;
 				delete this;
 				_forced_news = nullptr;
 				break;
 			case WID_N_CAPTION:
 				if (this->ni->reftype1 == NR_VEHICLE) {
 					const Vehicle *v = Vehicle::Get(this->ni->ref1);
 					ShowVehicleViewWindow(v);
+				}
 				break;
 			case WID_N_VIEWPORT:
 				break; // Ignore clicks
 			case WID_N_SHOW_GROUP:
 				if (this->ni->reftype1 == NR_VEHICLE) {
 					const Vehicle *v = Vehicle::Get(this->ni->ref1);
 					ShowCompanyGroupForVehicle(v);
+				}
 				break;
 			default:
 				if (this->ni->reftype1 == NR_VEHICLE) {
 					const Vehicle *v = Vehicle::Get(this->ni->ref1);
 					ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
 				} else {
 					TileIndex tile1 = GetReferenceTile(this->ni->reftype1, this->ni->ref1);
 					TileIndex tile2 = GetReferenceTile(this->ni->reftype2, this->ni->ref2);
 					if (_ctrl_pressed) {
 						if (tile1 != INVALID_TILE) ShowExtraViewportWindow(tile1);
 						if (tile2 != INVALID_TILE) ShowExtraViewportWindow(tile2);
 					} else {
 						if ((tile1 == INVALID_TILE || !ScrollMainWindowToTile(tile1)) && tile2 != INVALID_TILE) {
 							ScrollMainWindowToTile(tile2);
+						}
+					}
+				}
 				break;
+		}
+	}
 	/**
 	 * Some data on this window has become invalid.
 	 * @param data Information about the changed data.
 	 * @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.
 	 */
 	void OnInvalidateData(int data = 0, bool gui_scope = true) override
+	{
 		if (!gui_scope) return;
 		/* The chatbar has notified us that is was either created or closed */
 		int newtop = this->top + this->chat_height - data;
 		this->chat_height = data;
 		this->SetWindowTop(newtop);
+	}
 	void OnRealtimeTick(uint delta_ms) override
+	{
 		int count = this->timer.CountElapsed(delta_ms);
 		if (count > 0) {
 			/* Scroll up newsmessages from the bottom */
 			int newtop = std::max(this->top - 2 * count, _screen.height - this->height - this->status_height - this->chat_height);
 			this->SetWindowTop(newtop);
+		}
 		/* Decrement the news timer. We don't need to action an elapsed event here,
 		 * so no need to use TimerElapsed(). */
 		if (NewsWindow::duration > 0) NewsWindow::duration -= delta_ms;
+	}
 private:
 	/**
 	 * Moves the window to a new #top coordinate. Makes screen dirty where needed.
 	 * @param newtop new top coordinate
 	 */
 	void SetWindowTop(int newtop)
+	{
 		if (this->top == newtop) return;
 		int mintop = std::min(newtop, this->top);
 		int maxtop = std::max(newtop, this->top);
 		if (this->viewport != nullptr) this->viewport->top += newtop - this->top;
 		this->top = newtop;
 		AddDirtyBlock(this->left, mintop, this->left + this->width, maxtop + this->height);
+	}
 	StringID GetCompanyMessageString() const
+	{
 		/* Company news with a face have a separate headline, so the normal message is shifted by two params */
 		CopyInDParam(0, this->ni->params + 2, lengthof(this->ni->params) - 2);
 		return this->ni->params[1];
+	}
 	StringID GetNewVehicleMessageString(int widget) const
+	{
 		assert(this->ni->reftype1 == NR_ENGINE);
 		EngineID engine = this->ni->ref1;
 		switch (widget) {
 			case WID_N_VEH_TITLE:
 				SetDParam(0, GetEngineCategoryName(engine));
 				return STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE;
 			case WID_N_VEH_NAME:
 				SetDParam(0, engine);
 				return STR_NEWS_NEW_VEHICLE_TYPE;
 			default:
 				NOT_REACHED();
+		}
+	}
 };
 /* static */ int NewsWindow::duration = 0; // Instance creation.
 /** Open up an own newspaper window for the news item */
 static void ShowNewspaper(const NewsItem *ni)
+{
 	SoundFx sound = _news_type_data[ni->type].sound;
 	if (sound != 0 && _settings_client.sound.news_full) SndPlayFx(sound);
 	new NewsWindow(GetNewsWindowLayout(ni->flags), ni);
+}
 /** Show news item in the ticker */
 static void ShowTicker(const NewsItem *ni)
+{
 	if (_settings_client.sound.news_ticker) SndPlayFx(SND_16_MORSE);
 	_statusbar_news_item = ni;
 	InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);
+}
 /** Initialize the news-items data structures */
 void InitNewsItemStructs()
+{
 	for (NewsItem *ni = _oldest_news; ni != nullptr; ) {
 		NewsItem *next = ni->next;
 		delete ni;
 		ni = next;
+	}
 	_total_news = 0;
 	_oldest_news = nullptr;
 	_latest_news = nullptr;
 	_forced_news = nullptr;
 	_current_news = nullptr;
 	_statusbar_news_item = nullptr;
 	NewsWindow::duration = 0;
+}
 /**
  * Are we ready to show another ticker item?
  * Only if nothing is in the newsticker is displayed
  */
 static bool ReadyForNextTickerItem()
+{
 	const NewsItem *ni = _statusbar_news_item;
 	if (ni == nullptr) return true;
 	/* Ticker message
 	 * Check if the status bar message is still being displayed? */
 	if (IsNewsTickerShown()) return false;
 	return true;
+}
 /**
  * Are we ready to show another news item?
  * Only if no newspaper is displayed
  */
 static bool ReadyForNextNewsItem()
+{
 	const NewsItem *ni = _forced_news == nullptr ? _current_news : _forced_news;
 	if (ni == nullptr) return true;
 	/* neither newsticker nor newspaper are running */
 	return (NewsWindow::duration <= 0 || FindWindowById(WC_NEWS_WINDOW, 0) == nullptr);
+}
 /** Move to the next ticker item */
 static void MoveToNextTickerItem()
+{
 	/* There is no status bar, so no reason to show news;
 	 * especially important with the end game screen when
 	 * there is no status bar but possible news. */
 	if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
 	InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
 	/* if we're not at the last item, then move on */
 	while (_statusbar_news_item != _latest_news) {
 		_statusbar_news_item = (_statusbar_news_item == nullptr) ? _oldest_news : _statusbar_news_item->next;
 		const NewsItem *ni = _statusbar_news_item;
 		const NewsType type = ni->type;
 		/* check the date, don't show too old items */
 		if (_date - _news_type_data[type].age > ni->date) continue;
 		switch (_news_type_data[type].GetDisplay()) {
 			default: NOT_REACHED();
 			case ND_OFF: // Off - show nothing only a small reminder in the status bar
 				InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_REMINDER);
 				break;
 			case ND_SUMMARY: // Summary - show ticker
 				ShowTicker(ni);
 				break;
 			case ND_FULL: // Full - show newspaper, skipped here
 				continue;
+		}
 		return;
+	}
+}
 /** Move to the next news item */
 static void MoveToNextNewsItem()
+{
 	/* There is no status bar, so no reason to show news;
 	 * especially important with the end game screen when
 	 * there is no status bar but possible news. */
 	if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
 	DeleteWindowById(WC_NEWS_WINDOW, 0); // close the newspapers window if shown
 	_forced_news = nullptr;
 	/* if we're not at the last item, then move on */
 	while (_current_news != _latest_news) {
 		_current_news = (_current_news == nullptr) ? _oldest_news : _current_news->next;
 		const NewsItem *ni = _current_news;
 		const NewsType type = ni->type;
 		/* check the date, don't show too old items */
 		if (_date - _news_type_data[type].age > ni->date) continue;
 		switch (_news_type_data[type].GetDisplay()) {
 			default: NOT_REACHED();
 			case ND_OFF: // Off - show nothing only a small reminder in the status bar, skipped here
 				continue;
 			case ND_SUMMARY: // Summary - show ticker, skipped here
 				continue;
 			case ND_FULL: // Full - show newspaper
 				ShowNewspaper(ni);
 				break;
+		}
 		return;
+	}
+}
 /** Delete a news item from the queue */
 static void DeleteNewsItem(NewsItem *ni)
+{
 	/* Delete the news from the news queue. */
 	if (ni->prev != nullptr) {
 		ni->prev->next = ni->next;
 	} else {
 		assert(_oldest_news == ni);
 		_oldest_news = ni->next;
+	}
 	if (ni->next != nullptr) {
 		ni->next->prev = ni->prev;
 	} else {
 		assert(_latest_news == ni);
 		_latest_news = ni->prev;
+	}
 	_total_news--;
 	if (_forced_news == ni || _current_news == ni) {
 		/* When we're the current news, go to the previous item first;
 		 * we just possibly made that the last news item. */
 		if (_current_news == ni) _current_news = ni->prev;
 		/* About to remove the currently forced item (shown as newspapers) ||
 		 * about to remove the currently displayed item (newspapers) */
 		MoveToNextNewsItem();
+	}
 	if (_statusbar_news_item == ni) {
 		/* When we're the current news, go to the previous item first;
 		 * we just possibly made that the last news item. */
 		_statusbar_news_item = ni->prev;
 		/* About to remove the currently displayed item (ticker, or just a reminder) */
 		InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
 		MoveToNextTickerItem();
+	}
 	delete ni;
 	SetWindowDirty(WC_MESSAGE_HISTORY, 0);
+}
 /**
  * Add a new newsitem to be shown.
  * @param string String to display
  * @param type news category
  * @param flags display flags for the news
  * @param reftype1 Type of ref1
  * @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.
  * @param reftype2 Type of ref2
  * @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.
  * @param free_data Pointer to data that must be freed once the news message is cleared
+ *
  * @see NewsSubtype
  */
 void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, void *free_data)
+{
 	if (_game_mode == GM_MENU) return;
 	/* Create new news item node */
 	NewsItem *ni = new NewsItem;
 	ni->string_id = string;
 	ni->type = type;
 	ni->flags = flags;
 	/* show this news message in colour? */
 	if (_cur_year >= _settings_client.gui.coloured_news_year) ni->flags |= NF_INCOLOUR;
 	ni->reftype1 = reftype1;
 	ni->reftype2 = reftype2;
 	ni->ref1 = ref1;
 	ni->ref2 = ref2;
 	ni->free_data = free_data;
 	ni->date = _date;
 	CopyOutDParam(ni->params, 0, lengthof(ni->params));
 	if (_total_news++ == 0) {
 		assert(_oldest_news == nullptr);
 		_oldest_news = ni;
 		ni->prev = nullptr;
 	} else {
 		assert(_latest_news->next == nullptr);
 		_latest_news->next = ni;
 		ni->prev = _latest_news;
+	}
 	ni->next = nullptr;
 	_latest_news = ni;
 	/* Keep the number of stored news items to a managable number */
 	if (_total_news > MAX_NEWS_AMOUNT) {
 		DeleteNewsItem(_oldest_news);
+	}
 	SetWindowDirty(WC_MESSAGE_HISTORY, 0);
+}
 /**
  * Create a new custom news item.
  * @param tile unused
  * @param flags type of operation
  * @param p1 various bitstuffed elements
  * - p1 = (bit  0 -  7) - NewsType of the message.
  * - p1 = (bit  8 - 15) - NewsReferenceType of first reference.
  * - p1 = (bit 16 - 23) - Company this news message is for.
  * @param p2 First reference of the news message.
  * @param text The text of the news message.
  * @return the cost of this operation or an error
  */
 CommandCost CmdCustomNewsItem(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
+{
 	if (_current_company != OWNER_DEITY) return CMD_ERROR;
 	NewsType type = (NewsType)GB(p1, 0, 8);
 	NewsReferenceType reftype1 = (NewsReferenceType)GB(p1, 8, 8);
 	CompanyID company = (CompanyID)GB(p1, 16, 8);
 	if (company != INVALID_OWNER && !Company::IsValidID(company)) return CMD_ERROR;
 	if (type >= NT_END) return CMD_ERROR;
 	if (StrEmpty(text)) return CMD_ERROR;
 	switch (reftype1) {
 		case NR_NONE: break;
 		case NR_TILE:
 			if (!IsValidTile(p2)) return CMD_ERROR;
 			break;
 		case NR_VEHICLE:
 			if (!Vehicle::IsValidID(p2)) return CMD_ERROR;
 			break;
 		case NR_STATION:
 			if (!Station::IsValidID(p2)) return CMD_ERROR;
 			break;
 		case NR_INDUSTRY:
 			if (!Industry::IsValidID(p2)) return CMD_ERROR;
 			break;
 		case NR_TOWN:
 			if (!Town::IsValidID(p2)) return CMD_ERROR;
 			break;
 		case NR_ENGINE:
 			if (!Engine::IsValidID(p2)) return CMD_ERROR;
 			break;
 		default: return CMD_ERROR;
+	}
 	if (company != INVALID_OWNER && company != _local_company) return CommandCost();
 	if (flags & DC_EXEC) {
 		char *news = stredup(text);
 		SetDParamStr(0, news);
 		AddNewsItem(STR_NEWS_CUSTOM_ITEM, type, NF_NORMAL, reftype1, p2, NR_NONE, UINT32_MAX, news);
+	}
 	return CommandCost();
+}
 /**
  * Delete a news item type about a vehicle.
  * When the news item type is INVALID_STRING_ID all news about the vehicle gets deleted.
  * @param vid  The vehicle to remove the news for.
  * @param news The news type to remove.
  */
 void DeleteVehicleNews(VehicleID vid, StringID news)
+{
 	NewsItem *ni = _oldest_news;
 	while (ni != nullptr) {
 		NewsItem *next = ni->next;
 		if (((ni->reftype1 == NR_VEHICLE && ni->ref1 == vid) || (ni->reftype2 == NR_VEHICLE && ni->ref2 == vid)) &&
 				(news == INVALID_STRING_ID || ni->string_id == news)) {
 			DeleteNewsItem(ni);
+		}
 		ni = next;
+	}
+}
 /**
  * Remove news regarding given station so there are no 'unknown station now accepts Mail'
  * or 'First train arrived at unknown station' news items.
  * @param sid station to remove news about
  */
 void DeleteStationNews(StationID sid)
+{
 	NewsItem *ni = _oldest_news;
 	while (ni != nullptr) {
 		NewsItem *next = ni->next;
 		if ((ni->reftype1 == NR_STATION && ni->ref1 == sid) || (ni->reftype2 == NR_STATION && ni->ref2 == sid)) {
 			DeleteNewsItem(ni);
+		}
 		ni = next;
+	}
+}
 /**
  * Remove news regarding given industry
  * @param iid industry to remove news about
  */
 void DeleteIndustryNews(IndustryID iid)
+{
 	NewsItem *ni = _oldest_news;
 	while (ni != nullptr) {
 		NewsItem *next = ni->next;
 		if ((ni->reftype1 == NR_INDUSTRY && ni->ref1 == iid) || (ni->reftype2 == NR_INDUSTRY && ni->ref2 == iid)) {
 			DeleteNewsItem(ni);
+		}
 		ni = next;
+	}
+}
 /**
  * Remove engine announcements for invalid engines.
  */
 void DeleteInvalidEngineNews()
+{
 	NewsItem *ni = _oldest_news;
 	while (ni != nullptr) {
 		NewsItem *next = ni->next;
 		if ((ni->reftype1 == NR_ENGINE && (!Engine::IsValidID(ni->ref1) || !Engine::Get(ni->ref1)->IsEnabled())) ||
 				(ni->reftype2 == NR_ENGINE && (!Engine::IsValidID(ni->ref2) || !Engine::Get(ni->ref2)->IsEnabled()))) {
 			DeleteNewsItem(ni);
+		}
 		ni = next;
+	}
+}
 static void RemoveOldNewsItems()
+{
 	NewsItem *next;
 	for (NewsItem *cur = _oldest_news; _total_news > MIN_NEWS_AMOUNT && cur != nullptr; cur = next) {
 		next = cur->next;
 		if (_date - _news_type_data[cur->type].age * _settings_client.gui.news_message_timeout > cur->date) DeleteNewsItem(cur);
+	}
+}
 /**
  * Report a change in vehicle IDs (due to autoreplace) to affected vehicle news.
  * @note Viewports of currently displayed news is changed via #ChangeVehicleViewports
  * @param from_index the old vehicle ID
  * @param to_index the new vehicle ID
  */
 void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
+{
 	for (NewsItem *ni = _oldest_news; ni != nullptr; ni = ni->next) {
 		if (ni->reftype1 == NR_VEHICLE && ni->ref1 == from_index) ni->ref1 = to_index;
 		if (ni->reftype2 == NR_VEHICLE && ni->ref2 == from_index) ni->ref2 = to_index;
 		if (ni->flags & NF_VEHICLE_PARAM0 && ni->params[0] == from_index) ni->params[0] = to_index;
+	}
+}
 void NewsLoop()
+{
 	/* no news item yet */
 	if (_total_news == 0) return;
 	static byte _last_clean_month = 0;
 	if (_last_clean_month != _cur_month) {
 		RemoveOldNewsItems();
 		_last_clean_month = _cur_month;
+	}
 	if (ReadyForNextTickerItem()) MoveToNextTickerItem();
 	if (ReadyForNextNewsItem()) MoveToNextNewsItem();
+}
 /** Do a forced show of a specific message */
 static void ShowNewsMessage(const NewsItem *ni)
+{
 	assert(_total_news != 0);
 	/* Delete the news window */
 	DeleteWindowById(WC_NEWS_WINDOW, 0);
 	/* setup forced news item */
 	_forced_news = ni;
 	if (_forced_news != nullptr) {
 		DeleteWindowById(WC_NEWS_WINDOW, 0);
 		ShowNewspaper(ni);
+	}
+}
 /**
  * Close active news message window
  * @return true if a window was closed.
  */
 bool HideActiveNewsMessage() {
 	NewsWindow *w = (NewsWindow*)FindWindowById(WC_NEWS_WINDOW, 0);
 	if (w == nullptr) return false;
 	delete w;
 	return true;
+}
 /** Show previous news item */
 void ShowLastNewsMessage()
+{
 	const NewsItem *ni = nullptr;
 	if (_total_news == 0) {
 		return;
 	} else if (_forced_news == nullptr) {
 		/* Not forced any news yet, show the current one, unless a news window is
 		 * open (which can only be the current one), then show the previous item */
 		if (_current_news == nullptr) {
 			/* No news were shown yet resp. the last shown one was already deleted.
 			 * Threat this as if _forced_news reached _oldest_news; so, wrap around and start anew with the latest. */
 			ni = _latest_news;
 		} else {
 			const Window *w = FindWindowById(WC_NEWS_WINDOW, 0);
 			ni = (w == nullptr || (_current_news == _oldest_news)) ? _current_news : _current_news->prev;
+		}
 	} else if (_forced_news == _oldest_news) {
 		/* We have reached the oldest news, start anew with the latest */
 		ni = _latest_news;
 	} else {
 		/* 'Scrolling' through news history show each one in turn */
 		ni = _forced_news->prev;
+	}
 	bool wrap = false;
 	for (;;) {
 		if (_news_type_data[ni->type].GetDisplay() != ND_OFF) {
 			ShowNewsMessage(ni);
 			break;
+		}
 		ni = ni->prev;
 		if (ni == nullptr) {
 			if (wrap) break;
 			/* We have reached the oldest news, start anew with the latest */
 			ni = _latest_news;
 			wrap = true;
+		}
+	}
+}
 /**
  * Draw an unformatted news message truncated to a maximum length. If
  * length exceeds maximum length it will be postfixed by '...'
  * @param left  the left most location for the string
  * @param right the right most location for the string
  * @param y position of the string
  * @param colour the colour the string will be shown in
  * @param *ni NewsItem being printed
  */
 static void DrawNewsString(uint left, uint right, int y, TextColour colour, const NewsItem *ni)
+{
 	char buffer[512], buffer2[512];
 	StringID str;
 	CopyInDParam(0, ni->params, lengthof(ni->params));
 	str = ni->string_id;
 	GetString(buffer, str, lastof(buffer));
 	/* Copy the just gotten string to another buffer to remove any formatting
 	 * from it such as big fonts, etc. */
 	const char *ptr = buffer;
 	char *dest = buffer2;
 	WChar c_last = '\0';
 	for (;;) {
 		WChar c = Utf8Consume(&ptr);
 		if (c == 0) break;
 		/* Make a space from a newline, but ignore multiple newlines */
 		if (c == '\n' && c_last != '\n') {
 			dest[0] = ' ';
 			dest++;
 		} else if (c == '\r') {
 			dest[0] = dest[1] = dest[2] = dest[3] = ' ';
 			dest += 4;
 		} else if (IsPrintable(c)) {
 			dest += Utf8Encode(dest, c);
+		}
 		c_last = c;
+	}
 	*dest = '\0';
 	/* Truncate and show string; postfixed by '...' if necessary */
 	DrawString(left, right, y, buffer2, colour);
+}
 struct MessageHistoryWindow : Window {
 	static const int top_spacing;    ///< Additional spacing at the top of the #WID_MH_BACKGROUND widget.
 	static const int bottom_spacing; ///< Additional spacing at the bottom of the #WID_MH_BACKGROUND widget.
 	int line_height; /// < Height of a single line in the news history window including spacing.
 	int date_width;  /// < Width needed for the date part.
 	Scrollbar *vscroll;
 	MessageHistoryWindow(WindowDesc *desc) : Window(desc)
+	{
 		this->CreateNestedTree();
 		this->vscroll = this->GetScrollbar(WID_MH_SCROLLBAR);
 		this->FinishInitNested(); // Initializes 'this->line_height' and 'this->date_width'.
 		this->OnInvalidateData(0);
+	}
 	void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
+	{
 		if (widget == WID_MH_BACKGROUND) {
 			this->line_height = FONT_HEIGHT_NORMAL + 2;
 			resize->height = this->line_height;
 			/* Months are off-by-one, so it's actually 8. Not using
 			 * month 12 because the 1 is usually less wide. */
 			SetDParam(0, ConvertYMDToDate(ORIGINAL_MAX_YEAR, 7, 30));
 			this->date_width = GetStringBoundingBox(STR_SHORT_DATE).width;
 			size->height = 4 * resize->height + this->top_spacing + this->bottom_spacing; // At least 4 lines are visible.
 			size->width = std::max(200u, size->width); // At least 200 pixels wide.

0 comments (0 inline, 0 general)