OpenGL Anti-aliasing implementation for blender windows
[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_TUns16 numOfAASamples = 0,
119                 const GHOST_TEmbedderWindowID parentWindow = 0 
120         );
121         
122         virtual GHOST_TSuccess beginFullScreen(
123                 const GHOST_DisplaySetting& setting, 
124                 GHOST_IWindow** window,
125                 const bool stereoVisual
126         );
127         
128         virtual GHOST_TSuccess endFullScreen( void );
129         
130         /***************************************************************************************
131          ** Event management functionality
132          ***************************************************************************************/
133
134         /**
135          * Gets events from the system and stores them in the queue.
136          * @param waitForEvent Flag to wait for an event (or return immediately).
137          * @return Indication of the presence of events.
138          */
139         virtual bool processEvents(bool waitForEvent);
140         
141         /***************************************************************************************
142          ** Cursor management functionality
143          ***************************************************************************************/
144
145         /**
146          * Returns the current location of the cursor (location in screen coordinates)
147          * @param x                     The x-coordinate of the cursor.
148          * @param y                     The y-coordinate of the cursor.
149          * @return                      Indication of success.
150          */
151         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
152
153         /**
154          * Updates the location of the cursor (location in screen coordinates).
155          * @param x                     The x-coordinate of the cursor.
156          * @param y                     The y-coordinate of the cursor.
157          * @return                      Indication of success.
158          */
159         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y) const;
160
161         /***************************************************************************************
162          ** Access to mouse button and keyboard states.
163          ***************************************************************************************/
164
165         /**
166          * Returns the state of all modifier keys.
167          * @param keys  The state of all modifier keys (true == pressed).
168          * @return              Indication of success.
169          */
170         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
171
172         /**
173          * Returns the state of the mouse buttons (ouside the message queue).
174          * @param buttons       The state of the buttons.
175          * @return                      Indication of success.
176          */
177         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
178
179         /**
180          * Returns Clipboard data
181          * @param selection             Indicate which buffer to return
182          * @return                              Returns the selected buffer
183          */
184         virtual GHOST_TUns8* getClipboard(bool selection) const;
185         
186         /**
187          * Puts buffer to system clipboard
188          * @param buffer        The buffer to be copied
189          * @param selection     Indicates which buffer to copy too, only used on X11
190          */
191         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
192
193 protected:
194         /**
195          * Initializes the system.
196          * For now, it justs registers the window class (WNDCLASS).
197          * @return A success value.
198          */
199         virtual GHOST_TSuccess init();
200
201         /**
202          * Closes the system down.
203          * @return A success value.
204          */
205         virtual GHOST_TSuccess exit();
206
207         
208     /**
209      * Handles a tablet event.
210      * @param event     A Mac event.
211      * @return Indication whether the event was handled. 
212      */
213     OSStatus handleTabletEvent(EventRef event);
214     /**
215      * Handles a mouse event.
216      * @param event     A Mac event.
217      * @return Indication whether the event was handled. 
218      */
219     OSStatus handleMouseEvent(EventRef event);
220
221     /**
222      * Handles a key event.
223      * @param event     A Mac event.
224      * @return Indication whether the event was handled. 
225      */
226     OSStatus handleKeyEvent(EventRef event);
227
228    /**
229      * Handles a window event.
230      * @param event     A Mac event.
231      * @return Indication whether the event was handled. 
232      */
233     OSStatus handleWindowEvent(EventRef event);
234
235     /**
236      * Handles all basic Mac application stuff for a mouse down event.
237      * @param event     A Mac event.
238      * @return Indication whether the event was handled. 
239      */
240     bool handleMouseDown(EventRef event);
241
242     /**
243      * Handles a Mac menu command.
244      * @param menuResult A Mac menu/item identifier.
245      * @return Indication whether the event was handled. 
246      */
247     bool handleMenuCommand(GHOST_TInt32 menuResult);
248     
249     /* callback for blender generated events */
250 //      static OSStatus blendEventHandlerProc(EventHandlerCallRef handler, EventRef event, void* userData);
251
252
253     /**
254      * Callback for Carbon when it has events.
255      */
256         static OSStatus sEventHandlerProc(EventHandlerCallRef handler, EventRef event, void* userData);
257         
258         /** Apple Event Handlers */
259         static OSErr sAEHandlerLaunch(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
260         static OSErr sAEHandlerOpenDocs(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
261         static OSErr sAEHandlerPrintDocs(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
262         static OSErr sAEHandlerQuit(const AppleEvent *event, AppleEvent *reply, SInt32 refCon);
263
264     /**
265      * Callback for Mac Timer tasks that expire.
266      * @param tmTask Pointer to the timer task that expired.
267      */
268     //static void s_timerCallback(TMTaskPtr tmTask);
269     
270     /** Event handler reference. */
271     EventHandlerRef m_handler;
272         
273         /** Start time at initialization. */
274         GHOST_TUns64 m_start_time;
275         
276     /** State of the modifiers. */
277     UInt32 m_modifierMask;
278
279     /** Ignores window size messages (when window is dragged). */
280     bool m_ignoreWindowSizedMessages;    
281 };
282
283 #endif // _GHOST_SYSTEM_CARBON_H_
284