loggingeventpatternconverter.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_LOGGING_EVENT_PATTERN_CONVERTER_H
#define _LOG4CXX_PATTERN_LOGGING_EVENT_PATTERN_CONVERTER_H
 
#include <log4cxx/pattern/patternconverter.h>
#include <log4cxx/spi/loggingevent.h>
 
namespace LOG4CXX_NS
{
 
namespace pattern
{
class LOG4CXX_EXPORT LoggingEventPatternConverter : public PatternConverter
{
    protected:
        LoggingEventPatternConverter(
            const LogString& name, const LogString& style);
 
        LoggingEventPatternConverter(std::unique_ptr<PatternConverterPrivate> priv);
 
    public:
        DECLARE_LOG4CXX_PATTERN(LoggingEventPatternConverter)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(LoggingEventPatternConverter)
        LOG4CXX_CAST_ENTRY_CHAIN(PatternConverter)
        END_LOG4CXX_CAST_MAP()
 
        using PatternConverter::format;
#if LOG4CXX_ABI_VERSION <= 15
        void format(const spi::LoggingEventPtr& event, LogString& toAppendTo) const;
        virtual void format(
            const spi::LoggingEventPtr& event,
            LogString& toAppendTo,
            helpers::Pool& p) const = 0;
#define LOG4CXX_FORMAT_EVENT_FORMAL_PARAMETERS const spi::LoggingEventPtr& event, LogString& toAppendTo, helpers::Pool& p
#define LOG4CXX_FORMAT_EVENT_PARAMETERS event, toAppendTo, p
#else
        virtual void format(const spi::LoggingEventPtr& event, LogString& toAppendTo) const = 0;
#define LOG4CXX_FORMAT_EVENT_FORMAL_PARAMETERS const spi::LoggingEventPtr& event, LogString& toAppendTo
#define LOG4CXX_FORMAT_EVENT_PARAMETERS event, toAppendTo
        [[deprecated("Use format() without a Pool parameter instead")]]
        void format(const spi::LoggingEventPtr& event, LogString& toAppendTo, helpers::Pool& p) const;
#endif
 
        void format( LOG4CXX_FORMAT_OBJECT_FORMAL_PARAMETERS ) const override;

        virtual bool handlesThrowable() const;
};
 
LOG4CXX_PTR_DEF(LoggingEventPatternConverter);
 
}
}
 
#endif