data/src/OpenFOAM/db/dictionary/functionEntries/codeBlock/codeBlockEntry.C

/*---------------------------------------------------------------------------*\
  =========                 |
  \\      /  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;
}


// ************************************************************************* //