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