lestes::lang::cplus::lex::macro_storage Class Reference

Storage of defined macros. More...

#include <macro_storage.hh>

Inheritance diagram for lestes::lang::cplus::lex::macro_storage:

List of all members.

Public Member Functions
void	define (const ptr< macro > &a_macro)
	Defines new macro.
void	undef (const ptr< pp_token > &tok)
	Undefines macro.
bool	defined (const ptr< pp_token > &tok)
	Tests whether a macro is defined.
ptr< macro >	lookup (const ptr< token_value > &a_name)
	Searches for a macro of given name.
void	clear (void)
	Discards user defined macros.
Static Public Member Functions
static ptr< macro_storage >	create (void)
	Returns new storage.
Protected Member Functions
	macro_storage (void)
	Constructs empty object.
virtual void	gc_mark (void)
	Marks the object.
Private Types
typedef map< srp< token_value >, srp< macro > >	storage_type
	Type of storage for macros.
Private Attributes
srp< storage_type >	storage
	Storage for macros.

---

Detailed Description

Storage of defined macros.

Represents storage of defined macros. Handles definition, removal and lookup.

Definition at line 56 of file macro_storage.hh.

---

Member Typedef Documentation

typedef map< srp<token_value>, srp<macro> > lestes::lang::cplus::lex::macro_storage::storage_type [private]

Type of storage for macros.

Definition at line 77 of file macro_storage.hh.

---

Constructor & Destructor Documentation

lestes::lang::cplus::lex::macro_storage::macro_storage

(

void

)

[protected]

Constructs empty object.

Constructs empty object.

Definition at line 53 of file macro_storage.cc.

Referenced by create().

                                :
        storage(storage_type::create())
{
        // TODO pt add predefined
}

---

Member Function Documentation

void lestes::lang::cplus::lex::macro_storage::define

(

const ptr< macro > &

a_macro

)

Defines new macro.

Defines new macro, checks for redefinition.

Precondition:

a_macro != NULL

Parameters:

a_macro

The macro to be defined.

Definition at line 64 of file macro_storage.cc.

References lestes::is_equal(), lassert, lestes::lang::cplus::lex::macro_redefinition_different, lestes::lang::cplus::lex::predefined_macro_redefined, lestes::lang::cplus::lex::previous_definition, lestes::report, and storage.

{
        lassert(a_macro);
        
        ptr<token_value> name = a_macro->name_get();
        
        storage_type::iterator it = storage->find(name);
        if (it == storage->end()) {
                storage->insert(make_pair(name,a_macro));
                return;
        }
        
        ptr<macro> orig = (*it).second;
        if (orig->predefined_get()) {
                // redefinition of predefined internal macro
                report << predefined_macro_redefined << name->content_get() << a_macro->location_get();
                return;
        }
        
        // redefinition is equivalent, do nothing
        if (is_equal(a_macro,orig)) return;

        // macro redefinition is different
        report << macro_redefinition_different << name->content_get() << a_macro->location_get();
        // this is the location of the previous definition
        report << previous_definition << orig->location_get();
}

void lestes::lang::cplus::lex::macro_storage::undef

(

const ptr< pp_token > &

tok

)

Undefines macro.

Undefines macro, checks whether was defined.

Precondition:

tok != NULL

Parameters:

tok

The token with name of macro to undefine.

Definition at line 98 of file macro_storage.cc.

References lestes::lang::cplus::lex::expected_macro_name, lassert, lestes::lang::cplus::lex::predefined_macro_undefined, lestes::report, and storage.

{
        lassert(tok);
  
        if (!tok->is_name()) {
                // expected name of macro to undefine
                report << expected_macro_name << tok->location_get();
                return;
        }
  
        ptr<token_value> name = tok->value_get();

        storage_type::iterator it = storage->find(name);
        if (it == storage->end()) return;
        
        ptr<macro> m = (*it).second;
        
        if (m->predefined_get()) {
                // undefining predefined macro
                report << predefined_macro_undefined << name->content_get() << tok->location_get();
                return;
        }

        storage->erase(it);
}

bool lestes::lang::cplus::lex::macro_storage::defined

(

const ptr< pp_token > &

tok

)

Tests whether a macro is defined.

Tests whether macro of the given name is currently defined.

Precondition:

tok != NULL

Parameters:

tok

The token containing macro name to test.

Returns:

true If the macro of this name is defined.

Definition at line 130 of file macro_storage.cc.

References lestes::lang::cplus::lex::expected_macro_name, lassert, lestes::report, and storage.

{
        lassert(tok);

        if (!tok->is_name()) {
                // expected name of macro
                report << expected_macro_name << tok->location_get();
                // such macro is not defined
                return false;
        }
  
        ptr<token_value> name = tok->value_get();

        return storage->find(name) != storage->end();
}

ptr< macro > lestes::lang::cplus::lex::macro_storage::lookup

(

const ptr< token_value > &

name

)

Searches for a macro of given name.

Searches for macro of given name.

Todo:

pt return special values for __LINE__ etc

Precondition:

name != NULL

Parameters:

name

The name of the searched macro.

Returns:

The macro of the given name, or NULL if such macro is not defined.

Definition at line 153 of file macro_storage.cc.

References lassert, and storage.

{
        lassert(name);

        // TODO check special names (__LINE__) etc
        storage_type::iterator it = storage->find(name);
        if (it == storage->end()) return NULL;
        return (*it).second;
}

void lestes::lang::cplus::lex::macro_storage::clear

(

void

)

Discards user defined macros.

ptr< macro_storage > lestes::lang::cplus::lex::macro_storage::create

(

void

)

[static]

Returns new storage.

Returns new instance of the class.

Returns:

The new storage.

Definition at line 176 of file macro_storage.cc.

References macro_storage().

{
        return new macro_storage();
}

void lestes::lang::cplus::lex::macro_storage::gc_mark

(

void

)

[protected, virtual]

Marks the object.

Marks the object.

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

Definition at line 166 of file macro_storage.cc.

References lestes::std::mem::keystone::gc_mark(), and storage.

{
        storage.gc_mark();
	::lestes::std::object::gc_mark();
}

---

Member Data Documentation

srp<storage_type> lestes::lang::cplus::lex::macro_storage::storage [private]

Storage for macros.

Definition at line 79 of file macro_storage.hh.

Referenced by define(), defined(), gc_mark(), lookup(), and undef().

---

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

• macro_storage.hh
• macro_storage.cc

---