System dependent standard directory retrieval functions update : return const strings...
[blender.git] / intern / ghost / intern / GHOST_SystemCocoa.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):      Maarten Gribnau 05/2001
25  *                                      Damien Plisson 09/2009
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29 /**
30  * @file        GHOST_SystemCocoa.h
31  * Declaration of GHOST_SystemCocoa class.
32  */
33
34 #ifndef _GHOST_SYSTEM_COCOA_H_
35 #define _GHOST_SYSTEM_COCOA_H_
36
37 #ifndef __APPLE__
38 #error Apple OSX only!
39 #endif // __APPLE__
40
41 //#define __CARBONSOUND__
42
43
44 #include "GHOST_System.h"
45
46 class GHOST_EventCursor;
47 class GHOST_EventKey;
48 class GHOST_EventWindow;
49 class GHOST_WindowCocoa;
50
51
52 class GHOST_SystemCocoa : public GHOST_System {
53 public:
54     /**
55      * Constructor.
56      */
57     GHOST_SystemCocoa();
58     
59     /** 
60      * Destructor.
61      */
62     ~GHOST_SystemCocoa();
63     
64         /***************************************************************************************
65          ** Time(r) functionality
66          ***************************************************************************************/
67
68         /**
69          * Returns the system time.
70          * Returns the number of milliseconds since the start of the system process.
71          * Based on ANSI clock() routine.
72          * @return The number of milliseconds.
73          */
74         virtual GHOST_TUns64 getMilliSeconds() const;
75
76         /***************************************************************************************
77          ** Display/window management functionality
78          ***************************************************************************************/
79
80         /**
81          * Returns the number of displays on this system.
82          * @return The number of displays.
83          */
84         virtual GHOST_TUns8 getNumDisplays() const;
85
86         /**
87          * Returns the dimensions of the main display on this system.
88          * @return The dimension of the main display.
89          */
90         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
91         
92         /**
93          * Create a new window.
94          * The new window is added to the list of windows managed. 
95          * Never explicitly delete the window, use disposeWindow() instead.
96          * @param       title                   The name of the window (displayed in the title bar of the window if the OS supports it).
97          * @param       left                    The coordinate of the left edge of the window.
98          * @param       top                             The coordinate of the top edge of the window.
99          * @param       width                   The width the window.
100          * @param       height                  The height the window.
101          * @param       state                   The state of the window when opened.
102          * @param       type                    The type of drawing context installed in this window.
103          * @param       stereoVisual    Stereo visual for quad buffered stereo.
104          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
105          * @param       parentWindow    Parent (embedder) window
106          * @return      The new window (or 0 if creation failed).
107          */
108         virtual GHOST_IWindow* createWindow(
109                 const STR_String& title,
110                 GHOST_TInt32 left,
111                 GHOST_TInt32 top,
112                 GHOST_TUns32 width,
113                 GHOST_TUns32 height,
114                 GHOST_TWindowState state,
115                 GHOST_TDrawingContextType type,
116                 const bool stereoVisual = false,
117                 const GHOST_TUns16 numOfAASamples = 0,
118                 const GHOST_TEmbedderWindowID parentWindow = 0 
119         );
120         
121         virtual GHOST_TSuccess beginFullScreen(
122                 const GHOST_DisplaySetting& setting, 
123                 GHOST_IWindow** window,
124                 const bool stereoVisual
125         );
126         
127         virtual GHOST_TSuccess endFullScreen( void );
128         
129         /***************************************************************************************
130          ** Event management functionality
131          ***************************************************************************************/
132
133         /**
134          * Gets events from the system and stores them in the queue.
135          * @param waitForEvent Flag to wait for an event (or return immediately).
136          * @return Indication of the presence of events.
137          */
138         virtual bool processEvents(bool waitForEvent);
139         
140         /**
141          * Handle User request to quit, from Menu bar Quit, and Cmd+Q
142          * Display alert panel if changes performed since last save
143          */
144         GHOST_TUns8 handleQuitRequest();
145         
146         /**
147          * Handle Cocoa openFile event
148          * Display confirmation request panel if changes performed since last save
149          */
150         bool handleOpenDocumentRequest(void *filepathStr);      
151         
152         /**
153      * Handles a drag'n'drop destination event. Called by GHOST_WindowCocoa window subclass
154      * @param eventType The type of drag'n'drop event
155          * @param draggedObjectType The type object concerned (currently array of file names, string, TIFF image)
156          * @param mouseX x mouse coordinate (in cocoa base window coordinates)
157          * @param mouseY y mouse coordinate
158          * @param window The window on which the event occured
159      * @return Indication whether the event was handled. 
160      */
161         GHOST_TSuccess handleDraggingEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,
162                                                                            GHOST_WindowCocoa* window, int mouseX, int mouseY, void* data);
163         
164         /***************************************************************************************
165          ** Cursor management functionality
166          ***************************************************************************************/
167
168         /**
169          * Returns the current location of the cursor (location in screen coordinates)
170          * @param x                     The x-coordinate of the cursor.
171          * @param y                     The y-coordinate of the cursor.
172          * @return                      Indication of success.
173          */
174         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
175
176         /**
177          * Updates the location of the cursor (location in screen coordinates).
178          * @param x                     The x-coordinate of the cursor.
179          * @param y                     The y-coordinate of the cursor.
180          * @return                      Indication of success.
181          */
182         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
183
184         /***************************************************************************************
185          ** Access to mouse button and keyboard states.
186          ***************************************************************************************/
187
188         /**
189          * Returns the state of all modifier keys.
190          * @param keys  The state of all modifier keys (true == pressed).
191          * @return              Indication of success.
192          */
193         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
194
195         /**
196          * Returns the state of the mouse buttons (ouside the message queue).
197          * @param buttons       The state of the buttons.
198          * @return                      Indication of success.
199          */
200         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
201
202         /**
203          * Returns Clipboard data
204          * @param selection             Indicate which buffer to return
205          * @return                              Returns the selected buffer
206          */
207         virtual GHOST_TUns8* getClipboard(bool selection) const;
208         
209         /**
210          * Puts buffer to system clipboard
211          * @param buffer        The buffer to be copied
212          * @param selection     Indicates which buffer to copy too, only used on X11
213          */
214         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
215
216         /**
217          * Determine the base dir in which shared resources are located. It will first try to use
218          * "unpack and run" path, then look for properly installed path, not including versioning.
219          * @return Unsigned char string pointing to system dir (eg /usr/share/blender/).
220          */
221         virtual const GHOST_TUns8* getSystemDir() const;
222
223         /**
224          * Determine the base dir in which user configuration is stored, not including versioning.
225          * If needed, it will create the base directory.
226          * @return Unsigned char string pointing to user dir (eg ~/.blender/).
227          */
228         virtual const GHOST_TUns8* getUserDir() const;
229
230         /**
231      * Handles a window event. Called by GHOST_WindowCocoa window delegate
232      * @param eventType The type of window event
233          * @param window The window on which the event occured
234      * @return Indication whether the event was handled. 
235      */
236     GHOST_TSuccess handleWindowEvent(GHOST_TEventType eventType, GHOST_WindowCocoa* window);
237         
238         /**
239      * Handles the Cocoa event telling the application has become active (again)
240      * @return Indication whether the event was handled. 
241      */
242     GHOST_TSuccess handleApplicationBecomeActiveEvent();
243         
244         
245 protected:
246         /**
247          * Initializes the system.
248          * For now, it justs registers the window class (WNDCLASS).
249          * @return A success value.
250          */
251         virtual GHOST_TSuccess init();
252
253     /**
254      * Handles a tablet event.
255      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
256          * @param eventType The type of the event. It needs to be passed separately as it can be either directly in the event type, or as a subtype if combined with a mouse button event
257      * @return Indication whether the event was handled. 
258      */
259     GHOST_TSuccess handleTabletEvent(void *eventPtr, short eventType);
260     
261         /**
262      * Handles a mouse event.
263      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
264      * @return Indication whether the event was handled. 
265      */
266     GHOST_TSuccess handleMouseEvent(void *eventPtr);
267
268     /**
269      * Handles a key event.
270      * @param eventPtr  An NSEvent pointer (casted to void* to enable compilation in standard C++)
271      * @return Indication whether the event was handled. 
272      */
273     GHOST_TSuccess handleKeyEvent(void *eventPtr);
274     
275         /** Start time at initialization. */
276         GHOST_TUns64 m_start_time;
277         
278         /** Event has been processed directly by Cocoa and has sent a ghost event to be dispatched */
279         bool m_outsideLoopEventProcessed;
280         
281         /** Raised window is not yet known by the window manager, so delay application become active event handling */
282         bool m_needDelayedApplicationBecomeActiveEventProcessing;
283         
284         /** Mouse buttons state */
285         GHOST_TUns32 m_pressedMouseButtons;
286         
287     /** State of the modifiers. */
288     GHOST_TUns32 m_modifierMask;
289
290     /** Ignores window size messages (when window is dragged). */
291     bool m_ignoreWindowSizedMessages;   
292         
293         /** Stores the mouse cursor delta due to setting a new cursor position
294          * Needed because cocoa event delta cursor move takes setCursorPosition changes too.
295          */
296         GHOST_TInt32 m_cursorDelta_x, m_cursorDelta_y;
297         
298         /** Multitouch trackpad availability */
299         bool m_hasMultiTouchTrackpad;
300         
301         /** Multitouch gesture in progress, useful to distinguish trackpad from mouse scroll events */
302         bool m_isGestureInProgress;
303 };
304
305 #endif // _GHOST_SYSTEM_COCOA_H_
306