src/log4qt/helpers/patternformatter.h

Go to the documentation of this file.

/******************************************************************************
 *
 * package:     Log4Qt
 * file:        patternformatter.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_PATTERNFORMATTER_H
#define LOG4QT_PATTERNFORMATTER_H


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

#include <QtCore/QList>
#include <QtCore/QString>


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


namespace Log4Qt
{
    
    class FormattingInfo;
    class PatternConverter;
    class LoggingEvent;
    
    class PatternFormatter
    {
    public:
        PatternFormatter(const QString &rPattern);
        
        virtual ~PatternFormatter();
    
    private:
        PatternFormatter(const PatternFormatter &rOther); // Not implemented
        PatternFormatter &operator=(const PatternFormatter &rOther); // Not implemented
    
    public:
        QString format(const LoggingEvent &rLoggingEvent) const;
        
    private:
        bool addDigit(const QChar &rDigit, 
                      int &rValue);
        
        void createConverter(const QChar &rChar, 
                             const FormattingInfo &rFormattingInfo,  
                             const QString &rOption = QString());
        
        void createLiteralConverter(const QString &rLiteral);
        
        void parse();   
    
        int parseIntegerOption(const QString &rOption);
        
    private:
        const QString mIgnoreCharacters;
        const QString mConversionCharacters;
        const QString mOptionCharacters;
        QString mPattern;
        QList<PatternConverter *> mPatternConverters;
        
        // Needs to be friend to access internal data
        friend QDebug operator<<(QDebug, const PatternFormatter &rPatternFormatter);
    };
    
    
    /**************************************************************************
     * Operators, Helper
     **************************************************************************/
    
#ifndef QT_NO_DEBUG_STREAM

    QDebug operator<<(QDebug debug, 
                      const PatternFormatter &rPatternFormatter);
#endif // QT_NO_DEBUG_STREAM
    
    
    /**************************************************************************
     * Inline
     **************************************************************************/
    
    
} // namespace Log4Qt


Q_DECLARE_TYPEINFO(Log4Qt::PatternFormatter, Q_MOVABLE_TYPE);


#endif // LOG4QT_PATTERNFORMATTER_H

---