hierarchy.h

Go to the documentation of this file.

// Module:  Log4CPLUS
// File:    hierarchy.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_HIERARCHY_HEADER_
#define _LOG4CPLUS_HIERARCHY_HEADER_

#include <log4cplus/config.h>
#include <log4cplus/logger.h>
#include <log4cplus/helpers/logloguser.h>
#include <log4cplus/helpers/pointer.h>
#include <log4cplus/helpers/threads.h>
#include <map>
#include <memory>
#include <vector>


namespace log4cplus {
    // Forward Declarations
    class HierarchyLocker;

    class LOG4CPLUS_EXPORT Hierarchy : protected log4cplus::helpers::LogLogUser {
    public:
        // DISABLE_OFF should be set to a value lower than all possible
        // priorities.
        static const LogLevel DISABLE_OFF;
        static const LogLevel DISABLE_OVERRIDE;

      // Ctors
        Hierarchy();

      // Dtor
        virtual ~Hierarchy();

      // Methods
        virtual void clear();

        virtual bool exists(const log4cplus::tstring& name);

        virtual void disable(const log4cplus::tstring& loglevelStr);

        virtual void disable(LogLevel ll);

        virtual void disableAll();

        virtual void disableDebug();

        virtual void disableInfo();

        virtual void enableAll();

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

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

        virtual LoggerList getCurrentLoggers();

        virtual bool isDisabled(int level);

        virtual Logger getRoot() const;

        virtual void resetConfiguration(); 

        virtual void setLoggerFactory(std::auto_ptr<spi::LoggerFactory> factory);
        
        virtual spi::LoggerFactory* getLoggerFactory() { return defaultFactory.get(); }

        virtual void shutdown();

    private:
      // Types
        typedef std::vector<Logger> ProvisionNode;
        typedef std::map<log4cplus::tstring, ProvisionNode> ProvisionNodeMap;
        typedef std::map<log4cplus::tstring, Logger> LoggerMap;

      // Methods
        virtual Logger getInstanceImpl(const log4cplus::tstring& name, 
                                       spi::LoggerFactory& factory);
        
        virtual void initializeLoggerList(LoggerList& list) const;
        
        void updateParents(Logger logger);

        void updateChildren(ProvisionNode& pn, Logger logger);

    // Data
       LOG4CPLUS_MUTEX_PTR_DECLARE hashtable_mutex;
       std::auto_ptr<spi::LoggerFactory> defaultFactory;
       ProvisionNodeMap provisionNodes;
       LoggerMap loggerPtrs;
       Logger root;

       int disableValue;

       bool emittedNoAppenderWarning;
       bool emittedNoResourceBundleWarning;

     // Disallow copying of instances of this class
       Hierarchy(const Hierarchy&);
       Hierarchy& operator=(const Hierarchy&);

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

} // end namespace log4cplus

#endif // _LOG4CPLUS_HIERARCHY_HEADER_

---