1

/* $Id$ */

     2

     3

/** @file ai_error.hpp Everything to query errors. */

     4

     5

#ifndef AI_ERROR_HPP

     6

#define AI_ERROR_HPP

     7

     8

#include "ai_object.hpp"

     9

#include <map>

    10

    11

/**

    12

 * Class that handles all error related functions.

    13

 */

    14

class AIError : public AIObject {

    15

public:

    16

	static const char *GetClassName() { return "AIError"; }

    17

    18

	/**

    19

	 * All categories errors can be divided in.

    20

	 */

    21

	enum ErrorCategories {

    22

		ERR_CAT_NONE = 0, //!< Error messages not related to any category.

    23

		ERR_CAT_GENERAL,  //!< Error messages related to general things.

    24

		ERR_CAT_VEHICLE,  //!< Error messages related to building / maintaining vehicles.

    25

		ERR_CAT_STATION,  //!< Error messages related to building / maintaining stations.

    27

    28

		/**

    29

		 * DO NOT USE! The error bitsize determines how many errors can be stored in

    30

		 *  a category and what the offsets are of all categories.

    31

		 */

    32

		ERR_CAT_BIT_SIZE = 8,

    33

	};

    34

    35

	/**

    36

	 * General error messages (0x0100 - 0x0200).

    37

	 */

    38

	enum ErrorMessages {

    39

		/** Initial error value */

    40

		ERR_NONE = ERR_CAT_NONE << ERR_CAT_BIT_SIZE,  // []

    41

		/** If an error occured and the error wasn't mapped */

    42

		ERR_UNKNOWN,                                  // []

    43

		/** If a precondition is not met */

    44

		ERR_PRECONDITION_FAILED,                      // []

    45

    46

		/** Base for general errors */

    47

		ERR_GENERAL_BASE = ERR_CAT_GENERAL << ERR_CAT_BIT_SIZE,

    48

    49

		/** Not enough cash to perform the previous action */

    50

		ERR_NOT_ENOUGH_CASH,                          // [STR_0003_NOT_ENOUGH_CASH_REQUIRES]

    51

    52

		/** Local authority won't allow the previous action */

    53

		ERR_LOCAL_AUTHORITY_REFUSES,                  // [STR_2009_LOCAL_AUTHORITY_REFUSES]

    54

    55

		/** The piece of infrastructure you tried to build is already in place */

    57

    58

		/** Area isn't clear, try to demolish the building on it */

    59

		ERR_AREA_NOT_CLEAR,                           // [STR_2004_BUILDING_MUST_BE_DEMOLISHED, STR_5007_MUST_DEMOLISH_BRIDGE_FIRST, STR_300B_MUST_DEMOLISH_RAILROAD, STR_300E_MUST_DEMOLISH_AIRPORT_FIRST, STR_MUST_DEMOLISH_CARGO_TRAM_STATION, STR_3047_MUST_DEMOLISH_TRUCK_STATION, STR_MUST_DEMOLISH_PASSENGER_TRAM_STATION, STR_3046_MUST_DEMOLISH_BUS_STATION, STR_306A_BUOY_IN_THE_WAY, STR_304D_MUST_DEMOLISH_DOCK_FIRST, STR_4800_IN_THE_WAY, STR_5804_COMPANY_HEADQUARTERS_IN, STR_5800_OBJECT_IN_THE_WAY, STR_1801_MUST_REMOVE_ROAD_FIRST, STR_1008_MUST_REMOVE_RAILROAD_TRACK, STR_5007_MUST_DEMOLISH_BRIDGE_FIRST, STR_5006_MUST_DEMOLISH_TUNNEL_FIRST]

    60

    61

		/** Area is owned by another company */

    62

		ERR_AREA_IS_OWNED_BY_ANOTHER_COMPANY,         // [STR_1024_AREA_IS_OWNED_BY_ANOTHER]

    63

    64

		/** The name given is not unique for the object type */

    65

		ERR_NAME_IS_NOT_UNIQUE,                       // [STR_NAME_MUST_BE_UNIQUE]

    66

    67

		/** The building you want to build requires flat land */

    68

		ERR_FLAT_LAND_REQUIRED,                       // [STR_0007_FLAT_LAND_REQUIRED]

    69

	};

    70

    71

	/**

    72

	 * Check the membership of the last thrown error.

    73

	 * @return The category the error belongs to.

    74

	 * @note The last throw error can be aquired by calling GetLastError().

    75

	 */

    76

	static ErrorCategories GetErrorCategory();

    77

    78

	/**

    79

	 * Get the last error.

    80

	 * @return An ErrorMessages enum value.

    81

	 */

    82

	static AIErrorType GetLastError();

    83

    84

	/**

    85

	 * Get the last error in string format (for human readability).

    86

	 * @return An ErrorMessage enum item, as string.

    87

	 */

    88

	static const char *GetLastErrorString();

    89

    90

	/**

    91

	 * Get the error based on the OpenTTD StringID.

    92

	 * @note DO NOT INVOKE THIS METHOD YOURSELF!

    93

	 * @param internal_string_id The string to convert.

    94

	 * @return The NoAI equivalent error message.

    95

	 */

    96

	static AIErrorType StringToError(StringID internal_string_id);

    97

    98

	/**

    99

	 * Map an internal OpenTTD error message to it's NoAI equivalent.

   100

	 * @note DO NOT INVOKE THIS METHOD YOURSELF! The calls are autogenerated.

   101

	 * @param internal_string_id The OpenTTD StringID used for an error.

   102

	 * @param ai_error_msg The NoAI equivalent error message.

   103

	 */

   104

	static void RegisterErrorMap(StringID internal_string_id, AIErrorType ai_error_msg);

   105

   106

	/**

   107

	 * Map an internal OpenTTD error message to it's NoAI equivalent.

   108

	 * @note DO NOT INVOKE THIS METHOD YOURSELF! The calls are autogenerated.

   109

	 * @param ai_error_msg The NoAI error message representation.

   110

	 * @param message The string representation of this error message, used for debug purposes.

   111

	 */

   112

	static void RegisterErrorMapString(AIErrorType ai_error_msg, const char *message);

   113

   114

private:

   115

	typedef std::map<StringID, AIErrorType> AIErrorMap;

   116

	typedef std::map<AIErrorType, const char *> AIErrorMapString;

   117

   118

	static AIErrorMap error_map;

   119

	static AIErrorMapString error_map_string;

   120

};

   121

   122

#endif /* AI_ERROR_HPP */