event.h

/* Copyright (c) 2006-2013, Stefan Eilemann <eile@equalizergraphics.com>
 *                    2011, Cedric Stalder <cedric.stalder@gmail.com>
 *                    2012, Daniel Nachbaur <danielnachbaur@gmail.com>
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License version 2.1 as published
 * by the Free Software Foundation.
 *
 * This library 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 Lesser General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef EQ_EVENT_H
#define EQ_EVENT_H

#include <eq/client/api.h>
#include <eq/client/statistic.h>     // member
#include <eq/client/types.h>
#include <eq/fabric/renderContext.h> // member


namespace eq
{
enum KeyCode
{
    KC_ESCAPE = 256,
    KC_BACKSPACE,
    KC_RETURN,
    KC_TAB,
    KC_HOME,
    KC_LEFT,
    KC_UP,
    KC_RIGHT,
    KC_DOWN,
    KC_PAGE_UP,
    KC_PAGE_DOWN,
    KC_END,
    KC_F1,
    KC_F2,
    KC_F3,
    KC_F4,
    KC_F5,
    KC_F6,
    KC_F7,
    KC_F8,
    KC_F9,
    KC_F10,
    KC_F11,
    KC_F12,
    KC_F13,
    KC_F14,
    KC_F15,
    KC_F16,
    KC_F17,
    KC_F18,
    KC_F19,
    KC_F20,
    KC_F21,
    KC_F22,
    KC_F23,
    KC_F24,
    KC_SHIFT_L,
    KC_SHIFT_R,
    KC_CONTROL_L,
    KC_CONTROL_R,
    KC_ALT_L,
    KC_ALT_R,
    KC_VOID = 0xFFFFFF /* == XK_VoidSymbol */
};

enum PointerButton
{
    PTR_BUTTON_NONE = LB_BIT_NONE,
    PTR_BUTTON1     = LB_BIT1,
    PTR_BUTTON2     = LB_BIT2,
    PTR_BUTTON3     = LB_BIT3,
    PTR_BUTTON4     = LB_BIT4,
    PTR_BUTTON5     = LB_BIT5,
    PTR_BUTTON6     = LB_BIT6,
    PTR_BUTTON7     = LB_BIT7
};

struct ResizeEvent
{
    int32_t x; 
    int32_t y; 
    int32_t w; 
    int32_t h; 
    float dw;  
    float dh;  
};

struct PointerEvent
{
    int32_t x;             
    int32_t y;             
    int32_t dx;            
    int32_t dy;            
    uint32_t buttons;      
    uint32_t button;       
    int32_t xAxis;         
    int32_t yAxis;         
};

struct KeyEvent
{
    uint32_t key; 
    // TODO modifier state
};

struct MagellanEvent
{
    uint32_t button;       
    uint32_t buttons;      
    int16_t xAxis;         
    int16_t yAxis;         
    int16_t zAxis;         
    int16_t xRotation;     
    int16_t yRotation;     
    int16_t zRotation;     
};

#   define EQ_USER_EVENT_SIZE 128

struct UserEvent
{
    char data[ EQ_USER_EVENT_SIZE ]; 
};

struct Event
{
    EQ_API Event();

    enum Type // Also update string table in event.cpp
    {
        WINDOW_EXPOSE = 0,    
        WINDOW_RESIZE,        
        WINDOW_CLOSE,         
        WINDOW_HIDE,          
        WINDOW_SHOW,          
        WINDOW_SCREENSAVER,   
#ifdef EQ_USE_DEPRECATED
        POINTER_MOTION,       

        POINTER_BUTTON_PRESS,
        POINTER_BUTTON_RELEASE,
        POINTER_WHEEL,        
        CHANNEL_POINTER_MOTION = POINTER_MOTION,
        CHANNEL_POINTER_BUTTON_PRESS = POINTER_BUTTON_PRESS,
        CHANNEL_POINTER_BUTTON_RELEASE = POINTER_BUTTON_RELEASE,
        WINDOW_POINTER_WHEEL = POINTER_WHEEL,
#else
        CHANNEL_POINTER_MOTION,
        CHANNEL_POINTER_BUTTON_PRESS,
        CHANNEL_POINTER_BUTTON_RELEASE,
        CHANNEL_POINTER_WHEEL,
        WINDOW_POINTER_WHEEL,
#endif
        WINDOW_POINTER_MOTION,
        WINDOW_POINTER_BUTTON_PRESS,
        WINDOW_POINTER_BUTTON_RELEASE,
        WINDOW_POINTER_GRAB,
        WINDOW_POINTER_UNGRAB,

        KEY_PRESS,            
        KEY_RELEASE,          
        CHANNEL_RESIZE,       
        STATISTIC,            
        VIEW_RESIZE,          
        EXIT,                 
        MAGELLAN_AXIS,        
        MAGELLAN_BUTTON,      
        NODE_TIMEOUT,         

        OBSERVER_MOTION,

        CONFIG_ERROR,
        NODE_ERROR, 
        PIPE_ERROR, 
        WINDOW_ERROR, 
        CHANNEL_ERROR, 

        UNKNOWN,              

        USER = UNKNOWN + 5, // some buffer for binary-compatible patches
        ALL // must be last
    };

    uint32_t type;           

    // keep before 'uint128_t originator' for alignment
    uint32_t serial;       

    int64_t time;

    uint128_t originator;

    union
    {
        ResizeEvent   resize;             
        ResizeEvent   show;               
        ResizeEvent   hide;               

        PointerEvent  pointer;            
        PointerEvent  pointerMotion;      
        PointerEvent  pointerButtonPress; 
        PointerEvent  pointerButtonRelease; 
        PointerEvent  pointerWheel;       

        KeyEvent      key;                
        KeyEvent      keyPress;           
        KeyEvent      keyRelease;         

        Statistic     statistic;          
        MagellanEvent magellan;           

        UserEvent     user;               
    };

    RenderContext context;
};

EQ_API std::ostream& operator << ( std::ostream&, const Event& );
EQ_API std::ostream& operator << ( std::ostream&, const Event::Type& );
EQ_API std::ostream& operator << ( std::ostream&, const ResizeEvent& );
EQ_API std::ostream& operator << ( std::ostream&, const PointerEvent& );
EQ_API std::ostream& operator << ( std::ostream&, const KeyEvent& );
EQ_API std::ostream& operator << ( std::ostream&, const MagellanEvent& );
}

namespace lunchbox
{
template<> inline void byteswap( eq::Event& value )
{
    byteswap( value.type );
    byteswap( value.serial );
    byteswap( value.time );
    byteswap( value.originator );
    // #145 Todo byteswap union
    //byteswap( value.union );
    byteswap( value.context );
}
}

#endif // EQ_EVENT_H