A token holds an item read from Istream. More...
Classes | |
class | Compound |
A templated class for holding compound tokens. The underlying container is normally a List of values, it must have a value_type typedef as well as size(), resize(), cdata_bytes(), data_bytes(), size_bytes() methods. More... | |
class | compound |
Abstract base class for complex tokens. More... | |
Public Types | |
enum | tokenType : char { UNDEFINED = '\0', ERROR = '\x80', FLAG, PUNCTUATION, BOOL, LABEL, FLOAT, DOUBLE, WORD, STRING, COMPOUND, DIRECTIVE, EXPRESSION, VARIABLE, VERBATIM, CHAR_DATA, FLOAT_SCALAR = FLOAT, DOUBLE_SCALAR = DOUBLE, VERBATIMSTRING = VERBATIM } |
Enumeration defining the types of token. More... | |
enum | flagType { NO_FLAG = 0, ASCII = 1, BINARY = 2 } |
Stream or output control flags (1-byte width) More... | |
enum | punctuationToken : char { NULL_TOKEN = '\0', TAB = '\t', NL = '\n', SPACE = ' ', COLON = ':', SEMICOLON = ';', COMMA = ',', HASH = '#', DOLLAR = '$', QUESTION = '?', ATSYM = '@', SQUOTE = '\'', DQUOTE = '"', ASSIGN = '=', PLUS = '+', MINUS = '-', MULTIPLY = '*', DIVIDE = '/', LPAREN = '(', RPAREN = ')', LSQUARE = '[', RSQUARE = ']', LBRACE = '{', RBRACE = '}', ADD = PLUS, SUBTRACT = MINUS, END_STATEMENT = SEMICOLON, BEGIN_LIST = LPAREN, END_LIST = RPAREN, BEGIN_SQR = LSQUARE, END_SQR = RSQUARE, BEGIN_BLOCK = LBRACE, END_BLOCK = RBRACE, BEGIN_STRING = DQUOTE, END_STRING = DQUOTE } |
Standard punctuation tokens (a character) More... | |
Public Member Functions | |
constexpr | token () noexcept |
Default construct, initialized to an UNDEFINED token. More... | |
token (const token &t) | |
Copy construct. More... | |
token (token &&t) noexcept | |
Move construct. The original token is left as UNDEFINED. More... | |
token (punctuationToken p, label lineNum=0) noexcept | |
Construct punctuation character token. More... | |
token (const label val, label lineNum=0) noexcept | |
Construct label token. More... | |
token (const float val, label lineNum=0) noexcept | |
Construct float token. More... | |
token (const double val, label lineNum=0) noexcept | |
Construct double token. More... | |
token (const word &w, label lineNum=0) | |
Copy construct word token. More... | |
token (const string &str, label lineNum=0) | |
Copy construct string token. More... | |
token (word &&w, label lineNum=0) | |
Move construct word token. More... | |
token (string &&str, label lineNum=0) | |
Move construct string token. More... | |
token (tokenType typ, const std::string &, label line=0) | |
Copy construct word/string token with the specified variant. More... | |
token (tokenType typ, std::string &&, label line=0) | |
Move construct word/string token with the specified variant. More... | |
token (token::compound *ptr, label lineNum=0) | |
Construct from a compound pointer, taking ownership. More... | |
token (autoPtr< token::compound > &&ptr, label lineNum=0) | |
Move construct from a compound pointer, taking ownership. More... | |
token (Istream &is) | |
Construct from Istream. More... | |
~token () | |
Destructor. More... | |
word | name () const |
Return the name of the current token type. More... | |
tokenType | type () const noexcept |
Return the token type. More... | |
bool | setType (const tokenType tokType) noexcept |
Change the token type, for similar types. More... | |
label | lineNumber () const noexcept |
The line number for the token. More... | |
label | lineNumber (const label lineNum) noexcept |
Change token line number, return old value. More... | |
bool | good () const noexcept |
True if token is not UNDEFINED or ERROR. More... | |
bool | undefined () const noexcept |
Token is UNDEFINED. More... | |
bool | error () const noexcept |
Token is ERROR. More... | |
bool | isBool () const noexcept |
Token is BOOL. More... | |
bool | isFlag () const noexcept |
Token is FLAG. More... | |
bool | isPunctuation () const noexcept |
Token is PUNCTUATION. More... | |
bool | isPunctuation (const punctuationToken p) const noexcept |
True if token is PUNCTUATION and equal to parameter. More... | |
bool | isSeparator () const noexcept |
Token is PUNCTUATION and isseparator. More... | |
bool | isLabel () const noexcept |
Token is LABEL. More... | |
bool | isLabel (const label value) const noexcept |
True if token is LABEL and equal to parameter. More... | |
bool | isFloat () const noexcept |
Token is FLOAT. More... | |
bool | isDouble () const noexcept |
Token is DOUBLE. More... | |
bool | isScalar () const noexcept |
Token is FLOAT or DOUBLE. More... | |
bool | isNumber () const noexcept |
Token is LABEL, FLOAT or DOUBLE. More... | |
bool | isWord () const noexcept |
Token is word-variant (WORD, DIRECTIVE) More... | |
bool | isWord (const std::string &s) const |
Token is word-variant and equal to parameter. More... | |
bool | isDirective () const noexcept |
Token is DIRECTIVE (word variant) More... | |
bool | isQuotedString () const noexcept |
Token is (quoted) STRING (string variant) More... | |
bool | isString () const noexcept |
Token is string-variant (STRING, EXPRESSION, VARIABLE, VERBATIM, CHAR_DATA) More... | |
bool | isExpression () const noexcept |
Token is EXPRESSION (string variant) More... | |
bool | isVariable () const noexcept |
Token is VARIABLE (string variant) More... | |
bool | isVerbatim () const noexcept |
Token is VERBATIM string (string variant) More... | |
bool | isCharData () const noexcept |
Token is CHAR_DATA (string variant) More... | |
bool | isStringType () const noexcept |
Token is word-variant or string-variant (WORD, DIRECTIVE, STRING, EXPRESSION, VARIABLE, VERBATIM, CHAR_DATA) More... | |
bool | isCompound () const noexcept |
Token is COMPOUND. More... | |
bool | isCompound (const word &compoundType) const |
True if token is COMPOUND and its type() is equal to parameter. More... | |
template<class Type > | |
const Type * | isCompound () const |
If token is COMPOUND and can be dynamic_cast to the Type return a const pointer to the content. More... | |
operator bool () const noexcept | |
True if token is not UNDEFINED or ERROR. Same as good(). More... | |
bool | boolToken () const |
Return boolean token value. More... | |
int | flagToken () const |
Return flag bitmask value. More... | |
punctuationToken | pToken () const |
Return punctuation character. More... | |
label | labelToken () const |
Return label value. More... | |
float | floatToken () const |
Return float value. More... | |
double | doubleToken () const |
Return double value. More... | |
scalar | scalarToken () const |
Return float or double value. More... | |
scalar | number () const |
Return label, float or double value. More... | |
const word & | wordToken () const |
Return const reference to the word contents. More... | |
const string & | stringToken () const |
Return const reference to the string contents. More... | |
const compound & | compoundToken () const |
Const reference to compound token. Fatal if the wrong type. More... | |
compound & | refCompoundToken () |
Return reference to compound token. Fatal if the wrong type. No checks for released or pending states. More... | |
template<class Type > | |
Type & | refCompoundToken () |
Return reference to the underlying encapsulated container (eg, List<label> etc) of a compound token. No checks for released or pending states. More... | |
bool | readCompoundToken (const word &compoundType, Istream &is, const bool readContent=true) |
Default construct the specified compound type and read from stream. More... | |
compound & | transferCompoundToken (const Istream *is=nullptr) |
Return reference to compound and mark internally as released. More... | |
compound & | transferCompoundToken (const Istream &is) |
Return reference to compound and mark internally as released. More... | |
template<class Type > | |
Type & | transferCompoundToken (const Istream &is) |
Mark the compound as released and return a reference to the underlying encapsulated container - eg, List<label> More... | |
void | reset () |
Reset token to UNDEFINED and clear any allocated storage. More... | |
void | setBad () |
Clear token and set to be ERROR. More... | |
void | swap (token &tok) noexcept |
Swap token contents: type, data, line-number. More... | |
InfoProxy< token > | info () const noexcept |
Return info proxy, for printing token information to a stream. More... | |
void | operator= (const token &tok) |
Copy assign. More... | |
void | operator= (token &&tok) |
Move assign. More... | |
void | operator= (const punctuationToken p) |
Copy assign from punctuation. More... | |
void | operator= (const label val) |
Copy assign from label. More... | |
void | operator= (const float val) |
Copy assign from float. More... | |
void | operator= (const double val) |
Copy assign from double. More... | |
void | operator= (const word &w) |
Copy assign from word content. More... | |
void | operator= (const string &str) |
Copy assign from string content. More... | |
void | operator= (word &&w) |
Move assign from word content. More... | |
void | operator= (string &&str) |
Move assign from string content. More... | |
void | operator= (token::compound *ptr) |
Assign compound with reference counting to token. More... | |
void | operator= (autoPtr< token::compound > &&ptr) |
Move assign from compound pointer. More... | |
bool | operator== (const token &tok) const |
bool | operator== (const punctuationToken p) const noexcept |
bool | operator== (const label val) const noexcept |
bool | operator== (const float val) const noexcept |
bool | operator== (const double val) const noexcept |
bool | operator== (const std::string &s) const |
bool | operator!= (const token &tok) const |
bool | operator!= (const punctuationToken p) const noexcept |
bool | operator!= (const label val) const noexcept |
bool | operator!= (const float val) const noexcept |
bool | operator!= (const double val) const noexcept |
bool | operator!= (const std::string &s) const |
label & | lineNumber () noexcept |
Write access for the token line number. More... | |
bool | isFloatScalar () const |
Token is FLOAT. More... | |
bool | isDoubleScalar () const |
Token is DOUBLE. More... | |
float | floatScalarToken () const |
Return float value. More... | |
double | doubleScalarToken () const |
Return double value. More... | |
void | operator= (word *)=delete |
Deprecated(2017-11) transfer word pointer to the token. More... | |
void | operator= (string *)=delete |
Deprecated(2017-11) transfer string pointer to the token. More... | |
Static Public Member Functions | |
static token | boolean (bool on) noexcept |
Create a bool token. More... | |
static token | flag (int bitmask) noexcept |
Create a token with stream flags, no sanity check. More... | |
static bool | isseparator (int c) noexcept |
True if the character is a punctuation separator (eg, in ISstream). More... | |
static word | name (const token::tokenType tokType) |
Return the name for the token type. More... | |
Static Public Attributes | |
static const token | undefinedToken |
An undefined token. More... | |
static constexpr const char *const | typeName = "token" |
The type name is "token". More... | |
Friends | |
Ostream & | operator<< (Ostream &os, const token &tok) |
Ostream & | operator<< (Ostream &os, const punctuationToken &pt) |
ostream & | operator<< (ostream &os, const punctuationToken &pt) |
ostream & | operator<< (ostream &os, const InfoProxy< token > &ip) |
A token holds an item read from Istream.
enum tokenType : char |
Enumeration defining the types of token.
Since the enumeration is used to tag content in Pstream, it is of type char
and shall have values that do not overlap with regular punctuation characters.
Enumerator | |
---|---|
UNDEFINED | An undefined token-type. |
ERROR | Token error encountered. |
FLAG | stream flag (1-byte bitmask) |
PUNCTUATION | single character punctuation |
BOOL | boolean type |
LABEL | label (integer) type |
FLOAT | float (single-precision) type |
DOUBLE | double (double-precision) type |
WORD | |
STRING | Foam::string (usually double-quoted) |
COMPOUND | |
DIRECTIVE | Word-variant: dictionary |
EXPRESSION | String-variant: math expression for evaluation stored with delimiters |
VARIABLE | String-variant: dictionary |
VERBATIM | String-variant: verbatim string content stored without delimiters |
CHAR_DATA | String-variant: plain character content. |
FLOAT_SCALAR | compatibility name for FLOAT |
DOUBLE_SCALAR | compatibility name for DOUBLE |
VERBATIMSTRING | compatibility name for VERBATIM |
enum flagType |
enum punctuationToken : char |
Standard punctuation tokens (a character)
Enumerator | |
---|---|
NULL_TOKEN | Nul character. |
TAB | Tab [isspace]. |
NL | Newline [isspace]. |
SPACE | Space [isspace]. |
COLON | Colon [isseparator]. |
SEMICOLON | Semicolon [isseparator]. |
COMMA | Comma [isseparator]. |
HASH | Hash - directive or start verbatim string. |
DOLLAR | Dollar - start variable or expression. |
QUESTION | Question mark (eg, ternary) |
ATSYM | The 'at' symbol. |
SQUOTE | Single quote. |
DQUOTE | Double quote. |
ASSIGN | Assignment/equals [isseparator]. |
PLUS | Addition [isseparator]. |
MINUS | Subtract or start of negative number. |
MULTIPLY | Multiply [isseparator]. |
DIVIDE | Divide [isseparator]. |
LPAREN | Left parenthesis [isseparator]. |
RPAREN | Right parenthesis [isseparator]. |
LSQUARE | Left square bracket [isseparator]. |
RSQUARE | Right square bracket [isseparator]. |
LBRACE | Left brace [isseparator]. |
RBRACE | Right brace [isseparator]. |
ADD | Addition [isseparator]. |
SUBTRACT | Subtract or start of negative number. |
END_STATEMENT | End entry [isseparator]. |
BEGIN_LIST | Begin list [isseparator]. |
END_LIST | End list [isseparator]. |
BEGIN_SQR | Begin dimensions [isseparator]. |
END_SQR | End dimensions [isseparator]. |
BEGIN_BLOCK | Begin block [isseparator]. |
END_BLOCK | End block [isseparator]. |
BEGIN_STRING | Begin string with double quote. |
END_STRING | End string with double quote. |
|
inlinenoexcept |
|
inlineexplicitnoexcept |
|
inlineexplicitnoexcept |
|
inlineexplicitnoexcept |
|
inlineexplicitnoexcept |
|
inlineexplicit |
|
inlineexplicit |
Construct from Istream.
Definition at line 132 of file tokenIO.C.
References Istream::read().
|
inlinestaticnoexcept |
|
inlinestaticnoexcept |
|
inlinestaticnoexcept |
True if the character is a punctuation separator (eg, in ISstream).
Since it could also start a number, SUBTRACT is not included as a separator.
c | the character to test, passed as int for consistency with isdigit, isspace etc. |
Definition at line 69 of file tokenI.H.
References Foam::constant::universal::c.
|
static |
|
inline |
|
inlinenoexcept |
Return the token type.
Definition at line 405 of file tokenI.H.
Referenced by Foam::printTokenInfo(), OSstream::write(), and UOPstreamBase::write().
|
inlinenoexcept |
Change the token type, for similar types.
This can be used to change between string-like variants (eg, STRING, VARIABLE, etc) To change types entirely (eg, STRING to DOUBLE), use the corresponding assignment operator.
Definition at line 411 of file tokenI.H.
Referenced by UIPstreamBase::read(), ISstream::read(), and exprString::writeEntry().
|
inlinenoexcept |
The line number for the token.
Definition at line 493 of file tokenI.H.
Referenced by Foam::printTokenInfo(), UIPstreamBase::read(), ISstream::read(), and ITstream::read().
|
inlinenoexcept |
|
inlinenoexcept |
True if token is not UNDEFINED or ERROR.
Definition at line 507 of file tokenI.H.
Referenced by wordDirective::execute(), decomposedBlockData::getNumBlocks(), Foam::getToken(), token::operator bool(), Foam::operator>>(), Foam::parseStream(), exprValue::peekType(), Foam::printTokenError(), primitiveEntry::read(), exprValue::read(), decomposedBlockData::readBlockEntry(), Switch::Switch(), and OTstream::write().
|
inlinenoexcept |
|
inlinenoexcept |
Token is BOOL.
Definition at line 525 of file tokenI.H.
Referenced by Switch::Switch().
|
inlinenoexcept |
Token is FLAG.
Definition at line 543 of file tokenI.H.
Referenced by UIPstreamBase::read().
|
inlinenoexcept |
Token is PUNCTUATION.
Definition at line 561 of file tokenI.H.
Referenced by blockDescriptor::blockDescriptor(), dictionaryListEntry::dictionaryListEntry(), ITstream::find(), Foam::exprTools::getList(), Foam::getValueToken(), seriesWriter::load(), blockVertex::New(), entry::New(), Foam::operator>>(), exprValue::peekType(), Foam::blockMeshTools::read(), primitiveEntry::read(), exprValue::read(), IOPosition< CloudType >::readData(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > *>::readList(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), PackedList< 2 >::readList(), FixedList< point, 2 >::readList(), UList< Foam::vector >::readList(), and Reaction< ReactionThermo >::setLRhs().
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Token is LABEL.
Definition at line 599 of file tokenI.H.
Referenced by dictionaryListEntry::dictionaryListEntry(), Foam::exprTools::getList(), entry::New(), Foam::operator>>(), exprValue::peekType(), Foam::blockMeshTools::read(), STARCDsurfaceFormat< Face >::read(), STARCDedgeFormat::read(), STARCDMeshReader::readBoundary(), STARCDMeshReader::readCells(), IOPosition< CloudType >::readData(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > *>::readList(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), PackedList< 2 >::readList(), FixedList< point, 2 >::readList(), UList< Foam::vector >::readList(), Matrix< RectangularMatrix< Type >, Type >::readMatrix(), STARCDMeshReader::readPoints(), STARCDCore::readPoints(), decomposedBlockData::skipBlockEntry(), and Switch::Switch().
|
inlinenoexcept |
|
inlinenoexcept |
Token is FLOAT.
Definition at line 645 of file tokenI.H.
Referenced by token::isFloatScalar().
|
inlinenoexcept |
Token is DOUBLE.
Definition at line 663 of file tokenI.H.
Referenced by token::isDoubleScalar().
|
inlinenoexcept |
Token is FLOAT or DOUBLE.
Definition at line 681 of file tokenI.H.
Referenced by Foam::operator>>(), and exprValue::peekType().
|
inlinenoexcept |
Token is LABEL, FLOAT or DOUBLE.
Definition at line 707 of file tokenI.H.
Referenced by CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), seriesWriter::load(), Foam::operator>>(), exprValue::peekType(), dimensionSet::read(), Foam::readScaling(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), and IOstreamOption::versionNumber::versionNumber().
|
inlinenoexcept |
Token is word-variant (WORD, DIRECTIVE)
Definition at line 729 of file tokenI.H.
Referenced by arcEdge::arcEdge(), fileName::assign(), keyType::assign(), wordRe::assign(), Field< Foam::vector >::assign(), blockDescriptor::blockDescriptor(), Constant< Type >::Constant(), decomposedBlockData::getNumBlocks(), blockVertex::New(), Foam::operator>>(), Polynomial< Type >::Polynomial(), Foam::printTokenError(), genericPatchFieldBase::processEntry(), Foam::blockMeshTools::read(), dimensionSet::read(), decomposedBlockData::readBlockEntry(), IOobject::readHeader(), exprValue::readTokens(), decomposedBlockData::skipBlockEntry(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), Switch::Switch(), and Table< Type >::Table().
|
inline |
|
inlinenoexcept |
Token is DIRECTIVE (word variant)
Definition at line 741 of file tokenI.H.
Referenced by ifeqEntry::evaluate(), and ifeqEntry::execute().
|
inlinenoexcept |
Token is (quoted) STRING (string variant)
Definition at line 759 of file tokenI.H.
Referenced by fileName::assign(), keyType::assign(), wordRe::assign(), and Foam::operator>>().
|
inlinenoexcept |
Token is string-variant (STRING, EXPRESSION, VARIABLE, VERBATIM, CHAR_DATA)
Definition at line 765 of file tokenI.H.
Referenced by Foam::exprTools::getList(), seriesWriter::load(), and Foam::operator>>().
|
inlinenoexcept |
|
inlinenoexcept |
Token is VARIABLE (string variant)
Definition at line 777 of file tokenI.H.
Referenced by Foam::operator>>().
|
inlinenoexcept |
|
inlinenoexcept |
|
inlinenoexcept |
Token is word-variant or string-variant (WORD, DIRECTIVE, STRING, EXPRESSION, VARIABLE, VERBATIM, CHAR_DATA)
Definition at line 795 of file tokenI.H.
Referenced by functionEntry::readStringList(), and IOstreamOption::versionNumber::versionNumber().
|
inlinenoexcept |
Token is COMPOUND.
Definition at line 821 of file tokenI.H.
Referenced by mappedPatchBase::constructIOField(), decomposedBlockData::readBlockEntry(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), FixedList< point, 2 >::readList(), UList< Foam::vector >::readList(), and decomposedBlockData::skipBlockEntry().
|
inline |
|
inline |
|
inlineexplicitnoexcept |
True if token is not UNDEFINED or ERROR. Same as good().
Definition at line 946 of file token.H.
References token::good().
|
inline |
Return boolean token value.
Report FatalIOError and return false if token is not BOOL or LABEL
Definition at line 531 of file tokenI.H.
Referenced by Foam::printTokenInfo(), and Switch::Switch().
|
inline |
Return flag bitmask value.
Report FatalIOError and return NO_FLAG if token is not FLAG
Definition at line 549 of file tokenI.H.
Referenced by Foam::printTokenInfo(), UIPstreamBase::read(), and UOPstreamBase::write().
|
inline |
Return punctuation character.
Report FatalIOError and return \0 if token is not PUNCTUATION
Definition at line 587 of file tokenI.H.
Referenced by blockDescriptor::blockDescriptor(), seriesWriter::load(), Foam::operator>>(), Foam::printTokenInfo(), primitiveEntry::read(), Istream::readBeginList(), and Istream::readEndList().
|
inline |
Return label value.
Report FatalIOError and return 0 if token is not LABEL
Definition at line 633 of file tokenI.H.
Referenced by dictionaryListEntry::dictionaryListEntry(), Foam::operator>>(), Foam::printTokenInfo(), Foam::blockMeshTools::read(), STARCDsurfaceFormat< Face >::read(), STARCDMeshReader::readCells(), IOPosition< CloudType >::readData(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > *>::readList(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), PackedList< 2 >::readList(), FixedList< point, 2 >::readList(), UList< Foam::vector >::readList(), Matrix< RectangularMatrix< Type >, Type >::readMatrix(), STARCDMeshReader::readPoints(), STARCDCore::readPoints(), decomposedBlockData::skipBlockEntry(), and Switch::Switch().
|
inline |
Return float value.
Report FatalIOError and return 0 if token is not FLOAT
Definition at line 651 of file tokenI.H.
Referenced by token::floatScalarToken(), and Foam::printTokenInfo().
|
inline |
Return double value.
Report FatalIOError and return 0 if token is not DOUBLE
Definition at line 669 of file tokenI.H.
Referenced by token::doubleScalarToken(), and Foam::printTokenInfo().
|
inline |
Return float or double value.
Report FatalIOError and return 0 if token is not a FLOAT or DOUBLE
Definition at line 691 of file tokenI.H.
Referenced by Foam::operator>>().
|
inline |
Return label, float or double value.
Report FatalIOError and return 0 if token is not a LABEL, FLOAT or DOUBLE
Definition at line 713 of file tokenI.H.
Referenced by arcEdge::arcEdge(), CrankNicolsonDdtScheme< Type >::CrankNicolsonDdtScheme(), seriesWriter::load(), Foam::operator>>(), dimensionSet::read(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), and IOstreamOption::versionNumber::versionNumber().
|
inline |
Return const reference to the word contents.
Report FatalIOError and return "" if token is not a WORD or DIRECTIVE
Definition at line 747 of file tokenI.H.
References word::null.
Referenced by fileName::assign(), keyType::assign(), wordRe::assign(), blockDescriptor::blockDescriptor(), ifeqEntry::evaluate(), ifeqEntry::execute(), blockVertex::New(), Foam::operator>>(), Foam::printTokenError(), Foam::printTokenInfo(), Foam::blockMeshTools::read(), dimensionSet::read(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), Switch::Switch(), OSstream::write(), and UOPstreamBase::write().
|
inline |
Return const reference to the string contents.
Report FatalIOError and return "" if token is not a STRING, EXPRESSION, VARIABLE, VERBATIM, CHAR_DATA or an upcast WORD or DIRECTIVE
Definition at line 801 of file tokenI.H.
References string::null.
Referenced by fileName::assign(), keyType::assign(), wordRe::assign(), Foam::exprTools::getList(), seriesWriter::load(), Foam::operator>>(), Foam::printTokenInfo(), IOstreamOption::versionNumber::versionNumber(), functionEntry::write(), OSstream::write(), and UOPstreamBase::write().
|
inline |
Const reference to compound token. Fatal if the wrong type.
Definition at line 849 of file tokenI.H.
Referenced by Foam::printTokenInfo().
|
inline |
|
inline |
Return reference to the underlying encapsulated container (eg, List<label>
etc) of a compound token. No checks for released or pending states.
Default construct the specified compound type and read from stream.
A no-op and returns false if compound type is unknown. Modify the token and return true on success.
Definition at line 126 of file token.C.
References token::compound::read().
Referenced by Foam::readCompoundToken().
Foam::token::compound & transferCompoundToken | ( | const Istream * | is = nullptr | ) |
Return reference to compound and mark internally as released.
Optional Istream parameter only as reference for errors messages.
Definition at line 157 of file token.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::FatalIOError, and FatalIOErrorInFunction.
Referenced by mappedPatchBase::constructIOField(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), FixedList< point, 2 >::readList(), and UList< Foam::vector >::readList().
|
inline |
|
inline |
Mark the compound as released and return a reference to the underlying encapsulated container - eg, List<label>
The Istream is used for reference error messages only.
|
inline |
Reset token to UNDEFINED and clear any allocated storage.
Definition at line 335 of file tokenI.H.
Referenced by Foam::operator>>(), UIPstreamBase::read(), ISstream::read(), and ITstream::read().
|
inline |
Clear token and set to be ERROR.
Definition at line 379 of file tokenI.H.
Referenced by UIPstreamBase::read(), and ISstream::read().
|
inlinenoexcept |
Return info proxy, for printing token information to a stream.
Definition at line 1106 of file token.H.
Referenced by Field< Foam::vector >::assign(), blockDescriptor::blockDescriptor(), dictionaryListEntry::dictionaryListEntry(), blockVertex::New(), entry::New(), Foam::operator>>(), Foam::printTokenError(), Foam::blockMeshTools::read(), Istream::readBegin(), Istream::readBeginList(), IOPosition< CloudType >::readData(), Istream::readEnd(), Istream::readEndList(), PtrList< transferModel >::readIstream(), LList< Foam::chemPointISAT< CompType, ThermoType > *>::readList(), List< Field< scalar > >::readList(), DynamicList< Foam::vector >::readList(), PackedList< 2 >::readList(), FixedList< point, 2 >::readList(), UList< Foam::vector >::readList(), Matrix< RectangularMatrix< Type >, Type >::readMatrix(), Reaction< ReactionThermo >::specieCoeffs::specieCoeffs(), and IOstreamOption::versionNumber::versionNumber().
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
Definition at line 1105 of file tokenI.H.
References Foam::equal().
|
inlinenoexcept |
|
inlinenoexcept |
Definition at line 1182 of file tokenI.H.
References Foam::equal().
|
inlinenoexcept |
Definition at line 1192 of file tokenI.H.
References Foam::equal().
|
inline |
|
inline |
Definition at line 1202 of file tokenI.H.
References Foam::operator==().
|
inlinenoexcept |
|
inlinenoexcept |
Definition at line 1214 of file tokenI.H.
References Foam::operator==().
|
inlinenoexcept |
Definition at line 1220 of file tokenI.H.
References Foam::operator==().
|
inlinenoexcept |
Definition at line 1226 of file tokenI.H.
References Foam::operator==().
|
inline |
Definition at line 1232 of file tokenI.H.
References Foam::operator==(), and s.
|
inlinenoexcept |
Write access for the token line number.
|
inline |
Token is FLOAT.
Definition at line 1218 of file token.H.
References token::isFloat().
|
inline |
Token is DOUBLE.
Definition at line 1225 of file token.H.
References token::isDouble().
|
inline |
Return float value.
Definition at line 1232 of file token.H.
References token::floatToken().
|
inline |
Return double value.
Definition at line 1239 of file token.H.
References token::doubleToken().
|
delete |
Deprecated(2017-11) transfer word pointer to the token.
|
delete |
Deprecated(2017-11) transfer string pointer to the token.
|
friend |
|
friend |
|
static |
|
static |