File size: 12,858 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
\*---------------------------------------------------------------------------*/
#include "entry.H"
#include "dictionaryListEntry.H"
#include "includeEntry.H"
#include "inputModeEntry.H"
#include "stringOps.H"
// * * * * * * * * * * * * * Private Member Functions * * * * * * * * * * * //
bool Foam::entry::getKeyword
(
keyType& keyword,
token& keywordToken,
label& keywordLineNo,
Istream& is
)
{
// Read the next valid token discarding spurious ';'s
do
{
if
(
is.read(keywordToken).bad()
|| is.eof()
|| !keywordToken.good()
)
{
return false;
}
}
while (keywordToken == token::END_STATEMENT);
keyword = keywordToken;
keywordLineNo = is.lineNumber();
return !keyword.isUndefined();
}
bool Foam::entry::getKeyword
(
keyType& keyword,
label& keywordLineNo,
Istream& is
)
{
token keywordToken;
bool ok = getKeyword(keyword, keywordToken, keywordLineNo, is);
if (ok)
{
return true;
}
else
{
// Do some more checking
if (keywordToken == token::END_BLOCK || is.eof())
{
return false;
}
else
{
// Otherwise the token is invalid
cerr<< "--> FOAM Warning : " << std::endl
<< " From function "
<< "entry::getKeyword(keyType&, Istream&)" << std::endl
<< " in file " << __FILE__
<< " at line " << __LINE__ << std::endl
<< " Reading " << is.name().c_str() << std::endl
<< " found " << keywordToken << std::endl
<< " expected either " << token::END_BLOCK << " or EOF"
<< std::endl;
return false;
}
}
}
// * * * * * * * * * * * * * * * * Selectors * * * * * * * * * * * * * * * * //
bool Foam::entry::New(dictionary& parentDict, Istream& is)
{
is.fatalCheck("entry::New(const dictionary& parentDict, Istream&)");
keyType keyword;
label keywordLineNo = -1;
token keyToken;
// Get the next keyword and if valid return true
bool valid = getKeyword(keyword, keyToken, keywordLineNo, is);
if (!valid)
{
// Do some more checking
if (keyToken == token::END_BLOCK || is.eof())
{
return false;
}
else if
(
keyToken.isLabel()
|| (keyToken.isPunctuation() && keyToken.pToken() == token::BEGIN_LIST)
)
{
is.putBack(keyToken);
return parentDict.add
(
new dictionaryListEntry(parentDict, is),
false
);
}
else
{
// Otherwise the token is invalid
cerr<< "--> FOAM Warning : " << std::endl
<< " From function "
<< "entry::New(dictionary&, Istream&)" << std::endl
<< " in file " << __FILE__
<< " at line " << __LINE__ << std::endl
<< " Reading " << is.name().c_str() << std::endl
<< " found " << keyToken << std::endl
<< " expected either " << token::END_BLOCK << " or EOF"
<< std::endl;
return false;
}
}
else // Keyword starts entry ...
{
if (keyword.isFunctionName()) // ... Function entry
{
autoPtr<functionEntry> fe
(
functionEntry::New(keyword, parentDict, is)
);
if (disableFunctionEntries)
{
// Add the unexpanded functionEntry to the dictionary
// for future processing
return parentDict.add(fe.ptr(), false);
}
else
{
// Expand the functionEntry
return fe->execute(parentDict, is);
}
}
else if
(
!disableFunctionEntries
&& keyword.isVariable()
) // ... Substitution entry
{
token nextToken(is);
is.putBack(nextToken);
if (keyword.size() > 2 && keyword[1] == token::BEGIN_BLOCK)
{
// Recursive substitution mode. Replace between {} with
// expansion and then let standard variable expansion deal
// with rest.
string s(keyword(2, keyword.size() - 3));
// Substitute dictionary and environment variables. Do not allow
// empty substitutions.
stringOps::inplaceExpandEntry(s, parentDict, true, false);
keyword.std::string::replace(1, keyword.size() - 1, s);
}
if (nextToken == token::BEGIN_BLOCK)
{
const word varName = keyword(1, keyword.size() - 1);
// Lookup the variable name in the given dictionary
const entry* ePtr = parentDict.lookupScopedEntryPtr
(
varName,
true,
true
);
if (ePtr == nullptr)
{
FatalIOErrorInFunction(is)
<< "Attempt to use undefined variable " << varName
<< " as keyword"
<< exit(FatalIOError);
return false;
}
else if (ePtr->isStream())
{
// Read as primitiveEntry
const keyType newKeyword(ePtr->stream());
return parentDict.add
(
new dictionaryEntry(newKeyword, parentDict, is),
false
);
}
else if (ePtr->isDict())
{
FatalIOErrorInFunction(is)
<< "Attempt to substitute sub-dictionary"
<< nl << *ePtr
<< "for keyword " << varName
<< exit(FatalIOError);
return false;
}
}
else
{
const word varName = keyword(1, keyword.size() - 1);
// Lookup the variable name in the given dictionary
const entry* ePtr = parentDict.lookupScopedEntryPtr
(
varName,
true,
true
);
if (ePtr == nullptr)
{
FatalIOErrorInFunction(is)
<< "Attempt to use undefined variable " << keyword
<< " as a keyword"
<< exit(FatalIOError);
return false;
}
else if (ePtr->isDict())
{
// Insert the sub-dict entries into this dictionary
const dictionary& addDict = ePtr->dict();
forAllConstIter(IDLList<entry>, addDict, iter)
{
parentDict.add(iter());
}
return true;
}
else
{
FatalIOErrorInFunction(is)
<< "Attempt to substitute primitive entry "
<< *ePtr << "as a sub-dictionary"
<< exit(FatalIOError);
return false;
}
}
return true;
}
else // ... Data entries
{
token nextToken(is);
is.putBack(nextToken);
// Deal with duplicate entries
bool mergeEntry = false;
// If function entries are disabled allow duplicate entries
if (disableFunctionEntries)
{
mergeEntry = false;
}
else
{
// See (using exact match) if entry already present
entry* existingPtr = parentDict.lookupEntryPtr
(
keyword,
false,
false
);
if (existingPtr)
{
if (functionEntries::inputModeEntry::merge())
{
mergeEntry = true;
}
else if (functionEntries::inputModeEntry::overwrite())
{
// Clear dictionary so merge acts like overwrite
if (existingPtr->isDict())
{
existingPtr->dict().clear();
}
mergeEntry = true;
}
else if (functionEntries::inputModeEntry::protect())
{
// Read and discard the entry
if (nextToken == token::BEGIN_BLOCK)
{
dictionaryEntry dummy
(
keyword,
keywordLineNo,
parentDict,
is
);
}
else
{
primitiveEntry dummy(keyword, parentDict, is);
}
return true;
}
else if (functionEntries::inputModeEntry::error())
{
FatalIOErrorInFunction(is)
<< "ERROR! duplicate entry: " << keyword
<< exit(FatalIOError);
return false;
}
}
}
if (nextToken == token::BEGIN_BLOCK)
{
return parentDict.add
(
new dictionaryEntry(keyword, keywordLineNo, parentDict, is),
mergeEntry
);
}
else
{
return parentDict.add
(
new primitiveEntry(keyword, parentDict, is),
mergeEntry
);
}
}
}
}
Foam::autoPtr<Foam::entry> Foam::entry::New(Istream& is)
{
is.fatalCheck("entry::New(Istream&)");
keyType keyword;
label keywordLineNo = -1;
// Get the next keyword and if invalid return false
if (!getKeyword(keyword, keywordLineNo, is))
{
return autoPtr<entry>(nullptr);
}
else // Keyword starts entry ...
{
token nextToken(is);
is.putBack(nextToken);
if (nextToken == token::BEGIN_BLOCK)
{
return autoPtr<entry>
(
new dictionaryEntry
(
keyword,
keywordLineNo,
dictionary::null,
is
)
);
}
else
{
return autoPtr<entry>
(
new primitiveEntry(keyword, is)
);
}
}
}
// * * * * * * * * * * * * * Ostream operator * * * * * * * * * * * * * * * //
Foam::Ostream& Foam::operator<<(Ostream& os, const entry& e)
{
e.write(os);
return os;
}
// ************************************************************************* //
|