A token holds items read from Istream. More...

Collaboration diagram for token:

Classes
class	compound
	Abstract base class for complex tokens. More...

class	Compound
	A templated class for holding compound tokens. More...

Public Types
enum	tokenType { UNDEFINED, PUNCTUATION, WORD, VARIABLE, STRING, VERBATIMSTRING, LABEL, FLOAT_SCALAR, DOUBLE_SCALAR, COMPOUND, ERROR }
	Enumeration defining the types of token. More...

enum	punctuationToken { NULL_TOKEN = '\0', SPACE = ' ', TAB = '\t', NL = '\n', END_STATEMENT = ';', BEGIN_LIST = '(', END_LIST = ')', BEGIN_SQR = '[', END_SQR = ']', BEGIN_BLOCK = '{', END_BLOCK = '}', COLON = ':', COMMA = ',', HASH = '#', BEGIN_STRING = '"', END_STRING = BEGIN_STRING, ASSIGN = '=', ADD = '+', SUBTRACT = '-', MULTIPLY = '*', DIVIDE = '/' }
	Standard punctuation tokens. More...

Public Member Functions
	token ()
	Construct null. More...

	token (const token &)
	Construct as copy. More...

	token (punctuationToken, label lineNumber=0)
	Construct punctuation character token. More...

	token (const word &, label lineNumber=0)
	Construct word token. More...

	token (const string &, label lineNumber=0)
	Construct string token. More...

	token (const label, label lineNumber=0)
	Construct label token. More...

	token (const floatScalar, label lineNumber=0)
	Construct floatScalar token. More...

	token (const doubleScalar, label lineNumber=0)
	Construct doubleScalar token. More...

	token (Istream &)
	Construct from Istream. More...

	~token ()
	Destructor. More...

tokenType	type () const

tokenType &	type ()

bool	good () const

bool	undefined () const

bool	error () const

bool	isPunctuation () const

punctuationToken	pToken () const

bool	isWord () const

const word &	wordToken () const

bool	isVariable () const

bool	isString () const

const string &	stringToken () const

bool	isLabel () const

label	labelToken () const

bool	isFloatScalar () const

floatScalar	floatScalarToken () const

bool	isDoubleScalar () const

doubleScalar	doubleScalarToken () const

bool	isScalar () const

scalar	scalarToken () const

bool	isNumber () const

scalar	number () const

bool	isCompound () const

const compound &	compoundToken () const

compound &	transferCompoundToken (const Istream &is)

label	lineNumber () const

label &	lineNumber ()

void	setBad ()
	Set bad. More...

InfoProxy< token >	info () const
	Return info proxy. More...

void	operator= (const token &)

void	operator= (const punctuationToken)

void	operator= (word *)

void	operator= (const word &)

void	operator= (string *)

void	operator= (const string &)

void	operator= (const label)

void	operator= (const floatScalar)

void	operator= (const doubleScalar)

void	operator= (compound *)

bool	operator== (const token &) const

bool	operator== (const punctuationToken) const

bool	operator== (const word &) const

bool	operator== (const string &) const

bool	operator== (const label) const

bool	operator== (const floatScalar) const

bool	operator== (const doubleScalar) const

bool	operator!= (const token &) const

bool	operator!= (const punctuationToken) const

bool	operator!= (const word &) const

bool	operator!= (const string &) const

bool	operator!= (const label) const

bool	operator!= (const floatScalar) const

bool	operator!= (const doubleScalar) const

Static Public Attributes
static token	undefinedToken
	Static undefined token. More...

static const char *const	typeName = "token"

Friends
Istream &	operator>> (Istream &, token &)

Ostream &	operator<< (Ostream &, const token &)

Ostream &	operator<< (Ostream &, const punctuationToken &)

ostream &	operator<< (ostream &, const punctuationToken &)

ostream &	operator<< (ostream &, const InfoProxy< token > &)

Detailed Description

A token holds items read from Istream.

Source files

Definition at line 67 of file token.H.

Member Enumeration Documentation

enum tokenType

Enumeration defining the types of token.

Enumerator
UNDEFINED
PUNCTUATION
WORD
VARIABLE
STRING
VERBATIMSTRING
LABEL
FLOAT_SCALAR
DOUBLE_SCALAR
COMPOUND
ERROR

Definition at line 73 of file token.H.

enum punctuationToken

Standard punctuation tokens.

Enumerator
NULL_TOKEN
SPACE
TAB
NL
END_STATEMENT
BEGIN_LIST
END_LIST
BEGIN_SQR
END_SQR
BEGIN_BLOCK
END_BLOCK
COLON
COMMA
HASH
BEGIN_STRING
END_STRING
ASSIGN
ADD
SUBTRACT
MULTIPLY
DIVIDE

