Translations update
[openttd/fttd.git] / src / error.h
blob597b62efbe7fd309287627a5ea6fc4fa2c0fe1ae
1 /* $Id$ */
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 */
10 /** @file error.h Functions related to errors. */
12 #ifndef ERROR_H
13 #define ERROR_H
15 #include "strings_type.h"
16 #include "company_type.h"
17 #include "core/geometry_type.hpp"
19 struct GRFFile;
21 /** Message severity/type */
22 enum WarningLevel {
23 WL_INFO, ///< Used for DoCommand-like (and some non-fatal AI GUI) errors/information
24 WL_WARNING, ///< Other information
25 WL_ERROR, ///< Errors (eg. saving/loading failed)
26 WL_CRITICAL, ///< Critical errors, the MessageBox is shown in all cases
29 /** The data of the error message. */
30 class ErrorMessageData {
31 protected:
32 uint duration; ///< Length of display of the message. 0 means forever,
33 uint64 decode_params[20]; ///< Parameters of the message strings.
34 const char *strings[20]; ///< Copies of raw strings that were used.
35 const GRFFile *textref_stack_grffile; ///< NewGRF that filled the #TextRefStack for the error message.
36 uint textref_stack_size; ///< Number of uint32 values to put on the #TextRefStack for the error message.
37 uint32 textref_stack[16]; ///< Values to put on the #TextRefStack for the error message.
38 StringID summary_msg; ///< General error message showed in first line. Must be valid.
39 StringID detailed_msg; ///< Detailed error message showed in second line. Can be #INVALID_STRING_ID.
40 Point position; ///< Position of the error message window.
41 CompanyID face; ///< Company belonging to the face being shown. #INVALID_COMPANY if no face present.
43 public:
44 ErrorMessageData(const ErrorMessageData &data);
45 ~ErrorMessageData();
46 ErrorMessageData(StringID summary_msg, StringID detailed_msg, uint duration = 0, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = NULL, uint textref_stack_size = 0, const uint32 *textref_stack = NULL);
48 /** Check whether error window shall display a company manager face */
49 bool HasFace() const { return face != INVALID_COMPANY; }
51 void SetDParam(uint n, uint64 v);
52 void SetDParamStr(uint n, const char *str);
54 void CopyOutDParams();
57 void ScheduleErrorMessage(const ErrorMessageData &data);
59 void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = NULL, uint textref_stack_size = 0, const uint32 *textref_stack = NULL);
60 void ClearErrorMessages();
61 void ShowFirstError();
62 void UnshowCriticalError();
64 #endif /* ERROR_H */