/*

    SDL - Simple DirectMedia Layer

    Copyright (C) 1997-2009 Sam Lantinga

    This library is free software; you can redistribute it and/or

    modify it under the terms of the GNU Lesser General Public

    License as published by the Free Software Foundation; either

    version 2.1 of the License, or (at your option) any later version.

    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 St, Fifth Floor, Boston, MA  02110-1301  USA

    Sam Lantinga

    slouken@libsdl.org

*/

/**

 */

#ifndef _SDL_events_h

#define _SDL_events_h

#include "SDL_stdinc.h"

#include "SDL_error.h"

#include "SDL_video.h"

#include "SDL_keyboard.h"

#include "SDL_mouse.h"

#include "SDL_joystick.h"

#include "SDL_quit.h"

#include "begin_code.h"

/* Set up for C function definitions, even when using C++ */

#ifdef __cplusplus

/* *INDENT-OFF* */

extern "C" {

/* *INDENT-ON* */

#endif

/* General keyboard/mouse state definitions */

#define SDL_RELEASED	0

#define SDL_PRESSED	1

/**

 */

typedef enum

{

    SDL_NOEVENT = 0,            /**< Unused (do not remove) */

    SDL_WINDOWEVENT,            /**< Window state change */

    SDL_KEYDOWN,                /**< Keys pressed */

    SDL_KEYUP,                  /**< Keys released */

    SDL_TEXTEDITING,            /**< Keyboard text editing (composition) */

    SDL_TEXTINPUT,              /**< Keyboard text input */

    SDL_MOUSEMOTION,            /**< Mouse moved */

    SDL_MOUSEBUTTONDOWN,        /**< Mouse button pressed */

    SDL_MOUSEBUTTONUP,          /**< Mouse button released */

    SDL_MOUSEWHEEL,             /**< Mouse wheel motion */

    SDL_JOYAXISMOTION,          /**< Joystick axis motion */

    SDL_JOYBALLMOTION,          /**< Joystick trackball motion */

    SDL_JOYHATMOTION,           /**< Joystick hat position change */

    SDL_JOYBUTTONDOWN,          /**< Joystick button pressed */

    SDL_JOYBUTTONUP,            /**< Joystick button released */

    SDL_QUIT,                   /**< User-requested quit */

    SDL_SYSWMEVENT,             /**< System specific event */

    SDL_PROXIMITYIN,            /**< Proximity In event */

    SDL_PROXIMITYOUT,           /**< Proximity Out event */

    SDL_EVENT_RESERVED1,        /**< Reserved for future use... */

    SDL_USEREVENT = 24,

     */

    SDL_NUMEVENTS = 32

} SDL_EventType;

/**

 * \brief Predefined event masks

 */

typedef enum

{

    SDL_WINDOWEVENTMASK = SDL_EVENTMASK(SDL_WINDOWEVENT),

    SDL_KEYDOWNMASK = SDL_EVENTMASK(SDL_KEYDOWN),

    SDL_KEYUPMASK = SDL_EVENTMASK(SDL_KEYUP),

    SDL_KEYEVENTMASK = SDL_EVENTMASK(SDL_KEYDOWN) | SDL_EVENTMASK(SDL_KEYUP),

    SDL_TEXTEDITINGMASK = SDL_EVENTMASK(SDL_TEXTEDITING),

    SDL_TEXTINPUTMASK = SDL_EVENTMASK(SDL_TEXTINPUT),

    SDL_MOUSEMOTIONMASK = SDL_EVENTMASK(SDL_MOUSEMOTION),

    SDL_MOUSEBUTTONDOWNMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN),

    SDL_MOUSEBUTTONUPMASK = SDL_EVENTMASK(SDL_MOUSEBUTTONUP),

    SDL_MOUSEWHEELMASK = SDL_EVENTMASK(SDL_MOUSEWHEEL),

    SDL_MOUSEEVENTMASK = SDL_EVENTMASK(SDL_MOUSEMOTION) |

        SDL_EVENTMASK(SDL_MOUSEBUTTONDOWN) | SDL_EVENTMASK(SDL_MOUSEBUTTONUP),

    SDL_JOYAXISMOTIONMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION),

    SDL_JOYBALLMOTIONMASK = SDL_EVENTMASK(SDL_JOYBALLMOTION),

    SDL_JOYHATMOTIONMASK = SDL_EVENTMASK(SDL_JOYHATMOTION),

    SDL_JOYBUTTONDOWNMASK = SDL_EVENTMASK(SDL_JOYBUTTONDOWN),

    SDL_JOYBUTTONUPMASK = SDL_EVENTMASK(SDL_JOYBUTTONUP),

    SDL_JOYEVENTMASK = SDL_EVENTMASK(SDL_JOYAXISMOTION) |

        SDL_EVENTMASK(SDL_JOYBALLMOTION) |

        SDL_EVENTMASK(SDL_JOYHATMOTION) |

        SDL_EVENTMASK(SDL_JOYBUTTONDOWN) | SDL_EVENTMASK(SDL_JOYBUTTONUP),

    SDL_QUITMASK = SDL_EVENTMASK(SDL_QUIT),

    SDL_SYSWMEVENTMASK = SDL_EVENTMASK(SDL_SYSWMEVENT),

    SDL_PROXIMITYINMASK = SDL_EVENTMASK(SDL_PROXIMITYIN),

    SDL_PROXIMITYOUTMASK = SDL_EVENTMASK(SDL_PROXIMITYOUT)

} SDL_EventMask;

