error.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef ERROR_H
#define ERROR_H
 
#include "strings_type.h"
#include "company_type.h"
#include "command_type.h"
#include "core/geometry_type.hpp"
 
#include <chrono>
 
struct GRFFile;
 
enum WarningLevel {
  WL_INFO,     
  WL_WARNING,  
  WL_ERROR,    
  WL_CRITICAL, 
};
 
class ErrorMessageData {
protected:
  bool is_critical;               
  std::vector<StringParameterData> params; 
  const GRFFile *textref_stack_grffile; 
  uint textref_stack_size;        
  uint32_t textref_stack[16];       
  StringID summary_msg;           
  StringID detailed_msg;          
  StringID extra_msg;             
  Point position;                 
  CompanyID face;                 
 
public:
  ErrorMessageData(const ErrorMessageData &data);
  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);
 
  /* Remove the copy assignment, as the default implementation will not do the right thing. */
  ErrorMessageData &operator=(ErrorMessageData &rhs) = delete;
 
  bool HasFace() const { return face != INVALID_COMPANY; }
 
  void SetDParam(uint n, uint64_t v);
  void SetDParamStr(uint n, const char *str);
  void SetDParamStr(uint n, const std::string &str);
 
  void CopyOutDParams();
};
 
typedef std::list<ErrorMessageData> ErrorList;
 
void ScheduleErrorMessage(ErrorList &datas);
void ScheduleErrorMessage(const ErrorMessageData &data);
 
void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc);
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);
bool HideActiveErrorMessage();
 
void ClearErrorMessages();
void ShowFirstError();
void UnshowCriticalError();
 
#endif /* ERROR_H */