Document the mouse control method for Cube.

[sgt/puzzles] / puzzles.h

diff --git a/puzzles.h b/puzzles.h
index 63de880..7b35896 100644 (file)
--- a/puzzles.h
+++ b/puzzles.h
@@ -12,6 +12,8 @@
 #define FALSE 0
 #endif
 
+#define PI 3.141592653589793238462643383279502884197169399
+
 #define lenof(array) ( sizeof(array) / sizeof(*(array)) )
 
 #define STR_INT(x) #x
@@ -32,7 +34,10 @@ enum {
     CURSOR_LEFT,
     CURSOR_RIGHT,
     
-    MOD_NUM_KEYPAD = 0x40000000
+    MOD_CTRL       = 0x10000000,
+    MOD_SHFT       = 0x20000000,
+    MOD_NUM_KEYPAD = 0x40000000,
+    MOD_MASK       = 0x70000000 /* mask for all modifiers */
 };
 
 #define IS_MOUSE_DOWN(m) ( (unsigned)((m) - LEFT_BUTTON) <= \
@@ -128,6 +133,7 @@ void midend_size(midend_data *me, int *x, int *y);
 void midend_new_game(midend_data *me);
 void midend_restart_game(midend_data *me);
 int midend_process_key(midend_data *me, int x, int y, int button);
+void midend_force_redraw(midend_data *me);
 void midend_redraw(midend_data *me);
 float *midend_colours(midend_data *me, int *ncolours);
 void midend_timer(midend_data *me, float tplus);
@@ -135,12 +141,14 @@ int midend_num_presets(midend_data *me);
 void midend_fetch_preset(midend_data *me, int n,
                          char **name, game_params **params);
 int midend_wants_statusbar(midend_data *me);
-enum { CFG_SETTINGS, CFG_SEED };
+enum { CFG_SETTINGS, CFG_SEED, CFG_DESC };
 config_item *midend_get_config(midend_data *me, int which, char **wintitle);
 char *midend_set_config(midend_data *me, int which, config_item *cfg);
-char *midend_game_id(midend_data *me, char *id, int def_seed);
+char *midend_game_id(midend_data *me, char *id);
 char *midend_text_format(midend_data *me);
 char *midend_solve(midend_data *me);
+void midend_supersede_game_desc(midend_data *me, char *desc);
+char *midend_rewrite_statusbar(midend_data *me, char *text);
 
 /*
  * malloc.c
@@ -173,6 +181,20 @@ random_state *random_init(char *seed, int len);
 unsigned long random_bits(random_state *state, int bits);
 unsigned long random_upto(random_state *state, unsigned long limit);
 void random_free(random_state *state);
+char *random_state_encode(random_state *state);
+random_state *random_state_decode(char *input);
+/* random.c also exports SHA, which occasionally comes in useful. */
+typedef unsigned long uint32;
+typedef struct {
+    uint32 h[5];
+    unsigned char block[64];
+    int blkused;
+    uint32 lenhi, lenlo;
+} SHA_State;
+void SHA_Init(SHA_State *s);
+void SHA_Bytes(SHA_State *s, void *p, int len);
+void SHA_Final(SHA_State *s, unsigned char *output);
+void SHA_Simple(void *p, int len, unsigned char *output);
 
 /*
  * Data structure containing the function calls and data specific
@@ -186,19 +208,19 @@ struct game {
     const char *winhelp_topic;
     game_params *(*default_params)(void);
     int (*fetch_preset)(int i, char **name, game_params **params);
-    game_params *(*decode_params)(char const *string);
-    char *(*encode_params)(game_params *);
+    void (*decode_params)(game_params *, char const *string);
+    char *(*encode_params)(game_params *, int full);
     void (*free_params)(game_params *params);
     game_params *(*dup_params)(game_params *params);
     int can_configure;
     config_item *(*configure)(game_params *params);
     game_params *(*custom_params)(config_item *cfg);
     char *(*validate_params)(game_params *params);
-    char *(*new_seed)(game_params *params, random_state *rs,
-                     game_aux_info **aux);
+    char *(*new_desc)(game_params *params, random_state *rs,
+                     game_aux_info **aux, int interactive);
     void (*free_aux_info)(game_aux_info *aux);
-    char *(*validate_seed)(game_params *params, char *seed);
-    game_state *(*new_game)(game_params *params, char *seed);
+    char *(*validate_desc)(game_params *params, char *desc);
+    game_state *(*new_game)(midend_data *me, game_params *params, char *desc);
     game_state *(*dup_game)(game_state *state);
     void (*free_game)(game_state *state);
     int can_solve;
@@ -207,8 +229,8 @@ struct game {
     char *(*text_format)(game_state *state);
     game_ui *(*new_ui)(game_state *state);
     void (*free_ui)(game_ui *ui);
-    game_state *(*make_move)(game_state *from, game_ui *ui, int x, int y,
-                            int button);
+    game_state *(*make_move)(game_state *from, game_ui *ui, game_drawstate *ds,
+                             int x, int y, int button);
     void (*size)(game_params *params, int *x, int *y);
     float *(*colours)(frontend *fe, game_state *state, int *ncolours);
     game_drawstate *(*new_drawstate)(game_state *state);
@@ -216,9 +238,13 @@ struct game {
     void (*redraw)(frontend *fe, game_drawstate *ds, game_state *oldstate,
                   game_state *newstate, int dir, game_ui *ui, float anim_time,
                   float flash_time);
-    float (*anim_length)(game_state *oldstate, game_state *newstate, int dir);
-    float (*flash_length)(game_state *oldstate, game_state *newstate, int dir);
+    float (*anim_length)(game_state *oldstate, game_state *newstate, int dir,
+                        game_ui *ui);
+    float (*flash_length)(game_state *oldstate, game_state *newstate, int dir,
+                         game_ui *ui);
     int (*wants_statusbar)(void);
+    int is_timed;
+    int (*timing_state)(game_state *state);
 };
 
 /*