File size: 15,126 Bytes
5a600cf | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 OpenFOAM Foundation
\\/ 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 "functionName.H"
#include "variable.H"
#include "keyType.H"
#include "verbatimString.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 : char
{
UNDEFINED = 0,
PUNCTUATION = char(128),
WORD,
FUNCTIONNAME,
VARIABLE,
STRING,
VERBATIMSTRING,
INTEGER_32,
INTEGER_64,
UNSIGNED_INTEGER_32,
UNSIGNED_INTEGER_64,
FLOAT_SCALAR,
DOUBLE_SCALAR,
LONG_DOUBLE_SCALAR,
COMPOUND,
ERROR
};
//- Standard punctuation tokens
enum punctuationToken : char
{
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_;
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)
{}
//- Disallow default bitwise copy construction
compound(const compound&) = delete;
// Selectors
//- Select null constructed
static autoPtr<compound> New(const word& type, Istream&);
//- Destructor
virtual ~compound();
// Member Functions
//- 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;
virtual void write(Ostream&) const = 0;
// Member Operators
//- Disallow default bitwise assignment
void operator=(const compound&) = delete;
// 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
//- List of token type names
static const word typeNames_[];
//- The token type
tokenType type_;
//- Anonymous Union of token types
union
{
punctuationToken punctuationToken_;
word* wordTokenPtr_;
functionName* functionNameTokenPtr_;
variable* variableTokenPtr_;
string* stringTokenPtr_;
verbatimString* verbatimStringTokenPtr_;
int32_t integer32Token_;
int64_t integer64Token_;
uint32_t unsignedInteger32Token_;
uint64_t unsignedInteger64Token_;
floatScalar floatScalarToken_;
doubleScalar doubleScalarToken_;
longDoubleScalar* longDoubleScalarTokenPtr_;
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:
// Constructors
//- Construct null
inline token();
//- Copy constructor
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 keyType token
inline token(const keyType&, label lineNumber=0);
//- Construct verbatimString token
inline token(const verbatimString&, label lineNumber=0);
//- Construct 32-bit integer token
inline token(const int32_t, label lineNumber=0);
//- Construct 64-bit integer token
inline token(const int64_t, label lineNumber=0);
//- Construct unsigned 32-bit integer token
inline token(const uint32_t, label lineNumber=0);
//- Construct unsigned 64-bit integer token
inline token(const uint64_t, label lineNumber=0);
//- Construct floatScalar token
inline token(const floatScalar, label lineNumber=0);
//- Construct doubleScalar token
inline token(const doubleScalar, label lineNumber=0);
//- Construct longDoubleScalar token
inline token(const longDoubleScalar, 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;
//- Return the type name of the token
const word& typeName() const;
inline bool isPunctuation() const;
inline punctuationToken pToken() const;
inline bool isWord() const;
inline const word& wordToken() const;
inline bool isFunctionName() const;
inline const functionName& functionNameToken() const;
inline bool isVariable() const;
inline const variable& variableToken() const;
inline bool isString() const;
inline const string& stringToken() const;
inline bool isVerbatimString() const;
inline const verbatimString& verbatimStringToken() const;
inline bool isAnyString() const;
inline const string& anyStringToken() const;
inline bool isInteger32() const;
inline int32_t integer32Token() const;
inline bool isInteger64() const;
inline int64_t integer64Token() const;
inline bool isUnsignedInteger32() const;
inline uint32_t unsignedInteger32Token() const;
inline bool isUnsignedInteger64() const;
inline uint64_t unsignedInteger64Token() const;
inline bool isLabel() const;
inline label labelToken() const;
inline bool isULabel() const;
inline uLabel uLabelToken() const;
inline bool isFloatScalar() const;
inline floatScalar floatScalarToken() const;
inline bool isDoubleScalar() const;
inline doubleScalar doubleScalarToken() const;
inline bool isLongDoubleScalar() const;
inline longDoubleScalar longDoubleScalarToken() 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(const Istream& is);
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=(functionName*);
inline void operator=(const functionName&);
inline void operator=(variable*);
inline void operator=(const variable&);
inline void operator=(string*);
inline void operator=(const string&);
inline void operator=(verbatimString*);
inline void operator=(const verbatimString&);
inline void operator=(const int32_t);
inline void operator=(const int64_t);
inline void operator=(const uint32_t);
inline void operator=(const uint64_t);
inline void operator=(const floatScalar);
inline void operator=(const doubleScalar);
inline void operator=(const longDoubleScalar);
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 functionName&) const;
inline bool operator==(const variable&) const;
inline bool operator==(const string&) const;
inline bool operator==(const verbatimString&) const;
inline bool operator==(const int32_t) const;
inline bool operator==(const int64_t) const;
inline bool operator==(const uint32_t) const;
inline bool operator==(const uint64_t) const;
inline bool operator==(const floatScalar) const;
inline bool operator==(const doubleScalar) const;
inline bool operator==(const longDoubleScalar) const;
// Inequality
inline bool operator!=(const token&) const;
inline bool operator!=(const punctuationToken) const;
inline bool operator!=(const word&) const;
inline bool operator!=(const functionName&) const;
inline bool operator!=(const variable&) const;
inline bool operator!=(const string&) const;
inline bool operator!=(const verbatimString&) const;
inline bool operator!=(const int32_t) const;
inline bool operator!=(const int64_t) const;
inline bool operator!=(const uint32_t) const;
inline bool operator!=(const uint64_t) const;
inline bool operator!=(const floatScalar) const;
inline bool operator!=(const doubleScalar) const;
inline bool operator!=(const longDoubleScalar) 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 token::compound&);
ostream& operator<<(ostream&, const InfoProxy<token>&);
template<>
Ostream& operator<<(Ostream& os, const InfoProxy<token>& ip);
#define defineCompoundTypeName(Type, Name) \
defineTemplateTypeNameAndDebugWithName(token::Compound<Type>, #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
// ************************************************************************* //
|