dinput: Add helper function to dump mouse state.
[wine] / dlls / dinput / device_private.h
1 /*
2  * Copyright 2000 Lionel Ulmer
3  * Copyright 2000-2001 TransGaming Technologies Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
18  */
19
20 #ifndef __WINE_DLLS_DINPUT_DINPUTDEVICE_PRIVATE_H
21 #define __WINE_DLLS_DINPUT_DINPUTDEVICE_PRIVATE_H
22
23 #include <stdarg.h>
24
25 #include "windef.h"
26 #include "winbase.h"
27 #include "dinput.h"
28 #include "wine/list.h"
29 #include "dinput_private.h"
30
31 typedef struct
32 {
33     int size;
34     int offset_in;
35     int offset_out;
36     int value;
37 } DataTransform;
38
39 typedef struct
40 {
41     int                         size;
42     int                         internal_format_size;
43     DataTransform              *dt;
44
45     int                        *offsets;     /* object offsets */
46     LPDIDATAFORMAT              wine_df;     /* wine internal data format */
47     LPDIDATAFORMAT              user_df;     /* user defined data format */
48 } DataFormat;
49
50 /* Device implementation */
51 typedef struct IDirectInputDevice2AImpl IDirectInputDevice2AImpl;
52 struct IDirectInputDevice2AImpl
53 {
54     const void                 *lpVtbl;
55     LONG                        ref;
56     GUID                        guid;
57     CRITICAL_SECTION            crit;
58     IDirectInputImpl           *dinput;
59     struct list                 entry;       /* entry into IDirectInput devices list */
60     HANDLE                      hEvent;
61     DWORD                       dwCoopLevel;
62     HWND                        win;
63     int                         acquired;
64     DI_EVENT_PROC               event_proc;  /* function to receive mouse & keyboard events */
65
66     LPDIDEVICEOBJECTDATA        data_queue;  /* buffer for 'GetDeviceData'.                 */
67     int                         queue_len;   /* size of the queue - set in 'SetProperty'    */
68     int                         queue_head;  /* position to write new event into queue      */
69     int                         queue_tail;  /* next event to read from queue               */
70     BOOL                        overflow;    /* return DI_BUFFEROVERFLOW in 'GetDeviceData' */
71
72     DataFormat                  data_format; /* user data format and wine to user format converter */
73 };
74
75 /* Routines to do DataFormat / WineFormat conversions */
76 extern void fill_DataFormat(void *out, const void *in, const DataFormat *df) ;
77 extern HRESULT create_DataFormat(LPCDIDATAFORMAT asked_format, DataFormat *format);
78 extern void release_DataFormat(DataFormat *df) ;
79 extern void queue_event(LPDIRECTINPUTDEVICE8A iface, int ofs, DWORD data, DWORD time, DWORD seq);
80 /* Helper functions to work with data format */
81 extern int id_to_object(LPCDIDATAFORMAT df, int id);
82 extern int id_to_offset(const DataFormat *df, int id);
83 extern int find_property(const DataFormat *df, LPCDIPROPHEADER ph);
84
85 /* Common joystick stuff */
86 typedef struct
87 {
88     LONG lDevMin;
89     LONG lDevMax;
90     LONG lMin;
91     LONG lMax;
92     LONG lDeadZone;
93     LONG lSaturation;
94 } ObjProps;
95
96 extern DWORD joystick_map_pov(POINTL *p);
97 extern LONG joystick_map_axis(ObjProps *props, int val);
98
99 /**
100  * Callback Data used by specific callback 
101  *  for EnumObject on 'W' interfaces
102  */
103 typedef struct {
104   LPDIENUMDEVICEOBJECTSCALLBACKW lpCallBack;
105   LPVOID lpvRef;
106 } device_enumobjects_AtoWcb_data;
107
108 extern BOOL DIEnumDevicesCallbackAtoW(LPCDIDEVICEOBJECTINSTANCEA, LPVOID);
109
110 extern const GUID DInput_Wine_Keyboard_GUID;
111 extern const GUID DInput_Wine_Mouse_GUID;
112
113 /* Various debug tools */
114 extern void _dump_cooperativelevel_DI(DWORD dwFlags) ;
115 extern void _dump_EnumObjects_flags(DWORD dwFlags) ;
116 extern void _dump_DIPROPHEADER(LPCDIPROPHEADER diph) ;
117 extern void _dump_OBJECTINSTANCEA(const DIDEVICEOBJECTINSTANCEA *ddoi) ;
118 extern void _dump_OBJECTINSTANCEW(const DIDEVICEOBJECTINSTANCEW *ddoi) ;
119 extern void _dump_DIDATAFORMAT(const DIDATAFORMAT *df) ;
120 extern const char *_dump_dinput_GUID(const GUID *guid) ;
121
122 /* And the stubs */
123 extern HRESULT WINAPI IDirectInputDevice2AImpl_Acquire(LPDIRECTINPUTDEVICE8A iface);
124 extern HRESULT WINAPI IDirectInputDevice2AImpl_Unacquire(LPDIRECTINPUTDEVICE8A iface);
125 extern HRESULT WINAPI IDirectInputDevice2AImpl_SetDataFormat(
126         LPDIRECTINPUTDEVICE8A iface,LPCDIDATAFORMAT df ) ;
127 extern HRESULT WINAPI IDirectInputDevice2AImpl_SetCooperativeLevel(
128         LPDIRECTINPUTDEVICE8A iface,HWND hwnd,DWORD dwflags ) ;
129 extern HRESULT WINAPI IDirectInputDevice2AImpl_SetEventNotification(
130         LPDIRECTINPUTDEVICE8A iface,HANDLE hnd ) ;
131 extern ULONG WINAPI IDirectInputDevice2AImpl_Release(LPDIRECTINPUTDEVICE8A iface) ;
132 extern HRESULT WINAPI IDirectInputDevice2AImpl_QueryInterface(LPDIRECTINPUTDEVICE8A iface,REFIID riid,LPVOID *ppobj);
133 extern HRESULT WINAPI IDirectInputDevice2WImpl_QueryInterface(LPDIRECTINPUTDEVICE8W iface,REFIID riid,LPVOID *ppobj);
134 extern ULONG WINAPI IDirectInputDevice2AImpl_AddRef(
135         LPDIRECTINPUTDEVICE8A iface) ;
136 extern HRESULT WINAPI IDirectInputDevice2AImpl_EnumObjects(
137         LPDIRECTINPUTDEVICE8A iface,
138         LPDIENUMDEVICEOBJECTSCALLBACKA lpCallback,
139         LPVOID lpvRef,
140         DWORD dwFlags) ;
141 extern HRESULT WINAPI IDirectInputDevice2WImpl_EnumObjects(
142         LPDIRECTINPUTDEVICE8W iface,
143         LPDIENUMDEVICEOBJECTSCALLBACKW lpCallback,
144         LPVOID lpvRef,
145         DWORD dwFlags) ;
146 extern HRESULT WINAPI IDirectInputDevice2AImpl_GetProperty(LPDIRECTINPUTDEVICE8A iface, REFGUID rguid, LPDIPROPHEADER pdiph);
147 extern HRESULT WINAPI IDirectInputDevice2AImpl_SetProperty(LPDIRECTINPUTDEVICE8A iface, REFGUID rguid, LPCDIPROPHEADER pdiph);
148 extern HRESULT WINAPI IDirectInputDevice2AImpl_GetObjectInfo(
149         LPDIRECTINPUTDEVICE8A iface,
150         LPDIDEVICEOBJECTINSTANCEA pdidoi,
151         DWORD dwObj,
152         DWORD dwHow) ;
153 extern HRESULT WINAPI IDirectInputDevice2WImpl_GetObjectInfo(LPDIRECTINPUTDEVICE8W iface, 
154                                                              LPDIDEVICEOBJECTINSTANCEW pdidoi,
155                                                              DWORD dwObj,
156                                                              DWORD dwHow);
157 extern HRESULT WINAPI IDirectInputDevice2AImpl_GetDeviceData(LPDIRECTINPUTDEVICE8A iface,
158         DWORD dodsize, LPDIDEVICEOBJECTDATA dod, LPDWORD entries, DWORD flags);
159 extern HRESULT WINAPI IDirectInputDevice2AImpl_GetDeviceInfo(
160         LPDIRECTINPUTDEVICE8A iface,
161         LPDIDEVICEINSTANCEA pdidi) ;
162 extern HRESULT WINAPI IDirectInputDevice2WImpl_GetDeviceInfo(
163         LPDIRECTINPUTDEVICE8W iface,
164         LPDIDEVICEINSTANCEW pdidi) ;
165 extern HRESULT WINAPI IDirectInputDevice2AImpl_RunControlPanel(
166         LPDIRECTINPUTDEVICE8A iface,
167         HWND hwndOwner,
168         DWORD dwFlags) ;
169 extern HRESULT WINAPI IDirectInputDevice2AImpl_Initialize(
170         LPDIRECTINPUTDEVICE8A iface,
171         HINSTANCE hinst,
172         DWORD dwVersion,
173         REFGUID rguid) ;
174 extern HRESULT WINAPI IDirectInputDevice2AImpl_CreateEffect(
175         LPDIRECTINPUTDEVICE8A iface,
176         REFGUID rguid,
177         LPCDIEFFECT lpeff,
178         LPDIRECTINPUTEFFECT *ppdef,
179         LPUNKNOWN pUnkOuter) ;
180 extern HRESULT WINAPI IDirectInputDevice2AImpl_EnumEffects(
181         LPDIRECTINPUTDEVICE8A iface,
182         LPDIENUMEFFECTSCALLBACKA lpCallback,
183         LPVOID lpvRef,
184         DWORD dwFlags) ;
185 extern HRESULT WINAPI IDirectInputDevice2WImpl_EnumEffects(
186         LPDIRECTINPUTDEVICE8W iface,
187         LPDIENUMEFFECTSCALLBACKW lpCallback,
188         LPVOID lpvRef,
189         DWORD dwFlags) ;
190 extern HRESULT WINAPI IDirectInputDevice2AImpl_GetEffectInfo(
191         LPDIRECTINPUTDEVICE8A iface,
192         LPDIEFFECTINFOA lpdei,
193         REFGUID rguid) ;
194 extern HRESULT WINAPI IDirectInputDevice2WImpl_GetEffectInfo(
195         LPDIRECTINPUTDEVICE8W iface,
196         LPDIEFFECTINFOW lpdei,
197         REFGUID rguid) ;
198 extern HRESULT WINAPI IDirectInputDevice2AImpl_GetForceFeedbackState(
199         LPDIRECTINPUTDEVICE8A iface,
200         LPDWORD pdwOut) ;
201 extern HRESULT WINAPI IDirectInputDevice2AImpl_SendForceFeedbackCommand(
202         LPDIRECTINPUTDEVICE8A iface,
203         DWORD dwFlags) ;
204 extern HRESULT WINAPI IDirectInputDevice2AImpl_EnumCreatedEffectObjects(
205         LPDIRECTINPUTDEVICE8A iface,
206         LPDIENUMCREATEDEFFECTOBJECTSCALLBACK lpCallback,
207         LPVOID lpvRef,
208         DWORD dwFlags) ;
209 extern HRESULT WINAPI IDirectInputDevice2AImpl_Escape(
210         LPDIRECTINPUTDEVICE8A iface,
211         LPDIEFFESCAPE lpDIEEsc) ;
212 extern HRESULT WINAPI IDirectInputDevice2AImpl_Poll(
213         LPDIRECTINPUTDEVICE8A iface) ;
214 extern HRESULT WINAPI IDirectInputDevice2AImpl_SendDeviceData(
215         LPDIRECTINPUTDEVICE8A iface,
216         DWORD cbObjectData,
217         LPCDIDEVICEOBJECTDATA rgdod,
218         LPDWORD pdwInOut,
219         DWORD dwFlags) ;
220 extern HRESULT WINAPI IDirectInputDevice7AImpl_EnumEffectsInFile(LPDIRECTINPUTDEVICE8A iface,
221                                                                  LPCSTR lpszFileName,
222                                                                  LPDIENUMEFFECTSINFILECALLBACK pec,
223                                                                  LPVOID pvRef,
224                                                                  DWORD dwFlags) ;
225 extern HRESULT WINAPI IDirectInputDevice7WImpl_EnumEffectsInFile(LPDIRECTINPUTDEVICE8W iface,
226                                                                  LPCWSTR lpszFileName,
227                                                                  LPDIENUMEFFECTSINFILECALLBACK pec,
228                                                                  LPVOID pvRef,
229                                                                  DWORD dwFlags) ;
230 extern HRESULT WINAPI IDirectInputDevice7AImpl_WriteEffectToFile(LPDIRECTINPUTDEVICE8A iface,
231                                                                  LPCSTR lpszFileName,
232                                                                  DWORD dwEntries,
233                                                                  LPDIFILEEFFECT rgDiFileEft,
234                                                                  DWORD dwFlags) ;
235 extern HRESULT WINAPI IDirectInputDevice7WImpl_WriteEffectToFile(LPDIRECTINPUTDEVICE8W iface,
236                                                                  LPCWSTR lpszFileName,
237                                                                  DWORD dwEntries,
238                                                                  LPDIFILEEFFECT rgDiFileEft,
239                                                                  DWORD dwFlags) ;
240 extern HRESULT WINAPI IDirectInputDevice8AImpl_BuildActionMap(LPDIRECTINPUTDEVICE8A iface,
241                                                               LPDIACTIONFORMATA lpdiaf,
242                                                               LPCSTR lpszUserName,
243                                                               DWORD dwFlags);
244 extern HRESULT WINAPI IDirectInputDevice8WImpl_BuildActionMap(LPDIRECTINPUTDEVICE8W iface,
245                                                               LPDIACTIONFORMATW lpdiaf,
246                                                               LPCWSTR lpszUserName,
247                                                               DWORD dwFlags);
248 extern HRESULT WINAPI IDirectInputDevice8AImpl_SetActionMap(LPDIRECTINPUTDEVICE8A iface,
249                                                             LPDIACTIONFORMATA lpdiaf,
250                                                             LPCSTR lpszUserName,
251                                                             DWORD dwFlags);
252 extern HRESULT WINAPI IDirectInputDevice8WImpl_SetActionMap(LPDIRECTINPUTDEVICE8W iface,
253                                                             LPDIACTIONFORMATW lpdiaf,
254                                                             LPCWSTR lpszUserName,
255                                                             DWORD dwFlags);
256 extern HRESULT WINAPI IDirectInputDevice8AImpl_GetImageInfo(LPDIRECTINPUTDEVICE8A iface,
257                                                             LPDIDEVICEIMAGEINFOHEADERA lpdiDevImageInfoHeader);
258 extern HRESULT WINAPI IDirectInputDevice8WImpl_GetImageInfo(LPDIRECTINPUTDEVICE8W iface,
259                                                             LPDIDEVICEIMAGEINFOHEADERW lpdiDevImageInfoHeader);
260
261 #endif /* __WINE_DLLS_DINPUT_DINPUTDEVICE_PRIVATE_H */