73d9c95e273309761ebce5bc947862125935d9d4
[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_SYSTEM_X11_H_
34 #define _GHOST_SYSTEM_X11_H_
35
36 #include <X11/Xlib.h>
37 #include <GL/glx.h>
38
39 #include "GHOST_System.h"
40 #include "../GHOST_Types.h"
41
42 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
43 #  define GHOST_X11_RES_NAME  "Blender" /* res_name */
44 #  define GHOST_X11_RES_CLASS "Blender" /* res_class */
45 #endif
46
47
48 class GHOST_WindowX11;
49
50 /**
51  * X11 Implementation of GHOST_System class.
52  * @see GHOST_System.
53  * @author      Laurence Bourn
54  * @date        October 26, 2001
55  */
56
57 class GHOST_SystemX11 : public GHOST_System {
58 public:
59
60         /**
61          * Constructor
62          * this class should only be instanciated by GHOST_ISystem.
63          */
64
65         GHOST_SystemX11(
66         );
67         
68         /**
69          * Destructor.
70          */
71         virtual ~GHOST_SystemX11();
72
73
74                 GHOST_TSuccess 
75         init(
76         );
77
78
79         /**
80          * @section Interface Inherited from GHOST_ISystem 
81          */
82
83         /**
84          * Returns the system time.
85          * Returns the number of milliseconds since the start of the system process.
86          * @return The number of milliseconds.
87          */
88                 GHOST_TUns64 
89         getMilliSeconds(
90         ) const;
91         
92
93         /**
94          * Returns the number of displays on this system.
95          * @return The number of displays.
96          */
97                 GHOST_TUns8 
98         getNumDisplays(
99         ) const;
100
101         /**
102          * Returns the dimensions of the main display on this system.
103          * @return The dimension of the main display.
104          */
105                 void 
106         getMainDisplayDimensions(
107                 GHOST_TUns32& width,
108                 GHOST_TUns32& height
109         ) const;
110
111         /**
112          * Create a new window.
113          * The new window is added to the list of windows managed. 
114          * Never explicitly delete the window, use disposeWindow() instead.
115          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
116          * @param       left            The coordinate of the left edge of the window.
117          * @param       top             The coordinate of the top edge of the window.
118          * @param       width           The width the window.
119          * @param       height          The height the window.
120          * @param       state           The state of the window when opened.
121          * @param       type            The type of drawing context installed in this window.
122          * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
123          * @param       parentWindow    Parent (embedder) window
124          * @return      The new window (or 0 if creation failed).
125          */
126                 GHOST_IWindow* 
127         createWindow(
128                 const STR_String& title,
129                 GHOST_TInt32 left,
130                 GHOST_TInt32 top,
131                 GHOST_TUns32 width,
132                 GHOST_TUns32 height,
133                 GHOST_TWindowState state,
134                 GHOST_TDrawingContextType type,
135                 const bool stereoVisual,
136                 const GHOST_TUns16 numOfAASamples = 0,
137                 const GHOST_TEmbedderWindowID parentWindow = 0 
138         );
139
140         /**
141          * @section Interface Inherited from GHOST_ISystem 
142          */
143
144         /**
145          * Retrieves events from the system and stores them in the queue.
146          * @param waitForEvent Flag to wait for an event (or return immediately).
147          * @return Indication of the presence of events.
148          */
149                 bool 
150         processEvents(
151                 bool waitForEvent
152         );
153
154         /**
155          * @section Interface Inherited from GHOST_System 
156          */
157                 GHOST_TSuccess 
158         getCursorPosition(
159                 GHOST_TInt32& x,
160                 GHOST_TInt32& y
161         ) const;
162         
163                 GHOST_TSuccess 
164         setCursorPosition(
165                 GHOST_TInt32 x,
166                 GHOST_TInt32 y
167         );
168
169         /**
170          * Returns the state of all modifier keys.
171          * @param keys  The state of all modifier keys (true == pressed).
172          * @return              Indication of success.
173          */
174                 GHOST_TSuccess 
175         getModifierKeys(
176                 GHOST_ModifierKeys& keys
177         ) const ;
178
179         /**
180          * Returns the state of the mouse buttons (ouside the message queue).
181          * @param buttons       The state of the buttons.
182          * @return                      Indication of success.
183          */
184                 GHOST_TSuccess 
185         getButtons(
186                 GHOST_Buttons& buttons
187         ) const;
188
189         /**
190          * @section Interface Dirty
191          * Flag a window as dirty. This will
192          * generate a GHOST window update event on a call to processEvents() 
193          */
194
195                 void
196         addDirtyWindow(
197                 GHOST_WindowX11 * bad_wind
198         );
199   
200  
201         /**
202          * return a pointer to the X11 display structure
203          */
204
205                 Display *
206         getXDisplay(
207         ) {
208                 return m_display;
209         }       
210
211 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
212                 XIM
213         getX11_XIM(
214         ) {
215                 return m_xim;
216         }
217 #endif
218
219         /* Helped function for get data from the clipboard. */
220         void getClipboard_xcout(XEvent evt, Atom sel, Atom target,
221                                 unsigned char **txt, unsigned long *len,
222                                 unsigned int *context) const;
223
224         /**
225          * Returns unsinged char from CUT_BUFFER0
226          * @param selection             Get selection, X11 only feature
227          * @return                              Returns the Clipboard indicated by Flag
228          */
229         GHOST_TUns8 *getClipboard(bool selection) const;
230         
231         /**
232          * Puts buffer to system clipboard
233          * @param buffer        The buffer to copy to the clipboard     
234          * @param selection     Set the selection into the clipboard, X11 only feature
235          */
236         void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
237
238         /**
239          * @see GHOST_ISystem
240          */
241         int toggleConsole(int action) { return 0; }
242
243         /**
244          * Atom used for ICCCM, WM-spec and Motif.
245          * We only need get this atom at the start, it's relative
246          * to the display not the window and are public for every
247          * window that need it.
248          */
249         Atom m_wm_state;
250         Atom m_wm_change_state;
251         Atom m_net_state;
252         Atom m_net_max_horz;
253         Atom m_net_max_vert;
254         Atom m_net_fullscreen;
255         Atom m_motif;
256         Atom m_wm_take_focus;
257         Atom m_wm_protocols;
258         Atom m_delete_window_atom;
259
260         /* Atoms for Selection, copy & paste. */
261         Atom m_targets;
262         Atom m_string;
263         Atom m_compound_text;
264         Atom m_text;
265         Atom m_clipboard;
266         Atom m_primary;
267         Atom m_xclip_out;
268         Atom m_incr;
269         Atom m_utf8_string;
270
271 private :
272
273         Display * m_display;
274 #if defined(WITH_X11_XINPUT) && defined(X_HAVE_UTF8_STRING)
275         XIM m_xim;
276 #endif
277
278         /// The vector of windows that need to be updated.
279         std::vector<GHOST_WindowX11 *> m_dirty_windows;
280
281         /// Start time at initialization.
282         GHOST_TUns64 m_start_time;
283
284         /// A vector of keyboard key masks
285         char m_keyboard_vector[32];
286
287         /* to prevent multiple warp, we store the time of the last warp event
288          *  and stop accumulating all events generated before that */
289         Time m_last_warp;
290
291         /**
292          * Return the ghost window associated with the
293          * X11 window xwind
294          */
295
296                 GHOST_WindowX11 * 
297         findGhostWindow(
298                 Window xwind
299         ) const ;
300
301                 void
302         processEvent(
303                 XEvent *xe
304         );
305
306                 Time
307         lastEventTime(
308                 Time default_time
309         );
310
311                 bool
312         generateWindowExposeEvents(
313         );
314 };
315
316 #endif
317