Definition at line 92 of file token.H.

Constructor & Destructor Documentation

token ( )

inline

Construct null.

Definition at line 65 of file tokenI.H.

token ( const token & t )

inline

Construct as copy.

Definition at line 72 of file tokenI.H.

References token::COMPOUND, token::compoundTokenPtr_, token::DOUBLE_SCALAR, token::doubleScalarToken_, token::ERROR, token::FLOAT_SCALAR, token::floatScalarToken_, token::LABEL, token::labelToken_, token::PUNCTUATION, token::punctuationToken_, token::STRING, token::stringTokenPtr_, token::UNDEFINED, token::VARIABLE, token::VERBATIMSTRING, token::WORD, and token::wordTokenPtr_.

token	(	punctuationToken	p,
		label	lineNumber = `0`
	)

inline

Construct punctuation character token.

Definition at line 119 of file tokenI.H.

token	(	const word &	w,
		label	lineNumber = `0`
	)

inline

Construct word token.

Definition at line 127 of file tokenI.H.

token	(	const string &	s,
		label	lineNumber = `0`
	)

inline

Construct string token.

Definition at line 135 of file tokenI.H.

token	(	const label	l,
		label	lineNumber = `0`
	)

inline

Construct label token.

Definition at line 143 of file tokenI.H.

token	(	const floatScalar	s,
		label	lineNumber = `0`
	)

inline

Construct floatScalar token.

Definition at line 151 of file tokenI.H.

token	(	const doubleScalar	s,
		label	lineNumber = `0`
	)

inline

Construct doubleScalar token.

Definition at line 159 of file tokenI.H.

token ( Istream & is )

Construct from Istream.

Definition at line 34 of file tokenIO.C.

References Istream::read().

Here is the call graph for this function:

~token ( )

inline

Destructor.

Definition at line 170 of file tokenI.H.

Member Function Documentation

token::tokenType type ( ) const

inline

Definition at line 178 of file tokenI.H.

Referenced by token::compound::compound(), Foam::operator<<(), ISstream::read(), UIPstream::read(), prefixOSstream::write(), OSstream::write(), UOPstream::write(), and primitiveEntry::write().

Here is the caller graph for this function:

token::tokenType & type ( )

inline

Definition at line 183 of file tokenI.H.

bool good ( ) const

inline

Definition at line 188 of file tokenI.H.

References token::ERROR, and token::UNDEFINED.

Referenced by dimensionSet::dimensionSet(), keyType::match(), Foam::operator>>(), and primitiveEntry::read().

Here is the caller graph for this function:

bool undefined ( ) const

inline

Definition at line 193 of file tokenI.H.

References token::UNDEFINED.

bool error ( ) const

inline

Definition at line 198 of file tokenI.H.

References token::ERROR.

bool isPunctuation ( ) const

inline

Definition at line 203 of file tokenI.H.

References token::PUNCTUATION.

Referenced by blockDescriptor::blockDescriptor(), dimensionSet::dimensionSet(), FixedList< T, Size >::FixedList(), genericFvPatchField< Type >::genericFvPatchField(), List< T >::List(), LList< LListBase, T >::LList(), Foam::operator>>(), StaticHashTable< T, Key, Hash >::printInfo(), HashTable< T, Key, Hash >::printInfo(), PtrList< T >::read(), PackedList< nBits >::read(), IOPosition< CloudType >::readData(), Reaction< ReactionThermo >::setLRhs(), thirdBodyEfficiencies::thirdBodyEfficiencies(), and UList< T >::writeEntry().

Here is the caller graph for this function:

token::punctuationToken pToken ( ) const

inline

Definition at line 208 of file tokenI.H.

References token::NULL_TOKEN, token::PUNCTUATION, and token::punctuationToken_.

Referenced by blockDescriptor::blockDescriptor(), dimensionSet::dimensionSet(), List< T >::List(), LList< LListBase, T >::LList(), Foam::operator<<(), Foam::operator>>(), StaticHashTable< T, Key, Hash >::printInfo(), HashTable< T, Key, Hash >::printInfo(), PtrList< T >::read(), PackedList< nBits >::read(), Istream::readBeginList(), IOPosition< CloudType >::readData(), Istream::readEndList(), thirdBodyEfficiencies::thirdBodyEfficiencies(), and UList< T >::writeEntry().

Here is the caller graph for this function:

bool isWord ( ) const

inline

Definition at line 221 of file tokenI.H.

References token::WORD.

