Logger.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of RSC project
 *
 * Copyright (C) 2010 by Johannes Wienke <jwienke at techfak dot uni-bielefeld dot de>
 *
 * This file may be licensed under the terms of the
 * GNU Lesser General Public License Version 3 (the ``LGPL''),
 * or (at your option) any later version.
 *
 * Software distributed under the License is distributed
 * on an ``AS IS'' basis, WITHOUT WARRANTY OF ANY KIND, either
 * express or implied. See the LGPL for the specific language
 * governing rights and limitations.
 *
 * You should have received a copy of the LGPL along with this
 * program. If not, go to http://www.gnu.org/licenses/lgpl.html
 * or write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The development of this software was supported by:
 *   CoR-Lab, Research Institute for Cognition and Robotics
 *     Bielefeld University
 *
 * ============================================================ */

#pragma once

#include <string>
#include <ostream>
#include <sstream>

#include <boost/noncopyable.hpp>
#include <boost/shared_ptr.hpp>

#include "rsc/rscexports.h"

namespace rsc {
namespace logging {

class Logger;
typedef boost::shared_ptr<Logger> LoggerPtr;

class RSC_EXPORT Logger: public boost::noncopyable {
public:

    enum Level {
        LEVEL_ALL = 0x11111111,
        LEVEL_TRACE = 60,
        LEVEL_DEBUG = 50,
        LEVEL_INFO = 40,
        LEVEL_WARN = 30,
        LEVEL_ERROR = 20,
        LEVEL_FATAL = 10,
        LEVEL_OFF = 0
    };

    virtual ~Logger();

    static LoggerPtr getLogger(const std::string& name);


    virtual Level getLevel() const = 0;

    virtual void setLevel(const Level& level) = 0;

    virtual std::string getName() const = 0;

    virtual void setName(const std::string& name) = 0;



    virtual void trace(const std::string& msg);

    virtual void debug(const std::string& msg);

    virtual void info(const std::string& msg);

    virtual void warn(const std::string& msg);

    virtual void error(const std::string& msg);

    virtual void fatal(const std::string& msg);


    virtual void log(const Level& level, const std::string& msg) = 0;

    virtual bool isTraceEnabled() const;
    virtual bool isDebugEnabled() const;
    virtual bool isInfoEnabled() const;
    virtual bool isWarnEnabled() const;
    virtual bool isErrorEnabled() const;
    virtual bool isFatalEnabled() const;
    virtual bool isEnabledFor(const Level& level) const;

};

RSC_EXPORT std::ostream& operator<<(std::ostream& stream, const Logger::Level& level);

}
}


#define RSCTRACE(logger, msg) \
    if (logger->isTraceEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg; \
        logger->trace(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCDEBUG(logger, msg) \
    if (logger->isDebugEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg; \
        logger->debug(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCINFO(logger, msg) \
    if (logger->isInfoEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg; \
        logger->info(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCWARN(logger, msg) \
    if (logger->isWarnEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg; \
        logger->warn(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCERROR(logger, msg) \
    if (logger->isErrorEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg; \
        logger->error(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCFATAL(logger, msg) \
    if (logger->isFatalEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg; \
        logger->fatal(iShouldNeverBeMatchedByClientCode.str()); \
    }



#define RSCTRACE_EXPECT(condition, logger, msg) \
    if (!(condition) && logger->isTraceEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg << "\nfailed condition: " << #condition; \
        logger->trace(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCDEBUG_EXPECT(condition, logger, msg) \
    if (!(condition) && logger->isDebugEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg << "\nfailed condition: " << #condition; \
        logger->debug(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCINFO_EXPECT(condition, logger, msg) \
    if (!(condition) && logger->isInfoEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg << "\nfailed condition: " << #condition; \
        logger->info(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCWARN_EXPECT(condition, logger, msg) \
    if (!(condition) && logger->isWarnEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg << "\nfailed condition: " << #condition; \
        logger->warn(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCERROR_EXPECT(condition, logger, msg) \
    if (!(condition) && logger->isErrorEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg << "\nfailed condition: " << #condition; \
        logger->error(iShouldNeverBeMatchedByClientCode.str()); \
    }

#define RSCFATAL_EXPECT(condition, logger, msg) \
    if (!(condition) && logger->isFatalEnabled()) { \
        std::stringstream iShouldNeverBeMatchedByClientCode; \
        iShouldNeverBeMatchedByClientCode << msg << "\nfailed condition: " << #condition; \
        logger->fatal(iShouldNeverBeMatchedByClientCode.str()); \
    }