b0cf622f70932d5d37ce62edf498f5a32f2519a1
[blender.git] / intern / ghost / intern / GHOST_SystemCarbon.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_SystemCarbon.h
30  *  \ingroup GHOST
31  * Declaration of GHOST_SystemCarbon class.
32  */
33
34 #ifndef _GHOST_SYSTEM_CARBON_H_
35 #define _GHOST_SYSTEM_CARBON_H_
36
37 #ifndef __APPLE__
38 #error Apple OSX only!
39 #endif // __APPLE__
40
41 #define __CARBONSOUND__
42 #include <Carbon/Carbon.h>
43
44 #include "GHOST_System.h"
45
46 class GHOST_EventCursor;
47 class GHOST_EventKey;
48 class GHOST_EventWindow;
49
50 /**
51  * OSX/Carbon Implementation of GHOST_System class.
52  * @see GHOST_System.
53  * @author      Maarten Gribnau
54  * @date        May 21, 2001
55  */
56 class GHOST_SystemCarbon : public GHOST_System {
57 public:
58     /**
59      * Constructor.
60      */
61     GHOST_SystemCarbon();
62     
63     /** 
64      * Destructor.
65      */
66     ~GHOST_SystemCarbon();
67     
68         /***************************************************************************************
69          ** Time(r) functionality
70          ***************************************************************************************/
71
72         /**
73          * Returns the system time.
74          * Returns the number of milliseconds since the start of the system process.
75          * Based on ANSI clock() routine.
76          * @return The number of milliseconds.
77          */
78         virtual GHOST_TUns64 getMilliSeconds() const;
79
80         /***************************************************************************************
81          ** Display/window management functionality
82          ***************************************************************************************/
83
84         /**
85          * Returns the number of displays on this system.
86          * @return The number of displays.
87          */
88         virtual GHOST_TUns8 getNumDisplays() const;
89
90         /**
91          * Returns the dimensions of the main display on this system.
92          * @return The dimension of the main display.
93          */
94         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
95         
96         /**
97          * Create a new window.
98          * The new window is added to the list of windows managed. 
99          * Never explicitly delete the window, use disposeWindow() instead.
100          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
101          * @param       left    The coordinate of the left edge of the window.
102          * @param       top             The coordinate of the top edge of the window.
103          * @param       width   The width the window.
104          * @param       height  The height the window.
105          * @param       state   The state of the window when opened.
106          * @param       type    The type of drawing context installed in this window.
107          * @param       parentWindow    Parent (embedder) window
108          * @return      The new window (or 0 if creation failed).
109          */
110         virtual GHOST_IWindow* createWindow(
111                 const STR_String& title,
112                 GHOST_TInt32 left,
113                 GHOST_TInt32 top,
114                 GHOST_TUns32 width,
115                 GHOST_TUns32 height,
116                 GHOST_TWindowState state,
117                 GHOST_TDrawingContextType type,
118                 const bool stereoVisual,
119                 const GHOST_TUns16 numOfAASamples = 0,
120                 const GHOST_TEmbedderWindowID parentWindow = 0 
121         );
122         
123         virtual GHOST_TSuccess beginFullScreen(
124                 const GHOST_DisplaySetting& setting, 
125                 GHOST_IWindow** window,
126                 const bool stereoVisual
127         );
128         
129         virtual GHOST_TSuccess endFullScreen( void );
130         
131         /***************************************************************************************
132          ** Event management functionality
133          ***************************************************************************************/
134
135         /**
136          * Gets events from the system and stores them in the queue.
137          * @param waitForEvent Flag to wait for an event (or return immediately).
138          * @return Indication of the presence of events.
139          */
140         virtual bool processEvents(bool waitForEvent);
141         
142         /***************************************************************************************
143          ** Cursor management functionality
144          ***************************************************************************************/
145
146         /**
147          * Returns the current location of the cursor (location in screen coordinates)
148          * @param x                     The x-coordinate of the cursor.
149          * @param y                     The y-coordinate of the cursor.
150          * @return                      Indication of success.
151          */
152         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
153
154         /**
155          * Updates the location of the cursor (location in screen coordinates).
156          * @param x                     The x-coordinate of the cursor.
157          * @param y                     The y-coordinate of the cursor.
158          * @return                      Indication of success.
159          */
160         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
161
162         /***************************************************************************************
163          ** Access to mouse button and keyboard states.
164          ***************************************************************************************/
165
166         /**
167          * Returns the state of all modifier keys.
168          * @param keys  The state of all modifier keys (true == pressed).
169          * @return              Indication of success.
170          */
171         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) 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         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
179
180         /**
181          * Returns Clipboard data
182          * @param selection             Indicate which buffer to return
183          * @return                              Returns the selected buffer
184          */
185         virtual GHOST_TUns8* getClipboard(bool selection) const;
186         
187         /**
188          * Puts buffer to system clipboard
189          * @param buffer        The buffer to be copied
190          * @param selection     Indicates which buffer to copy too, only used on X11
191          */
192         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
193
194         /**
195          * @see GHOST_ISystem
196          */
197         int toggleConsole(int action) { return 0; }
198
199 protected:
200         /**
201          * Initializes the system.
202          * For now, it justs registers the window class (WNDCLASS).
203          * @return A success value.
204          */
205         virtual GHOST_TSuccess init();
206
207         /**
208          * Closes the system down.
209          * @return A success value.
210          */
211         virtual GHOST_TSuccess exit();
212
213         
214     /**
215      * Handles a tablet event.
216      * @param event     A Mac event.
217      * @return Indication whether the event was handled. 
218      */
219     OSStatus handleTabletEvent(EventRef event);
220     /**
221      * Handles a mouse event.
222      * @param event     A Mac event.
223      * @return Indication whether the event was handled. 
224      */
225     OSStatus handleMouseEvent(EventRef event);
226
227     /**
228      * Handles a key event.
229      * @param event     A Mac event.
230      * @return Indication whether the event was handled. 
231      */
232     OSStatus handleKeyEvent(EventRef event);
233
234    /**
235      * Handles a window event.
236      * @param event     A Mac event.
237      * @return Indication whether the event was handled. 
238      */
239     OSStatus handleWindowEvent(EventRef event);
240
241     /**
242      * Handles all basic Mac application stuff for a mouse down event.
243      * @param event     A Mac event.
244      * @return Indication whether the event was handled. 
245      */
246     bool handleMouseDown(EventRef event);
247
248     /**
249      * Handles a Mac menu command.
250      * @param menuResult A Mac menu/item identifier.
251      * @return Indication whether the event was handled. 
252      */
253     bool handleMenuCommand(GHOST_TInt32 menuResult);
254     
255     /* callback for blender generated events */
256 //      static OSStatus blendEventHandlerProc(EventHandlerCallRef handler, EventRef event, void* userData);
257
258
259     /**
260      * Callback for Carbon when it has events.
261      */
262         static OSStatus sEventHandlerProc(EventHandlerCallRef handler, EventRef event, void* userData);
263         
264         /** Apple Event Handlers */
265         static OSErr sAEHandlerLaunch(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
266         static OSErr sAEHandlerOpenDocs(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
267         static OSErr sAEHandlerPrintDocs(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
268         static OSErr sAEHandlerQuit(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
269
270     /**
271      * Callback for Mac Timer tasks that expire.
272      * @param tmTask Pointer to the timer task that expired.
273      */
274     //static void s_timerCallback(TMTaskPtr tmTask);
275     
276     /** Event handler reference. */
277     EventHandlerRef m_handler;
278         
279         /** Start time at initialization. */
280         GHOST_TUns64 m_start_time;
281         
282     /** State of the modifiers. */
283     UInt32 m_modifierMask;
284
285     /** Ignores window size messages (when window is dragged). */
286     bool m_ignoreWindowSizedMessages;    
287 };
288
289 #endif // _GHOST_SYSTEM_CARBON_H_
290