X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FScripting%2FNasalSys.hxx;h=4d59b8b2c8aa2908813dcbf14c610719affdd7dc;hb=9c28ed02577e6d32e1365567107adbd048f3d743;hp=c1dfa92ad3483c8c3686c603916d228a4dd37a2b;hpb=79e48829da50e0103e81684896b8287bfe23cc96;p=flightgear.git diff --git a/src/Scripting/NasalSys.hxx b/src/Scripting/NasalSys.hxx index c1dfa92ad..4d59b8b2c 100644 --- a/src/Scripting/NasalSys.hxx +++ b/src/Scripting/NasalSys.hxx @@ -5,6 +5,8 @@ #include #include +class FGNasalScript; + class FGNasalSys : public SGSubsystem { public: @@ -13,7 +15,9 @@ public: virtual void init(); virtual void update(double dt) { /* noop */ } - virtual bool handleCommand(const SGPropertyNode* arg); + // Loads a nasal script from an external file and inserts it as a + // global module of the specified name. + void loadModule(SGPath file, const char* moduleName); // Simple hook to run arbitrary source code. Returns a bool to // indicate successful execution. Does *not* return any Nasal @@ -21,13 +25,29 @@ public: // is deep voodoo and violates the "simple hook" idea. bool parseAndRun(const char* sourceCode); + // Slightly more complicated hook to get a handle to a precompiled + // Nasal script that can be invoked via a call() method. The + // caller is expected to delete the FGNasalScript returned from + // this function. The "name" argument specifies the "file name" + // for the source code that will be printed in Nasal stack traces + // on error. + FGNasalScript* parseScript(const char* src, const char* name=0); + // Implementation of the settimer extension function - void setTimer(naRef args); + void setTimer(int argc, naRef* args); // Returns a ghost wrapper for the current _cmdArg naRef cmdArgGhost(); + // Callbacks for command and timer bindings + virtual bool handleCommand(const SGPropertyNode* arg); + + void createModule(const char* moduleName, const char* fileName, + const char* src, int len); + private: + friend class FGNasalScript; + // // FGTimer subclass for handling Nasal timer callbacks. // See the implementation of the settimer() extension function for @@ -36,30 +56,51 @@ private: struct NasalTimer { virtual void timerExpired(); naRef handler; - int hashKey; + int gcKey; FGNasalSys* nasal; }; void loadPropertyScripts(); - void initModule(const char* moduleName, const char* fileName, - const char* src, int len); - void readScriptFile(SGPath file, const char* lib); void hashset(naRef hash, const char* key, naRef val); void logError(); naRef parse(const char* filename, const char* buf, int len); naRef genPropsModule(); naRef propNodeGhost(SGPropertyNode* handle); + // This mechanism is here to allow naRefs to be passed to + // locations "outside" the interpreter. Normally, such a + // reference would be garbage collected unexpectedly. By passing + // it to gcSave and getting a key/handle, it can be cached in a + // globals.__gcsave hash. Be sure to release it with gcRelease + // when done. + int gcSave(naRef r); + void gcRelease(int key); + naContext _context; naRef _globals; - naRef _timerHash; SGPropertyNode* _cmdArg; - int _nextTimerHashKey; + int _nextGCKey; + naRef _gcHash; + + public: void handleTimer(NasalTimer* t); +}; +class FGNasalScript { public: - void handleTimer(NasalTimer* t); + ~FGNasalScript() { _nas->gcRelease(_gcKey); } + + bool call() { + naCall(_nas->_context, _code, 0, 0, naNil(), naNil()); + return naGetError(_nas->_context) == 0; + } + +private: + friend class FGNasalSys; + naRef _code; + int _gcKey; + FGNasalSys* _nas; }; #endif // __NASALSYS_HXX