log4cpp  1.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
PatternLayout.hh
Go to the documentation of this file.
1 /*
2  * PatternLayout.hh
3  *
4  * Copyright 2002, Bastiaan Bakker. All rights reserved.
5  *
6  * See the COPYING file for the terms of usage and distribution.
7  */
8 
9 #ifndef _LOG4CPP_PATTERNLAYOUT_HH
10 #define _LOG4CPP_PATTERNLAYOUT_HH
11 
12 #include <log4cpp/Portability.hh>
13 #include <log4cpp/Layout.hh>
14 #include <log4cpp/Configurator.hh>
15 #include <vector>
16 #ifdef LOG4CPP_HAVE_SSTREAM
17 #include <sstream>
18 #endif
19 
20 namespace log4cpp {
21 
26  public:
30  static const char* DEFAULT_CONVERSION_PATTERN;
31 
35  static const char* SIMPLE_CONVERSION_PATTERN;
36 
40  static const char* BASIC_CONVERSION_PATTERN;
41 
46  static const char* TTCC_CONVERSION_PATTERN;
47 
48  PatternLayout();
49  virtual ~PatternLayout();
50 
51  // NOTE: All double percentage signs ('%%') followed by a character
52  // in the following comments should actually be a single char.
53  // The doubles are included so that doxygen will print them correctly.
59  virtual std::string format(const LoggingEvent& event);
60 
84  virtual void setConversionPattern(const std::string& conversionPattern)
85  throw(ConfigureFailure);
86 
87  virtual std::string getConversionPattern() const;
88 
89  virtual void clearConversionPattern();
90 
92  public:
93  inline virtual ~PatternComponent() {};
94  virtual void append(std::ostringstream& out, const LoggingEvent& event) = 0;
95  };
96 
97  private:
98  typedef std::vector<PatternComponent*> ComponentVector;
99  ComponentVector _components;
100 
101  std::string _conversionPattern;
102  };
103 }
104 
105 #endif // _LOG4CPP_PATTERNLAYOUT_HH
static const char * DEFAULT_CONVERSION_PATTERN
The default conversion pattern.
Definition: PatternLayout.hh:30
Extend this abstract class to create your own log layout format.
Definition: Layout.hh:22
Exception class for configuration.
Definition: Configurator.hh:21
Definition: PatternLayout.hh:91
virtual ~PatternComponent()
Definition: PatternLayout.hh:93
#define LOG4CPP_EXPORT
Definition: Export.hh:19
The top level namespace for all 'Log for C++' types and classes.
Definition: AbortAppender.hh:16
static const char * SIMPLE_CONVERSION_PATTERN
A conversion pattern equivalent to the SimpleLayout.
Definition: PatternLayout.hh:35
The internal representation of logging events.
Definition: LoggingEvent.hh:32
static const char * BASIC_CONVERSION_PATTERN
A conversion pattern equivalent to the BasicLayout.
Definition: PatternLayout.hh:40
static const char * TTCC_CONVERSION_PATTERN
A conversion pattern equivalent to the TTCCLayout.
Definition: PatternLayout.hh:46
Definition: Portability.hh:45
PatternLayout is a simple fixed format Layout implementation.
Definition: PatternLayout.hh:25