File size: 5,500 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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::dictionaryEntry
Description
A keyword and a list of tokens is a 'dictionaryEntry'.
An dictionaryEntry can be read, written and printed, and the types and
values of its tokens analysed. A dictionaryEntry 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
dictionaryEntry.C
dictionaryEntryIO.C
\*---------------------------------------------------------------------------*/
#include "dictionary.H"
#ifndef dictionaryEntry_H
#define dictionaryEntry_H
#include "InfoProxy.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class dictionaryEntry;
Ostream& operator<<(Ostream&, const dictionaryEntry&);
/*---------------------------------------------------------------------------*\
Class dictionaryEntry Declaration
\*---------------------------------------------------------------------------*/
class dictionaryEntry
:
public entry,
public dictionary
{
// Private Member Functions
void readData(Istream&);
public:
// Constructors
//- Construct from the parent dictionary and Istream
dictionaryEntry(const dictionary& parentDict, Istream&);
//- Construct from keyword, line number, parent dictionary and Istream
dictionaryEntry
(
const keyType&,
const label lineNumber,
const dictionary& parentDict,
Istream& is
);
//- Construct from the keyword, parent dictionary and a Istream
dictionaryEntry
(
const keyType&,
const dictionary& parentDict,
Istream& is
);
//- Construct from the keyword, parent dictionary and a dictionary
dictionaryEntry
(
const keyType&,
const dictionary& parentDict,
const dictionary& dict
);
//- Construct as copy for the given parent dictionary
dictionaryEntry
(
const dictionary& parentDict,
const dictionaryEntry&
);
//- Disallow bitwise copy
dictionaryEntry(const dictionary&) = delete;
autoPtr<entry> clone(const dictionary& parentDict) const
{
return autoPtr<entry>(new dictionaryEntry(parentDict, *this));
}
// Member Functions
//- Return the local dictionary name (final part of scoped name)
const word dictName() const
{
return dictionary::dictName();
}
//- Return the dictionary name (scoped, e.g. dictA::dictB::dictC)
const fileName& name() const
{
return dictionary::name();
}
//- Return the dictionary name (scoped, e.g. dictA::dictB::dictC)
fileName& name()
{
return dictionary::name();
}
//- Return line number of the keyword of the entry
virtual label startLineNumber() const;
//- Return line number of last token in the dictionary
virtual label endLineNumber() const;
//- This entry is not a primitive,
// calling this function generates a FatalError
ITstream& stream() const;
//- Return true because this entry is a dictionary
bool isDict() const
{
return true;
}
//- Return dictionary
const dictionary& dict() const;
//- Return non-const access to dictionary
dictionary& dict();
//- Write
void write(Ostream&) const;
//- Return info proxy.
// Used to print token information to a stream
InfoProxy<dictionaryEntry> info() const
{
return *this;
}
// Ostream operator
friend Ostream& operator<<(Ostream&, const dictionaryEntry&);
};
template<>
Ostream& operator<<(Ostream&, const InfoProxy<dictionaryEntry>&);
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|