VuoCompilerNodeClass.hh

Go to the documentation of this file.

 
#pragma once
 
#include "VuoBaseDetail.hh"
#include "VuoCompilerModule.hh"
 
class VuoCompiler;
class VuoCompilerInputEventPortClass;
class VuoCompilerInputDataClass;
class VuoCompilerInstanceDataClass;
class VuoCompilerNodeArgumentClass;
class VuoCompilerOutputDataClass;
class VuoCompilerOutputEventPortClass;
class VuoCompilerTriggerDescription;
class VuoCompilerTriggerPortClass;
class VuoNode;
class VuoNodeClass;
class VuoPortClass;
class VuoType;
 
class VuoCompilerNodeClass : public VuoBaseDetail<VuoNodeClass>, public VuoCompilerModule  // Order matters: VuoCompilerModule after VuoBaseDetail - https://stackoverflow.com/a/2254306/238387
{
private:
    Function *eventFunction;
    Function *initFunction;
    Function *finiFunction;
    Function *callbackStartFunction;
    Function *callbackUpdateFunction;
    Function *callbackStopFunction;
    VuoCompilerInstanceDataClass *instanceDataClass;
    vector<VuoCompilerTriggerDescription *> triggerDescriptions;
    set<VuoCompilerInputEventPortClass *> portsWithExplicitEventBlockingNone;
    set< pair<string, string> > containedNodes;
 
    static bool isNodeClass(Module *module, string moduleKey);
    void parse(void);
    set<string> globalsToRename(void);
    void parseMetadata(void);
    void parseEventFunction(void);
    void parseInitFunction(void);
    void parseFiniFunction(void);
    void parseCallbackStartFunction(void);
    void parseCallbackUpdateFunction(void);
    void parseCallbackStopFunction(void);
    void parseParameters(Function *function, unsigned long acceptanceFlags);
    void instantiateCompilerNode(VuoNode *node);
 
    VuoCompilerInputDataClass * parseInputDataParameter(string annotation, Argument *a);
    VuoCompilerOutputDataClass * parseOutputDataParameter(string annotation, Argument *a);
    VuoCompilerInputEventPortClass * parseInputEventParameter(string annotation, Argument *a);
    VuoCompilerOutputEventPortClass * parseOutputEventParameter(string annotation, Argument *a);
    VuoCompilerTriggerPortClass * parseTriggerParameter(string annotation, Argument *a);
    VuoCompilerInstanceDataClass * parseInstanceDataParameter(string annotation, Argument *a);
    VuoType * parseTypeParameter(string annotation);
    struct json_object * parseDetailsParameter(string annotation);
    VuoPortClass * getExistingPortClass(VuoCompilerNodeArgumentClass *argumentClass, bool isInput);
 
    bool _isSubcomposition;
    void updateSubcompositionStatus();
 
    friend class TestVuoCompilerType;
    friend class TestVuoCompilerNodeClass;
 
protected:
    VuoCompilerNodeClass(string className, Module * module);
    VuoCompilerNodeClass(VuoCompilerNodeClass *compilerNodeClass);
    VuoCompilerNodeClass(VuoNodeClass *baseNodeClass);
    VuoPortClass * getInputPortClassWithName(string portName);
    VuoPortClass * getOutputPortClassWithName(string portName);
 
public:
    VuoNode * newNode(string title = "", double x = 0, double y = 0);
    VuoNode * newNode(VuoNode *nodeToCopyMetadataFrom);
    static VuoNodeClass * newNodeClass(string nodeClassName, Module * module);
    static VuoNodeClass * newNodeClassWithoutImplementation(VuoNodeClass *baseNodeClass);
    virtual ~VuoCompilerNodeClass(void);
 
    virtual string getFileName(void);
    static string getFileNameForModuleKey(const string &moduleKey);
    static bool isModuleKeyMangledInFileName(const string &fileName);
    virtual string getClassIdentifier(void);
    virtual Function * getEventFunction(void);
    virtual Function * getInitFunction(void);
    virtual Function * getFiniFunction(void);
    virtual Function * getCallbackStartFunction(void);
    virtual Function * getCallbackUpdateFunction(void);
    virtual Function * getCallbackStopFunction(void);
    virtual Function * getCompositionAddNodeMetadataFunction(void);
    virtual Function * getCompositionPerformDataOnlyTransmissionsFunction(void);
    virtual Function * getCompositionSetPublishedInputPortValueFunction(void);
    virtual Function * getTriggerWorkerFunction(string portIdentifier);
    virtual vector<VuoCompilerTriggerDescription *> getTriggerDescriptions(void);
    virtual VuoCompilerInstanceDataClass * getInstanceDataClass(void);
    virtual string getDoxygenDocumentation(void);
    virtual string getDefaultSpecializedTypeName(string genericTypeName);
    virtual vector<string> getAutomaticKeywords(void);
    bool isLikelyImageFilter(void);
    bool isLikelyImageGenerator(void);
    bool isLikelyImageTransition(void);
    int getImagePortCount(bool isInput);
    virtual bool isStateful(void);
    bool isSubcomposition(void);
    bool isIsf(void);
    set< pair<string, string> > getContainedNodes(void);
};