Skip to content

Commit ffaba9b

Browse files
author
Helge Mathee
committed
#3800: support for referenced splice files
1 parent b5994fb commit ffaba9b

File tree

4 files changed

+136
-83
lines changed

4 files changed

+136
-83
lines changed

‎DGGraphImpl.cpp

+102-74
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,7 @@ DGGraphImpl::DGGraphImpl(
170170
mIsClearing = true;
171171
mUsesEvalContext = false;
172172
mUserPointer = NULL;
173+
mIsReferenced = false;
173174

174175
try
175176
{
@@ -2449,100 +2450,108 @@ FabricCore::Variant DGGraphImpl::getPersistenceDataDict(const PersistenceInfo *
24492450
persistenceContextRT.setMember("filePath", FabricSplice::constructStringRTVal(info->filePath.getStringData()));
24502451
}
24512452

2452-
FabricCore::Variant dgNodeListVar = FabricCore::Variant::CreateArray();
2453-
FabricCore::Variant portData = FabricCore::Variant::CreateDict();
2454-
for(DGNodeIt it = mDGNodes.begin(); it != mDGNodes.end(); it++)
2453+
// only persist the splice base path, if applicable
2454+
if(mIsReferenced)
24552455
{
2456-
FabricCore::Variant dgNodeVar = FabricCore::Variant::CreateDict();
2456+
dataVar.setDictValue("spliceFilePath", FabricCore::Variant::CreateString(mFilePath.c_str()));
2457+
}
2458+
else
2459+
{
2460+
FabricCore::Variant dgNodeListVar = FabricCore::Variant::CreateArray();
2461+
FabricCore::Variant portData = FabricCore::Variant::CreateDict();
2462+
for(DGNodeIt it = mDGNodes.begin(); it != mDGNodes.end(); it++)
2463+
{
2464+
FabricCore::Variant dgNodeVar = FabricCore::Variant::CreateDict();
24572465

2458-
// only save non-default names
2459-
if(it->first != "DGNode")
2460-
dgNodeVar.setDictValue("name", FabricCore::Variant::CreateString(it->first.c_str()));
2466+
// only save non-default names
2467+
if(it->first != "DGNode")
2468+
dgNodeVar.setDictValue("name", FabricCore::Variant::CreateString(it->first.c_str()));
24612469

2462-
FabricCore::DGNode node = it->second.node;
2470+
FabricCore::DGNode node = it->second.node;
24632471

2464-
FabricCore::Variant dependenciesVar = node.getDependencies_Variant();
2465-
if(dependenciesVar.isArray())
2466-
{
2467-
if(dependenciesVar.getArraySize() > 0)
2468-
dgNodeVar.setDictValue("dependencies", dependenciesVar);
2469-
}
2472+
FabricCore::Variant dependenciesVar = node.getDependencies_Variant();
2473+
if(dependenciesVar.isArray())
2474+
{
2475+
if(dependenciesVar.getArraySize() > 0)
2476+
dgNodeVar.setDictValue("dependencies", dependenciesVar);
2477+
}
24702478

2471-
FabricCore::Variant bindingListVar = FabricCore::Variant::CreateArray();
2479+
FabricCore::Variant bindingListVar = FabricCore::Variant::CreateArray();
24722480

2473-
FabricCore::DGBindingList bindings = node.getBindingList();
2474-
for(uint32_t i=0;i<bindings.getCount();i++)
2475-
{
2476-
FabricCore::DGBinding binding = bindings.getBinding(i);
2477-
FabricCore::DGOperator op = binding.getOperator();
2481+
FabricCore::DGBindingList bindings = node.getBindingList();
2482+
for(uint32_t i=0;i<bindings.getCount();i++)
2483+
{
2484+
FabricCore::DGBinding binding = bindings.getBinding(i);
2485+
FabricCore::DGOperator op = binding.getOperator();
24782486

2479-
FabricCore::Variant bindingVar = FabricCore::Variant::CreateDict();
2480-
FabricCore::Variant opVar = FabricCore::Variant::CreateDict();
2487+
FabricCore::Variant bindingVar = FabricCore::Variant::CreateDict();
2488+
FabricCore::Variant opVar = FabricCore::Variant::CreateDict();
24812489

2482-
std::string opName = getPrettyDGOperatorName(op.getName());
2490+
std::string opName = getPrettyDGOperatorName(op.getName());
24832491

2484-
opVar.setDictValue("name", FabricCore::Variant::CreateString(opName.c_str()));
2492+
opVar.setDictValue("name", FabricCore::Variant::CreateString(opName.c_str()));
24852493

2486-
// only save entry points which differ from the op name
2487-
if(opName != op.getEntryPoint())
2488-
opVar.setDictValue("entry", FabricCore::Variant::CreateString(op.getEntryPoint()));
2494+
// only save entry points which differ from the op name
2495+
if(opName != op.getEntryPoint())
2496+
opVar.setDictValue("entry", FabricCore::Variant::CreateString(op.getEntryPoint()));
24892497

2490-
// either store the filename with the code, or just the filename.
2491-
// this should be based on a user decision, if the kl file is based
2492-
// on an external file, or not.
2493-
stringIt fileNameIt = mKLOperatorFileNames.find(op.getName());
2494-
if(fileNameIt == mKLOperatorFileNames.end())
2495-
{
2496-
// only save non-default names
2497-
std::string fileNameStr = op.getFilename();
2498-
if(fileNameStr != opName+".kl")
2499-
opVar.setDictValue("filename", FabricCore::Variant::CreateString(op.getFilename()));
2500-
2501-
// check if we have operator source code in the DCC UI somewhere
2502-
std::string klCode;
2503-
if(sGetOperatorSourceCodeFunc)
2498+
// either store the filename with the code, or just the filename.
2499+
// this should be based on a user decision, if the kl file is based
2500+
// on an external file, or not.
2501+
stringIt fileNameIt = mKLOperatorFileNames.find(op.getName());
2502+
if(fileNameIt == mKLOperatorFileNames.end())
25042503
{
2505-
const char * klCodeCStr = (*sGetOperatorSourceCodeFunc)(getName().c_str(), opName.c_str());
2506-
if(klCodeCStr)
2507-
klCode = klCodeCStr;
2504+
// only save non-default names
2505+
std::string fileNameStr = op.getFilename();
2506+
if(fileNameStr != opName+".kl")
2507+
opVar.setDictValue("filename", FabricCore::Variant::CreateString(op.getFilename()));
2508+
2509+
// check if we have operator source code in the DCC UI somewhere
2510+
std::string klCode;
2511+
if(sGetOperatorSourceCodeFunc)
2512+
{
2513+
const char * klCodeCStr = (*sGetOperatorSourceCodeFunc)(getName().c_str(), opName.c_str());
2514+
if(klCodeCStr)
2515+
klCode = klCodeCStr;
2516+
}
2517+
if(klCode.length() == 0)
2518+
{
2519+
klCode = getKLOperatorSourceCode(opName);
2520+
}
2521+
opVar.setDictValue("kl", FabricCore::Variant::CreateString(klCode.c_str()));
25082522
}
2509-
if(klCode.length() == 0)
2523+
else
25102524
{
2511-
klCode = getKLOperatorSourceCode(opName);
2525+
opVar.setDictValue("filename", FabricCore::Variant::CreateString(fileNameIt->second.c_str()));
25122526
}
2513-
opVar.setDictValue("kl", FabricCore::Variant::CreateString(klCode.c_str()));
2514-
}
2515-
else
2516-
{
2517-
opVar.setDictValue("filename", FabricCore::Variant::CreateString(fileNameIt->second.c_str()));
2518-
}
25192527

2520-
if(i < it->second.opPortMaps.size())
2521-
{
2522-
bool hasContent = !FabricCore::Variant::DictIter(it->second.opPortMaps[i]).isDone();
2523-
if(hasContent)
2524-
opVar.setDictValue("portmap", it->second.opPortMaps[i]);
2528+
if(i < it->second.opPortMaps.size())
2529+
{
2530+
bool hasContent = !FabricCore::Variant::DictIter(it->second.opPortMaps[i]).isDone();
2531+
if(hasContent)
2532+
opVar.setDictValue("portmap", it->second.opPortMaps[i]);
2533+
}
2534+
2535+
// todo: we might want to store the parameter layout at a some point
2536+
bindingVar.setDictValue("operator", opVar);
2537+
bindingListVar.arrayAppend(bindingVar);
25252538
}
2539+
dgNodeVar.setDictValue("bindings", bindingListVar);
25262540

2527-
// todo: we might want to store the parameter layout at a some point
2528-
bindingVar.setDictValue("operator", opVar);
2529-
bindingListVar.arrayAppend(bindingVar);
2541+
dgNodeListVar.arrayAppend(dgNodeVar);
25302542
}
2531-
dgNodeVar.setDictValue("bindings", bindingListVar);
2532-
2533-
dgNodeListVar.arrayAppend(dgNodeVar);
2534-
}
2535-
dataVar.setDictValue("nodes", dgNodeListVar);
2543+
dataVar.setDictValue("nodes", dgNodeListVar);
25362544

2537-
FabricCore::Variant extensionListVar = FabricCore::Variant::CreateArray();
2538-
for(stringIt it = mLoadedExtensions.begin(); it != mLoadedExtensions.end(); it++)
2539-
extensionListVar.arrayAppend(FabricCore::Variant::CreateString(it->first.c_str()));
2540-
if(mLoadedExtensions.size() > 0)
2541-
dataVar.setDictValue("extensions", extensionListVar);
2545+
FabricCore::Variant extensionListVar = FabricCore::Variant::CreateArray();
2546+
for(stringIt it = mLoadedExtensions.begin(); it != mLoadedExtensions.end(); it++)
2547+
extensionListVar.arrayAppend(FabricCore::Variant::CreateString(it->first.c_str()));
2548+
if(mLoadedExtensions.size() > 0)
2549+
dataVar.setDictValue("extensions", extensionListVar);
25422550

2543-
FabricCore::Variant portInfo;
2544-
getDGPortInfo(portInfo, persistenceContextRT);
2545-
dataVar.setDictValue("ports", portInfo);
2551+
FabricCore::Variant portInfo;
2552+
getDGPortInfo(portInfo, persistenceContextRT);
2553+
dataVar.setDictValue("ports", portInfo);
2554+
}
25462555

25472556
mIsPersisting = false;
25482557

@@ -2578,6 +2587,14 @@ bool DGGraphImpl::setFromPersistenceDataDict(
25782587
if(mMetaData.length() > 0)
25792588
dataVar.setDictValue("metaData", FabricCore::Variant::CreateString(mMetaData.c_str()));
25802589

2590+
// check if this is a referenced splice file
2591+
const FabricCore::Variant * spliceFilePathVar = dataVar.getDictValue("spliceFilePath");
2592+
if(spliceFilePathVar)
2593+
{
2594+
std::string spliceFilePath = spliceFilePathVar->getStringData();
2595+
return loadFromFile(thisGraph, spliceFilePath, info, true, errorOut);
2596+
}
2597+
25812598
const FabricCore::Variant * nodesVar = dataVar.getDictValue("nodes");
25822599
if(!nodesVar)
25832600
return LoggingImpl::reportError("JSON data is corrupt, no 'nodes' element.", errorOut);
@@ -2980,13 +2997,16 @@ bool DGGraphImpl::loadFromFile(
29802997
DGGraphImplPtr thisGraph,
29812998
const std::string & filePath,
29822999
PersistenceInfo * info,
3000+
bool asReferenced,
29833001
std::string * errorOut
29843002
) {
29853003
if(!thisGraph)
29863004
return LoggingImpl::reportError("Parameter thisGraph is not valid.", errorOut);
29873005
if(thisGraph.get() != this)
29883006
return LoggingImpl::reportError("Parameter thisGraph does not refer to this graph.", errorOut);
2989-
FILE * file = fopen(filePath.c_str(), "rb");
3007+
3008+
std::string resolvedFilePath = resolveEnvironmentVariables(filePath);
3009+
FILE * file = fopen(resolvedFilePath.c_str(), "rb");
29903010
if(!file)
29913011
return LoggingImpl::reportError("Invalid filePath '"+filePath+"'", errorOut);
29923012

@@ -3005,13 +3025,21 @@ bool DGGraphImpl::loadFromFile(
30053025
std::string json = buffer;
30063026
free(buffer);
30073027

3028+
mIsReferenced = asReferenced;
3029+
mFilePath = filePath;
3030+
30083031
if(!setFromPersistenceDataJSON(thisGraph, json, info, filePath.c_str(), errorOut))
30093032
return false;
30103033
LoggingImpl::log("Loaded graph '"+getName()+"' from "+filePath);
30113034

30123035
return true;
30133036
}
30143037

3038+
bool DGGraphImpl::isReferenced()
3039+
{
3040+
return mIsReferenced;
3041+
}
3042+
30153043
bool DGGraphImpl::requireEvaluate()
30163044
{
30173045
if(mRequiresEval)

‎DGGraphImpl.h

+8-3
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,10 @@ namespace FabricSpliceImpl
281281

282282
/// constructs the node based on a persisted JSON file
283283
/// you need to pass in thisGraph as a shared pointer to avoid cycles in reference counting.
284-
bool loadFromFile(DGGraphImplPtr thisGraph, const std::string & filePath, PersistenceInfo * info = NULL, std::string * errorOut = NULL);
284+
bool loadFromFile(DGGraphImplPtr thisGraph, const std::string & filePath, PersistenceInfo * info = NULL, bool asReferenced = false, std::string * errorOut = NULL);
285+
286+
/// returns true if this graph is referenced from a file
287+
bool isReferenced();
285288

286289
/// request an evaluation on idle
287290
bool requireEvaluate();
@@ -395,6 +398,8 @@ namespace FabricSpliceImpl
395398
std::string mMetaData;
396399
FabricCore::RTVal mEvalContext;
397400
stringMap mKLOperatorFileNames;
401+
bool mIsReferenced;
402+
std::string mFilePath;
398403

399404
// static members
400405
static DGOperatorSuffixMap sDGOperatorSuffix;
@@ -412,8 +417,8 @@ namespace FabricSpliceImpl
412417

413418
// utilities
414419
bool memberPersistence(const std::string &name, const std::string &type, bool * requiresStorage = NULL);
415-
std::string resolveRelativePath(const std::string & baseFile, const std::string text);
416-
std::string resolveEnvironmentVariables(const std::string text);
420+
static std::string resolveRelativePath(const std::string & baseFile, const std::string text);
421+
static std::string resolveEnvironmentVariables(const std::string text);
417422
};
418423
};
419424

‎FabricSplice.cpp

+10-2
Original file line numberDiff line numberDiff line change
@@ -1933,11 +1933,19 @@ bool FECS_DGGraph_saveToFile(FECS_DGGraphRef ref, const char * filePath, const F
19331933
FECS_CATCH(false);
19341934
}
19351935

1936-
bool FECS_DGGraph_loadFromFile(FECS_DGGraphRef ref, const char * filePath, FECS_PersistenceInfo * info)
1936+
bool FECS_DGGraph_loadFromFile(FECS_DGGraphRef ref, const char * filePath, FECS_PersistenceInfo * info, bool asReferenced)
19371937
{
19381938
FECS_TRY_CLEARERROR
19391939
GETSMARTPTR(DGGraphImplPtr, graph, false)
1940-
return graph->loadFromFile(graph, filePath, (DGGraphImpl::PersistenceInfo *)info);
1940+
return graph->loadFromFile(graph, filePath, (DGGraphImpl::PersistenceInfo *)info, asReferenced);
1941+
FECS_CATCH(false);
1942+
}
1943+
1944+
FECS_DECL bool FECS_DGGraph_isReferenced(FECS_DGGraphRef ref)
1945+
{
1946+
FECS_TRY_CLEARERROR
1947+
GETSMARTPTR(DGGraphImplPtr, graph, false)
1948+
return graph->isReferenced();
19411949
FECS_CATCH(false);
19421950
}
19431951

‎FabricSplice.h

+16-4
Original file line numberDiff line numberDiff line change
@@ -1611,7 +1611,10 @@ Class Outline
16111611
bool saveToFile(const char * filePath, const PersistenceInfo * info = NULL);
16121612
16131613
// constructs the node based on a persisted JSON file
1614-
bool loadFromFile(const char * filePath, PersistenceInfo * info = NULL);
1614+
bool loadFromFile(const char * filePath, PersistenceInfo * info = NULL, bool asReferenced = false);
1615+
1616+
// returns true if this graph is referenced from a file
1617+
bool isReferenced();
16151618
16161619
// marks a member to be persisted
16171620
void setMemberPersistence(const char * name, bool persistence);
@@ -1951,7 +1954,8 @@ FECS_DECL char * FECS_DGGraph_getPersistenceDataJSON(FECS_DGGraphRef ref, const
19511954
FECS_DECL bool FECS_DGGraph_setFromPersistenceDataDict(FECS_DGGraphRef ref, const FabricCore::Variant & dict, FECS_PersistenceInfo * info, const char * baseFilePath);
19521955
FECS_DECL bool FECS_DGGraph_setFromPersistenceDataJSON(FECS_DGGraphRef ref, const char * json, FECS_PersistenceInfo * info, const char * baseFilePath);
19531956
FECS_DECL bool FECS_DGGraph_saveToFile(FECS_DGGraphRef ref, const char * filePath, const FECS_PersistenceInfo * info);
1954-
FECS_DECL bool FECS_DGGraph_loadFromFile(FECS_DGGraphRef ref, const char * filePath, FECS_PersistenceInfo * info);
1957+
FECS_DECL bool FECS_DGGraph_loadFromFile(FECS_DGGraphRef ref, const char * filePath, FECS_PersistenceInfo * info, bool asReferenced);
1958+
FECS_DECL bool FECS_DGGraph_isReferenced(FECS_DGGraphRef ref);
19551959
FECS_DECL void FECS_DGGraph_setMemberPersistence(FECS_DGGraphRef ref, const char * name, bool persistence);
19561960

19571961
FECS_DECL FECS_DGPortRef FECS_DGPort_copy(FECS_DGPortRef ref);
@@ -4584,9 +4588,17 @@ namespace FabricSplice
45844588
}
45854589

45864590
// constructs the node based on a persisted JSON file
4587-
bool loadFromFile(const char * filePath, PersistenceInfo * info = NULL)
4591+
bool loadFromFile(const char * filePath, PersistenceInfo * info = NULL, bool asReferenced = false)
4592+
{
4593+
bool result = FECS_DGGraph_loadFromFile(mRef, filePath, info, asReferenced);
4594+
Exception::MaybeThrow();
4595+
return result;
4596+
}
4597+
4598+
// returns true if this graph is referenced from a file
4599+
bool isReferenced()
45884600
{
4589-
bool result = FECS_DGGraph_loadFromFile(mRef, filePath, info);
4601+
bool result = FECS_DGGraph_isReferenced(mRef);
45904602
Exception::MaybeThrow();
45914603
return result;
45924604
}

0 commit comments

Comments
 (0)