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