intern/ghost/intern/GHOST_SystemWin32.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_SystemWin32.h
  30  * Declaration of GHOST_SystemWin32 class.
  31  */
  32
  33 #ifndef _GHOST_SYSTEM_WIN32_H_
  34 #define _GHOST_SYSTEM_WIN32_H_
  35
  36 #ifndef WIN32
  37 #error WIN32 only!
  38 #endif // WIN32
  39
  40 #include <windows.h>
  41
  42 #include "GHOST_System.h"
  43
  44 #if defined(__CYGWIN32__)
  45 #       define __int64 long long
  46 #endif
  47
  48
  49 class GHOST_EventButton;
  50 class GHOST_EventCursor;
  51 class GHOST_EventKey;
  52 class GHOST_EventWheel;
  53 class GHOST_EventWindow;
  54 class GHOST_EventDragnDrop;
  55
  56 /**
  57  * WIN32 Implementation of GHOST_System class.
  58  * @see GHOST_System.
  59  * @author      Maarten Gribnau
  60  * @date        May 10, 2001
  61  */
  62 class GHOST_SystemWin32 : public GHOST_System {
  63 public:
  64         /**
  65          * Constructor.
  66          */
  67         GHOST_SystemWin32();
  68
  69         /**
  70          * Destructor.
  71          */
  72         virtual ~GHOST_SystemWin32();
  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          * This overloaded method uses the high frequency timer if available.
  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          * @param       stereoVisual    Stereo visual for quad buffered stereo.
 114          * @param       numOfAASamples  Number of samples used for AA (zero if no AA)
 115          * @param       parentWindow    Parent (embedder) window
 116          * @return      The new window (or 0 if creation failed).
 117          */
 118         virtual GHOST_IWindow* createWindow(
 119                 const STR_String& title,
 120                 GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
 121                 GHOST_TWindowState state, GHOST_TDrawingContextType type,
 122                 const bool stereoVisual = false,
 123                 const GHOST_TUns16 numOfAASamples = 0,
 124                 const GHOST_TEmbedderWindowID parentWindow = 0 );
 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         /***************************************************************************************
 139          ** Cursor management functionality
 140          ***************************************************************************************/
 141
 142         /**
 143          * Returns the current location of the cursor (location in screen coordinates)
 144          * @param x                     The x-coordinate of the cursor.
 145          * @param y                     The y-coordinate of the cursor.
 146          * @return                      Indication of success.
 147          */
 148         virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;
 149
 150         /**
 151          * Updates the location of the cursor (location in screen coordinates).
 152          * @param x                     The x-coordinate of the cursor.
 153          * @param y                     The y-coordinate of the cursor.
 154          * @return                      Indication of success.
 155          */
 156         virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);
 157
 158         /***************************************************************************************
 159          ** Access to mouse button and keyboard states.
 160          ***************************************************************************************/
 161
 162         /**
 163          * Returns the state of all modifier keys.
 164          * @param keys  The state of all modifier keys (true == pressed).
 165          * @return              Indication of success.
 166          */
 167         virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;
 168
 169         /**
 170          * Returns the state of the mouse buttons (ouside the message queue).
 171          * @param buttons       The state of the buttons.
 172          * @return                      Indication of success.
 173          */
 174         virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;
 175
 176         /**
 177          * Returns unsinged char from CUT_BUFFER0
 178          * @param selection             Used by X11 only
 179          * @return                              Returns the Clipboard
 180          */
 181         virtual GHOST_TUns8* getClipboard(bool selection) const;
 182
 183         /**
 184          * Puts buffer to system clipboard
 185          * @param selection             Used by X11 only
 186          * @return                              No return
 187          */
 188         virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;
 189
 190         /**
 191          * Determine the base dir in which shared resources are located. It will first try to use
 192          * "unpack and run" path, then look for properly installed path, not including versioning.
 193          * @return Unsigned char string pointing to system dir (eg /usr/share/).
 194          */
 195         virtual const GHOST_TUns8* getSystemDir() const;
 196
 197         /**
 198          * Determine the base dir in which user configuration is stored, not including versioning.
 199          * If needed, it will create the base directory.
 200          * @return Unsigned char string pointing to user dir (eg ~/).
 201          */
 202          virtual const GHOST_TUns8* getUserDir() const;
 203
 204          /**
 205           * Determine the directory of the current binary
 206           * @return Unsigned char string pointing to the binary dir
 207           */
 208          virtual const GHOST_TUns8* getBinaryDir() const;
 209
 210         /**
 211          * Creates a drag'n'drop event and pushes it immediately onto the event queue.
 212          * Called by GHOST_DropTargetWin32 class.
 213          * @param eventType The type of drag'n'drop event
 214          * @param draggedObjectType The type object concerned (currently array of file names, string, ?bitmap)
 215          * @param mouseX x mouse coordinate (in window coordinates)
 216          * @param mouseY y mouse coordinate
 217          * @param window The window on which the event occurred
 218          * @return Indication whether the event was handled.
 219          */
 220         static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
 221
 222 protected:
 223         /**
 224          * Initializes the system.
 225          * For now, it justs registers the window class (WNDCLASS).
 226          * @return A success value.
 227          */
 228         virtual GHOST_TSuccess init();
 229
 230         /**
 231          * Closes the system down.
 232          * @return A success value.
 233          */
 234         virtual GHOST_TSuccess exit();
 235
 236         /**
 237          * Converts raw WIN32 key codes from the wndproc to GHOST keys.
 238          * @param wParam        The wParam from the wndproc
 239          * @param lParam        The lParam from the wndproc
 240          * @return The GHOST key (GHOST_kKeyUnknown if no match).
 241          */
 242         virtual GHOST_TKey convertKey(WPARAM wParam, LPARAM lParam) const;
 243
 244         /**
 245          * Creates modifier key event(s) and updates the key data stored locally (m_modifierKeys).
 246          * With the modifier keys, we want to distinguish left and right keys.
 247          * Sometimes this is not possible (Windows ME for instance). Then, we want
 248          * events generated for both keys.
 249          * @param window        The window receiving the event (the active window).
 250          */
 251         GHOST_EventKey* processModifierKeys(GHOST_IWindow *window);
 252
 253         /**
 254          * Creates mouse button event.
 255          * @param type          The type of event to create.
 256          * @param window        The window receiving the event (the active window).
 257          * @param mask          The button mask of this event.
 258          * @return The event created.
 259          */
 260         static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);
 261
 262         /**
 263          * Creates cursor event.
 264          * @param type          The type of event to create.
 265          * @param window        The window receiving the event (the active window).
 266          * @return The event created.
 267          */
 268         static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow);
 269
 270         /**
 271          * Creates a mouse wheel event.
 272          * @param window        The window receiving the event (the active window).
 273          * @param wParam        The wParam from the wndproc
 274          * @param lParam        The lParam from the wndproc
 275          */
 276         static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);
 277
 278         /**
 279          * Creates a key event and updates the key data stored locally (m_modifierKeys).
 280          * In most cases this is a straightforward conversion of key codes.
 281          * For the modifier keys however, we want to distinguish left and right keys.
 282          * @param window        The window receiving the event (the active window).
 283          * @param wParam        The wParam from the wndproc
 284          * @param lParam        The lParam from the wndproc
 285          */
 286         static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, bool keyDown, WPARAM wParam, LPARAM lParam);
 287
 288         /**
 289          * Creates a window event.
 290          * @param type          The type of event to create.
 291          * @param window        The window receiving the event (the active window).
 292          * @return The event created.
 293          */
 294         static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);
 295         /**
 296          * Handles minimum window size.
 297          * @param minmax        The MINMAXINFO structure.
 298          */
 299         static void processMinMaxInfo(MINMAXINFO * minmax);
 300
 301         /**
 302          * Returns the local state of the modifier keys (from the message queue).
 303          * @param keys The state of the keys.
 304          */
 305         inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;
 306
 307         /**
 308          * Stores the state of the modifier keys locally.
 309          * For internal use only!
 310          * @param keys The new state of the modifier keys.
 311          */
 312         inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
 313
 314         /**
 315          * Windows call back routine for our window class.
 316          */
 317         static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);
 318
 319         /** The current state of the modifier keys. */
 320         GHOST_ModifierKeys m_modifierKeys;
 321         /** State variable set at initialization. */
 322         bool m_hasPerformanceCounter;
 323         /** High frequency timer variable. */
 324         __int64 m_freq;
 325         /** High frequency timer variable. */
 326         __int64 m_start;
 327 };
 328
 329 inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
 330 {
 331         keys = m_modifierKeys;
 332 }
 333
 334 inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
 335 {
 336         m_modifierKeys = keys;
 337 }
 338
 339 #endif // _GHOST_SYSTEM_WIN32_H_
 340