ScriptObject.h

Go to the documentation of this file.

#pragma once
#include <cstring>
#include <misc/gen/TClassRegistration.h>
#include <misc/gen/Value.h>
#include <misc/global.h>
 
namespace sf
{
 
class _MISC_CLASS ScriptObject
{
  public:
    struct Parameters
    {
        explicit Parameters(Value::vector_type* arguments, ScriptObject* parent = nullptr)
          : _parent(parent)
          , _arguments(arguments)
        {}
 
        ScriptObject* _parent;
        Value::vector_type* _arguments;
    };
 
    typedef std::string::size_type pos_type;
    typedef ssize_t ip_type;
 
    enum EIdentifier
    {
      idUnknown = 0,
      idConstant,
      idVariable,
      idFunction,
      idTypedef,
      idKeyword
    };
 
    struct IdInfo
    {
        int _index{0};
        EIdentifier _id{idUnknown};
        const char* _name{nullptr};
        int _paramCount{0};
        void* _data{nullptr};
    };
 
    explicit ScriptObject(const char* type_name, ScriptObject* parent = nullptr);
 
    virtual ~ScriptObject() = default;
 
    [[nodiscard]] virtual const IdInfo* getInfo(const std::string& name) const = 0;
 
    virtual std::string getStatusText();
    virtual bool getSetValue(const IdInfo* info, Value* value, Value::vector_type* params, bool flag_set) = 0;
 
    virtual void destroyObject(bool& should_delete) = 0;
 
    [[nodiscard]] inline int getRefCount() const
    {
      return _refCount;
    }
 
    explicit operator Value() const;
 
    static const IdInfo* getInfoUnknown();
 
    [[nodiscard]] std::string getTypeName() const;
 
    inline ScriptObject* getParent()
    {
      return _parent;
    }
 
    [[nodiscard]] inline const ScriptObject* getParent() const
    {
      return _parent;
    }
 
    ScriptObject* castToObject(const Value& value);
 
  protected:
    void makeParent(ScriptObject* so);
    void setParent(ScriptObject* parent);
 
  private:
    int _refCount{0};
    const char* _typeName{nullptr};
    ScriptObject* _parent{nullptr};
 
    friend class ScriptInterpreter;
 
    // Declarations of static functions and data members to be able to create implementations.
    SF_DECL_IFACE(ScriptObject, ScriptObject::Parameters, Interface)
};
 
}// namespace sf