IPrimaryScreen.h

/*
 * synergy -- mouse and keyboard sharing utility
 * Copyright (C) 2012 Bolton Software Ltd.
 * Copyright (C) 2003 Chris Schoeneman
 * 
 * This package is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * found in the file COPYING that should have accompanied this file.
 * 
 * This package 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, see <http://www.gnu.org/licenses/>.
 */

#ifndef IPRIMARYSCREEN_H
#define IPRIMARYSCREEN_H

#include "IInterface.h"
#include "KeyTypes.h"
#include "MouseTypes.h"
#include "CEvent.h"
#include "GameDeviceTypes.h"


class IPrimaryScreen : public IInterface {
public:
    class CButtonInfo {
    public:
        static CButtonInfo* alloc(ButtonID, KeyModifierMask);
        static CButtonInfo* alloc(const CButtonInfo&);

        static bool         equal(const CButtonInfo*, const CButtonInfo*);

    public:
        ButtonID        m_button;
        KeyModifierMask m_mask;
    };
    class CMotionInfo {
    public:
        static CMotionInfo* alloc(SInt32 x, SInt32 y);

    public:
        SInt32          m_x;
        SInt32          m_y;
    };
    class CWheelInfo {
    public:
        static CWheelInfo* alloc(SInt32 xDelta, SInt32 yDelta);

    public:
        SInt32          m_xDelta;
        SInt32          m_yDelta;
    };
    class CHotKeyInfo {
    public:
        static CHotKeyInfo* alloc(UInt32 id);

    public:
        UInt32          m_id;
    };
    class CGameDeviceButtonInfo {
    public:
        CGameDeviceButtonInfo(GameDeviceID id, GameDeviceButton buttons) :
            m_id(id), m_buttons(buttons) { }
    public:
        GameDeviceID m_id;
        GameDeviceButton m_buttons;
    };
    class CGameDeviceStickInfo {
    public:
        CGameDeviceStickInfo(GameDeviceID id, SInt16 x1, SInt16 y1, SInt16 x2, SInt16 y2) :
            m_id(id), m_x1(x1), m_x2(x2), m_y1(y1), m_y2(y2) { }
    public:
        GameDeviceID m_id;
        SInt16 m_x1;
        SInt16 m_x2;
        SInt16 m_y1;
        SInt16 m_y2;
    };
    class CGameDeviceTriggerInfo {
    public:
        CGameDeviceTriggerInfo(GameDeviceID id, UInt8 t1, UInt8 t2) :
          m_id(id), m_t1(t1), m_t2(t2) { }
    public:
        GameDeviceID m_id;
        UInt8 m_t1;
        UInt8 m_t2;
    };
    class CGameDeviceTimingRespInfo {
    public:
        CGameDeviceTimingRespInfo(UInt16 freq) :
          m_freq(freq) { }
    public:
        UInt16 m_freq;
    };
    class CGameDeviceFeedbackInfo {
    public:
        CGameDeviceFeedbackInfo(GameDeviceID id, UInt16 m1, UInt16 m2) :
          m_id(id), m_m1(m1), m_m2(m2) { }
    public:
        GameDeviceID m_id;
        UInt16 m_m1;
        UInt16 m_m2;
    };




    virtual void        reconfigure(UInt32 activeSides) = 0;


    virtual void        warpCursor(SInt32 x, SInt32 y) = 0;


    virtual UInt32      registerHotKey(KeyID key, KeyModifierMask mask) = 0;


    virtual void        unregisterHotKey(UInt32 id) = 0;


    virtual void        fakeInputBegin() = 0;


    virtual void        fakeInputEnd() = 0;





    virtual SInt32      getJumpZoneSize() const = 0;


    virtual bool        isAnyMouseButtonDown() const = 0;


    virtual void        getCursorCenter(SInt32& x, SInt32& y) const = 0;
    
    virtual void        gameDeviceTimingResp(UInt16 freq) = 0;

    virtual void        gameDeviceFeedback(GameDeviceID id, UInt16 m1, UInt16 m2) = 0;

    static CEvent::Type getButtonDownEvent();
    static CEvent::Type getButtonUpEvent();

    static CEvent::Type getMotionOnPrimaryEvent();

    static CEvent::Type getMotionOnSecondaryEvent();
    static CEvent::Type getWheelEvent();
    static CEvent::Type getScreensaverActivatedEvent();
    static CEvent::Type getScreensaverDeactivatedEvent();
    static CEvent::Type getHotKeyDownEvent();
    static CEvent::Type getHotKeyUpEvent();
    static CEvent::Type getFakeInputBeginEvent();
    static CEvent::Type getFakeInputEndEvent();
public: // HACK
    static CEvent::Type getGameDeviceButtonsEvent();
    static CEvent::Type getGameDeviceSticksEvent();
    static CEvent::Type getGameDeviceTriggersEvent();
    static CEvent::Type getGameDeviceTimingReqEvent();
private: // HACK


private:
    static CEvent::Type s_buttonDownEvent;
    static CEvent::Type s_buttonUpEvent;
    static CEvent::Type s_motionPrimaryEvent;
    static CEvent::Type s_motionSecondaryEvent;
    static CEvent::Type s_wheelEvent;
    static CEvent::Type s_ssActivatedEvent;
    static CEvent::Type s_ssDeactivatedEvent;
    static CEvent::Type s_hotKeyDownEvent;
    static CEvent::Type s_hotKeyUpEvent;
    static CEvent::Type s_fakeInputBegin;
    static CEvent::Type s_fakeInputEnd;
    static CEvent::Type s_gameButtonsEvent;
    static CEvent::Type s_gameSticksEvent;
    static CEvent::Type s_gameTriggersEvent;
    static CEvent::Type s_gameTimingReqEvent;
};

#endif