CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

Shared Class Facility (SCF)


Compounds

struct  iBase
 This is the basic interface: all other interfaces should be derived from this one, this will allow us to always use at least some minimal functionality given any interface pointer. More...

struct  iComponent
 This interface describes a generic component in Crystal Space. More...

struct  iFactory
 iFactory is an interface that is used to create instances of shared classes. More...

class  scfInterface
 Interface query class. More...

struct  iObjectRegistry
 This interface serves as a registry of other objects. More...

struct  iObjectRegistryIterator
 Use an instance of this class to iterate over objects in the object registry. More...

struct  iPluginIterator
 An iterator to iterate over all plugins in the plugin manager. More...

struct  iPluginManager
 This is the plugin manager. More...

struct  iSCF
 iSCF is the interface that allows using SCF functions from shared classes. More...


Defines

#define SCF_TRACE(x)
 Macro for typing debug strings: Add define SCF_DEBUG at the top of modules you want to track miscelaneous SCF activity and recompile.

#define SCF_PRINT_CALL_ADDRESS
 Macro for getting the address we were called from (stack backtracing).

#define SCF_CONSTRUCT_VERSION(Major, Minor, Micro)   ((Major << 24) | (Minor << 16) | Micro)
 Use this macro to construct interface version numbers.

#define SCF_DECLARE_IBASE
 This macro should be embedded into any SCF-capable class definition to declare the minimal functionality required by iBase interface.

#define SCF_DECLARE_EMBEDDED_IBASE(OuterClass)
 SCF_DECLARE_EMBEDDED_IBASE is used to declare the methods of iBase inside an embedded class that is exposed via QueryInterface...

#define SCF_CONSTRUCT_IBASE(Parent)
 The SCF_CONSTRUCT_IBASE macro should be invoked inside the constructor of a class (not inside an embedded interface).

#define SCF_CONSTRUCT_EMBEDDED_IBASE(Interface)
 The SCF_CONSTRUCT_EMBEDDED_IBASE macro should be invoked inside the constructor of a class that has an embedded interface (not inside the constructor of the embedded interface).

#define SCF_DESTRUCT_IBASE()
 The SCF_DESTRUCT_IBASE macro should be invoked inside the destructor of a class (not inside an embedded interface).

#define SCF_DESTRUCT_EMBEDDED_IBASE(Interface)
 The SCF_DESTRUCT_EMBEDDED_IBASE macro should be invoked inside the destructor of a class that has an embedded interface (not inside the destructor of the embedded interface).

#define SCF_IMPLEMENT_IBASE_INCREF(Class)
 The SCF_IMPLEMENT_IBASE_INCREF() macro implements the IncRef() method for a class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_DECREF(Class)
 The SCF_IMPLEMENT_IBASE_DECREF() macro implements the DecRef() method for a class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_REMOVE_REF_OWNERS(Class)
 The SCF_IMPLEMENT_IBASE_REMOVE_REF_OWNERS() macro implements the scfRemoveRefOwners() method for a class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_REFOWNER(Class)
 The SCF_IMPLEMENT_IBASE_REFOWNER() macro implements the AddRefOwner() and RemoveRefOwner() for a weak reference.

#define SCF_IMPLEMENT_IBASE_GETREFCOUNT(Class)
 The SCF_IMPLEMENT_IBASE_GETREFCOUNT() macro implements GetRefCount() for a class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_QUERY(Class)
 The SCF_IMPLEMENT_IBASE_QUERY() macro implements the opening boilerplate for the QueryInterface() method for a class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_QUERY_END
 The SCF_IMPLEMENT_IBASE_QUERY_END macro implements the closing boilerplate for the QueryInterface() method for a class in a C++ source module.

#define SCF_IMPLEMENT_IBASE(Class)
 The SCF_IMPLEMENT_IBASE() macro should be used within the C++ source module that implements a interface derived from iBase.

#define SCF_IMPLEMENT_IBASE_END   SCF_IMPLEMENT_IBASE_QUERY_END
 The SCF_IMPLEMENT_IBASE_END macro is used to finish an SCF_IMPLEMENT_IBASE definition.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_INCREF(Class)
 The SCF_IMPLEMENT_EMBEDDED_IBASE_INCREF() macro implements the IncRef() method for an embedded class in a C++ source module.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_DECREF(Class)
 The SCF_IMPLEMENT_EMBEDDED_IBASE_DECREF() macro implements the DecRef() method for an embedded class in a C++ source module.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_GETREFCOUNT(Class)
 The SCF_IMPLEMENT_EMBEDDED_IBASE_GETREFCOUNT() macro implements the GetRefCount() method for an embedded class in a C++ source module.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_REFOWNER(Class)
 The SCF_IMPLEMENT_EMBEDDED_IBASE_REFOWNER() macro implements the AddRefOwner() and RemoveRefOwner() for a weak reference.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY(Class)
 The SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY() macro implements the opening boilerplate for the QueryInterface() method for an embedded class in a C++ source module.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END
 The SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END macro implements the closing boilerplate for the QueryInterface() method for a class in an embedded C++ source module.

