Go to the documentation of this file.00001
00002
00003
00004
00005
00006
00007
00008
00009
00012 #ifndef SCRIPT_ERROR_HPP
00013 #define SCRIPT_ERROR_HPP
00014
00015 #include "script_object.hpp"
00016 #include <map>
00017
00023 #define EnforcePrecondition(returnval, condition) \
00024 if (!(condition)) { \
00025 ScriptObject::SetLastError(ScriptError::ERR_PRECONDITION_FAILED); \
00026 return returnval; \
00027 }
00028
00035 #define EnforcePreconditionCustomError(returnval, condition, error_code) \
00036 if (!(condition)) { \
00037 ScriptObject::SetLastError(error_code); \
00038 return returnval; \
00039 }
00040
00045 class ScriptError : public ScriptObject {
00046 public:
00050 enum ErrorCategories {
00051 ERR_CAT_NONE = 0,
00052 ERR_CAT_GENERAL,
00053 ERR_CAT_VEHICLE,
00054 ERR_CAT_STATION,
00055 ERR_CAT_BRIDGE,
00056 ERR_CAT_TUNNEL,
00057 ERR_CAT_TILE,
00058 ERR_CAT_SIGN,
00059 ERR_CAT_RAIL,
00060 ERR_CAT_ROAD,
00061 ERR_CAT_ORDER,
00062 ERR_CAT_MARINE,
00063 ERR_CAT_WAYPOINT,
00064
00069 ERR_CAT_BIT_SIZE = 8,
00070 };
00071
00075 enum ErrorMessages {
00077 ERR_NONE = ERR_CAT_NONE << ERR_CAT_BIT_SIZE,
00079 ERR_UNKNOWN,
00081 ERR_PRECONDITION_FAILED,
00083 ERR_PRECONDITION_STRING_TOO_LONG,
00085 ERR_PRECONDITION_INVALID_COMPANY,
00087 ERR_NEWGRF_SUPPLIED_ERROR,
00088
00090 ERR_GENERAL_BASE = ERR_CAT_GENERAL << ERR_CAT_BIT_SIZE,
00091
00093 ERR_NOT_ENOUGH_CASH,
00094
00096 ERR_LOCAL_AUTHORITY_REFUSES,
00097
00099 ERR_ALREADY_BUILT,
00100
00102 ERR_AREA_NOT_CLEAR,
00103
00105 ERR_OWNED_BY_ANOTHER_COMPANY,
00106
00108 ERR_NAME_IS_NOT_UNIQUE,
00109
00111 ERR_FLAT_LAND_REQUIRED,
00112
00114 ERR_LAND_SLOPED_WRONG,
00115
00117 ERR_VEHICLE_IN_THE_WAY,
00118
00120 ERR_SITE_UNSUITABLE,
00121
00123 ERR_TOO_CLOSE_TO_EDGE,
00124
00126 ERR_STATION_TOO_SPREAD_OUT,
00127 };
00128
00134 static ErrorCategories GetErrorCategory();
00135
00140 static ScriptErrorType GetLastError();
00141
00146 static char *GetLastErrorString();
00147
00154 static ScriptErrorType StringToError(StringID internal_string_id);
00155
00162 static void RegisterErrorMap(StringID internal_string_id, ScriptErrorType ai_error_msg);
00163
00170 static void RegisterErrorMapString(ScriptErrorType ai_error_msg, const char *message);
00171
00172 private:
00173 typedef std::map<StringID, ScriptErrorType> ScriptErrorMap;
00174 typedef std::map<ScriptErrorType, const char *> ScriptErrorMapString;
00175
00176 static ScriptErrorMap error_map;
00177 static ScriptErrorMapString error_map_string;
00178 };
00179
00180 #endif