Referenced by blockDescriptor::blockDescriptor(), Constant< Type >::Constant(), dimensionSet::dimensionSet(), Field< Type >::Field(), genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), keyType::match(), dimensioned< Type >::operator/=(), Foam::operator>>(), dimensionSet::read(), IOobject::readHeader(), mappedPatchBase::readListOrField(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), and thirdBodyEfficiencies::thirdBodyEfficiencies().

Here is the caller graph for this function:

const word & wordToken ( ) const

inline

Definition at line 226 of file tokenI.H.

References word::null, token::WORD, and token::wordTokenPtr_.

Referenced by blockDescriptor::blockDescriptor(), dimensionSet::dimensionSet(), Field< Type >::Field(), genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), keyType::match(), Foam::operator<<(), token::operator==(), Foam::operator>>(), dimensionSet::read(), IOobject::readHeader(), mappedPatchBase::readListOrField(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), and thirdBodyEfficiencies::thirdBodyEfficiencies().

Here is the caller graph for this function:

bool isVariable ( ) const

inline

Definition at line 239 of file tokenI.H.

References token::VARIABLE.

bool isString ( ) const

inline

Definition at line 244 of file tokenI.H.

References token::STRING, token::VARIABLE, and token::VERBATIMSTRING.

Referenced by keyType::match(), and Foam::operator>>().

Here is the caller graph for this function:

const string & stringToken ( ) const

inline

Definition at line 249 of file tokenI.H.

References string::null, token::STRING, token::stringTokenPtr_, token::VARIABLE, and token::VERBATIMSTRING.

Referenced by keyType::match(), Foam::operator<<(), token::operator==(), Foam::operator>>(), prefixOSstream::write(), OSstream::write(), and UOPstream::write().

Here is the caller graph for this function:

bool isLabel ( ) const

inline

Definition at line 262 of file tokenI.H.

References token::LABEL.

Referenced by FixedList< T, Size >::FixedList(), genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), List< T >::List(), LList< LListBase, T >::LList(), Matrix< Form, Type >::Matrix(), Foam::operator>>(), StaticHashTable< T, Key, Hash >::printInfo(), HashTable< T, Key, Hash >::printInfo(), PtrList< T >::read(), PackedList< nBits >::read(), IOPosition< CloudType >::readData(), and UList< T >::writeEntry().

Here is the caller graph for this function:

label labelToken ( ) const

inline

Definition at line 267 of file tokenI.H.

References token::LABEL, and token::labelToken_.

Referenced by FixedList< T, Size >::FixedList(), genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), List< T >::List(), LList< LListBase, T >::LList(), Matrix< Form, Type >::Matrix(), Foam::operator<<(), Foam::operator>>(), StaticHashTable< T, Key, Hash >::printInfo(), HashTable< T, Key, Hash >::printInfo(), PtrList< T >::read(), PackedList< nBits >::read(), IOPosition< CloudType >::readData(), and UList< T >::writeEntry().

Here is the caller graph for this function:

bool isFloatScalar ( ) const

inline

Definition at line 280 of file tokenI.H.

References token::FLOAT_SCALAR.

floatScalar floatScalarToken ( ) const

inline

Definition at line 285 of file tokenI.H.

References token::FLOAT_SCALAR, and token::floatScalarToken_.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

bool isDoubleScalar ( ) const

inline

Definition at line 299 of file tokenI.H.

References token::DOUBLE_SCALAR.

doubleScalar doubleScalarToken ( ) const

inline

Definition at line 304 of file tokenI.H.

References token::DOUBLE_SCALAR, and token::doubleScalarToken_.

Referenced by Foam::operator<<().

Here is the caller graph for this function:

bool isScalar ( ) const

inline

Definition at line 318 of file tokenI.H.

References token::DOUBLE_SCALAR, and token::FLOAT_SCALAR.

Referenced by token::isNumber(), and token::number().

Here is the caller graph for this function:

scalar scalarToken ( ) const

inline

Definition at line 323 of file tokenI.H.

References token::DOUBLE_SCALAR, token::doubleScalarToken_, token::FLOAT_SCALAR, and token::floatScalarToken_.

Referenced by token::number().

Here is the caller graph for this function:

bool isNumber ( ) const

inline

Definition at line 340 of file tokenI.H.

References token::isScalar(), and token::LABEL.

Referenced by Time::findTimes(), Foam::operator>>(), dimensionSet::read(), and Reaction< ReactionThermo >::specieCoeffs::specieCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

scalar number ( ) const

inline

Definition at line 345 of file tokenI.H.

References token::isScalar(), token::LABEL, token::labelToken_, and token::scalarToken().

