VuoCompilerEnvironment.hh

Go to the documentation of this file.

 
#pragma once
 
#include "VuoFileUtilities.hh"
#include "VuoFileWatcher.hh"
#include "VuoModuleCacheManifest.hh"
class VuoCompiler;
class VuoCompilerGenericType;
class VuoCompilerIssues;
class VuoCompilerModule;
class VuoCompilerNodeClass;
class VuoCompilerType;
class VuoDirectedAcyclicGraph;
class VuoMakeDependencies;
class VuoModuleCache;
class VuoModuleCompilationQueue;
class VuoModuleInfo;
class VuoModuleInfoIterator;
class VuoNodeSet;
 
class VuoCompilerEnvironment : public VuoFileWatcherDelegate
{
private:
    string target;  
    bool builtIn;  
    bool generated;  
    set<VuoCompiler *> compilersToNotify;  
    dispatch_queue_t compilersToNotifyQueue;  
    set<VuoFileWatcher *> moduleSearchPathWatchers;  
    map<string, VuoCompilerNodeClass *> nodeClasses;  
    map<string, VuoCompilerType *> types;  
    map<string, VuoNodeSet *> nodeSetForName;  
    map<string, VuoCompilerModule *> libraryModules;  
    VuoCompilerModule * inMemoryModuleAwaitingLoad;  
    map<string, dispatch_group_t> specializedModulesLoading;  
    map<string, map<string, VuoModuleInfo *> > moduleFilesAtSearchPath;  
    map<string, map<string, VuoModuleInfo *> > sourceFilesAtSearchPath;  
    vector<string> moduleSearchPaths;  
    vector<string> headerSearchPaths;  
    vector<string> librarySearchPaths;  
    vector<string> frameworkSearchPaths;  
    vector<string> expatriateSourceFiles;  
    shared_ptr<VuoModuleCache> moduleCache;  
    string compiledModuleCachePath;  
    string overriddenCompiledModuleCachePath;  
    bool isModuleCacheableDataDirty;  
    VuoModuleCacheManifest cacheableModulesAndDependencies;  
    set<string> dylibsNeededToLinkToThisCache;  
    set<string> frameworksNeededToLinkToThisCache;  
    VuoDirectedAcyclicGraph *dependencyGraph;  
    VuoDirectedAcyclicGraph *compositionDependencyGraph;  
    VuoModuleCompilationQueue *moduleCompilationQueue;  
 
    void updateModulesAtSearchPath(const string &path);
    void updateModuleAtSearchPath(const string &moduleSearchPath, const string &moduleRelativePath);
    void updateSourceFilesAtSearchPath(const string &path);
    void unmangleModuleKeysAtSearchPath(const string &path, const set<string> &knownModuleKeys);
    void startWatchingModuleSearchPath(const string &moduleSearchPath);
    bool writeToCompiledModuleCache(Module *module, const string &compiledModulePath, shared_ptr<VuoMakeDependencies> makeDependencies, dispatch_queue_t llvmQueue, VuoCompilerIssues *issues);
    void deleteFromCompiledModuleCache(const string &compiledModulePath);
    VuoCompilerModule * readModuleFromFile(VuoModuleInfo *moduleInfo, dispatch_queue_t llvmQueue);
    void loadInMemoryModule(const string &moduleKey, const string &moduleSourceCode, Module *module, std::function<void(void)> moduleLoadedCallback, VuoCompiler *compiler, dispatch_queue_t llvmQueue);
    void loadInMemoryModule(VuoCompilerModule *module, const string &moduleSourceCode, std::function<void(void)> moduleLoadedCallback, VuoCompiler *compiler, dispatch_queue_t llvmQueue);
 
    friend class TestCompilingAndLinking;
 
public:
    dispatch_queue_t moduleSearchPathContentsChangedQueue;  
 
