NasalSys.hxx

Go to the documentation of this file.

// NasalSys.hxx -
// SPDX-License-Identifier: GPL-2.0-or-later
 
#pragma once
 
#include <map>
#include <memory>
 
#include <simgear/math/SGMath.hxx> // keep before any cppbind include to enable
                                   // SGVec2<T> conversion.
#include <simgear/misc/sg_dir.hxx>
#include <simgear/misc/sg_path.hxx>
#include <simgear/nasal/cppbind/NasalHash.hxx>
#include <simgear/nasal/nasal.h>
#include <simgear/props/props.hxx>
#include <simgear/structure/subsystem_mgr.hxx>
#include <simgear/threads/SGQueue.hxx>
 
 
class FGNasalScript;
class FGNasalListener;
class SGCondition;
class FGNasalModelData;
class TimerObj;
class NasalSysPrivate;
struct NasalTimer;
class FGNasalModuleListener;
 
namespace simgear { class BufferedLogCallback; }
 
SGPropertyNode* ghostToPropNode(naRef ref);
 
class FGNasalSys : public SGSubsystem
{
public:
    FGNasalSys();
    virtual ~FGNasalSys();
 
    // Subsystem API.
    void init() override;
    void shutdown() override;
    void update(double dt) override;
 
    // Subsystem identification.
    static const char* staticSubsystemClassId() { return "nasal"; }
 
    // 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 std::string& source);
 
    bool parseAndRunWithOutput(const std::string& source,
                     std::string& output,
                     std::string& errors);
 
    // Implementation of the settimer extension function
    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);

    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,
                                SGPropertyNode* root = 0);
    virtual bool handleCommand(const SGPropertyNode* arg, SGPropertyNode *root);
 
    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);
 
    naRef getModule(const std::string& moduleName) const;
    naRef getModule(const char* moduleName);
 
    bool addCommand(naRef func, const std::string& name);
    bool removeCommand(const std::string& name);

    void hashset(naRef hash, const char* key, naRef val);

    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;
 
    nasal::Hash getGlobals() const;
 
    // 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 checkIOrules();

    simgear::BufferedLogCallback* log() const;
 
    string_list getAndClearErrorList();

    static naRef getPropertyValue(naContext c, SGPropertyNode* node);
 
    bool reloadModuleFromFile(const std::string& moduleName);
 
    // private methods: the class has a lot of friends to allow particular classes
    // to do book-keeping, this is not ideal.
private:
    friend FGNasalModuleListener;
 
    void initLogLevelConstants();
 
    void loadPropertyScripts();
    void loadPropertyScripts(SGPropertyNode* n);
    void loadScriptDirectory(simgear::Dir nasalDir, SGPropertyNode* loadorder,
                             bool excludeUnspecifiedInLoadOrder);
    void addModule(std::string moduleName, simgear::PathList scripts);
    static void logError(naContext);
    naRef parse(naContext ctx, const char* filename, const char* buf, int len,
               std::string& errors);
    naRef genPropsModule();
 
    friend TimerObj;
 
    void addPersistentTimer(TimerObj* pto);
    void removePersistentTimer(TimerObj* obj);
 
    // NasalTimer is a friend to invoke handleTimer and do the actual
    // dispatch of the settimer-d callback
    friend NasalTimer;
 
    void handleTimer(NasalTimer* t);
 
    static void logNasalStack(naContext context, string_list& stack);
 
    // members: should only be the d-ptr
private:
    std::unique_ptr<NasalSysPrivate> d;
};