G3D::Token Class Reference

#include <TextInput.h>

Public Types
enum	ExtendedType {   DOUBLE_QUOTED_TYPE, SINGLE_QUOTED_TYPE, SYMBOL_TYPE, FLOATING_POINT_TYPE,   INTEGER_TYPE, BOOLEAN_TYPE, LINE_COMMENT_TYPE, BLOCK_COMMENT_TYPE,   NEWLINE_TYPE, END_TYPE }
enum	Type {   STRING = DOUBLE_QUOTED_TYPE, SYMBOL = SYMBOL_TYPE, NUMBER = FLOATING_POINT_TYPE, BOOLEAN = BOOLEAN_TYPE,   COMMENT = LINE_COMMENT_TYPE, NEWLINE = NEWLINE_TYPE, END = END_TYPE }

Public Member Functions
	Token ()
	Token (Type t, ExtendedType e, const std::string &s, int L, int c, uint64 byte)
	Token (Type t, ExtendedType e, const std::string &s, bool b, int L, int c, uint64 byte)
Type	type () const
ExtendedType	extendedType () const
const std::string &	string () const
bool	boolean () const
int	line () const
int	character () const
uint64	bytePosition () const
double	number () const

Private Attributes
std::string	_string
bool	_bool
int	_line
int	_character
uint64	_bytePosition
Type	_type
ExtendedType	_extendedType

Friends
class	TextInput

Detailed Description

For use with TextInput.

Member Enumeration Documentation

enum G3D::Token::ExtendedType

More detailed type information than Type.

Enumerator
DOUBLE_QUOTED_TYPE
SINGLE_QUOTED_TYPE
SYMBOL_TYPE
FLOATING_POINT_TYPE
INTEGER_TYPE
BOOLEAN_TYPE
LINE_COMMENT_TYPE
BLOCK_COMMENT_TYPE
NEWLINE_TYPE
END_TYPE

 {
 DOUBLE_QUOTED_TYPE, 
 SINGLE_QUOTED_TYPE, 
 SYMBOL_TYPE,
 FLOATING_POINT_TYPE, 
 INTEGER_TYPE,
 BOOLEAN_TYPE,
 LINE_COMMENT_TYPE,
 BLOCK_COMMENT_TYPE,
 NEWLINE_TYPE,
 END_TYPE
 };

enum G3D::Token::Type

Strings are enclosed in quotes, symbols are not.

Enumerator
STRING
SYMBOL
NUMBER
BOOLEAN
COMMENT
NEWLINE
END

 {
 STRING = DOUBLE_QUOTED_TYPE, 
 SYMBOL = SYMBOL_TYPE, 
 NUMBER = FLOATING_POINT_TYPE, 
 BOOLEAN = BOOLEAN_TYPE,
 COMMENT = LINE_COMMENT_TYPE,
 NEWLINE = NEWLINE_TYPE,
 END = END_TYPE
 };

Constructor & Destructor Documentation

G3D::Token::Token ( )

inline

 :
 _string(""),
 _bool(false),
 _line(0), 
 _character(0), 
 _bytePosition(0),
 _type(END), 
 _extendedType(END_TYPE) {}

G3D::Token::Token ( Type  t, ExtendedType  e, const std::string &  s, int  L, int  c, uint64  byte  )

inline

 : _string(s), _bool(false), _line(L), _character(c), _bytePosition(byte), _type(t), _extendedType(e) {}

G3D::Token::Token ( Type  t, ExtendedType  e, const std::string &  s, bool  b, int  L, int  c, uint64  byte  )

inline

 : _string(s), _bool(b), _line(L), _character(c), _bytePosition(byte), _type(t), _extendedType(e) {}

Member Function Documentation

bool G3D::Token::boolean ( ) const

inline

 {
 return _bool;
 }

Here is the caller graph for this function:

uint64 G3D::Token::bytePosition ( ) const

inline

Number of bytes from the beginning of the buffer that this token was parsed from. Begins at 0

 {
 return _bytePosition;
 }

Here is the caller graph for this function:

int G3D::Token::character ( ) const

inline

Starting character position in the input line from which this token was parsed. Starts at 1.

 {
 return _character;
 }

Here is the caller graph for this function:

ExtendedType G3D::Token::extendedType ( ) const

inline

 {
 return _extendedType;
 }

int G3D::Token::line ( ) const

inline

Starting line of the input from which this token was parsed. Starts at 1.

 {
 return _line;
 }

Here is the caller graph for this function:

double G3D::Token::number

(

)

const

Return the numeric value for a number type, or zero if this is not a number type.

 {
 if (_type == NUMBER) {
 return TextInput::parseNumber(_string);
 } else {
 return 0.0;
 }
}

Here is the call graph for this function:

Here is the caller graph for this function:

const std::string& G3D::Token::string ( ) const

inline

The value of a single or double quote string (not including the quotes), the name of a symbol, or the exact textual representation of a number as parsed from the input.

 {
 return _string;
 }

Here is the caller graph for this function:

Type G3D::Token::type ( ) const

inline

 {
 return _type;
 }

Here is the caller graph for this function:

Friends And Related Function Documentation

friend class TextInput

friend

Member Data Documentation

bool G3D::Token::_bool

private

uint64 G3D::Token::_bytePosition

private

int G3D::Token::_character

private

ExtendedType G3D::Token::_extendedType

private

int G3D::Token::_line

private

std::string G3D::Token::_string

private

Holds the actual value, which might be any type. If a number, it will be parsed at runtime.

Type G3D::Token::_type

private

---

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

• dep/g3dlite/include/G3D/TextInput.h
• dep/g3dlite/source/TextInput.cpp