GHOST_SystemWin32.h

Go to the documentation of this file.

/*
 * ***** BEGIN GPL LICENSE BLOCK *****
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 *
 * The Original Code is: all of this file.
 *
 * Contributor(s): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef _GHOST_SYSTEM_WIN32_H_
#define _GHOST_SYSTEM_WIN32_H_

#ifndef WIN32
#error WIN32 only!
#endif // WIN32

#define _WIN32_WINNT 0x501 // require Windows XP or newer
#define WIN32_LEAN_AND_MEAN
#include <windows.h>
#include <ole2.h> // for drag-n-drop

#include "GHOST_System.h"

#if defined(__CYGWIN32__)
#   define __int64 long long
#endif

class GHOST_EventButton;
class GHOST_EventCursor;
class GHOST_EventKey;
class GHOST_EventWheel;
class GHOST_EventWindow;
class GHOST_EventDragnDrop;

class GHOST_SystemWin32 : public GHOST_System {
public:
    GHOST_SystemWin32();

    virtual ~GHOST_SystemWin32();

    /***************************************************************************************
     ** Time(r) functionality
     ***************************************************************************************/

    virtual GHOST_TUns64 getMilliSeconds() const;

    /***************************************************************************************
     ** Display/window management functionality
     ***************************************************************************************/

    virtual GHOST_TUns8 getNumDisplays() const;

    virtual void getMainDisplayDimensions(GHOST_TUns32& width, GHOST_TUns32& height) const;
    
    virtual GHOST_IWindow* createWindow(
        const STR_String& title,
        GHOST_TInt32 left, GHOST_TInt32 top, GHOST_TUns32 width, GHOST_TUns32 height,
        GHOST_TWindowState state, GHOST_TDrawingContextType type,
        const bool stereoVisual = false,
        const GHOST_TUns16 numOfAASamples = 0,
        const GHOST_TEmbedderWindowID parentWindow = 0 );

    /***************************************************************************************
     ** Event management functionality
     ***************************************************************************************/

    virtual bool processEvents(bool waitForEvent);
    

    /***************************************************************************************
     ** Cursor management functionality
     ***************************************************************************************/

    virtual GHOST_TSuccess getCursorPosition(GHOST_TInt32& x, GHOST_TInt32& y) const;

    virtual GHOST_TSuccess setCursorPosition(GHOST_TInt32 x, GHOST_TInt32 y);

    /***************************************************************************************
     ** Access to mouse button and keyboard states.
     ***************************************************************************************/

    virtual GHOST_TSuccess getModifierKeys(GHOST_ModifierKeys& keys) const;

    virtual GHOST_TSuccess getButtons(GHOST_Buttons& buttons) const;

    virtual GHOST_TUns8* getClipboard(bool selection) const;
    
    virtual void putClipboard(GHOST_TInt8 *buffer, bool selection) const;

    static GHOST_TSuccess pushDragDropEvent(GHOST_TEventType eventType, GHOST_TDragnDropTypes draggedObjectType,GHOST_IWindow* window, int mouseX, int mouseY, void* data);
     
protected:
    virtual GHOST_TSuccess init();

    virtual GHOST_TSuccess exit();
    
    virtual GHOST_TKey convertKey(GHOST_IWindow *window, short vKey, short ScanCode, short extend) const;

    virtual GHOST_TKey hardKey(GHOST_IWindow *window, RAWINPUT const& raw, int * keyDown, char * vk);

    GHOST_EventKey* processModifierKeys(GHOST_IWindow *window);

    static GHOST_EventButton* processButtonEvent(GHOST_TEventType type, GHOST_IWindow *window, GHOST_TButtonMask mask);

    static GHOST_EventCursor* processCursorEvent(GHOST_TEventType type, GHOST_IWindow *Iwindow);

    static GHOST_EventWheel* processWheelEvent(GHOST_IWindow *window, WPARAM wParam, LPARAM lParam);

    static GHOST_EventKey* processKeyEvent(GHOST_IWindow *window, RAWINPUT const& raw);

    virtual GHOST_TKey processSpecialKey(GHOST_IWindow *window, short vKey, short scanCode) const;

    static GHOST_Event* processWindowEvent(GHOST_TEventType type, GHOST_IWindow* window);

    static void processMinMaxInfo(MINMAXINFO * minmax);

#ifdef WITH_INPUT_NDOF

    bool processNDOF(RAWINPUT const& raw);
#endif

    inline virtual void retrieveModifierKeys(GHOST_ModifierKeys& keys) const;

    inline virtual void storeModifierKeys(const GHOST_ModifierKeys& keys);
    
    inline virtual void handleKeyboardChange(void);

    static LRESULT WINAPI s_wndProc(HWND hwnd, UINT msg, WPARAM wParam, LPARAM lParam);

    int toggleConsole(int action);
    
    GHOST_ModifierKeys m_modifierKeys;
    bool m_hasPerformanceCounter;
    __int64 m_freq;
    __int64 m_start;
    bool m_hasAltGr;
    WORD m_langId;
    HKL m_keylayout;

    int m_consoleStatus;
};

inline void GHOST_SystemWin32::retrieveModifierKeys(GHOST_ModifierKeys& keys) const
{
    keys = m_modifierKeys;
}

inline void GHOST_SystemWin32::storeModifierKeys(const GHOST_ModifierKeys& keys)
{
    m_modifierKeys = keys;
}

inline void GHOST_SystemWin32::handleKeyboardChange(void)
{
    m_keylayout = GetKeyboardLayout(0); // get keylayout for current thread
    int i;
    SHORT s;

    // save the language identifier.
    m_langId = LOWORD(m_keylayout);

    for(m_hasAltGr = false, i = 32; i < 256; ++i) {
        s = VkKeyScanEx((char)i, m_keylayout);
        // s == -1 means no key that translates passed char code
        // high byte contains shift state. bit 2 ctrl pressed, bit 4 alt pressed
        // if both are pressed, we have AltGr keycombo on keylayout
        if(s!=-1 && (s & 0x600) == 0x600) {
            m_hasAltGr = true;
            break;
        }
    }
}
#endif // _GHOST_SYSTEM_WIN32_H_