d76c3991beb2cde38a32d1113f434ec73af5ab1f
[blender-staging.git] / intern / ghost / intern / GHOST_SystemX11.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program 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
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 /**
29  * @file        GHOST_SystemX11.h
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 class GHOST_WindowX11;
43
44 /**
45  * X11 Implementation of GHOST_System class.
46  * @see GHOST_System.
47  * @author      Laurence Bourn
48  * @date        October 26, 2001
49  */
50
51 class GHOST_SystemX11 : public GHOST_System {
52 public:
53
54         /**
55          * Constructor
56          * this class should only be instanciated by GHOST_ISystem.
57          */
58
59         GHOST_SystemX11(
60         );
61         
62         /**
63          * Destructor.
64          */
65         virtual ~GHOST_SystemX11();
66
67
68                 GHOST_TSuccess 
69         init(
70         );
71
72
73         /**
74          * @section Interface Inherited from GHOST_ISystem 
75          */
76
77         /**
78          * Returns the system time.
79          * Returns the number of milliseconds since the start of the system process.
80          * @return The number of milliseconds.
81          */
82                 GHOST_TUns64 
83         getMilliSeconds(
84         ) const;
85         
86
87         /**
88          * Returns the number of displays on this system.
89          * @return The number of displays.
90          */
91                 GHOST_TUns8 
92         getNumDisplays(
93         ) const;
94
95         /**
96          * Returns the dimensions of the main display on this system.
97          * @return The dimension of the main display.
98          */
99                 void 
100         getMainDisplayDimensions(
101                 GHOST_TUns32& width,
102                 GHOST_TUns32& height
103         ) const;
104
105         /**
106          * Create a new window.
107          * The new window is added to the list of windows managed. 
108          * Never explicitly delete the window, use disposeWindow() instead.
109          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
110          * @param       left            The coordinate of the left edge of the window.
111          * @param       top             The coordinate of the top edge of the window.
112          * @param       width           The width the window.
113          * @param       height          The height the window.
114          * @param       state           The state of the window when opened.
115          * @param       type            The type of drawing context installed in this window.
116          * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
117          * @param       parentWindow    Parent (embedder) window
118          * @return      The new window (or 0 if creation failed).
119          */
120                 GHOST_IWindow* 
121         createWindow(
122                 const STR_String& title,
123                 GHOST_TInt32 left,
124                 GHOST_TInt32 top,
125                 GHOST_TUns32 width,
126                 GHOST_TUns32 height,
127                 GHOST_TWindowState state,
128                 GHOST_TDrawingContextType type,
129                 const bool stereoVisual,
130                 const GHOST_TEmbedderWindowID parentWindow = 0 
131         );
132
133         /**
134          * @section Interface Inherited from GHOST_ISystem 
135          */
136
137         /**
138          * Retrieves events from the system and stores them in the queue.
139          * @param waitForEvent Flag to wait for an event (or return immediately).
140          * @return Indication of the presence of events.
141          */
142                 bool 
143         processEvents(
144                 bool waitForEvent
145         );
146
147         /**
148          * @section Interface Inherited from GHOST_System 
149          */
150                 GHOST_TSuccess 
151         getCursorPosition(
152                 GHOST_TInt32& x,
153                 GHOST_TInt32& y
154         ) const;
155         
156                 GHOST_TSuccess 
157         setCursorPosition(
158                 GHOST_TInt32 x,
159                 GHOST_TInt32 y
160         ) const;
161
162         /**
163          * Returns the state of all modifier keys.
164          * @param keys  The state of all modifier keys (true == pressed).
165          * @return              Indication of success.
166          */
167                 GHOST_TSuccess 
168         getModifierKeys(
169                 GHOST_ModifierKeys& keys
170         ) const ;
171
172         /**
173          * Returns the state of the mouse buttons (ouside the message queue).
174          * @param buttons       The state of the buttons.
175          * @return                      Indication of success.
176          */
177                 GHOST_TSuccess 
178         getButtons(
179                 GHOST_Buttons& buttons
180         ) const;
181
182         /**
183          * @section
184          * Flag a window as dirty. This will
185          * generate a GHOST window update event on a call to processEvents() 
186          */
187
188                 void
189         addDirtyWindow(
190                 GHOST_WindowX11 * bad_wind
191         );
192   
193  
194         /**
195          * return a pointer to the X11 display structure
196          */
197
198                 Display *
199         getXDisplay(
200         ) {
201                 return m_display;
202         }       
203
204                 void *
205         prepareNdofInfo(
206                 volatile GHOST_TEventNDOFData *current_values
207         );
208
209         /* Helped function for get data from the clipboard. */
210         void getClipboard_xcout(XEvent evt, Atom sel, Atom target,
211                          unsigned char **txt, unsigned long *len,
212                          unsigned int *context) const;
213
214         /**
215          * Returns unsinged char from CUT_BUFFER0
216          * @param selection             Get selection, X11 only feature
217          * @return                              Returns the Clipboard indicated by Flag
218          */
219         GHOST_TUns8 *getClipboard(bool selection) const;
220         
221         /**
222          * Puts buffer to system clipboard
223          * @param buffer        The buffer to copy to the clipboard     
224          * @param selection     Set the selection into the clipboard, X11 only feature
225          */
226         void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
227
228         /**
229          * Atom used for ICCCM, WM-spec and Motif.
230          * We only need get this atom at the start, it's relative
231          * to the display not the window and are public for every
232          * window that need it.
233          */
234         Atom m_wm_state;
235         Atom m_wm_change_state;
236         Atom m_net_state;
237         Atom m_net_max_horz;
238         Atom m_net_max_vert;
239         Atom m_net_fullscreen;
240         Atom m_motif;
241         Atom m_wm_take_focus;
242         Atom m_wm_protocols;
243         Atom m_delete_window_atom;
244
245         /* Atoms for Selection, copy & paste. */
246         Atom m_targets;
247         Atom m_string;
248         Atom m_compound_text;
249         Atom m_text;
250         Atom m_clipboard;
251         Atom m_primary;
252         Atom m_xclip_out;
253         Atom m_incr;
254         Atom m_utf8_string;
255
256 private :
257
258         Display * m_display;
259
260         /// The vector of windows that need to be updated.
261         std::vector<GHOST_WindowX11 *> m_dirty_windows;
262
263         /// Start time at initialization.
264         GHOST_TUns64 m_start_time;
265
266         /// A vector of keyboard key masks
267         char m_keyboard_vector[32];
268
269         /* to prevent multiple warp, we store the time of the last warp event
270          *  and stop accumulating all events generated before that */
271         Time m_last_warp;
272
273         /**
274          * Return the ghost window associated with the
275          * X11 window xwind
276          */
277
278                 GHOST_WindowX11 * 
279         findGhostWindow(
280                 Window xwind
281         ) const ;
282
283                 void
284         processEvent(
285                 XEvent *xe
286         );
287
288                 Time
289         lastEventTime(
290                 Time default_time
291         );
292
293                 bool
294         generateWindowExposeEvents(
295         );
296  
297                 GHOST_TKey
298         convertXKey(
299                 KeySym key
300         );
301
302 };
303
304 #endif
305