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

    26

		/**

    27

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

    28

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

    29

		 */

    30

		ERR_CAT_BIT_SIZE = 8,

    31

	};

    32

    33

	/**

    34

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

    35

	 */

    36

	enum ErrorMessages {

    37

		/** Initial error value */

    38

		ERR_NONE = ERR_CAT_NONE << ERR_CAT_BIT_SIZE,  // []

    39

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

    40

		ERR_UNKNOWN,                                  // []

    41

		/** If a precondition is not met */

    42

		ERR_PRECONDITION_FAILED,                      // []

    43

    44

		/** Base for general errors */

    45

		ERR_GENERAL_BASE = ERR_CAT_GENERAL << ERR_CAT_BIT_SIZE,

    46

    47

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

    48

		ERR_NOT_ENOUGH_CASH,                          // [STR_0003_NOT_ENOUGH_CASH_REQUIRES]

    49

    50

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

    51

		ERR_LOCAL_AUTHORITY_REFUSES,                  // [STR_2009_LOCAL_AUTHORITY_REFUSES]

    52

    53

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

    54

		ERR_ALREADY_BUILT,                            // [STR_1007_ALREADY_BUILT]

    55

    56

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

    57

		ERR_AREA_NOT_CLEAR,                           // [STR_2004_BUILDING_MUST_BE_DEMOLISHED]

    58

    59

		/** Area is owned by another company */

    60

		ERR_AREA_IS_OWNED_BY_ANOTHER_COMPANY,         // [STR_1024_AREA_IS_OWNED_BY_ANOTHER]

    61

	};

    62

    63

	/**

    64

	 * Check the membership of the last thrown error.

    65

	 * @return The category the error belongs to.

    66

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

    67

	 */

    68

	static ErrorCategories GetErrorCategory();

    69

    70

	/**

    71

	 * Get the last error.

    72

	 * @return An ErrorMessages enum value.

    73

	 */

    75

    76

	/**

    77

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

    78

	 * @return An ErrorMessage enum item, as string.

    79

	 */

    80

	static const char *GetLastErrorString();

    81

    82

	/**

    83

	 * Get the error based on the OpenTTD StringID.

    84

	 * @note DO NOT INVOKE THIS METHOD YOURSELF!

    85

	 * @param internal_string_id The string to convert.

    86

	 * @return The NoAI equivalent error message.

    87

	 */

    89

    90

	/**

    91

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

    92

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

    93

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

    94

	 * @param ai_error_msg The NoAI equivalent error message.

    95

	 */

    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 ai_error_msg The NoAI error message representation.

   102

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

   103

	 */

   105

   106

private:

   109

   110

	static AIErrorMap error_map;

   111

	static AIErrorMapString error_map_string;

   112

};

   113

   114

#endif /* AI_ERROR_HPP */