OpenTTD
error_gui.cpp
Go to the documentation of this file.
1 /* $Id: error_gui.cpp 27307 2015-06-20 12:57:34Z frosch $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "landscape.h"
14 #include "newgrf_text.h"
15 #include "error.h"
16 #include "viewport_func.h"
17 #include "gfx_func.h"
18 #include "string_func.h"
19 #include "company_base.h"
20 #include "company_manager_face.h"
21 #include "strings_func.h"
22 #include "zoom_func.h"
23 #include "window_func.h"
24 #include "console_func.h"
25 #include "window_gui.h"
26 
27 #include "widgets/error_widget.h"
28 
29 #include "table/strings.h"
30 #include <list>
31 
32 #include "safeguards.h"
33 
34 static const NWidgetPart _nested_errmsg_widgets[] = {
36  NWidget(WWT_CLOSEBOX, COLOUR_RED),
37  NWidget(WWT_CAPTION, COLOUR_RED, WID_EM_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION, STR_NULL),
38  EndContainer(),
39  NWidget(WWT_PANEL, COLOUR_RED),
40  NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_MESSAGE), SetPadding(0, 2, 0, 2), SetMinimalSize(236, 32),
41  EndContainer(),
42 };
43 
44 static WindowDesc _errmsg_desc(
45  WDP_MANUAL, "error", 0, 0,
47  0,
48  _nested_errmsg_widgets, lengthof(_nested_errmsg_widgets)
49 );
50 
51 static const NWidgetPart _nested_errmsg_face_widgets[] = {
53  NWidget(WWT_CLOSEBOX, COLOUR_RED),
54  NWidget(WWT_CAPTION, COLOUR_RED, WID_EM_CAPTION), SetDataTip(STR_ERROR_MESSAGE_CAPTION_OTHER_COMPANY, STR_NULL),
55  EndContainer(),
56  NWidget(WWT_PANEL, COLOUR_RED),
57  NWidget(NWID_HORIZONTAL), SetPIP(2, 1, 2),
58  NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_FACE), SetMinimalSize(92, 119), SetFill(0, 1), SetPadding(2, 0, 1, 0),
59  NWidget(WWT_EMPTY, COLOUR_RED, WID_EM_MESSAGE), SetFill(0, 1), SetMinimalSize(238, 123),
60  EndContainer(),
61  EndContainer(),
62 };
63 
64 static WindowDesc _errmsg_face_desc(
65  WDP_MANUAL, "error_face", 0, 0,
67  0,
68  _nested_errmsg_face_widgets, lengthof(_nested_errmsg_face_widgets)
69 );
70 
76 {
77  *this = data;
78  for (size_t i = 0; i < lengthof(this->strings); i++) {
79  if (this->strings[i] != NULL) {
80  this->strings[i] = stredup(this->strings[i]);
81  this->decode_params[i] = (size_t)this->strings[i];
82  }
83  }
84 }
85 
88 {
89  for (size_t i = 0; i < lengthof(this->strings); i++) free(this->strings[i]);
90 }
91 
103 ErrorMessageData::ErrorMessageData(StringID summary_msg, StringID detailed_msg, uint duration, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32 *textref_stack) :
104  duration(duration),
105  textref_stack_grffile(textref_stack_grffile),
106  textref_stack_size(textref_stack_size),
107  summary_msg(summary_msg),
108  detailed_msg(detailed_msg),
109  face(INVALID_COMPANY)
110 {
111  this->position.x = x;
112  this->position.y = y;
113 
114  memset(this->decode_params, 0, sizeof(this->decode_params));
115  memset(this->strings, 0, sizeof(this->strings));
116 
117  if (textref_stack_size > 0) MemCpyT(this->textref_stack, textref_stack, textref_stack_size);
118 
119  assert(summary_msg != INVALID_STRING_ID);
120 }
121 
126 {
127  /* Reset parameters */
128  for (size_t i = 0; i < lengthof(this->strings); i++) free(this->strings[i]);
129  memset(this->decode_params, 0, sizeof(this->decode_params));
130  memset(this->strings, 0, sizeof(this->strings));
131 
132  /* Get parameters using type information */
135  if (this->textref_stack_size > 0) StopTextRefStackUsage();
136 
137  if (this->detailed_msg == STR_ERROR_OWNED_BY) {
138  CompanyID company = (CompanyID)GetDParamX(this->decode_params, 2);
139  if (company < MAX_COMPANIES) face = company;
140  }
141 }
142 
148 void ErrorMessageData::SetDParam(uint n, uint64 v)
149 {
150  this->decode_params[n] = v;
151 }
152 
158 void ErrorMessageData::SetDParamStr(uint n, const char *str)
159 {
160  free(this->strings[n]);
161  this->strings[n] = stredup(str);
162 }
163 
165 typedef std::list<ErrorMessageData> ErrorList;
167 ErrorList _error_list;
170 
173 private:
176 
177 public:
178  ErrmsgWindow(const ErrorMessageData &data) : Window(data.HasFace() ? &_errmsg_face_desc : &_errmsg_desc), ErrorMessageData(data)
179  {
180  this->InitNested();
181  }
182 
183  virtual void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize)
184  {
185  switch (widget) {
186  case WID_EM_MESSAGE: {
189 
190  int text_width = max(0, (int)size->width - WD_FRAMETEXT_LEFT - WD_FRAMETEXT_RIGHT);
191  this->height_summary = GetStringHeight(this->summary_msg, text_width);
192  this->height_detailed = (this->detailed_msg == INVALID_STRING_ID) ? 0 : GetStringHeight(this->detailed_msg, text_width);
193 
194  if (this->textref_stack_size > 0) StopTextRefStackUsage();
195 
196  uint panel_height = WD_FRAMERECT_TOP + this->height_summary + WD_FRAMERECT_BOTTOM;
197  if (this->detailed_msg != INVALID_STRING_ID) panel_height += this->height_detailed + WD_PAR_VSEP_WIDE;
198 
199  size->height = max(size->height, panel_height);
200  break;
201  }
202  case WID_EM_FACE: {
203  Dimension face_size = GetSpriteSize(SPR_GRADIENT);
204  size->width = max(size->width, face_size.width);
205  size->height = max(size->height, face_size.height);
206  break;
207  }
208  }
209  }
210 
211  virtual Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number)
212  {
213  /* Position (0, 0) given, center the window. */
214  if (this->position.x == 0 && this->position.y == 0) {
215  Point pt = {(_screen.width - sm_width) >> 1, (_screen.height - sm_height) >> 1};
216  return pt;
217  }
218 
219  /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
220  * Add a fixed distance 20 to make it less cluttered.
221  */
222  int scr_top = GetMainViewTop() + 20;
223  int scr_bot = GetMainViewBottom() - 20;
224 
225  Point pt = RemapCoords2(this->position.x, this->position.y);
227  if (this->face == INVALID_COMPANY) {
228  /* move x pos to opposite corner */
229  pt.x = UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left;
230  pt.x = (pt.x < (_screen.width >> 1)) ? _screen.width - sm_width - 20 : 20; // Stay 20 pixels away from the edge of the screen.
231 
232  /* move y pos to opposite corner */
233  pt.y = UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top;
234  pt.y = (pt.y < (_screen.height >> 1)) ? scr_bot - sm_height : scr_top;
235  } else {
236  pt.x = Clamp(UnScaleByZoom(pt.x - vp->virtual_left, vp->zoom) + vp->left - (sm_width / 2), 0, _screen.width - sm_width);
237  pt.y = Clamp(UnScaleByZoom(pt.y - vp->virtual_top, vp->zoom) + vp->top - (sm_height / 2), scr_top, scr_bot - sm_height);
238  }
239  return pt;
240  }
241 
247  virtual void OnInvalidateData(int data = 0, bool gui_scope = true)
248  {
249  /* If company gets shut down, while displaying an error about it, remove the error message. */
250  if (this->face != INVALID_COMPANY && !Company::IsValidID(this->face)) delete this;
251  }
252 
253  virtual void SetStringParameters(int widget) const
254  {
255  if (widget == WID_EM_CAPTION) CopyInDParam(0, this->decode_params, lengthof(this->decode_params));
256  }
257 
258  virtual void DrawWidget(const Rect &r, int widget) const
259  {
260  switch (widget) {
261  case WID_EM_FACE: {
262  const Company *c = Company::Get(this->face);
263  DrawCompanyManagerFace(c->face, c->colour, r.left, r.top);
264  break;
265  }
266 
267  case WID_EM_MESSAGE:
270 
271  if (this->detailed_msg == INVALID_STRING_ID) {
273  this->summary_msg, TC_FROMSTRING, SA_CENTER);
274  } else {
275  int extra = (r.bottom - r.top + 1 - this->height_summary - this->height_detailed - WD_PAR_VSEP_WIDE) / 2;
276 
277  /* Note: NewGRF supplied error message often do not start with a colour code, so default to white. */
278  int top = r.top + WD_FRAMERECT_TOP;
279  int bottom = top + this->height_summary + extra;
280  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, top, bottom, this->summary_msg, TC_WHITE, SA_CENTER);
281 
282  bottom = r.bottom - WD_FRAMERECT_BOTTOM;
283  top = bottom - this->height_detailed - extra;
284  DrawStringMultiLine(r.left + WD_FRAMETEXT_LEFT, r.right - WD_FRAMETEXT_RIGHT, top, bottom, this->detailed_msg, TC_WHITE, SA_CENTER);
285  }
286 
287  if (this->textref_stack_size > 0) StopTextRefStackUsage();
288  break;
289 
290  default:
291  break;
292  }
293  }
294 
295  virtual void OnMouseLoop()
296  {
297  /* Disallow closing the window too easily, if timeout is disabled */
298  if (_right_button_down && this->duration != 0) delete this;
299  }
300 
301  virtual void OnHundredthTick()
302  {
303  /* Timeout enabled? */
304  if (this->duration != 0) {
305  this->duration--;
306  if (this->duration == 0) delete this;
307  }
308  }
309 
310  ~ErrmsgWindow()
311  {
313  if (_window_system_initialized) ShowFirstError();
314  }
315 
316  virtual EventState OnKeyPress(WChar key, uint16 keycode)
317  {
318  if (keycode != WKC_SPACE) return ES_NOT_HANDLED;
319  delete this;
320  return ES_HANDLED;
321  }
322 
327  bool IsCritical()
328  {
329  return this->duration == 0;
330  }
331 };
332 
337 {
339  _error_list.clear();
340 }
341 
344 {
345  _window_system_initialized = true;
346  if (!_error_list.empty()) {
347  new ErrmsgWindow(_error_list.front());
348  _error_list.pop_front();
349  }
350 }
351 
358 {
360  if (_window_system_initialized && w != NULL) {
361  if (w->IsCritical()) _error_list.push_front(*w);
362  _window_system_initialized = false;
363  delete w;
364  }
365 }
366 
378 void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x, int y, const GRFFile *textref_stack_grffile, uint textref_stack_size, const uint32 *textref_stack)
379 {
380  assert(textref_stack_size == 0 || (textref_stack_grffile != NULL && textref_stack != NULL));
381  if (summary_msg == STR_NULL) summary_msg = STR_EMPTY;
382 
383  if (wl != WL_INFO) {
384  /* Print message to console */
385  char buf[DRAW_STRING_BUFFER];
386 
387  if (textref_stack_size > 0) StartTextRefStackUsage(textref_stack_grffile, textref_stack_size, textref_stack);
388 
389  char *b = GetString(buf, summary_msg, lastof(buf));
390  if (detailed_msg != INVALID_STRING_ID) {
391  b += seprintf(b, lastof(buf), " ");
392  GetString(b, detailed_msg, lastof(buf));
393  }
394 
395  if (textref_stack_size > 0) StopTextRefStackUsage();
396 
397  switch (wl) {
398  case WL_WARNING: IConsolePrint(CC_WARNING, buf); break;
399  default: IConsoleError(buf); break;
400  }
401  }
402 
403  bool no_timeout = wl == WL_CRITICAL;
404 
405  if (_settings_client.gui.errmsg_duration == 0 && !no_timeout) return;
406 
407  ErrorMessageData data(summary_msg, detailed_msg, no_timeout ? 0 : _settings_client.gui.errmsg_duration, x, y, textref_stack_grffile, textref_stack_size, textref_stack);
408  data.CopyOutDParams();
409 
411  if (w != NULL && w->IsCritical()) {
412  /* A critical error is currently shown. */
413  if (wl == WL_CRITICAL) {
414  /* Push another critical error in the queue of errors,
415  * but do not put other errors in the queue. */
416  _error_list.push_back(data);
417  }
418  } else {
419  /* Nothing or a non-critical error was shown. */
420  delete w;
421  new ErrmsgWindow(data);
422  }
423 }
424 
430 void ScheduleErrorMessage(ErrorList &datas)
431 {
432  _error_list.splice(_error_list.end(), datas);
433 }
434 
441 {
442  _error_list.push_back(data);
443 }