X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FScripting%2FNasalSys.hxx;h=096a591bed35ce854f2212848456db161f15d4c9;hb=9c63b7713307eb4db9f6df7959fe83977f561c42;hp=9b50e89f0e2f4915a0d0ba7554168701edcd84d1;hpb=1a292c9ed28735ab785078905e6a9445d7b198fb;p=flightgear.git diff --git a/src/Scripting/NasalSys.hxx b/src/Scripting/NasalSys.hxx index 9b50e89f0..096a591be 100644 --- a/src/Scripting/NasalSys.hxx +++ b/src/Scripting/NasalSys.hxx @@ -1,18 +1,34 @@ #ifndef __NASALSYS_HXX #define __NASALSYS_HXX +#include // keep before any cppbind include to enable + // SGVec2 conversion. +#include #include -#include +#include #include -#include -#include +#include +#include +#include + +// Required only for MSVC +#ifdef _MSC_VER +# include +#endif #include -using std::map; class FGNasalScript; class FGNasalListener; +class SGCondition; +class FGNasalModelData; +class NasalCommand; +class FGNasalModuleListener; + +namespace simgear { class BufferedLogCallback; } + +SGPropertyNode* ghostToPropNode(naRef ref); class FGNasalSys : public SGSubsystem { @@ -20,11 +36,13 @@ public: FGNasalSys(); virtual ~FGNasalSys(); virtual void init(); + virtual void shutdown(); + virtual void update(double dt); // 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); + 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 @@ -38,7 +56,7 @@ public: // 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); + // FGNasalScript* parseScript(const char* src, const char* name=0); // Implementation of the settimer extension function void setTimer(naContext c, int argc, naRef* args); @@ -50,21 +68,97 @@ public: // 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); - void createModule(const char* moduleName, const char* fileName, + 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); + void addCommand(naRef func, const std::string& name); + void removeCommand(const std::string& name); + + /** + * 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 callWithContext(naContext ctx, naRef code, int argc, naRef* args, naRef locals); + + naRef callMethod(naRef code, naRef self, int argc, naRef* args, naRef locals); + naRef callMethodWithContext(naContext ctx, 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; } + + 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); + /** + * Check if IOrules correctly work to limit access from Nasal scripts to the + * file system. + * + * @note Just a simple test is performed to check if access to a path is + * possible which should never be possible (The actual path refers to + * a file/folder named 'do-not-access' in the file system root). + * + * @see http://wiki.flightgear.org/IOrules + * + * @return Whether the check was successful. + */ + bool checkIOrules(); + + /// 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 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. @@ -80,38 +174,39 @@ private: }; // Listener - map _listener; - vector _dead_listener; + std::map _listener; + std::vector _dead_listener; + + std::vector _moduleListeners; + static int _listenerId; void loadPropertyScripts(); - void hashset(naRef hash, const char* key, naRef val); - void logError(naContext); - naRef parse(const char* filename, const char* buf, int len); + void loadPropertyScripts(SGPropertyNode* n); + void loadScriptDirectory(simgear::Dir nasalDir); + void addModule(std::string moduleName, simgear::PathList scripts); + static void logError(naContext); + naRef parse(naContext ctx, const char* filename, const char* buf, int len); naRef genPropsModule(); - // 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); - + bool _inited; naContext _context; - naRef _globals; + naRef _globals, + _string; SGPropertyNode_ptr _cmdArg; - int _nextGCKey; - naRef _gcHash; - int _callCount; - - public: void handleTimer(NasalTimer* t); + simgear::BufferedLogCallback* _log; + + typedef std::map NasalCommandDict; + NasalCommandDict _commands; + + naRef _wrappedNodeFunc; +public: + void handleTimer(NasalTimer* t); }; - +#if 0 class FGNasalScript { public: ~FGNasalScript() { _nas->gcRelease(_gcKey); } @@ -121,74 +216,14 @@ public: naCall(_nas->_context, _code, 0, &n, naNil(), naNil()); return naGetError(_nas->_context) == 0; } - -private: - friend class FGNasalSys; - naRef _code; - int _gcKey; - FGNasalSys* _nas; -}; - - -class FGNasalListener : public SGPropertyChangeListener { -public: - FGNasalListener(SGPropertyNode* node, naRef code, FGNasalSys* nasal, - int key, int id, int type); - - virtual ~FGNasalListener(); - virtual void valueChanged(SGPropertyNode* node); - virtual void childAdded(SGPropertyNode* parent, SGPropertyNode* child); - virtual void childRemoved(SGPropertyNode* parent, SGPropertyNode* child); - + + FGNasalSys* sys() const { return _nas; } private: - bool changed(SGPropertyNode* node); - void call(SGPropertyNode* which, naRef mode); - friend class FGNasalSys; - SGPropertyNode_ptr _node; naRef _code; int _gcKey; - int _id; FGNasalSys* _nas; - int _type; - unsigned int _active; - bool _dead; - bool _first_call; - long _last_int; - double _last_float; - string _last_string; -}; - - -class FGNasalModelData : public simgear::SGModelData { -public: - FGNasalModelData(SGPropertyNode *root = 0) : _root(root), _unload(0) {} - ~FGNasalModelData(); - void modelLoaded(const string& path, SGPropertyNode *prop, osg::Node *); - -private: - string _module; - SGPropertyNode_ptr _root; - SGConstPropertyNode_ptr _unload; -}; - - -class NasalXMLVisitor : public XMLVisitor { -public: - NasalXMLVisitor(naContext c, int argc, naRef* args); - virtual ~NasalXMLVisitor() { naFreeContext(_c); } - - virtual void startElement(const char* tag, const XMLAttributes& a); - virtual void endElement(const char* tag); - virtual void data(const char* str, int len); - virtual void pi(const char* target, const char* data); - -private: - void call(naRef func, int num, naRef a = naNil(), naRef b = naNil()); - naRef make_string(const char* s, int n = -1); - - naContext _c; - naRef _start_element, _end_element, _data, _pi; }; +#endif #endif // __NASALSYS_HXX