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 "command_type.h"
  16 #include "core/geometry_type.hpp"
  17
  18 #include <chrono>
  19
  20 struct GRFFile;
  21
  22 /** Message severity/type */
  23 enum WarningLevel {
  24         WL_INFO,     ///< Used for DoCommand-like (and some non-fatal AI GUI) errors/information
  25         WL_WARNING,  ///< Other information
  26         WL_ERROR,    ///< Errors (eg. saving/loading failed)
  27         WL_CRITICAL, ///< Critical errors, the MessageBox is shown in all cases
  28 };
  29
  30 /** The data of the error message. */
  31 class ErrorMessageData {
  32 protected:
  33         bool is_critical;               ///< Whether the error message is critical.
  34         std::vector<StringParameterData> params; ///< Backup of parameters of the message strings.
  35         const GRFFile *textref_stack_grffile; ///< NewGRF that filled the #TextRefStack for the error message.
  36         uint textref_stack_size;        ///< Number of uint32_t values to put on the #TextRefStack for the error message.
  37         uint32_t 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         StringID extra_msg;             ///< Extra error message shown in third line. Can be #INVALID_STRING_ID.
  41         Point position;                 ///< Position of the error message window.
  42         CompanyID face;                 ///< Company belonging to the face being shown. #INVALID_COMPANY if no face present.
  43
  44 public:
  45         ErrorMessageData(const ErrorMessageData &data);
  46         ErrorMessageData(StringID summary_msg, StringID detailed_msg, bool is_critical = false, int x = 0, int y = 0, const GRFFile *textref_stack_grffile = nullptr, uint textref_stack_size = 0, const uint32_t *textref_stack = nullptr, StringID extra_msg = INVALID_STRING_ID);
  47
  48         /* Remove the copy assignment, as the default implementation will not do the right thing. */
  49         ErrorMessageData &operator=(ErrorMessageData &rhs) = delete;
  50
  51         /** Check whether error window shall display a company manager face */
  52         bool HasFace() const { return face != INVALID_COMPANY; }
  53
  54         void SetDParam(uint n, uint64_t v);
  55         void SetDParamStr(uint n, const char *str);
  56         void SetDParamStr(uint n, const std::string &str);
  57
  58         void CopyOutDParams();
  59 };
  60
  61 /** Define a queue with errors. */
  62 typedef std::list<ErrorMessageData> ErrorList;
  63
  64 void ScheduleErrorMessage(ErrorList &datas);
  65 void ScheduleErrorMessage(const ErrorMessageData &data);
  66
  67 void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc);
  68 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_t *textref_stack = nullptr, StringID extra_msg = INVALID_STRING_ID);
  69 bool HideActiveErrorMessage();
  70
  71 void ClearErrorMessages();
  72 void ShowFirstError();
  73 void UnshowCriticalError();
  74
  75 #endif /* ERROR_H */