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