reactos/lib/ole32/compobj_private.h

   1 /*
   2  * Copyright 1995 Martin von Loewis
   3  * Copyright 1998 Justin Bradford
   4  * Copyright 1999 Francis Beaudet
   5  * Copyright 1999 Sylvain St-Germain
   6  * Copyright 2002 Marcus Meissner
   7  * Copyright 2003 Ove Kåven, TransGaming Technologies
   8  * Copyright 2004 Mike Hearn, Rob Shearman, CodeWeavers Inc
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #ifndef __WINE_OLE_COMPOBJ_H
  26 #define __WINE_OLE_COMPOBJ_H
  27
  28 /* All private prototype functions used by OLE will be added to this header file */
  29
  30 #include <stdarg.h>
  31
  32 #include "wine/list.h"
  33
  34 #include "windef.h"
  35 #include "winbase.h"
  36 #include "wtypes.h"
  37 #include "dcom.h"
  38 #include "winreg.h"
  39 #include "winternl.h"
  40
  41 struct apartment;
  42 typedef struct apartment APARTMENT;
  43
  44 /* Thread-safety Annotation Legend:
  45  *
  46  * RO    - The value is read only. It never changes after creation, so no
  47  *         locking is required.
  48  * LOCK  - The value is written to only using Interlocked* functions.
  49  * CS    - The value is read or written to inside a critical section.
  50  *         The identifier following "CS" is the specific critical setion that
  51  *         must be used.
  52  * MUTEX - The value is read or written to with a mutex held.
  53  *         The identifier following "MUTEX" is the specific mutex that
  54  *         must be used.
  55  */
  56
  57 typedef enum ifstub_state
  58 {
  59     STUBSTATE_NORMAL_MARSHALED,
  60     STUBSTATE_NORMAL_UNMARSHALED,
  61     STUBSTATE_TABLE_WEAK_MARSHALED,
  62     STUBSTATE_TABLE_WEAK_UNMARSHALED,
  63     STUBSTATE_TABLE_STRONG,
  64 } STUB_STATE;
  65
  66 /* an interface stub */
  67 struct ifstub
  68 {
  69     struct list       entry;      /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
  70     IRpcStubBuffer   *stubbuffer; /* RO */
  71     IID               iid;        /* RO */
  72     IPID              ipid;       /* RO */
  73     IUnknown         *iface;      /* RO */
  74     MSHLFLAGS         flags;      /* so we can enforce process-local marshalling rules (RO) */
  75 };
  76
  77
  78 /* stub managers hold refs on the object and each interface stub */
  79 struct stub_manager
  80 {
  81     struct list       entry;      /* entry in apartment stubmgr list (CS apt->cs) */
  82     struct list       ifstubs;    /* list of active ifstubs for the object (CS lock) */
  83     CRITICAL_SECTION  lock;
  84     APARTMENT        *apt;        /* owning apt (RO) */
  85
  86     ULONG             extrefs;    /* number of 'external' references (CS lock) */
  87     ULONG             refs;       /* internal reference count (CS apt->cs) */
  88     OID               oid;        /* apartment-scoped unique identifier (RO) */
  89     IUnknown         *object;     /* the object we are managing the stub for (RO) */
  90     ULONG             next_ipid;  /* currently unused (LOCK) */
  91
  92     /* We need to keep a count of the outstanding marshals, so we can enforce the
  93      * marshalling rules (ie, you can only unmarshal normal marshals once). Note
  94      * that these counts do NOT include unmarshalled interfaces, once a stream is
  95      * unmarshalled and a proxy set up, this count is decremented.
  96      */
  97
  98     ULONG             norm_refs;  /* refcount of normal marshals (CS lock) */
  99 };
 100
 101 /* imported interface proxy */
 102 struct ifproxy
 103 {
 104   struct list entry;       /* entry in proxy_manager list (CS parent->cs) */
 105   struct proxy_manager *parent; /* owning proxy_manager (RO) */
 106   LPVOID iface;            /* interface pointer (RO) */
 107   STDOBJREF stdobjref;     /* marshal data that represents this object (RO) */
 108   IID iid;                 /* interface ID (RO) */
 109   LPRPCPROXYBUFFER proxy;  /* interface proxy (RO) */
 110   DWORD refs;              /* imported (public) references (MUTEX parent->remoting_mutex) */
 111   IRpcChannelBuffer *chan; /* channel to object (CS parent->cs) */
 112 };
 113
 114 /* imported object / proxy manager */
 115 struct proxy_manager
 116 {
 117   const IMultiQIVtbl *lpVtbl;
 118   const IMarshalVtbl *lpVtblMarshal;
 119   struct apartment *parent; /* owning apartment (RO) */
 120   struct list entry;        /* entry in apartment (CS parent->cs) */
 121   OXID oxid;                /* object exported ID (RO) */
 122   OID oid;                  /* object ID (RO) */
 123   struct list interfaces;   /* imported interfaces (CS cs) */
 124   LONG refs;                /* proxy reference count (LOCK) */
 125   CRITICAL_SECTION cs;      /* thread safety for this object and children */
 126   ULONG sorflags;           /* STDOBJREF flags (RO) */
 127   IRemUnknown *remunk;      /* proxy to IRemUnknown used for lifecycle management (CS cs) */
 128   HANDLE remoting_mutex;    /* mutex used for synchronizing access to IRemUnknown */
 129 };
 130
 131 /* this needs to become a COM object that implements IRemUnknown */
 132 struct apartment
 133 {
 134   struct list entry;
 135
 136   LONG  refs;              /* refcount of the apartment (LOCK) */
 137   DWORD model;             /* threading model (RO) */
 138   DWORD tid;               /* thread id (RO) */
 139   OXID oxid;               /* object exporter ID (RO) */
 140   LONG ipidc;              /* interface pointer ID counter, starts at 1 (LOCK) */
 141   HWND win;                /* message window (RO) */
 142   CRITICAL_SECTION cs;     /* thread safety */
 143   LPMESSAGEFILTER filter;  /* message filter (CS cs) */
 144   struct list proxies;     /* imported objects (CS cs) */
 145   struct list stubmgrs;    /* stub managers for exported objects (CS cs) */
 146   BOOL remunk_exported;    /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
 147   LONG remoting_started;   /* has the RPC system been started for this apartment? (LOCK) */
 148
 149   /* FIXME: OID's should be given out by RPCSS */
 150   OID oidc;                /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
 151 };
 152
 153 /* this is what is stored in TEB->ReservedForOle */
 154 struct oletls
 155 {
 156     struct apartment *apt;
 157     IErrorInfo       *errorinfo;   /* see errorinfo.c */
 158     IUnknown         *state;       /* see CoSetState */
 159     DWORD            inits;        /* number of times CoInitializeEx called */
 160 };
 161
 162
 163 /* Global Interface Table Functions */
 164
 165 extern void* StdGlobalInterfaceTable_Construct(void);
 166 extern void  StdGlobalInterfaceTable_Destroy(void* self);
 167 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv);
 168 extern void* StdGlobalInterfaceTableInstance;
 169
 170 /* FIXME: these shouldn't be needed, except for 16-bit functions */
 171 extern HRESULT WINE_StringFromCLSID(const CLSID *id,LPSTR idstr);
 172 HRESULT WINAPI __CLSIDFromStringA(LPCSTR idstr, CLSID *id);
 173
 174 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key);
 175 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv);
 176
 177 /* Stub Manager */
 178
 179 ULONG stub_manager_int_addref(struct stub_manager *This);
 180 ULONG stub_manager_int_release(struct stub_manager *This);
 181 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object);
 182 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs);
 183 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs);
 184 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, MSHLFLAGS flags);
 185 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags);
 186 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid);
 187 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object);
 188 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid);
 189 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid);
 190 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid);
 191 HRESULT ipid_to_stub_manager(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **stubmgr_ret);
 192 IRpcStubBuffer *ipid_to_apt_and_stubbuffer(const IPID *ipid, APARTMENT **stub_apt);
 193 HRESULT start_apartment_remote_unknown(void);
 194
 195 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, MSHLFLAGS mshlflags);
 196
 197 /* RPC Backend */
 198
 199 struct dispatch_params;
 200
 201 void    RPC_StartRemoting(struct apartment *apt);
 202 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid, IRpcChannelBuffer **pipebuf);
 203 void    RPC_ExecuteCall(struct dispatch_params *params);
 204 HRESULT RPC_RegisterInterface(REFIID riid);
 205 void    RPC_UnregisterInterface(REFIID riid);
 206 void    RPC_StartLocalServer(REFCLSID clsid, IStream *stream);
 207 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv);
 208
 209 /* This function initialize the Running Object Table */
 210 HRESULT WINAPI RunningObjectTableImpl_Initialize(void);
 211
 212 /* This function uninitialize the Running Object Table */
 213 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void);
 214
 215 /* This function decomposes a String path to a String Table containing all the elements ("\" or "subDirectory" or "Directory" or "FileName") of the path */
 216 int FileMonikerImpl_DecomposePath(LPCOLESTR str, LPOLESTR** stringTable);
 217
 218
 219 /* Apartment Functions */
 220
 221 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref);
 222 APARTMENT *apartment_findfromtid(DWORD tid);
 223 DWORD apartment_addref(struct apartment *apt);
 224 DWORD apartment_release(struct apartment *apt);
 225 HRESULT apartment_disconnectproxies(struct apartment *apt);
 226 void apartment_disconnectobject(struct apartment *apt, void *object);
 227 static inline HRESULT apartment_getoxid(struct apartment *apt, OXID *oxid)
 228 {
 229     *oxid = apt->oxid;
 230     return S_OK;
 231 }
 232
 233
 234 /* DCOM messages used by the apartment window (not compatible with native) */
 235 #define DM_EXECUTERPC   (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
 236
 237 /*
 238  * Per-thread values are stored in the TEB on offset 0xF80,
 239  * see http://www.microsoft.com/msj/1099/bugslayer/bugslayer1099.htm
 240  */
 241
 242 /* will create if necessary */
 243 static inline struct oletls *COM_CurrentInfo(void)
 244 {
 245     if (!NtCurrentTeb()->ReservedForOle)
 246         NtCurrentTeb()->ReservedForOle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct oletls));
 247
 248     return NtCurrentTeb()->ReservedForOle;
 249 }
 250
 251 static inline APARTMENT* COM_CurrentApt(void)
 252 {
 253     return COM_CurrentInfo()->apt;
 254 }
 255
 256 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
 257
 258 /* helpers for debugging */
 259 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
 260 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
 261
 262 extern HINSTANCE OLE32_hInstance; /* FIXME: make static */
 263
 264 #define CHARS_IN_GUID 39 /* including NULL */
 265
 266 /* Exported non-interface Data Advise Holder functions */
 267 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate);
 268 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface);
 269
 270 #endif /* __WINE_OLE_COMPOBJ_H */