patternlayout.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 _LOG4CXX_PATTERN_LAYOUT_H
#define _LOG4CXX_PATTERN_LAYOUT_H

#if defined(_MSC_VER)
    #pragma warning ( push )
    #pragma warning ( disable: 4231 4251 4275 4786 )
#endif

#include <log4cxx/layout.h>
#include <log4cxx/pattern/loggingeventpatternconverter.h>
#include <log4cxx/pattern/formattinginfo.h>
#include <log4cxx/pattern/patternparser.h>

namespace log4cxx
{
LOG4CXX_LIST_DEF(LoggingEventPatternConverterList, log4cxx::pattern::LoggingEventPatternConverterPtr);
LOG4CXX_LIST_DEF(FormattingInfoList, log4cxx::pattern::FormattingInfoPtr);

class LOG4CXX_EXPORT PatternLayout : public Layout
{
        LogString conversionPattern;

        LoggingEventPatternConverterList patternConverters;

        FormattingInfoList patternFields;

    public:
        DECLARE_LOG4CXX_OBJECT(PatternLayout)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(PatternLayout)
        LOG4CXX_CAST_ENTRY_CHAIN(Layout)
        END_LOG4CXX_CAST_MAP()

        
        PatternLayout();

        PatternLayout(const LogString& pattern);

        void setConversionPattern(const LogString& conversionPattern);

        inline LogString getConversionPattern() const
        {
            return conversionPattern;
        }

        virtual void activateOptions(log4cxx::helpers::Pool& p);

        virtual void setOption(const LogString& option, const LogString& value);

        virtual bool ignoresThrowable() const
        {
            return true;
        }

        virtual void format(    LogString& output,
            const spi::LoggingEventPtr& event,
            log4cxx::helpers::Pool& pool) const;

    protected:
        virtual log4cxx::pattern::PatternMap getFormatSpecifiers();
};

LOG4CXX_PTR_DEF(PatternLayout);
} // namespace log4cxx

#if defined(_MSC_VER)
    #pragma warning ( pop )
#endif

#endif //_LOG4CXX_PATTERN_LAYOUT_H