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