Make more of the OLE interface vtables const.
[wine] / dlls / dplayx / dplay_global.h
1 /*
2  * Copyright 2000 Peter Hunnisett
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2.1 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General Public
15  * License along with this library; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17  */
18
19 #ifndef __WINE_DPLAY_GLOBAL_INCLUDED
20 #define __WINE_DPLAY_GLOBAL_INCLUDED
21
22 #include <stdarg.h>
23
24 #include "windef.h"
25 #include "winbase.h"
26 #include "dplaysp.h"
27 #include "lobbysp.h"
28 #include "dplayx_queue.h"
29
30 extern HRESULT DPL_EnumAddress( LPDPENUMADDRESSCALLBACK lpEnumAddressCallback,
31                                 LPCVOID lpAddress, DWORD dwAddressSize,
32                                 LPVOID lpContext );
33
34 extern DWORD DP_CalcSessionDescSize( LPCDPSESSIONDESC2 lpSessDesc, BOOL bAnsi );
35
36 /*****************************************************************************
37  * Predeclare the interface implementation structures
38  */
39 typedef struct IDirectPlay2Impl IDirectPlay2AImpl;
40 typedef struct IDirectPlay2Impl IDirectPlay2Impl;
41 typedef struct IDirectPlay3Impl IDirectPlay3AImpl;
42 typedef struct IDirectPlay3Impl IDirectPlay3Impl;
43 typedef struct IDirectPlay4Impl IDirectPlay4AImpl;
44 typedef struct IDirectPlay4Impl IDirectPlay4Impl;
45
46 typedef struct tagDirectPlayIUnknownData
47 {
48   ULONG             ulObjRef;
49   CRITICAL_SECTION  DP_lock;
50 } DirectPlayIUnknownData;
51
52 typedef struct tagEnumSessionAsyncCallbackData
53 {
54   LPSPINITDATA lpSpData;
55   GUID         requestGuid;
56   DWORD        dwEnumSessionFlags;
57   DWORD        dwTimeout;
58   HANDLE       hSuicideRequest;
59 } EnumSessionAsyncCallbackData;
60
61 typedef struct tagDP_MSG_REPLY_STRUCT
62 {
63   HANDLE hReceipt;
64   WORD   wExpectedReply;
65   LPVOID lpReplyMsg;
66   DWORD  dwMsgBodySize;
67   /* FIXME: Is the message header required as well? */
68 } DP_MSG_REPLY_STRUCT, *LPDP_MSG_REPLY_STRUCT;
69
70 typedef struct tagDP_MSG_REPLY_STRUCT_LIST
71 {
72   DPQ_ENTRY(tagDP_MSG_REPLY_STRUCT_LIST) replysExpected;
73   DP_MSG_REPLY_STRUCT replyExpected;
74 } DP_MSG_REPLY_STRUCT_LIST, *LPDP_MSG_REPLY_STRUCT_LIST;
75
76 struct PlayerData
77 {
78   /* Individual player information */
79   DPID dpid;
80
81   DPNAME name;
82   HANDLE hEvent;
83
84   ULONG  uRef;  /* What is the reference count on this data? */
85
86   /* View of local data */
87   LPVOID lpLocalData;
88   DWORD  dwLocalDataSize;
89
90   /* View of remote data */
91   LPVOID lpRemoteData;
92   DWORD  dwRemoteDataSize;
93
94   /* SP data on a per player basis */
95   LPVOID lpSPPlayerData;
96
97   DWORD  dwFlags; /* Special remarks about the type of player */
98 };
99 typedef struct PlayerData* lpPlayerData;
100
101 struct PlayerList
102 {
103   DPQ_ENTRY(PlayerList) players;
104
105   lpPlayerData lpPData;
106 };
107 typedef struct PlayerList* lpPlayerList;
108
109 struct GroupData
110 {
111   /* Internal information */
112   DPID parent; /* If parent == 0 it's a top level group */
113
114   ULONG uRef; /* Reference count */
115
116   DPQ_HEAD(GroupList)  groups;  /* A group has [0..n] groups */
117   DPQ_HEAD(PlayerList) players; /* A group has [0..n] players */
118
119   DPID idGroupOwner; /* ID of player who owns the group */
120
121   DWORD dwFlags; /* Flags describing anything special about the group */
122
123   DPID   dpid;
124   DPNAME name;
125
126   /* View of local data */
127   LPVOID lpLocalData;
128   DWORD  dwLocalDataSize;
129
130   /* View of remote data */
131   LPVOID lpRemoteData;
132   DWORD  dwRemoteDataSize;
133 };
134 typedef struct GroupData  GroupData;
135 typedef struct GroupData* lpGroupData;
136
137 struct GroupList
138 {
139   DPQ_ENTRY(GroupList) groups;
140
141   lpGroupData lpGData;
142 };
143 typedef struct GroupList* lpGroupList;
144
145 struct DPMSG
146 {
147   DPQ_ENTRY( DPMSG ) msgs;
148   DPMSG_GENERIC* msg;
149 };
150 typedef struct DPMSG* LPDPMSG;
151
152 enum SPSTATE
153 {
154   NO_PROVIDER = 0,
155   DP_SERVICE_PROVIDER = 1,
156   DP_LOBBY_PROVIDER = 2
157 };
158
159 /* Contains all data members. FIXME: Rename me */
160 typedef struct tagDirectPlay2Data
161 {
162   BOOL   bConnectionOpen;
163
164   /* For async EnumSessions requests */
165   HANDLE hEnumSessionThread;
166   HANDLE hKillEnumSessionThreadEvent;
167
168   LPVOID lpNameServerData; /* DPlay interface doesn't know contents */
169
170   BOOL bHostInterface; /* Did this interface create the session */
171
172   lpGroupData lpSysGroup; /* System group with _everything_ in it */
173
174   LPDPSESSIONDESC2 lpSessionDesc;
175
176   /* I/O Msg queues */
177   DPQ_HEAD( DPMSG ) receiveMsgs; /* Msg receive queue */
178   DPQ_HEAD( DPMSG ) sendMsgs;    /* Msg send pending queue */
179
180   /* Information about the service provider active on this connection */
181   SPINITDATA spData;
182   BOOL       bSPInitialized;
183
184   /* Information about the lobby server that's attached to this DP object */
185   SPDATA_INIT dplspData;
186   BOOL        bDPLSPInitialized;
187
188   /* Our service provider */
189   HMODULE hServiceProvider;
190
191   /* Our DP lobby provider */
192   HMODULE hDPLobbyProvider;
193
194   enum SPSTATE connectionInitialized;
195
196   /* Expected messages queue */
197   DPQ_HEAD( tagDP_MSG_REPLY_STRUCT_LIST ) replysExpected;
198 } DirectPlay2Data;
199
200 typedef struct tagDirectPlay3Data
201 {
202   BOOL dummy;
203 } DirectPlay3Data;
204 typedef struct tagDirectPlay4Data
205 {
206   BOOL dummy;
207 } DirectPlay4Data;
208
209 #define DP_IMPL_FIELDS \
210   ULONG ulInterfaceRef; \
211   DirectPlayIUnknownData*  unk; \
212   DirectPlay2Data*         dp2; \
213   DirectPlay3Data*         dp3; \
214   DirectPlay4Data*         dp4;
215
216 struct IDirectPlay2Impl
217 {
218   const IDirectPlay2Vtbl *lpVtbl;
219   DP_IMPL_FIELDS
220 };
221
222 struct IDirectPlay3Impl
223 {
224   const IDirectPlay3Vtbl *lpVtbl;
225   DP_IMPL_FIELDS
226 };
227
228 struct IDirectPlay4Impl
229 {
230   const IDirectPlay4Vtbl *lpVtbl;
231   DP_IMPL_FIELDS
232 };
233
234 HRESULT DP_HandleMessage( IDirectPlay2Impl* This, LPCVOID lpMessageBody,
235                           DWORD  dwMessageBodySize, LPCVOID lpMessageHeader,
236                           WORD wCommandId, WORD wVersion,
237                           LPVOID* lplpReply, LPDWORD lpdwMsgSize );
238
239 /* DP SP external interfaces into DirectPlay */
240 extern HRESULT DP_GetSPPlayerData( IDirectPlay2Impl* lpDP, DPID idPlayer, LPVOID* lplpData );
241 extern HRESULT DP_SetSPPlayerData( IDirectPlay2Impl* lpDP, DPID idPlayer, LPVOID lpData );
242
243 /* DP external interfaces to call into DPSP interface */
244 extern LPVOID DPSP_CreateSPPlayerData(void);
245
246 #endif /* __WINE_DPLAY_GLOBAL_INCLUDED */