#define SCF_IMPLEMENT_EMBEDDED_IBASE(Class)
 SCF_IMPLEMENT_EMBEDDED_IBASE should be used to implement embedded interfaces derived from iBase.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_END   SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END
 The SCF_IMPLEMENT_EMBEDDED_IBASE_END macro is used to finish an SCF_IMPLEMENT_EMBEDDED_IBASE definition.

#define SCF_IMPLEMENTS_INTERFACE(Interface)
 The IMPLEMENT_INTERFACE macro is used inside QueryInterface function to check if user requested a specific interface, whenever requested version of the interface correspond to the version we have and to return a pointer to that interface if everything is correct.

#define SCF_IMPLEMENTS_EMBEDDED_INTERFACE(Interface)   SCF_IMPLEMENTS_INTERFACE_COMMON (Interface, (&scf##Interface))
 IMPLEMENT_EMBEDDED_INTERFACE is same as IMPLEMENT_INTERFACE but is used when class implements the interface as an embedded member.

#define SCF_IMPLEMENTS_INTERFACE_COMMON(Interface, Object)
 This is a common macro used in all IMPLEMENTS_XXX_INTERFACE macros.

#define SCF_DECLARE_IBASE_EXT(ParentClass)
 The following macro is used in "expansion SCF classes".

#define SCF_IMPLEMENT_IBASE_EXT_INCREF(Class)
 The SCF_IMPLEMENT_IBASE_EXT_INCREF() macro implements the IncRef() method for a class extending another SCF class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_EXT_DECREF(Class)
 The SCF_IMPLEMENT_IBASE_EXT_DECREF() macro implements the DecRef() method for a class extending another SCF class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_EXT_GETREFCOUNT(Class)
 The SCF_IMPLEMENT_IBASE_EXT_GETREFCOUNT() macro implements the GetRefCount() method for a class extending another SCF class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_EXT_REFOWNER(Class)
 The SCF_IMPLEMENT_IBASE_EXT_REFOWNER() macro implements the AddRefOwner() and RemoveRefOwner() for a weak reference.

#define SCF_IMPLEMENT_IBASE_EXT_QUERY(Class)
 The SCF_IMPLEMENT_IBASE_EXT_QUERY() macro implements the opening boilerplate for the QueryInterface() method for a class extending another SCF class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_EXT_QUERY_END
 The SCF_IMPLEMENT_IBASE_EXT_QUERY_END macro implements the closing boilerplate for the QueryInterface() method for a class extending another SCF class in a C++ source module.

#define SCF_IMPLEMENT_IBASE_EXT(Class)
 This macro implements same functionality as SCF_IMPLEMENT_IBASE except that it should be used for expansion SCF classes.

#define SCF_IMPLEMENT_IBASE_EXT_END   SCF_IMPLEMENT_IBASE_EXT_QUERY_END
 This macro implements same functionality as SCF_IMPLEMENT_IBASE_END except that it is used for expansion SCF classes.

#define SCF_IMPLEMENT_FACTORY_INIT(Class)
 The SCF_IMPLEMENT_FACTORY_INIT macro defines initialization code for a plugin module.

#define SCF_IMPLEMENT_FACTORY_FINIS(Class)
 The SCF_IMPLEMENT_FACTORY_FINIS macro defines finalization code for a plugin module.

#define SCF_IMPLEMENT_FACTORY_CREATE(Class)
 The SCF_IMPLEMENT_FACTORY_CREATE macro is used to define a factory for one of exported classes.

#define SCF_IMPLEMENT_FACTORY(Class)
 The SCF_IMPLEMENT_FACTORY macro is used to define a factory for one of exported classes.

#define SCF_REGISTER_STATIC_CLASS(Class, Ident, Desc, Dep)
 Automatically register a built-in class with SCF during startup.

#define SCF_REGISTER_STATIC_LIBRARY(Module, MetaInfo)
 Automatically register a static library with SCF during startup.

#define SCF_REGISTER_FACTORY_FUNC(Class)
 Used in conjunction with SCF_REGISTER_STATIC_LIBRARY to ensure that a reference to the class(s) registered via SCF_REGISTER_STATIC_LIBRARY are actually linked into the application.

#define SCF_CREATE_INSTANCE(ClassID, Interface)
 Handy macro to create an instance of a shared class.

#define SCF_VERSION(Name, Major, Minor, Micro)
 SCF_VERSION can be used to define an interface's version number; you should specify interface name and major, minor and micro version components.

#define SCF_QUERY_INTERFACE(Object, Interface)
 Shortcut macro to query given interface from given object.

#define SCF_QUERY_INTERFACE_SAFE(Object, Interface)
 Shortcut macro to query given interface from given object.

#define CS_QUERY_PLUGIN_CLASS(Object, ClassID, Interface)
 Find a plugin by his class ID.

#define CS_LOAD_PLUGIN(Object, ClassID, Interface)
 Tell plugin manager driver to load a plugin.

#define CS_LOAD_PLUGIN_ALWAYS(Object, ClassID)   csPtr<iBase> ((Object)->LoadPlugin (ClassID, 0, 0))
 Same as CS_LOAD_PLUGIN but don't bother asking for a interface.


