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