Environment.h

// Environment.h
//
 
namespace nkScripts
{
    class Environment final
    {
        public :
 
            Environment () noexcept ;
            ~Environment () ;
 
            // Getters
            const ExecutionResult& getLastExecutionResult () const ;
            nkMemory::StringView getName () const ;
 
            // Setters
            void setEnvironmentFor (INTERPRETER interpretType) ;
            void setName (nkMemory::StringView name) ;
 
            // Execution
            bool execute (const Script& script) ;
            void requestGarbageCollection () ;
 
            // Manipulating memory
            void setVar (nkMemory::StringView name, bool value) ;
            void setVar (nkMemory::StringView name, int value) ;
            void setVar (nkMemory::StringView name, float value) ;
            void setVar (nkMemory::StringView name, double value) ;
            void setVar (nkMemory::StringView name, const char* value) ;
            void setVar (nkMemory::StringView name, nkMemory::StringView value) ;
            void setVar (nkMemory::StringView name, const ScriptObjectReference& value) ;
            void setObject (nkMemory::StringView name, nkMemory::StringView userTypeName, void* value) ;
 
            bool isVarSet (nkMemory::StringView name) ;
 
            bool getVar (nkMemory::StringView name, bool defaultValue) ;
            int getVar (nkMemory::StringView name, int defaultValue) ;
            float getVar (nkMemory::StringView name, float defaultValue) ;
            double getVar (nkMemory::StringView name, double defaultValue) ;
            nkMemory::StringView getVar (nkMemory::StringView name, const char* defaultValue) ;
            nkMemory::StringView getVar (nkMemory::StringView name, nkMemory::StringView defaultValue) ;
            ScriptObjectReference getVar (nkMemory::StringView name) ;
            void* getObject (nkMemory::StringView name, nkMemory::StringView userTypeName = nullptr) ;
            ScriptObjectReference getScriptFunction (nkMemory::StringView name) ;
 
            Function* setFunc (nkMemory::StringView name) ;
            bool isFuncSet (nkMemory::StringView name) ;
            Function* getFunc (nkMemory::StringView name) ;
 
            UserType* setUserType (nkMemory::StringView name) ;
            bool isUserTypeSet (nkMemory::StringView name) ;
            UserType* getUserType (nkMemory::StringView name) ;
 
            Namespace* setNamespace (nkMemory::StringView name) ;
            bool isNamespaceSet (nkMemory::StringView name) ;
            Namespace* getNamespace (nkMemory::StringView name) ;
 
            // Call C++ -> Script
            bool callScriptFunction (const ScriptObjectReference& reference, const DataStack& args, DataStack& expectedOutput) ;
 
            nkMemory::Buffer serializeScriptObject (const ScriptObjectReference& reference, bool forwardUserDataOwnership = false) ;
            ScriptObjectReference deserializeScriptObject (nkMemory::BufferView<unsigned char> object) ;
    } ;
}