    explicit VuoCompilerEnvironment(string target, bool builtIn, bool generated);
    virtual ~VuoCompilerEnvironment(void);
    string getTarget();
    void addCompilerToNotify(VuoCompiler *compiler);
    void removeCompilerToNotify(VuoCompiler *compiler);
    map<string, VuoCompilerNodeClass *> getNodeClasses(void);
    VuoCompilerNodeClass * getNodeClass(const string &moduleKey);
    map<string, VuoCompilerType *> getTypes(void);
    VuoCompilerType * getType(const string &moduleKey);
    map<string, VuoNodeSet *> getNodeSets();
    VuoCompilerModule *getLibraryModule(const string &libraryModuleName);
    map<string, VuoCompilerModule *> getLibraryModules(void);
    VuoCompilerModule * findModule(const string &moduleKey);
    VuoNodeSet * findNodeSet(const string &name);
    void addModuleSearchPath(const string &path, bool shouldWatch = true);
    vector<string> getModuleSearchPaths(void);
    void addHeaderSearchPath(const string &path);
    vector<string> getHeaderSearchPaths(void);
    void addLibrarySearchPath(const string &path);
    vector<string> getLibrarySearchPaths(void);
    void addFrameworkSearchPath(const string &path);
    void setModuleCache(shared_ptr<VuoModuleCache> moduleCache);
    shared_ptr<VuoModuleCache> getModuleCache(void);
    string getCompiledModuleCachePath(void);
    string getOverriddenCompiledModuleCachePath(void);
    vector<string> getFrameworkSearchPaths(void);
    VuoDirectedAcyclicGraph * getDependencyGraph(void);
    VuoDirectedAcyclicGraph * getCompositionDependencyGraph(void);
    void addExpatriateSourceFile(const string &sourcePath);
    void removeExpatriateSourceFile(const string &sourcePath);
    VuoModuleInfo * listModule(const string &moduleKey);
    VuoModuleInfoIterator listModules(const set<string> &moduleKeys);
    VuoModuleInfoIterator listAllModules(void);
    VuoModuleInfo * listSourceFile(const string &moduleKey);
    VuoModuleInfoIterator listSourceFiles(const set<string> &moduleKeys);
    VuoModuleInfoIterator listAllSourceFiles(void);
    static vector<string> getBuiltInModuleSearchPaths(void);
    static vector<string> getBuiltInLibrarySearchPaths(void);
    static vector<string> getBuiltInFrameworkSearchPaths(void);
    void stopWatchingModuleSearchPaths(void);
    void fileChanged(const string &moduleSearchPath);
    void moduleSearchPathContentsChanged(const string &moduleSearchPath);
    void moduleFileChanged(const string &moduleKey, const string &modulePath, const string &moduleSourceCode, std::function<void(void)> moduleLoadedCallback, VuoCompiler *compiler, VuoCompilerIssues *issues = nullptr);
    void deleteOverriddenModuleFile(const string &moduleKey);
    void notifyCompilers(const set<VuoCompilerModule *> &modulesAdded, const set<pair<VuoCompilerModule *, VuoCompilerModule *> > &modulesModified, const set<VuoCompilerModule *> &modulesRemoved, VuoCompilerIssues *issues, bool oldModulesInvalidated = true);
    set<VuoCompilerModule *> loadCompiledModules(const set<string> &moduleKeys, const map<string, string> &sourceCodeForModule, dispatch_queue_t llvmQueue);
    set<dispatch_group_t> generateSpecializedModules(const set<string> &moduleKeys, VuoCompiler *compiler, dispatch_group_t moduleSourceCompilersExist, dispatch_queue_t llvmQueue);
    set<dispatch_group_t> compileModulesFromSourceCode(const set<string> &moduleKeys, bool shouldRecompileIfUnchanged, dispatch_group_t moduleSourceCompilersExist, dispatch_queue_t llvmQueue);
    set<VuoCompilerModule *> unloadCompiledModules(const set<string> &moduleKeys);
    void deleteFromCompiledModuleCache(const set<string> &moduleKeys);
    void addToDependencyGraph(VuoCompilerModule *module);
    void removeFromDependencyGraph(VuoCompilerModule *module);
    VuoModuleCacheManifest getCacheableModulesAndDependencies(set<string> &dylibsNeededToLinkToThisCache, set<string> &frameworksNeededToLinkToThisCache);
    void modulesChanged(void);
 
    bool isBuiltInOriginal(void);
    bool isBuiltIn(void);
    bool isGenerated(void);
    string getName();
 
#ifdef VUO_PRO
#include "../compiler/pro/VuoCompilerEnvironment_Pro.hh"
#endif
};