Add grotty casts to prevent negative -> large positive conversion of cursor
[sgt/puzzles] / puzzles.h
CommitLineData
720a8fb7 1/*
2 * puzzles.h: header file for my puzzle collection
3 */
4
5#ifndef PUZZLES_PUZZLES_H
6#define PUZZLES_PUZZLES_H
7
8#ifndef TRUE
9#define TRUE 1
10#endif
11#ifndef FALSE
12#define FALSE 0
13#endif
14
15#define lenof(array) ( sizeof(array) / sizeof(*(array)) )
16
17enum {
18 LEFT_BUTTON = 0x1000,
19 MIDDLE_BUTTON,
1482ee76 20 RIGHT_BUTTON,
74a4e547 21 LEFT_DRAG,
22 MIDDLE_DRAG,
23 RIGHT_DRAG,
24 LEFT_RELEASE,
25 MIDDLE_RELEASE,
26 RIGHT_RELEASE,
1482ee76 27 CURSOR_UP,
28 CURSOR_DOWN,
29 CURSOR_LEFT,
c71454c0 30 CURSOR_RIGHT,
31 CURSOR_UP_LEFT,
32 CURSOR_DOWN_LEFT,
33 CURSOR_UP_RIGHT,
34 CURSOR_DOWN_RIGHT
720a8fb7 35};
36
4e7ef6e6 37#define IGNOREARG(x) ( (x) = (x) )
7f77ea24 38
2ef96bd6 39typedef struct frontend frontend;
c8230524 40typedef struct config_item config_item;
7f77ea24 41typedef struct midend_data midend_data;
42typedef struct random_state random_state;
43typedef struct game_params game_params;
44typedef struct game_state game_state;
74a4e547 45typedef struct game_ui game_ui;
2ef96bd6 46typedef struct game_drawstate game_drawstate;
7f77ea24 47
4efb3868 48#define ALIGN_VNORMAL 0x000
49#define ALIGN_VCENTRE 0x100
50
51#define ALIGN_HLEFT 0x000
52#define ALIGN_HCENTRE 0x001
53#define ALIGN_HRIGHT 0x002
54
55#define FONT_FIXED 0
56#define FONT_VARIABLE 1
57
720a8fb7 58/*
c8230524 59 * Structure used to pass configuration data between frontend and
60 * game
61 */
95709966 62enum { C_STRING, C_CHOICES, C_BOOLEAN, C_END };
c8230524 63struct config_item {
64 /*
65 * `name' is never dynamically allocated.
66 */
67 char *name;
68 /*
69 * `type' contains one of the above values.
70 */
71 int type;
72 /*
95709966 73 * For C_STRING, `sval' is always dynamically allocated and
74 * non-NULL. For C_BOOLEAN and C_END, `sval' is always NULL.
75 * For C_CHOICES, `sval' is non-NULL, _not_ dynamically
76 * allocated, and contains a set of option strings separated by
77 * a delimiter. The delimeter is also the first character in
78 * the string, so for example ":Foo:Bar:Baz" gives three
79 * options `Foo', `Bar' and `Baz'.
c8230524 80 */
81 char *sval;
82 /*
95709966 83 * For C_BOOLEAN, this is TRUE or FALSE. For C_CHOICES, it
c8230524 84 * indicates the chosen index from the `sval' list. In the
85 * above example, 0==Foo, 1==Bar and 2==Baz.
86 */
87 int ival;
88};
89
90/*
720a8fb7 91 * Platform routines
92 */
93void fatal(char *fmt, ...);
2ef96bd6 94void frontend_default_colour(frontend *fe, float *output);
4efb3868 95void draw_text(frontend *fe, int x, int y, int fonttype, int fontsize,
96 int align, int colour, char *text);
2ef96bd6 97void draw_rect(frontend *fe, int x, int y, int w, int h, int colour);
98void draw_line(frontend *fe, int x1, int y1, int x2, int y2, int colour);
99void draw_polygon(frontend *fe, int *coords, int npoints,
100 int fill, int colour);
4efb3868 101void clip(frontend *fe, int x, int y, int w, int h);
102void unclip(frontend *fe);
2ef96bd6 103void start_draw(frontend *fe);
104void draw_update(frontend *fe, int x, int y, int w, int h);
105void end_draw(frontend *fe);
106void deactivate_timer(frontend *fe);
107void activate_timer(frontend *fe);
fd1a1a2b 108void status_bar(frontend *fe, char *text);
720a8fb7 109
110/*
7f77ea24 111 * midend.c
112 */
48d70ca9 113midend_data *midend_new(frontend *fe, void *randseed, int randseedsize);
7f77ea24 114void midend_free(midend_data *me);
115void midend_set_params(midend_data *me, game_params *params);
116void midend_size(midend_data *me, int *x, int *y);
5928817c 117void midend_new_game(midend_data *me);
7f77ea24 118void midend_restart_game(midend_data *me);
7f77ea24 119int midend_process_key(midend_data *me, int x, int y, int button);
2ef96bd6 120void midend_redraw(midend_data *me);
121float *midend_colours(midend_data *me, int *ncolours);
122void midend_timer(midend_data *me, float tplus);
eb2ad6f1 123int midend_num_presets(midend_data *me);
124void midend_fetch_preset(midend_data *me, int n,
125 char **name, game_params **params);
fd1a1a2b 126int midend_wants_statusbar(midend_data *me);
5928817c 127enum { CFG_SETTINGS, CFG_SEED };
128config_item *midend_get_config(midend_data *me, int which, char **wintitle);
129char *midend_set_config(midend_data *me, int which, config_item *cfg);
8b7938e7 130char *midend_game_id(midend_data *me, char *id, int def_seed);
7f77ea24 131
132/*
720a8fb7 133 * malloc.c
134 */
135void *smalloc(int size);
136void *srealloc(void *p, int size);
137void sfree(void *p);
ab30d7be 138char *dupstr(const char *s);
720a8fb7 139#define snew(type) \
140 ( (type *) smalloc (sizeof (type)) )
141#define snewn(number, type) \
142 ( (type *) smalloc ((number) * sizeof (type)) )
143#define sresize(array, number, type) \
7f77ea24 144 ( (type *) srealloc ((array), (number) * sizeof (type)) )
720a8fb7 145
146/*
4efb3868 147 * misc.c
148 */
077f3cbe 149void free_cfg(config_item *cfg);
4efb3868 150
151/*
720a8fb7 152 * random.c
153 */
720a8fb7 154random_state *random_init(char *seed, int len);
48d70ca9 155unsigned long random_bits(random_state *state, int bits);
720a8fb7 156unsigned long random_upto(random_state *state, unsigned long limit);
157void random_free(random_state *state);
158
159/*
160 * Game-specific routines
161 */
0c490335 162extern const char *const game_name;
e91825f8 163extern const char *const game_winhelp_topic;
c8230524 164const int game_can_configure;
7f77ea24 165game_params *default_params(void);
eb2ad6f1 166int game_fetch_preset(int i, char **name, game_params **params);
b0e26073 167game_params *decode_params(char const *string);
168char *encode_params(game_params *);
7f77ea24 169void free_params(game_params *params);
eb2ad6f1 170game_params *dup_params(game_params *params);
c8230524 171config_item *game_configure(game_params *params);
172game_params *custom_params(config_item *cfg);
173char *validate_params(game_params *params);
48d70ca9 174char *new_game_seed(game_params *params, random_state *rs);
5928817c 175char *validate_seed(game_params *params, char *seed);
720a8fb7 176game_state *new_game(game_params *params, char *seed);
177game_state *dup_game(game_state *state);
178void free_game(game_state *state);
74a4e547 179game_ui *new_ui(game_state *state);
180void free_ui(game_ui *ui);
181game_state *make_move(game_state *from, game_ui *ui, int x, int y, int button);
7f77ea24 182void game_size(game_params *params, int *x, int *y);
2ef96bd6 183float *game_colours(frontend *fe, game_state *state, int *ncolours);
184game_drawstate *game_new_drawstate(game_state *state);
185void game_free_drawstate(game_drawstate *ds);
186void game_redraw(frontend *fe, game_drawstate *ds, game_state *oldstate,
c822de4a 187 game_state *newstate, int dir, game_ui *ui, float anim_time,
74a4e547 188 float flash_time);
c822de4a 189float game_anim_length(game_state *oldstate, game_state *newstate, int dir);
190float game_flash_length(game_state *oldstate, game_state *newstate, int dir);
fd1a1a2b 191int game_wants_statusbar(void);
720a8fb7 192
193#endif /* PUZZLES_PUZZLES_H */