摘自log4cplus-1.1.1-rc4/include/log4cplus/layout.h <br/><br/>
A flexible layout configurable with pattern string. The goal of this class is to format a InternalLoggingEvent and return the results as a string. The results depend on the conversion pattern. The conversion pattern is closely related to the conversion pattern of the printf function in C. A conversion pattern is composed of literal text and format control expressions called conversion specifiers. You are free to insert any literal text within the conversion pattern. Each conversion specifier starts with a percent sign (%%) and is followed by optional format modifiers and a conversion character. The conversion character specifies the type of data, e.g. Logger, LogLevel, date, thread name. The format modifiers control such things as field width, padding, left and right justification. The following is a simple example. Let the conversion pattern be "%-5p [%t]: %m%n" and assume that the log4cplus environment was set to use a PatternLayout. Then the statements
Logger root = Logger.getRoot();
LOG4CPLUS_DEBUG(root, "Message 1");
LOG4CPLUS_WARN(root, "Message 2");
would yield the output
DEBUG [main]: Message 1
WARN [main]: Message 2
Note that there is no explicit separator between text and conversion specifiers. The pattern parser knows when it has reached the end of a conversion specifier when it reads a conversion character. In the example above the conversion specifier
"%-5p" means the LogLevel of the logging event should be left justified to a width of five characters. * The recognized conversion characters are*****************
Conversion Character | Effect |
b | Used to output file name component of path name. E.g. main.cxx from path ../../main.cxx. |
c | Used to output the logger of the logging event. The logger conversion specifier can be optionally followed by precision specifier, that is a decimal constant in brackets. If a precision specifier is given, then only the corresponding number of right most components of the logger name will be printed. By default the logger name is printed in full. For example, for the logger name "a.b.c" the pattern %c{2} will output "b.c". |
d | Used to output the date of the logging event in UTC. * The date conversion specifier may be followed by a date format specifier enclosed between braces. For example, %%d{%%H:%%M:%%s} or %%d{%%d %%b %%Y %%H:%%M:%%s}. If no date format specifier is given then %%d{%%d %%m %%Y %%H:%%M:%%s} is assumed. * The Following format options are possible:
|
D | Used to output the date of the logging event in local time. * All of the above information applies. |
F | Used to output the file name where the logging request was issued. NOTE Unlike log4j, there is no performance penalty for calling this method. |
h | Used to output the hostname of this system (as returned by gethostname(2)). * NOTE The hostname is only retrieved once at initialization. * |
H | Used to output the fully-qualified domain name of this system (as returned by gethostbyname(2) for the hostname returned by gethostname(2)). * NOTE The hostname is only retrieved once at initialization. * |
l | Equivalent to using "%F:%L" NOTE: Unlike log4j, there is no performance penalty for calling this method. |
L | Used to output the line number from where the logging request was issued. NOTE: Unlike log4j, there is no performance penalty for calling this method. |
m | Used to output the application supplied message associated with the logging event. |
M | Used to output function name using__FUNCTION__or similar macro. * NOTE The__FUNCTION__macro is not standard but it is common extension provided by all compilers (as of 2010). In case it is missing or in case this feature is disabled using theLOG4CPLUS_DISABLE_FUNCTION_MACROmacro, %M expands to an empty string. |
n | Outputs the platform dependent line separator character or characters. |
p | Used to output the LogLevel of the logging event. |
r | Used to output miliseconds since program start of the logging event. |
t | Used to output the name of the thread that generated the logging event. |
T | Used to output alternative name of the thread that generated the logging event. |
i | Used to output the process ID of the process that generated the logging event. |
x | Used to output the NDC (nested diagnostic context) associated with the thread that generated the logging event. |
"%%" | The sequence "%%" outputs a single percent sign. |
Format modifier | left justify | minimum width | maximum width | comment |
%20c | false | 20 | none | Left pad with spaces if the logger name is less than 20 characters long. |
%-20c | true | 20 | none | Right pad with spaces if the logger name is less than 20 characters long. |
%.30c | NA | none | 30 | Truncate from the beginning if the logger name is longer than 30 characters. |
%20.30c | false | 20 | 30 | Left pad with spaces if the logger name is shorter than 20 characters. However, if logger name is longer than 30 characters, then truncate from the beginning. |
%-20.30c | true | 20 | 30 | Right pad with spaces if the logger name is shorter than 20 characters. However, if logger name is longer than 30 characters, then truncate from the beginning. |