src/log4qt/helpers/properties.h

Go to the documentation of this file.

/******************************************************************************
 *
 * package:     Log4Qt
 * file:        properties.h
 * created:     September 
 * 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_PROPERTIES_H
#define LOG4QT_PROPERTIES_H


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

#include <QtCore/QHash>
#include <QtCore/QStringList>


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

class QIODevice;
class QSettings;


namespace Log4Qt
{
    class Properties : public QHash<QString, QString>
    {
    public:
        Properties(Properties *pDefaultProperties = 0);
        // virtual ~Properties(); // Use compiler default
        // Properties(const Properties &rOther); // Use compiler default
        // Properties &operator=(const Properties &rOther); // Not implemented
    
    public:
        Properties *defaultProperties() const;
        QString property(const QString &rKey) const; 
        QString property(const QString &rKey, 
                         const QString &rDefaultValue) const; 
        void setDefaultProperties(Properties *pDefault);
        void setProperty(const QString &rKey,
                         const QString &rValue);
        
        // JAVA: void list(QTextStream &rTextStream); 
        void load(QIODevice *pDevice);
        
        void load(const QSettings &rSettings);
        
        QStringList propertyNames() const;
        // JAVA: void save(QIODevice *pDevice) const;
        
    private:
        void parseProperty(const QString &rProperty, 
                           int line);
        static int hexDigitValue(const QChar &rDigit);
        static QString trimLeft(const QString &rString);
    
    private:
        Properties *mpDefaultProperties;
        static const char msEscapeChar;
        static const char *msValueEscapeCodes;
        static const char *msValueEscapeChars;
        static const char *msKeyEscapeCodes;
        static const char *msKeyEscapeChars;
    };
    
    
    /**************************************************************************
     * Operators, Helper
     **************************************************************************/
    
#ifndef QT_NO_DEBUG_STREAM

    QDebug operator<<(QDebug debug, 
                      const Properties &rProperties);
#endif // QT_NO_DEBUG_STREAM
    
    
    /**************************************************************************
     * Inline
     **************************************************************************/

    inline Properties::Properties(Properties *pDefaultProperties) :
        mpDefaultProperties(pDefaultProperties)
    {}
    
    inline Properties *Properties::defaultProperties() const
    {   return mpDefaultProperties; }
    
    inline void Properties::setDefaultProperties(Properties *pDefaultProperties)
    {   mpDefaultProperties = pDefaultProperties;   }
    
    inline void Properties::setProperty(const QString &rKey, 
                                        const QString &rValue)
    {   insert(rKey, rValue);   }
    
    
} // namespace Log4Qt


Q_DECLARE_TYPEINFO(Log4Qt::Properties, Q_MOVABLE_TYPE);


#endif // LOG4QT_PROPERTIES_H

---