#define SDL_ALLEVENTS		0xFFFFFFFF

/**

 */

typedef struct SDL_WindowEvent

{

    SDL_WindowID windowID;  /**< The associated window */

    int data1;              /**< event dependent data */

    int data2;              /**< event dependent data */

} SDL_WindowEvent;

/**

 */

typedef struct SDL_KeyboardEvent

{

    SDL_WindowID windowID;  /**< The window with keyboard focus, if any */

    Uint8 which;            /**< The keyboard device index */

    SDL_keysym keysym;      /**< The key that was pressed or released */

} SDL_KeyboardEvent;

/**

 */

typedef struct SDL_TextEditingEvent

{

    char text[SDL_TEXTEDITINGEVENT_TEXT_SIZE];  /**< The editing text */

    int start;                                  /**< The start cursor of selected editing text */

    int length;                                 /**< The length of selected editing text */

} SDL_TextEditingEvent;

/**

 */

typedef struct SDL_TextInputEvent

{

    SDL_WindowID windowID;                    /**< The window with keyboard focus, if any */

    Uint8 which;                              /**< The keyboard device index */

    char text[SDL_TEXTINPUTEVENT_TEXT_SIZE];  /**< The input text */

} SDL_TextInputEvent;

/**

 */

typedef struct SDL_MouseMotionEvent

{

    SDL_WindowID windowID;  /**< The window with mouse focus, if any */

    Uint8 which;            /**< The mouse device index */

    Uint8 state;            /**< The current button state */

    int x;                  /**< X coordinate, relative to window */

    int y;                  /**< Y coordinate, relative to window */

    int z;                  /**< Z coordinate, for future use */

    int pressure;           /**< Pressure reported by tablets */

    int pressure_max;       /**< Maximum value of the pressure reported by the device */

    int pressure_min;       /**< Minimum value of the pressure reported by the device */

    int rotation;           /**< For future use */

    int tilt;               /**< For future use */

    int cursor;             /**< The cursor being used in the event */

    int xrel;               /**< The relative motion in the X direction */

    int yrel;               /**< The relative motion in the Y direction */

} SDL_MouseMotionEvent;

/**

 */

typedef struct SDL_MouseButtonEvent

{

    SDL_WindowID windowID;  /**< The window with mouse focus, if any */

    Uint8 which;            /**< The mouse device index */

    Uint8 button;           /**< The mouse button index */

    int x;                  /**< X coordinate, relative to window */

    int y;                  /**< Y coordinate, relative to window */

} SDL_MouseButtonEvent;

/**

 */

typedef struct SDL_MouseWheelEvent

{

    SDL_WindowID windowID;  /**< The window with mouse focus, if any */

    Uint8 which;            /**< The mouse device index */

    int x;                  /**< The amount scrolled horizontally */

    int y;                  /**< The amount scrolled vertically */

} SDL_MouseWheelEvent;

/**

 */

typedef struct SDL_JoyAxisEvent

{

    Uint8 which;        /**< The joystick device index */

    Uint8 axis;         /**< The joystick axis index */

    int value;          /**< The axis value (range: -32768 to 32767) */

} SDL_JoyAxisEvent;

