X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FScripting%2FNasalSys.hxx;h=973730e4770f99eb19b77eb9ff0012e195ce6dab;hb=5146868bfb63895edb6c89b24a9ba216420485c2;hp=36473ed36673b58fdaf99e900a8375614b4c7868;hpb=2be85c1b1b8db11cd0161ef06a88b25d95b0f5e6;p=flightgear.git diff --git a/src/Scripting/NasalSys.hxx b/src/Scripting/NasalSys.hxx index 36473ed36..973730e47 100644 --- a/src/Scripting/NasalSys.hxx +++ b/src/Scripting/NasalSys.hxx @@ -3,7 +3,29 @@ #include #include +#include +#include #include +#include +#include + +// Required only for MSVC +#ifdef _MSC_VER +# include +#endif + +#include + + +class FGNasalScript; +class FGNasalListener; +class SGCondition; +class FGNasalModelData; + +namespace simgear { class BufferedLogCallback; } + +SGPropertyNode* ghostToPropNode(naRef ref); +SGCondition* conditionGhost(naRef r); class FGNasalSys : public SGSubsystem { @@ -11,14 +33,112 @@ public: FGNasalSys(); virtual ~FGNasalSys(); virtual void init(); - virtual void update(double dt) { /* noop */ } + virtual void update(double dt); - 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. + bool 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 + // values, because handling garbage-collected objects from C space + // 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(naContext c, int argc, naRef* args); + + // Implementation of the setlistener extension function + naRef setListener(naContext c, int argc, naRef* args); + naRef removeListener(naContext c, int argc, naRef* args); + + // Returns a ghost wrapper for the current _cmdArg + naRef cmdArgGhost(); + + void setCmdArg(SGPropertyNode* aNode); + + /** + * create Nasal props.Node for an SGPropertyNode* + * This is the actual ghost, wrapped in a Nasal sugar class. + */ + naRef wrappedPropsNode(SGPropertyNode* aProps); + + // Callbacks for command and timer bindings + virtual bool handleCommand( const char* moduleName, + const char* fileName, + const char* src, + const SGPropertyNode* arg = 0 ); + virtual bool handleCommand(const SGPropertyNode* arg); + + bool createModule(const char* moduleName, const char* fileName, + const char* src, int len, const SGPropertyNode* cmdarg=0, + int argc=0, naRef*args=0); + void deleteModule(const char* moduleName); + + /** + * Set member of specified hash to given value + */ + void hashset(naRef hash, const char* key, naRef val); + + /** + * Set member of globals hash to given value + */ + void globalsSet(const char* key, naRef val); + + naRef call(naRef code, int argc, naRef* args, naRef locals); + + naRef callMethod(naRef code, naRef self, int argc, naRef* args, naRef locals); + + naRef propNodeGhost(SGPropertyNode* handle); + + void registerToLoad(FGNasalModelData* data); + void registerToUnload(FGNasalModelData* data); + + // can't call this 'globals' due to naming clash + naRef nasalGlobals() const + { return _globals; } + + naContext context() const + { return _context; } + + nasal::Hash getGlobals() const + { return nasal::Hash(_globals, _context); } + + // 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); + + /// retrive the associated log object, for displaying log + /// output somewhere (a UI, presumably) + simgear::BufferedLogCallback* log() const + { return _log; } private: + //friend class FGNasalScript; + friend class FGNasalListener; + friend class FGNasalModuleListener; + + SGLockedQueue > _loadList; + SGLockedQueue > _unloadList; + + // Delay removing items of the _loadList to ensure the are already attached + // to the scene graph (eg. enables to retrieve world position in load + // callback). + bool _delay_load; + // // FGTimer subclass for handling Nasal timer callbacks. // See the implementation of the settimer() extension function for @@ -26,24 +146,59 @@ private: // struct NasalTimer { virtual void timerExpired(); + virtual ~NasalTimer() {} naRef handler; - int hashKey; + int gcKey; FGNasalSys* nasal; }; - void readScriptFile(SGPath file, const char* lib); - void hashset(naRef hash, const char* key, naRef val); - void logError(); + // Listener + std::map _listener; + std::vector _dead_listener; + + static int _listenerId; + + void loadPropertyScripts(); + void loadPropertyScripts(SGPropertyNode* n); + void loadScriptDirectory(simgear::Dir nasalDir); + void addModule(std::string moduleName, simgear::PathList scripts); + void logError(naContext); naRef parse(const char* filename, const char* buf, int len); + naRef genPropsModule(); naContext _context; - naRef _globals; - naRef _timerHash; + naRef _globals, + _string; + + SGPropertyNode_ptr _cmdArg; - int _nextTimerHashKey; + int _nextGCKey; + naRef _gcHash; + int _callCount; + simgear::BufferedLogCallback* _log; public: - void handleTimer(NasalTimer* t); + void handleTimer(NasalTimer* t); +}; + +#if 0 +class FGNasalScript { +public: + ~FGNasalScript() { _nas->gcRelease(_gcKey); } + + bool call() { + naRef n = naNil(); + naCall(_nas->_context, _code, 0, &n, naNil(), naNil()); + return naGetError(_nas->_context) == 0; + } + + FGNasalSys* sys() const { return _nas; } +private: + friend class FGNasalSys; + naRef _code; + int _gcKey; + FGNasalSys* _nas; }; +#endif #endif // __NASALSYS_HXX