Om  1.0.0
A universal framework for multimedia simulation
Public Member Functions | Static Public Member Functions | List of all members
om::scripting::mir::lang::Identifier Class Reference

A class that represents a single-word identifying name within Mir source code. More...

#include <omScriptingMirIdentifier.h>

Inheritance diagram for om::scripting::mir::lang::Identifier:
om::scripting::mir::lang::ASTNode

Public Member Functions

 Identifier (const String &newSpelling)
 Create a new identifier object with the specified string spelling. More...
 
Bool operator== (const Identifier &other) const
 Return whether or not the spelling of this identifier exactly matches that of another. More...
 
Bool operator!= (const Identifier &other) const
 Return whether or not the spelling of this identifier doesn't match that of another. More...
 
 operator const String & () const
 Convert this identifier to a string representing its spelling in the source code. More...
 
const String & getSpelling () const
 Convert this identifier to a string representing its spelling in the source code. More...
 
- Public Member Functions inherited from om::scripting::mir::lang::ASTNode
 ASTNode ()
 Create a new AST node with no node position specified. More...
 
 ASTNode (const Position &newPosition)
 Create a new AST node which corresponds to a token starting at the specified source code position. More...
 
virtual ~ASTNode ()
 Destroy this AST node object. More...
 
const PositiongetPosition () const
 Return an object representing the position of this AST node in the source code. More...
 
void setPosition (const Position &newPosition)
 Set the position of this AST node in the source code. More...
 

Static Public Member Functions

static Shared< Identifierconstruct (const String &newSpelling)
 Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...
 

Detailed Description

A class that represents a single-word identifying name within Mir source code.

Constructor & Destructor Documentation

om::scripting::mir::lang::Identifier::Identifier ( const String &  newSpelling)
inline

Create a new identifier object with the specified string spelling.

Member Function Documentation

Bool om::scripting::mir::lang::Identifier::operator== ( const Identifier other) const
inline

Return whether or not the spelling of this identifier exactly matches that of another.

Bool om::scripting::mir::lang::Identifier::operator!= ( const Identifier other) const
inline

Return whether or not the spelling of this identifier doesn't match that of another.

om::scripting::mir::lang::Identifier::operator const String & ( ) const
inline

Convert this identifier to a string representing its spelling in the source code.

const String& om::scripting::mir::lang::Identifier::getSpelling ( ) const
inline

Convert this identifier to a string representing its spelling in the source code.

static Shared<Identifier> om::scripting::mir::lang::Identifier::construct ( const String &  newSpelling)
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: