1

#ifndef LOGGER_HH

     2

#define LOGGER_HH

     3

     4

#include "Types.hh"

     5

     6

#include <iostream>

     7

     8

/**

     9

 * Utility class used for logging, use Engine::log() to construct these. Implements the same streaming behaviour as 

    10

 * std::ostream, but the construtor prints out a header, and the destructor a newline. 

    11

 *

    12

 * Useage example:

    13

 * 

    14

 * \code

    15

 *      Engine::log(INFO, "foo.bar") << "value of quux=" << quux;

    16

 *

    17

 * \endcode

    18

 *

    19

 * This will result in output like the following to stdout:

    20

 *

    21

 * \verbatim

    22

 * INFO [foo.bar] value of quux=5

    23

 * \endverbatim

    24

 *

    25

 * @see Engine::log

    26

 */

    27

class Logger {

    28

    private:

    29

        /**

    30

         * The stream we output to

    31

         */

    32

        std::ostream &stream;

    33

    34

        /**

    35

         * Do we even care?

    36

         */

    37

        bool show;

    38

    39

    public:

    40

        /**

    41

         * If the given level is smaller than the given maximum level, output the header. Otherwise, act as a

    42

         * no-op.

    43

         */

    44

        Logger (std::ostream &stream, LogLevel level, const char *module, LogLevel max_level);

    45

    46

        /**

    47

         * Stream the given value to our output stream, just like with std::ostream, unless we're acting as a no-op.

    48

         */

    49

        template <typename T> Logger& operator<< (const T val);

    50

    51

        /**

    52

         * Output the final newline

    53

         */

    54

        ~Logger (void);

    55

};

    56

    57

/*

    58

 * Logger template method definition

    59

 */

    60

template <typename T> 

    61

inline Logger& Logger::operator<< (const T val) {

    62

    if (show)

    63

        stream << val;

    64

    65

    // chaining

    66

    return *this;

    67

}

    68

    69

#endif /* LOGGER_HH */