Typedefs

typedef unsigned long scfInterfaceID
 Type of registered interface handle used by iBase::QueryInterface().

typedef void *(* scfFactoryFunc )(iBase *)
 Type of factory function which creates an instance of an SCF class.


Functions

void scfInitialize (csPluginPaths *pluginPaths)
 This function should be called to initialize client SCF library.

void scfInitialize (int argc, const char *const argv[])
 This function should be called to initialize client SCF library.

bool scfCompatibleVersion (int iVersion, int iItfVersion)
 This function checks whenever an interface is compatible with given version.


Define Documentation

#define CS_LOAD_PLUGIN Object,
ClassID,
Interface   
 

Value:

csPtr<Interface> ((Interface *)((Object)->LoadPlugin                    \
  (ClassID, #Interface, scfInterface<Interface>::GetVersion())))
Tell plugin manager driver to load a plugin.

`Object' is a object that implements iPluginManager interface. `ClassID' is the class ID (`crystalspace.graphics3d.software'). `Interface' is a interface name (iGraphics2D, iVFS and so on).

Definition at line 51 of file plugin.h.

#define CS_LOAD_PLUGIN_ALWAYS Object,
ClassID       csPtr<iBase> ((Object)->LoadPlugin (ClassID, 0, 0))
 

Same as CS_LOAD_PLUGIN but don't bother asking for a interface.

This is useful for unconditionally loading plugins.

Definition at line 72 of file plugin.h.

#define CS_QUERY_PLUGIN_CLASS Object,
ClassID,
Interface   
 

Value:

csPtr<Interface> ((Interface *)((Object)->QueryPlugin                   \
  (ClassID, #Interface, scfInterface<Interface>::GetVersion())))
Find a plugin by his class ID.

First the plugin with requested class identifier is found, and after this it is queried for the respective interface; if it does not implement the requested interface, 0 is returned.

Definition at line 41 of file plugin.h.

#define CS_QUERY_REGISTRY Reg,
Interface   
 

Value:

csPtr<Interface> ((Interface*)(CS_IMPLICIT_PTR_CAST(iObjectRegistry, Reg)->Get (#Interface, \
    scfInterface<Interface>::GetID(), scfInterface<Interface>::GetVersion())))

Definition at line 34 of file objreg.h.

#define CS_QUERY_REGISTRY_TAG_INTERFACE Reg,
Tag,
Interface   
 

Value:

Definition at line 37 of file objreg.h.

#define SCF_CONSTRUCT_EMBEDDED_IBASE Interface   
 

Value:

Interface.scfParent = this;                                             \
  csRefTrackerAccess::AddAlias (&Interface, this);
The SCF_CONSTRUCT_EMBEDDED_IBASE macro should be invoked inside the constructor of a class that has an embedded interface (not inside the constructor of the embedded interface).

The macro will initialize the pointer to the parent object (to the object this one is embedded into). The argument to this macro is the name of the parent's instance variable by which the embedded object is known (typically something like `scfiFooBar').

Definition at line 163 of file scf.h.

#define SCF_CONSTRUCT_IBASE Parent   
 

Value:

csRefTrackerAccess::TrackConstruction (this);                           \
  csRefTrackerAccess::SetDescription (this, CS_TYPENAME(*this));        \
  scfRefCount = 1;                                                      \
  scfWeakRefOwners = 0;                                                 \
  scfParent = Parent; if (scfParent) scfParent->IncRef();               \
  SCF_INIT_TRACKER_ALIASES
The SCF_CONSTRUCT_IBASE macro should be invoked inside the constructor of a class (not inside an embedded interface).

Normally each constructor should accept an iBase* parameter (that is passed by scfCreateInstance function) which should be passed to this macro. The macro will zero the reference count and initialize the pointer to the parent object. If the object is unparented (a common case), it is okay to use null as the argument to this macro.

Definition at line 146 of file scf.h.

Referenced by csDataBuffer::csDataBuffer(), csInputBinderBoolean::csInputBinderBoolean(), csInputBinderPosition::csInputBinderPosition(), csPath::csPath(), csPolygonMesh::csPolygonMesh(), csPolygonMeshBox::csPolygonMeshBox(), csScfStringSet::csScfStringSet(), scfString::scfString(), and scfStringArray::scfStringArray().

#define SCF_CONSTRUCT_VERSION Major,
Minor,
Micro       ((Major << 24) | (Minor << 16) | Micro)
 

Use this macro to construct interface version numbers.

Definition at line 69 of file scf.h.

#define SCF_CREATE_INSTANCE ClassID,
Interface   
 

Value:

csPtr<Interface> (                                                    \
    (Interface *)iSCF::SCF->CreateInstance (                            \
    ClassID, #Interface, scfInterface<Interface>::GetVersion()))
Handy macro to create an instance of a shared class.

This is a simple wrapper around scfCreateInstance.

Definition at line 727 of file scf.h.

#define SCF_DECLARE_EMBEDDED_IBASE OuterClass   
 

Value:

public:                                                                 \
  OuterClass *scfParent;                                \
  virtual void IncRef ();                                               \
  virtual void DecRef ();                                               \
  virtual int GetRefCount ();                                           \
  virtual void AddRefOwner (iBase** ref_owner);                         \
  virtual void RemoveRefOwner (iBase** ref_owner);                      \
  virtual void *QueryInterface (scfInterfaceID iInterfaceID, int iVersion)
SCF_DECLARE_EMBEDDED_IBASE is used to declare the methods of iBase inside an embedded class that is exposed via QueryInterface...

Definition at line 127 of file scf.h.

#define SCF_DECLARE_IBASE
 

Value:

int scfRefCount;                                        \
  csArray<iBase**>* scfWeakRefOwners;                                   \
  void scfRemoveRefOwners ();                                           \
  SCF_DECLARE_EMBEDDED_IBASE (iBase)
This macro should be embedded into any SCF-capable class definition to declare the minimal functionality required by iBase interface.

Definition at line 117 of file scf.h.

#define SCF_DECLARE_IBASE_EXT ParentClass   
 

Value:

typedef ParentClass __scf_superclass;                                   \
  virtual void IncRef ();                                               \
  virtual void DecRef ();                                               \
  virtual int GetRefCount ();                                           \
  virtual void AddRefOwner (iBase** ref_owner);                         \
  virtual void RemoveRefOwner (iBase** ref_owner);                      \
  virtual void *QueryInterface (scfInterfaceID iInterfaceID, int iVersion)
The following macro is used in "expansion SCF classes".

An expansion class is a class that extends the functionality of another SCF class. For example, suppose a class TheWolf that implements the iWolf interface. Separately it is a useful class per se, but if you want to implement an additional class TheDog that is a subclass of TheWolf and which implements an additional interface iDog in theory you should just override the QueryInterface method and return the corresponding pointer when asked. The following macro makes such overrides simpler to write.

Definition at line 448 of file scf.h.

#define SCF_DESTRUCT_EMBEDDED_IBASE Interface   
 

Value:

csRefTrackerAccess::RemoveAlias (&Interface, this);                     \
  Interface.scfParent = 0;
The SCF_DESTRUCT_EMBEDDED_IBASE macro should be invoked inside the destructor of a class that has an embedded interface (not inside the destructor of the embedded interface).

It reverses the initialization performed by the SCF_CONSTRUCT_EMBEDDED_IBASE() macro.

Definition at line 182 of file scf.h.

 
#define SCF_DESTRUCT_IBASE  
 

Value:

csRefTrackerAccess::TrackDestruction (this, scfRefCount);               \
  scfRemoveRefOwners ();
The SCF_DESTRUCT_IBASE macro should be invoked inside the destructor of a class (not inside an embedded interface).

It reverses the initialization performed by the SCF_CONSTRUCT_IBASE() macro.

Definition at line 172 of file scf.h.

Referenced by csDataBuffer::~csDataBuffer(), csInputBinderBoolean::~csInputBinderBoolean(), csInputBinderPosition::~csInputBinderPosition(), csPath::~csPath(), csScfStringSet::~csScfStringSet(), scfString::~scfString(), and scfStringArray::~scfStringArray().

#define SCF_IMPLEMENT_EMBEDDED_IBASE Class   
 

Value:

SCF_IMPLEMENT_EMBEDDED_IBASE should be used to implement embedded interfaces derived from iBase.

It differs from SCF_IMPLEMENT_IBASE because embedded interface don't have reference counts themselves, but instead use the reference count of their parent object.

Definition at line 393 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_DECREF Class   
 

Value:

void Class::DecRef ()                                                   \
{                                                                       \
  SCF_TRACE (("  (%s *)%p->DecRef (%d)\n", #Class, this,                \
              scfParent->GetRefCount ()-1));                            \
  scfParent->DecRef ();                                                 \
}
The SCF_IMPLEMENT_EMBEDDED_IBASE_DECREF() macro implements the DecRef() method for an embedded class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_EMBEDDED_IBASE() convenience macro.

Definition at line 333 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_END   SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END
 

The SCF_IMPLEMENT_EMBEDDED_IBASE_END macro is used to finish an SCF_IMPLEMENT_EMBEDDED_IBASE definition.

Definition at line 404 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_GETREFCOUNT Class   
 

Value:

int Class::GetRefCount ()                                               \
{                                                                       \
  return scfParent->GetRefCount ();                                     \
}
The SCF_IMPLEMENT_EMBEDDED_IBASE_GETREFCOUNT() macro implements the GetRefCount() method for an embedded class in a C++ source module.

Definition at line 345 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_INCREF Class   
 

Value:

void Class::IncRef ()                                                   \
{                                                                       \
  SCF_TRACE (("  (%s *)%p->IncRef (%d)\n", #Class, this,                \
    scfParent->GetRefCount () + 1));                                    \
  scfParent->IncRef ();                                                 \
}
The SCF_IMPLEMENT_EMBEDDED_IBASE_INCREF() macro implements the IncRef() method for an embedded class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_EMBEDDED_IBASE() convenience macro.

Definition at line 319 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY Class   
 

Value:

void *Class::QueryInterface (scfInterfaceID iInterfaceID, int iVersion) \
{                                                                       \
  SCF_TRACE (("  (%s *)%p->QueryInterface (%u, %08X)\n",                \
    #Class, this, iInterfaceID, iVersion));
The SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY() macro implements the opening boilerplate for the QueryInterface() method for an embedded class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_EMBEDDED_IBASE() convenience macro.

Definition at line 371 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END
 

Value:

return scfParent->QueryInterface (iInterfaceID, iVersion);              \
}
The SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END macro implements the closing boilerplate for the QueryInterface() method for a class in an embedded C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_EMBEDDED_IBASE_END convenience macro.

Definition at line 383 of file scf.h.

#define SCF_IMPLEMENT_EMBEDDED_IBASE_REFOWNER Class   
 

Value:

void Class::AddRefOwner (iBase** ref_owner)                             \
{                                                                       \
  scfParent->AddRefOwner (ref_owner);                                   \
}                                                                       \
void Class::RemoveRefOwner (iBase** ref_owner)                          \
{                                                                       \
  scfParent->RemoveRefOwner (ref_owner);                                \
}
The SCF_IMPLEMENT_EMBEDDED_IBASE_REFOWNER() macro implements the AddRefOwner() and RemoveRefOwner() for a weak reference.

Definition at line 355 of file scf.h.

#define SCF_IMPLEMENT_FACTORY Class   
 

Value:

The SCF_IMPLEMENT_FACTORY macro is used to define a factory for one of exported classes.

You can define the function manually, of course, if the constructor for your class has some specific constructor arguments (that is, more than one iBase* argument).

Definition at line 622 of file scf.h.

#define SCF_IMPLEMENT_FACTORY_CREATE Class   
 

Value:

CS_EXPORTED_FUNCTION                                                    \
void* CS_EXPORTED_NAME(Class,_Create)(iBase *iParent)                   \
{                                                                       \
  void *ret = new Class (iParent);                                      \
  SCF_TRACE (("  %p = new %s ()\n", ret, #Class));                      \
  return ret;                                                           \
}
The SCF_IMPLEMENT_FACTORY_CREATE macro is used to define a factory for one of exported classes.

You can define the function manually, of course, if the constructor for your class has some specific constructor arguments (that is, more than one iBase* argument).

Definition at line 607 of file scf.h.

#define SCF_IMPLEMENT_FACTORY_FINIS Class   
 

Value:

CS_DECLARE_STATIC_VARIABLE_CLEANUP                                      \
CS_EXPORTED_FUNCTION                                                    \
void CS_EXPORTED_NAME(Class,_scfFinalize)()                             \
{                                                                       \
SCF_STATIC_VAR_CLEANUP                                                  \
}
The SCF_IMPLEMENT_FACTORY_FINIS macro defines finalization code for a plugin module.

As with SCF_IMPLEMENT_FACTORY_INIT, only one instance of this function will be invoked to finalize the module.

Definition at line 593 of file scf.h.

#define SCF_IMPLEMENT_FACTORY_INIT Class   
 

Value:

static inline void Class ## _scfUnitInitialize(iSCF* SCF)               \
{ iSCF::SCF = SCF; }                                                    \
CS_EXPORTED_FUNCTION                                                    \
void CS_EXPORTED_NAME(Class,_scfInitialize)(iSCF* SCF)                  \
{ Class ## _scfUnitInitialize(SCF); }
The SCF_IMPLEMENT_FACTORY_INIT macro defines initialization code for a plugin module.

This function should set the plugin-global iSCF::SCF variable, and otherwise initialize the plugin module. Although a version of this function will be created for each SCF factory exported by the plugin, SCF will call one, and only one, to perform the plugin initialization. The choice of which function will be invoked to initialize the plugin is an SCF implementation detail. You should not attempt to predict which class_scfInitialize() function will be used, nor should use try to sway SCF's choice. Implementation note: There are some rare instances where a particularly picky (and probably buggy) compiler does not allow C++ expressions within a function declared `extern "C"'. For this reason, the iSCF::SCF variable is instead initialized in the Class_scfUnitInitialize() function which is not qualified as `extern "C"'.

Definition at line 574 of file scf.h.

#define SCF_IMPLEMENT_IBASE Class   
 

Value:

The SCF_IMPLEMENT_IBASE() macro should be used within the C++ source module that implements a interface derived from iBase.

Of course, you can still implement those methods manually, if you desire ...

Definition at line 298 of file scf.h.

#define SCF_IMPLEMENT_IBASE_DECREF Class   
 

Value:

void Class::DecRef ()                                                   \
{                                                                       \
  csRefTrackerAccess::TrackDecRef (this, scfRefCount);                  \
  if (scfRefCount == 1)                                                 \
  {                                                                     \
    SCF_TRACE ((" delete (%s *)%p\n", #Class, this));                   \
    scfRemoveRefOwners ();                                              \
    if (scfParent)                                                      \
      scfParent->DecRef ();                                             \
    delete this;                                                        \
    return;                                                             \
  }                                                                     \
  scfRefCount--;                                                        \
}
The SCF_IMPLEMENT_IBASE_DECREF() macro implements the DecRef() method for a class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE() convenience macro.

A note about the implementation: We do the "if" before the "scRefCount--" to make sure that calling Inc/DecRef doesn't result in a 2nd delete

Definition at line 207 of file scf.h.

#define SCF_IMPLEMENT_IBASE_END   SCF_IMPLEMENT_IBASE_QUERY_END
 

The SCF_IMPLEMENT_IBASE_END macro is used to finish an SCF_IMPLEMENT_IBASE definition.

Definition at line 310 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT Class   
 

Value:

This macro implements same functionality as SCF_IMPLEMENT_IBASE except that it should be used for expansion SCF classes.

Definition at line 531 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_DECREF Class   
 

Value:

void Class::DecRef ()                                                   \
{                                                                       \
  __scf_superclass::DecRef ();                                          \
}
The SCF_IMPLEMENT_IBASE_EXT_DECREF() macro implements the DecRef() method for a class extending another SCF class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE_EXT() convenience macro.

Definition at line 475 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_END   SCF_IMPLEMENT_IBASE_EXT_QUERY_END
 

This macro implements same functionality as SCF_IMPLEMENT_IBASE_END except that it is used for expansion SCF classes.

Definition at line 542 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_GETREFCOUNT Class   
 

Value:

int Class::GetRefCount ()                                               \
{                                                                       \
  return __scf_superclass::GetRefCount ();                              \
}
The SCF_IMPLEMENT_IBASE_EXT_GETREFCOUNT() macro implements the GetRefCount() method for a class extending another SCF class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE_EXT() convenience macro.

Definition at line 487 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_INCREF Class   
 

Value:

void Class::IncRef ()                                                   \
{                                                                       \
  __scf_superclass::IncRef ();                                          \
}
The SCF_IMPLEMENT_IBASE_EXT_INCREF() macro implements the IncRef() method for a class extending another SCF class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE_EXT() convenience macro.

Definition at line 463 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_QUERY Class   
 

Value:

void *Class::QueryInterface (scfInterfaceID iInterfaceID, int iVersion) \
{
The SCF_IMPLEMENT_IBASE_EXT_QUERY() macro implements the opening boilerplate for the QueryInterface() method for a class extending another SCF class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE_EXT() convenience macro.

Definition at line 513 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_QUERY_END
 

Value:

return __scf_superclass::QueryInterface (iInterfaceID, iVersion);       \
}
The SCF_IMPLEMENT_IBASE_EXT_QUERY_END macro implements the closing boilerplate for the QueryInterface() method for a class extending another SCF class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE_EXT_END convenience macro.

Definition at line 523 of file scf.h.

#define SCF_IMPLEMENT_IBASE_EXT_REFOWNER Class   
 

Value:

void Class::AddRefOwner (iBase** ref_owner)                             \
{                                                                       \
  __scf_superclass::AddRefOwner (ref_owner);                            \
}                                                                       \
void Class::RemoveRefOwner (iBase** ref_owner)                          \
{                                                                       \
  __scf_superclass::RemoveRefOwner (ref_owner);                         \
}
The SCF_IMPLEMENT_IBASE_EXT_REFOWNER() macro implements the AddRefOwner() and RemoveRefOwner() for a weak reference.

Definition at line 497 of file scf.h.

#define SCF_IMPLEMENT_IBASE_GETREFCOUNT Class   
 

Value:

int Class::GetRefCount ()                                               \
{                                                                       \
  return scfRefCount;                                                   \
}
The SCF_IMPLEMENT_IBASE_GETREFCOUNT() macro implements GetRefCount() for a class in a C++ source module.

Definition at line 264 of file scf.h.

#define SCF_IMPLEMENT_IBASE_INCREF Class   
 

Value:

void Class::IncRef ()                                                   \
{                                                                       \
  SCF_TRACE (("  (%s *)%p->IncRef (%d)\n", #Class, this, scfRefCount + 1));\
  csRefTrackerAccess::TrackIncRef (this, scfRefCount);                  \
  scfRefCount++;                                                        \
}
The SCF_IMPLEMENT_IBASE_INCREF() macro implements the IncRef() method for a class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE() convenience macro.

Definition at line 191 of file scf.h.

#define SCF_IMPLEMENT_IBASE_QUERY Class   
 

Value:

void *Class::QueryInterface (scfInterfaceID iInterfaceID, int iVersion) \
{                                                                       \
  SCF_TRACE (("  (%s *)%p->QueryInterface (%u, %08X)\n",                \
    #Class, this, iInterfaceID, iVersion));
The SCF_IMPLEMENT_IBASE_QUERY() macro implements the opening boilerplate for the QueryInterface() method for a class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE() convenience macro.

Definition at line 276 of file scf.h.

#define SCF_IMPLEMENT_IBASE_QUERY_END
 

Value:

return scfParent ?                                                      \
    scfParent->QueryInterface (iInterfaceID, iVersion) : 0;             \
}
The SCF_IMPLEMENT_IBASE_QUERY_END macro implements the closing boilerplate for the QueryInterface() method for a class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE_END convenience macro.

Definition at line 288 of file scf.h.

#define SCF_IMPLEMENT_IBASE_REFOWNER Class   
 

Value:

void Class::AddRefOwner (iBase** ref_owner)                             \
{                                                                       \
  if (!scfWeakRefOwners)                                                \
    scfWeakRefOwners = new csArray<iBase**>;                            \
  scfWeakRefOwners->Push (ref_owner);                                   \
}                                                                       \
void Class::RemoveRefOwner (iBase** ref_owner)                          \
{                                                                       \
  if (!scfWeakRefOwners)                                                \
    scfWeakRefOwners = new csArray<iBase**>;                            \
  scfWeakRefOwners->Delete (ref_owner);                                 \
}
The SCF_IMPLEMENT_IBASE_REFOWNER() macro implements the AddRefOwner() and RemoveRefOwner() for a weak reference.

Definition at line 246 of file scf.h.

#define SCF_IMPLEMENT_IBASE_REMOVE_REF_OWNERS Class   
 

Value:

void Class::scfRemoveRefOwners ()                                       \
{                                                                       \
  if (!scfWeakRefOwners) return;                                        \
  for (int i = 0 ; i < scfWeakRefOwners->Length () ; i++)               \
  {                                                                     \
    iBase** p = (*scfWeakRefOwners)[i];                                 \
    *p = 0;                                                             \
  }                                                                     \
  delete scfWeakRefOwners;                                              \
  scfWeakRefOwners = 0;                                                 \
}
The SCF_IMPLEMENT_IBASE_REMOVE_REF_OWNERS() macro implements the scfRemoveRefOwners() method for a class in a C++ source module.

Typically, this macro is automatically employed by the SCF_IMPLEMENT_IBASE() convenience macro.

Definition at line 229 of file scf.h.

#define SCF_IMPLEMENTS_EMBEDDED_INTERFACE Interface       SCF_IMPLEMENTS_INTERFACE_COMMON (Interface, (&scf##Interface))
 

IMPLEMENT_EMBEDDED_INTERFACE is same as IMPLEMENT_INTERFACE but is used when class implements the interface as an embedded member.

Definition at line 421 of file scf.h.

#define SCF_IMPLEMENTS_INTERFACE Interface   
 

Value:

csRefTrackerAccess::AddAlias (CS_STATIC_CAST(Interface*, this), this);\
  SCF_IMPLEMENTS_INTERFACE_COMMON (Interface, this)
The IMPLEMENT_INTERFACE macro is used inside QueryInterface function to check if user requested a specific interface, whenever requested version of the interface correspond to the version we have and to return a pointer to that interface if everything is correct.

Definition at line 413 of file scf.h.

#define SCF_IMPLEMENTS_INTERFACE_COMMON Interface,
Object   
 

Value:

static scfInterfaceID Interface##_scfID = (scfInterfaceID)-1;           \
  if (Interface##_scfID == (scfInterfaceID)-1)                          \
    Interface##_scfID = iSCF::SCF->GetInterfaceID (#Interface);         \
  if (iInterfaceID == Interface##_scfID &&                              \
    scfCompatibleVersion (iVersion, scfInterface<Interface>::GetVersion())) \
  {                                                                     \
    (Object)->IncRef ();                                                \
    return CS_STATIC_CAST(Interface*, Object);                          \
  }
This is a common macro used in all IMPLEMENTS_XXX_INTERFACE macros.

Definition at line 427 of file scf.h.

#define SCF_PRINT_CALL_ADDRESS
 

Macro for getting the address we were called from (stack backtracing).

This works ONLY For GCC >= 2.8.0

Definition at line 65 of file scf.h.

#define SCF_QUERY_INTERFACE Object,
Interface   
 

Value:

csPtr<Interface> ((Interface *)(Object)->QueryInterface (               \
  scfInterface<Interface>::GetID (), scfInterface<Interface>::GetVersion()))
Shortcut macro to query given interface from given object.

This is a wrapper around iBase::QueryInterface method.

Definition at line 816 of file scf.h.

#define SCF_QUERY_INTERFACE_SAFE Object,
Interface   
 

Value:

csPtr<Interface> ((Interface *)(iBase::QueryInterfaceSafe ((Object),    \
  scfInterface<Interface>::GetID (), scfInterface<Interface>::GetVersion())))
Shortcut macro to query given interface from given object.

This is a wrapper around iBase::QueryInterface method. This version tests if Object is 0 and will return 0 in that case.

Definition at line 825 of file scf.h.

#define SCF_REGISTER_FACTORY_FUNC Class   
 

Value:

CS_EXPORTED_FUNCTION void* CS_EXPORTED_NAME(Class,_Create)(iBase*);     \
  class Class##_StaticInit                                              \
  {                                                                     \
  public:                                                               \
    Class##_StaticInit()                                                \
    {                                                                   \
      scfInitialize(0);                                                 \
      iSCF::SCF->RegisterFactoryFunc(CS_EXPORTED_NAME(Class,_Create),#Class); \
    }                                                                   \
  } Class##_static_init__;
Used in conjunction with SCF_REGISTER_STATIC_LIBRARY to ensure that a reference to the class(s) registered via SCF_REGISTER_STATIC_LIBRARY are actually linked into the application.

Invoke this macro once for each <implementation> mentioned in the MetaInfo registered with SCF_REGISTER_STATIC_LIBRARY. Invocations of this macro must appear after the the invocation of SCF_REGISTER_STATIC_LIBRARY.

Definition at line 674 of file scf.h.

#define SCF_REGISTER_STATIC_CLASS Class,
Ident,
Desc,
Dep   
 

Value:

CS_EXPORTED_FUNCTION void* CS_EXPORTED_NAME(Class,_Create)(iBase*);     \
  class Class##_StaticInit__                                            \
  {                                                                     \
  public:                                                               \
    Class##_StaticInit__()                                              \
    {                                                                   \
      scfInitialize(0);                                                 \
      iSCF::SCF->RegisterClass(                                         \
        CS_EXPORTED_NAME(Class,_Create), Ident, Desc, Dep,              \
        SCF_STATIC_CLASS_CONTEXT);                                      \
    }                                                                   \
  } Class##_static_init__;
Automatically register a built-in class with SCF during startup.

When SCF classes are statically linked (vs dynamic linking) they should be referenced from somewhere inside your program, otherwise the static libraries won't be linked into the static executable. This macro defines a dummy variable that registers the class during initialization and ensures that it gets linked into the program

Definition at line 637 of file scf.h.

#define SCF_REGISTER_STATIC_LIBRARY Module,
MetaInfo   
 

Value:

class Module##_StaticInit                                               \
  {                                                                     \
  public:                                                               \
    Module##_StaticInit()                                               \
    {                                                                   \
      scfInitialize(0);                                                 \
      iSCF::SCF->RegisterClasses(MetaInfo, SCF_STATIC_CLASS_CONTEXT);   \
    }                                                                   \
  } Module##_static_init__;
Automatically register a static library with SCF during startup.

Employ this macro along with one or more invocations of SCF_REGISTER_FACTORY_FUNC.

Definition at line 655 of file scf.h.

#define SCF_TRACE  
 

Macro for typing debug strings: Add define SCF_DEBUG at the top of modules you want to track miscelaneous SCF activity and recompile.

Definition at line 54 of file scf.h.

#define SCF_VERSION Name,
Major,
Minor,
Micro   
 

Value:

struct Name;                                                            \
CS_SPECIALIZE_TEMPLATE                                                  \
class scfInterface<Name>                                                \
{                                                                       \
public:                                                                 \
  static int GetVersion()                                               \
  {                                                                     \
    return SCF_CONSTRUCT_VERSION(Major, Minor, Micro);                  \
  }                                                                     \
  static scfInterfaceID GetID()                                         \
  {                                                                     \
    static scfInterfaceID ID = (scfInterfaceID)-1;                      \
    if (ID == (scfInterfaceID)(-1))                                     \
      ID = iSCF::SCF->GetInterfaceID(#Name);                            \
    return ID;                                                          \
  }                                                                     \
  static char const* GetName()                                          \
  {                                                                     \
    return #Name;                                                       \
  }                                                                     \
};
SCF_VERSION can be used to define an interface's version number; you should specify interface name and major, minor and micro version components.

This way:

 SCF_VERSION (iSomething, 0, 0, 1);
 struct iSomething : public iBase
 {
   ...
 };
 

Definition at line 744 of file scf.h.


Typedef Documentation

typedef void*(* scfFactoryFunc)(iBase*)
 

Type of factory function which creates an instance of an SCF class.

Definition at line 721 of file scf.h.

typedef unsigned long scfInterfaceID
 

Type of registered interface handle used by iBase::QueryInterface().

Definition at line 41 of file scf.h.

Referenced by scfInterface< T >::GetID(), and iBase::QueryInterfaceSafe().


Function Documentation

bool scfCompatibleVersion int    iVersion,
int    iItfVersion
[inline, static]
 

This function checks whenever an interface is compatible with given version.

SCF uses the following comparison criteria: if the major version numbers are equal and required minor and micro version is less or equal than target version minor and micro numbers, the versions are considered compatible.

Definition at line 856 of file scf.h.

void scfInitialize int    argc,
const char *const    argv[]
 

This function should be called to initialize client SCF library.

It uses the default plugin paths provided by csGetPluginPaths().

void scfInitialize csPluginPaths   pluginPaths
 

This function should be called to initialize client SCF library.

If a number of plugin paths are provided, the directories will be scanned for plugins and their SCF-related registry data will be retrieved. The root node within the registry data document should be named "plugin", and the SCF-related information should be in a child node of the root named "scf". It is legal to call scfInitialize more than once (possibly providing a different set of directories each time).

Parameters:
pluginPaths  Directories that will be scanned for plugins. If this parameter is 0, the paths returned by csGetPluginPaths() will be scanned.
Remarks:
The path list is ignored for static builds.


Generated for Crystal Space by doxygen 1.2.18