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 extern const CLSID CLSID_PSFactoryBuffer
;
45 extern const CLSID CLSID_DfMarshal
;
47 /* Thread-safety Annotation Legend:
49 * RO - The value is read only. It never changes after creation, so no
50 * locking is required.
51 * LOCK - The value is written to only using Interlocked* functions.
52 * CS - The value is read or written to inside a critical section.
53 * The identifier following "CS" is the specific critical setion that
55 * MUTEX - The value is read or written to with a mutex held.
56 * The identifier following "MUTEX" is the specific mutex that
60 typedef enum ifstub_state
62 STUBSTATE_NORMAL_MARSHALED
,
63 STUBSTATE_NORMAL_UNMARSHALED
,
64 STUBSTATE_TABLE_WEAK_MARSHALED
,
65 STUBSTATE_TABLE_WEAK_UNMARSHALED
,
66 STUBSTATE_TABLE_STRONG
,
69 /* an interface stub */
72 struct list entry
; /* entry in stub_manager->ifstubs list (CS stub_manager->lock) */
73 IRpcStubBuffer
*stubbuffer
; /* RO */
76 IUnknown
*iface
; /* RO */
77 MSHLFLAGS flags
; /* so we can enforce process-local marshalling rules (RO) */
78 IRpcChannelBuffer
*chan
; /* channel passed to IRpcStubBuffer::Invoke (RO) */
82 /* stub managers hold refs on the object and each interface stub */
85 struct list entry
; /* entry in apartment stubmgr list (CS apt->cs) */
86 struct list ifstubs
; /* list of active ifstubs for the object (CS lock) */
87 CRITICAL_SECTION lock
;
88 APARTMENT
*apt
; /* owning apt (RO) */
90 ULONG extrefs
; /* number of 'external' references (CS lock) */
91 ULONG refs
; /* internal reference count (CS apt->cs) */
92 OID oid
; /* apartment-scoped unique identifier (RO) */
93 IUnknown
*object
; /* the object we are managing the stub for (RO) */
94 ULONG next_ipid
; /* currently unused (LOCK) */
96 /* We need to keep a count of the outstanding marshals, so we can enforce the
97 * marshalling rules (ie, you can only unmarshal normal marshals once). Note
98 * that these counts do NOT include unmarshalled interfaces, once a stream is
99 * unmarshalled and a proxy set up, this count is decremented.
102 ULONG norm_refs
; /* refcount of normal marshals (CS lock) */
105 /* imported interface proxy */
108 struct list entry
; /* entry in proxy_manager list (CS parent->cs) */
109 struct proxy_manager
*parent
; /* owning proxy_manager (RO) */
110 LPVOID iface
; /* interface pointer (RO) */
111 STDOBJREF stdobjref
; /* marshal data that represents this object (RO) */
112 IID iid
; /* interface ID (RO) */
113 LPRPCPROXYBUFFER proxy
; /* interface proxy (RO) */
114 DWORD refs
; /* imported (public) references (MUTEX parent->remoting_mutex) */
115 IRpcChannelBuffer
*chan
; /* channel to object (CS parent->cs) */
118 /* imported object / proxy manager */
121 const IMultiQIVtbl
*lpVtbl
;
122 const IMarshalVtbl
*lpVtblMarshal
;
123 struct apartment
*parent
; /* owning apartment (RO) */
124 struct list entry
; /* entry in apartment (CS parent->cs) */
125 OXID oxid
; /* object exported ID (RO) */
126 OID oid
; /* object ID (RO) */
127 struct list interfaces
; /* imported interfaces (CS cs) */
128 LONG refs
; /* proxy reference count (LOCK) */
129 CRITICAL_SECTION cs
; /* thread safety for this object and children */
130 ULONG sorflags
; /* STDOBJREF flags (RO) */
131 IRemUnknown
*remunk
; /* proxy to IRemUnknown used for lifecycle management (CS cs) */
132 HANDLE remoting_mutex
; /* mutex used for synchronizing access to IRemUnknown */
133 MSHCTX dest_context
; /* context used for activating optimisations (LOCK) */
134 void *dest_context_data
; /* reserved context value (LOCK) */
137 /* this needs to become a COM object that implements IRemUnknown */
142 LONG refs
; /* refcount of the apartment (LOCK) */
143 BOOL multi_threaded
; /* multi-threaded or single-threaded apartment? (RO) */
144 DWORD tid
; /* thread id (RO) */
145 OXID oxid
; /* object exporter ID (RO) */
146 LONG ipidc
; /* interface pointer ID counter, starts at 1 (LOCK) */
147 HWND win
; /* message window (LOCK) */
148 CRITICAL_SECTION cs
; /* thread safety */
149 LPMESSAGEFILTER filter
; /* message filter (CS cs) */
150 struct list proxies
; /* imported objects (CS cs) */
151 struct list stubmgrs
; /* stub managers for exported objects (CS cs) */
152 BOOL remunk_exported
; /* has the IRemUnknown interface for this apartment been created yet? (CS cs) */
153 LONG remoting_started
; /* has the RPC system been started for this apartment? (LOCK) */
155 /* FIXME: OID's should be given out by RPCSS */
156 OID oidc
; /* object ID counter, starts at 1, zero is invalid OID (CS cs) */
159 /* this is what is stored in TEB->ReservedForOle */
162 struct apartment
*apt
;
163 IErrorInfo
*errorinfo
; /* see errorinfo.c */
164 IUnknown
*state
; /* see CoSetState */
165 DWORD inits
; /* number of times CoInitializeEx called */
169 /* Global Interface Table Functions */
171 extern void* StdGlobalInterfaceTable_Construct(void);
172 extern void StdGlobalInterfaceTable_Destroy(void* self
);
173 extern HRESULT
StdGlobalInterfaceTable_GetFactory(LPVOID
*ppv
);
174 extern void* StdGlobalInterfaceTableInstance
;
176 /* FIXME: these shouldn't be needed, except for 16-bit functions */
177 extern HRESULT
WINE_StringFromCLSID(const CLSID
*id
,LPSTR idstr
);
179 HRESULT
COM_OpenKeyForCLSID(REFCLSID clsid
, LPCWSTR keyname
, REGSAM access
, HKEY
*key
);
180 HRESULT
MARSHAL_GetStandardMarshalCF(LPVOID
*ppv
);
184 ULONG
stub_manager_int_addref(struct stub_manager
*This
);
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
);
188 ULONG
stub_manager_ext_release(struct stub_manager
*m
, ULONG refs
);
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
);
196 HRESULT
ipid_to_stub_manager(const IPID
*ipid
, APARTMENT
**stub_apt
, struct stub_manager
**stubmgr_ret
);
197 HRESULT
ipid_get_dispatch_params(const IPID
*ipid
, APARTMENT
**stub_apt
, IRpcStubBuffer
**stub
, IRpcChannelBuffer
**chan
);
198 HRESULT
start_apartment_remote_unknown(void);
200 HRESULT
marshal_object(APARTMENT
*apt
, STDOBJREF
*stdobjref
, REFIID riid
, IUnknown
*obj
, MSHLFLAGS mshlflags
);
204 struct dispatch_params
;
206 void RPC_StartRemoting(struct apartment
*apt
);
207 HRESULT
RPC_CreateClientChannel(const OXID
*oxid
, const IPID
*ipid
,
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 void RPC_StartLocalServer(REFCLSID clsid
, IStream
*stream
);
215 HRESULT
RPC_GetLocalClassObject(REFCLSID rclsid
, REFIID iid
, LPVOID
*ppv
);
217 /* This function initialize the Running Object Table */
218 HRESULT WINAPI
RunningObjectTableImpl_Initialize(void);
220 /* This function uninitialize the Running Object Table */
221 HRESULT WINAPI
RunningObjectTableImpl_UnInitialize(void);
223 /* This function decomposes a String path to a String Table containing all the elements ("\" or "subDirectory" or "Directory" or "FileName") of the path */
224 int FileMonikerImpl_DecomposePath(LPCOLESTR str
, LPOLESTR
** stringTable
);
227 /* Apartment Functions */
229 APARTMENT
*apartment_findfromoxid(OXID oxid
, BOOL ref
);
230 APARTMENT
*apartment_findfromtid(DWORD tid
);
231 DWORD
apartment_addref(struct apartment
*apt
);
232 DWORD
apartment_release(struct apartment
*apt
);
233 HRESULT
apartment_disconnectproxies(struct apartment
*apt
);
234 void apartment_disconnectobject(struct apartment
*apt
, void *object
);
235 static inline HRESULT
apartment_getoxid(struct apartment
*apt
, OXID
*oxid
)
240 HRESULT
apartment_createwindowifneeded(struct apartment
*apt
);
241 HWND
apartment_getwindow(struct apartment
*apt
);
242 void apartment_joinmta(void);
245 /* DCOM messages used by the apartment window (not compatible with native) */
246 #define DM_EXECUTERPC (WM_USER + 0) /* WPARAM = 0, LPARAM = (struct dispatch_params *) */
249 * Per-thread values are stored in the TEB on offset 0xF80,
250 * see http://www.microsoft.com/msj/1099/bugslayer/bugslayer1099.htm
253 /* will create if necessary */
254 static inline struct oletls
*COM_CurrentInfo(void)
256 if (!NtCurrentTeb()->ReservedForOle
)
257 NtCurrentTeb()->ReservedForOle
= HeapAlloc(GetProcessHeap(), HEAP_ZERO_MEMORY
, sizeof(struct oletls
));
259 return NtCurrentTeb()->ReservedForOle
;
262 static inline APARTMENT
* COM_CurrentApt(void)
264 return COM_CurrentInfo()->apt
;
267 #define ICOM_THIS_MULTI(impl,field,iface) impl* const This=(impl*)((char*)(iface) - offsetof(impl,field))
269 /* helpers for debugging */
270 # define DEBUG_SET_CRITSEC_NAME(cs, name) (cs)->DebugInfo->Spare[0] = (DWORD_PTR)(__FILE__ ": " name)
271 # define DEBUG_CLEAR_CRITSEC_NAME(cs) (cs)->DebugInfo->Spare[0] = 0
273 extern HINSTANCE OLE32_hInstance
; /* FIXME: make static */
275 #define CHARS_IN_GUID 39 /* including NULL */
277 /* Exported non-interface Data Advise Holder functions */
278 HRESULT
DataAdviseHolder_OnConnect(IDataAdviseHolder
*iface
, IDataObject
*pDelegate
);
279 void DataAdviseHolder_OnDisconnect(IDataAdviseHolder
*iface
);
281 #endif /* __WINE_OLE_COMPOBJ_H */