File size: 5,911 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::entry
Description
A keyword and a list of tokens is an 'entry'.
An entry can be read, written and printed, and the types and values of
its tokens analysed. An entry is a high-level building block for data
description. It is a front-end for the token parser. A list of entries
can be used as a set of keyword syntax elements, for example.
SourceFiles
entry.C
entryIO.C
\*---------------------------------------------------------------------------*/
#ifndef entry_H
#define entry_H
#include "keyType.H"
#include "IDLList.H"
#include "fileName.H"
#include "autoPtr.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
class ITstream;
class dictionary;
// Forward declaration of friend functions and operators
class entry;
Ostream& operator<<(Ostream&, const entry&);
/*---------------------------------------------------------------------------*\
Class entry Declaration
\*---------------------------------------------------------------------------*/
class entry
:
public IDLList<entry>::link
{
// Private Data
//- Keyword of entry
keyType keyword_;
//- Line number of the entry keyword
label startLineNumber_;
// Private Member Functions
//- Get the next valid keyword
// set the line number return true if is valid
static bool getKeyword
(
keyType& keyword,
token& keywordToken,
label& keywordLineNo,
Istream& is
);
//- Get the next valid keyword
// set the line number return true if is valid
static bool getKeyword
(
keyType& keyword,
label& keywordLineNo,
Istream& is
);
public:
static int disableFunctionEntries;
// Constructors
//- Construct from keyword and corresponding line number
explicit entry(const keyType& key, const label keywordLineNumber);
//- Copy constructor
entry(const entry&);
//- Construct on freestore as copy with reference to the
// dictionary the copy belongs to
virtual autoPtr<entry> clone(const dictionary& parentDict) const = 0;
//- Construct on freestore as copy
// Note: the parent directory is set to dictionary::null
virtual autoPtr<entry> clone() const;
//- Construct from Istream and insert into dictionary
static bool New(dictionary& parentDict, Istream&);
//- Construct on freestore from Istream and return
static autoPtr<entry> New(Istream& is);
//- Destructor
virtual ~entry()
{}
// Member Functions
//- Return keyword
const keyType& keyword() const
{
return keyword_;
}
//- Return non-const access to keyword
keyType& keyword()
{
return keyword_;
}
//- Return the dictionary name
virtual const fileName& name() const = 0;
//- Return the dictionary name
virtual fileName& name() = 0;
//- Return line number of keyword of the entry
virtual label startLineNumber() const
{
return startLineNumber_;
}
//- Return non-const access to line number of keyword of the entry
virtual label& startLineNumber()
{
return startLineNumber_;
}
//- Return line number of last token in dictionary
virtual label endLineNumber() const = 0;
//- Return true if this entry is a stream
virtual bool isStream() const
{
return false;
}
//- Return token stream if this entry is a primitive entry
virtual ITstream& stream() const = 0;
//- Return true if this entry is a dictionary
virtual bool isDict() const
{
return false;
}
//- Return dictionary if this entry is a dictionary
virtual const dictionary& dict() const = 0;
//- Return non-const access to dictionary if this entry is a dictionary
virtual dictionary& dict() = 0;
//- Write
virtual void write(Ostream&) const = 0;
// Member Operators
void operator=(const entry&);
bool operator==(const entry&) const;
bool operator!=(const entry&) const;
// Ostream operator
friend Ostream& operator<<(Ostream&, const entry&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|