prj/cam/libsrc/script/scrptsrv.h

   1 /*
   2 @Copyright Looking Glass Studios, Inc.
   3 1996,1997,1998,1999,2000 Unpublished Work.
   4 */
   5
   6 ///////////////////////////////////////////////////////////////////////////////
   7 // $Header: r:/t2repos/thief2/libsrc/script/scrptsrv.h,v 1.5 1997/12/31 12:33:53 TOML Exp $
   8 //
   9 //
  10 //
  11
  12 #ifndef __SCRPTSRV_H
  13 #define __SCRPTSRV_H
  14
  15 #include <dynarray.h>
  16
  17 ///////////////////////////////////////////////////////////////////////////////
  18 //
  19 // Macros to build a script service
  20 //
  21 // Steps to defining your own script service:
  22 //
  23 // A script interface is similar to a COM interface, with the following
  24 // differences
  25 //
  26 //    1) it cannot only be called from a script
  27 //    2) arguments and return values must be of one of the base types in scrptbas.h,
  28 //       or a cMultiParm
  29 //    3) Script functions by convention are always mixed-case style
  30 //    4) In declarations of service methods, omit "THIS"
  31 //    5) Implementations must derive from interface & implement using macros
  32 //
  33 // Note: because passive linking is used here, services in libraries may
  34 // not get linked in if the service is the only thing in the module.
  35
  36 #undef INTERFACE
  37
  38 DECLARE_INTERFACE_(IAutoScriptService, IUnknown)
  39 {
  40    STDMETHOD_(void, Init)() PURE;
  41    STDMETHOD_(void, End)() PURE;
  42 };
  43
  44 #define DECLARE_SCRIPT_SERVICE_(iface_root) \
  45    DECLARE_INTERFACE_( I##iface_root##ScriptService, IAutoScriptService)
  46
  47 #ifdef SCRIPT_MAIN_MODULE
  48
  49    #define DECLARE_SCRIPT_SERVICE(iface_root, lgiid) \
  50       F_DECLARE_INTERFACE( I##iface_root##ScriptService); \
  51       DEFINE_LG_GUID_UNCONDITIONAL(IID_I##iface_root##ScriptService, lgiid); \
  52       extern IScriptMan * g_pScriptMan; \
  53       I##iface_root##ScriptService & iface_root = *((I##iface_root##ScriptService *)g_pScriptMan->GetService(&IID_I##iface_root##ScriptService)); \
  54       class c##iface_root##ServiceReleaser \
  55       { \
  56       public: \
  57          c##iface_root##ServiceReleaser() \
  58          { \
  59             ((IUnknown *)(&iface_root))->Release(); \
  60          } \
  61       } _g_##iface_root##ServiceReleaser; \
  62       DECLARE_SCRIPT_SERVICE_(iface_root)
  63
  64 #else
  65
  66    #define DECLARE_SCRIPT_SERVICE(iface_root, lgiid) \
  67       F_DECLARE_INTERFACE( I##iface_root##ScriptService); \
  68       const int kIID_I##iface_root##ScriptService = lgiid; \
  69       DECLARE_SCRIPT_SERVICE_(iface_root)
  70
  71 #endif
  72
  73 template <class INTERFACE, const GUID * pIID_INTERFACE>
  74 class cScriptServiceImplBase : public cCTUnaggregated<INTERFACE, pIID_INTERFACE, kCTU_NoSelfDelete>
  75 {
  76    STDMETHOD_(void, Init)()
  77    {
  78    }
  79
  80    STDMETHOD_(void, End)()
  81    {
  82    }
  83 };
  84
  85 #define DECLARE_SCRIPT_SERVICE_IMPL(impl, iface_root) \
  86    class impl : public cScriptServiceImplBase<I##iface_root##ScriptService, &IID_I##iface_root##ScriptService>
  87
  88 #define IMPLEMENT_SCRIPT_SERVICE_IMPL(impl, iface_root) \
  89    DEFINE_LG_GUID_UNCONDITIONAL(IID_I##iface_root##ScriptService, kIID_I##iface_root##ScriptService); \
  90    impl g_##impl##ScriptService; \
  91    sScrSrvRegData g_##impl##ScrSrvRegData(&g_##impl##ScriptService, &IID_I##iface_root##ScriptService)
  92
  93 struct sScrSrvRegData;
  94
  95 extern cDynArray<sScrSrvRegData *> g_ScrSrvRegData;
  96
  97 struct sScrSrvRegData
  98 {
  99    sScrSrvRegData(IAutoScriptService * pService, const GUID * pGuid)
 100     : pService(pService), pGuid(pGuid)
 101    {
 102       g_ScrSrvRegData.Append(this);
 103    }
 104
 105    IAutoScriptService * pService;
 106    const GUID *         pGuid;
 107 };
 108
 109 ///////////////////////////////////////////////////////////////////////////////
 110
 111 #endif /* !__SCRPTSRV_H */