Main Page | Namespace List | Class Hierarchy | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

ONE::script::ScriptingHost Class Reference

Inheritance diagram for ONE::script::ScriptingHost:

Inheritance graph
[legend]
List of all members.

Public Member Functions

int addScript (const std::string &scriptfile, const std::string &module)
int addScript (const std::string &scriptfile, const std::string &module, const std::string &section)
int addScriptString (const std::string &scriptfile, const std::string &module)
int build (const std::string &module)
void callFunction (const std::string &module, const std::string &declaration)
Argument callFunction (const std::string &module, const std::string &declaration, Type return_type)
void callFunction (const std::string &module, const std::string &declaration, unsigned int argc, Argument *args)
Argument callFunction (const std::string &module, const std::string &declaration, Type return_type, unsigned int argc, Argument *args)
bool checkModule (const std::string &module)
int deleteModule (const std::string &module)
void executeString (const std::string &scriptstring)
ONE::util::TextDispatchergetOutputDispatcher ()
bool isFunction (const std::string &module, const std::string &declaration)
int registerGlobalFunction (const std::string &declaration, asUPtr funcPointer, asDWORD callConv)
int registerGlobalProperty (const std::string &declaration, void *pointer)
int registerObjectBehaviour (const std::string &datatype, asDWORD behaviour, const std::string &declaration, asUPtr funcPointer, asDWORD callConv)
int registerObjectMethod (const std::string &obj, const std::string &declaration, asUPtr funcPointer, asDWORD callConv)
int registerObjectProperty (const std::string &obj, const std::string &declaration, int byteOffset)
int registerObjectType (const std::string &name, int byteSize, asDWORD flags)
 ~ScriptingHost ()

Static Public Member Functions

static void destroyInstance ()
 may be used to manually destroy the singleton instance
static ScriptingHostgetInstance ()
 accesses the singleton instance
static bool isActive ()
 checks if the singleton is active
static bool isDestroyed ()
 checks if the singleton is destroyed
static bool isVirgin ()
 checks if the singleton has not been initialized
static void setPriority (unsigned short)
 sets this singleton's shutdown priority

Protected Member Functions

 Singleton ()

Static Protected Member Functions

static void destroyedError ()
static void initInstance ()

Classes

class  COutStream

Constructor & Destructor Documentation

ONE::script::ScriptingHost::~ScriptingHost  )  [inline]
 


Member Function Documentation

int ONE::script::ScriptingHost::addScript const std::string &  scriptfile,
const std::string &  module
 

int ONE::script::ScriptingHost::addScript const std::string &  scriptfile,
const std::string &  module,
const std::string &  section
 

int ONE::script::ScriptingHost::addScriptString const std::string &  scriptfile,
const std::string &  module
 

int ONE::script::ScriptingHost::build const std::string &  module  ) 
 

void ONE::script::ScriptingHost::callFunction const std::string &  module,
const std::string &  declaration
 

Argument ONE::script::ScriptingHost::callFunction const std::string &  module,
const std::string &  declaration,
Type  return_type
 

void ONE::script::ScriptingHost::callFunction const std::string &  module,
const std::string &  declaration,
unsigned int  argc,
Argument args
 

Argument ONE::script::ScriptingHost::callFunction const std::string &  module,
const std::string &  declaration,
Type  return_type,
unsigned int  argc,
Argument args
 

bool ONE::script::ScriptingHost::checkModule const std::string &  module  ) 
 

int ONE::script::ScriptingHost::deleteModule const std::string &  module  ) 
 

static void ONE::util::OrderedAutomatic< ScriptingHost >::destroyedError  )  [static, protected, inherited]
 

static void ONE::util::OrderedAutomatic< ScriptingHost >::destroyInstance  )  [static, inherited]
 

may be used to manually destroy the singleton instance

If this function is not called, the instance is destroyed automatically during shutdown.

void ONE::script::ScriptingHost::executeString const std::string &  scriptstring  ) 
 

static ScriptingHost * ONE::util::Singleton< ScriptingHost , ONE::util::OrderedAutomatic >::getInstance  )  [static, inherited]
 

accesses the singleton instance

The exact operation executed by calling this function is determined by the singleton policies.

Returns:
a pointer to the singleton instance

ONE::util::TextDispatcher* ONE::script::ScriptingHost::getOutputDispatcher  )  [inline]
 

static void ONE::util::OrderedAutomatic< ScriptingHost >::initInstance  )  [static, protected, inherited]
 

static bool ONE::util::Singleton< ScriptingHost , ONE::util::OrderedAutomatic >::isActive  )  [static, inherited]
 

checks if the singleton is active

Returns:
if the singleton is instantiated

static bool ONE::util::Singleton< ScriptingHost , ONE::util::OrderedAutomatic >::isDestroyed  )  [static, inherited]
 

checks if the singleton is destroyed

This function returns true if an instance existed and was destroyed. Note that in some cases it is possible to revive a singleton.

Returns:
if the singleton is destroyed

bool ONE::script::ScriptingHost::isFunction const std::string &  module,
const std::string &  declaration
 

static bool ONE::util::Singleton< ScriptingHost , ONE::util::OrderedAutomatic >::isVirgin  )  [static, inherited]
 

checks if the singleton has not been initialized

A singleton is not initialized if no instance exists and no instance has been destroyed.

Returns:
if the singleton is untouched

int ONE::script::ScriptingHost::registerGlobalFunction const std::string &  declaration,
asUPtr  funcPointer,
asDWORD  callConv
 

int ONE::script::ScriptingHost::registerGlobalProperty const std::string &  declaration,
void *  pointer
 

int ONE::script::ScriptingHost::registerObjectBehaviour const std::string &  datatype,
asDWORD  behaviour,
const std::string &  declaration,
asUPtr  funcPointer,
asDWORD  callConv
 

int ONE::script::ScriptingHost::registerObjectMethod const std::string &  obj,
const std::string &  declaration,
asUPtr  funcPointer,
asDWORD  callConv
 

int ONE::script::ScriptingHost::registerObjectProperty const std::string &  obj,
const std::string &  declaration,
int  byteOffset
 

int ONE::script::ScriptingHost::registerObjectType const std::string &  name,
int  byteSize,
asDWORD  flags
 

static void ONE::util::OrderedAutomatic< ScriptingHost >::setPriority unsigned  short  )  [static, inherited]
 

sets this singleton's shutdown priority

The higher the priority, the earlier the instance will be destroyed during shutdown. If the priority is changed, the highest given priority will be used.

ONE::util::Singleton< ScriptingHost , ONE::util::OrderedAutomatic >::Singleton  )  [protected, inherited]
 


Generated on Wed Sep 7 19:03:30 2005 for ONEngine by  doxygen 1.4.3