/* event.h
 *
 * This file contains the event data struture, global variables
 * and specially defined values like MAX_EVENT_HASH.
 */

/* the size of the event queue */
#define MAX_EVENT_HASH        128

/* the different types of owners */
#define EVENT_UNOWNED           0
#define EVENT_OWNER_NONE        1
#define EVENT_OWNER_DSOCKET     2
#define EVENT_OWNER_DMOB        3
#define EVENT_OWNER_GAME        4

/* the NULL event type */
#define EVENT_NONE              0

/* Mobile events are given a type value here.
 * Each value should be unique and explicit,
 * besides that, there are no restrictions.
 */
#define EVENT_MOBILE_SAVE       1

/* Socket events are given a type value here.
 * Each value should be unique and explicit,
 * besides that, there are no restrictions.
 */
#define EVENT_SOCKET_IDLE       1

/* Game events are given a type value here.
 * Each value should be unique and explicit,
 * besides that, there are no restrictions
 */
#define EVENT_GAME_TICK         1

/* the event prototype */
typedef bool EVENT_FUN ( EVENT_DATA *event );

/* the event structure */
struct event_data
{
  EVENT_DATA       * next_global;      /* next event in this hash bucket      */
  EVENT_DATA       * prev_global;      /* prev event in this hash bucket      */
  EVENT_DATA       * next_local;       /* next event for owner                */
  EVENT_DATA       * prev_local;       /* prev event for owner                */
  EVENT_FUN        * fun;              /* the function being called           */
  char             * argument;         /* the text argument given (if any)    */
  sh_int             passes;           /* how long before this event executes */
  sh_int             type;             /* event type EVENT_XXX_YYY            */
  sh_int             ownertype;        /* type of owner (unlinking req)       */
  sh_int             bucket;           /* which bucket is this event in       */

  union 
  {                                    /* this is the owner of the event, we  */
    D_MOBILE       * dMob;             /* use a union to make sure any of the */
    D_SOCKET       * dSock;            /* types can be used for an event.     */
  } owner;
};

/* functions which can be accessed outside event-handler.c */
EVENT_DATA *alloc_event          ( void );
EVENT_DATA *event_isset_socket   ( D_SOCKET *dSock, int type );
EVENT_DATA *event_isset_mobile   ( D_MOBILE *dMob, int type );
void dequeue_event               ( EVENT_DATA *event );
void init_event_queue            ( int section );
void init_events_player          ( D_MOBILE *dMob );
void init_events_socket          ( D_SOCKET *dSock );
void heartbeat                   ( void );
void add_event_mobile            ( EVENT_DATA *event, D_MOBILE *dMob, int delay );
void add_event_socket            ( EVENT_DATA *event, D_SOCKET *dSock, int delay );
void add_event_game              ( EVENT_DATA *event, int delay );
void strip_event_socket          ( D_SOCKET *dSock, int type );
void strip_event_mobile          ( D_MOBILE *dMob, int type );

/* all events should be defined here */
bool event_mobile_save           ( EVENT_DATA *event );
bool event_socket_idle           ( EVENT_DATA *event );
bool event_game_tick             ( EVENT_DATA *event );