2 * puzzles.h: header file for my puzzle collection
5 #ifndef PUZZLES_PUZZLES_H
6 #define PUZZLES_PUZZLES_H
8 #include <stdio.h> /* for FILE */
9 #include <stdlib.h> /* for size_t */
10 #include <limits.h> /* for UINT_MAX */
19 #define PI 3.141592653589793238462643383279502884197169399
21 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
24 #define STR(x) STR_INT(x)
26 /* NB not perfect because they evaluate arguments multiple times. */
28 #define max(x,y) ( (x)>(y) ? (x) : (y) )
31 #define min(x,y) ( (x)<(y) ? (x) : (y) )
50 /* made smaller because of 'limited range of datatype' errors. */
53 MOD_NUM_KEYPAD = 0x4000,
54 MOD_MASK = 0x7000 /* mask for all modifiers */
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))
65 * Flags in the back end's `flags' word.
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 */
78 /* Pocket PC devices have small, portrait screen that requires more vivid colours */
80 #define PORTRAIT_SCREEN
85 #define IGNOREARG(x) ( (x) = (x) )
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;
102 #define ALIGN_VNORMAL 0x000
103 #define ALIGN_VCENTRE 0x100
105 #define ALIGN_HLEFT 0x000
106 #define ALIGN_HCENTRE 0x001
107 #define ALIGN_HRIGHT 0x002
110 #define FONT_VARIABLE 1
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
123 * Structure used to pass configuration data between frontend and
126 enum { C_STRING, C_CHOICES, C_BOOLEAN, C_END };
129 * `name' is never dynamically allocated.
133 * `type' contains one of the above values.
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'.
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.
158 /* We can't use #ifdef DEBUG, because Cygwin defines it by default. */
160 #define debug(x) (debug_printf x)
161 void debug_printf(char *fmt, ...);
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);
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,
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);
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),
249 char *midend_deserialise(midend *me,
250 int (*read)(void *ctx, void *buf, int len),
252 /* Printing functions supplied by the mid-end */
253 char *midend_print_puzzle(midend *me, document *doc, int with_soln);
258 void *smalloc(size_t size);
259 void *srealloc(void *p, size_t size);
261 char *dupstr(const char *s);
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)) )
272 void free_cfg(config_item *cfg);
273 void obfuscate_bitmap(unsigned char *bmp, int bits, int decode);
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);
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);
289 /* Randomly shuffles an array of items. */
290 void shuffle(void *array, int nelts, int eltsize, random_state *rs);
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,
299 int *snew_dsf(int size);
301 void print_dsf(int *dsf, int size);
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);
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);
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
337 typedef uint32_t uint32;
338 #elif UINT_MAX >= 4294967295L
339 typedef unsigned int uint32;
341 typedef unsigned long uint32;
345 unsigned char block[64];
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);
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);
366 psdata *ps_init(FILE *outfile, int colour);
367 void ps_free(psdata *ps);
368 drawing *ps_drawing_api(psdata *ps);
371 * combi.c: provides a structure and functions for iterating over
372 * combinations (i.e. choosing r things out of n).
374 typedef struct _combi_ctx {
375 int r, n, nleft, total;
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);
387 /* divides w*h rectangle into pieces of size k. Returns w*h dsf. */
388 int *divvy_rectangle(int w, int h, int k, random_state *rs);
391 * Data structure containing the function calls and data specific
392 * to a particular game. This is enclosed in a data structure so
393 * that a particular platform can choose, if it wishes, to compile
394 * all the games into a single combined executable rather than
395 * having lots of little ones.
399 const char *winhelp_topic, *htmlhelp_topic;
400 game_params *(*default_params)(void);
401 int (*fetch_preset)(int i, char **name, game_params **params);
402 void (*decode_params)(game_params *, char const *string);
403 char *(*encode_params)(game_params *, int full);
404 void (*free_params)(game_params *params);
405 game_params *(*dup_params)(game_params *params);
407 config_item *(*configure)(game_params *params);
408 game_params *(*custom_params)(config_item *cfg);
409 char *(*validate_params)(game_params *params, int full);
410 char *(*new_desc)(game_params *params, random_state *rs,
411 char **aux, int interactive);
412 char *(*validate_desc)(game_params *params, char *desc);
413 game_state *(*new_game)(midend *me, game_params *params, char *desc);
414 game_state *(*dup_game)(game_state *state);
415 void (*free_game)(game_state *state);
417 char *(*solve)(game_state *orig, game_state *curr,
418 char *aux, char **error);
419 int can_format_as_text;
420 char *(*text_format)(game_state *state);
421 game_ui *(*new_ui)(game_state *state);
422 void (*free_ui)(game_ui *ui);
423 char *(*encode_ui)(game_ui *ui);
424 void (*decode_ui)(game_ui *ui, char *encoding);
425 void (*changed_state)(game_ui *ui, game_state *oldstate,
426 game_state *newstate);
427 char *(*interpret_move)(game_state *state, game_ui *ui, game_drawstate *ds,
428 int x, int y, int button);
429 game_state *(*execute_move)(game_state *state, char *move);
430 int preferred_tilesize;
431 void (*compute_size)(game_params *params, int tilesize, int *x, int *y);
432 void (*set_size)(drawing *dr, game_drawstate *ds,
433 game_params *params, int tilesize);
434 float *(*colours)(frontend *fe, int *ncolours);
435 game_drawstate *(*new_drawstate)(drawing *dr, game_state *state);
436 void (*free_drawstate)(drawing *dr, game_drawstate *ds);
437 void (*redraw)(drawing *dr, game_drawstate *ds, game_state *oldstate,
438 game_state *newstate, int dir, game_ui *ui, float anim_time,
440 float (*anim_length)(game_state *oldstate, game_state *newstate, int dir,
442 float (*flash_length)(game_state *oldstate, game_state *newstate, int dir,
444 int can_print, can_print_in_colour;
445 void (*print_size)(game_params *params, float *x, float *y);
446 void (*print)(drawing *dr, game_state *state, int tilesize);
449 int (*timing_state)(game_state *state, game_ui *ui);
454 * Data structure containing the drawing API implemented by the
455 * front end and also by cross-platform printing modules such as
459 void (*draw_text)(void *handle, int x, int y, int fonttype, int fontsize,
460 int align, int colour, char *text);
461 void (*draw_rect)(void *handle, int x, int y, int w, int h, int colour);
462 void (*draw_line)(void *handle, int x1, int y1, int x2, int y2,
464 void (*draw_polygon)(void *handle, int *coords, int npoints,
465 int fillcolour, int outlinecolour);
466 void (*draw_circle)(void *handle, int cx, int cy, int radius,
467 int fillcolour, int outlinecolour);
468 void (*draw_update)(void *handle, int x, int y, int w, int h);
469 void (*clip)(void *handle, int x, int y, int w, int h);
470 void (*unclip)(void *handle);
471 void (*start_draw)(void *handle);
472 void (*end_draw)(void *handle);
473 void (*status_bar)(void *handle, char *text);
474 blitter *(*blitter_new)(void *handle, int w, int h);
475 void (*blitter_free)(void *handle, blitter *bl);
476 void (*blitter_save)(void *handle, blitter *bl, int x, int y);
477 void (*blitter_load)(void *handle, blitter *bl, int x, int y);
478 void (*begin_doc)(void *handle, int pages);
479 void (*begin_page)(void *handle, int number);
480 void (*begin_puzzle)(void *handle, float xm, float xc,
481 float ym, float yc, int pw, int ph, float wmm);
482 void (*end_puzzle)(void *handle);
483 void (*end_page)(void *handle, int number);
484 void (*end_doc)(void *handle);
485 void (*line_width)(void *handle, float width);
489 * For one-game-at-a-time platforms, there's a single structure
490 * like the above, under a fixed name. For all-at-once platforms,
491 * there's a list of all available puzzles in array form.
494 extern const game *gamelist[];
495 extern const int gamecount;
497 extern const game thegame;
500 #endif /* PUZZLES_PUZZLES_H */