Enter your search terms GNU-Darwin Web Submit search form

scf.h /* Crystal Space Shared Class Facility (SCF) Copyright (C) 1999 by Andrew Zabolotny This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; if not, write to the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. */ #ifndef __CSSCF_H__ #define __CSSCF_H__ /* PLEASE USE 8-SPACE TAB WIDTH WHEN EDITING THIS FILE! */ typedef uint32 scfInterfaceID; #ifdef SCF_DEBUG # define SCF_TRACE(x) \ { \ printf ("SCF [%s:%d]:\n", __FILE__, __LINE__); \ printf x; SCF_PRINT_CALL_ADDRESS \ } #else # define SCF_TRACE(x) #endif #if (__GNUC__ >= 2) && (__GNUC_MINOR__ >= 8) # define SCF_PRINT_CALL_ADDRESS \ printf (" Called from address %p\n", __builtin_return_address (0)); #else # define SCF_PRINT_CALL_ADDRESS #endif #define SCF_CONSTRUCT_VERSION(Major,Minor,Micro) \ ((Major << 24) | (Minor << 16) | Micro) #define SCF_VERSION(Name,Major,Minor,Micro) \ const int VERSION_##Name = SCF_CONSTRUCT_VERSION (Major, Minor, Micro) SCF_VERSION (iBase, 0, 1, 0); struct iBase { virtual void IncRef () = 0; virtual void DecRef () = 0; virtual int GetRefCount () = 0; virtual void *QueryInterface (scfInterfaceID iInterfaceID, int iVersion) = 0; static void* QueryInterfaceSafe (iBase* ibase, scfInterfaceID iInterfaceID, int iVersion) { if (ibase == NULL) return NULL; else return ibase->QueryInterface (iInterfaceID, iVersion); } }; #define SCF_INC_REF(ptr) {if (ptr) {ptr->IncRef();}} #define SCF_DEC_REF(ptr) {if (ptr) {ptr->DecRef();}} #define SCF_SET_REF(var,ref) \ { \ if (ref) ref->IncRef (); \ if (var) var->DecRef (); \ var = ref; \ } #define SCF_DECLARE_IBASE \ int scfRefCount; /* Reference counter */ \ SCF_DECLARE_EMBEDDED_IBASE (iBase) #define SCF_DECLARE_EMBEDDED_IBASE(OuterClass) \ public: \ OuterClass *scfParent; /* The parent object */ \ virtual void IncRef (); \ virtual void DecRef (); \ virtual int GetRefCount (); \ virtual void *QueryInterface (scfInterfaceID iInterfaceID, int iVersion) #define SCF_CONSTRUCT_IBASE(Parent) \ scfRefCount = 1; scfParent = Parent; if (scfParent) scfParent->IncRef(); #define SCF_CONSTRUCT_EMBEDDED_IBASE(Interface) \ Interface.scfParent = this; #define SCF_IMPLEMENT_IBASE_INCREF(Class) \ void Class::IncRef () \ { \ SCF_TRACE ((" (%s *)%p->IncRef (%d)\n", #Class, this, scfRefCount + 1));\ scfRefCount++; \ } #define SCF_IMPLEMENT_IBASE_DECREF(Class) \ void Class::DecRef () \ { \ scfRefCount--; \ if (scfRefCount <= 0) \ { \ SCF_TRACE ((" delete (%s *)%p\n", #Class, this)); \ if (scfParent) \ scfParent->DecRef (); \ delete this; \ } \ else \ SCF_TRACE ((" (%s *)%p->DecRef (%d)\n", #Class, this, scfRefCount));\ } #define SCF_IMPLEMENT_IBASE_GETREFCOUNT(Class) \ int Class::GetRefCount () \ { \ return scfRefCount; \ } #define SCF_IMPLEMENT_IBASE_QUERY(Class) \ void *Class::QueryInterface (scfInterfaceID iInterfaceID, int iVersion) \ { \ SCF_TRACE ((" (%s *)%p->QueryInterface (%u, %08X)\n", \ #Class, this, iInterfaceID, iVersion)); #define SCF_IMPLEMENT_IBASE_QUERY_END \ return scfParent ? \ scfParent->QueryInterface (iInterfaceID, iVersion) : NULL; \ } #define SCF_IMPLEMENT_IBASE(Class) \ SCF_IMPLEMENT_IBASE_INCREF(Class) \ SCF_IMPLEMENT_IBASE_DECREF(Class) \ SCF_IMPLEMENT_IBASE_GETREFCOUNT(Class) \ SCF_IMPLEMENT_IBASE_QUERY(Class) #define SCF_IMPLEMENT_IBASE_END \ SCF_IMPLEMENT_IBASE_QUERY_END #define SCF_IMPLEMENT_EMBEDDED_IBASE_INCREF(Class) \ void Class::IncRef () \ { \ SCF_TRACE ((" (%s *)%p->IncRef (%d)\n", #Class, this, \ scfParent->GetRefCount () + 1)); \ scfParent->IncRef (); \ } #define SCF_IMPLEMENT_EMBEDDED_IBASE_DECREF(Class) \ void Class::DecRef () \ { \ SCF_TRACE ((" (%s *)%p->DecRef (%d)\n", #Class, this, \ scfParent->GetRefCount ()-1)); \ scfParent->DecRef (); \ } #define SCF_IMPLEMENT_EMBEDDED_IBASE_GETREFCOUNT(Class) \ int Class::GetRefCount () \ { \ return scfParent->GetRefCount (); \ } #define SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY(Class) \ void *Class::QueryInterface (scfInterfaceID iInterfaceID, int iVersion) \ { \ SCF_TRACE ((" (%s *)%p->QueryInterface (%u, %08X)\n", \ #Class, this, iInterfaceID, iVersion)); #define SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END \ return scfParent->QueryInterface (iInterfaceID, iVersion); \ } #define SCF_IMPLEMENT_EMBEDDED_IBASE(Class) \ SCF_IMPLEMENT_EMBEDDED_IBASE_INCREF(Class) \ SCF_IMPLEMENT_EMBEDDED_IBASE_DECREF(Class) \ SCF_IMPLEMENT_EMBEDDED_IBASE_GETREFCOUNT(Class) \ SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY(Class) #define SCF_IMPLEMENT_EMBEDDED_IBASE_END \ SCF_IMPLEMENT_EMBEDDED_IBASE_QUERY_END #define SCF_IMPLEMENTS_INTERFACE(Interface) \ SCF_IMPLEMENTS_INTERFACE_COMMON (Interface, this) #define SCF_IMPLEMENTS_EMBEDDED_INTERFACE(Interface) \ SCF_IMPLEMENTS_INTERFACE_COMMON (Interface, (&scf##Interface)) #define SCF_IMPLEMENTS_INTERFACE_COMMON(Interface,Object) \ static scfInterfaceID scfID_##Interface = (scfInterfaceID)-1; \ if (scfID_##Interface == (scfInterfaceID)-1) \ scfID_##Interface = iSCF::SCF->GetInterfaceID (#Interface); \ if (iInterfaceID == scfID_##Interface && \ scfCompatibleVersion (iVersion, VERSION_##Interface)) \ { \ (Object)->IncRef (); \ return STATIC_CAST(Interface*, Object); \ } #define SCF_DECLARE_IBASE_EXT(ParentClass) \ typedef ParentClass __scf_superclass; \ virtual void IncRef (); \ virtual void DecRef (); \ virtual int GetRefCount (); \ virtual void *QueryInterface (scfInterfaceID iInterfaceID, int iVersion) #define SCF_IMPLEMENT_IBASE_EXT_INCREF(Class) \ void Class::IncRef () \ { \ __scf_superclass::IncRef (); \ } #define SCF_IMPLEMENT_IBASE_EXT_DECREF(Class) \ void Class::DecRef () \ { \ __scf_superclass::DecRef (); \ } #define SCF_IMPLEMENT_IBASE_EXT_GETREFCOUNT(Class) \ int Class::GetRefCount () \ { \ return __scf_superclass::GetRefCount (); \ } #define SCF_IMPLEMENT_IBASE_EXT_QUERY(Class) \ void *Class::QueryInterface (scfInterfaceID iInterfaceID, int iVersion) \ { #define SCF_IMPLEMENT_IBASE_EXT_QUERY_END \ return __scf_superclass::QueryInterface (iInterfaceID, iVersion); \ } #define SCF_IMPLEMENT_IBASE_EXT(Class) \ SCF_IMPLEMENT_IBASE_EXT_INCREF(Class) \ SCF_IMPLEMENT_IBASE_EXT_DECREF(Class) \ SCF_IMPLEMENT_IBASE_EXT_GETREFCOUNT(Class) \ SCF_IMPLEMENT_IBASE_EXT_QUERY(Class) #define SCF_IMPLEMENT_IBASE_EXT_END \ SCF_IMPLEMENT_IBASE_EXT_QUERY_END #define SCF_IMPLEMENT_FACTORY(Class) \ void *Create_##Class (iBase *iParent) \ { \ void *ret = new Class (iParent); \ SCF_TRACE ((" %p = new %s ()\n", ret, #Class)); \ return ret; \ } #define SCF_DECLARE_FACTORY(Class) void *Create_##Class (iBase *iParent); struct scfClassInfo { char *ClassID; char *Description; char *Dependencies; void *(*Factory) (iBase *iParent); }; /* * The following set of macros are used to define the table that contains * information about all classes exported from a shared library. This table * is used with both static and dynamic class linking. */ // extern CS_DECLARE_STATIC_VARIABLE_CLEANUP #define SCF_EXPORT_CLASS_TABLE(LibraryName) \ CS_DECLARE_STATIC_VARIABLE_CLEANUP \ CS_EXPORTED_FUNCTION void \ CS_EXPORTED_NAME(LibraryName,_scfFinalize)() \ { CS_STATIC_VARIABLE_CLEANUP } \ static inline void \ CS_EXPORTED_NAME(LibraryName,_scfUnitInitialize)(iSCF *SCF) \ { iSCF::SCF = SCF; } \ CS_EXPORTED_FUNCTION scfClassInfo* \ CS_EXPORTED_NAME(LibraryName,_scfInitialize)(iSCF *SCF) \ { \ CS_EXPORTED_NAME(LibraryName,_scfUnitInitialize)(SCF); \ static scfClassInfo ExportClassTable [] = \ { #define SCF_EXPORT_CLASS(Class, ClassID, Description) \ { ClassID, Description, NULL, Create_##Class }, #define SCF_EXPORT_CLASS_DEP(Class, ClassID, Description, Dependencies) \ { ClassID, Description, Dependencies, Create_##Class }, #define SCF_EXPORT_CLASS_TABLE_END \ { 0, 0, 0, 0 } \ }; \ return ExportClassTable; \ } #define SCF_REGISTER_STATIC_LIBRARY(LibraryName) \ extern "C" scfClassInfo *LibraryName##_scfInitialize (iSCF*); \ class __##LibraryName##_Init \ { \ public: \ __##LibraryName##_Init () \ { if (!iSCF::SCF) scfInitialize (); \ iSCF::SCF->RegisterClassList(LibraryName##_scfInitialize(iSCF::SCF)); }\ } __##LibraryName##_dummy; #define SCF_REGISTER_STATIC_CLASS(Class,ClassID,Description) \ SCF_REGISTER_STATIC_CLASS_DEP (Class,ClassID,Description,NULL); #define SCF_REGISTER_STATIC_CLASS_DEP(Class,ClassID,Description,Dependency)\ extern void *Create_##Class (iBase *); \ static scfClassInfo Class##_ClassInfo = \ { ClassID, Description, Dependency, Create_##Class }; \ class __##Class##_Init \ { \ public: \ __##Class##_Init () \ { if (!iSCF::SCF) scfInitialize (); \ iSCF::SCF->RegisterStaticClass (&Class##_ClassInfo); } \ } __##Class##_dummy; //--------------------------------------------- Class factory interface -----// SCF_VERSION (iFactory, 0, 0, 1); struct iFactory : public iBase { virtual void *CreateInstance () = 0; virtual void TryUnload () = 0; virtual const char *QueryDescription () = 0; virtual const char *QueryDependencies () = 0; virtual const char *QueryClassID () = 0; }; //----------------------------------------------- Client-side functions -----// struct iConfigFile; struct iStrVector; #define SCF_DECLARE_FAST_INTERFACE(Interface) \ inline static scfInterfaceID scfGetID_##Interface () \ { \ static scfInterfaceID ID = (scfInterfaceID)-1; \ if (ID == (scfInterfaceID)(-1)) \ ID = iSCF::SCF->GetInterfaceID (#Interface); \ return ID; \ } #define SCF_CREATE_INSTANCE(ClassID,Interface) \ (Interface *)iSCF::SCF->CreateInstance ( \ ClassID, #Interface, VERSION_##Interface) #define SCF_QUERY_INTERFACE(Object,Interface) \ (Interface *)(Object)->QueryInterface ( \ iSCF::SCF->GetInterfaceID (#Interface), VERSION_##Interface) #define SCF_QUERY_INTERFACE_FAST(Object,Interface) \ (Interface*)(Object)->QueryInterface ( \ scfGetID_##Interface (), VERSION_##Interface) #define SCF_QUERY_INTERFACE_SAFE(Object,Interface) \ (Interface *)(iBase::QueryInterfaceSafe ((Object), \ iSCF::SCF->GetInterfaceID (#Interface), VERSION_##Interface)) extern void scfInitialize (iConfigFile *iConfig = 0); static inline bool scfCompatibleVersion (int iVersion, int iItfVersion) { return ((iVersion & 0xff000000) == (iItfVersion & 0xff000000)) && ((iVersion & 0x00ffffff) <= (iItfVersion & 0x00ffffff)); } #ifdef CS_DEBUG struct iObjectRegistry; #endif SCF_VERSION (iSCF, 0, 0, 1); struct iSCF : public iBase { static iSCF *SCF; #ifdef CS_DEBUG // This is EXTREMELY dirty but I see no other solution for now. // For debugging reasons I must have a global (global over the application // and all plugins)pointer to the object registry. I have no other // global object to tag this pointer on that except for iSCF. // This pointer is only here in debug mode though. That ensures that it // cannot be misused in real code. // If you know another solution for this problem? This global pointer // will be used by csDebuggingGraph in csutil. iObjectRegistry* object_reg; #endif virtual void RegisterConfigClassList (iConfigFile *Config) = 0; virtual bool ClassRegistered (const char *iClassID) = 0; virtual void *CreateInstance (const char *iClassID, const char *iInterface, int iVersion) = 0; virtual const char *GetClassDescription (const char *iClassID) = 0; virtual const char *GetClassDependencies (const char *iClassID) = 0; virtual void UnloadUnusedModules () = 0; virtual bool RegisterClass (const char *iClassID, const char *iLibraryName, const char *Dependencies = NULL) = 0; virtual bool RegisterStaticClass (scfClassInfo *iClassInfo) = 0; virtual bool RegisterClassList (scfClassInfo *iClassInfo) = 0; virtual bool UnregisterClass (const char *iClassID) = 0; virtual scfInterfaceID GetInterfaceID (const char *iInterface) = 0; virtual void Finish () = 0; virtual iStrVector* QueryClassList (char const* pattern) = 0; }; #endif // __CSSCF_H__ Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000