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::StringLiteral Class Reference

A class that represents a string literal within the source code. More...

#include <omScriptingMirLiterals.h>

Inheritance diagram for om::scripting::mir::lang::StringLiteral:
om::scripting::mir::lang::Literal om::scripting::mir::lang::ASTNode

Public Member Functions

 StringLiteral (const UTF8String &newSpelling)
 Create a new string literal object with the specified spelling. More...
 
Bool operator== (const StringLiteral &other) const
 Return whether or not the spelling of this string literal exactly matches that of another. More...
 
Bool operator!= (const StringLiteral &other) const
 Return whether or not the spelling of this string literal doesn't match that of another. More...
 
 operator const UTF8String & () const
 Convert this string literal to a string representing its spelling in the source code. More...
 
const UTF8String & getSpelling () const
 Convert this string literal to a string representing its spelling in the source code. More...
 
- Public Member Functions inherited from om::scripting::mir::lang::Literal
Type getType () const
 Convert this visibility type to an enum value. 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< StringLiteralconstruct (const UTF8String &newSpelling)
 Construct a smart-pointer-wrapped instance of this class using the constructor with the given arguments. More...
 

Additional Inherited Members

- Public Types inherited from om::scripting::mir::lang::Literal
enum  Type {
  INTEGER_LITERAL, FLOAT_LITERAL, STRING_LITERAL, BOOLEAN_LITERAL,
  NULL_LITERAL
}
 An enum that specifies the different kinds of visiblity for member declarations. More...
 
- Protected Member Functions inherited from om::scripting::mir::lang::Literal
 Literal (Type newType)
 Create a new literal with the specified literal type enum value. More...
 

Detailed Description

A class that represents a string literal within the source code.

Constructor & Destructor Documentation

om::scripting::mir::lang::StringLiteral::StringLiteral ( const UTF8String &  newSpelling)
inline

Create a new string literal object with the specified spelling.

Member Function Documentation

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

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

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

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

om::scripting::mir::lang::StringLiteral::operator const UTF8String & ( ) const
inline

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

const UTF8String& om::scripting::mir::lang::StringLiteral::getSpelling ( ) const
inline

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

static Shared<StringLiteral> om::scripting::mir::lang::StringLiteral::construct ( const UTF8String &  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: