PatternLayout.hh

Go to the documentation of this file.

/*
 * PatternLayout.hh
 *
 * Copyright 2002, Bastiaan Bakker. All rights reserved.
 *
 * See the COPYING file for the terms of usage and distribution.
 */

#ifndef _LOG4CPP_PATTERNLAYOUT_HH
#define _LOG4CPP_PATTERNLAYOUT_HH

#include "Base/GCException.h"
#include <log4cpp/Portability.hh>
#include <log4cpp/Layout.hh>
#include <log4cpp/Configurator.hh>
#include <vector>
#ifdef LOG4CPP_HAVE_SSTREAM
#include <sstream>
#endif

LOG4CPP_NS_BEGIN

class LOG4CPP_EXPORT PatternLayout : public Layout {
public:
    static const char* DEFAULT_CONVERSION_PATTERN;

    static const char* SIMPLE_CONVERSION_PATTERN;

    static const char* BASIC_CONVERSION_PATTERN;

    static const char* TTCC_CONVERSION_PATTERN;

    PatternLayout();
    virtual ~PatternLayout();

    // NOTE: All double percentage signs ('%%') followed by a character
    //       in the following comments should actually be a single char.
    //       The doubles are included so that doxygen will print them correctly.
    virtual std::string format(const LoggingEvent& event);

    virtual void setConversionPattern(const std::string& conversionPattern);
    //throw (GenICam::InvalidArgumentException);

    virtual void setConversionPattern(const char* conversionPattern);
    //throw (GenICam::InvalidArgumentException);

    virtual std::string getConversionPattern() const;

    virtual void clearConversionPattern();

    class LOG4CPP_EXPORT PatternComponent {
    public:
        inline virtual ~PatternComponent() {};
        virtual void append(std::ostringstream& out, const LoggingEvent& event) = 0;
    };

private:
    typedef std::vector<PatternComponent*> ComponentVector;
    ComponentVector _components;

    std::string _conversionPattern;
};
LOG4CPP_NS_END

#endif // _LOG4CPP_PATTERNLAYOUT_HH