Yes I did it again ;)
[blender-staging.git] / intern / ghost / intern / GHOST_SystemX11.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 10, 2001
38  */
39
40 #ifndef _GHOST_SYSTEM_X11_H_
41 #define _GHOST_SYSTEM_X11_H_
42
43 #include <X11/Xlib.h>
44 #include <GL/glx.h>
45
46 #ifdef HAVE_CONFIG_H
47 #include <config.h>
48 #endif
49
50 #include "GHOST_System.h"
51 #include "../GHOST_Types.h"
52
53 class GHOST_WindowX11;
54
55 /**
56  * X11 Implementation of GHOST_System class.
57  * @see GHOST_System.
58  * @author      Laurence Bourn
59  * @date        October 26, 2001
60  */
61
62 class GHOST_SystemX11 : public GHOST_System {
63 public:
64
65         /**
66          * Constructor
67          * this class should only be instanciated by GHOST_ISystem.
68          */
69
70         GHOST_SystemX11(
71         );
72         
73                 GHOST_TSuccess 
74         init(
75         );
76
77
78         /**
79          * @section Interface Inherited from GHOST_ISystem 
80          */
81
82         /**
83          * Returns the system time.
84          * Returns the number of milliseconds since the start of the system process.
85          * @return The number of milliseconds.
86          */
87                 GHOST_TUns64 
88         getMilliSeconds(
89         ) const;
90         
91
92         /**
93          * Returns the number of displays on this system.
94          * @return The number of displays.
95          */
96                 GHOST_TUns8 
97         getNumDisplays(
98         ) const;
99
100         /**
101          * Returns the dimensions of the main display on this system.
102          * @return The dimension of the main display.
103          */
104                 void 
105         getMainDisplayDimensions(
106                 GHOST_TUns32& width,
107                 GHOST_TUns32& height
108         ) const;
109
110         /**
111          * Create a new window.
112          * The new window is added to the list of windows managed. 
113          * Never explicitly delete the window, use disposeWindow() instead.
114          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
115          * @param       left            The coordinate of the left edge of the window.
116          * @param       top             The coordinate of the top edge of the window.
117          * @param       width           The width the window.
118          * @param       height          The height the window.
119          * @param       state           The state of the window when opened.
120          * @param       type            The type of drawing context installed in this window.
121          * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
122          * @return      The new window (or 0 if creation failed).
123          */
124                 GHOST_IWindow* 
125         createWindow(
126                 const STR_String& title,
127                 GHOST_TInt32 left,
128                 GHOST_TInt32 top,
129                 GHOST_TUns32 width,
130                 GHOST_TUns32 height,
131                 GHOST_TWindowState state,
132                 GHOST_TDrawingContextType type,
133                 const bool stereoVisual
134         );
135          
136         /**
137          * @section Interface Inherited from GHOST_ISystem 
138          */
139
140         /**
141          * Retrieves events from the system and stores them in the queue.
142          * @param waitForEvent Flag to wait for an event (or return immediately).
143          * @return Indication of the presence of events.
144          */
145                 bool 
146         processEvents(
147                 bool waitForEvent
148         );
149
150         /**
151          * @section Interface Inherited from GHOST_System 
152          */
153                 GHOST_TSuccess 
154         getCursorPosition(
155                 GHOST_TInt32& x,
156                 GHOST_TInt32& y
157         ) const;
158         
159                 GHOST_TSuccess 
160         setCursorPosition(
161                 GHOST_TInt32 x,
162                 GHOST_TInt32 y
163         ) const;
164
165         /**
166          * Returns the state of all modifier keys.
167          * @param keys  The state of all modifier keys (true == pressed).
168          * @return              Indication of success.
169          */
170                 GHOST_TSuccess 
171         getModifierKeys(
172                 GHOST_ModifierKeys& keys
173         ) const ;
174
175         /**
176          * Returns the state of the mouse buttons (ouside the message queue).
177          * @param buttons       The state of the buttons.
178          * @return                      Indication of success.
179          */
180                 GHOST_TSuccess 
181         getButtons(
182                 GHOST_Buttons& buttons
183         ) const;
184
185         /**
186          * @section
187          * Flag a window as dirty. This will
188          * generate a GHOST window update event on a call to processEvents() 
189          */
190
191                 void
192         addDirtyWindow(
193                 GHOST_WindowX11 * bad_wind
194         );
195   
196  
197         /**
198          * return a pointer to the X11 display structure
199          */
200
201                 Display *
202         getXDisplay(
203         ) {
204                 return m_display;
205         }       
206
207         
208 private :
209
210         Display * m_display;
211
212         /**
213          * Atom used to detect window close events
214          */
215         Atom m_delete_window_atom;
216
217         /// The vector of windows that need to be updated.
218         std::vector<GHOST_WindowX11 *> m_dirty_windows;
219
220         /// Start time at initialization.
221         GHOST_TUns64 m_start_time;
222
223         /// A vector of keyboard key masks
224         char *m_keyboard_vector;
225
226         /**
227          * Return the ghost window associated with the
228          * X11 window xwind
229          */
230
231                 GHOST_WindowX11 * 
232         findGhostWindow(
233                 Window xwind
234         ) const ;
235
236                 void
237         processEvent(
238                 XEvent *xe
239         );
240
241                 bool
242         generateWindowExposeEvents(
243         );
244  
245                 GHOST_TKey
246         convertXKey(
247                 unsigned int key
248         );
249
250 };
251
252 #endif
253