Scanframe Modular Application 0.1.0
|
Info structure for objects used in scripts. More...
#include <ScriptObject.h>
Classes | |
struct | IdInfo |
Used to create static lookup lists. More... | |
struct | Parameters |
Type to pass to registered classes. More... | |
Public Types | |
enum | EIdentifier { idUnknown = 0 , idConstant , idVariable , idFunction , idTypedef , idKeyword } |
Keyword identifiers. More... | |
typedef std::string::size_type | pos_type |
Source position type. | |
typedef ssize_t | ip_type |
Instruction pointer type. | |
Public Member Functions | |
ScriptObject (const char *type_name, ScriptObject *parent=nullptr) | |
virtual | ~ScriptObject ()=default |
Virtual destructor which can be overloaded to clean up objects. | |
virtual const IdInfo * | getInfo (const std::string &name) const =0 |
Must be overloaded for member namespace. | |
virtual std::string | getStatusText () |
Gets the status text of this object for debugging purposes. | |
virtual bool | getSetValue (const IdInfo *info, Value *value, Value::vector_type *params, bool flag_set)=0 |
Gets or sets the a passed data member. Must be overloaded in derived class. | |
virtual void | destroyObject (bool &should_delete)=0 |
Asks if the object should be deleted after having made this call. | |
int | getRefCount () const |
Gets the reference count. | |
operator Value () const | |
Cast operator to be able to return this instance as a Value. | |
std::string | getTypeName () const |
Returns the type name Set at the constructor. | |
ScriptObject * | getParent () |
Gets the script object owner. | |
const ScriptObject * | getParent () const |
Gets the script object owner. | |
ScriptObject * | castToObject (const Value &value) |
Casts a sf::Value::vitCustom typed sf::Value to a ScriptObject typed pointer. | |
Static Public Member Functions | |
static const IdInfo * | getInfoUnknown () |
Returns the static Info structure for unknowns. | |
static sf::TClassRegistration< ScriptObject, ScriptObject::Parameters > | Interface () |
Protected Member Functions | |
void | makeParent (ScriptObject *so) |
Makes this object the owner of the other object. | |
void | setParent (ScriptObject *parent) |
Sets the owner to the pass script object. | |
Friends | |
class | ScriptInterpreter |
class | sf::TClassRegistration< ScriptObject, ScriptObject::Parameters > |
Info structure for objects used in scripts.
typedef ssize_t sf::ScriptObject::ip_type |
Instruction pointer type.
typedef std::string::size_type sf::ScriptObject::pos_type |
Source position type.
Keyword identifiers.
|
explicit |
Constructor.
|
virtualdefault |
Virtual destructor which can be overloaded to clean up objects.
ScriptObject * sf::ScriptObject::castToObject | ( | const Value & | value | ) |
Casts a sf::Value::vitCustom typed sf::Value to a ScriptObject typed pointer.
|
pure virtual |
Asks if the object should be deleted after having made this call.
Implemented in sf::FileFindObject, sf::IniProfileObject, sf::StringsObject, sf::ResultDataScriptObject, sf::VariableScriptObject, and sf::ScriptGlobalObject.
|
pure virtual |
Must be overloaded for member namespace.
Implemented in sf::FileFindObject, sf::IniProfileObject, sf::StringsObject, sf::GiiScriptInterpreter, sf::ResultDataScriptObject, sf::VariableScriptObject, sf::ScriptEngine, sf::ScriptGlobalObject, and sf::ScriptInterpreter.
|
static |
Returns the static Info structure for unknowns.
|
inline |
Gets the script object owner.
|
inline |
Gets the script object owner.
|
inline |
Gets the reference count.
|
pure virtual |
Gets or sets the a passed data member. Must be overloaded in derived class.
Implemented in sf::GiiScriptInterpreter, sf::FileFindObject, sf::IniProfileObject, sf::StringsObject, sf::ResultDataScriptObject, sf::VariableScriptObject, sf::ScriptEngine, sf::ScriptGlobalObject, and sf::ScriptInterpreter.
|
virtual |
Gets the status text of this object for debugging purposes.
Reimplemented in sf::ResultDataScriptObject, and sf::VariableScriptObject.
std::string sf::ScriptObject::getTypeName | ( | ) | const |
Returns the type name Set at the constructor.
|
static |
|
protected |
Makes this object the owner of the other object.
|
explicit |
Cast operator to be able to return this instance as a Value.
|
protected |
Sets the owner to the pass script object.
|
friend |
|
friend |