4 * Copyright 1997 Alexandre Julliard
5 * Copyright 1997 Len White
6 * Copyright 1999 Keith Matthews
8 * Copyright 2001 Eric Pouech
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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
25 #ifndef __WINE_DDEML_PRIVATE_H
26 #define __WINE_DDEML_PRIVATE_H
31 /* defined in atom.c file.
33 #define MAX_ATOM_LEN 255
35 /* Maximum buffer size ( including the '\0' ).
37 #define MAX_BUFFER_LEN (MAX_ATOM_LEN + 1)
39 /* The internal structures (prefixed by WDML) are used as follows:
40 * + a WDML_INSTANCE is created for each instance creation (DdeInitialize)
41 * - a popup window (InstanceClass) is created for each instance.
42 * - this window is used to receive all the DDEML events (server registration,
43 * conversation confirmation...). See the WM_WDML_???? messages for details
44 * + when registering a server (DdeNameService) a WDML_SERVER is created
45 * - a popup window (ServerNameClass) is created
46 * + a conversation is represented by two WDML_CONV structures:
47 * - one on the client side, the other one on the server side
48 * - this is needed because the address spaces may be different
49 * - therefore, two lists of links are kept for each instance
50 * - two windows are created for a conversation:
51 * o a popup window on client side (ClientConvClass)
52 * o a child window (of the ServerName) on the server side
54 * - all the exchanges then take place between those two windows
55 * - windows for the conversation exist in two forms (Ansi & Unicode). This
56 * is only needed when a partner in a conv is not handled by DDEML. The
57 * type (A/W) of the window is used to handle the ansi <=> unicode
59 * - two handles are created for a conversation (on each side). Each handle
60 * is linked to a structure. To help differentiate those handles, the
61 * local one has an even value, whereas the remote one has an odd value.
62 * + a (warm or link) is represented by two WDML_LINK structures:
63 * - one on client side, the other one on server side
64 * - therefore, two lists of links are kept for each instance
66 * To help getting back to data, WDML windows store information:
67 * - offset 0: the DDE instance
68 * - offset 4: the current conversation (for ClientConv and ServerConv only)
70 * All the implementation (client & server) makes the assumption that the other side
71 * is not always a DDEML partner. However, if it's the case, supplementary services
72 * are available (most notably the REGISTER/UNREGISTER and CONNECT_CONFIRM messages
73 * to the callback function). To be correct in every situation, all the basic
74 * exchanges are made using the 'pure' DDE protocol. A (future !) enhancement would
75 * be to provide a new protocol in the case where both partners are handled by DDEML.
77 * The StringHandles are in fact stored as local atoms. So an HSZ and a (local) atom
78 * can be used interchangeably. However, in order to keep track of the allocated HSZ,
79 * and to free them upon instance termination, all HSZ are stored in a link list.
80 * When the HSZ need to be passed through DDE messages, we need to convert them back and
81 * forth to global atoms.
84 /* this struct has the same mapping as all the DDE??? structures */
86 unsigned short unused
:12,
94 typedef struct tagHSZNode
96 struct tagHSZNode
* next
;
101 typedef struct tagWDML_SERVER
103 struct tagWDML_SERVER
* next
;
107 ATOM atomServiceSpec
;
112 typedef struct tagWDML_XACT
{
113 struct tagWDML_XACT
* next
; /* list of transactions in conversation */
122 ATOM atom
; /* as converted from or to hszItem */
124 LPARAM lParam
; /* useful for reusing */
127 typedef struct tagWDML_CONV
129 struct tagWDML_CONV
* next
; /* to link all the conversations */
130 struct tagWDML_INSTANCE
* instance
;
131 HSZ hszService
; /* pmt used for connection */
132 HSZ hszTopic
; /* pmt used for connection */
133 UINT magic
; /* magic number to check validity */
134 UINT afCmd
; /* service name flag */
135 CONVCONTEXT convContext
;
136 HWND hwndClient
; /* source of conversation (ClientConvClass) */
137 HWND hwndServer
; /* destination of conversation (ServerConvClass) */
138 WDML_XACT
* transactions
; /* pending transactions */
139 DWORD hUser
; /* user defined value */
140 DWORD wStatus
; /* same bits as convinfo.wStatus */
141 DWORD wConvst
; /* same values as convinfo.wConvst */
144 #define WDML_CONV_MAGIC 0xbabe1234
146 /* DDE_LINK struct defines hot, warm, and cold links */
147 typedef struct tagWDML_LINK
{
148 struct tagWDML_LINK
* next
; /* to link all the active links */
149 HCONV hConv
; /* to get back to the conversation */
150 UINT transactionType
;/* 0 for no link */
151 HSZ hszItem
; /* item targeted for (hot/warm) link */
152 UINT uFmt
; /* format for data */
155 typedef struct tagWDML_INSTANCE
157 struct tagWDML_INSTANCE
* next
;
158 DWORD instanceID
; /* needed to track monitor usage */
159 DWORD threadID
; /* needed to keep instance linked to a unique thread */
160 BOOL monitor
; /* have these two as full Booleans cos they'll be tested frequently */
161 BOOL clientOnly
; /* bit wasteful of space but it will be faster */
162 BOOL unicode
; /* Flag to indicate Win32 API used to initialise */
163 HSZNode
* nodeList
; /* for cleaning upon exit */
164 PFNCALLBACK callback
;
169 DWORD wStatus
; /* global instance status */
170 WDML_SERVER
* servers
; /* list of registered servers */
171 WDML_CONV
* convs
[2]; /* active conversations for this instance (client and server) */
172 WDML_LINK
* links
[2]; /* active links for this instance (client and server) */
175 /* header for the DDE Data objects */
176 typedef struct tagDDE_DATAHANDLE_HEAD
180 } DDE_DATAHANDLE_HEAD
;
182 typedef enum tagWDML_SIDE
184 WDML_CLIENT_SIDE
= 0, WDML_SERVER_SIDE
= 1
188 WDML_QS_ERROR
, WDML_QS_HANDLED
, WDML_QS_PASS
, WDML_QS_SWALLOWED
, WDML_QS_BLOCK
,
191 extern HDDEDATA
WDML_InvokeCallback(WDML_INSTANCE
* pInst
, UINT uType
, UINT uFmt
, HCONV hConv
,
192 HSZ hsz1
, HSZ hsz2
, HDDEDATA hdata
,
193 ULONG_PTR dwData1
, ULONG_PTR dwData2
) DECLSPEC_HIDDEN
;
194 extern WDML_SERVER
* WDML_AddServer(WDML_INSTANCE
* pInstance
, HSZ hszService
, HSZ hszTopic
) DECLSPEC_HIDDEN
;
195 extern void WDML_RemoveServer(WDML_INSTANCE
* pInstance
, HSZ hszService
, HSZ hszTopic
) DECLSPEC_HIDDEN
;
196 extern WDML_SERVER
* WDML_FindServer(WDML_INSTANCE
* pInstance
, HSZ hszService
, HSZ hszTopic
) DECLSPEC_HIDDEN
;
197 /* transaction handler on the server side */
198 extern WDML_QUEUE_STATE
WDML_ServerHandle(WDML_CONV
* pConv
, WDML_XACT
* pXAct
) DECLSPEC_HIDDEN
;
199 /* transaction handler on the client side */
200 HDDEDATA
WDML_ClientHandle(WDML_CONV
*pConv
, WDML_XACT
*pXAct
, DWORD dwTimeout
, LPDWORD pdwResult
) DECLSPEC_HIDDEN
;
201 /* called both in DdeClientTransaction and server side. */
202 extern WDML_CONV
* WDML_AddConv(WDML_INSTANCE
* pInstance
, WDML_SIDE side
,
203 HSZ hszService
, HSZ hszTopic
, HWND hwndClient
, HWND hwndServer
) DECLSPEC_HIDDEN
;
204 extern void WDML_RemoveConv(WDML_CONV
* pConv
, WDML_SIDE side
) DECLSPEC_HIDDEN
;
205 extern WDML_CONV
* WDML_GetConv(HCONV hConv
, BOOL checkConnected
) DECLSPEC_HIDDEN
;
206 extern WDML_CONV
* WDML_GetConvFromWnd(HWND hWnd
) DECLSPEC_HIDDEN
;
207 extern WDML_CONV
* WDML_FindConv(WDML_INSTANCE
* pInstance
, WDML_SIDE side
,
208 HSZ hszService
, HSZ hszTopic
) DECLSPEC_HIDDEN
;
209 extern BOOL
WDML_PostAck(WDML_CONV
* pConv
, WDML_SIDE side
, WORD appRetCode
,
210 BOOL fBusy
, BOOL fAck
, UINT_PTR pmt
, LPARAM lParam
, UINT oldMsg
) DECLSPEC_HIDDEN
;
211 extern void WDML_AddLink(WDML_INSTANCE
* pInstance
, HCONV hConv
, WDML_SIDE side
,
212 UINT wType
, HSZ hszItem
, UINT wFmt
) DECLSPEC_HIDDEN
;
213 extern WDML_LINK
* WDML_FindLink(WDML_INSTANCE
* pInstance
, HCONV hConv
, WDML_SIDE side
,
214 HSZ hszItem
, BOOL use_fmt
, UINT uFmt
) DECLSPEC_HIDDEN
;
215 extern void WDML_RemoveLink(WDML_INSTANCE
* pInstance
, HCONV hConv
, WDML_SIDE side
,
216 HSZ hszItem
, UINT wFmt
) DECLSPEC_HIDDEN
;
217 /* string internals */
218 extern BOOL
WDML_DecHSZ(WDML_INSTANCE
* pInstance
, HSZ hsz
) DECLSPEC_HIDDEN
;
219 extern BOOL
WDML_IncHSZ(WDML_INSTANCE
* pInstance
, HSZ hsz
) DECLSPEC_HIDDEN
;
220 extern ATOM
WDML_MakeAtomFromHsz(HSZ hsz
) DECLSPEC_HIDDEN
;
221 extern HSZ
WDML_MakeHszFromAtom(const WDML_INSTANCE
* pInstance
, ATOM atom
) DECLSPEC_HIDDEN
;
222 /* client calls these */
223 extern WDML_XACT
* WDML_AllocTransaction(WDML_INSTANCE
* pInstance
, UINT ddeMsg
, UINT wFmt
, HSZ hszItem
) DECLSPEC_HIDDEN
;
224 extern void WDML_QueueTransaction(WDML_CONV
* pConv
, WDML_XACT
* pXAct
) DECLSPEC_HIDDEN
;
225 extern BOOL
WDML_UnQueueTransaction(WDML_CONV
* pConv
, WDML_XACT
* pXAct
) DECLSPEC_HIDDEN
;
226 extern void WDML_FreeTransaction(WDML_INSTANCE
* pInstance
, WDML_XACT
* pXAct
, BOOL doFreePmt
) DECLSPEC_HIDDEN
;
227 extern HGLOBAL
WDML_DataHandle2Global(HDDEDATA hDdeData
, BOOL fResponse
, BOOL fRelease
,
228 BOOL fDeferUpd
, BOOL dAckReq
) DECLSPEC_HIDDEN
;
229 extern HDDEDATA
WDML_Global2DataHandle(WDML_CONV
* pConv
, HGLOBAL hMem
, WINE_DDEHEAD
* da
) DECLSPEC_HIDDEN
;
230 extern BOOL
WDML_IsAppOwned(HDDEDATA hDdeData
) DECLSPEC_HIDDEN
;
231 extern WDML_INSTANCE
* WDML_GetInstance(DWORD InstId
) DECLSPEC_HIDDEN
;
232 extern WDML_INSTANCE
* WDML_GetInstanceFromWnd(HWND hWnd
) DECLSPEC_HIDDEN
;
233 /* broadcasting to DDE windows */
234 extern void WDML_BroadcastDDEWindows(LPCWSTR clsName
, UINT uMsg
,
235 WPARAM wParam
, LPARAM lParam
) DECLSPEC_HIDDEN
;
236 extern void WDML_NotifyThreadExit(DWORD tid
) DECLSPEC_HIDDEN
;
237 extern void WDML_NotifyThreadDetach(void) DECLSPEC_HIDDEN
;
240 static inline void WDML_ExtractAck(WORD status
, DDEACK
* da
)
242 *da
= *((DDEACK
*)&status
);
245 extern const WCHAR WDML_szEventClass
[] DECLSPEC_HIDDEN
; /* class of window for events (aka instance) */
246 extern const char WDML_szServerConvClassA
[] DECLSPEC_HIDDEN
; /* ANSI class of window for server side conv */
247 extern const WCHAR WDML_szServerConvClassW
[] DECLSPEC_HIDDEN
; /* unicode class of window for server side conv */
248 extern const char WDML_szClientConvClassA
[] DECLSPEC_HIDDEN
; /* ANSI class of window for client side conv */
249 extern const WCHAR WDML_szClientConvClassW
[] DECLSPEC_HIDDEN
; /* unicode class of window for client side conv */
251 #define WM_WDML_REGISTER (WM_USER + 0x200)
252 #define WM_WDML_UNREGISTER (WM_USER + 0x201)
253 #define WM_WDML_CONNECT_CONFIRM (WM_USER + 0x202)
255 /* parameters for messages:
257 * Register atom for service name atom for service spec
258 * Unregister atom for service name atom for service spec
259 * ConnectConfirm client window handle server window handle
262 #define GWL_WDML_INSTANCE (0)
263 #define GWL_WDML_CONVERSATION (sizeof(ULONG_PTR))
264 #define GWL_WDML_SERVER (sizeof(ULONG_PTR))
266 #endif /* __WINE_DDEML_PRIVATE_H */