lestes::msg::message_stencil Class Reference

Message stencil base. More...

#include <message_stencil.hh>

Inheritance diagram for lestes::msg::message_stencil:

List of all members.

Public Member Functions
ulint	nparams_get (void) const
	Returns the number of parameters.
ulint	kind_get (void) const
	Returns the unique kind identification.
bool	equals (const ptr< message_stencil > &other) const
	Tests equality.
Protected Types
typedef message::flags_type	flags_type
	Type of message flags.
typedef ::lestes::std::vector< lstring >	args_type
	Type of argument list.
Protected Member Functions
	message_stencil (ulint a_nparams, const lstring &a_format, flags_type a_flags)
	Creates the message stencil.
ptr< message >	generate (const ptr< args_type > &args) const
	Returns a formatted message.
void	gc_mark (void)
	Marks the object.
Private Types
typedef ::lestes::std::vector< lstring >	texts_type
	Type of storage for message texts.
typedef ::lestes::std::vector< ulint >	params_type
	Type of storage for parameters.
Private Member Functions
void	parse (const lstring &a_format)
	Parses the format string.
	message_stencil (const message_stencil &)
	Hides copy constructor.
message_stencil &	operator= (const message_stencil &)
	Hides assignment operator.
Private Attributes
ulint	nparams
	Number of parameters.
ulint	kind
	The unique identification of message kind.
flags_type	flags
	Message flags.
srp< texts_type >	texts
	The parsed texts.
srp< params_type >	params
	The parsed parameters.
Static Private Attributes
static ulint	kind_counter = 0
	The internal counter to distinguish instances.

---

Detailed Description

Message stencil base.

Represents base class parametrised stencil for creating formatted messages. Each instance of stencil represents one unique message family (generating the same kind of messages). Each instance is assigned an unique identification number to help expressing sets of message kinds efficiently, for example via bit vectors. It is however, not assured, that one object will get the same id each time.

The format text recognizes parameter reference in the form D where D is a decimal digit. The parameter numbering starts with 0 and only valid indexes are accepted. The reference to a single parameter can appear zero or more times, in no particular order. To express a single %, %% is used. Any other character after % is not allowed and neither is end of string.

Example: "Value %0 is invalid in %3, %0 is out of range %1 - %2 allowed for %3"

Implementation details: The parsed format text is stored as a sequence of parameter indexes with a special value (equal to the number of parameters) designating use of next part of text, stored in another sequence.

Definition at line 66 of file message_stencil.hh.

---

Member Typedef Documentation

typedef message::flags_type lestes::msg::message_stencil::flags_type [protected]

Type of message flags.

Definition at line 76 of file message_stencil.hh.

typedef ::lestes::std::vector<lstring> lestes::msg::message_stencil::args_type [protected]

Type of argument list.

Definition at line 78 of file message_stencil.hh.

typedef ::lestes::std::vector<lstring> lestes::msg::message_stencil::texts_type [private]

Type of storage for message texts.

Definition at line 87 of file message_stencil.hh.

typedef ::lestes::std::vector<ulint> lestes::msg::message_stencil::params_type [private]

Type of storage for parameters.

Definition at line 89 of file message_stencil.hh.

---

Constructor & Destructor Documentation

lestes::msg::message_stencil::message_stencil	(	ulint	a_nparams,
		const lstring &	a_format,
		flags_type	a_flags
	)			[protected]

Creates the message stencil.

Creates the stencil, initializes with number of expected parameters and values to fill into the message. Assigns a unique id number, starting from zero.

Precondition:

The format string is well-formed.

Parameters:

	a_nparams	Number of parameters for the stencil.
	a_format	The format for the message, with % designating indexed parameter slots.
	a_flags	The flags for the message.

Definition at line 48 of file message_stencil.cc.

References parse().

                                                                                            :
        nparams(a_nparams),
        kind(kind_counter++),
        flags(a_flags),
        texts(texts_type::create()),
        params(params_type::create())
{
        // attempt to fill internal structures for faster message creation
        parse(a_format);
}

lestes::msg::message_stencil::message_stencil

(

const message_stencil &

)

[private]

Hides copy constructor.

---

Member Function Documentation

ulint lestes::msg::message_stencil::nparams_get

(

void

)

const

Returns the number of parameters.

Returns the number of parameters for the message.

Returns:

The number of parameters.

Definition at line 63 of file message_stencil.cc.

References nparams.

{
        return nparams;
}

ulint lestes::msg::message_stencil::kind_get

(

void

)

const

Returns the unique kind identification.

Returns the assigned unique identification number. The number is only for internal use and may vary between compilations.

Returns:

The kind identification number.

Definition at line 73 of file message_stencil.cc.

References kind.

{
        return kind;
}

bool lestes::msg::message_stencil::equals

(

const ptr< message_stencil > &

other

)

const

Tests equality.

Tests equality to other stencil. Each stencil object represents one message kind and is thus unique.

Parameters:

other

The stencil to compare to.

Returns:

true If both stencils point to the same object.

Definition at line 84 of file message_stencil.cc.

