File size: 9,452 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2026 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 "includeEntry.H"
#include "includeIfPresentEntry.H"
#include "stringOps.H"
#include "IOobject.H"
#include "addToRunTimeSelectionTable.H"
#include "addToMemberFunctionSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
bool Foam::functionEntries::includeEntry::log(false);
namespace Foam
{
namespace functionEntries
{
defineFunctionTypeNameAndDebug(includeEntry, 0);
addToRunTimeSelectionTable(functionEntry, includeEntry, dictionary);
addToMemberFunctionSelectionTable
(
functionEntry,
includeEntry,
execute,
primitiveEntryIstream
);
}
}
// * * * * * * * * * * * Private Member Functions * * * * * * * * * * * * * //
Foam::List<Foam::Tuple3<Foam::word, Foam::string, Foam::label>>
Foam::functionEntries::includeEntry::insertNamedArgs
(
dictionary& contextDict,
const Tuple2<string, label>& fNameArgs
) const
{
List<Tuple3<word, string, label>> namedArgs;
// If the next character is a '(' process the arguments
if (fNameArgs.first().size())
{
// Parse the argument string
word funcType;
List<Tuple2<wordRe, label>> args;
dictArgList(fNameArgs, funcType, args, namedArgs);
// Add the named arguments as entries into the contextDict
// temporarily renaming any existing entries with the same name
forAll(namedArgs, i)
{
const Pair<word> dAk(dictAndKeyword(namedArgs[i].first()));
dictionary& subDict(contextDict.scopedDict(dAk.first()));
// Rename the original entry adding a '_'
if (subDict.found(dAk.second()))
{
keyType tmpName(dAk.second());
tmpName += '_';
subDict.changeKeyword(dAk.second(), tmpName);
}
// Add the temporary argument entry
IStringStream entryStream
(
dAk.second()
+ ' '
+ expandArg
(
namedArgs[i].second(),
contextDict,
namedArgs[i].third()
)
+ ';'
);
subDict.set(entry::New(entryStream).ptr());
}
}
return namedArgs;
}
void Foam::functionEntries::includeEntry::removeInsertNamedArgs
(
dictionary& contextDict,
const List<Tuple3<word, string, label>>& namedArgs
) const
{
forAll(namedArgs, i)
{
// Remove the temporary argument entry
contextDict.remove(namedArgs[i].first());
// Reinstate the original entry
const Pair<word> dAk(dictAndKeyword(namedArgs[i].first()));
dictionary& subDict(contextDict.scopedDict(dAk.first()));
keyType tmpName(dAk.second());
tmpName += '_';
subDict.changeKeyword(tmpName, dAk.second());
}
}
// * * * * * * * * * * * Protected Member Functions * * * * * * * * * * * * //
Foam::fileName Foam::functionEntries::includeEntry::includeFileName
(
const fileName& dir,
const fileName& f,
const dictionary& dict
) const
{
fileName fName(f);
// Substitute dictionary and environment variables. Allow empty
// substitutions.
stringOps::inplaceExpandEntry(fName, dict, true, true);
if (fName.empty() || fName.isAbsolute())
{
return fName;
}
else
{
// relative name
return dir/fName;
}
}
bool Foam::functionEntries::includeEntry::virtualExecute
(
const dictionary& contextDict,
primitiveEntry& contextEntry,
Istream& is
)
{
const fileName fName
(
includeFileName(is.name().path(), this->fName(), contextDict)
);
if (!fileHandler().exists(fName))
{
if (includeIfPresent())
{
return true;
}
else
{
FatalIOErrorInFunction
(
is
) << "Cannot find include file " << fName
<< " while reading dictionary " << contextDict.name()
<< exit(FatalIOError);
}
}
// Cache the optional named arguments
// temporarily inserted into contextDict
List<Tuple3<word, string, label>> namedArgs
(
insertNamedArgs(const_cast<dictionary&>(contextDict), args())
);
autoPtr<ISstream> ifsPtr(fileHandler().NewIFstream(fName));
ISstream& ifs = ifsPtr();
if (ifs)
{
if (Foam::functionEntries::includeEntry::log)
{
Info<< fName << endl;
}
contextEntry.read(contextDict, ifs);
}
else
{
FatalIOErrorInFunction
(
is
) << "Cannot open include file "
<< (ifs.name().size() ? ifs.name() : this->fName())
<< " while reading dictionary " << contextDict.name()
<< exit(FatalIOError);
}
// Remove named argument entries from contextDict
// renaming any existing entries which had the same name
removeInsertNamedArgs(const_cast<dictionary&>(contextDict), namedArgs);
return true;
}
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::functionEntries::includeEntry::includeEntry
(
const functionName& functionType,
const label lineNumber,
const dictionary& parentDict,
Istream& is
)
:
functionEntry
(
functionType,
lineNumber,
parentDict,
is,
readFileNameArgList(functionType, is)
)
{}
Foam::functionEntries::includeEntry::includeEntry
(
const label lineNumber,
const dictionary& parentDict,
Istream& is
)
:
includeEntry(typeName, lineNumber, parentDict, is)
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::functionEntries::includeEntry::execute
(
dictionary& contextDict,
Istream& is
)
{
const fileName fName
(
includeFileName(is.name().path(), this->fName(), contextDict)
);
if (!fileHandler().exists(fName))
{
if (includeIfPresent())
{
return true;
}
else
{
FatalIOErrorInFunction
(
is
) << "Cannot find include file " << fName
<< " while reading dictionary " << contextDict.name()
<< exit(FatalIOError);
}
}
// Cache the optional named arguments
// temporarily inserted into contextDict
List<Tuple3<word, string, label>> namedArgs
(
insertNamedArgs(contextDict, args())
);
autoPtr<ISstream> ifsPtr
(
fileHandler().NewIFstream(fName, is.format(), is.version())
);
ISstream& ifs = ifsPtr();
if (ifs)
{
if (Foam::functionEntries::includeEntry::log)
{
Info<< fName << endl;
}
// Cache the FoamFile entry if present
dictionary foamFileDict;
if (contextDict.found(IOobject::foamFile))
{
foamFileDict = contextDict.subDict(IOobject::foamFile);
}
// Read and clear the FoamFile entry
contextDict.read(ifs);
// Reinstate original FoamFile entry
if (foamFileDict.size() != 0)
{
dictionary contextDictTmp(contextDict);
contextDict.clear();
contextDict.add(IOobject::foamFile, foamFileDict);
contextDict += contextDictTmp;
}
}
else
{
FatalIOErrorInFunction
(
is
) << "Cannot open include file "
<< (ifs.name().size() ? ifs.name() : this->fName())
<< " while reading dictionary " << contextDict.name()
<< exit(FatalIOError);
}
// Remove named argument entries from contextDict
// renaming any existing entries which had the same name
removeInsertNamedArgs(contextDict, namedArgs);
return true;
}
bool Foam::functionEntries::includeEntry::execute
(
const dictionary& contextDict,
primitiveEntry& contextEntry,
Istream& is
)
{
return
includeEntry(is.lineNumber(), contextDict, is)
.virtualExecute(contextDict, contextEntry, is);
}
// ************************************************************************* //
|