Referenced by Time::findTimes(), genericFvPatchField< Type >::genericFvPatchField(), Foam::operator>>(), dimensionSet::read(), and Reaction< ReactionThermo >::specieCoeffs::specieCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

bool isCompound ( ) const

inline

Definition at line 362 of file tokenI.H.

References token::COMPOUND.

Referenced by FixedList< T, Size >::FixedList(), genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), List< T >::List(), and UList< T >::writeEntry().

Here is the caller graph for this function:

const token::compound & compoundToken ( ) const

inline

Definition at line 367 of file tokenI.H.

References token::COMPOUND, and token::compoundTokenPtr_.

Referenced by genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), and Foam::operator<<().

Here is the caller graph for this function:

Foam::token::compound & transferCompoundToken ( const Istream & is )

Definition at line 93 of file token.C.

References Foam::abort(), Foam::FatalIOError, and FatalIOErrorIn.

Referenced by FixedList< T, Size >::FixedList(), genericFvPatchField< Type >::genericFvPatchField(), genericPointPatchField< Type >::genericPointPatchField(), List< T >::List(), and UList< T >::writeEntry().

Here is the call graph for this function:

Here is the caller graph for this function:

label lineNumber ( ) const

inline

Definition at line 381 of file tokenI.H.

Referenced by Foam::operator<<(), ISstream::read(), UIPstream::read(), and ITstream::read().

Here is the caller graph for this function:

label & lineNumber ( )

inline

Definition at line 386 of file tokenI.H.

void setBad ( )

inline

Set bad.

Definition at line 392 of file tokenI.H.

References token::ERROR.

Referenced by ISstream::read(), and UIPstream::read().

Here is the caller graph for this function:

InfoProxy<token> info ( ) const

inline

Return info proxy.

Used to print token information to a stream

Definition at line 372 of file token.H.

Referenced by blockDescriptor::blockDescriptor(), Field< Type >::Field(), FixedList< T, Size >::FixedList(), List< T >::List(), LList< LListBase, T >::LList(), keyType::match(), Matrix< Form, Type >::Matrix(), Foam::operator>>(), StaticHashTable< T, Key, Hash >::printInfo(), HashTable< T, Key, Hash >::printInfo(), PtrList< T >::read(), PackedList< nBits >::read(), Istream::readBegin(), Istream::readBeginList(), IOPosition< CloudType >::readData(), Istream::readEnd(), Istream::readEndList(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), thirdBodyEfficiencies::thirdBodyEfficiencies(), and UList< T >::writeEntry().

Here is the caller graph for this function:

void operator= ( const token & t )

inline

Definition at line 401 of file tokenI.H.

References token::COMPOUND, token::compoundTokenPtr_, token::DOUBLE_SCALAR, token::doubleScalarToken_, token::ERROR, token::FLOAT_SCALAR, token::floatScalarToken_, token::LABEL, token::labelToken_, token::PUNCTUATION, token::punctuationToken_, token::STRING, token::stringTokenPtr_, token::UNDEFINED, token::VARIABLE, token::VERBATIMSTRING, token::WORD, and token::wordTokenPtr_.

Referenced by token::operator=().

Here is the caller graph for this function:

void operator= ( const punctuationToken p )

inline

Definition at line 449 of file tokenI.H.

References p, token::PUNCTUATION, and token::punctuationToken_.

void operator= ( word * wPtr )

inline

Definition at line 456 of file tokenI.H.

References token::WORD, and token::wordTokenPtr_.

void operator= ( const word & w )

inline

Definition at line 463 of file tokenI.H.

References token::operator=().

Here is the call graph for this function:

void operator= ( string * sPtr )

inline

Definition at line 468 of file tokenI.H.

References token::STRING, and token::stringTokenPtr_.

void operator= ( const string & s )

inline

Definition at line 475 of file tokenI.H.

References token::operator=().

Here is the call graph for this function:

void operator= ( const label l )

inline

Definition at line 480 of file tokenI.H.

References token::LABEL, and token::labelToken_.

void operator= ( const floatScalar s )

inline

Definition at line 487 of file tokenI.H.

References token::FLOAT_SCALAR, token::floatScalarToken_, and s().

Here is the call graph for this function:

void operator= ( const doubleScalar s )

inline

Definition at line 494 of file tokenI.H.

References token::DOUBLE_SCALAR, token::doubleScalarToken_, and s().

Here is the call graph for this function:

void operator= ( token::compound * cPtr )

inline

Definition at line 501 of file tokenI.H.

References token::COMPOUND, and token::compoundTokenPtr_.

bool operator== ( const token & t ) const

inline

Definition at line 509 of file tokenI.H.

