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 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
,
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
,
219 void print_line_width(drawing
*dr
, int width
);
220 void print_line_dotted(drawing
*dr
, int dotted
);
225 midend
*midend_new(frontend
*fe
, const game
*ourgame
,
226 const drawing_api
*drapi
, void *drhandle
);
227 void midend_free(midend
*me
);
228 void midend_set_params(midend
*me
, game_params
*params
);
229 game_params
*midend_get_params(midend
*me
);
230 void midend_size(midend
*me
, int *x
, int *y
, int user_size
);
231 void midend_new_game(midend
*me
);
232 void midend_restart_game(midend
*me
);
233 void midend_stop_anim(midend
*me
);
234 int midend_process_key(midend
*me
, int x
, int y
, int button
);
235 void midend_force_redraw(midend
*me
);
236 void midend_redraw(midend
*me
);
237 float *midend_colours(midend
*me
, int *ncolours
);
238 void midend_freeze_timer(midend
*me
, float tprop
);
239 void midend_timer(midend
*me
, float tplus
);
240 int midend_num_presets(midend
*me
);
241 void midend_fetch_preset(midend
*me
, int n
,
242 char **name
, game_params
**params
);
243 int midend_which_preset(midend
*me
);
244 int midend_wants_statusbar(midend
*me
);
245 enum { CFG_SETTINGS
, CFG_SEED
, CFG_DESC
, CFG_FRONTEND_SPECIFIC
};
246 config_item
*midend_get_config(midend
*me
, int which
, char **wintitle
);
247 char *midend_set_config(midend
*me
, int which
, config_item
*cfg
);
248 char *midend_game_id(midend
*me
, char *id
);
249 char *midend_get_game_id(midend
*me
);
250 int midend_can_format_as_text_now(midend
*me
);
251 char *midend_text_format(midend
*me
);
252 char *midend_solve(midend
*me
);
253 void midend_supersede_game_desc(midend
*me
, char *desc
, char *privdesc
);
254 char *midend_rewrite_statusbar(midend
*me
, char *text
);
255 void midend_serialise(midend
*me
,
256 void (*write
)(void *ctx
, void *buf
, int len
),
258 char *midend_deserialise(midend
*me
,
259 int (*read
)(void *ctx
, void *buf
, int len
),
261 /* Printing functions supplied by the mid-end */
262 char *midend_print_puzzle(midend
*me
, document
*doc
, int with_soln
);
263 int midend_tilesize(midend
*me
);
268 void *smalloc(size_t size
);
269 void *srealloc(void *p
, size_t size
);
271 char *dupstr(const char *s
);
273 ( (type *) smalloc (sizeof (type)) )
274 #define snewn(number, type) \
275 ( (type *) smalloc ((number) * sizeof (type)) )
276 #define sresize(array, number, type) \
277 ( (type *) srealloc ((array), (number) * sizeof (type)) )
282 void free_cfg(config_item
*cfg
);
283 void obfuscate_bitmap(unsigned char *bmp
, int bits
, int decode
);
285 /* allocates output each time. len is always in bytes of binary data.
286 * May assert (or just go wrong) if lengths are unchecked. */
287 char *bin2hex(const unsigned char *in
, int inlen
);
288 unsigned char *hex2bin(const char *in
, int outlen
);
290 /* Sets (and possibly dims) background from frontend default colour,
291 * and auto-generates highlight and lowlight colours too. */
292 void game_mkhighlight(frontend
*fe
, float *ret
,
293 int background
, int highlight
, int lowlight
);
294 /* As above, but starts from a provided background colour rather
295 * than the frontend default. */
296 void game_mkhighlight_specific(frontend
*fe
, float *ret
,
297 int background
, int highlight
, int lowlight
);
299 /* Randomly shuffles an array of items. */
300 void shuffle(void *array
, int nelts
, int eltsize
, random_state
*rs
);
302 /* Draw a rectangle outline, using the drawing API's draw_line. */
303 void draw_rect_outline(drawing
*dr
, int x
, int y
, int w
, int h
,
306 void move_cursor(int button
, int *x
, int *y
, int maxw
, int maxh
, int wrap
);
308 /* Used in netslide.c and sixteen.c for cursor movement around edge. */
309 int c2pos(int w
, int h
, int cx
, int cy
);
310 int c2diff(int w
, int h
, int cx
, int cy
, int button
);
311 void pos2c(int w
, int h
, int pos
, int *cx
, int *cy
);
313 /* Draws text with an 'outline' formed by offsetting the text
314 * by one pixel; useful for highlighting. Outline is omitted if -1. */
315 void draw_text_outline(drawing
*dr
, int x
, int y
, int fonttype
,
316 int fontsize
, int align
,
317 int text_colour
, int outline_colour
, char *text
);
321 int *snew_dsf(int size
);
323 void print_dsf(int *dsf
, int size
);
325 /* Return the canonical element of the equivalence class containing element
326 * val. If 'inverse' is non-NULL, this function will put into it a flag
327 * indicating whether the canonical element is inverse to val. */
328 int edsf_canonify(int *dsf
, int val
, int *inverse
);
329 int dsf_canonify(int *dsf
, int val
);
330 int dsf_size(int *dsf
, int val
);
332 /* Allow the caller to specify that two elements should be in the same
333 * equivalence class. If 'inverse' is TRUE, the elements are actually opposite
334 * to one another in some sense. This function will fail an assertion if the
335 * caller gives it self-contradictory data, ie if two elements are claimed to
336 * be both opposite and non-opposite. */
337 void edsf_merge(int *dsf
, int v1
, int v2
, int inverse
);
338 void dsf_merge(int *dsf
, int v1
, int v2
);
339 void dsf_init(int *dsf
, int len
);
344 int *domino_layout(int w
, int h
, random_state
*rs
);
345 void domino_layout_prealloc(int w
, int h
, random_state
*rs
,
346 int *grid
, int *grid2
, int *list
);
355 random_state
*random_new(char *seed
, int len
);
356 random_state
*random_copy(random_state
*tocopy
);
357 unsigned long random_bits(random_state
*state
, int bits
);
358 unsigned long random_upto(random_state
*state
, unsigned long limit
);
359 void random_free(random_state
*state
);
360 char *random_state_encode(random_state
*state
);
361 random_state
*random_state_decode(char *input
);
362 /* random.c also exports SHA, which occasionally comes in useful. */
363 #if __STDC_VERSION__ >= 199901L
365 typedef uint32_t uint32
;
366 #elif UINT_MAX >= 4294967295L
367 typedef unsigned int uint32
;
369 typedef unsigned long uint32
;
373 unsigned char block
[64];
377 void SHA_Init(SHA_State
*s
);
378 void SHA_Bytes(SHA_State
*s
, void *p
, int len
);
379 void SHA_Final(SHA_State
*s
, unsigned char *output
);
380 void SHA_Simple(void *p
, int len
, unsigned char *output
);
385 document
*document_new(int pw
, int ph
, float userscale
);
386 void document_free(document
*doc
);
387 void document_add_puzzle(document
*doc
, const game
*game
, game_params
*par
,
388 game_state
*st
, game_state
*st2
);
389 void document_print(document
*doc
, drawing
*dr
);
394 psdata
*ps_init(FILE *outfile
, int colour
);
395 void ps_free(psdata
*ps
);
396 drawing
*ps_drawing_api(psdata
*ps
);
399 * combi.c: provides a structure and functions for iterating over
400 * combinations (i.e. choosing r things out of n).
402 typedef struct _combi_ctx
{
403 int r
, n
, nleft
, total
;
407 combi_ctx
*new_combi(int r
, int n
);
408 void reset_combi(combi_ctx
*combi
);
409 combi_ctx
*next_combi(combi_ctx
*combi
); /* returns NULL for end */
410 void free_combi(combi_ctx
*combi
);
415 /* divides w*h rectangle into pieces of size k. Returns w*h dsf. */
416 int *divvy_rectangle(int w
, int h
, int k
, random_state
*rs
);
419 * Data structure containing the function calls and data specific
420 * to a particular game. This is enclosed in a data structure so
421 * that a particular platform can choose, if it wishes, to compile
422 * all the games into a single combined executable rather than
423 * having lots of little ones.
427 const char *winhelp_topic
, *htmlhelp_topic
;
428 game_params
*(*default_params
)(void);
429 int (*fetch_preset
)(int i
, char **name
, game_params
**params
);
430 void (*decode_params
)(game_params
*, char const *string
);
431 char *(*encode_params
)(game_params
*, int full
);
432 void (*free_params
)(game_params
*params
);
433 game_params
*(*dup_params
)(game_params
*params
);
435 config_item
*(*configure
)(game_params
*params
);
436 game_params
*(*custom_params
)(config_item
*cfg
);
437 char *(*validate_params
)(game_params
*params
, int full
);
438 char *(*new_desc
)(game_params
*params
, random_state
*rs
,
439 char **aux
, int interactive
);
440 char *(*validate_desc
)(game_params
*params
, char *desc
);
441 game_state
*(*new_game
)(midend
*me
, game_params
*params
, char *desc
);
442 game_state
*(*dup_game
)(game_state
*state
);
443 void (*free_game
)(game_state
*state
);
445 char *(*solve
)(game_state
*orig
, game_state
*curr
,
446 char *aux
, char **error
);
447 int can_format_as_text_ever
;
448 int (*can_format_as_text_now
)(game_params
*params
);
449 char *(*text_format
)(game_state
*state
);
450 game_ui
*(*new_ui
)(game_state
*state
);
451 void (*free_ui
)(game_ui
*ui
);
452 char *(*encode_ui
)(game_ui
*ui
);
453 void (*decode_ui
)(game_ui
*ui
, char *encoding
);
454 void (*changed_state
)(game_ui
*ui
, game_state
*oldstate
,
455 game_state
*newstate
);
456 char *(*interpret_move
)(game_state
*state
, game_ui
*ui
, game_drawstate
*ds
,
457 int x
, int y
, int button
);
458 game_state
*(*execute_move
)(game_state
*state
, char *move
);
459 int preferred_tilesize
;
460 void (*compute_size
)(game_params
*params
, int tilesize
, int *x
, int *y
);
461 void (*set_size
)(drawing
*dr
, game_drawstate
*ds
,
462 game_params
*params
, int tilesize
);
463 float *(*colours
)(frontend
*fe
, int *ncolours
);
464 game_drawstate
*(*new_drawstate
)(drawing
*dr
, game_state
*state
);
465 void (*free_drawstate
)(drawing
*dr
, game_drawstate
*ds
);
466 void (*redraw
)(drawing
*dr
, game_drawstate
*ds
, game_state
*oldstate
,
467 game_state
*newstate
, int dir
, game_ui
*ui
, float anim_time
,
469 float (*anim_length
)(game_state
*oldstate
, game_state
*newstate
, int dir
,
471 float (*flash_length
)(game_state
*oldstate
, game_state
*newstate
, int dir
,
473 int can_print
, can_print_in_colour
;
474 void (*print_size
)(game_params
*params
, float *x
, float *y
);
475 void (*print
)(drawing
*dr
, game_state
*state
, int tilesize
);
478 int (*timing_state
)(game_state
*state
, game_ui
*ui
);
483 * Data structure containing the drawing API implemented by the
484 * front end and also by cross-platform printing modules such as
488 void (*draw_text
)(void *handle
, int x
, int y
, int fonttype
, int fontsize
,
489 int align
, int colour
, char *text
);
490 void (*draw_rect
)(void *handle
, int x
, int y
, int w
, int h
, int colour
);
491 void (*draw_line
)(void *handle
, int x1
, int y1
, int x2
, int y2
,
493 void (*draw_polygon
)(void *handle
, int *coords
, int npoints
,
494 int fillcolour
, int outlinecolour
);
495 void (*draw_circle
)(void *handle
, int cx
, int cy
, int radius
,
496 int fillcolour
, int outlinecolour
);
497 void (*draw_update
)(void *handle
, int x
, int y
, int w
, int h
);
498 void (*clip
)(void *handle
, int x
, int y
, int w
, int h
);
499 void (*unclip
)(void *handle
);
500 void (*start_draw
)(void *handle
);
501 void (*end_draw
)(void *handle
);
502 void (*status_bar
)(void *handle
, char *text
);
503 blitter
*(*blitter_new
)(void *handle
, int w
, int h
);
504 void (*blitter_free
)(void *handle
, blitter
*bl
);
505 void (*blitter_save
)(void *handle
, blitter
*bl
, int x
, int y
);
506 void (*blitter_load
)(void *handle
, blitter
*bl
, int x
, int y
);
507 void (*begin_doc
)(void *handle
, int pages
);
508 void (*begin_page
)(void *handle
, int number
);
509 void (*begin_puzzle
)(void *handle
, float xm
, float xc
,
510 float ym
, float yc
, int pw
, int ph
, float wmm
);
511 void (*end_puzzle
)(void *handle
);
512 void (*end_page
)(void *handle
, int number
);
513 void (*end_doc
)(void *handle
);
514 void (*line_width
)(void *handle
, float width
);
515 void (*line_dotted
)(void *handle
, int dotted
);
519 * For one-game-at-a-time platforms, there's a single structure
520 * like the above, under a fixed name. For all-at-once platforms,
521 * there's a list of all available puzzles in array form.
524 extern const game
*gamelist
[];
525 extern const int gamecount
;
527 extern const game thegame
;
530 #endif /* PUZZLES_PUZZLES_H */