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
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.
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.
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
25 #ifndef __WINE_OLE_COMPOBJ_H
26 #define __WINE_OLE_COMPOBJ_H
28 /* All private prototype functions used by OLE will be added to this header file */
32 #include "wine/list.h"
42 typedef struct apartment APARTMENT;
44 /* Thread-safety Annotation Legend:
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
52 * MUTEX - The value is read or written to with a mutex held.
53 * The identifier following "MUTEX" is the specific mutex that
57 typedef enum ifstub_state
59 STUBSTATE_NORMAL_MARSHALED,
60 STUBSTATE_NORMAL_UNMARSHALED,
61 STUBSTATE_TABLE_WEAK_MARSHALED,
62 STUBSTATE_TABLE_WEAK_UNMARSHALED,
63 STUBSTATE_TABLE_STRONG,
66 /* an interface stub */
69 struct list entry; /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
70 IRpcStubBuffer *stubbuffer; /* RO */
73 IUnknown *iface; /* RO */
74 MSHLFLAGS flags; /* so we can enforce process-local marshalling rules (RO) */
75 IRpcChannelBuffer*chan; /* channel passed to IRpcStubBuffer::Invoke (RO) */
79 /* stub managers hold refs on the object and each interface stub */
82 struct list entry; /* entry in apartment stubmgr list (CS apt->cs) */
83 struct list ifstubs; /* list of active ifstubs for the object (CS lock) */
84 CRITICAL_SECTION lock;
85 APARTMENT *apt; /* owning apt (RO) */
87 ULONG extrefs; /* number of 'external' references (CS lock) */
88 ULONG refs; /* internal reference count (CS apt->cs) */
89 OID oid; /* apartment-scoped unique identifier (RO) */
90 IUnknown *object; /* the object we are managing the stub for (RO) */
91 ULONG next_ipid; /* currently unused (LOCK) */
93 /* We need to keep a count of the outstanding marshals, so we can enforce the
94 * marshalling rules (ie, you can only unmarshal normal marshals once). Note
95 * that these counts do NOT include unmarshalled interfaces, once a stream is
96 * unmarshalled and a proxy set up, this count is decremented.
99 ULONG norm_refs; /* refcount of normal marshals (CS lock) */
102 /* imported interface proxy */
105 struct list entry; /* entry in proxy_manager list (CS parent->cs) */
106 struct proxy_manager *parent; /* owning proxy_manager (RO) */
107 LPVOID iface; /* interface pointer (RO) */
108 STDOBJREF stdobjref; /* marshal data that represents this object (RO) */
109 IID iid; /* interface ID (RO) */
110 LPRPCPROXYBUFFER proxy; /* interface proxy (RO) */
111 DWORD refs; /* imported (public) references (MUTEX parent->remoting_mutex) */
112 IRpcChannelBuffer *chan; /* channel to object (CS parent->cs) */
115 /* imported object / proxy manager */
118 const IMultiQIVtbl *lpVtbl;
119 const IMarshalVtbl *lpVtblMarshal;
120 struct apartment *parent; /* owning apartment (RO) */
121 struct list entry; /* entry in apartment (CS parent->cs) */
122 OXID oxid; /* object exported ID (RO) */
123 OID oid; /* object ID (RO) */
124 struct list interfaces; /* imported interfaces (CS cs) */
125 LONG refs; /* proxy reference count (LOCK) */
126 CRITICAL_SECTION cs; /* thread safety for this object and children */
127 ULONG sorflags; /* STDOBJREF flags (RO) */
128 IRemUnknown *remunk; /* proxy to IRemUnknown used for lifecycle management (CS cs) */
129 HANDLE remoting_mutex; /* mutex used for synchronizing access to IRemUnknown */
130 MSHCTX dest_context; /* context used for activating optimisations (LOCK) */
131 void *dest_context_data; /* reserved context value (LOCK) */
134 /* this needs to become a COM object that implements IRemUnknown */
139 LONG refs; /* refcount of the apartment (LOCK) */
140 BOOL multi_threaded; /* multi-threaded or single-threaded apartment? (RO) */
141 DWORD tid; /* thread id (RO) */
142 OXID oxid; /* object exporter ID (RO) */
143 LONG ipidc; /* interface pointer ID counter, starts at 1 (LOCK) */
144 HWND win; /* message window (LOCK) */
145 CRITICAL_SECTION cs; /* thread safety */
146 LPMESSAGEFILTER filter; /* message filter (CS cs) */
147 struct list proxies; /* imported objects (CS cs) */
148 struct list stubmgrs; /* stub managers for exported objects (CS cs) */
149 BOOL remunk_exported; /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
150 LONG remoting_started; /* has the RPC system been started for this apartment? (LOCK) */
152 /* FIXME: OID's should be given out by RPCSS */
153 OID oidc; /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
156 /* this is what is stored in TEB->ReservedForOle */
159 struct apartment *apt;
160 IErrorInfo *errorinfo; /* see errorinfo.c */
161 IUnknown *state; /* see CoSetState */
162 DWORD inits; /* number of times CoInitializeEx called */
166 /* Global Interface Table Functions */
168 extern void* StdGlobalInterfaceTable_Construct(void);
169 extern void StdGlobalInterfaceTable_Destroy(void* self);
170 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv);
171 extern void* StdGlobalInterfaceTableInstance;
173 /* FIXME: these shouldn't be needed, except for 16-bit functions */
174 extern HRESULT WINE_StringFromCLSID(const CLSID *id,LPSTR idstr);
176 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key);
177 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv);
181 ULONG stub_manager_int_addref(struct stub_manager *This);
182 ULONG stub_manager_int_release(struct stub_manager *This);
183 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object);
184 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs);
185 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs);
186 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, MSHLFLAGS flags);
187 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags);
188 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid);
189 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object);
190 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid);
191 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid);
192 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid);
193 HRESULT ipid_to_stub_manager(const IPID *ipid, APARTMENT **stub_apt, struct stub_manager **stubmgr_ret);
194 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt, IRpcStubBuffer **stub, IRpcChannelBuffer **chan);
195 HRESULT start_apartment_remote_unknown(void);
197 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, MSHLFLAGS mshlflags);
201 struct dispatch_params;
203 void RPC_StartRemoting(struct apartment *apt);
204 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
205 DWORD dest_context, void *dest_context_data,
206 IRpcChannelBuffer **chan);
207 HRESULT RPC_CreateServerChannel(IRpcChannelBuffer **chan);
208 void RPC_ExecuteCall(struct dispatch_params *params);
209 HRESULT RPC_RegisterInterface(REFIID riid);
210 void RPC_UnregisterInterface(REFIID riid);
211 void RPC_StartLocalServer(REFCLSID clsid, IStream *stream);
212 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv);
214 /* This function initialize the Running Object Table */
215 HRESULT WINAPI RunningObjectTableImpl_Initialize(void);
217 /* This function uninitialize the Running Object Table */
218 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void);
220 /* This function decomposes a String path to a String Table containing all the elements ("\" or "subDirectory" or "Directory" or "FileName") of the path */
221 int FileMonikerImpl_DecomposePath(LPCOLESTR str, LPOLESTR** stringTable);
224 /* Apartment Functions */
226 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref);
227 APARTMENT *apartment_findfromtid(DWORD tid);
228 DWORD apartment_addref(struct apartment *apt);
229 DWORD apartment_release(struct apartment *apt);
230 HRESULT apartment_disconnectproxies(struct apartment *apt);
231 void apartment_disconnectobject(struct apartment *apt, void *object);
232 static inline HRESULT apartment_getoxid(struct apartment *apt, OXID *oxid)
237 HRESULT apartment_createwindowifneeded(struct apartment *apt);
238 HWND apartment_getwindow(struct apartment *apt);
239 void apartment_joinmta(void);
242 /* DCOM messages used by the apartment window (not compatible with native) */
243 #define DM_EXECUTERPC (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
246 * Per-thread values are stored in the TEB on offset 0xF80,
247 * see http://www.microsoft.com/msj/1099/bugslayer/bugslayer1099.htm
250 /* will create if necessary */
251 static inline struct oletls *COM_CurrentInfo(void)
253 if (!NtCurrentTeb()->ReservedForOle)
254 NtCurrentTeb()->ReservedForOle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct oletls));
256 return NtCurrentTeb()->ReservedForOle;
259 static inline APARTMENT* COM_CurrentApt(void)
261 return COM_CurrentInfo()->apt;
264 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
266 /* helpers for debugging */
267 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
268 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
270 extern HINSTANCE OLE32_hInstance; /* FIXME: make static */
272 #define CHARS_IN_GUID 39 /* including NULL */
274 /* Exported non-interface Data Advise Holder functions */
275 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate);
276 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface);
278 #endif /* __WINE_OLE_COMPOBJ_H */