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 #include <stdio.h>  /* for FILE */
   9 #include <stdlib.h> /* for size_t */
  10
  11 #ifndef TRUE
  12 #define TRUE 1
  13 #endif
  14 #ifndef FALSE
  15 #define FALSE 0
  16 #endif
  17
  18 #define PI 3.141592653589793238462643383279502884197169399
  19
  20 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
  21
  22 #define STR_INT(x) #x
  23 #define STR(x) STR_INT(x)
  24
  25 /* NB not perfect because they evaluate arguments multiple times. */
  26 #ifndef max
  27 #define max(x,y) ( (x)>(y) ? (x) : (y) )
  28 #endif /* max */
  29 #ifndef min
  30 #define min(x,y) ( (x)<(y) ? (x) : (y) )
  31 #endif /* min */
  32
  33 enum {
  34     LEFT_BUTTON = 0x0200,
  35     MIDDLE_BUTTON,
  36     RIGHT_BUTTON,
  37     LEFT_DRAG,
  38     MIDDLE_DRAG,
  39     RIGHT_DRAG,
  40     LEFT_RELEASE,
  41     MIDDLE_RELEASE,
  42     RIGHT_RELEASE,
  43     CURSOR_UP,
  44     CURSOR_DOWN,
  45     CURSOR_LEFT,
  46     CURSOR_RIGHT,
  47     CURSOR_SELECT,
  48
  49     /* made smaller because of 'limited range of datatype' errors. */
  50     MOD_CTRL       = 0x1000,
  51     MOD_SHFT       = 0x2000,
  52     MOD_NUM_KEYPAD = 0x4000,
  53     MOD_MASK       = 0x7000 /* mask for all modifiers */
  54 };
  55
  56 #define IS_MOUSE_DOWN(m) ( (unsigned)((m) - LEFT_BUTTON) <= \
  57                                (unsigned)(RIGHT_BUTTON - LEFT_BUTTON))
  58 #define IS_MOUSE_DRAG(m) ( (unsigned)((m) - LEFT_DRAG) <= \
  59                                (unsigned)(RIGHT_DRAG - LEFT_DRAG))
  60 #define IS_MOUSE_RELEASE(m) ( (unsigned)((m) - LEFT_RELEASE) <= \
  61                                (unsigned)(RIGHT_RELEASE - LEFT_RELEASE))
  62
  63 /* Bit flags indicating mouse button priorities */
  64 #define BUTTON_BEATS(x,y) ( 1 << (((x)-LEFT_BUTTON)*3+(y)-LEFT_BUTTON) )
  65
  66 /* Another random flag that goes in the mouse priorities section for want
  67  * of a better place to put it */
  68 #define SOLVE_ANIMATES ( 1 << 9 )
  69
  70 #define IGNOREARG(x) ( (x) = (x) )
  71
  72 typedef struct frontend frontend;
  73 typedef struct config_item config_item;
  74 typedef struct midend midend;
  75 typedef struct random_state random_state;
  76 typedef struct game_params game_params;
  77 typedef struct game_state game_state;
  78 typedef struct game_ui game_ui;
  79 typedef struct game_drawstate game_drawstate;
  80 typedef struct game game;
  81 typedef struct blitter blitter;
  82 typedef struct document document;
  83 typedef struct drawing_api drawing_api;
  84 typedef struct drawing drawing;
  85 typedef struct psdata psdata;
  86
  87 #define ALIGN_VNORMAL 0x000
  88 #define ALIGN_VCENTRE 0x100
  89
  90 #define ALIGN_HLEFT   0x000
  91 #define ALIGN_HCENTRE 0x001
  92 #define ALIGN_HRIGHT  0x002
  93
  94 #define FONT_FIXED    0
  95 #define FONT_VARIABLE 1
  96
  97 /* For printing colours */
  98 #define HATCH_SOLID 0
  99 #define HATCH_CLEAR 1
 100 #define HATCH_SLASH 2
 101 #define HATCH_BACKSLASH 3
 102 #define HATCH_HORIZ 4
 103 #define HATCH_VERT 5
 104 #define HATCH_PLUS 6
 105 #define HATCH_X 7
 106
 107 /*
 108  * Structure used to pass configuration data between frontend and
 109  * game
 110  */
 111 enum { C_STRING, C_CHOICES, C_BOOLEAN, C_END };
 112 struct config_item {
 113     /*
 114      * `name' is never dynamically allocated.
 115      */
 116     char *name;
 117     /*
 118      * `type' contains one of the above values.
 119      */
 120     int type;
 121     /*
 122      * For C_STRING, `sval' is always dynamically allocated and
 123      * non-NULL. For C_BOOLEAN and C_END, `sval' is always NULL.
 124      * For C_CHOICES, `sval' is non-NULL, _not_ dynamically
 125      * allocated, and contains a set of option strings separated by
 126      * a delimiter. The delimeter is also the first character in
 127      * the string, so for example ":Foo:Bar:Baz" gives three
 128      * options `Foo', `Bar' and `Baz'.
 129      */
 130     char *sval;
 131     /*
 132      * For C_BOOLEAN, this is TRUE or FALSE. For C_CHOICES, it
 133      * indicates the chosen index from the `sval' list. In the
 134      * above example, 0==Foo, 1==Bar and 2==Baz.
 135      */
 136     int ival;
 137 };
 138
 139 /*
 140  * Platform routines
 141  */
 142
 143 /* We can't use #ifdef DEBUG, because Cygwin defines it by default. */
 144 #ifdef DEBUGGING
 145 #define debug(x) (debug_printf x)
 146 void debug_printf(char *fmt, ...);
 147 #else
 148 #define debug(x)
 149 #endif
 150
 151 void fatal(char *fmt, ...);
 152 void frontend_default_colour(frontend *fe, float *output);
 153 void deactivate_timer(frontend *fe);
 154 void activate_timer(frontend *fe);
 155 void get_random_seed(void **randseed, int *randseedsize);
 156
 157 /*
 158  * drawing.c
 159  */
 160 drawing *drawing_init(const drawing_api *api, void *handle);
 161 void drawing_free(drawing *dr);
 162 void draw_text(drawing *dr, int x, int y, int fonttype, int fontsize,
 163                int align, int colour, char *text);
 164 void draw_rect(drawing *dr, int x, int y, int w, int h, int colour);
 165 void draw_line(drawing *dr, int x1, int y1, int x2, int y2, int colour);
 166 void draw_polygon(drawing *dr, int *coords, int npoints,
 167                   int fillcolour, int outlinecolour);
 168 void draw_circle(drawing *dr, int cx, int cy, int radius,
 169                  int fillcolour, int outlinecolour);
 170 void clip(drawing *dr, int x, int y, int w, int h);
 171 void unclip(drawing *dr);
 172 void start_draw(drawing *dr);
 173 void draw_update(drawing *dr, int x, int y, int w, int h);
 174 void end_draw(drawing *dr);
 175 void status_bar(drawing *dr, char *text);
 176 blitter *blitter_new(drawing *dr, int w, int h);
 177 void blitter_free(drawing *dr, blitter *bl);
 178 /* save puts the portion of the current display with top-left corner
 179  * (x,y) to the blitter. load puts it back again to the specified
 180  * coords, or else wherever it was saved from
 181  * (if x = y = BLITTER_FROMSAVED). */
 182 void blitter_save(drawing *dr, blitter *bl, int x, int y);
 183 #define BLITTER_FROMSAVED (-1)
 184 void blitter_load(drawing *dr, blitter *bl, int x, int y);
 185 void print_begin_doc(drawing *dr, int pages);
 186 void print_begin_page(drawing *dr, int number);
 187 void print_begin_puzzle(drawing *dr, float xm, float xc,
 188                         float ym, float yc, int pw, int ph, float wmm,
 189                         float scale);
 190 void print_end_puzzle(drawing *dr);
 191 void print_end_page(drawing *dr, int number);
 192 void print_end_doc(drawing *dr);
 193 void print_get_colour(drawing *dr, int colour, int *hatch,
 194                       float *r, float *g, float *b);
 195 int print_mono_colour(drawing *dr, int grey); /* 0==black, 1==white */
 196 int print_grey_colour(drawing *dr, int hatch, float grey);
 197 int print_rgb_colour(drawing *dr, int hatch, float r, float g, float b);
 198 void print_line_width(drawing *dr, int width);
 199
 200 /*
 201  * midend.c
 202  */
 203 midend *midend_new(frontend *fe, const game *ourgame,
 204                    const drawing_api *drapi, void *drhandle);
 205 void midend_free(midend *me);
 206 void midend_set_params(midend *me, game_params *params);
 207 game_params *midend_get_params(midend *me);
 208 void midend_size(midend *me, int *x, int *y, int expand);
 209 void midend_new_game(midend *me);
 210 void midend_restart_game(midend *me);
 211 void midend_stop_anim(midend *me);
 212 int midend_process_key(midend *me, int x, int y, int button);
 213 void midend_force_redraw(midend *me);
 214 void midend_redraw(midend *me);
 215 float *midend_colours(midend *me, int *ncolours);
 216 void midend_timer(midend *me, float tplus);
 217 int midend_num_presets(midend *me);
 218 void midend_fetch_preset(midend *me, int n,
 219                          char **name, game_params **params);
 220 int midend_wants_statusbar(midend *me);
 221 enum { CFG_SETTINGS, CFG_SEED, CFG_DESC, CFG_FRONTEND_SPECIFIC };
 222 config_item *midend_get_config(midend *me, int which, char **wintitle);
 223 char *midend_set_config(midend *me, int which, config_item *cfg);
 224 char *midend_game_id(midend *me, char *id);
 225 char *midend_get_game_id(midend *me);
 226 char *midend_text_format(midend *me);
 227 char *midend_solve(midend *me);
 228 void midend_supersede_game_desc(midend *me, char *desc, char *privdesc);
 229 char *midend_rewrite_statusbar(midend *me, char *text);
 230 void midend_serialise(midend *me,
 231                       void (*write)(void *ctx, void *buf, int len),
 232                       void *wctx);
 233 char *midend_deserialise(midend *me,
 234                          int (*read)(void *ctx, void *buf, int len),
 235                          void *rctx);
 236 /* Printing functions supplied by the mid-end */
 237 char *midend_print_puzzle(midend *me, document *doc, int with_soln);
 238
 239 /*
 240  * malloc.c
 241  */
 242 void *smalloc(size_t size);
 243 void *srealloc(void *p, size_t size);
 244 void sfree(void *p);
 245 char *dupstr(const char *s);
 246 #define snew(type) \
 247     ( (type *) smalloc (sizeof (type)) )
 248 #define snewn(number, type) \
 249     ( (type *) smalloc ((number) * sizeof (type)) )
 250 #define sresize(array, number, type) \
 251     ( (type *) srealloc ((array), (number) * sizeof (type)) )
 252
 253 /*
 254  * misc.c
 255  */
 256 void free_cfg(config_item *cfg);
 257 void obfuscate_bitmap(unsigned char *bmp, int bits, int decode);
 258
 259 /* allocates output each time. len is always in bytes of binary data.
 260  * May assert (or just go wrong) if lengths are unchecked. */
 261 char *bin2hex(const unsigned char *in, int inlen);
 262 unsigned char *hex2bin(const char *in, int outlen);
 263
 264 /* Sets (and possibly dims) background from frontend default colour,
 265  * and auto-generates highlight and lowlight colours too. */
 266 void game_mkhighlight(frontend *fe, float *ret,
 267                       int background, int highlight, int lowlight);
 268
 269 /* Randomly shuffles an array of items. */
 270 void shuffle(void *array, int nelts, int eltsize, random_state *rs);
 271
 272 /* Draw a rectangle outline, using the drawing API's draw_line. */
 273 void draw_rect_outline(drawing *dr, int x, int y, int w, int h,
 274                        int colour);
 275
 276 /*
 277  * dsf.c
 278  */
 279 int dsf_canonify(int *dsf, int val);
 280 void dsf_merge(int *dsf, int v1, int v2);
 281
 282 /*
 283  * version.c
 284  */
 285 extern char ver[];
 286
 287 /*
 288  * random.c
 289  */
 290 random_state *random_new(char *seed, int len);
 291 random_state *random_copy(random_state *tocopy);
 292 unsigned long random_bits(random_state *state, int bits);
 293 unsigned long random_upto(random_state *state, unsigned long limit);
 294 void random_free(random_state *state);
 295 char *random_state_encode(random_state *state);
 296 random_state *random_state_decode(char *input);
 297 /* random.c also exports SHA, which occasionally comes in useful. */
 298 typedef unsigned long uint32;
 299 typedef struct {
 300     uint32 h[5];
 301     unsigned char block[64];
 302     int blkused;
 303     uint32 lenhi, lenlo;
 304 } SHA_State;
 305 void SHA_Init(SHA_State *s);
 306 void SHA_Bytes(SHA_State *s, void *p, int len);
 307 void SHA_Final(SHA_State *s, unsigned char *output);
 308 void SHA_Simple(void *p, int len, unsigned char *output);
 309
 310 /*
 311  * printing.c
 312  */
 313 document *document_new(int pw, int ph, float userscale);
 314 void document_free(document *doc);
 315 void document_add_puzzle(document *doc, const game *game, game_params *par,
 316                          game_state *st, game_state *st2);
 317 void document_print(document *doc, drawing *dr);
 318
 319 /*
 320  * ps.c
 321  */
 322 psdata *ps_init(FILE *outfile, int colour);
 323 void ps_free(psdata *ps);
 324 drawing *ps_drawing_api(psdata *ps);
 325
 326 /*
 327  * combi.c: provides a structure and functions for iterating over
 328  * combinations (i.e. choosing r things out of n).
 329  */
 330 typedef struct _combi_ctx {
 331   int r, n, nleft, total;
 332   int *a;
 333 } combi_ctx;
 334
 335 combi_ctx *new_combi(int r, int n);
 336 void reset_combi(combi_ctx *combi);
 337 combi_ctx *next_combi(combi_ctx *combi); /* returns NULL for end */
 338 void free_combi(combi_ctx *combi);
 339
 340 /*
 341  * Data structure containing the function calls and data specific
 342  * to a particular game. This is enclosed in a data structure so
 343  * that a particular platform can choose, if it wishes, to compile
 344  * all the games into a single combined executable rather than
 345  * having lots of little ones.
 346  */
 347 struct game {
 348     const char *name;
 349     const char *winhelp_topic;
 350     game_params *(*default_params)(void);
 351     int (*fetch_preset)(int i, char **name, game_params **params);
 352     void (*decode_params)(game_params *, char const *string);
 353     char *(*encode_params)(game_params *, int full);
 354     void (*free_params)(game_params *params);
 355     game_params *(*dup_params)(game_params *params);
 356     int can_configure;
 357     config_item *(*configure)(game_params *params);
 358     game_params *(*custom_params)(config_item *cfg);
 359     char *(*validate_params)(game_params *params, int full);
 360     char *(*new_desc)(game_params *params, random_state *rs,
 361                       char **aux, int interactive);
 362     char *(*validate_desc)(game_params *params, char *desc);
 363     game_state *(*new_game)(midend *me, game_params *params, char *desc);
 364     game_state *(*dup_game)(game_state *state);
 365     void (*free_game)(game_state *state);
 366     int can_solve;
 367     char *(*solve)(game_state *orig, game_state *curr,
 368                    char *aux, char **error);
 369     int can_format_as_text;
 370     char *(*text_format)(game_state *state);
 371     game_ui *(*new_ui)(game_state *state);
 372     void (*free_ui)(game_ui *ui);
 373     char *(*encode_ui)(game_ui *ui);
 374     void (*decode_ui)(game_ui *ui, char *encoding);
 375     void (*changed_state)(game_ui *ui, game_state *oldstate,
 376                           game_state *newstate);
 377     char *(*interpret_move)(game_state *state, game_ui *ui, game_drawstate *ds,
 378                             int x, int y, int button);
 379     game_state *(*execute_move)(game_state *state, char *move);
 380     int preferred_tilesize;
 381     void (*compute_size)(game_params *params, int tilesize, int *x, int *y);
 382     void (*set_size)(drawing *dr, game_drawstate *ds,
 383                      game_params *params, int tilesize);
 384     float *(*colours)(frontend *fe, game_state *state, int *ncolours);
 385     game_drawstate *(*new_drawstate)(drawing *dr, game_state *state);
 386     void (*free_drawstate)(drawing *dr, game_drawstate *ds);
 387     void (*redraw)(drawing *dr, game_drawstate *ds, game_state *oldstate,
 388                    game_state *newstate, int dir, game_ui *ui, float anim_time,
 389                    float flash_time);
 390     float (*anim_length)(game_state *oldstate, game_state *newstate, int dir,
 391                          game_ui *ui);
 392     float (*flash_length)(game_state *oldstate, game_state *newstate, int dir,
 393                           game_ui *ui);
 394     int can_print, can_print_in_colour;
 395     void (*print_size)(game_params *params, float *x, float *y);
 396     void (*print)(drawing *dr, game_state *state, int tilesize);
 397     int (*wants_statusbar)(void);
 398     int is_timed;
 399     int (*timing_state)(game_state *state, game_ui *ui);
 400     int mouse_priorities;
 401 };
 402
 403 /*
 404  * Data structure containing the drawing API implemented by the
 405  * front end and also by cross-platform printing modules such as
 406  * PostScript.
 407  */
 408 struct drawing_api {
 409     void (*draw_text)(void *handle, int x, int y, int fonttype, int fontsize,
 410                       int align, int colour, char *text);
 411     void (*draw_rect)(void *handle, int x, int y, int w, int h, int colour);
 412     void (*draw_line)(void *handle, int x1, int y1, int x2, int y2,
 413                       int colour);
 414     void (*draw_polygon)(void *handle, int *coords, int npoints,
 415                          int fillcolour, int outlinecolour);
 416     void (*draw_circle)(void *handle, int cx, int cy, int radius,
 417                         int fillcolour, int outlinecolour);
 418     void (*draw_update)(void *handle, int x, int y, int w, int h);
 419     void (*clip)(void *handle, int x, int y, int w, int h);
 420     void (*unclip)(void *handle);
 421     void (*start_draw)(void *handle);
 422     void (*end_draw)(void *handle);
 423     void (*status_bar)(void *handle, char *text);
 424     blitter *(*blitter_new)(void *handle, int w, int h);
 425     void (*blitter_free)(void *handle, blitter *bl);
 426     void (*blitter_save)(void *handle, blitter *bl, int x, int y);
 427     void (*blitter_load)(void *handle, blitter *bl, int x, int y);
 428     void (*begin_doc)(void *handle, int pages);
 429     void (*begin_page)(void *handle, int number);
 430     void (*begin_puzzle)(void *handle, float xm, float xc,
 431                          float ym, float yc, int pw, int ph, float wmm);
 432     void (*end_puzzle)(void *handle);
 433     void (*end_page)(void *handle, int number);
 434     void (*end_doc)(void *handle);
 435     void (*line_width)(void *handle, float width);
 436 };
 437
 438 /*
 439  * For one-game-at-a-time platforms, there's a single structure
 440  * like the above, under a fixed name. For all-at-once platforms,
 441  * there's a list of all available puzzles in array form.
 442  */
 443 #ifdef COMBINED
 444 extern const game *gamelist[];
 445 extern const int gamecount;
 446 #else
 447 extern const game thegame;
 448 #endif
 449
 450 #endif /* PUZZLES_PUZZLES_H */