ReactOS 0.4.15-dev-8102-g108db8f
dde_private.h
Go to the documentation of this file.
1/*
2 * DDEML library
3 *
4 * Copyright 1997 Alexandre Julliard
5 * Copyright 1997 Len White
6 * Copyright 1999 Keith Matthews
7 * Copyright 2000 Corel
8 * Copyright 2001 Eric Pouech
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_DDEML_PRIVATE_H
26#define __WINE_DDEML_PRIVATE_H
27
28/* defined in atom.c file.
29 */
30#define MAX_ATOM_LEN 255
31
32/* Maximum buffer size ( including the '\0' ).
33 */
34#define MAX_BUFFER_LEN (MAX_ATOM_LEN + 1)
35
36/* The internal structures (prefixed by WDML) are used as follows:
37 * + a WDML_INSTANCE is created for each instance creation (DdeInitialize)
38 * - a popup window (InstanceClass) is created for each instance.
39 * - this window is used to receive all the DDEML events (server registration,
40 * conversation confirmation...). See the WM_WDML_???? messages for details
41 * + when registering a server (DdeNameService) a WDML_SERVER is created
42 * - a popup window (ServerNameClass) is created
43 * + a conversation is represented by two WDML_CONV structures:
44 * - one on the client side, the other one on the server side
45 * - this is needed because the address spaces may be different
46 * - therefore, two lists of links are kept for each instance
47 * - two windows are created for a conversation:
48 * o a popup window on client side (ClientConvClass)
49 * o a child window (of the ServerName) on the server side
50 * (ServerConvClass)
51 * - all the exchanges then take place between those two windows
52 * - windows for the conversation exist in two forms (Ansi & Unicode). This
53 * is only needed when a partner in a conv is not handled by DDEML. The
54 * type (A/W) of the window is used to handle the ansi <=> unicode
55 * transformations
56 * - two handles are created for a conversation (on each side). Each handle
57 * is linked to a structure. To help differentiate those handles, the
58 * local one has an even value, whereas the remote one has an odd value.
59 * + a (warm or link) is represented by two WDML_LINK structures:
60 * - one on client side, the other one on server side
61 * - therefore, two lists of links are kept for each instance
62 *
63 * To help getting back to data, WDML windows store information:
64 * - offset 0: the DDE instance
65 * - offset 4: the current conversation (for ClientConv and ServerConv only)
66 *
67 * All the implementation (client & server) makes the assumption that the other side
68 * is not always a DDEML partner. However, if it's the case, supplementary services
69 * are available (most notably the REGISTER/UNREGISTER and CONNECT_CONFIRM messages
70 * to the callback function). To be correct in every situation, all the basic
71 * exchanges are made using the 'pure' DDE protocol. A (future !) enhancement would
72 * be to provide a new protocol in the case were both partners are handled by DDEML.
73 *
74 * The StringHandles are in fact stored as local atoms. So an HSZ and a (local) atom
75 * can be used interchangeably. However, in order to keep track of the allocated HSZ,
76 * and to free them upon instance termination, all HSZ are stored in a link list.
77 * When the HSZ need to be passed through DDE messages, we need to convert them back and
78 * forth to global atoms.
79 */
80
81/* this struct has the same mapping as all the DDE??? structures */
82typedef struct {
83 unsigned short unused:12,
88 short cfFormat;
90
91typedef struct tagHSZNode
92{
94 HSZ hsz;
95 unsigned refCount;
97
98typedef struct tagWDML_SERVER
99{
108
109typedef struct tagWDML_XACT {
110 struct tagWDML_XACT* next; /* list of transactions in conversation */
113 HDDEDATA hDdeData;
119 ATOM atom; /* as converted from or to hszItem */
121 LPARAM lParam; /* useful for reusing */
123
124typedef struct tagWDML_CONV
125{
126 struct tagWDML_CONV* next; /* to link all the conversations */
128 HSZ hszService; /* pmt used for connection */
129 HSZ hszTopic; /* pmt used for connection */
130 UINT magic; /* magic number to check validity */
131 UINT afCmd; /* service name flag */
133 HWND hwndClient; /* source of conversation (ClientConvClass) */
134 HWND hwndServer; /* destination of conversation (ServerConvClass) */
135 WDML_XACT* transactions; /* pending transactions */
136 DWORD hUser; /* user defined value */
137 DWORD wStatus; /* same bits as convinfo.wStatus */
138 DWORD wConvst; /* same values as convinfo.wConvst */
140
141#define WDML_CONV_MAGIC 0xbabe1234
142
143/* DDE_LINK struct defines hot, warm, and cold links */
144typedef struct tagWDML_LINK {
145 struct tagWDML_LINK* next; /* to link all the active links */
146 HCONV hConv; /* to get back to the conversation */
147 UINT transactionType;/* 0 for no link */
148 HSZ hszItem; /* item targeted for (hot/warm) link */
149 UINT uFmt; /* format for data */
151
152typedef struct tagWDML_INSTANCE
153{
155 DWORD instanceID; /* needed to track monitor usage */
156 DWORD threadID; /* needed to keep instance linked to a unique thread */
157 BOOL monitor; /* have these two as full Booleans cos they'll be tested frequently */
158 BOOL clientOnly; /* bit wasteful of space but it will be faster */
159 BOOL unicode; /* Flag to indicate Win32 API used to initialise */
160 HSZNode* nodeList; /* for cleaning upon exit */
166 DWORD wStatus; /* global instance status */
167 WDML_SERVER* servers; /* list of registered servers */
168 WDML_CONV* convs[2]; /* active conversations for this instance (client and server) */
169 WDML_LINK* links[2]; /* active links for this instance (client and server) */
171
172/* header for the DDE Data objects */
174{
178
179typedef enum tagWDML_SIDE
180{
183
184typedef enum {
187
188extern HDDEDATA WDML_InvokeCallback(WDML_INSTANCE* pInst, UINT uType, UINT uFmt, HCONV hConv,
189 HSZ hsz1, HSZ hsz2, HDDEDATA hdata,
190 ULONG_PTR dwData1, ULONG_PTR dwData2) DECLSPEC_HIDDEN;
192extern void WDML_RemoveServer(WDML_INSTANCE* pInstance, HSZ hszService, HSZ hszTopic) DECLSPEC_HIDDEN;
194/* transaction handler on the server side */
196/* transaction handler on the client side */
198/* called both in DdeClientTransaction and server side. */
200 HSZ hszService, HSZ hszTopic, HWND hwndClient, HWND hwndServer) DECLSPEC_HIDDEN;
201extern void WDML_RemoveConv(WDML_CONV* pConv, WDML_SIDE side) DECLSPEC_HIDDEN;
202extern WDML_CONV* WDML_GetConv(HCONV hConv, BOOL checkConnected) DECLSPEC_HIDDEN;
205 HSZ hszService, HSZ hszTopic) DECLSPEC_HIDDEN;
206extern BOOL WDML_PostAck(WDML_CONV* pConv, WDML_SIDE side, WORD appRetCode,
207 BOOL fBusy, BOOL fAck, UINT_PTR pmt, LPARAM lParam, UINT oldMsg) DECLSPEC_HIDDEN;
208extern void WDML_AddLink(WDML_INSTANCE* pInstance, HCONV hConv, WDML_SIDE side,
209 UINT wType, HSZ hszItem, UINT wFmt) DECLSPEC_HIDDEN;
210extern WDML_LINK* WDML_FindLink(WDML_INSTANCE* pInstance, HCONV hConv, WDML_SIDE side,
211 HSZ hszItem, BOOL use_fmt, UINT uFmt) DECLSPEC_HIDDEN;
212extern void WDML_RemoveLink(WDML_INSTANCE* pInstance, HCONV hConv, WDML_SIDE side,
213 HSZ hszItem, UINT wFmt) DECLSPEC_HIDDEN;
214/* string internals */
219/* client calls these */
221extern void WDML_QueueTransaction(WDML_CONV* pConv, WDML_XACT* pXAct) DECLSPEC_HIDDEN;
224extern HGLOBAL WDML_DataHandle2Global(HDDEDATA hDdeData, BOOL fResponse, BOOL fRelease,
225 BOOL fDeferUpd, BOOL dAckReq) DECLSPEC_HIDDEN;
226extern HDDEDATA WDML_Global2DataHandle(WDML_CONV* pConv, HGLOBAL hMem, WINE_DDEHEAD* da) DECLSPEC_HIDDEN;
227extern BOOL WDML_IsAppOwned(HDDEDATA hDdeData) DECLSPEC_HIDDEN;
230/* broadcasting to DDE windows */
231extern void WDML_BroadcastDDEWindows(LPCWSTR clsName, UINT uMsg,
235
236
237static __inline void WDML_ExtractAck(WORD status, DDEACK* da)
238{
239 *da = *((DDEACK*)&status);
240}
241
242extern const WCHAR WDML_szEventClass[] DECLSPEC_HIDDEN; /* class of window for events (aka instance) */
243extern const char WDML_szServerConvClassA[] DECLSPEC_HIDDEN; /* ANSI class of window for server side conv */
244extern const WCHAR WDML_szServerConvClassW[] DECLSPEC_HIDDEN; /* unicode class of window for server side conv */
245extern const char WDML_szClientConvClassA[] DECLSPEC_HIDDEN; /* ANSI class of window for client side conv */
246extern const WCHAR WDML_szClientConvClassW[] DECLSPEC_HIDDEN; /* unicode class of window for client side conv */
247
248#define WM_WDML_REGISTER (WM_USER + 0x200)
249#define WM_WDML_UNREGISTER (WM_USER + 0x201)
250#define WM_WDML_CONNECT_CONFIRM (WM_USER + 0x202)
251
252/* parameters for messages:
253 * wParam lParam
254 * Register atom for service name atom for service spec
255 * Unregister atom for service name atom for service spec
256 * ConnectConfirm client window handle server window handle
257 */
258
259#define GWL_WDML_INSTANCE (0)
260#define GWL_WDML_CONVERSATION (sizeof(ULONG_PTR))
261#define GWL_WDML_SERVER (sizeof(ULONG_PTR))
262
263#endif /* __WINE_DDEML_PRIVATE_H */
HWND hWnd
Definition: settings.c:17
WPARAM wParam
Definition: combotst.c:138
LPARAM lParam
Definition: combotst.c:139
WDML_CONV * WDML_FindConv(WDML_INSTANCE *pInstance, WDML_SIDE side, HSZ hszService, HSZ hszTopic) DECLSPEC_HIDDEN
Definition: ddemisc.c:2048
WDML_XACT * WDML_AllocTransaction(WDML_INSTANCE *pInstance, UINT ddeMsg, UINT wFmt, HSZ hszItem) DECLSPEC_HIDDEN
Definition: ddemisc.c:1900
HDDEDATA WDML_InvokeCallback(WDML_INSTANCE *pInst, UINT uType, UINT uFmt, HCONV hConv, HSZ hsz1, HSZ hsz2, HDDEDATA hdata, ULONG_PTR dwData1, ULONG_PTR dwData2) DECLSPEC_HIDDEN
Definition: ddemisc.c:1206
HDDEDATA WDML_Global2DataHandle(WDML_CONV *pConv, HGLOBAL hMem, WINE_DDEHEAD *da) DECLSPEC_HIDDEN
Definition: ddemisc.c:1504
void WDML_NotifyThreadDetach(void) DECLSPEC_HIDDEN
Definition: ddemisc.c:1181
ATOM WDML_MakeAtomFromHsz(HSZ hsz) DECLSPEC_HIDDEN
Definition: ddemisc.c:325
WDML_QUEUE_STATE WDML_ServerHandle(WDML_CONV *pConv, WDML_XACT *pXAct) DECLSPEC_HIDDEN
Definition: ddeserver.c:968
enum tagWDML_SIDE WDML_SIDE
static __inline void WDML_ExtractAck(WORD status, DDEACK *da)
Definition: dde_private.h:237
WDML_LINK * WDML_FindLink(WDML_INSTANCE *pInstance, HCONV hConv, WDML_SIDE side, HSZ hszItem, BOOL use_fmt, UINT uFmt) DECLSPEC_HIDDEN
Definition: ddemisc.c:1868
struct tagWDML_CONV WDML_CONV
WDML_INSTANCE * WDML_GetInstanceFromWnd(HWND hWnd) DECLSPEC_HIDDEN
Definition: ddemisc.c:1261
HGLOBAL WDML_DataHandle2Global(HDDEDATA hDdeData, BOOL fResponse, BOOL fRelease, BOOL fDeferUpd, BOOL dAckReq) DECLSPEC_HIDDEN
Definition: ddemisc.c:1563
WDML_CONV * WDML_GetConv(HCONV hConv, BOOL checkConnected) DECLSPEC_HIDDEN
Definition: ddemisc.c:2230
struct tagDDE_DATAHANDLE_HEAD DDE_DATAHANDLE_HEAD
BOOL WDML_DecHSZ(WDML_INSTANCE *pInstance, HSZ hsz) DECLSPEC_HIDDEN
Definition: ddemisc.c:380
struct tagWDML_LINK WDML_LINK
BOOL WDML_UnQueueTransaction(WDML_CONV *pConv, WDML_XACT *pXAct) DECLSPEC_HIDDEN
Definition: ddemisc.c:1947
void WDML_NotifyThreadExit(DWORD tid) DECLSPEC_HIDDEN
void WDML_AddLink(WDML_INSTANCE *pInstance, HCONV hConv, WDML_SIDE side, UINT wType, HSZ hszItem, UINT wFmt) DECLSPEC_HIDDEN
Definition: ddemisc.c:1755
const WCHAR WDML_szEventClass[] DECLSPEC_HIDDEN
Definition: dde_private.h:243
void WDML_RemoveServer(WDML_INSTANCE *pInstance, HSZ hszService, HSZ hszTopic) DECLSPEC_HIDDEN
Definition: ddemisc.c:1670
HDDEDATA WDML_ClientHandle(WDML_CONV *pConv, WDML_XACT *pXAct, DWORD dwTimeout, LPDWORD pdwResult) DECLSPEC_HIDDEN
Definition: ddeclient.c:1090
WDML_SERVER * WDML_FindServer(WDML_INSTANCE *pInstance, HSZ hszService, HSZ hszTopic) DECLSPEC_HIDDEN
Definition: ddemisc.c:1729
WDML_CONV * WDML_GetConvFromWnd(HWND hWnd) DECLSPEC_HIDDEN
Definition: ddemisc.c:2265
void WDML_RemoveLink(WDML_INSTANCE *pInstance, HCONV hConv, WDML_SIDE side, HSZ hszItem, UINT wFmt) DECLSPEC_HIDDEN
Definition: ddemisc.c:1780
struct tagWDML_SERVER WDML_SERVER
void WDML_FreeTransaction(WDML_INSTANCE *pInstance, WDML_XACT *pXAct, BOOL doFreePmt) DECLSPEC_HIDDEN
Definition: ddemisc.c:1967
struct tagWDML_XACT WDML_XACT
BOOL WDML_PostAck(WDML_CONV *pConv, WDML_SIDE side, WORD appRetCode, BOOL fBusy, BOOL fAck, UINT_PTR pmt, LPARAM lParam, UINT oldMsg) DECLSPEC_HIDDEN
Definition: ddemisc.c:2275
struct tagWDML_INSTANCE WDML_INSTANCE
WDML_INSTANCE * WDML_GetInstance(DWORD InstId) DECLSPEC_HIDDEN
Definition: ddemisc.c:1230
tagWDML_SIDE
Definition: dde_private.h:180
@ WDML_SERVER_SIDE
Definition: dde_private.h:181
@ WDML_CLIENT_SIDE
Definition: dde_private.h:181
void WDML_RemoveConv(WDML_CONV *pConv, WDML_SIDE side) DECLSPEC_HIDDEN
Definition: ddemisc.c:2070
BOOL WDML_IncHSZ(WDML_INSTANCE *pInstance, HSZ hsz) DECLSPEC_HIDDEN
Definition: ddemisc.c:362
WDML_SERVER * WDML_AddServer(WDML_INSTANCE *pInstance, HSZ hszService, HSZ hszTopic) DECLSPEC_HIDDEN
Definition: ddemisc.c:1638
HSZ WDML_MakeHszFromAtom(const WDML_INSTANCE *pInstance, ATOM atom) DECLSPEC_HIDDEN
Definition: ddemisc.c:342
void WDML_BroadcastDDEWindows(LPCWSTR clsName, UINT uMsg, WPARAM wParam, LPARAM lParam) DECLSPEC_HIDDEN
Definition: ddemisc.c:2502
WDML_QUEUE_STATE
Definition: dde_private.h:184
@ WDML_QS_PASS
Definition: dde_private.h:185
@ WDML_QS_BLOCK
Definition: dde_private.h:185
@ WDML_QS_HANDLED
Definition: dde_private.h:185
@ WDML_QS_SWALLOWED
Definition: dde_private.h:185
@ WDML_QS_ERROR
Definition: dde_private.h:185
BOOL WDML_IsAppOwned(HDDEDATA hDdeData) DECLSPEC_HIDDEN
Definition: ddemisc.c:1477
struct tagHSZNode HSZNode
WDML_CONV * WDML_AddConv(WDML_INSTANCE *pInstance, WDML_SIDE side, HSZ hszService, HSZ hszTopic, HWND hwndClient, HWND hwndServer) DECLSPEC_HIDDEN
Definition: ddemisc.c:2008
void WDML_QueueTransaction(WDML_CONV *pConv, WDML_XACT *pXAct) DECLSPEC_HIDDEN
Definition: ddemisc.c:1933
const char WDML_szClientConvClassA[]
Definition: ddeclient.c:31
const WCHAR WDML_szClientConvClassW[]
Definition: ddeclient.c:32
const WCHAR WDML_szEventClass[]
Definition: ddemisc.c:38
HDDEDATA(CALLBACK * PFNCALLBACK)(UINT, UINT, HCONV, HSZ, HSZ, HDDEDATA, ULONG_PTR, ULONG_PTR)
Definition: ddeml.h:290
const WCHAR WDML_szServerConvClassW[]
Definition: ddeserver.c:32
const char WDML_szServerConvClassA[]
Definition: ddeserver.c:31
WORD ATOM
Definition: dimm.idl:113
unsigned int BOOL
Definition: ntddk_ex.h:94
unsigned long DWORD
Definition: ntddk_ex.h:95
unsigned short WORD
Definition: ntddk_ex.h:93
FxWmiInstanceExternal * pInstance
Definition: fxwmiapi.cpp:113
static TfClientId tid
unsigned __int3264 UINT_PTR
Definition: mstsclib_h.h:274
unsigned int UINT
Definition: ndis.h:50
_In_ UINT _In_ DWORD _Out_ DWORD * pdwResult
Definition: ntgdi.h:250
static HSZ hszTopic
Definition: shlexec.c:148
Definition: dde.h:51
unsigned short unused
Definition: dde_private.h:83
unsigned short fRelease
Definition: dde_private.h:85
unsigned short fResponse
Definition: dde_private.h:84
unsigned short fAckReq
Definition: dde_private.h:87
unsigned short fDeferUpd
Definition: dde_private.h:86
short cfFormat
Definition: dde_private.h:88
Definition: ps.c:97
struct tagHSZNode * next
Definition: dde_private.h:93
unsigned refCount
Definition: dde_private.h:95
struct tagWDML_CONV * next
Definition: dde_private.h:126
CONVCONTEXT convContext
Definition: dde_private.h:132
WDML_XACT * transactions
Definition: dde_private.h:135
struct tagWDML_INSTANCE * instance
Definition: dde_private.h:127
HSZNode * nodeList
Definition: dde_private.h:160
struct tagWDML_INSTANCE * next
Definition: dde_private.h:154
WDML_LINK * links[2]
Definition: dde_private.h:169
WDML_CONV * convs[2]
Definition: dde_private.h:168
PFNCALLBACK callback
Definition: dde_private.h:161
WDML_SERVER * servers
Definition: dde_private.h:167
struct tagWDML_SERVER * next
Definition: dde_private.h:100
ATOM atomServiceSpec
Definition: dde_private.h:104
HDDEDATA hDdeData
Definition: dde_private.h:113
struct tagWDML_XACT * next
Definition: dde_private.h:110
DWORD dwTimeout
Definition: dde_private.h:114
LPARAM lParam
Definition: dde_private.h:121
HGLOBAL hMem
Definition: dde_private.h:120
uint32_t * LPDWORD
Definition: typedefs.h:59
uint32_t ULONG_PTR
Definition: typedefs.h:65
_In_ void _In_ PCCERT_CONTEXT _In_opt_ LPFILETIME _In_ DWORD _In_ DWORD dwTimeout
Definition: wincrypt.h:6081
LONG_PTR LPARAM
Definition: windef.h:208
UINT_PTR WPARAM
Definition: windef.h:207
__wchar_t WCHAR
Definition: xmlstorage.h:180
const WCHAR * LPCWSTR
Definition: xmlstorage.h:185