{
        return other && other == this;
}

ptr< message > lestes::msg::message_stencil::generate

(

const ptr< args_type > &

args

)

const [protected]

Returns a formatted message.

Returns message with arguments filled into the parameter slots.

Precondition:

args != NULL

args->size() == nparams_get()

Parameters:

args

The arguments for the message.

Definition at line 148 of file message_stencil.cc.

References lestes::msg::message::create(), flags, kind, lassert, nparams, params, and texts.

Referenced by lestes::msg::message_stencil3< P0, P1, P2 >::format(), lestes::msg::message_stencil2< P0, P1 >::format(), lestes::msg::message_stencil1< P0 >::format(), and lestes::msg::message_stencil0< T >::format().

{
        lassert(args);
        lassert(args->size() == nparams);
        
        lstring result;
        
        texts_type::iterator tit = texts->begin();
        texts_type::iterator tend = texts->end();
        
        for (params_type::iterator it = params->begin(), end = params->end(); it != end; ++it) {
                ulint idx = *it;
                if (idx == nparams) {
                        lassert(tit != tend);
                        result += *tit;
                        ++tit;
                } else {
                        lassert(idx < nparams);
                        // operator[] does no range check
                        result += args->operator[](idx);
                }
        }

        // pass all stored info
        return message::create(kind,result,flags);
}

void lestes::msg::message_stencil::gc_mark

(

void

)

[protected, virtual]

Marks the object.

Marks the object for garbage collection.

Reimplemented from lestes::std::mem::keystone.

Reimplemented in lestes::msg::message_stencil0< T >, lestes::msg::message_stencil1< P0 >, lestes::msg::message_stencil2< P0, P1 >, and lestes::msg::message_stencil3< P0, P1, P2 >.

Definition at line 178 of file message_stencil.cc.

References params, and texts.

Referenced by lestes::msg::message_stencil3< P0, P1, P2 >::gc_mark(), lestes::msg::message_stencil2< P0, P1 >::gc_mark(), lestes::msg::message_stencil1< P0 >::gc_mark(), and lestes::msg::message_stencil0< T >::gc_mark().

{
        texts.gc_mark();
        params.gc_mark();
        object::gc_mark();
}

void lestes::msg::message_stencil::parse

(

const lstring &

a_format

)

[private]

Parses the format string.

Parses the format text.

Precondition:

The text is well-formed according to the class documentation.

Parameters:

text

The text to parse.

Definition at line 94 of file message_stencil.cc.

References lassert2, nparams, params, texts, and u.

Referenced by message_stencil().

{
        bool percent = false;
        // start of not yet stored part
        ulint start = 0;
        lstring out;
        
        for (ulint i = 0, len = a_format.length(); i < len; i++) {
                char c = a_format[i];
                if (percent) {
                        // add the part of a_format before the % sequence
                        out += a_format.substr(start,i - start - 1);
                        if (c == '%') {
                                out += '%';
                        } else {
                                ucn u = character::create_from_host(c);
                        
                                lassert2(character::is_digit(u),"Invalid `%' sequence.");
                                ulint x = character::extract_digit(u);
                                lassert2(x < nparams,"Invalid parameter in `%' sequence.");
                                
                                if (out.length()) {
                                        // flush the a_format before the parameter
                                        texts->push_back(out);
                                        out = "";
                                        // signal a_format output
                                        params->push_back(nparams);
                                }
                                params->push_back(x);
                        }
                        start = i + 1;
                        percent = false;
                } else {
                        percent = (c == '%');
                }
        }

        lassert2(!percent,"Unterminated `%' sequence.");

        out += a_format.substr(start);
        if (out.length()) {
                // flush the last a_format
                texts->push_back(out);
                // signal a_format output
                params->push_back(nparams);
        }
}

message_stencil& lestes::msg::message_stencil::operator=

(

const message_stencil &

)

[private]

Hides assignment operator.

---

Member Data Documentation

ulint lestes::msg::message_stencil::nparams [private]

Number of parameters.

Definition at line 93 of file message_stencil.hh.

Referenced by generate(), nparams_get(), and parse().

ulint lestes::msg::message_stencil::kind [private]

The unique identification of message kind.

Definition at line 95 of file message_stencil.hh.

Referenced by generate(), and kind_get().

flags_type lestes::msg::message_stencil::flags [private]

Message flags.

Definition at line 97 of file message_stencil.hh.

Referenced by generate().

srp<texts_type> lestes::msg::message_stencil::texts [private]

The parsed texts.

Definition at line 99 of file message_stencil.hh.

Referenced by gc_mark(), generate(), and parse().

srp<params_type> lestes::msg::message_stencil::params [private]

The parsed parameters.

Definition at line 101 of file message_stencil.hh.

Referenced by gc_mark(), generate(), and parse().

ulint lestes::msg::message_stencil::kind_counter = 0 [static, private]

The internal counter to distinguish instances.

Internal message stencil instance identification number counter.

Definition at line 107 of file message_stencil.hh.

---

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

• message_stencil.hh
• message_stencil.cc

---