lestes::msg::message Class Reference

Message wrapper. More...

#include <message.hh>

Inheritance diagram for lestes::msg::message:

List of all members.

Public Types
enum	message_flags {   FLG_NONE = 0x0, FLG_FATAL = 0x1, FLG_ERROR = 0x2, FLG_WARNING = 0x4,   FLG_HINT = 0x8 }
	Type of message flags. More...
typedef enum lestes::msg::message::message_flags	flags_type
	Type of message flags.
Public Member Functions
ulint	kind_get (void) const
	Returns stencil kind identification.
lstring	text_get (void) const
	Returns the message text.
flags_type	flags_get (void) const
	Returns message flags.
bool	equals (const ptr< message > &other) const
	Tests equality.
Static Public Member Functions
static ptr< message >	create (ulint a_id, const lstring &a_text, flags_type a_flags)
	Returns new message.
Protected Member Functions
	message (const message &)
	Hides copy constructor.
message &	operator= (const message &)
	Hides assignment operator.
Protected Attributes
ulint	kind
	Identification of message kind.
lstring	text
	Message text.
flags_type	flags
	Message flags.
Private Member Functions
	message (ulint a_id, const lstring &a_text, flags_type a_flags)
	Creates a message.

---

Detailed Description

Message wrapper.

Represents text message with message kind identification and flags. The message is usually returned from message stencil.

Definition at line 48 of file message.hh.

---

Member Typedef Documentation

typedef enum lestes::msg::message::message_flags lestes::msg::message::flags_type

Type of message flags.

---

Member Enumeration Documentation

enum lestes::msg::message::message_flags

Type of message flags.

Enumerator:

FLG_NONE	General message.
FLG_FATAL	Fatal error message.
FLG_ERROR	Error message.
FLG_WARNING	Warning message.
FLG_HINT	Hint message.

Definition at line 51 of file message.hh.

                                   {
                //! General message.
                FLG_NONE = 0x0,
                //! Fatal error message.
                FLG_FATAL = 0x1,
                //! Error message.
                FLG_ERROR = 0x2,
                //! Warning message.
                FLG_WARNING = 0x4,
                //! Hint message.
                FLG_HINT = 0x8
        } flags_type;

---

Constructor & Destructor Documentation

lestes::msg::message::message	(	ulint	a_kind,
		const lstring &	a_text,
		flags_type	a_flags
	)			[private]

Creates a message.

Creates a message.

Parameters:

	a_kind	The identification of the message kind.
	a_tex	The text of the message.
	a_flags	The flags for the message.

Definition at line 47 of file message.cc.

Referenced by create().

                                                                       :
        kind(a_kind),
        text(a_text),
        flags(a_flags)
{
}

lestes::msg::message::message

(

const message &

)

[protected]

Hides copy constructor.

---

Member Function Documentation

ulint lestes::msg::message::kind_get

(

void

)

const

Returns stencil kind identification.

Returns messsage kind identification.

Returns:

The identification number of the message kind.

Definition at line 58 of file message.cc.

References kind.

{
        return kind;
}

lstring lestes::msg::message::text_get

(

void

)

const

Returns the message text.

Returns the messsage text.

Returns:

The text of the message.

Definition at line 67 of file message.cc.

References text.

{
        return text;
}

message::flags_type lestes::msg::message::flags_get

(

void

)

const

Returns message flags.

Returns the messsage flags.

Returns:

The flags of the message.

Definition at line 76 of file message.cc.

References flags.

{
        return flags;
}

bool lestes::msg::message::equals

(

const ptr< message > &

other

)

const

Tests equality.

Tests equality to other message.

Parameters:

other

The message to compare to.

Returns:

true If both messages have the same fields.

Definition at line 86 of file message.cc.

References flags, lestes::is_equal(), kind, and text.

{
        return other &&
                is_equal(kind,other->kind_get()) &&
                is_equal(text,other->text_get()) &&
                is_equal(flags,other->flags_get());
}

ptr< message > lestes::msg::message::create	(	ulint	a_kind,
		const lstring &	a_text,
		flags_type	a_flags
	)			[static]

Returns new message.

Returns new message.

Parameters:

	a_kind	The unique identification the message kind.
	a_text	The text of the message.
	a_flags	The flags for the message.

Returns:

The message with supplied text.

Definition at line 101 of file message.cc.

References message().

Referenced by lestes::msg::message_stencil::generate(), lestes::lang::cplus::lex::special_tokens::read(), and lestes::lang::cplus::lex::encoder_host::read().

{
        return new message(a_kind,a_text,a_flags);
}

message& lestes::msg::message::operator=

(

const message &

)

[protected]

Hides assignment operator.

---

Member Data Documentation

ulint lestes::msg::message::kind [protected]

Identification of message kind.

Definition at line 78 of file message.hh.

Referenced by equals(), and kind_get().

lstring lestes::msg::message::text [protected]

Message text.

Definition at line 80 of file message.hh.

Referenced by equals(), and text_get().

flags_type lestes::msg::message::flags [protected]

Message flags.

Definition at line 82 of file message.hh.

Referenced by equals(), and flags_get().

---

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

• message.hh
• message.cc

---