OpenTTD Source: src/error.h Source File

OpenTTD Source 13.2.1

error.h
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
10 #ifndef ERROR_H
11 #define ERROR_H
12
13 #include "strings_type.h"
14 #include "company_type.h"
15 #include "core/geometry_type.hpp"
16 #include "guitimer_func.h"
17
18 struct GRFFile;
19
21 enum WarningLevel {
22 WL_INFO,
23 WL_WARNING,
24 WL_ERROR,
25 WL_CRITICAL,
26 };
27
29 class ErrorMessageData {
30 protected:
31 GUITimer display_timer;
32 uint64 decode_params[20];
33 const char *strings[20];
34 const GRFFile *textref_stack_grffile;
35 uint textref_stack_size;
36 uint32 textref_stack[16];
37 StringID summary_msg;
38 StringID detailed_msg;
39 Point position;
40 CompanyID face;
41
42 public:
43 ErrorMessageData(const ErrorMessageData &data);
44 ~ErrorMessageData();
45 ErrorMessageData(StringID summary_msg, StringID detailed_msg, uint duration = 0, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = nullptr, uint textref_stack_size = 0, const uint32 *textref_stack = nullptr);
46
47 /* Remove the copy assignment, as the default implementation will not do the right thing. */
48 ErrorMessageData &operator=(ErrorMessageData &rhs) = delete;
49
51 bool HasFace() const { return face != INVALID_COMPANY; }
52
53 void SetDParam(uint n, uint64 v);
54 void SetDParamStr(uint n, const char *str);
55 void SetDParamStr(uint n, const std::string &str);
56
57 void CopyOutDParams();
58 };
59
60 void ScheduleErrorMessage(const ErrorMessageData &data);
61
62 void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = nullptr, uint textref_stack_size = 0, const uint32 *textref_stack = nullptr);
63 bool HideActiveErrorMessage();
64
65 void ClearErrorMessages();
66 void ShowFirstError();
67 void UnshowCriticalError();
68
69 #endif /* ERROR_H */
ErrorMessageData::position
Point position
Position of the error message window.
Definition: error.h:39
ShowFirstError
void ShowFirstError()
Show the first error of the queue.
Definition: error_gui.cpp:342
ErrorMessageData::textref_stack_grffile
const GRFFile * textref_stack_grffile
NewGRF that filled the TextRefStack for the error message.
Definition: error.h:34
ErrorMessageData::textref_stack_size
uint textref_stack_size
Number of uint32 values to put on the TextRefStack for the error message.
Definition: error.h:35
ErrorMessageData::SetDParamStr
void SetDParamStr(uint n, const char *str)
Set a rawstring parameter.
Definition: error_gui.cpp:161
WarningLevel
WarningLevel
Message severity/type.
Definition: error.h:21
WL_WARNING
@ WL_WARNING
Other information.
Definition: error.h:23
guitimer_func.h
ErrorMessageData::decode_params
uint64 decode_params[20]
Parameters of the message strings.
Definition: error.h:32
ErrorMessageData::~ErrorMessageData
~ErrorMessageData()
Free all the strings.
Definition: error_gui.cpp:89
ErrorMessageData::CopyOutDParams
void CopyOutDParams()
Copy error parameters from current DParams.
Definition: error_gui.cpp:128
strings_type.h
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:377
geometry_type.hpp
HideActiveErrorMessage
bool HideActiveErrorMessage()
Close active error message window.
Definition: error_gui.cpp:429
GUITimer
Definition: guitimer_func.h:13
ClearErrorMessages
void ClearErrorMessages()
Clear all errors from the queue.
Definition: error_gui.cpp:335
ErrorMessageData::textref_stack
uint32 textref_stack[16]
Values to put on the TextRefStack for the error message.
Definition: error.h:36
ErrorMessageData::SetDParam
void SetDParam(uint n, uint64 v)
Set a error string parameter.
Definition: error_gui.cpp:151
WL_INFO
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
Definition: error.h:22
ErrorMessageData
The data of the error message.
Definition: error.h:29
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
ErrorMessageData::face
CompanyID face
Company belonging to the face being shown. INVALID_COMPANY if no face present.
Definition: error.h:40
ErrorMessageData::display_timer
GUITimer display_timer
Timer before closing the message.
Definition: error.h:31
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
ErrorMessageData::HasFace
bool HasFace() const
Check whether error window shall display a company manager face.
Definition: error.h:51
ErrorMessageData::detailed_msg
StringID detailed_msg
Detailed error message showed in second line. Can be INVALID_STRING_ID.
Definition: error.h:38
UnshowCriticalError
void UnshowCriticalError()
Unshow the critical error.
Definition: error_gui.cpp:356
ScheduleErrorMessage
void ScheduleErrorMessage(const ErrorMessageData &data)
Schedule an error.
Definition: error_gui.cpp:451
WL_ERROR
@ WL_ERROR
Errors (eg. saving/loading failed)
Definition: error.h:24
ErrorMessageData::strings
const char * strings[20]
Copies of raw strings that were used.
Definition: error.h:33
INVALID_COMPANY
@ INVALID_COMPANY
An invalid company.
Definition: company_type.h:30
company_type.h
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:106
WL_CRITICAL
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
Definition: error.h:25
ErrorMessageData::summary_msg
StringID summary_msg
General error message showed in first line. Must be valid.
Definition: error.h:37
ErrorMessageData::ErrorMessageData
ErrorMessageData(const ErrorMessageData &data)
Copy the given data into our instance.
Definition: error_gui.cpp:73