File size: 8,737 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / 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/>.
Class
Foam::dynamicCode
Description
Encapsulation of dynamic code dictionaries and functionality
SourceFiles
dynamicCode.C
\*---------------------------------------------------------------------------*/
#ifndef dynamicCode_H
#define dynamicCode_H
#include "dictionary.H"
#include "HashTable.H"
#include "SHA1Digest.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
/*---------------------------------------------------------------------------*\
Class dynamicCode Declaration
\*---------------------------------------------------------------------------*/
class dynamicCode
{
// Private Data
//- Top-level directory name for copy/compiling
static const word topDirName;
//- Name of the code template sub-directory
// Used when locating the codeTemplateName via Foam::findEtcFile
static const fileName codeTemplateDirName;
//- Root of the LIB target for Make/files
static const char* const libTargetRoot;
//- Root for dynamic code compilation
fileName codeRoot_;
//- Subdirectory name for loading libraries
const fileName libSubDir_;
//- Name for code
word codeName_;
//- Unique name for code with the SHA1 appendedm
word codeSha1Name_;
//- Name for code subdirectory
word codeDirName_;
//- Keywords associated with source code
const wordList& codeKeys_;
//- Name of the dictionary variables in the source code
const wordList& codeDictVars_;
//- Options file name
const word& optionsFileName_;
//- Files to copy and filter and compile
const wordList& compileFiles_;
//- Files to copy and filter
const wordList& copyFiles_;
//- Code strings
// Stored to write for restart
List<verbatimString> codeStrings_;
//- Variable substitutions
HashTable<string> varSubstitutions_;
//- Code key substitutions
HashTable<string> codeKeySubstitutions_;
//- Optional "codeOptions" string
// Stored to write for restart
verbatimString optionsString_;
//- Optional "codeOptions" entry
string options_;
//- Optional "codeLibs" string
// Stored to write for restart
verbatimString libsString_;
//- Optional "codeLibs" entry
string libs_;
//- Calculated SHA1Digest
SHA1Digest sha1_;
// Private Member Functions
//- Path for SHA1Digest
// Corresponds to codePath()/Make/SHA1Digest
fileName digestFile() const
{
return codeRoot_/codeDirName_/"Make/SHA1Digest";
}
//- Path for specified code name
// Corresponds to codeRoot()/codeDirName()
fileName codePath() const
{
return codeRoot_/codeDirName_;
}
//- Path for specified code name relative to \$FOAM_CASE
// Corresponds to topDirName/codeDirName()
fileName codeRelPath() const
{
return topDirName/codeDirName_;
}
//- Add a \#line directive to the start of the given source string that
// compilation messages are meaningful
static void addLineDirective
(
string&,
const label lineNum,
const fileName& name
);
//- Copy lines while expanding variables
static void copyAndFilter
(
ISstream&,
OSstream&,
const HashTable<string>& mapping
);
//- Resolve code-templates via Foam::findConfigFile
static bool resolveTemplates
(
const wordList& templateNames,
DynamicList<fileName>& resolvedFiles,
DynamicList<fileName>& badFiles
);
//- Copy/create Make/files prior to compilation
bool createMakeFiles() const;
//- Copy/create Make/options prior to compilation
bool createMakeOptions() const;
//- Write digest to Make/SHA1Digest
bool writeDigest() const;
public:
// Static Data Members
// Declare name of the class and its debug switch
ClassName("dynamicCode");
//- Flag if system operations are allowed
static int allowSystemOperations;
// Constructors
//- Construct from the context and code dictionaries
// and lists of which entries correspond to code
dynamicCode
(
const dictionary& contextDict,
const dictionary& codeDict,
const word& codeName,
const word& codeDirName,
const wordList& codeKeys,
const wordList& codeDictVars,
const word& optionsFileName,
const wordList& compileFiles,
const wordList& copyFiles
);
//- Construct from the context dictionary also containing the code
// and lists of which entries correspond
dynamicCode
(
const dictionary& contextDict,
const word& codeName,
const word& codeDirName,
const wordList& codeKeys,
const wordList& codeDictVars,
const word& optionsFileName,
const wordList& compileFiles,
const wordList& copyFiles
);
// Member Functions
//- Return the code-name
const word& codeName() const
{
return codeName_;
}
//- Return the unique code name
const word& codeSha1Name() const
{
return codeSha1Name_;
}
//- Library path for specified code name
// Corresponds to codeRoot()/libSubDir()/lib\<codeSha1Name\>.so
fileName libPath() const
{
return codeRoot_/libSubDir_/"lib" + codeSha1Name_ + ".so";
}
//- Library path for specified code name relative to \$FOAM_CASE
// Corresponds to
// dynamicCode/codeDirName()/libSubDir()/lib\<codeSha1Name\>.so
fileName libRelPath() const
{
return codeRelPath()/libSubDir_/"lib" + codeSha1Name_ + ".so";
}
HashTable<string>& varSubstitutions()
{
return varSubstitutions_;
}
//- Return the library basename without leading 'lib' or trailing '.so'
static word libraryBaseName(const fileName& libPath);
//- Resolve code-template via Foam::findConfigFile
static fileName resolveTemplate(const fileName& templateName);
//- Verify if the copied code is up-to-date, based on Make/SHA1Digest
bool upToDate() const;
//- Copy/create files prior to compilation
bool copyOrCreateFiles(const bool verbose = false) const;
//- Compile a libso
bool wmakeLibso() const;
void* loadLibrary(const fileName& libPath) const;
void createLibrary
(
const dictionary& dict,
const bool masterOnlyRead = false
) const;
void read(const dictionary& contextDict, const dictionary& codeDict);
void read(const dictionary& contextDict);
//- Write the code for restart
void write(Ostream& os) const;
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|