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/>.
10 /** @file error_gui.cpp GUI related to errors. */
13 #include "landscape.h"
14 #include "newgrf_text.h"
16 #include "viewport_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"
27 #include "widgets/error_widget.h"
29 #include "table/strings.h"
32 static const NWidgetPart _nested_errmsg_widgets
[] = {
33 NWidget(NWID_HORIZONTAL
),
34 NWidget(WWT_CLOSEBOX
, COLOUR_RED
),
35 NWidget(WWT_CAPTION
, COLOUR_RED
, WID_EM_CAPTION
), SetDataTip(STR_ERROR_MESSAGE_CAPTION
, STR_NULL
),
37 NWidget(WWT_PANEL
, COLOUR_RED
),
38 NWidget(WWT_EMPTY
, COLOUR_RED
, WID_EM_MESSAGE
), SetPadding(0, 2, 0, 2), SetMinimalSize(236, 32),
42 static WindowDesc
_errmsg_desc(
43 WDP_MANUAL
, "error", 0, 0,
46 _nested_errmsg_widgets
, lengthof(_nested_errmsg_widgets
)
49 static const NWidgetPart _nested_errmsg_face_widgets
[] = {
50 NWidget(NWID_HORIZONTAL
),
51 NWidget(WWT_CLOSEBOX
, COLOUR_RED
),
52 NWidget(WWT_CAPTION
, COLOUR_RED
, WID_EM_CAPTION
), SetDataTip(STR_ERROR_MESSAGE_CAPTION_OTHER_COMPANY
, STR_NULL
),
54 NWidget(WWT_PANEL
, COLOUR_RED
),
55 NWidget(NWID_HORIZONTAL
), SetPIP(2, 1, 2),
56 NWidget(WWT_EMPTY
, COLOUR_RED
, WID_EM_FACE
), SetMinimalSize(92, 119), SetFill(0, 1), SetPadding(2, 0, 1, 0),
57 NWidget(WWT_EMPTY
, COLOUR_RED
, WID_EM_MESSAGE
), SetFill(0, 1), SetMinimalSize(238, 123),
62 static WindowDesc
_errmsg_face_desc(
63 WDP_MANUAL
, "error_face", 0, 0,
66 _nested_errmsg_face_widgets
, lengthof(_nested_errmsg_face_widgets
)
70 * Copy the given data into our instance.
71 * @param data The data to copy.
73 ErrorMessageData::ErrorMessageData(const ErrorMessageData
&data
)
76 for (size_t i
= 0; i
< lengthof(this->strings
); i
++) {
77 if (this->strings
[i
] != NULL
) {
78 this->strings
[i
] = strdup(this->strings
[i
]);
79 this->decode_params
[i
] = (size_t)this->strings
[i
];
84 /** Free all the strings. */
85 ErrorMessageData::~ErrorMessageData()
87 for (size_t i
= 0; i
< lengthof(this->strings
); i
++) free(this->strings
[i
]);
91 * Display an error message in a window.
92 * @param summary_msg General error message showed in first line. Must be valid.
93 * @param detailed_msg Detailed error message showed in second line. Can be INVALID_STRING_ID.
94 * @param duration The amount of time to show this error message.
95 * @param x World X position (TileVirtX) of the error location. Set both x and y to 0 to just center the message when there is no related error tile.
96 * @param y World Y position (TileVirtY) of the error location. Set both x and y to 0 to just center the message when there is no related error tile.
97 * @param textref_stack_size Number of uint32 values to put on the #TextRefStack for the error message; 0 if the #TextRefStack shall not be used.
98 * @param textref_stack Values to put on the #TextRefStack.
100 ErrorMessageData::ErrorMessageData(StringID summary_msg
, StringID detailed_msg
, uint duration
, int x
, int y
, uint textref_stack_size
, const uint32
*textref_stack
) :
102 textref_stack_size(textref_stack_size
),
103 summary_msg(summary_msg
),
104 detailed_msg(detailed_msg
),
105 face(INVALID_COMPANY
)
107 this->position
.x
= x
;
108 this->position
.y
= y
;
110 memset(this->decode_params
, 0, sizeof(this->decode_params
));
111 memset(this->strings
, 0, sizeof(this->strings
));
113 if (textref_stack_size
> 0) MemCpyT(this->textref_stack
, textref_stack
, textref_stack_size
);
115 assert(summary_msg
!= INVALID_STRING_ID
);
119 * Copy error parameters from current DParams.
121 void ErrorMessageData::CopyOutDParams()
123 /* Reset parameters */
124 for (size_t i
= 0; i
< lengthof(this->strings
); i
++) free(this->strings
[i
]);
125 memset(this->decode_params
, 0, sizeof(this->decode_params
));
126 memset(this->strings
, 0, sizeof(this->strings
));
128 /* Get parameters using type information */
129 if (this->textref_stack_size
> 0) StartTextRefStackUsage(this->textref_stack_size
, this->textref_stack
);
130 CopyOutDParam(this->decode_params
, this->strings
, this->detailed_msg
== INVALID_STRING_ID
? this->summary_msg
: this->detailed_msg
, lengthof(this->decode_params
));
131 if (this->textref_stack_size
> 0) StopTextRefStackUsage();
133 if (this->detailed_msg
== STR_ERROR_OWNED_BY
) {
134 CompanyID company
= (CompanyID
)GetDParamX(this->decode_params
, 2);
135 if (company
< MAX_COMPANIES
) face
= company
;
140 * Set a error string parameter.
141 * @param n Parameter index
142 * @param v Parameter value
144 void ErrorMessageData::SetDParam(uint n
, uint64 v
)
146 this->decode_params
[n
] = v
;
150 * Set a rawstring parameter.
151 * @param n Parameter index
152 * @param str Raw string
154 void ErrorMessageData::SetDParamStr(uint n
, const char *str
)
156 free(this->strings
[n
]);
157 this->strings
[n
] = strdup(str
);
160 /** Define a queue with errors. */
161 typedef std::list
<ErrorMessageData
> ErrorList
;
162 /** The actual queue with errors. */
163 ErrorList _error_list
;
164 /** Whether the window system is initialized or not. */
165 bool _window_system_initialized
= false;
167 /** Window class for displaying an error message window. */
168 struct ErrmsgWindow
: public Window
, ErrorMessageData
{
170 uint height_summary
; ///< Height of the #summary_msg string in pixels in the #WID_EM_MESSAGE widget.
171 uint height_detailed
; ///< Height of the #detailed_msg string in pixels in the #WID_EM_MESSAGE widget.
174 ErrmsgWindow(const ErrorMessageData
&data
) : Window(data
.HasFace() ? &_errmsg_face_desc
: &_errmsg_desc
), ErrorMessageData(data
)
179 virtual void UpdateWidgetSize(int widget
, Dimension
*size
, const Dimension
&padding
, Dimension
*fill
, Dimension
*resize
)
181 if (widget
!= WID_EM_MESSAGE
) return;
183 CopyInDParam(0, this->decode_params
, lengthof(this->decode_params
));
184 if (this->textref_stack_size
> 0) StartTextRefStackUsage(this->textref_stack_size
, this->textref_stack
);
186 int text_width
= max(0, (int)size
->width
- WD_FRAMETEXT_LEFT
- WD_FRAMETEXT_RIGHT
);
187 this->height_summary
= GetStringHeight(this->summary_msg
, text_width
);
188 this->height_detailed
= (this->detailed_msg
== INVALID_STRING_ID
) ? 0 : GetStringHeight(this->detailed_msg
, text_width
);
190 if (this->textref_stack_size
> 0) StopTextRefStackUsage();
192 uint panel_height
= WD_FRAMERECT_TOP
+ this->height_summary
+ WD_FRAMERECT_BOTTOM
;
193 if (this->detailed_msg
!= INVALID_STRING_ID
) panel_height
+= this->height_detailed
+ WD_PAR_VSEP_WIDE
;
195 size
->height
= max(size
->height
, panel_height
);
198 virtual Point
OnInitialPosition(int16 sm_width
, int16 sm_height
, int window_number
)
200 /* Position (0, 0) given, center the window. */
201 if (this->position
.x
== 0 && this->position
.y
== 0) {
202 Point pt
= {(_screen
.width
- sm_width
) >> 1, (_screen
.height
- sm_height
) >> 1};
206 /* Find the free screen space between the main toolbar at the top, and the statusbar at the bottom.
207 * Add a fixed distance 20 to make it less cluttered.
209 int scr_top
= GetMainViewTop() + 20;
210 int scr_bot
= GetMainViewBottom() - 20;
212 Point pt
= RemapCoords2(this->position
.x
, this->position
.y
);
213 const ViewPort
*vp
= FindWindowById(WC_MAIN_WINDOW
, 0)->viewport
;
214 if (this->face
== INVALID_COMPANY
) {
215 /* move x pos to opposite corner */
216 pt
.x
= UnScaleByZoom(pt
.x
- vp
->virtual_left
, vp
->zoom
) + vp
->left
;
217 pt
.x
= (pt
.x
< (_screen
.width
>> 1)) ? _screen
.width
- sm_width
- 20 : 20; // Stay 20 pixels away from the edge of the screen.
219 /* move y pos to opposite corner */
220 pt
.y
= UnScaleByZoom(pt
.y
- vp
->virtual_top
, vp
->zoom
) + vp
->top
;
221 pt
.y
= (pt
.y
< (_screen
.height
>> 1)) ? scr_bot
- sm_height
: scr_top
;
223 pt
.x
= Clamp(UnScaleByZoom(pt
.x
- vp
->virtual_left
, vp
->zoom
) + vp
->left
- (sm_width
/ 2), 0, _screen
.width
- sm_width
);
224 pt
.y
= Clamp(UnScaleByZoom(pt
.y
- vp
->virtual_top
, vp
->zoom
) + vp
->top
- (sm_height
/ 2), scr_top
, scr_bot
- sm_height
);
230 * Some data on this window has become invalid.
231 * @param data Information about the changed data.
232 * @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.
234 virtual void OnInvalidateData(int data
= 0, bool gui_scope
= true)
236 /* If company gets shut down, while displaying an error about it, remove the error message. */
237 if (this->face
!= INVALID_COMPANY
&& !Company::IsValidID(this->face
)) delete this;
240 virtual void SetStringParameters(int widget
) const
242 if (widget
== WID_EM_CAPTION
) CopyInDParam(0, this->decode_params
, lengthof(this->decode_params
));
245 virtual void DrawWidget(const Rect
&r
, int widget
) const
249 const Company
*c
= Company::Get(this->face
);
250 DrawCompanyManagerFace(c
->face
, c
->colour
, r
.left
, r
.top
);
255 CopyInDParam(0, this->decode_params
, lengthof(this->decode_params
));
256 if (this->textref_stack_size
> 0) StartTextRefStackUsage(this->textref_stack_size
, this->textref_stack
);
258 if (this->detailed_msg
== INVALID_STRING_ID
) {
259 DrawStringMultiLine(r
.left
+ WD_FRAMETEXT_LEFT
, r
.right
- WD_FRAMETEXT_RIGHT
, r
.top
+ WD_FRAMERECT_TOP
, r
.bottom
- WD_FRAMERECT_BOTTOM
,
260 this->summary_msg
, TC_FROMSTRING
, SA_CENTER
);
262 int extra
= (r
.bottom
- r
.top
+ 1 - this->height_summary
- this->height_detailed
- WD_PAR_VSEP_WIDE
) / 2;
264 /* Note: NewGRF supplied error message often do not start with a colour code, so default to white. */
265 int top
= r
.top
+ WD_FRAMERECT_TOP
;
266 int bottom
= top
+ this->height_summary
+ extra
;
267 DrawStringMultiLine(r
.left
+ WD_FRAMETEXT_LEFT
, r
.right
- WD_FRAMETEXT_RIGHT
, top
, bottom
, this->summary_msg
, TC_WHITE
, SA_CENTER
);
269 bottom
= r
.bottom
- WD_FRAMERECT_BOTTOM
;
270 top
= bottom
- this->height_detailed
- extra
;
271 DrawStringMultiLine(r
.left
+ WD_FRAMETEXT_LEFT
, r
.right
- WD_FRAMETEXT_RIGHT
, top
, bottom
, this->detailed_msg
, TC_WHITE
, SA_CENTER
);
274 if (this->textref_stack_size
> 0) StopTextRefStackUsage();
282 virtual void OnMouseLoop()
284 /* Disallow closing the window too easily, if timeout is disabled */
285 if (_right_button_down
&& this->duration
!= 0) delete this;
288 virtual void OnHundredthTick()
290 /* Timeout enabled? */
291 if (this->duration
!= 0) {
293 if (this->duration
== 0) delete this;
299 SetRedErrorSquare(INVALID_TILE
);
300 if (_window_system_initialized
) ShowFirstError();
303 virtual EventState
OnKeyPress(WChar key
, uint16 keycode
)
305 if (keycode
!= WKC_SPACE
) return ES_NOT_HANDLED
;
311 * Check whether the currently shown error message was critical or not.
312 * @return True iff the message was critical.
316 return this->duration
== 0;
321 * Clear all errors from the queue.
323 void ClearErrorMessages()
325 UnshowCriticalError();
329 /** Show the first error of the queue. */
330 void ShowFirstError()
332 _window_system_initialized
= true;
333 if (!_error_list
.empty()) {
334 new ErrmsgWindow(_error_list
.front());
335 _error_list
.pop_front();
340 * Unshow the critical error. This has to happen when a critical
341 * error is shown and we uninitialise the window system, i.e.
342 * remove all the windows.
344 void UnshowCriticalError()
346 ErrmsgWindow
*w
= (ErrmsgWindow
*)FindWindowById(WC_ERRMSG
, 0);
347 if (_window_system_initialized
&& w
!= NULL
) {
348 if (w
->IsCritical()) _error_list
.push_front(*w
);
349 _window_system_initialized
= false;
355 * Display an error message in a window.
356 * @param summary_msg General error message showed in first line. Must be valid.
357 * @param detailed_msg Detailed error message showed in second line. Can be INVALID_STRING_ID.
358 * @param wl Message severity.
359 * @param x World X position (TileVirtX) of the error location. Set both x and y to 0 to just center the message when there is no related error tile.
360 * @param y World Y position (TileVirtY) of the error location. Set both x and y to 0 to just center the message when there is no related error tile.
361 * @param textref_stack_size Number of uint32 values to put on the #TextRefStack for the error message; 0 if the #TextRefStack shall not be used.
362 * @param textref_stack Values to put on the #TextRefStack.
364 void ShowErrorMessage(StringID summary_msg
, StringID detailed_msg
, WarningLevel wl
, int x
, int y
, uint textref_stack_size
, const uint32
*textref_stack
)
366 assert(textref_stack_size
== 0 || textref_stack
!= NULL
);
367 if (summary_msg
== STR_NULL
) summary_msg
= STR_EMPTY
;
370 /* Print message to console */
371 char buf
[DRAW_STRING_BUFFER
];
373 if (textref_stack_size
> 0) StartTextRefStackUsage(textref_stack_size
, textref_stack
);
375 char *b
= GetString(buf
, summary_msg
, lastof(buf
));
376 if (detailed_msg
!= INVALID_STRING_ID
) {
377 b
+= seprintf(b
, lastof(buf
), " ");
378 GetString(b
, detailed_msg
, lastof(buf
));
381 if (textref_stack_size
> 0) StopTextRefStackUsage();
384 case WL_WARNING
: IConsolePrint(CC_WARNING
, buf
); break;
385 default: IConsoleError(buf
); break;
389 bool no_timeout
= wl
== WL_CRITICAL
;
391 if (_settings_client
.gui
.errmsg_duration
== 0 && !no_timeout
) return;
393 ErrorMessageData
data(summary_msg
, detailed_msg
, no_timeout
? 0 : _settings_client
.gui
.errmsg_duration
, x
, y
, textref_stack_size
, textref_stack
);
394 data
.CopyOutDParams();
396 ErrmsgWindow
*w
= (ErrmsgWindow
*)FindWindowById(WC_ERRMSG
, 0);
397 if (w
!= NULL
&& w
->IsCritical()) {
398 /* A critical error is currently shown. */
399 if (wl
== WL_CRITICAL
) {
400 /* Push another critical error in the queue of errors,
401 * but do not put other errors in the queue. */
402 _error_list
.push_back(data
);
405 /* Nothing or a non-critical error was shown. */
407 new ErrmsgWindow(data
);
412 * Schedule a list of errors.
413 * Note: This does not try to display the error now. This is useful if the window system is not yet running.
414 * @param data Error message datas; cleared afterwards
416 void ScheduleErrorMessage(ErrorList
&datas
)
418 _error_list
.splice(_error_list
.end(), datas
);
423 * Note: This does not try to display the error now. This is useful if the window system is not yet running.
424 * @param data Error message data; cleared afterwards
426 void ScheduleErrorMessage(const ErrorMessageData
&data
)
428 _error_list
.push_back(data
);