patternconverter.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_PATTERN_CONVERTER_H
#define _LOG4CXX_PATTERN_PATTERN_CONVERTER_H
 
 
#include <log4cxx/helpers/object.h>
#include <log4cxx/logstring.h>
#include <log4cxx/pattern/formattinginfo.h>
#include <vector>
 
#define DECLARE_LOG4CXX_PATTERN(cls) DECLARE_ABSTRACT_LOG4CXX_OBJECT(cls)
 
namespace LOG4CXX_NS
{
namespace pattern
{
 
typedef std::vector<LogString> OptionsList;

class LOG4CXX_EXPORT PatternConverter : public virtual helpers::Object
{
    protected:
        LOG4CXX_DECLARE_PRIVATE_MEMBER_PTR(PatternConverterPrivate, m_priv)
        PatternConverter(LOG4CXX_PRIVATE_PTR(PatternConverterPrivate) priv);

        PatternConverter(const LogString& name,
            const LogString& style);
 
        virtual ~PatternConverter();
 
    public:
        DECLARE_LOG4CXX_PATTERN(PatternConverter)
        BEGIN_LOG4CXX_CAST_MAP()
        LOG4CXX_CAST_ENTRY(PatternConverter)
        END_LOG4CXX_CAST_MAP()

#if LOG4CXX_ABI_VERSION <= 15
        void format(const helpers::ObjectPtr& obj, LogString& toAppendTo) const;
        virtual void format(const helpers::ObjectPtr& obj,
            LogString& toAppendTo,
            helpers::Pool& p) const = 0;
#define LOG4CXX_FORMAT_OBJECT_FORMAL_PARAMETERS const helpers::ObjectPtr& obj, LogString& toAppendTo, helpers::Pool& p
#else
        virtual void format(const helpers::ObjectPtr& obj, LogString& toAppendTo) const = 0;
#define LOG4CXX_FORMAT_OBJECT_FORMAL_PARAMETERS const helpers::ObjectPtr& obj, LogString& toAppendTo
        [[deprecated("Use format() without a Pool parameter instead")]]
        virtual void format(const helpers::ObjectPtr& obj, LogString& toAppendTo, helpers::Pool& p) const;
#endif

        LogString getName() const;

        virtual LogString getStyleClass(const helpers::ObjectPtr& e) const;

        const FormattingInfo& getFormattingInfo() const;

        void setFormattingInfo(const FormattingInfoPtr& newValue);
 
    protected:
        static void append(LogString& toAppendTo, const std::string& src);
};
 
 
LOG4CXX_PTR_DEF(PatternConverter);
 
}
}
 
 
#endif