References token::COMPOUND, token::compoundTokenPtr_, token::DOUBLE_SCALAR, token::doubleScalarToken_, Foam::equal(), token::ERROR, token::FLOAT_SCALAR, token::floatScalarToken_, token::LABEL, token::labelToken_, token::PUNCTUATION, token::punctuationToken_, token::STRING, token::stringTokenPtr_, token::UNDEFINED, token::VARIABLE, token::VERBATIMSTRING, token::WORD, and token::wordTokenPtr_.

Referenced by token::operator!=().

Here is the call graph for this function:

Here is the caller graph for this function:

bool operator== ( const punctuationToken p ) const

inline

Definition at line 551 of file tokenI.H.

References token::PUNCTUATION, and token::punctuationToken_.

bool operator== ( const word & w ) const

inline

Definition at line 556 of file tokenI.H.

References token::WORD, and token::wordToken().

Here is the call graph for this function:

bool operator== ( const string & s ) const

inline

Definition at line 561 of file tokenI.H.

References token::STRING, token::stringToken(), token::VARIABLE, and token::VERBATIMSTRING.

Here is the call graph for this function:

bool operator== ( const label l ) const

inline

Definition at line 570 of file tokenI.H.

References token::LABEL, and token::labelToken_.

bool operator== ( const floatScalar s ) const

inline

Definition at line 575 of file tokenI.H.

References Foam::equal(), token::FLOAT_SCALAR, and token::floatScalarToken_.

Here is the call graph for this function:

bool operator== ( const doubleScalar s ) const

inline

Definition at line 580 of file tokenI.H.

References token::DOUBLE_SCALAR, token::doubleScalarToken_, and Foam::equal().

Here is the call graph for this function:

bool operator!= ( const token & t ) const

inline

Definition at line 585 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

bool operator!= ( const punctuationToken p ) const

inline

Definition at line 590 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

bool operator!= ( const word & w ) const

inline

Definition at line 595 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

bool operator!= ( const string & s ) const

inline

Definition at line 600 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

bool operator!= ( const label l ) const

inline

Definition at line 615 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

bool operator!= ( const floatScalar s ) const

inline

Definition at line 605 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

bool operator!= ( const doubleScalar s ) const

inline

Definition at line 610 of file tokenI.H.

References token::operator==().

Here is the call graph for this function:

Friends And Related Function Documentation

Istream& operator>>	(	Istream &	,
		token &
	)

friend

Ostream& operator<<	(	Ostream &	,
		const token &
	)

friend

Ostream& operator<<	(	Ostream &	,
		const punctuationToken &
	)

friend

ostream& operator<<	(	ostream &	,
		const punctuationToken &
	)

friend

ostream& operator<<	(	ostream &	,
		const InfoProxy< token > &
	)

friend

Member Data Documentation

token undefinedToken

static

Static undefined token.

Definition at line 241 of file token.H.

Referenced by Istream::peekBack(), and ITstream::read().

punctuationToken punctuationToken_

Definition at line 254 of file token.H.

Referenced by Foam::operator<<(), token::operator=(), token::operator==(), token::pToken(), and token::token().

word* wordTokenPtr_

Definition at line 255 of file token.H.

Referenced by Foam::operator<<(), token::operator=(), token::operator==(), token::token(), and token::wordToken().

string* stringTokenPtr_

Definition at line 256 of file token.H.

Referenced by Foam::operator<<(), token::operator=(), token::operator==(), token::stringToken(), and token::token().

label labelToken_

Definition at line 257 of file token.H.

Referenced by token::labelToken(), token::number(), Foam::operator<<(), token::operator=(), token::operator==(), and token::token().

floatScalar floatScalarToken_

Definition at line 258 of file token.H.

Referenced by token::floatScalarToken(), Foam::operator<<(), token::operator=(), token::operator==(), token::scalarToken(), and token::token().

doubleScalar doubleScalarToken_

Definition at line 259 of file token.H.

Referenced by token::doubleScalarToken(), Foam::operator<<(), token::operator=(), token::operator==(), token::scalarToken(), and token::token().

compound* compoundTokenPtr_

mutable

Definition at line 260 of file token.H.

Referenced by token::compoundToken(), Foam::operator<<(), token::operator=(), token::operator==(), and token::token().

const char *const typeName = "token"

static

Definition at line 280 of file token.H.

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

src/OpenFOAM/db/IOstreams/token/token.H
src/OpenFOAM/db/IOstreams/token/token.C
src/OpenFOAM/db/IOstreams/token/tokenI.H
src/OpenFOAM/db/IOstreams/token/tokenIO.C

Classes

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation