events.hpp

/*
This file is part of Heroes of Wesnoth.
Copyright (C) 2007, 2008, 2009 Jon Ander Peñalba <jonan88@gmail.com>

Heroes of Wesnoth is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License version 3 as
published by the Free Software Foundation.

Heroes of Wesnoth 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 Heroes of Wesnoth. If not, see <http://www.gnu.org/licenses/>
*/

/// @file
/// The Events class and global events variables.
/// @author Jonan

#ifndef EVENTS_HPP
#define EVENTS_HPP

#include <SDL/SDL_keysym.h>
#include <SDL/SDL_mouse.h>

#include "util.hpp"

struct SDL_Rect;
struct SDL_Surface;
union SDL_Event;

/// All functions related to events.
namespace events_engine {

/// Mouse info
enum {MOUSE_X, MOUSE_Y, MOUSE_BUTTON};

/// Types of cursors
enum {NO_CURSOR,
      NORMAL_CURSOR,
      ATTACK_CURSOR,
      MOVE_CURSOR,
      ILLEGAL_CURSOR,
      WAIT_CURSOR,
      NUM_CURSORS};

/// Event control.
/// Tells you when has an event has occurred. This event can be a system event (resize,
/// close, redraw, etc.) or user event (keyboard or mouse). Once the event has occurred,
/// gives you complete information about it.
class Events {
  public:
    static Events* getInstance(void); // Singleton pattern constructor
    ~Events(void); // Destructor

    /// Sets the cursor's type.
    /// @param[in] type Type of cursor.
    void setCursorType(const int type) {cursor_type = type;}

    /// Reads the input from mouse, keyboard and system.
    /// Gets the input and stores the information obtained
    /// (must be called before any other events function).
    void readInput(void);

    /// Draws the mouse on the screen.
    /// It's called every time the screen is updated,
    /// so it should only be called from graphics.
    void drawMouse(void);

  private:
    Events(void); // Constructor

    SDL_Event *event;

    SDL_Rect *mouse_position;
    SDL_Surface *cursor_image[NUM_CURSORS];
    int cursor_type;

    DISALLOW_COPY_AND_ASSIGN(Events);
};

extern Events *input;

extern bool *keys;  // Stores the state of each keyboard key
extern int  *mouse; // Stores all the mouse info

} // namespace events_engine

#endif // EVENTS_HPP