/* Eliot                                                       */
/* Copyright (C) 1999  Antoine Fraboulet                             */
/* antoine.fraboulet@free.fr                                       */
/*                                                            */
/* 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-1307  USA */

/* $Id: game.h 13 2004-03-17 15:57:42Z philippe $ */

#ifndef _GAME_H_
#define _GAME_H_

#if defined(__cplusplus)
extern "C" {
#endif 

#include "round.h"
#include "pldrack.h"
  /*************************
   * Dimensions of the board, the tiles placed on 
   * the board can be accessed Game_getboardchar()
   *************************/

#define BOARD_MIN 1
#define BOARD_MAX 15

  /*************************
   * dimensions of the strings that are used to return
   * values to the GUI
   *************************/
  
#define WORD_SIZE_MAX            16
#define RACK_SIZE_MAX            10
#define COOR_SIZE_MAX            5

  /*************************
   * Functions to create and destroy a game
   * the dictionary does not belong to the
   * game (ie: it won't be destroyed by Game_destroy)
   *
   * The dictionary can be set to NULL and changed
   * afterwards by Game_setdic
   *************************/

typedef struct tgame* Game;

Game     Game_create         (Dictionary);
void     Game_destroy        (Game);

  /*************************
   * handling games
   * Game_init will set up a new (empty) game
   *
   * Game_load return :
   *  0 : ok 
   *  1 : bad identstring
   * Game_load might need some more work to be robust enough to 
   * handling "hand written" files
   *************************/

void     Game_init           (Game);
void	 Game_copy(Game dest, Game src);
void	 Game_copy_n(Game dest, Game src);
int      Game_load           (Game,FILE*);
void     Game_save           (Game,FILE*);

  /*************************
   * Dictionary associated with the game 
   * the dictionary can be changed during a 
   * game without problem
   *************************/

Dictionary Game_getdic        (Game);
void     Game_setdic         (Game,Dictionary);

  /*************************
   * Playing the game
   * the int parameter should be 0 <= int < Game_getnrounds
   *
   * testplay will place a temporary word on the board for
   * preview purpose 
   * return value is
   *  0 : ok
   *  1 : dictionary is set to NULL
   *  2 : not enough played rounds for the request
   *************************/

int  Game_search             (Game);
int  Game_play               (Game,int);
int  Game_play_round               (Game,Round);
int  Game_back               (Game,int);
int  Game_testplay            (Game,int);
int  Game_removetestplay       (Game);

  /*************************
   * int coordinates have to be
   * BOARD_MIN <= int <= BOARD_MAX
   *
   *************************/

int  Game_getpoints           (Game);

  /*************************
   * Set the rack for searching
   *
   * the int parameter is a boolean, if this parameter 
   * set the rack will check that there are at least
   * 2 vowels and 2 consonants before the round 15.
   *
   * The setrack_manual parameter string has to contain
   * 'a' <= char <= 'z' or 'A' <= char <= 'Z' or '?'
   *
   * return value
   *    0 : the rack has been set
   *    1 : the bag does not contain enough tiles
   *    2 : the rack check was set on and failed
   *    3 : the rack cannot be completed (Game_setrack_random only)
   *************************/

#define RACK_MAX 7
typedef enum {RACK_ALL, RACK_NEW} set_rack_mode;

int  Game_setrack_random       (Game,unsigned short int etat[3], int force_vide);
int  Game_setrack_random_aux   (Game,Playedrack,set_rack_mode,unsigned short int etat[3]);

  /*************************
   * Get the number of tile available in the bag. 
   * The parameter has to be
   * 'a' <= char <= 'z' or 'A' <= char <= 'Z' or '?'
   *************************/

int  Game_getcharinbag        (Game,char);

  /*************************
   * functions to access already played words
   * the int parameter should be 0 <= int < getnrounds
   *************************/

int  Game_getnrounds          (Game);
void Game_getplayedrack        (Game,int,char [RACK_SIZE_MAX]);
void Game_getplayedword        (Game,int,char [WORD_SIZE_MAX]);
void Game_getplayedfirstcoord    (Game,int,char [COOR_SIZE_MAX]);
void Game_getplayedsecondcoord   (Game,int,char [COOR_SIZE_MAX]);
void Game_getplayedcoord       (Game,int,char [COOR_SIZE_MAX]);
int  Game_getplayedpoints      (Game,int);
int  Game_getplayedbonus       (Game,int);
unsigned int  Game_getheuristic        (Game,int);

  /*************************
   * functions to access the current search results
   * the int parameter should be 0 <= int < getnresults
   *************************/

int  Game_getnresults         (Game);
int  Game_getntotal           (Game);
void Game_getsearchedword      (Game,int,char [WORD_SIZE_MAX]);
void Game_getsearchedfirstcoord  (Game,int,char [COOR_SIZE_MAX]);
void Game_getsearchedsecondcoord (Game,int,char [COOR_SIZE_MAX]);
void Game_getsearchedcoord     (Game,int,char [COOR_SIZE_MAX]);
int  Game_getsearchedpoints    (Game,int);
int  Game_getsearchedbonus     (Game,int);
void Game_getsearchedround(Game g, int num, Round round) ;

  /*************************
   * Fonctions calcul de score
   * ***********************/
int  Game_getcalc_cross (Game g) ;
int  Game_getcalc_scrab (Game g) ;


#if defined(__cplusplus)
   }
#endif 
#endif /* _GAME_H */