/**

 */

typedef struct SDL_JoyBallEvent

{

    Uint8 which;        /**< The joystick device index */

    Uint8 ball;         /**< The joystick trackball index */

    int xrel;           /**< The relative motion in the X direction */

    int yrel;           /**< The relative motion in the Y direction */

} SDL_JoyBallEvent;

/**

 */

typedef struct SDL_JoyHatEvent

{

    Uint8 which;        /**< The joystick device index */

    Uint8 hat;          /**< The joystick hat index */

                         */

} SDL_JoyHatEvent;

/**

 */

typedef struct SDL_JoyButtonEvent

{

    Uint8 which;        /**< The joystick device index */

    Uint8 button;       /**< The joystick button index */

} SDL_JoyButtonEvent;

/**

 */

typedef struct SDL_QuitEvent

{

} SDL_QuitEvent;

/**

 */

typedef struct SDL_UserEvent

{

    SDL_WindowID windowID;  /**< The associated window if any*/

    int code;               /**< User defined event code */

    void *data1;            /**< User defined data pointer */

    void *data2;            /**< User defined data pointer */

} SDL_UserEvent;

struct SDL_SysWMmsg;

typedef struct SDL_SysWMmsg SDL_SysWMmsg;

typedef struct SDL_SysWMEvent

{

    SDL_SysWMmsg *msg;  /**< driver dependent data, defined in SDL_syswm.h */

} SDL_SysWMEvent;

typedef struct SDL_ProximityEvent

{

    Uint8 type;

    SDL_WindowID windowID;  /**< The associated window */

    Uint8 which;

    int cursor;

    int x;

    int y;

} SDL_ProximityEvent;

#ifndef SDL_NO_COMPAT

typedef struct SDL_ActiveEvent

{

    Uint8 type;

    Uint8 gain;

    Uint8 state;

} SDL_ActiveEvent;

typedef struct SDL_ResizeEvent

{

    Uint8 type;

    int w;

    int h;

} SDL_ResizeEvent;

#endif

/**

 */

typedef union SDL_Event

{

    Uint8 type;                     /**< Event type, shared with all events */

    SDL_WindowEvent window;         /**< Window event data */

    SDL_KeyboardEvent key;          /**< Keyboard event data */

    SDL_TextEditingEvent edit;      /**< Text editing event data */

    SDL_TextInputEvent text;        /**< Text input event data */

    SDL_MouseMotionEvent motion;    /**< Mouse motion event data */

    SDL_MouseButtonEvent button;    /**< Mouse button event data */

    SDL_MouseWheelEvent wheel;      /**< Mouse wheel event data */

    SDL_JoyAxisEvent jaxis;         /**< Joystick axis event data */

    SDL_JoyBallEvent jball;         /**< Joystick ball event data */

    SDL_JoyHatEvent jhat;           /**< Joystick hat event data */

    SDL_JoyButtonEvent jbutton;     /**< Joystick button event data */

    SDL_QuitEvent quit;             /**< Quit request event data */

    SDL_UserEvent user;             /**< Custom event data */

    SDL_SysWMEvent syswm;           /**< System dependent window event data */

    SDL_ProximityEvent proximity;   /**< Proximity In or Out event */

#ifndef SDL_NO_COMPAT

    SDL_ActiveEvent active;

    SDL_ResizeEvent resize;

#endif

} SDL_Event;

/* Function prototypes */

extern DECLSPEC void SDLCALL SDL_PumpEvents(void);

typedef enum

{

    SDL_ADDEVENT,

    SDL_PEEKEVENT,

    SDL_GETEVENT

} SDL_eventaction;

extern DECLSPEC int SDLCALL SDL_PeepEvents(SDL_Event * events, int numevents,

                                           SDL_eventaction action,

                                           Uint32 mask);

 */

extern DECLSPEC SDL_bool SDLCALL SDL_HasEvent(Uint32 mask);

 */

extern DECLSPEC int SDLCALL SDL_PollEvent(SDL_Event * event);

 */

extern DECLSPEC int SDLCALL SDL_WaitEvent(SDL_Event * event);

 */

extern DECLSPEC int SDLCALL SDL_WaitEventTimeout(SDL_Event * event,

                                                 int timeout);

 */

extern DECLSPEC int SDLCALL SDL_PushEvent(SDL_Event * event);