576577917ba67c0b2c6e172367733340afc9cf87
[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                 GHOST_TSuccess 
63         init(
64         );
65
66
67         /**
68          * @section Interface Inherited from GHOST_ISystem 
69          */
70
71         /**
72          * Returns the system time.
73          * Returns the number of milliseconds since the start of the system process.
74          * @return The number of milliseconds.
75          */
76                 GHOST_TUns64 
77         getMilliSeconds(
78         ) const;
79         
80
81         /**
82          * Returns the number of displays on this system.
83          * @return The number of displays.
84          */
85                 GHOST_TUns8 
86         getNumDisplays(
87         ) const;
88
89         /**
90          * Returns the dimensions of the main display on this system.
91          * @return The dimension of the main display.
92          */
93                 void 
94         getMainDisplayDimensions(
95                 GHOST_TUns32& width,
96                 GHOST_TUns32& height
97         ) const;
98
99         /**
100          * Create a new window.
101          * The new window is added to the list of windows managed. 
102          * Never explicitly delete the window, use disposeWindow() instead.
103          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
104          * @param       left            The coordinate of the left edge of the window.
105          * @param       top             The coordinate of the top edge of the window.
106          * @param       width           The width the window.
107          * @param       height          The height the window.
108          * @param       state           The state of the window when opened.
109          * @param       type            The type of drawing context installed in this window.
110          * @param       stereoVisual    Create a stereo visual for quad buffered stereo.
111          * @param       parentWindow    Parent (embedder) window
112          * @return      The new window (or 0 if creation failed).
113          */
114                 GHOST_IWindow* 
115         createWindow(
116                 const STR_String& title,
117                 GHOST_TInt32 left,
118                 GHOST_TInt32 top,
119                 GHOST_TUns32 width,
120                 GHOST_TUns32 height,
121                 GHOST_TWindowState state,
122                 GHOST_TDrawingContextType type,
123                 const bool stereoVisual,
124                 const GHOST_TEmbedderWindowID parentWindow = 0 
125         );
126
127         /**
128          * @section Interface Inherited from GHOST_ISystem 
129          */
130
131         /**
132          * Retrieves events from the system and stores them in the queue.
133          * @param waitForEvent Flag to wait for an event (or return immediately).
134          * @return Indication of the presence of events.
135          */
136                 bool 
137         processEvents(
138                 bool waitForEvent
139         );
140
141         /**
142          * @section Interface Inherited from GHOST_System 
143          */
144                 GHOST_TSuccess 
145         getCursorPosition(
146                 GHOST_TInt32& x,
147                 GHOST_TInt32& y
148         ) const;
149         
150                 GHOST_TSuccess 
151         setCursorPosition(
152                 GHOST_TInt32 x,
153                 GHOST_TInt32 y
154         ) const;
155
156         /**
157          * Returns the state of all modifier keys.
158          * @param keys  The state of all modifier keys (true == pressed).
159          * @return              Indication of success.
160          */
161                 GHOST_TSuccess 
162         getModifierKeys(
163                 GHOST_ModifierKeys& keys
164         ) const ;
165
166         /**
167          * Returns the state of the mouse buttons (ouside the message queue).
168          * @param buttons       The state of the buttons.
169          * @return                      Indication of success.
170          */
171                 GHOST_TSuccess 
172         getButtons(
173                 GHOST_Buttons& buttons
174         ) const;
175
176         /**
177          * @section
178          * Flag a window as dirty. This will
179          * generate a GHOST window update event on a call to processEvents() 
180          */
181
182                 void
183         addDirtyWindow(
184                 GHOST_WindowX11 * bad_wind
185         );
186   
187  
188         /**
189          * return a pointer to the X11 display structure
190          */
191
192                 Display *
193         getXDisplay(
194         ) {
195                 return m_display;
196         }       
197
198                 void *
199         prepareNdofInfo(
200                 volatile GHOST_TEventNDOFData *current_values
201         );
202                 
203         /**
204          * Returns unsinged char from CUT_BUFFER0
205          * @param flag          Flag indicates which buffer to return 0 for clipboard 1 for selection
206          * @return              Returns the Clipboard indicated by Flag
207          */
208                 GHOST_TUns8*
209         getClipboard(int flag) const;
210         
211         /**
212          * Puts buffer to system clipboard
213          * @param buffer        The buffer to copy to the clipboard     
214          * @param flag          Flag indicates which buffer to set ownership of 0 for clipboard 1 for selection
215          */
216         virtual void putClipboard(GHOST_TInt8 *buffer, int flag) const;
217
218         /* Atom used for ICCCM. */
219         Atom m_wm_take_focus;
220         Atom m_wm_protocols;
221         Atom m_delete_window_atom;
222
223 private :
224
225         Display * m_display;
226
227         /// The vector of windows that need to be updated.
228         std::vector<GHOST_WindowX11 *> m_dirty_windows;
229
230         /// Start time at initialization.
231         GHOST_TUns64 m_start_time;
232
233         /// A vector of keyboard key masks
234         char *m_keyboard_vector;
235
236         /**
237          * Return the ghost window associated with the
238          * X11 window xwind
239          */
240
241                 GHOST_WindowX11 * 
242         findGhostWindow(
243                 Window xwind
244         ) const ;
245
246                 void
247         processEvent(
248                 XEvent *xe
249         );
250
251                 bool
252         generateWindowExposeEvents(
253         );
254  
255                 GHOST_TKey
256         convertXKey(
257                 KeySym key
258         );
259
260 };
261
262 #endif
263