src/error.h

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