* DEBUG - Hello world
*
*
* {@link PatternLayout} offers a much more powerful alternative.
*/
class DCMTK_LOG4CPLUS_EXPORT SimpleLayout
: public Layout
{
public:
SimpleLayout();
SimpleLayout(const log4cplus::helpers::Properties& properties);
virtual ~SimpleLayout();
virtual void formatAndAppend(log4cplus::tostream& output,
const log4cplus::spi::InternalLoggingEvent& event);
private:
// Disallow copying of instances of this class
SimpleLayout(const SimpleLayout&);
SimpleLayout& operator=(const SimpleLayout&);
};
/**
* TTCC layout format consists of time, thread, Logger and nested
* diagnostic context information, hence the name.
*
* The time format depends on the DateFormat used. Use the
* Use_gmtime to specify whether messages should be logged using
* localtime or gmtime.
*
* Here is an example TTCCLayout output:
*
*
* 176 [main] INFO org.apache.log4j.examples.Sort - Populating an array of 2 elements in reverse order.
* 225 [main] INFO org.apache.log4j.examples.SortAlgo - Entered the sort method.
* 262 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=1 - Outer loop.
* 276 [main] DEBUG org.apache.log4j.examples.SortAlgo.SWAP i=1 j=0 - Swapping intArray[0] = 1 and intArray[1] = 0
* 290 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=0 - Outer loop.
* 304 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Dump of interger array:
* 317 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Element [0] = 0
* 331 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Element [1] = 1
* 343 [main] INFO org.apache.log4j.examples.Sort - The next log statement should be an error message.
* 346 [main] ERROR org.apache.log4j.examples.SortAlgo.DUMP - Tried to dump an uninitialized array.
* 467 [main] INFO org.apache.log4j.examples.Sort - Exiting main method.
*
*
* The first field is the number of milliseconds elapsed since the
* start of the program. The second field is the thread outputting the
* log statement. The third field is the LogLevel, the fourth field is
* the logger to which the statement belongs.
*
* The fifth field (just before the '-') is the nested diagnostic
* context. Note the nested diagnostic context may be empty as in the
* first two statements. The text after the '-' is the message of the
* statement.
*
* PatternLayout offers a much more flexible alternative.
*/
class DCMTK_LOG4CPLUS_EXPORT TTCCLayout
: public Layout
{
public:
// Ctor and dtor
TTCCLayout(bool use_gmtime = false);
TTCCLayout(const log4cplus::helpers::Properties& properties);
virtual ~TTCCLayout();
virtual void formatAndAppend(log4cplus::tostream& output,
const log4cplus::spi::InternalLoggingEvent& event);
protected:
log4cplus::tstring dateFormat;
bool use_gmtime;
private:
// Disallow copying of instances of this class
TTCCLayout(const TTCCLayout&);
TTCCLayout& operator=(const TTCCLayout&);
};
DCMTK_LOG4CPLUS_EXPORT helpers::Time const & getTTCCLayoutTimeBase ();
/**
* 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();
* DCMTK_LOG4CPLUS_DEBUG(root, "Message 1");
* DCMTK_LOG4CPLUS_WARN(root, "Message 2");
*
* 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:
*
strftime() function
* found in the <ctime> header for more information.
* |
*
| 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 the
* DCMTK_LOG4CPLUS_DISABLE_FUNCTION_MACRO macro, %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. | *
| P | *Used to output the first character of the LogLevel of the logging event. * NOTE: This pattern has been added to log4cplus. * | *
| 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. * |