This is the doxygen documentation for gtkboard.

.          

---

game.h

Go to the documentation of this file.

/*  This file is a part of gtkboard, a board games system.
    Copyright (C) 2003, Arvind Narayanan <arvindn@users.sourceforge.net>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111 USA

*/
#ifndef _GAME_H_
#define _GAME_H_

#include<glib.h>


#ifndef byte 
#define byte gint8
#endif

/* White is always the player that moves first. Internally they
 are always called white and black even if the game wants the user to
 see them as red and blue, or Bob and Sue etc.*/
typedef enum {WHITE, BLACK} Player;


typedef enum 
{
        GTKBOARD_BUTTON_PRESS = 1, 
        GTKBOARD_BUTTON_RELEASE, 
        GTKBOARD_MOTION_NOTIFY,
        GTKBOARD_LEAVE_NOTIFY,
        GTKBOARD_KEY_PRESS,
        GTKBOARD_KEY_RELEASE,
        GTKBOARD_GAME_START,
        GTKBOARD_HUMAN_MOVE,
        GTKBOARD_MACHINE_MOVE,
        GTKBOARD_HISTORY_MOVE
} GtkboardEventType;

typedef struct 
{
        GtkboardEventType type;

        int x;

        // y coordinate of the cell
        int y;

        int pixel_x;

        int pixel_y;

        int key;

        byte *move;
} GtkboardEvent;

typedef enum 
{
        RESULT_WHITE, 
        RESULT_BLACK, 
        RESULT_TIE, 
        RESULT_NOTYET,
        RESULT_WON,

        RESULT_LOST,
        RESULT_MISC
} ResultType;

typedef enum
{
        INPUT_ILLEGAL = -1,
        INPUT_NOTYET = 0,
        INPUT_LEGAL = 1
} InputType;

typedef struct
{

        byte *move;

        int *rmove;

        gchar *custom;

        gchar *help_message;

        gchar *human_readable;
}MoveInfo;

typedef enum {FILERANK_LABEL_TYPE_NONE, FILERANK_LABEL_TYPE_NUM, FILERANK_LABEL_TYPE_ALPHA, FILERANK_LABEL_TYPE_ALPHA_CAPS} FILERANK_LABEL_TYPE;

#define FILERANK_LABEL_TYPE_MASK 0x3

#define FILERANK_LABEL_DESC (1 << 2)

#define GAME_EVAL_INFTY (1.0e10)

#define ISINBOARD(x,y) ((x)>=0 && (y)>=0 && (x)<board_wid && (y)< board_heit)

#define GAME_DEFAULT_URL(x) "http://gtkboard.sourceforge.net/showgame.pl?game="x


typedef struct
{
        int cell_size;

        int board_wid;

        int board_heit;


        int num_pieces;

        char *colors;

        int * init_pos;

        char *** pixmaps;

        char *name;
        void (*game_init) ();
}Game;

typedef enum 
{
        RENDER_NONE, 
        RENDER_HIGHLIGHT1, RENDER_HIGHLIGHT2, RENDER_HIGHLIGHT3,
        RENDER_SHADE1, RENDER_SHADE2, RENDER_SHADE3,
        RENDER_BUTTONIZE,
        RENDER_HIDE,

        RENDER_REPLACE,
} RenderType;

typedef struct
{

        byte *board;


        /* A note on why this is int* while board is byte*: the latter will
         be used by the engine, and so size is important. But render can be 
         big because it will be used only by the engine which will have only
         once instance of Pos*/
        int *render;


        Player player;


        void *state;


        int num_moves;

        void *ui_state;
}Pos;

typedef struct
{
        char *name;

        float (*eval_fun) (Pos *, int);

        char *comment;

        char *args;
}HeurTab;


extern ResultType (*game_eval) (Pos *pos, Player player, float *eval);


extern ResultType (*game_eval_incr) (Pos *pos, Player player, byte *move, float *eval);

extern gboolean (*game_use_incr_eval) (Pos *pos, Player player);

extern void (*game_search) (Pos *pos, byte **move);


extern byte * (*game_movegen) (Pos *);



extern int (*game_getmove) (Pos *pos, int x, int y, GtkboardEventType type, Player to_play, byte ** movp, int **renderp);


extern InputType (*game_event_handler) (Pos *pos, GtkboardEvent *event, MoveInfo *move_info_p);


extern int (*game_getmove_kb) (Pos *pos, int key, Player to_play, byte ** movp, int **rmovp);


extern ResultType (*game_who_won) (Pos *pos, Player player, char ** scorep);


extern void (*game_set_init_pos) (Pos *pos);

extern void (*game_set_init_render) (Pos *pos);

extern void (*game_get_render) (Pos *pos, byte *move, int **rmovp);


extern char ** (*game_get_pixmap) (int piece, int color);

extern guchar * (*game_get_rgbmap) (int piece, int color);

extern int (*game_animate) (Pos *pos, byte ** movp);


extern void * (*game_newstate) (Pos *pos, byte * move);

extern void (*game_free) ();

//extern void game_set_init_pos_def (Pos *);


extern void (*game_reset_uistate) ();

extern int board_wid, board_heit, cell_size, num_pieces;

extern int game_single_player;

extern gboolean game_allow_undo;

extern int game_animation_time;

extern gboolean game_animation_use_movstack;

extern gboolean game_stateful;


extern gboolean game_draw_cell_boundaries;

extern char *game_highlight_colors;


extern gboolean game_allow_back_forw;


extern gboolean game_start_immediately;

extern gboolean game_allow_flip;

extern gboolean game_file_label, game_rank_label;
        

extern int game_state_size;

extern HeurTab *game_htab;

extern gchar *game_doc_about;
extern gchar *game_doc_rules;
extern gchar *game_doc_strategy;

extern gchar *game_white_string, *game_black_string;


extern char ** game_bg_pixmap;



typedef enum {
        SCORE_FIELD_NONE, 
        SCORE_FIELD_RANK, SCORE_FIELD_USER, SCORE_FIELD_SCORE, SCORE_FIELD_TIME, SCORE_FIELD_DATE, 
        SCORE_FIELD_MISC1, SCORE_FIELD_MISC2
} SCORE_FIELD;


extern SCORE_FIELD * game_score_fields;


extern gchar **game_score_field_names;


extern int (*game_scorecmp) (gchar *, int, gchar*, int);

extern int (*game_scorecmp_def_dscore) (gchar *, int, gchar*, int);
extern int (*game_scorecmp_def_iscore) (gchar *, int, gchar*, int);
extern int (*game_scorecmp_def_time) (gchar *, int, gchar*, int);

#endif