puzzles.h

   1 /*
   2  * puzzles.h: header file for my puzzle collection
   3  */
   4
   5 #ifndef PUZZLES_PUZZLES_H
   6 #define PUZZLES_PUZZLES_H
   7
   8 #ifndef TRUE
   9 #define TRUE 1
  10 #endif
  11 #ifndef FALSE
  12 #define FALSE 0
  13 #endif
  14
  15 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
  16
  17 enum {
  18     LEFT_BUTTON = 0x1000,
  19     MIDDLE_BUTTON,
  20     RIGHT_BUTTON,
  21     LEFT_DRAG,
  22     MIDDLE_DRAG,
  23     RIGHT_DRAG,
  24     LEFT_RELEASE,
  25     MIDDLE_RELEASE,
  26     RIGHT_RELEASE,
  27     CURSOR_UP,
  28     CURSOR_DOWN,
  29     CURSOR_LEFT,
  30     CURSOR_RIGHT,
  31     CURSOR_UP_LEFT,
  32     CURSOR_DOWN_LEFT,
  33     CURSOR_UP_RIGHT,
  34     CURSOR_DOWN_RIGHT
  35 };
  36
  37 #define IS_MOUSE_DOWN(m) ( (unsigned)((m) - LEFT_BUTTON) <= \
  38                                (unsigned)(RIGHT_BUTTON - LEFT_BUTTON))
  39 #define IS_MOUSE_DRAG(m) ( (unsigned)((m) - LEFT_DRAG) <= \
  40                                (unsigned)(RIGHT_DRAG - LEFT_DRAG))
  41 #define IS_MOUSE_RELEASE(m) ( (unsigned)((m) - LEFT_RELEASE) <= \
  42                                (unsigned)(RIGHT_RELEASE - LEFT_RELEASE))
  43
  44 #define IGNOREARG(x) ( (x) = (x) )
  45
  46 typedef struct frontend frontend;
  47 typedef struct config_item config_item;
  48 typedef struct midend_data midend_data;
  49 typedef struct random_state random_state;
  50 typedef struct game_params game_params;
  51 typedef struct game_state game_state;
  52 typedef struct game_ui game_ui;
  53 typedef struct game_drawstate game_drawstate;
  54 typedef struct game game;
  55
  56 #define ALIGN_VNORMAL 0x000
  57 #define ALIGN_VCENTRE 0x100
  58
  59 #define ALIGN_HLEFT   0x000
  60 #define ALIGN_HCENTRE 0x001
  61 #define ALIGN_HRIGHT  0x002
  62
  63 #define FONT_FIXED    0
  64 #define FONT_VARIABLE 1
  65
  66 /*
  67  * Structure used to pass configuration data between frontend and
  68  * game
  69  */
  70 enum { C_STRING, C_CHOICES, C_BOOLEAN, C_END };
  71 struct config_item {
  72     /*
  73      * `name' is never dynamically allocated.
  74      */
  75     char *name;
  76     /*
  77      * `type' contains one of the above values.
  78      */
  79     int type;
  80     /*
  81      * For C_STRING, `sval' is always dynamically allocated and
  82      * non-NULL. For C_BOOLEAN and C_END, `sval' is always NULL.
  83      * For C_CHOICES, `sval' is non-NULL, _not_ dynamically
  84      * allocated, and contains a set of option strings separated by
  85      * a delimiter. The delimeter is also the first character in
  86      * the string, so for example ":Foo:Bar:Baz" gives three
  87      * options `Foo', `Bar' and `Baz'.
  88      */
  89     char *sval;
  90     /*
  91      * For C_BOOLEAN, this is TRUE or FALSE. For C_CHOICES, it
  92      * indicates the chosen index from the `sval' list. In the
  93      * above example, 0==Foo, 1==Bar and 2==Baz.
  94      */
  95     int ival;
  96 };
  97
  98 /*
  99  * Platform routines
 100  */
 101 void fatal(char *fmt, ...);
 102 void frontend_default_colour(frontend *fe, float *output);
 103 void draw_text(frontend *fe, int x, int y, int fonttype, int fontsize,
 104                int align, int colour, char *text);
 105 void draw_rect(frontend *fe, int x, int y, int w, int h, int colour);
 106 void draw_line(frontend *fe, int x1, int y1, int x2, int y2, int colour);
 107 void draw_polygon(frontend *fe, int *coords, int npoints,
 108                   int fill, int colour);
 109 void clip(frontend *fe, int x, int y, int w, int h);
 110 void unclip(frontend *fe);
 111 void start_draw(frontend *fe);
 112 void draw_update(frontend *fe, int x, int y, int w, int h);
 113 void end_draw(frontend *fe);
 114 void deactivate_timer(frontend *fe);
 115 void activate_timer(frontend *fe);
 116 void status_bar(frontend *fe, char *text);
 117 void get_random_seed(void **randseed, int *randseedsize);
 118
 119 /*
 120  * midend.c
 121  */
 122 midend_data *midend_new(frontend *fe, const game *ourgame);
 123 void midend_free(midend_data *me);
 124 void midend_set_params(midend_data *me, game_params *params);
 125 void midend_size(midend_data *me, int *x, int *y);
 126 void midend_new_game(midend_data *me);
 127 void midend_restart_game(midend_data *me);
 128 int midend_process_key(midend_data *me, int x, int y, int button);
 129 void midend_redraw(midend_data *me);
 130 float *midend_colours(midend_data *me, int *ncolours);
 131 void midend_timer(midend_data *me, float tplus);
 132 int midend_num_presets(midend_data *me);
 133 void midend_fetch_preset(midend_data *me, int n,
 134                          char **name, game_params **params);
 135 int midend_wants_statusbar(midend_data *me);
 136 enum { CFG_SETTINGS, CFG_SEED };
 137 config_item *midend_get_config(midend_data *me, int which, char **wintitle);
 138 char *midend_set_config(midend_data *me, int which, config_item *cfg);
 139 char *midend_game_id(midend_data *me, char *id, int def_seed);
 140
 141 /*
 142  * malloc.c
 143  */
 144 void *smalloc(int size);
 145 void *srealloc(void *p, int size);
 146 void sfree(void *p);
 147 char *dupstr(const char *s);
 148 #define snew(type) \
 149     ( (type *) smalloc (sizeof (type)) )
 150 #define snewn(number, type) \
 151     ( (type *) smalloc ((number) * sizeof (type)) )
 152 #define sresize(array, number, type) \
 153     ( (type *) srealloc ((array), (number) * sizeof (type)) )
 154
 155 /*
 156  * misc.c
 157  */
 158 void free_cfg(config_item *cfg);
 159
 160 /*
 161  * random.c
 162  */
 163 random_state *random_init(char *seed, int len);
 164 unsigned long random_bits(random_state *state, int bits);
 165 unsigned long random_upto(random_state *state, unsigned long limit);
 166 void random_free(random_state *state);
 167
 168 /*
 169  * Data structure containing the function calls and data specific
 170  * to a particular game. This is enclosed in a data structure so
 171  * that a particular platform can choose, if it wishes, to compile
 172  * all the games into a single combined executable rather than
 173  * having lots of little ones.
 174  */
 175 struct game {
 176     const char *name;
 177     const char *winhelp_topic;
 178     int can_configure;
 179     game_params *(*default_params)(void);
 180     int (*fetch_preset)(int i, char **name, game_params **params);
 181     game_params *(*decode_params)(char const *string);
 182     char *(*encode_params)(game_params *);
 183     void (*free_params)(game_params *params);
 184     game_params *(*dup_params)(game_params *params);
 185     config_item *(*configure)(game_params *params);
 186     game_params *(*custom_params)(config_item *cfg);
 187     char *(*validate_params)(game_params *params);
 188     char *(*new_seed)(game_params *params, random_state *rs);
 189     char *(*validate_seed)(game_params *params, char *seed);
 190     game_state *(*new_game)(game_params *params, char *seed);
 191     game_state *(*dup_game)(game_state *state);
 192     void (*free_game)(game_state *state);
 193     game_ui *(*new_ui)(game_state *state);
 194     void (*free_ui)(game_ui *ui);
 195     game_state *(*make_move)(game_state *from, game_ui *ui, int x, int y,
 196                              int button);
 197     void (*size)(game_params *params, int *x, int *y);
 198     float *(*colours)(frontend *fe, game_state *state, int *ncolours);
 199     game_drawstate *(*new_drawstate)(game_state *state);
 200     void (*free_drawstate)(game_drawstate *ds);
 201     void (*redraw)(frontend *fe, game_drawstate *ds, game_state *oldstate,
 202                    game_state *newstate, int dir, game_ui *ui, float anim_time,
 203                    float flash_time);
 204     float (*anim_length)(game_state *oldstate, game_state *newstate, int dir);
 205     float (*flash_length)(game_state *oldstate, game_state *newstate, int dir);
 206     int (*wants_statusbar)(void);
 207 };
 208
 209 /*
 210  * For one-game-at-a-time platforms, there's a single structure
 211  * like the above, under a fixed name. For all-at-once platforms,
 212  * there's a list of all available puzzles in array form.
 213  */
 214 #ifdef COMBINED
 215 extern const game *gamelist[];
 216 extern const int gamecount;
 217 #else
 218 extern const game thegame;
 219 #endif
 220
 221 #endif /* PUZZLES_PUZZLES_H */