ggzdmod.h

Go to the documentation of this file.

/* 
 * File: ggzdmod.h
 * Author: GGZ Dev Team
 * Project: ggzdmod
 * Date: 10/14/01
 * Desc: GGZ game module functions
 * $Id: ggzdmod.h 9062 2007-04-21 03:51:10Z jdorje $
 *
 * This file contains the main interface for the ggzdmod library.  This
 * library facilitates the communication between the GGZ server (ggzd)
 * and game servers.  This file provides a unified interface that can be
 * used at both ends.
 *
 * Copyright (C) 2001-2002 GGZ Development Team.
 *
 * 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
 */

#include <ggz.h> /* libggz */
#include <ggz_common.h>

#ifndef __GGZDMOD_H__
#define __GGZDMOD_H__

#define GGZDMOD_VERSION_MAJOR 0
#define GGZDMOD_VERSION_MINOR 0
#define GGZDMOD_VERSION_MICRO 14
#define GGZDMOD_VERSION_IFACE "6:0:0"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    GGZDMOD_STATE_CREATED,  
    GGZDMOD_STATE_WAITING,  
    GGZDMOD_STATE_PLAYING,  
    GGZDMOD_STATE_DONE  
} GGZdModState;

typedef enum {
    GGZDMOD_EVENT_STATE,

    GGZDMOD_EVENT_JOIN,

    GGZDMOD_EVENT_LEAVE,

    GGZDMOD_EVENT_SEAT,

    GGZDMOD_EVENT_SPECTATOR_JOIN,

    GGZDMOD_EVENT_SPECTATOR_LEAVE,

    GGZDMOD_EVENT_SPECTATOR_SEAT,

    GGZDMOD_EVENT_PLAYER_DATA,

    GGZDMOD_EVENT_SPECTATOR_DATA,

    GGZDMOD_EVENT_ERROR

    /* GGZDMOD_EVENT_ERROR must be last in the list! */
} GGZdModEvent;

typedef enum {
    GGZDMOD_GGZ,    
    GGZDMOD_GAME    
} GGZdModType;

typedef struct GGZdMod GGZdMod;

typedef void (*GGZdModHandler) (GGZdMod * mod, GGZdModEvent event,
                const void *data);

typedef struct {
    unsigned int num;   
    GGZSeatType type;   
    const char *name;   
    int fd;         
    void *playerdata;   
} GGZSeat;
#define GGZSpectator GGZSeat

int ggzdmod_is_ggz_mode(void);

/* 
 * Creation functions
 */

GGZdMod *ggzdmod_new(GGZdModType type);

void ggzdmod_free(GGZdMod * ggzdmod);


/* 
 * Accessor functions
 */

int ggzdmod_get_fd(GGZdMod * ggzdmod);

GGZdModType ggzdmod_get_type(GGZdMod * ggzdmod);

GGZdModState ggzdmod_get_state(GGZdMod * ggzdmod);

int ggzdmod_get_num_seats(GGZdMod * ggzdmod);

GGZSeat ggzdmod_get_seat(GGZdMod * ggzdmod, int seat);

char * ggzdmod_get_bot_class(GGZdMod * ggzdmod, const char * name);

void ggzdmod_set_playerdata(GGZdMod * ggzdmod, bool is_spectator, int seat_num,
                void *playerdata);

void * ggzdmod_get_gamedata(GGZdMod * ggzdmod);

void ggzdmod_set_gamedata(GGZdMod * ggzdmod, void * data);

int ggzdmod_get_max_num_spectators(GGZdMod *ggzdmod);

GGZSeat ggzdmod_get_spectator(GGZdMod * ggzdmod, int spectator);

int ggzdmod_set_handler(GGZdMod * ggzdmod, GGZdModEvent e,
            GGZdModHandler func);

int ggzdmod_count_seats(GGZdMod * ggzdmod, GGZSeatType seat_type);

int ggzdmod_count_spectators(GGZdMod * ggzdmod);


/* 
 * Event/Data handling
 */

int ggzdmod_dispatch(GGZdMod * ggzdmod);

int ggzdmod_loop(GGZdMod * ggzdmod);


/* 
 * Control functions
 */

int ggzdmod_set_state(GGZdMod * ggzdmod, GGZdModState state);

int ggzdmod_connect(GGZdMod * ggzdmod);

int ggzdmod_disconnect(GGZdMod * ggzdmod);


/* 
 * Logging functions
 */

int ggzdmod_log(GGZdMod * ggzdmod, const char *fmt, ...)
        ggz__attribute((format(printf, 2, 3)));
        
        
void ggzdmod_check(GGZdMod *ggzdmod);

typedef enum {
    GGZ_GAME_WIN,
    GGZ_GAME_LOSS,
    GGZ_GAME_TIE,
    GGZ_GAME_FORFEIT,
    GGZ_GAME_NONE
} GGZGameResult;

void ggzdmod_report_game(GGZdMod *ggzdmod,
             int *teams,
             GGZGameResult *results, int *scores);

void ggzdmod_report_savegame(GGZdMod *ggzdmod, const char *savegame);

void ggzdmod_request_num_seats(GGZdMod * ggzdmod, int num_seats);

void ggzdmod_request_boot(GGZdMod * ggzdmod, const char *name);

void ggzdmod_request_bot(GGZdMod * ggzdmod, int seat_num);

void ggzdmod_request_open(GGZdMod * ggzdmod, int seat_num);

#ifdef __cplusplus
}
#endif

#endif /* __GGZDMOD_H__ */

---