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) )
51 /* made smaller because of 'limited range of datatype' errors. */
54 MOD_NUM_KEYPAD
= 0x4000,
55 MOD_MASK
= 0x7000 /* mask for all modifiers */
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)
69 * Flags in the back end's `flags' word.
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 */
82 /* Pocket PC devices have small, portrait screen that requires more vivid colours */
84 #define PORTRAIT_SCREEN
89 #define IGNOREARG(x) ( (x) = (x) )
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
;
106 #define ALIGN_VNORMAL 0x000
107 #define ALIGN_VCENTRE 0x100
109 #define ALIGN_HLEFT 0x000
110 #define ALIGN_HCENTRE 0x001
111 #define ALIGN_HRIGHT 0x002
114 #define FONT_VARIABLE 1
116 /* For printing colours */
117 #define HATCH_SLASH 1
118 #define HATCH_BACKSLASH 2
119 #define HATCH_HORIZ 3
125 * Structure used to pass configuration data between frontend and
128 enum { C_STRING
, C_CHOICES
, C_BOOLEAN
, C_END
};
131 * `name' is never dynamically allocated.
135 * `type' contains one of the above values.
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'.
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.
160 /* We can't use #ifdef DEBUG, because Cygwin defines it by default. */
162 #define debug(x) (debug_printf x)
163 void debug_printf(char *fmt
, ...);
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
);
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 char *text_fallback(drawing
*dr
, const char *const *strings
, int nstrings
);
193 void status_bar(drawing
*dr
, char *text
);
194 blitter
*blitter_new(drawing
*dr
, int w
, int h
);
195 void blitter_free(drawing
*dr
, blitter
*bl
);
196 /* save puts the portion of the current display with top-left corner
197 * (x,y) to the blitter. load puts it back again to the specified
198 * coords, or else wherever it was saved from
199 * (if x = y = BLITTER_FROMSAVED). */
200 void blitter_save(drawing
*dr
, blitter
*bl
, int x
, int y
);
201 #define BLITTER_FROMSAVED (-1)
202 void blitter_load(drawing
*dr
, blitter
*bl
, int x
, int y
);
203 void print_begin_doc(drawing
*dr
, int pages
);
204 void print_begin_page(drawing
*dr
, int number
);
205 void print_begin_puzzle(drawing
*dr
, float xm
, float xc
,
206 float ym
, float yc
, int pw
, int ph
, float wmm
,
208 void print_end_puzzle(drawing
*dr
);
209 void print_end_page(drawing
*dr
, int number
);
210 void print_end_doc(drawing
*dr
);
211 void print_get_colour(drawing
*dr
, int colour
, int printing_in_colour
,
212 int *hatch
, float *r
, float *g
, float *b
);
213 int print_mono_colour(drawing
*dr
, int grey
); /* 0==black, 1==white */
214 int print_grey_colour(drawing
*dr
, float grey
);
215 int print_hatched_colour(drawing
*dr
, int hatch
);
216 int print_rgb_mono_colour(drawing
*dr
, float r
, float g
, float b
, int mono
);
217 int print_rgb_grey_colour(drawing
*dr
, float r
, float g
, float b
, float grey
);
218 int print_rgb_hatched_colour(drawing
*dr
, float r
, float g
, float b
,
220 void print_line_width(drawing
*dr
, int width
);
221 void print_line_dotted(drawing
*dr
, int dotted
);
226 midend
*midend_new(frontend
*fe
, const game
*ourgame
,
227 const drawing_api
*drapi
, void *drhandle
);
228 void midend_free(midend
*me
);
229 void midend_set_params(midend
*me
, game_params
*params
);
230 game_params
*midend_get_params(midend
*me
);
231 void midend_size(midend
*me
, int *x
, int *y
, int user_size
);
232 void midend_new_game(midend
*me
);
233 void midend_restart_game(midend
*me
);
234 void midend_stop_anim(midend
*me
);
235 int midend_process_key(midend
*me
, int x
, int y
, int button
);
236 void midend_force_redraw(midend
*me
);
237 void midend_redraw(midend
*me
);
238 float *midend_colours(midend
*me
, int *ncolours
);
239 void midend_freeze_timer(midend
*me
, float tprop
);
240 void midend_timer(midend
*me
, float tplus
);
241 int midend_num_presets(midend
*me
);
242 void midend_fetch_preset(midend
*me
, int n
,
243 char **name
, game_params
**params
);
244 int midend_which_preset(midend
*me
);
245 int midend_wants_statusbar(midend
*me
);
246 enum { CFG_SETTINGS
, CFG_SEED
, CFG_DESC
, CFG_FRONTEND_SPECIFIC
};
247 config_item
*midend_get_config(midend
*me
, int which
, char **wintitle
);
248 char *midend_set_config(midend
*me
, int which
, config_item
*cfg
);
249 char *midend_game_id(midend
*me
, char *id
);
250 char *midend_get_game_id(midend
*me
);
251 int midend_can_format_as_text_now(midend
*me
);
252 char *midend_text_format(midend
*me
);
253 char *midend_solve(midend
*me
);
254 void midend_supersede_game_desc(midend
*me
, char *desc
, char *privdesc
);
255 char *midend_rewrite_statusbar(midend
*me
, char *text
);
256 void midend_serialise(midend
*me
,
257 void (*write
)(void *ctx
, void *buf
, int len
),
259 char *midend_deserialise(midend
*me
,
260 int (*read
)(void *ctx
, void *buf
, int len
),
262 /* Printing functions supplied by the mid-end */
263 char *midend_print_puzzle(midend
*me
, document
*doc
, int with_soln
);
264 int midend_tilesize(midend
*me
);
269 void *smalloc(size_t size
);
270 void *srealloc(void *p
, size_t size
);
272 char *dupstr(const char *s
);
274 ( (type *) smalloc (sizeof (type)) )
275 #define snewn(number, type) \
276 ( (type *) smalloc ((number) * sizeof (type)) )
277 #define sresize(array, number, type) \
278 ( (type *) srealloc ((array), (number) * sizeof (type)) )
283 void free_cfg(config_item
*cfg
);
284 void obfuscate_bitmap(unsigned char *bmp
, int bits
, int decode
);
286 /* allocates output each time. len is always in bytes of binary data.
287 * May assert (or just go wrong) if lengths are unchecked. */
288 char *bin2hex(const unsigned char *in
, int inlen
);
289 unsigned char *hex2bin(const char *in
, int outlen
);
291 /* Sets (and possibly dims) background from frontend default colour,
292 * and auto-generates highlight and lowlight colours too. */
293 void game_mkhighlight(frontend
*fe
, float *ret
,
294 int background
, int highlight
, int lowlight
);
295 /* As above, but starts from a provided background colour rather
296 * than the frontend default. */
297 void game_mkhighlight_specific(frontend
*fe
, float *ret
,
298 int background
, int highlight
, int lowlight
);
300 /* Randomly shuffles an array of items. */
301 void shuffle(void *array
, int nelts
, int eltsize
, random_state
*rs
);
303 /* Draw a rectangle outline, using the drawing API's draw_line. */
304 void draw_rect_outline(drawing
*dr
, int x
, int y
, int w
, int h
,
307 /* Draw a set of rectangle corners (e.g. for a cursor display). */
308 void draw_rect_corners(drawing
*dr
, int cx
, int cy
, int r
, int col
);
310 void move_cursor(int button
, int *x
, int *y
, int maxw
, int maxh
, int wrap
);
312 /* Used in netslide.c and sixteen.c for cursor movement around edge. */
313 int c2pos(int w
, int h
, int cx
, int cy
);
314 int c2diff(int w
, int h
, int cx
, int cy
, int button
);
315 void pos2c(int w
, int h
, int pos
, int *cx
, int *cy
);
317 /* Draws text with an 'outline' formed by offsetting the text
318 * by one pixel; useful for highlighting. Outline is omitted if -1. */
319 void draw_text_outline(drawing
*dr
, int x
, int y
, int fonttype
,
320 int fontsize
, int align
,
321 int text_colour
, int outline_colour
, char *text
);
325 int *snew_dsf(int size
);
327 void print_dsf(int *dsf
, int size
);
329 /* Return the canonical element of the equivalence class containing element
330 * val. If 'inverse' is non-NULL, this function will put into it a flag
331 * indicating whether the canonical element is inverse to val. */
332 int edsf_canonify(int *dsf
, int val
, int *inverse
);
333 int dsf_canonify(int *dsf
, int val
);
334 int dsf_size(int *dsf
, int val
);
336 /* Allow the caller to specify that two elements should be in the same
337 * equivalence class. If 'inverse' is TRUE, the elements are actually opposite
338 * to one another in some sense. This function will fail an assertion if the
339 * caller gives it self-contradictory data, ie if two elements are claimed to
340 * be both opposite and non-opposite. */
341 void edsf_merge(int *dsf
, int v1
, int v2
, int inverse
);
342 void dsf_merge(int *dsf
, int v1
, int v2
);
343 void dsf_init(int *dsf
, int len
);
348 int *domino_layout(int w
, int h
, random_state
*rs
);
349 void domino_layout_prealloc(int w
, int h
, random_state
*rs
,
350 int *grid
, int *grid2
, int *list
);
359 random_state
*random_new(char *seed
, int len
);
360 random_state
*random_copy(random_state
*tocopy
);
361 unsigned long random_bits(random_state
*state
, int bits
);
362 unsigned long random_upto(random_state
*state
, unsigned long limit
);
363 void random_free(random_state
*state
);
364 char *random_state_encode(random_state
*state
);
365 random_state
*random_state_decode(char *input
);
366 /* random.c also exports SHA, which occasionally comes in useful. */
367 #if __STDC_VERSION__ >= 199901L
369 typedef uint32_t uint32
;
370 #elif UINT_MAX >= 4294967295L
371 typedef unsigned int uint32
;
373 typedef unsigned long uint32
;
377 unsigned char block
[64];
381 void SHA_Init(SHA_State
*s
);
382 void SHA_Bytes(SHA_State
*s
, void *p
, int len
);
383 void SHA_Final(SHA_State
*s
, unsigned char *output
);
384 void SHA_Simple(void *p
, int len
, unsigned char *output
);
389 document
*document_new(int pw
, int ph
, float userscale
);
390 void document_free(document
*doc
);
391 void document_add_puzzle(document
*doc
, const game
*game
, game_params
*par
,
392 game_state
*st
, game_state
*st2
);
393 void document_print(document
*doc
, drawing
*dr
);
398 psdata
*ps_init(FILE *outfile
, int colour
);
399 void ps_free(psdata
*ps
);
400 drawing
*ps_drawing_api(psdata
*ps
);
403 * combi.c: provides a structure and functions for iterating over
404 * combinations (i.e. choosing r things out of n).
406 typedef struct _combi_ctx
{
407 int r
, n
, nleft
, total
;
411 combi_ctx
*new_combi(int r
, int n
);
412 void reset_combi(combi_ctx
*combi
);
413 combi_ctx
*next_combi(combi_ctx
*combi
); /* returns NULL for end */
414 void free_combi(combi_ctx
*combi
);
419 /* divides w*h rectangle into pieces of size k. Returns w*h dsf. */
420 int *divvy_rectangle(int w
, int h
, int k
, random_state
*rs
);
423 * Data structure containing the function calls and data specific
424 * to a particular game. This is enclosed in a data structure so
425 * that a particular platform can choose, if it wishes, to compile
426 * all the games into a single combined executable rather than
427 * having lots of little ones.
431 const char *winhelp_topic
, *htmlhelp_topic
;
432 game_params
*(*default_params
)(void);
433 int (*fetch_preset
)(int i
, char **name
, game_params
**params
);
434 void (*decode_params
)(game_params
*, char const *string
);
435 char *(*encode_params
)(game_params
*, int full
);
436 void (*free_params
)(game_params
*params
);
437 game_params
*(*dup_params
)(game_params
*params
);
439 config_item
*(*configure
)(game_params
*params
);
440 game_params
*(*custom_params
)(config_item
*cfg
);
441 char *(*validate_params
)(game_params
*params
, int full
);
442 char *(*new_desc
)(game_params
*params
, random_state
*rs
,
443 char **aux
, int interactive
);
444 char *(*validate_desc
)(game_params
*params
, char *desc
);
445 game_state
*(*new_game
)(midend
*me
, game_params
*params
, char *desc
);
446 game_state
*(*dup_game
)(game_state
*state
);
447 void (*free_game
)(game_state
*state
);
449 char *(*solve
)(game_state
*orig
, game_state
*curr
,
450 char *aux
, char **error
);
451 int can_format_as_text_ever
;
452 int (*can_format_as_text_now
)(game_params
*params
);
453 char *(*text_format
)(game_state
*state
);
454 game_ui
*(*new_ui
)(game_state
*state
);
455 void (*free_ui
)(game_ui
*ui
);
456 char *(*encode_ui
)(game_ui
*ui
);
457 void (*decode_ui
)(game_ui
*ui
, char *encoding
);
458 void (*changed_state
)(game_ui
*ui
, game_state
*oldstate
,
459 game_state
*newstate
);
460 char *(*interpret_move
)(game_state
*state
, game_ui
*ui
, game_drawstate
*ds
,
461 int x
, int y
, int button
);
462 game_state
*(*execute_move
)(game_state
*state
, char *move
);
463 int preferred_tilesize
;
464 void (*compute_size
)(game_params
*params
, int tilesize
, int *x
, int *y
);
465 void (*set_size
)(drawing
*dr
, game_drawstate
*ds
,
466 game_params
*params
, int tilesize
);
467 float *(*colours
)(frontend
*fe
, int *ncolours
);
468 game_drawstate
*(*new_drawstate
)(drawing
*dr
, game_state
*state
);
469 void (*free_drawstate
)(drawing
*dr
, game_drawstate
*ds
);
470 void (*redraw
)(drawing
*dr
, game_drawstate
*ds
, game_state
*oldstate
,
471 game_state
*newstate
, int dir
, game_ui
*ui
, float anim_time
,
473 float (*anim_length
)(game_state
*oldstate
, game_state
*newstate
, int dir
,
475 float (*flash_length
)(game_state
*oldstate
, game_state
*newstate
, int dir
,
477 int can_print
, can_print_in_colour
;
478 void (*print_size
)(game_params
*params
, float *x
, float *y
);
479 void (*print
)(drawing
*dr
, game_state
*state
, int tilesize
);
482 int (*timing_state
)(game_state
*state
, game_ui
*ui
);
487 * Data structure containing the drawing API implemented by the
488 * front end and also by cross-platform printing modules such as
492 void (*draw_text
)(void *handle
, int x
, int y
, int fonttype
, int fontsize
,
493 int align
, int colour
, char *text
);
494 void (*draw_rect
)(void *handle
, int x
, int y
, int w
, int h
, int colour
);
495 void (*draw_line
)(void *handle
, int x1
, int y1
, int x2
, int y2
,
497 void (*draw_polygon
)(void *handle
, int *coords
, int npoints
,
498 int fillcolour
, int outlinecolour
);
499 void (*draw_circle
)(void *handle
, int cx
, int cy
, int radius
,
500 int fillcolour
, int outlinecolour
);
501 void (*draw_update
)(void *handle
, int x
, int y
, int w
, int h
);
502 void (*clip
)(void *handle
, int x
, int y
, int w
, int h
);
503 void (*unclip
)(void *handle
);
504 void (*start_draw
)(void *handle
);
505 void (*end_draw
)(void *handle
);
506 void (*status_bar
)(void *handle
, char *text
);
507 blitter
*(*blitter_new
)(void *handle
, int w
, int h
);
508 void (*blitter_free
)(void *handle
, blitter
*bl
);
509 void (*blitter_save
)(void *handle
, blitter
*bl
, int x
, int y
);
510 void (*blitter_load
)(void *handle
, blitter
*bl
, int x
, int y
);
511 void (*begin_doc
)(void *handle
, int pages
);
512 void (*begin_page
)(void *handle
, int number
);
513 void (*begin_puzzle
)(void *handle
, float xm
, float xc
,
514 float ym
, float yc
, int pw
, int ph
, float wmm
);
515 void (*end_puzzle
)(void *handle
);
516 void (*end_page
)(void *handle
, int number
);
517 void (*end_doc
)(void *handle
);
518 void (*line_width
)(void *handle
, float width
);
519 void (*line_dotted
)(void *handle
, int dotted
);
520 char *(*text_fallback
)(void *handle
, const char *const *strings
,
525 * For one-game-at-a-time platforms, there's a single structure
526 * like the above, under a fixed name. For all-at-once platforms,
527 * there's a list of all available puzzles in array form.
530 extern const game
*gamelist
[];
531 extern const int gamecount
;
533 extern const game thegame
;
536 #endif /* PUZZLES_PUZZLES_H */