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
 
#include <log4cxx/layout.h>
#include <log4cxx/pattern/loggingeventpatternconverter.h>
#include <log4cxx/pattern/formattinginfo.h>
#include <log4cxx/pattern/patternparser.h>
 
namespace LOG4CXX_NS
{
LOG4CXX_LIST_DEF(LoggingEventPatternConverterList, LOG4CXX_NS::pattern::LoggingEventPatternConverterPtr);
LOG4CXX_LIST_DEF(FormattingInfoList, LOG4CXX_NS::pattern::FormattingInfoPtr);

class LOG4CXX_EXPORT PatternLayout : public Layout
{
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(PatternLayoutPrivate, m_priv)
 
    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);
 
        ~PatternLayout();

        void setConversionPattern(const LogString& conversionPattern);

        LogString getConversionPattern() const;

        void activateOptions(helpers::Pool& p) override;

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

        bool ignoresThrowable() const override
        {
            return true;
        }

        void format(    LogString& output,
            const spi::LoggingEventPtr& event,
            helpers::Pool& pool) const override;
 
    protected:
        virtual LOG4CXX_NS::pattern::PatternMap getFormatSpecifiers();
 
    private:
        pattern::PatternConverterPtr createColorStartPatternConverter(const std::vector<LogString>& options);
};
 
LOG4CXX_PTR_DEF(PatternLayout);
} // namespace log4cxx
 
#endif //_LOG4CXX_PATTERN_LAYOUT_H