System dependent standard directory retrieval functions update : return const strings...
[blender.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_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_TUns16 numOfAASamples = 0,
131                 const GHOST_TEmbedderWindowID parentWindow = 0 
132         );
133
134         /**
135          * @section Interface Inherited from GHOST_ISystem 
136          */
137
138         /**
139          * Retrieves events from the system and stores them in the queue.
140          * @param waitForEvent Flag to wait for an event (or return immediately).
141          * @return Indication of the presence of events.
142          */
143                 bool 
144         processEvents(
145                 bool waitForEvent
146         );
147
148         /**
149          * @section Interface Inherited from GHOST_System 
150          */
151                 GHOST_TSuccess 
152         getCursorPosition(
153                 GHOST_TInt32& x,
154                 GHOST_TInt32& y
155         ) const;
156         
157                 GHOST_TSuccess 
158         setCursorPosition(
159                 GHOST_TInt32 x,
160                 GHOST_TInt32 y
161         ) const;
162
163         /**
164          * Returns the state of all modifier keys.
165          * @param keys  The state of all modifier keys (true == pressed).
166          * @return              Indication of success.
167          */
168                 GHOST_TSuccess 
169         getModifierKeys(
170                 GHOST_ModifierKeys& keys
171         ) const ;
172
173         /**
174          * Returns the state of the mouse buttons (ouside the message queue).
175          * @param buttons       The state of the buttons.
176          * @return                      Indication of success.
177          */
178                 GHOST_TSuccess 
179         getButtons(
180                 GHOST_Buttons& buttons
181         ) const;
182
183         /**
184          * @section
185          * Flag a window as dirty. This will
186          * generate a GHOST window update event on a call to processEvents() 
187          */
188
189                 void
190         addDirtyWindow(
191                 GHOST_WindowX11 * bad_wind
192         );
193   
194  
195         /**
196          * return a pointer to the X11 display structure
197          */
198
199                 Display *
200         getXDisplay(
201         ) {
202                 return m_display;
203         }       
204
205                 void *
206         prepareNdofInfo(
207                 volatile GHOST_TEventNDOFData *current_values
208         );
209
210         /* Helped function for get data from the clipboard. */
211         void getClipboard_xcout(XEvent evt, Atom sel, Atom target,
212                          unsigned char **txt, unsigned long *len,
213                          unsigned int *context) const;
214
215         /**
216          * Returns unsinged char from CUT_BUFFER0
217          * @param selection             Get selection, X11 only feature
218          * @return                              Returns the Clipboard indicated by Flag
219          */
220         GHOST_TUns8 *getClipboard(bool selection) const;
221         
222         /**
223          * Puts buffer to system clipboard
224          * @param buffer        The buffer to copy to the clipboard     
225          * @param selection     Set the selection into the clipboard, X11 only feature
226          */
227         void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
228
229         /**
230          * Determine the base dir in which shared resources are located. It will first try to use
231          * "unpack and run" path, then look for properly installed path, not including versioning.
232          * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
233          */
234         const GHOST_TUns8* getSystemDir() const;
235
236         /**
237          * Determine the base dir in which user configuration is stored, not including versioning.
238          * If needed, it will create the base directory.
239          * @return Unsigned char string pointing to user dir (eg ~/.blender/).
240          */
241         const GHOST_TUns8* getUserDir() const;
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
275         /// The vector of windows that need to be updated.
276         std::vector<GHOST_WindowX11 *> m_dirty_windows;
277
278         /// Start time at initialization.
279         GHOST_TUns64 m_start_time;
280
281         /// A vector of keyboard key masks
282         char m_keyboard_vector[32];
283
284         /* to prevent multiple warp, we store the time of the last warp event
285          *  and stop accumulating all events generated before that */
286         Time m_last_warp;
287
288         /**
289          * Return the ghost window associated with the
290          * X11 window xwind
291          */
292
293                 GHOST_WindowX11 * 
294         findGhostWindow(
295                 Window xwind
296         ) const ;
297
298                 void
299         processEvent(
300                 XEvent *xe
301         );
302
303                 Time
304         lastEventTime(
305                 Time default_time
306         );
307
308                 bool
309         generateWindowExposeEvents(
310         );
311  
312                 GHOST_TKey
313         convertXKey(
314                 KeySym key
315         );
316
317 };
318
319 #endif
320