ole32: Get rid of the ICOM_THIS_MULTI macro.
[wine] / dlls / 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, 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 DEFINE_OLEGUID( CLSID_DfMarshal, 0x0000030b, 0, 0 );
45 DEFINE_OLEGUID( CLSID_PSFactoryBuffer, 0x00000320, 0, 0 );
46
47 /* signal to stub manager that this is a rem unknown object */
48 #define MSHLFLAGSP_REMUNKNOWN   0x80000000
49
50 /* Thread-safety Annotation Legend:
51  *
52  * RO    - The value is read only. It never changes after creation, so no
53  *         locking is required.
54  * LOCK  - The value is written to only using Interlocked* functions.
55  * CS    - The value is read or written to inside a critical section.
56  *         The identifier following "CS" is the specific critical section that
57  *         must be used.
58  * MUTEX - The value is read or written to with a mutex held.
59  *         The identifier following "MUTEX" is the specific mutex that
60  *         must be used.
61  */
62
63 typedef enum ifstub_state
64 {
65     STUBSTATE_NORMAL_MARSHALED,
66     STUBSTATE_NORMAL_UNMARSHALED,
67     STUBSTATE_TABLE_WEAK_MARSHALED,
68     STUBSTATE_TABLE_WEAK_UNMARSHALED,
69     STUBSTATE_TABLE_STRONG,
70 } STUB_STATE;
71
72 /* an interface stub */
73 struct ifstub   
74 {
75     struct list       entry;      /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
76     IRpcStubBuffer   *stubbuffer; /* RO */
77     IID               iid;        /* RO */
78     IPID              ipid;       /* RO */
79     IUnknown         *iface;      /* RO */
80     MSHLFLAGS         flags;      /* so we can enforce process-local marshalling rules (RO) */
81     IRpcChannelBuffer*chan;       /* channel passed to IRpcStubBuffer::Invoke (RO) */
82 };
83
84
85 /* stub managers hold refs on the object and each interface stub */
86 struct stub_manager
87 {
88     struct list       entry;      /* entry in apartment stubmgr list (CS apt->cs) */
89     struct list       ifstubs;    /* list of active ifstubs for the object (CS lock) */
90     CRITICAL_SECTION  lock;
91     APARTMENT        *apt;        /* owning apt (RO) */
92
93     ULONG             extrefs;    /* number of 'external' references (CS lock) */
94     ULONG             refs;       /* internal reference count (CS apt->cs) */
95     ULONG             weakrefs;   /* number of weak references (CS lock) */
96     OID               oid;        /* apartment-scoped unique identifier (RO) */
97     IUnknown         *object;     /* the object we are managing the stub for (RO) */
98     ULONG             next_ipid;  /* currently unused (LOCK) */
99     OXID_INFO         oxid_info;  /* string binding, ipid of rem unknown and other information (RO) */
100
101     /* We need to keep a count of the outstanding marshals, so we can enforce the
102      * marshalling rules (ie, you can only unmarshal normal marshals once). Note
103      * that these counts do NOT include unmarshalled interfaces, once a stream is
104      * unmarshalled and a proxy set up, this count is decremented.
105      */
106
107     ULONG             norm_refs;  /* refcount of normal marshals (CS lock) */
108 };
109
110 /* imported interface proxy */
111 struct ifproxy
112 {
113   struct list entry;       /* entry in proxy_manager list (CS parent->cs) */
114   struct proxy_manager *parent; /* owning proxy_manager (RO) */
115   LPVOID iface;            /* interface pointer (RO) */
116   STDOBJREF stdobjref;     /* marshal data that represents this object (RO) */
117   IID iid;                 /* interface ID (RO) */
118   LPRPCPROXYBUFFER proxy;  /* interface proxy (RO) */
119   ULONG refs;              /* imported (public) references (LOCK) */
120   IRpcChannelBuffer *chan; /* channel to object (CS parent->cs) */
121 };
122
123 struct apartment
124 {
125   struct list entry;
126
127   LONG  refs;              /* refcount of the apartment (LOCK) */
128   BOOL multi_threaded;     /* multi-threaded or single-threaded apartment? (RO) */
129   DWORD tid;               /* thread id (RO) */
130   OXID oxid;               /* object exporter ID (RO) */
131   LONG ipidc;              /* interface pointer ID counter, starts at 1 (LOCK) */
132   CRITICAL_SECTION cs;     /* thread safety */
133   struct list proxies;     /* imported objects (CS cs) */
134   struct list stubmgrs;    /* stub managers for exported objects (CS cs) */
135   BOOL remunk_exported;    /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
136   LONG remoting_started;   /* has the RPC system been started for this apartment? (LOCK) */
137   struct list psclsids;    /* list of registered PS CLSIDs (CS cs) */
138   struct list loaded_dlls; /* list of dlls loaded by this apartment (CS cs) */
139   DWORD host_apt_tid;      /* thread ID of apartment hosting objects of differing threading model (CS cs) */
140   HWND host_apt_hwnd;      /* handle to apartment window of host apartment (CS cs) */
141
142   /* FIXME: OID's should be given out by RPCSS */
143   OID oidc;                /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
144
145   /* STA-only fields */
146   HWND win;                /* message window (LOCK) */
147   LPMESSAGEFILTER filter;  /* message filter (CS cs) */
148   BOOL main;               /* is this a main-threaded-apartment? (RO) */
149 };
150
151 /* this is what is stored in TEB->ReservedForOle */
152 struct oletls
153 {
154     struct apartment *apt;
155     IErrorInfo       *errorinfo;   /* see errorinfo.c */
156     IUnknown         *state;       /* see CoSetState */
157     DWORD             apt_mask;    /* apartment mask (+0Ch on x86) */
158     IInitializeSpy   *spy;         /* The "SPY" from CoInitializeSpy */
159     DWORD            inits;        /* number of times CoInitializeEx called */
160     DWORD            ole_inits;    /* number of times OleInitialize called */
161     GUID             causality_id; /* unique identifier for each COM call */
162     LONG             pending_call_count_client; /* number of client calls pending */
163     LONG             pending_call_count_server; /* number of server calls pending */
164     DWORD            unknown;
165     IObjContext     *context_token; /* (+38h on x86) */
166     IUnknown        *call_state;    /* current call context (+3Ch on x86) */
167     DWORD            unknown2[46];
168     IUnknown        *cancel_object; /* cancel object set by CoSetCancelObject (+F8h on x86) */
169 };
170
171
172 /* Global Interface Table Functions */
173
174 extern void* StdGlobalInterfaceTable_Construct(void);
175 extern HRESULT StdGlobalInterfaceTable_GetFactory(LPVOID *ppv);
176 extern void* StdGlobalInterfaceTableInstance;
177
178 HRESULT COM_OpenKeyForCLSID(REFCLSID clsid, LPCWSTR keyname, REGSAM access, HKEY *key);
179 HRESULT COM_OpenKeyForAppIdFromCLSID(REFCLSID clsid, REGSAM access, HKEY *subkey);
180 HRESULT MARSHAL_GetStandardMarshalCF(LPVOID *ppv);
181 HRESULT FTMarshalCF_Create(REFIID riid, LPVOID *ppv);
182
183 /* Stub Manager */
184
185 ULONG stub_manager_int_release(struct stub_manager *This);
186 struct stub_manager *new_stub_manager(APARTMENT *apt, IUnknown *object);
187 ULONG stub_manager_ext_addref(struct stub_manager *m, ULONG refs, BOOL tableweak);
188 ULONG stub_manager_ext_release(struct stub_manager *m, ULONG refs, BOOL tableweak, BOOL last_unlock_releases);
189 struct ifstub *stub_manager_new_ifstub(struct stub_manager *m, IRpcStubBuffer *sb, IUnknown *iptr, REFIID iid, MSHLFLAGS flags);
190 struct ifstub *stub_manager_find_ifstub(struct stub_manager *m, REFIID iid, MSHLFLAGS flags);
191 struct stub_manager *get_stub_manager(APARTMENT *apt, OID oid);
192 struct stub_manager *get_stub_manager_from_object(APARTMENT *apt, void *object);
193 BOOL stub_manager_notify_unmarshal(struct stub_manager *m, const IPID *ipid);
194 BOOL stub_manager_is_table_marshaled(struct stub_manager *m, const IPID *ipid);
195 void stub_manager_release_marshal_data(struct stub_manager *m, ULONG refs, const IPID *ipid, BOOL tableweak);
196 HRESULT ipid_get_dispatch_params(const IPID *ipid, APARTMENT **stub_apt, IRpcStubBuffer **stub, IRpcChannelBuffer **chan, IID *iid, IUnknown **iface);
197 HRESULT start_apartment_remote_unknown(void);
198
199 HRESULT marshal_object(APARTMENT *apt, STDOBJREF *stdobjref, REFIID riid, IUnknown *obj, MSHLFLAGS mshlflags);
200
201 /* RPC Backend */
202
203 struct dispatch_params;
204
205 void    RPC_StartRemoting(struct apartment *apt);
206 HRESULT RPC_CreateClientChannel(const OXID *oxid, const IPID *ipid,
207                                 const OXID_INFO *oxid_info,
208                                 DWORD dest_context, void *dest_context_data,
209                                 IRpcChannelBuffer **chan);
210 HRESULT RPC_CreateServerChannel(IRpcChannelBuffer **chan);
211 void    RPC_ExecuteCall(struct dispatch_params *params);
212 HRESULT RPC_RegisterInterface(REFIID riid);
213 void    RPC_UnregisterInterface(REFIID riid);
214 HRESULT RPC_StartLocalServer(REFCLSID clsid, IStream *stream, BOOL multi_use, void **registration);
215 void    RPC_StopLocalServer(void *registration);
216 HRESULT RPC_GetLocalClassObject(REFCLSID rclsid, REFIID iid, LPVOID *ppv);
217 HRESULT RPC_RegisterChannelHook(REFGUID rguid, IChannelHook *hook);
218 void    RPC_UnregisterAllChannelHooks(void);
219 HRESULT RPC_ResolveOxid(OXID oxid, OXID_INFO *oxid_info);
220
221 /* This function initialize the Running Object Table */
222 HRESULT WINAPI RunningObjectTableImpl_Initialize(void);
223
224 /* This function uninitialize the Running Object Table */
225 HRESULT WINAPI RunningObjectTableImpl_UnInitialize(void);
226
227 /* Drag and drop */
228 void OLEDD_UnInitialize(void);
229
230 /* Apartment Functions */
231
232 APARTMENT *apartment_findfromoxid(OXID oxid, BOOL ref);
233 APARTMENT *apartment_findfromtid(DWORD tid);
234 DWORD apartment_release(struct apartment *apt);
235 HRESULT apartment_disconnectproxies(struct apartment *apt);
236 void apartment_disconnectobject(struct apartment *apt, void *object);
237 static inline HRESULT apartment_getoxid(const struct apartment *apt, OXID *oxid)
238 {
239     *oxid = apt->oxid;
240     return S_OK;
241 }
242 HRESULT apartment_createwindowifneeded(struct apartment *apt);
243 HWND apartment_getwindow(const struct apartment *apt);
244 void apartment_joinmta(void);
245
246
247 /* DCOM messages used by the apartment window (not compatible with native) */
248 #define DM_EXECUTERPC   (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
249 #define DM_HOSTOBJECT   (WM_USER + 1) /* WPARAM = 0, LPARAM = (struct host_object_params *) */
250
251 /*
252  * Per-thread values are stored in the TEB on offset 0xF80
253  */
254
255 /* will create if necessary */
256 static inline struct oletls *COM_CurrentInfo(void)
257 {
258     if (!NtCurrentTeb()->ReservedForOle)
259         NtCurrentTeb()->ReservedForOle = HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY, sizeof(struct oletls));
260
261     return NtCurrentTeb()->ReservedForOle;
262 }
263
264 static inline APARTMENT* COM_CurrentApt(void)
265 {  
266     return COM_CurrentInfo()->apt;
267 }
268
269 static inline GUID COM_CurrentCausalityId(void)
270 {
271     struct oletls *info = COM_CurrentInfo();
272     if (!info)
273         return GUID_NULL;
274     if (IsEqualGUID(&info->causality_id, &GUID_NULL))
275         CoCreateGuid(&info->causality_id);
276     return info->causality_id;
277 }
278
279 /* helpers for debugging */
280 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
281 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
282
283 #define CHARS_IN_GUID 39 /* including NULL */
284
285 #define WINE_CLSCTX_DONT_HOST   0x80000000
286
287 /* from dlldata.c */
288 extern HINSTANCE hProxyDll DECLSPEC_HIDDEN;
289 extern HRESULT WINAPI OLE32_DllGetClassObject(REFCLSID rclsid, REFIID iid,LPVOID *ppv) DECLSPEC_HIDDEN;
290 extern HRESULT WINAPI OLE32_DllRegisterServer(void) DECLSPEC_HIDDEN;
291 extern HRESULT WINAPI OLE32_DllUnregisterServer(void) DECLSPEC_HIDDEN;
292
293 extern HRESULT Handler_DllGetClassObject(REFCLSID rclsid, REFIID riid, LPVOID *ppv);
294 extern HRESULT HandlerCF_Create(REFCLSID rclsid, REFIID riid, LPVOID *ppv);
295
296 /* Exported non-interface Data Advise Holder functions */
297 HRESULT DataAdviseHolder_OnConnect(IDataAdviseHolder *iface, IDataObject *pDelegate);
298 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder *iface);
299
300 extern UINT ownerlink_clipboard_format;
301 extern UINT filename_clipboard_format;
302 extern UINT filenameW_clipboard_format;
303 extern UINT dataobject_clipboard_format;
304 extern UINT embedded_object_clipboard_format;
305 extern UINT embed_source_clipboard_format;
306 extern UINT custom_link_source_clipboard_format;
307 extern UINT link_source_clipboard_format;
308 extern UINT object_descriptor_clipboard_format;
309 extern UINT link_source_descriptor_clipboard_format;
310 extern UINT ole_private_data_clipboard_format;
311
312 #endif /* __WINE_OLE_COMPOBJ_H */