fixed spacing in the headers to get rid of some warnings and some other
[blender.git] / intern / ghost / intern / GHOST_SystemCarbon.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL/BL DUAL 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. The Blender
9  * Foundation also sells licenses for use in proprietary software under
10  * the Blender License.  See http://www.blender.org/BL/ for information
11  * about this.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
30  */
31
32 /**
33
34  * $Id$
35  * Copyright (C) 2001 NaN Technologies B.V.
36  * @author      Maarten Gribnau
37  * @date        May 10, 2001
38  */
39
40 #ifndef _GHOST_SYSTEM_CARBON_H_
41 #define _GHOST_SYSTEM_CARBON_H_
42
43 #ifndef __APPLE__
44 #error Apple OSX only!
45 #endif // __APPLE__
46
47 #include <Carbon/Carbon.h>
48
49 #include "GHOST_System.h"
50
51
52 class GHOST_EventCursor;
53 class GHOST_EventKey;
54 class GHOST_EventWindow;
55
56 /**
57  * OSX/Carbon Implementation of GHOST_System class.
58  * @see GHOST_System.
59  * @author      Maarten Gribnau
60  * @date        May 21, 2001
61  */
62 class GHOST_SystemCarbon : public GHOST_System {
63 public:
64     /**
65      * Constructor.
66      */
67     GHOST_SystemCarbon::GHOST_SystemCarbon();
68     
69     /** 
70      * Destructor.
71      */
72     GHOST_SystemCarbon::~GHOST_SystemCarbon();
73     
74         /***************************************************************************************
75          ** Time(r) functionality
76          ***************************************************************************************/
77
78         /**
79          * Returns the system time.
80          * Returns the number of milliseconds since the start of the system process.
81          * Based on ANSI clock() routine.
82          * @return The number of milliseconds.
83          */
84         virtual GHOST_TUns64 getMilliSeconds() const;
85
86         /***************************************************************************************
87          ** Display/window management functionality
88          ***************************************************************************************/
89
90         /**
91          * Returns the number of displays on this system.
92          * @return The number of displays.
93          */
94         virtual GHOST_TUns8 getNumDisplays() const;
95
96         /**
97          * Returns the dimensions of the main display on this system.
98          * @return The dimension of the main display.
99          */
100         virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
101         
102         /**
103          * Create a new window.
104          * The new window is added to the list of windows managed. 
105          * Never explicitly delete the window, use disposeWindow() instead.
106          * @param       title   The name of the window (displayed in the title bar of the window if the OS supports it).
107          * @param       left    The coordinate of the left edge of the window.
108          * @param       top             The coordinate of the top edge of the window.
109          * @param       width   The width the window.
110          * @param       height  The height the window.
111          * @param       state   The state of the window when opened.
112          * @param       type    The type of drawing context installed in this window.
113          * @return      The new window (or 0 if creation failed).
114          */
115         virtual GHOST_IWindow* createWindow(
116                 const STR_String& title,
117                 GHOST_TInt32 left,
118                 GHOST_TInt32 top,
119                 GHOST_TUns32 width,
120                 GHOST_TUns32 height,
121                 GHOST_TWindowState state,
122                 GHOST_TDrawingContextType type,
123                 const bool stereoVisual
124         );
125         
126         /***************************************************************************************
127          ** Event management functionality
128          ***************************************************************************************/
129
130         /**
131          * Gets events from the system and stores them in the queue.
132          * @param waitForEvent Flag to wait for an event (or return immediately).
133          * @return Indication of the presence of events.
134          */
135         virtual bool processEvents(bool waitForEvent);
136         
137         /***************************************************************************************
138          ** Cursor management functionality
139          ***************************************************************************************/
140
141         /**
142          * Returns the current location of the cursor (location in screen coordinates)
143          * @param x                     The x-coordinate of the cursor.
144          * @param y                     The y-coordinate of the cursor.
145          * @return                      Indication of success.
146          */
147         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
148
149         /**
150          * Updates the location of the cursor (location in screen coordinates).
151          * @param x                     The x-coordinate of the cursor.
152          * @param y                     The y-coordinate of the cursor.
153          * @return                      Indication of success.
154          */
155         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
156
157         /***************************************************************************************
158          ** Access to mouse button and keyboard states.
159          ***************************************************************************************/
160
161         /**
162          * Returns the state of all modifier keys.
163          * @param keys  The state of all modifier keys (true == pressed).
164          * @return              Indication of success.
165          */
166         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
167
168         /**
169          * Returns the state of the mouse buttons (ouside the message queue).
170          * @param buttons       The state of the buttons.
171          * @return                      Indication of success.
172          */
173         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
174
175 protected:
176         /**
177          * Initializes the system.
178          * For now, it justs registers the window class (WNDCLASS).
179          * @return A success value.
180          */
181         virtual GHOST_TSuccess init();
182
183         /**
184          * Closes the system down.
185          * @return A success value.
186          */
187         virtual GHOST_TSuccess exit();
188
189     /**
190      * Handles a mouse event.
191      * @param event     A Mac event.
192      * @return Indication whether the event was handled. 
193      */
194     OSStatus handleMouseEvent(EventRef event);
195
196     /**
197      * Handles a key event.
198      * @param event     A Mac event.
199      * @return Indication whether the event was handled. 
200      */
201     OSStatus handleKeyEvent(EventRef event);
202
203    /**
204      * Handles a window event.
205      * @param event     A Mac event.
206      * @return Indication whether the event was handled. 
207      */
208     OSStatus handleWindowEvent(EventRef event);
209
210     /**
211      * Handles all basic Mac application stuff for a mouse down event.
212      * @param event     A Mac event.
213      * @return Indication whether the event was handled. 
214      */
215     bool handleMouseDown(EventRef event);
216
217     /**
218      * Handles a Mac menu command.
219      * @param menuResult A Mac menu/item identifier.
220      * @return Indication whether the event was handled. 
221      */
222     bool handleMenuCommand(GHOST_TInt32 menuResult);
223     
224     /**
225      * Callback for Carbon when it has events.
226      */
227         static OSStatus sEventHandlerProc(EventHandlerCallRef handler, EventRef event, void* userData);
228         
229         /** Apple Event Handlers */
230         static OSErr sAEHandlerLaunch(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
231         static OSErr sAEHandlerOpenDocs(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
232         static OSErr sAEHandlerPrintDocs(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
233         static OSErr sAEHandlerQuit(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
234
235     /**
236      * Callback for Mac Timer tasks that expire.
237      * @param tmTask Pointer to the timer task that expired.
238      */
239     //static void s_timerCallback(TMTaskPtr tmTask);
240     
241     /** Event handler reference. */
242     EventHandlerRef m_handler;
243         
244         /** Start time at initialization. */
245         GHOST_TUns64 m_start_time;
246         
247     /** State of the modifiers. */
248     UInt32 m_modifierMask;
249 };
250
251 #endif // _GHOST_SYSTEM_CARBON_H_
252