1

/* $Id$ */

     2

     3

/** @file ai_log.hpp Everything to handle and issue log messages. */

     4

     5

#ifndef AI_LOG_HPP

     6

#define AI_LOG_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all log related functions.

    12

 */

    13

class AILog : public AIObject {

    14

	/* AIController needs access to Enum and Log, in order to keep the flow from

    15

	 *  OpenTTD core to NoAI API clear and simple. */

    16

	friend class AIController;

    17

    18

public:

    19

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

    20

    21

	/**

    22

	 * Log levels; The value is also feed to DEBUG() lvl.

    23

	 *  This has no use for you, as AI writer.

    24

	 */

    25

	enum AILogType {

    26

		LOG_SQ_ERROR = 0, //!< Squirrel printed an error.

    27

		LOG_ERROR = 1,    //!< User printed an error.

    28

		LOG_SQ_INFO = 2,  //!< Squirrel printed some info.

    29

		LOG_WARNING = 3,  //!< User printed some warning.

    30

		LOG_INFO = 4,     //!< User printed some info.

    31

	};

    32

    37

	struct LogData {

    38

		char **lines;

    39

		AILog::AILogType *type;

    40

		int count;

    41

		int pos;

    42

	};

    43

    44

	/**

    45

	 * Print an Info message to the logs.

    46

	 * @param message The message to log.

    47

	 */

    48

	static void Info(const char *message);

    49

    50

	/**

    51

	 * Print a Warning message to the logs.

    52

	 * @param message The message to log.

    53

	 */

    54

	static void Warning(const char *message);

    55

    56

	/**

    57

	 * Print an Error message to the logs.

    58

	 * @param message The message to log.

    59

	 */

    60

	static void Error(const char *message);

    61

    62

	/**

    63

	 * Free the log pointer.

    64

	 * @note DO NOT CALL YOURSELF; leave it to the internal AI programming.

    65

	 */

    66

	static void FreeLogPointer();

    67

    68

private:

    69

	/**

    70

	 * Internal command to log the message in a common way.

    71

	 */

    72

	static void Log(AILog::AILogType level, const char *message);

    73

};

    74

    75

#endif /* AI_LOG_HPP */