logger.h

Go to the documentation of this file.

// Module:  Log4CPLUS
// File:    logger.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright (C) Tad E. Smith  All rights reserved.
//
// This software is published under the terms of the Apache Software
// License version 1.1, a copy of which has been included with this
// distribution in the LICENSE.APL file.
//

#ifndef _LOG4CPLUS_LOGGERHEADER_
#define _LOG4CPLUS_LOGGERHEADER_

#include <log4cplus/config.h>
#include <log4cplus/loglevel.h>
#include <log4cplus/loggingmacros.h>
#include <log4cplus/tstring.h>
#include <log4cplus/streams.h>
#include <log4cplus/helpers/pointer.h>
#include <log4cplus/spi/appenderattachable.h>
#include <log4cplus/spi/loggerfactory.h>

#include <memory>
#include <vector>

namespace log4cplus {
    // Forward declarations
    namespace spi {
        class LoggerImpl;
        typedef helpers::SharedObjectPtr<LoggerImpl> SharedLoggerImplPtr;
    }
    class Appender;
    class Hierarchy;
    class HierarchyLocker;
    class DefaultLoggerFactory;


    typedef std::vector<Logger> LoggerList;


    class LOG4CPLUS_EXPORT Logger : public log4cplus::spi::AppenderAttachable {
    public:
      // Static Methods
        static bool exists(const log4cplus::tstring& name);

        /*
         * Returns all the currently defined loggers in the default
         * hierarchy.
         * <p>
         * The root logger is <em>not</em> included in the returned
         * list.     
         */
        static LoggerList getCurrentLoggers();
     
        static Hierarchy& getDefaultHierarchy();

        static Logger getInstance(const log4cplus::tstring& name);

        static Logger getInstance(const log4cplus::tstring& name, spi::LoggerFactory& factory);

        static Logger getRoot();

        static void shutdown();

      // Non-Static Methods
        void assertion(bool assertionVal, const log4cplus::tstring& msg) {
            if(!assertionVal) {
                log(FATAL_LOG_LEVEL, msg);
            }
        }

        void closeNestedAppenders();

        bool isEnabledFor(LogLevel ll) const;

        void log(LogLevel ll, const log4cplus::tstring& message,
                 const char* file=NULL, int line=-1);

        void forcedLog(LogLevel ll, const log4cplus::tstring& message,
                       const char* file=NULL, int line=-1);

        void callAppenders(const spi::InternalLoggingEvent& event);

        LogLevel getChainedLogLevel() const;

        LogLevel getLogLevel() const;

        void setLogLevel(LogLevel);

        Hierarchy& getHierarchy() const;

        log4cplus::tstring getName() const;

        bool getAdditivity() const;

        void setAdditivity(bool additive);


      // AppenderAttachable Methods
        virtual void addAppender(SharedAppenderPtr newAppender);

        virtual SharedAppenderPtrList getAllAppenders();

        virtual SharedAppenderPtr getAppender(const log4cplus::tstring& name);

        virtual void removeAllAppenders();

        virtual void removeAppender(SharedAppenderPtr appender);

        virtual void removeAppender(const log4cplus::tstring& name);

      // Copy Ctor
        Logger(const Logger& rhs);
        Logger& operator=(const Logger& rhs);

      // Dtor
        ~Logger();

        Logger getParent();

    protected:
      // Data
        spi::LoggerImpl *value;

    private:
      // Ctors
        Logger(spi::LoggerImpl *ptr);
        Logger(const spi::SharedLoggerImplPtr& val);

      // Methods
        void init();
        void validate(const char *file, int line) const;

      // Friends
        friend class log4cplus::spi::LoggerImpl;
        friend class log4cplus::Hierarchy;
        friend class log4cplus::HierarchyLocker;
        friend class log4cplus::DefaultLoggerFactory;
    };


    class LOG4CPLUS_EXPORT DefaultLoggerFactory : public spi::LoggerFactory {
    public:
        Logger makeNewLoggerInstance(const log4cplus::tstring& name, Hierarchy& h);
    };



    class LOG4CPLUS_EXPORT TraceLogger {
    public:
        TraceLogger(const Logger& l, const log4cplus::tstring& _msg,
                    const char* _file=NULL, int _line=-1) 
          : logger(l), msg(_msg), file(_file), line(_line)
        { if(logger.isEnabledFor(TRACE_LOG_LEVEL))
              logger.forcedLog(TRACE_LOG_LEVEL, LOG4CPLUS_TEXT("ENTER: ") + msg, file, line); 
        }

        ~TraceLogger()
        { if(logger.isEnabledFor(TRACE_LOG_LEVEL))
              logger.forcedLog(TRACE_LOG_LEVEL, LOG4CPLUS_TEXT("EXIT:  ") + msg, file, line); 
        }

    private:
        Logger logger;
        log4cplus::tstring msg;
        const char* file;
        int line;
    };

} // end namespace log4cplus


#endif // _LOG4CPLUS_LOGGERHEADER_

---