om::scripting::mir::lang::IDTable Class Reference

A class that provides a data structure for efficiently resolving identifier names. More...

#include <omScriptingMirIDTable.h>

Public Member Functions
	IDTable ()
	Create a new empty ID table. More...
Bool	getEntry (const String &name, IDTableEntry *&entry)
	Find the entry with the specified name and place it in the output entry parameter. More...
Bool	getEntry (const String &name, const IDTableEntry *&entry) const
	Find the entry with the specified name and place it in the output entry parameter. More...
Bool	addEntry (const String &name, const IDTableEntry &newEntry)
	Add a new entry to this ID table with the specified name and entry. More...
Bool	containsEntry (const String &name)
	Return whether or not this ID table contains an entry with the specified name. More...
Bool	getImportEntry (const String &name, const IDTableEntry *&entry)
	Find the imported entry with the specified name and place it in the output entry parameter. More...
Bool	addImportEntry (const String &name, const IDTableEntry &newEntry)
	Add a new imported entry to this ID table with the specified name and entry. More...
Bool	containsImportEntry (const String &name)
	Return whether or not this ID table contains an imported entry with the specified name. More...

Static Public Member Functions
static Shared< IDTable >	construct ()
	Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...

Detailed Description

A class that provides a data structure for efficiently resolving identifier names.

Constructor & Destructor Documentation

om::scripting::mir::lang::IDTable::IDTable

(

)

Create a new empty ID table.

Member Function Documentation

Bool om::scripting::mir::lang::IDTable::getEntry	(	const String &	name,
		IDTableEntry *&	entry
	)

Find the entry with the specified name and place it in the output entry parameter.

If there exists an identifier with the specified name, the method places a pointer to the associated table entry in the output entry parameter and returns TRUE, indicating success. If there is no such entry, FALSE is returned and the output parameter is not changed.

Bool om::scripting::mir::lang::IDTable::getEntry	(	const String &	name,
		const IDTableEntry *&	entry
	)		const

Find the entry with the specified name and place it in the output entry parameter.

If there exists an identifier with the specified name, the method places a pointer to the associated table entry in the output entry parameter and returns TRUE, indicating success. If there is no such entry, FALSE is returned and the output parameter is not changed.

Bool om::scripting::mir::lang::IDTable::addEntry	(	const String &	name,
		const IDTableEntry &	newEntry
	)

Add a new entry to this ID table with the specified name and entry.

Bool om::scripting::mir::lang::IDTable::containsEntry

(

const String &

name

)

Return whether or not this ID table contains an entry with the specified name.

Bool om::scripting::mir::lang::IDTable::getImportEntry	(	const String &	name,
		const IDTableEntry *&	entry
	)

Find the imported entry with the specified name and place it in the output entry parameter.

If there exists an identifier with the specified name, the method places a pointer to the associated table entry in the output entry parameter and returns TRUE, indicating success. If there is no such entry, FALSE is returned and the output parameter is not changed.

Bool om::scripting::mir::lang::IDTable::addImportEntry	(	const String &	name,
		const IDTableEntry &	newEntry
	)

Add a new imported entry to this ID table with the specified name and entry.

Bool om::scripting::mir::lang::IDTable::containsImportEntry

(

const String &

name

)

Return whether or not this ID table contains an imported entry with the specified name.

static Shared<IDTable> om::scripting::mir::lang::IDTable::construct ( )

inlinestatic

Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments.

---

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

• omScriptingMirIDTable.h