Synesis Software STLSoft - ... Robust, Lightweight, Cross-platform, Template Software ...

character Class Reference
[Inserters]

#include <pantheios/inserters/character.hpp>

List of all members.


Detailed Description

Class for inserting characters into Pantheios diagnostic logging statements.

This class converts a character variable into a string, thereby enabling it to be inserted into a logging statement. Consider the following statement:

  char        c   = '#';
  char        s[] = "abc";
  std::string str("def");

  pantheios::log(pantheios::notice, "s=", s, ", c=", pantheios::character(c), ", str=", str);

This will produce the output:

    s=abc, c=#, str=def

Note:
Currently, Pantheios does not support the insertion of character types in diagnostic logging statements, due to the various ambiguities inherent in the C++ language. (See chapters 14, 15, 19, 24 of Imperfect C++ for discussions of these issues.) It is possible that a future version of the library will be able to incorporate them directly, so long as that does not sacrifice Pantheios's central claim of not paying for what you don't use.
Examples:

cpp/inserters/example.cpp.inserter.character/example.cpp.inserter.character.cpp, and cpp/misc/example.cpp.misc.101/example.cpp.misc.101.cpp.


Public Types

typedef character class_type
 This type.

Public Member Functions

 character (char value)
 Construct from a char value.
pan_char_t const * data () const
 A possibly non-nul-terminated non-null pointer to the c-style string representation of the character.
pan_char_t const * c_str () const
 A nul-terminated non-null pointer to the c-style string representation of the character.
size_t length () const
 The length of the c-style string representation of the character.

Member Typedef Documentation

typedef character class_type

This type.


Constructor & Destructor Documentation

character ( char  value  )  [inline, explicit]

Construct from a char value.


Member Function Documentation

pan_char_t const * data (  )  const [inline]

A possibly non-nul-terminated non-null pointer to the c-style string representation of the character.

pan_char_t const * c_str (  )  const [inline]

A nul-terminated non-null pointer to the c-style string representation of the character.

size_t length (  )  const [inline]

The length of the c-style string representation of the character.


The documentation for this class was generated from the following file:

pantheios Library documentation Matthew Wilson & Synesis Software, 2006-2011 SourceForge.net Logo