ggzmod.h

Go to the documentation of this file.

/* 
 * File: ggzmod.h
 * Author: GGZ Dev Team
 * Project: ggzmod
 * Date: 10/14/01
 * Desc: GGZ game module functions
 * $Id: ggzmod.h 8945 2007-01-16 17:42:57Z josef $
 *
 * This file contains the main interface for the ggzmod library.  This
 * library facilitates the communication between the GGZ core client (ggz)
 * and game clients.  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 */

#ifndef __GGZMOD_H__
#define __GGZMOD_H__

#define GGZMOD_VERSION_MAJOR 0
#define GGZMOD_VERSION_MINOR 0
#define GGZMOD_VERSION_MICRO 14
#define GGZMOD_VERSION_IFACE "5:0:1"

#include <ggz_common.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    GGZMOD_STATE_CREATED,

    GGZMOD_STATE_CONNECTED,

    GGZMOD_STATE_WAITING,

    GGZMOD_STATE_PLAYING,

    GGZMOD_STATE_DONE
} GGZModState;

typedef enum {
    GGZMOD_EVENT_STATE,

    GGZMOD_EVENT_SERVER,

    GGZMOD_EVENT_PLAYER,

    GGZMOD_EVENT_SEAT,

    GGZMOD_EVENT_SPECTATOR_SEAT,

    GGZMOD_EVENT_CHAT,

    GGZMOD_EVENT_STATS,

    GGZMOD_EVENT_INFO,
    
    GGZMOD_EVENT_ERROR
} GGZModEvent;

typedef enum {
    GGZMOD_GGZ, 
    GGZMOD_GAME 
} GGZModType;

typedef struct {
    unsigned int num;   
    GGZSeatType type;   
    const char * name;  
} GGZSeat;

typedef struct {
    unsigned int num;   
    const char * name;  
} GGZSpectatorSeat;

typedef struct {
    const char *player;
    const char *message;    
} GGZChat;

typedef struct {
    unsigned int num;   
    const char *realname;   
    const char *photo;  
    const char *host;   
} GGZPlayerInfo;

typedef struct GGZMod GGZMod;

typedef void (*GGZModHandler) (GGZMod * mod, GGZModEvent e, const void *data);

int ggzmod_is_ggz_mode(void);

/* 
 * Creation functions
 */

GGZMod *ggzmod_new(GGZModType type);

void ggzmod_free(GGZMod * ggzmod);

/* 
 * Accessor functions
 */

int ggzmod_get_fd(GGZMod * ggzmod);

GGZModType ggzmod_get_type(GGZMod * ggzmod);

GGZModState ggzmod_get_state(GGZMod * ggzmod);

int ggzmod_get_server_fd(GGZMod * ggzmod);

int ggzmod_get_num_seats(GGZMod *ggzmod);

GGZSeat ggzmod_get_seat(GGZMod *ggzmod, int seat);

int ggzmod_get_num_spectator_seats(GGZMod *ggzmod);

GGZSpectatorSeat ggzmod_get_spectator_seat(GGZMod * ggzmod, int seat);

const char * ggzmod_get_player(GGZMod *ggzmod,
                   int *is_spectator, int *seat_num);

void * ggzmod_get_gamedata(GGZMod * ggzmod);

void ggzmod_set_gamedata(GGZMod * ggzmod, void * data);

void ggzmod_set_handler(GGZMod * ggzmod, GGZModEvent e, GGZModHandler func);


/* 
 * Event/Data handling
 */

int ggzmod_dispatch(GGZMod * ggzmod);

/* 
 * Control functions
 */

int ggzmod_set_state(GGZMod * ggzmod, GGZModState state);

int ggzmod_connect(GGZMod * ggzmod);

int ggzmod_disconnect(GGZMod * ggzmod);


void ggzmod_request_stand(GGZMod * ggzmod);

void ggzmod_request_sit(GGZMod * ggzmod, int seat_num);

void ggzmod_request_boot(GGZMod * ggzmod, const char *name);

void ggzmod_request_bot(GGZMod * ggzmod, int seat_num);

void ggzmod_request_open(GGZMod * ggzmod, int seat_num);

void ggzmod_request_chat(GGZMod *ggzmod, const char *chat_msg);

int ggzmod_player_get_record(GGZMod *ggzmod, GGZSeat *seat,
                 int *wins, int *losses,
                 int *ties, int *forfeits);

int ggzmod_player_get_rating(GGZMod *ggzmod, GGZSeat *seat, int *rating);

int ggzmod_player_get_ranking(GGZMod *ggzmod, GGZSeat *seat, int *ranking);

int ggzmod_player_get_highscore(GGZMod *ggzmod, GGZSeat *seat, int *highscore);

int ggzmod_spectator_get_record(GGZMod *ggzmod, GGZSpectatorSeat *seat,
                int *wins, int *losses,
                int *ties, int *forfeits);

int ggzmod_spectator_get_rating(GGZMod *ggzmod, GGZSpectatorSeat *seat, int *rating);

int ggzmod_spectator_get_ranking(GGZMod *ggzmod, GGZSpectatorSeat *seat, int *ranking);

int ggzmod_spectator_get_highscore(GGZMod *ggzmod, GGZSpectatorSeat *seat, int *highscore);


int ggzmod_player_request_info(GGZMod *ggzmod, int seat_num);

GGZPlayerInfo* ggzmod_player_get_info(GGZMod *ggzmod, int seat);

#ifdef __cplusplus
}
#endif

#endif /* __GGZMOD_H__ */

---