src/log4qt/propertyconfigurator.h

Go to the documentation of this file.

/******************************************************************************
 * 
 * package:     Logging
 * file:        propertyconfigurator.h
 * created:     September 2007
 * author:      Martin Heinrich
 *
 * 
 * Copyright 2007 Martin Heinrich
 * 
 * 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 LOG4QT_PROPERTYCONFIGURATOR_H
#define LOG4QT_PROPERTYCONFIGURATOR_H


/******************************************************************************
 * Dependencies
 ******************************************************************************/


#include <QtCore/QHash>
#include "log4qt/helpers/logobjectptr.h"
#include "log4qt/log4qt.h"


/******************************************************************************
 * Declarations
 ******************************************************************************/

class QSettings;

namespace Log4Qt
{

    class Appender;
    class Layout;
    class ListAppender;
    class Logger;
    class Properties;
    class LoggerRepository;
    
    class PropertyConfigurator
    {
    public:
        PropertyConfigurator();
        // virtual ~PropertyConfigurator(); // Use compiler default
    private:
        PropertyConfigurator(const PropertyConfigurator &rOther); // Not implemented
        PropertyConfigurator &operator=(const PropertyConfigurator &rOther); // Not implemented
        
    public:
        bool doConfigure(const Properties &rProperties, 
                         LoggerRepository *pLoggerRepository = 0); 
        
        bool doConfigure(const QString &rConfigFileName, 
                         LoggerRepository *pLoggerRepository = 0);
        
        bool doConfigure(const QSettings &rSettings,
                         LoggerRepository *pLoggerRepository = 0);
        
        // JAVA: void doConfigure(const QUrl &rUrl, LoggerRepository *pLoggerRepository);
        
        static bool configure(const Properties &rProperties);
        
        static bool configure(const QString &rConfigFilename);
        
        static bool configure(const QSettings &rSettings);
        
        // JAVA: static void configure(const QUrl &rUrl);
         
        static bool configureAndWatch(const QString &rConfigFilename);
        
    private:
        void configureFromFile(const QString &rConfigFileName,
                               LoggerRepository *pLoggerRepository);
        void configureFromProperties(const Properties &rProperties, 
                                     LoggerRepository *pLoggerRepository);
        void configureFromSettings(const QSettings &rSettings, 
                                   LoggerRepository *pLoggerRepository);
        void configureGlobalSettings(const Properties &rProperties,
                                     LoggerRepository *pLoggerRepository) const;
        void configureNonRootElements(const Properties &rProperties, 
                                      LoggerRepository *pLoggerRepository);
        void configureRootLogger(const Properties &rProperties, 
                                 LoggerRepository *pLoggerRepository);
        void parseAdditivityForLogger(const Properties &rProperties,
                                      Logger *pLogger, 
                                      const QString &rLog4jName) const;
        LogObjectPtr<Appender> parseAppender(const Properties &rProperties,
                                             const QString &rName);
        LogObjectPtr<Layout> parseLayout(const Properties &rProperties,
                                         const QString &rAppenderName);
        void parseLogger(const Properties &rProperties, 
                         Logger *pLogger, 
                         const QString &rKey,
                         const QString &rValue);
        void setProperties(const Properties &rProperties,
                           const QString &rPrefix,
                           const QStringList &rExclusions,
                           QObject *pObject);
        void startCaptureErrors();
        bool stopCaptureErrors();
        
    private:
        LogObjectPtr<ListAppender> mpConfigureErrors;
        QHash< QString, LogObjectPtr<Appender> > mAppenderRegistry;
    };
        
    /**************************************************************************
     * Operators, Helper
     **************************************************************************/
    
#ifndef QT_NO_DEBUG_STREAM

    QDebug operator<<(QDebug debug,
                      const PropertyConfigurator &rPropertyConfigurator);
#endif
    
    
    /**************************************************************************
     * Inline
     **************************************************************************/
    
    inline PropertyConfigurator::PropertyConfigurator()
    {}
    
    
} // namspace Logging


// Q_DECLARE_TYPEINFO(Log4Qt::PropertyConfigurator, Q_COMPLEX_TYPE); // Use default


#endif // LOG4QT_PROPERTYCONFIGURATOR_H

---