logger.h

/***************************************************************************
 *   Copyright (C) 2005-2008 by the FIFE team                              *
 *   http://www.fifengine.de                                               *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_LOGGER_H
#define FIFE_LOGGER_H

// Standard C++ library includes
#include <iomanip>
#include <iostream>
#include <list>
#include <sstream>
#include <string>
#include <vector>
#include <map>
#include <set>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/fife_stdint.h"

#include "modules.h"

#ifdef LOG_ENABLED

#define FL_DBG(logger, msg) do { if (FIFE::LogManager::instance()->isVisible(logger.getModule())) logger.log(FIFE::LogManager::LEVEL_DEBUG, msg); } while(0)

#define FL_LOG(logger, msg) do { if (FIFE::LogManager::instance()->isVisible(logger.getModule())) logger.log(FIFE::LogManager::LEVEL_LOG, msg); } while(0)

#define FL_WARN(logger, msg) do { if (FIFE::LogManager::instance()->isVisible(logger.getModule())) logger.log(FIFE::LogManager::LEVEL_WARN, msg); } while(0)

#define FL_ERR(logger, msg) do { if (FIFE::LogManager::instance()->isVisible(logger.getModule())) logger.log(FIFE::LogManager::LEVEL_ERROR, msg); } while(0)

#define FL_PANIC(logger, msg) do { if (FIFE::LogManager::instance()->isVisible(logger.getModule())) logger.log(FIFE::LogManager::LEVEL_PANIC, msg); } while(0)

#else
// empty definitions in case logs are turned off for speed
#define FL_DBG(logger, msg)
#define FL_LOG(logger, msg)
#define FL_WARN(logger, msg)
#define FL_ERR(logger, msg)
#define FL_PANIC(logger, msg)
#endif

namespace FIFE {

    class LMsg {
    public:
        LMsg(const std::string& msg=""): str(msg) {}
        ~LMsg() {}

        template <typename T> LMsg& operator<<(const T& t) {
            std::ostringstream stream;
            stream << t;
            str += stream.str();
            return *this;
        }

        std::string str;
    };

    class LogManager {
    public:
        enum LogLevel {
            LEVEL_DEBUG = 0,
            LEVEL_LOG   = 1,
            LEVEL_WARN  = 2,
            LEVEL_ERROR = 3,
            LEVEL_PANIC = 4
        };

        static LogManager* instance();

        ~LogManager();

        void log(LogLevel level, logmodule_t module, const std::string& msg);

        void setLevelFilter(LogLevel level);

        LogLevel getLevelFilter();

        void addVisibleModule(logmodule_t module);

        void removeVisibleModule(logmodule_t module);

        void clearVisibleModules();

        bool isVisible(logmodule_t module);

        void setLogToPrompt(bool log_to_promt);

        bool isLoggingToPrompt();

        void setLogToFile(bool logtofile);

        bool isLoggingToFile();

        std::string getModuleName(logmodule_t module);

    private:
        void validateModule(logmodule_t m);

        // hidden constructor for singleton
        LogManager();
        // validates if definitions in module.h are valid
        void validateModuleDescription(logmodule_t module);

        // singleton instance
        static LogManager* m_instance;
        // current filter level
        LogLevel m_level;
        // visibility array for modules
        bool m_modules[LM_MODULE_MAX];
        // used during module description validation to check cycles in hierarchy
        std::vector<logmodule_t> module_check_stack;

        bool m_logtofile;
        bool m_logtoprompt;

        std::ofstream* m_logfile;
    };

    class Logger {
    public:
        Logger(logmodule_t module);

        ~Logger();

        void log(LogManager::LogLevel level, const std::string& msg);

        void log(LogManager::LogLevel level, const LMsg& msg);

        inline logmodule_t getModule() const { return m_module; }

    private:
        logmodule_t m_module;
    };

    struct pprint {
        void* p;
        pprint( void* _p ) : p(_p) {}
    };
}

namespace std {
    template <class Ch, class Tr>
    basic_ostream<Ch,Tr>& operator<<( basic_ostream<Ch,Tr>& s, const FIFE::pprint& p ) {
        s << "0x"
            << hex << setw( 2*sizeof(void*) ) << setfill('0')
            << reinterpret_cast<uint64_t>( p.p );

        return s;
    }
}


#endif