GHOST/X11: support accessing physical keycodes
[blender.git] / intern / ghost / intern / GHOST_SystemX11.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program 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
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file ghost/intern/GHOST_SystemX11.h
29  *  \ingroup GHOST
30  * Declaration of GHOST_SystemX11 class.
31  */
32
33 #ifndef __GHOST_SYSTEMX11_H__
34 #define __GHOST_SYSTEMX11_H__
35
36 #include <X11/Xlib.h>
37 #include <X11/XKBlib.h> /* allow detectable autorepeate */
38
39 #include "GHOST_System.h"
40 #include "../GHOST_Types.h"
41
42 // For tablets
43 #ifdef WITH_X11_XINPUT
44 #  include <X11/extensions/XInput.h>
45 #endif
46
47 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
48 #  define GHOST_X11_RES_NAME  "Blender" /* res_name */
49 #  define GHOST_X11_RES_CLASS "Blender" /* res_class */
50 #endif
51
52 /* generic error handlers */
53 int GHOST_X11_ApplicationErrorHandler(Display *display, XErrorEvent *theEvent);
54 int GHOST_X11_ApplicationIOErrorHandler(Display *display);
55
56 #define GHOST_X11_ERROR_HANDLERS_OVERRIDE(var) \
57         struct { \
58                 XErrorHandler handler; \
59                 XIOErrorHandler handler_io; \
60         } var = { \
61                 XSetErrorHandler(GHOST_X11_ApplicationErrorHandler), \
62                 XSetIOErrorHandler(GHOST_X11_ApplicationIOErrorHandler), \
63         }
64
65 #define GHOST_X11_ERROR_HANDLERS_RESTORE(var) \
66         { \
67                 (void)XSetErrorHandler(var.handler); \
68                 (void)XSetIOErrorHandler(var.handler_io); \
69         } ((void)0)
70
71 class GHOST_WindowX11;
72
73 /**
74  * X11 Implementation of GHOST_System class.
75  * \see GHOST_System.
76  * \author      Laurence Bourn
77  * \date        October 26, 2001
78  */
79
80 class GHOST_SystemX11 : public GHOST_System {
81 public:
82
83         /**
84          * Constructor
85          * this class should only be instanciated by GHOST_ISystem.
86          */
87
88         GHOST_SystemX11(
89             );
90
91         /**
92          * Destructor.
93          */
94         ~GHOST_SystemX11();
95
96
97         GHOST_TSuccess
98         init(
99             );
100
101         /**
102          * Informs if the system provides native dialogs (eg. confirm quit)
103          */
104         virtual bool supportsNativeDialogs(void);
105
106         /**
107          * \section Interface Inherited from GHOST_ISystem
108          */
109
110         /**
111          * Returns the system time.
112          * Returns the number of milliseconds since the start of the system process.
113          * \return The number of milliseconds.
114          */
115         GHOST_TUns64
116         getMilliSeconds(
117             ) const;
118
119
120         /**
121          * Returns the number of displays on this system.
122          * \return The number of displays.
123          */
124         GHOST_TUns8
125         getNumDisplays(
126             ) const;
127
128         /**
129          * Returns the dimensions of the main display on this system.
130          * \return The dimension of the main display.
131          */
132         void
133         getMainDisplayDimensions(
134             GHOST_TUns32& width,
135             GHOST_TUns32& height
136             ) const;
137
138         /**
139          * Returns the dimensions of all displays on this system.
140          * \return The dimension of the main display.
141          */
142         void
143         getAllDisplayDimensions(
144             GHOST_TUns32& width,
145             GHOST_TUns32& height
146             ) const;
147
148         /**
149          * Create a new window.
150          * The new window is added to the list of windows managed.
151          * Never explicitly delete the window, use disposeWindow() instead.
152          * \param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
153          * \param       left            The coordinate of the left edge of the window.
154          * \param       top             The coordinate of the top edge of the window.
155          * \param       width           The width the window.
156          * \param       height          The height the window.
157          * \param       state           The state of the window when opened.
158          * \param       type            The type of drawing context installed in this window.
159          * \param       stereoVisual    Create a stereo visual for quad buffered stereo.
160          * \param       exclusive       Use to show the window ontop and ignore others
161          *                                              (used fullscreen).
162          * \param       parentWindow    Parent (embedder) window
163          * \return      The new window (or 0 if creation failed).
164          */
165         GHOST_IWindow *
166         createWindow(
167             const STR_String& title,
168             GHOST_TInt32 left,
169             GHOST_TInt32 top,
170             GHOST_TUns32 width,
171             GHOST_TUns32 height,
172             GHOST_TWindowState state,
173             GHOST_TDrawingContextType type,
174             GHOST_GLSettings glSettings,
175             const bool exclusive = false,
176             const GHOST_TEmbedderWindowID parentWindow = 0
177             );
178
179         /**
180          * Retrieves events from the system and stores them in the queue.
181          * \param waitForEvent Flag to wait for an event (or return immediately).
182          * \return Indication of the presence of events.
183          */
184         bool
185         processEvents(
186             bool waitForEvent
187             );
188
189         GHOST_TSuccess
190         getCursorPosition(
191             GHOST_TInt32& x,
192             GHOST_TInt32& y
193             ) const;
194
195         GHOST_TSuccess
196         setCursorPosition(
197             GHOST_TInt32 x,
198             GHOST_TInt32 y
199             );
200
201         /**
202          * Returns the state of all modifier keys.
203          * \param keys  The state of all modifier keys (true == pressed).
204          * \return              Indication of success.
205          */
206         GHOST_TSuccess
207         getModifierKeys(
208             GHOST_ModifierKeys& keys
209             ) const;
210
211         /**
212          * Returns the state of the mouse buttons (ouside the message queue).
213          * \param buttons       The state of the buttons.
214          * \return                      Indication of success.
215          */
216         GHOST_TSuccess
217         getButtons(
218             GHOST_Buttons& buttons
219             ) const;
220
221         /**
222          * Flag a window as dirty. This will
223          * generate a GHOST window update event on a call to processEvents()
224          */
225
226         void
227         addDirtyWindow(
228             GHOST_WindowX11 *bad_wind
229             );
230
231
232         /**
233          * return a pointer to the X11 display structure
234          */
235
236         Display *
237         getXDisplay(
238                 ) {
239                 return m_display;
240         }
241
242 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
243         XIM
244         getX11_XIM()
245         {
246                 return m_xim;
247         }
248 #endif
249
250         /* Helped function for get data from the clipboard. */
251         void getClipboard_xcout(const XEvent *evt, Atom sel, Atom target,
252                                 unsigned char **txt, unsigned long *len,
253                                 unsigned int *context) const;
254
255         /**
256          * Returns unsigned char from CUT_BUFFER0
257          * \param selection             Get selection, X11 only feature
258          * \return                              Returns the Clipboard indicated by Flag
259          */
260         GHOST_TUns8 *getClipboard(bool selection) const;
261
262         /**
263          * Puts buffer to system clipboard
264          * \param buffer        The buffer to copy to the clipboard
265          * \param selection     Set the selection into the clipboard, X11 only feature
266          */
267         void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
268
269 #ifdef WITH_XDND
270         /**
271          * Creates a drag'n'drop event and pushes it immediately onto the event queue.
272          * Called by GHOST_DropTargetX11 class.
273          * \param eventType The type of drag'n'drop event
274          * \param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
275          * \param mouseX x mouse coordinate (in window coordinates)
276          * \param mouseY y mouse coordinate
277          * \param window The window on which the event occurred
278          * \return Indication whether the event was handled.
279          */
280         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType, GHOST_IWindow *window, int mouseX, int mouseY, void *data);
281 #endif
282
283         /**
284          * \see GHOST_ISystem
285          */
286         int toggleConsole(int /*action*/) {
287                 return 0;
288         }
289
290 #ifdef WITH_X11_XINPUT
291         typedef struct GHOST_TabletX11 {
292                 XDevice *StylusDevice;
293                 XDevice *EraserDevice;
294
295                 XID StylusID, EraserID;
296
297                 int MotionEvent;
298                 int ProxInEvent;
299                 int ProxOutEvent;
300                 int PressEvent;
301
302                 int MotionEventEraser;
303                 int ProxInEventEraser;
304                 int ProxOutEventEraser;
305                 int PressEventEraser;
306
307                 int PressureLevels;
308                 int XtiltLevels, YtiltLevels;
309         } GHOST_TabletX11;
310
311         GHOST_TabletX11 &GetXTablet()
312         {
313                 return m_xtablet;
314         }
315 #endif // WITH_X11_XINPUT
316
317         struct {
318                 /**
319                  * Atom used for ICCCM, WM-spec and Motif.
320                  * We only need get this atom at the start, it's relative
321                  * to the display not the window and are public for every
322                  * window that need it.
323                  */
324                 Atom WM_STATE;
325                 Atom WM_CHANGE_STATE;
326                 Atom _NET_WM_STATE;
327                 Atom _NET_WM_STATE_MAXIMIZED_HORZ;
328                 Atom _NET_WM_STATE_MAXIMIZED_VERT;
329                 Atom _NET_WM_STATE_FULLSCREEN;
330                 Atom _MOTIF_WM_HINTS;
331                 Atom WM_TAKE_FOCUS;
332                 Atom WM_PROTOCOLS;
333                 Atom WM_DELETE_WINDOW;
334
335                 /* Atoms for Selection, copy & paste. */
336                 Atom TARGETS;
337                 Atom STRING;
338                 Atom COMPOUND_TEXT;
339                 Atom TEXT;
340                 Atom CLIPBOARD;
341                 Atom PRIMARY;
342                 Atom XCLIP_OUT;
343                 Atom INCR;
344                 Atom UTF8_STRING;
345 #ifdef WITH_X11_XINPUT
346                 Atom TABLET;
347 #endif
348         } m_atom;
349
350 #ifdef WITH_X11_XINPUT
351         XExtensionVersion m_xinput_version;
352 #endif
353
354 private:
355
356         Display *m_display;
357
358         /* Use for scancode lookups. */
359         XkbDescRec *m_xkb_descr;
360
361 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
362         XIM m_xim;
363 #endif
364
365 #ifdef WITH_X11_XINPUT
366         /* Tablet devices */
367         GHOST_TabletX11 m_xtablet;
368 #endif
369
370         /// The vector of windows that need to be updated.
371         std::vector<GHOST_WindowX11 *> m_dirty_windows;
372
373         /// Start time at initialization.
374         GHOST_TUns64 m_start_time;
375
376         /// A vector of keyboard key masks
377         char m_keyboard_vector[32];
378
379         /* to prevent multiple warp, we store the time of the last warp event
380          *  and stop accumulating all events generated before that */
381         Time m_last_warp;
382
383         /* detect autorepeat glitch */
384         unsigned int m_last_release_keycode;
385         Time m_last_release_time;
386
387         /**
388          * Return the ghost window associated with the
389          * X11 window xwind
390          */
391
392 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
393         bool openX11_IM();
394 #endif
395
396 #ifdef WITH_X11_XINPUT
397         void refreshXInputDevices();
398 #endif
399
400         GHOST_WindowX11 *
401         findGhostWindow(
402             Window xwind
403             ) const;
404
405         void
406         processEvent(
407             XEvent *xe
408             );
409
410         Time
411         lastEventTime(
412             Time default_time
413             );
414
415         bool
416         generateWindowExposeEvents(
417             );
418 };
419
420 #endif
421