File size: 8,235 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2025-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 "codeBlockEntry.H"
#include "endCodeBlockEntry.H"
#include "codeBlockStreamEntry.H"
#include "codeBlockDictEntry.H"
#include "codeStream.H"
#include "codeDict.H"
#include "streamEntry.H"
#include "calcEntry.H"
#include "codeIncludeEntry.H"
#include "negEntry.H"
#include "OTstream.H"
#include "ITstream.H"
#include "addToRunTimeSelectionTable.H"
// * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
namespace Foam
{
namespace functionEntries
{
defineFunctionTypeNameAndDebug(codeBlockEntry, 0);
addToRunTimeSelectionTable(functionEntry, codeBlockEntry, dictionary);
}
}
const Foam::word Foam::functionEntries::codeBlockEntry::codeOptions
(
"codeBlockOptions"
);
const Foam::wordList Foam::functionEntries::codeBlockEntry::compileFiles
{
"codeBlockTemplate.C"
};
// * * * * * * * * * * * * * * * * Constructors * * * * * * * * * * * * * * //
Foam::functionEntries::codeBlockEntry::codeBlockEntry
(
const label lineNumber,
const dictionary& parentDict,
Istream& is
)
:
functionEntry(typeName, lineNumber, parentDict),
codeBlockName_(word::null),
lib_(nullptr)
{}
// * * * * * * * * * * * * * * * Member Functions * * * * * * * * * * * * * //
bool Foam::functionEntries::codeBlockEntry::execute
(
dictionary& contextDict,
Istream& is
)
{
if (debug)
{
Info<< "Compiling code within " << typeName << " starting at line "
<< is.lineNumber() << " in file " << contextDict.name() << endl;
}
// Construct codeDict for codeStream with the parent dictionary provided for
// string expansion and variable substitution and the same name as the
// parent for consistent error messaging
dictionary codeDict(typeName, contextDict);
string codeString;
List<fileName> includeFileNames;
// Disable functionEntry expansion
entry::disableFunctionEntries = true;
// Read the dictionary up to #endCodeBlock
// Dict stream including the code retrieval entries
OTstream dictCodeStream(contextDict.name());
// Dict stream without the code retrieval entries
// used to provide entries for the code to lookup
OTstream dictStream(contextDict.name());
label codeIndex = 0;
token t;
while (!is.eof() && !is.read(t).bad() && t.good())
{
if (t.isFunctionName())
{
if (t.functionNameToken() == endCodeBlockEntry::typeName)
{
break;
}
else if (t.functionNameToken() == codeStream::typeName)
{
// Accumulate the #codeStream code strings
// into a single code block
codeString +=
codeStream::codeString(codeIndex, contextDict, is);
// Replace the #codeStream with a #codeBlockStream followed by
// the pointer to this codeBlockEntry and the index of
// #codeStream
dictCodeStream
<< keyType(codeBlockStreamEntry::typeName) << token::SPACE
<< reinterpret_cast<uint64_t>(this) << token::SPACE
<< codeIndex++ << endl;
}
else if (t.functionNameToken() == codeDict::typeName)
{
// Accumulate the #codeDict code strings
// into a single code block
codeString +=
codeDict::codeString(codeIndex, contextDict, is);
// Replace the #codeDict with a #codeBlockDict followed by the
// pointer to this codeBlockEntry and the index of #codeDict
dictCodeStream
<< keyType(codeBlockDictEntry::typeName) << token::SPACE
<< reinterpret_cast<uint64_t>(this) << token::SPACE
<< codeIndex++ << endl;
}
else if (t.functionNameToken() == streamEntry::typeName)
{
// Accumulate the #stream code strings into a single code block
codeString +=
streamEntry::codeString(codeIndex, codeDict, is);
// Replace the #stream with a #codeBlockStream followed by
// the pointer to this codeBlockEntry and the index of #stream
dictCodeStream
<< keyType(codeBlockStreamEntry::typeName) << token::SPACE
<< reinterpret_cast<uint64_t>(this) << token::SPACE
<< codeIndex++ << endl;
}
else if (t.functionNameToken() == calcEntry::typeName)
{
// Accumulate the #calc code strings into a single code block
codeString +=
calcEntry::codeString(codeIndex, codeDict, is);
// Replace the #calc with a #codeBlockStream followed by
// the pointer to this codeBlockEntry and the index of #calc
dictCodeStream
<< keyType(codeBlockStreamEntry::typeName) << token::SPACE
<< reinterpret_cast<uint64_t>(this) << token::SPACE
<< codeIndex++ << endl;
}
else if (t.functionNameToken() == codeIncludeEntry::typeName)
{
// Add any optional codeInclude entry to codeDict
includeFileNames.append
(
codeIncludeEntry(t.lineNumber(), codeDict, is).fileNames()
);
}
else if (t.functionNameToken() == negEntry::typeName)
{
dictCodeStream.append(t);
}
else
{
FatalIOErrorInFunction(is)
<< t.functionNameToken() << " not supported within "
<< codeBlockEntry::typeName << "..."
<< endCodeBlockEntry::typeName
<< exit(FatalIOError);
}
}
else
{
dictCodeStream.append(t);
dictStream.append(t);
}
}
// Read the dictionary without expanding functionEntries
// to provide entries for the code to lookup
contextDict.read(ITstream(dictStream.name(), dictStream)());
// Add the code entry to the codeDict
codeDict.add(primitiveEntry("code", codeString, 0));
codeIncludeEntry::addCodeInclude(includeFileNames, contextDict, codeDict);
// Compile the codeBlock library and cache the pointer
lib_ = codeStream::compile
(
typeName,
contextDict,
codeDict,
codeOptions,
compileFiles,
codeBlockName_
);
// Re-enable functionEntry expansion
entry::disableFunctionEntries = false;
// Re-read the dictionary expanding all functionEntries
// including #codeBlockStream and #codeBlockDict using the functions in lib_
contextDict.read(ITstream(dictCodeStream.name(), dictCodeStream)());
return true;
}
// ************************************************************************* //
|