topical media & game development
[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

talk show tell print

lib-of-vs-libs-Poco-include-Poco-PatternFormatter.h / h



  //
  // PatternFormatter.h
  //
  // Id: //poco/1.3/Foundation/include/Poco/PatternFormatter.h#2 
  //
  // Library: Foundation
  // Package: Logging
  // Module:  PatternFormatter
  //
  // Definition of the PatternFormatter class.
  //
  // Copyright (c) 2004-2006, Applied Informatics Software Engineering GmbH.
  // and Contributors.
  //
  // Permission is hereby granted, free of charge, to any person or organization
  // obtaining a copy of the software and accompanying documentation covered by
  // this license (the "Software") to use, reproduce, display, distribute,
  // execute, and transmit the Software, and to prepare derivative works of the
  // Software, and to permit third-parties to whom the Software is furnished to
  // do so, all subject to the following:
  // 
  // The copyright notices in the Software and this entire statement, including
  // the above license grant, this restriction and the following disclaimer,
  // must be included in all copies of the Software, in whole or in part, and
  // all derivative works of the Software, unless such copies or derivative
  // works are solely in the form of machine-executable object code generated by
  // a source language processor.
  // 
  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  // FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
  // SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
  // FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
  // ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  // DEALINGS IN THE SOFTWARE.
  //
  
  ifndef Foundation_PatternFormatter_INCLUDED
  define Foundation_PatternFormatter_INCLUDED
  
  include "Poco/Foundation.h"
  include "Poco/Formatter.h"
  include "Poco/Message.h"
  
  namespace Poco {
  
  class Foundation_API PatternFormatter: public Formatter
This Formatter allows for custom formatting of log messages based on format patterns. The format pattern is used as a template to format the message and is copied character by character except for the following special characters, which are replaced by the corresponding value. * %s - message source * %t - message text * %l - message priority level (1 .. 7) * %p - message priority (Fatal, Critical, Error, Warning, Notice, Information, Debug, Trace) * %q - abbreviated message priority (F, C, E, W,N, I, D, T) * %P - message process identifier * %T - message thread name * %I - message thread identifier (numeric) * %N - node or host name * %w - message date/time abbreviated weekday (Mon, Tue, ...) * %W - message date/time full weekday (Monday, Tuesday, ...) * %b - message date/time abbreviated month (Jan, Feb, ...) * %B - message date/time full month (January, February, ...) * %d - message date/time zero-padded day of month (01 .. 31) * %e - message date/time day of month (1 .. 31) * %f - message date/time space-padded day of month ( 1 .. 31) * %m - message date/time zero-padded month (01 .. 12) * %n - message date/time month (1 .. 12) * %o - message date/time space-padded month ( 1 .. 12) * %y - message date/time year without century (70) * %Y - message date/time year with century (1970) * %H - message date/time hour (00 .. 23) * %h - message date/time hour (00 .. 12) * %a - message date/time am/pm * %A - message date/time AM/PM * %M - message date/time minute (00 .. 59) * %S - message date/time second (00 .. 59) * %i - message date/time millisecond (000 .. 999) * %c - message date/time centisecond (0 .. 9) * %z - time zone differential in ISO 8601 format (Z or +NN.NN). * %Z - time zone differential in RFC format (GMT or +NNNN) * %[name] - the value of the message parameter with the given name * %% - percent sign 

  {
  public:
          PatternFormatter();
Creates a PatternFormatter. The format pattern must be specified with a call to setProperty. 

          PatternFormatter(const std::string& format);
Creates a PatternFormatter that uses the given format pattern. 

          ~PatternFormatter();
Destroys the PatternFormatter. 

          void format(const Message& msg, std::string& text);
Formats the message according to the specified format pattern and places the result in text. void setProperty(const std::string& name, const std::string& value); Sets the property with the given name to the given value. The following properties are supported: * pattern: The format pattern. See the PatternFormatter class for details. * times: Specifies whether times are adjusted for local time or taken as they are in UTC. Supported values are "local" and "UTC". If any other property name is given, a PropertyNotSupported exception is thrown. 

          std::string getProperty(const std::string& name) const;
Returns the value of the property with the given name or throws a PropertyNotSupported exception if the given name is not recognized. 

          static const std::string PROP_PATTERN;
          static const std::string PROP_TIMES;
  
  protected:
          static const std::string& getPriorityName(int);
Returns a string for the given priority value. static void fmt(std::string& str, int value); static void fmt(std::string& str, int value, int width); static void fmt0(std::string& str, int value, int width); private: bool _localTime; std::string _pattern; }; 

  } // namespace Poco
  
  endif // Foundation_PatternFormatter_INCLUDED
[] readme course(s) preface I 1 2 II 3 4 III 5 6 7 IV 8 9 10 V 11 12 afterthought(s) appendix reference(s) example(s) resource(s) _

(C) Æliens 04/09/2009

You may not copy or print any of this material without explicit permission of the author or the publisher. In case of other copyright issues, contact the author.