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