hierarchy.h

Go to the documentation of this file.

// -*- C++ -*-
// Module:  Log4CPLUS
// File:    hierarchy.h
// Created: 6/2001
// Author:  Tad E. Smith
//
//
// Copyright 2001-2017 Tad E. Smith
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
 
#ifndef LOG4CPLUS_HIERARCHY_HEADER_
#define LOG4CPLUS_HIERARCHY_HEADER_
 
#include <log4cplus/config.hxx>
 
#if defined (LOG4CPLUS_HAVE_PRAGMA_ONCE)
#pragma once
#endif
 
#include <log4cplus/logger.h>
#include <log4cplus/thread/syncprims.h>
#include <map>
#include <memory>
#include <vector>
 
 
namespace log4cplus {
    // Forward Declarations
    class HierarchyLocker;
 
    class LOG4CPLUS_EXPORT Hierarchy
    {
    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(LogLevel level);
 
        virtual Logger getRoot() const;
 
        virtual void resetConfiguration();
 
        virtual void setLoggerFactory(std::unique_ptr<spi::LoggerFactory> factory);
 
        virtual spi::LoggerFactory* getLoggerFactory();
 
        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
        LOG4CPLUS_PRIVATE
        Logger getInstanceImpl(const log4cplus::tstring& name,
            spi::LoggerFactory& factory);
 
        LOG4CPLUS_PRIVATE
        void initializeLoggerList(LoggerList& list) const;
 
        LOG4CPLUS_PRIVATE void updateParents(Logger const & logger);
 
        LOG4CPLUS_PRIVATE void updateChildren(ProvisionNode& pn,
            Logger const & logger);
 
     // Data
        thread::Mutex hashtable_mutex;
        std::unique_ptr<spi::LoggerFactory> defaultFactory;
        ProvisionNodeMap provisionNodes;
        LoggerMap loggerPtrs;
        Logger root;
 
        int disableValue;
 
        bool emittedNoAppenderWarning;
 
        // Disallow copying of instances of this class
        Hierarchy(const Hierarchy&);
        Hierarchy& operator=(const Hierarchy&);
 
     // Friends
        friend class log4cplus::spi::LoggerImpl;
        friend class log4cplus::HierarchyLocker;
    };
 
 
    LOG4CPLUS_EXPORT Hierarchy & getDefaultHierarchy ();
 
 
} // end namespace log4cplus
 
#endif // LOG4CPLUS_HIERARCHY_HEADER_