mirror of
https://develop.openfoam.com/Development/openfoam.git
synced 2025-11-28 03:28:01 +00:00
460 lines
11 KiB
C++
460 lines
11 KiB
C++
/*---------------------------------------------------------------------------*\
|
|
========= |
|
|
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
|
|
\\ / O peration |
|
|
\\ / A nd | Copyright (C) 2004-2011 OpenCFD Ltd.
|
|
\\/ M anipulation |
|
|
-------------------------------------------------------------------------------
|
|
License
|
|
This file is part of OpenFOAM.
|
|
|
|
OpenFOAM is free software: you can redistribute it and/or modify it
|
|
under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
|
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
Class
|
|
Foam::token
|
|
|
|
Description
|
|
A token holds items read from Istream.
|
|
|
|
SourceFiles
|
|
tokenI.H
|
|
token.C
|
|
tokenIO.C
|
|
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
#ifndef token_H
|
|
#define token_H
|
|
|
|
#include "label.H"
|
|
#include "uLabel.H"
|
|
#include "scalar.H"
|
|
#include "word.H"
|
|
#include "InfoProxy.H"
|
|
#include "refCount.H"
|
|
#include "typeInfo.H"
|
|
|
|
#define NoHashTableC
|
|
#include "runTimeSelectionTables.H"
|
|
|
|
#include <iostream>
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
namespace Foam
|
|
{
|
|
|
|
// Forward declaration of friend functions and operators
|
|
|
|
class token;
|
|
Istream& operator>>(Istream&, token&);
|
|
Ostream& operator<<(Ostream&, const token&);
|
|
|
|
/*---------------------------------------------------------------------------*\
|
|
Class token Declaration
|
|
\*---------------------------------------------------------------------------*/
|
|
|
|
class token
|
|
{
|
|
|
|
public:
|
|
|
|
//- Enumeration defining the types of token
|
|
enum tokenType
|
|
{
|
|
UNDEFINED,
|
|
|
|
PUNCTUATION,
|
|
WORD,
|
|
STRING,
|
|
VERBATIMSTRING,
|
|
LABEL,
|
|
FLOAT_SCALAR,
|
|
DOUBLE_SCALAR,
|
|
COMPOUND,
|
|
|
|
ERROR
|
|
};
|
|
|
|
|
|
//- Standard punctuation tokens
|
|
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 = '/'
|
|
};
|
|
|
|
|
|
//- Abstract base class for complex tokens
|
|
class compound
|
|
:
|
|
public refCount
|
|
{
|
|
// Private data
|
|
|
|
bool empty_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Disallow default bitwise copy construct
|
|
compound(const compound&);
|
|
|
|
//- Disallow default bitwise assignment
|
|
void operator=(const compound&);
|
|
|
|
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("compound");
|
|
|
|
|
|
//- Declare run-time constructor selection table
|
|
declareRunTimeSelectionTable
|
|
(
|
|
autoPtr,
|
|
compound,
|
|
Istream,
|
|
(Istream& is),
|
|
(is)
|
|
);
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
compound()
|
|
:
|
|
empty_(false)
|
|
{}
|
|
|
|
|
|
// Selectors
|
|
|
|
//- Select null constructed
|
|
static autoPtr<compound> New(const word& type, Istream&);
|
|
|
|
|
|
//- Destructor
|
|
virtual ~compound();
|
|
|
|
|
|
// Member Functions
|
|
|
|
// Access
|
|
|
|
//- Return true if name is a compound type
|
|
static bool isCompound(const word& name);
|
|
|
|
bool empty() const
|
|
{
|
|
return empty_;
|
|
}
|
|
|
|
bool& empty()
|
|
{
|
|
return empty_;
|
|
}
|
|
|
|
virtual label size() const = 0;
|
|
|
|
|
|
// Check
|
|
|
|
// Edit
|
|
|
|
// Write
|
|
|
|
virtual void write(Ostream&) const = 0;
|
|
|
|
|
|
// IOstream Operators
|
|
|
|
friend Ostream& operator<<(Ostream&, const compound&);
|
|
};
|
|
|
|
|
|
//- A templated class for holding compound tokens
|
|
template<class T>
|
|
class Compound
|
|
:
|
|
public token::compound,
|
|
public T
|
|
{
|
|
public:
|
|
|
|
//- Runtime type information
|
|
TypeName("Compound<T>");
|
|
|
|
Compound(Istream& is)
|
|
:
|
|
T(is)
|
|
{}
|
|
|
|
label size() const
|
|
{
|
|
return T::size();
|
|
}
|
|
|
|
void write(Ostream& os) const
|
|
{
|
|
operator<<(os, static_cast<const T&>(*this));
|
|
}
|
|
};
|
|
|
|
|
|
//- Static undefined token
|
|
static token undefinedToken;
|
|
|
|
|
|
private:
|
|
|
|
// Private data
|
|
|
|
//- The token type
|
|
tokenType type_;
|
|
|
|
//- Anonymous Union of token types
|
|
union
|
|
{
|
|
punctuationToken punctuationToken_;
|
|
word* wordTokenPtr_;
|
|
string* stringTokenPtr_;
|
|
label labelToken_;
|
|
floatScalar floatScalarToken_;
|
|
doubleScalar doubleScalarToken_;
|
|
mutable compound* compoundTokenPtr_;
|
|
};
|
|
|
|
//- Line number in the file this token was read from
|
|
label lineNumber_;
|
|
|
|
|
|
// Private Member Functions
|
|
|
|
//- Clear any allocated storage (word or string)
|
|
inline void clear();
|
|
|
|
// Parse error, expected 'expected', found ...
|
|
void parseError(const char* expected) const;
|
|
|
|
|
|
public:
|
|
|
|
// Static data members
|
|
|
|
static const char* const typeName;
|
|
|
|
|
|
// Constructors
|
|
|
|
//- Construct null
|
|
inline token();
|
|
|
|
//- Construct as copy
|
|
inline token(const token&);
|
|
|
|
//- Construct punctuation character token
|
|
inline token(punctuationToken, label lineNumber=0);
|
|
|
|
//- Construct word token
|
|
inline token(const word&, label lineNumber=0);
|
|
|
|
//- Construct string token
|
|
inline token(const string&, label lineNumber=0);
|
|
|
|
//- Construct label token
|
|
inline token(const label, label lineNumber=0);
|
|
|
|
//- Construct floatScalar token
|
|
inline token(const floatScalar, label lineNumber=0);
|
|
|
|
//- Construct doubleScalar token
|
|
inline token(const doubleScalar, label lineNumber=0);
|
|
|
|
//- Construct from Istream
|
|
token(Istream&);
|
|
|
|
|
|
//- Destructor
|
|
inline ~token();
|
|
|
|
|
|
// Member functions
|
|
|
|
// Access
|
|
|
|
inline tokenType type() const;
|
|
inline tokenType& type();
|
|
|
|
inline bool good() const;
|
|
inline bool undefined() const;
|
|
inline bool error() const;
|
|
|
|
inline bool isPunctuation() const;
|
|
inline punctuationToken pToken() const;
|
|
|
|
inline bool isWord() const;
|
|
inline const word& wordToken() const;
|
|
|
|
inline bool isString() const;
|
|
inline const string& stringToken() const;
|
|
|
|
inline bool isLabel() const;
|
|
inline label labelToken() const;
|
|
|
|
inline bool isFloatScalar() const;
|
|
inline floatScalar floatScalarToken() const;
|
|
|
|
inline bool isDoubleScalar() const;
|
|
inline doubleScalar doubleScalarToken() const;
|
|
|
|
inline bool isScalar() const;
|
|
inline scalar scalarToken() const;
|
|
|
|
inline bool isNumber() const;
|
|
inline scalar number() const;
|
|
|
|
inline bool isCompound() const;
|
|
inline const compound& compoundToken() const;
|
|
compound& transferCompoundToken();
|
|
|
|
inline label lineNumber() const;
|
|
inline label& lineNumber();
|
|
|
|
|
|
// Edit
|
|
|
|
//- Set bad
|
|
inline void setBad();
|
|
|
|
|
|
// Info
|
|
|
|
//- Return info proxy.
|
|
// Used to print token information to a stream
|
|
InfoProxy<token> info() const
|
|
{
|
|
return *this;
|
|
}
|
|
|
|
|
|
// Member operators
|
|
|
|
// Assignment
|
|
|
|
inline void operator=(const token&);
|
|
|
|
inline void operator=(const punctuationToken);
|
|
|
|
inline void operator=(word*);
|
|
inline void operator=(const word&);
|
|
|
|
inline void operator=(string*);
|
|
inline void operator=(const string&);
|
|
|
|
inline void operator=(const label);
|
|
inline void operator=(const floatScalar);
|
|
inline void operator=(const doubleScalar);
|
|
|
|
inline void operator=(compound*);
|
|
|
|
|
|
// Equality
|
|
|
|
inline bool operator==(const token&) const;
|
|
inline bool operator==(const punctuationToken) const;
|
|
inline bool operator==(const word&) const;
|
|
inline bool operator==(const string&) const;
|
|
inline bool operator==(const label) const;
|
|
inline bool operator==(const floatScalar) const;
|
|
inline bool operator==(const doubleScalar) const;
|
|
|
|
|
|
// Inequality
|
|
|
|
inline bool operator!=(const token&) const;
|
|
inline bool operator!=(const punctuationToken) const;
|
|
inline bool operator!=(const word&) const;
|
|
inline bool operator!=(const string&) const;
|
|
inline bool operator!=(const label) const;
|
|
inline bool operator!=(const floatScalar) const;
|
|
inline bool operator!=(const doubleScalar) const;
|
|
|
|
|
|
// IOstream operators
|
|
|
|
friend 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>&);
|
|
};
|
|
|
|
|
|
Ostream& operator<<(Ostream&, const token::punctuationToken&);
|
|
ostream& operator<<(ostream&, const token::punctuationToken&);
|
|
ostream& operator<<(ostream&, const InfoProxy<token>&);
|
|
Ostream& operator<<(Ostream&, const token::compound&);
|
|
|
|
|
|
#define defineCompoundTypeName(Type, Name) \
|
|
typedef token::Compound<Type> tokenCompound##Name##_; \
|
|
defineTemplateTypeNameAndDebugWithName(tokenCompound##Name##_, #Type, 0);
|
|
|
|
#define addCompoundToRunTimeSelectionTable(Type, Name) \
|
|
token::compound::addIstreamConstructorToTable<token::Compound<Type> > \
|
|
add##Name##IstreamConstructorToTable_;
|
|
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
} // End namespace Foam
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#include "tokenI.H"
|
|
#include "Istream.H"
|
|
|
|
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
|
|
|
|
#endif
|
|
|
|
// ************************************************************************* //
|