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