Giant const patch of doom: add a 'const' to every parameter in every

puzzle backend function which ought to have it, and propagate those
consts through to per-puzzle subroutines as needed.

I've recently had to do that to a few specific parameters which were
being misused by particular puzzles (r9657, r9830), which suggests
that it's probably a good idea to do the whole lot pre-emptively
before the next such problem shows up.

[originally from svn r9832]
[r9657 == 3b250baa02a7332510685948bf17576c397b8ceb]
[r9830 == 0b93de904a98f119b1a95d3a53029f1ed4bfb9b3]
This commit is contained in:
Simon Tatham
2013-04-13 10:37:32 +00:00
parent 339329449f
commit 251b21c418
45 changed files with 1856 additions and 1655 deletions

View File

@ -138,7 +138,7 @@ static void free_params(game_params *params)
sfree(params);
}
static game_params *dup_params(game_params *params)
static game_params *dup_params(const game_params *params)
{
game_params *ret = snew(game_params);
*ret = *params; /* structure copy */
@ -172,7 +172,7 @@ static void decode_params(game_params *ret, char const *string)
}
}
static char *encode_params(game_params *params, int full)
static char *encode_params(const game_params *params, int full)
{
char buf[256];
sprintf(buf, "%dx%d", params->w, params->h);
@ -183,7 +183,7 @@ static char *encode_params(game_params *params, int full)
return dupstr(buf);
}
static config_item *game_configure(game_params *params)
static config_item *game_configure(const game_params *params)
{
config_item *ret;
char buf[64];
@ -220,7 +220,7 @@ static config_item *game_configure(game_params *params)
return ret;
}
static game_params *custom_params(config_item *cfg)
static game_params *custom_params(const config_item *cfg)
{
game_params *ret = snew(game_params);
@ -232,7 +232,7 @@ static game_params *custom_params(config_item *cfg)
return ret;
}
static char *validate_params(game_params *params, int full)
static char *validate_params(const game_params *params, int full)
{
if (params->w < 2) return "Width must be at least one";
if (params->h < 2) return "Height must be at least one";
@ -317,7 +317,7 @@ static game_state *new_state(int w, int h)
return ret;
}
static game_state *dup_game(game_state *src)
static game_state *dup_game(const game_state *src)
{
game_state *dest = snew(game_state);
@ -395,7 +395,8 @@ static int c2n(char c) { /* XXX cloned from singles.c */
return -1;
}
static char *readrow(char *desc, int n, int *array, int off, const char **prob)
static const char *readrow(const char *desc, int n, int *array, int off,
const char **prob)
{
int i, num;
char c;
@ -422,7 +423,7 @@ badchar:
return NULL;
}
static game_state *new_game_int(const game_params *params, char *desc,
static game_state *new_game_int(const game_params *params, const char *desc,
const char **prob)
{
game_state *state = new_state(params->w, params->h);
@ -530,7 +531,7 @@ done:
return state;
}
static char *validate_desc(const game_params *params, char *desc)
static char *validate_desc(const game_params *params, const char *desc)
{
const char *prob;
game_state *st = new_game_int(params, desc, &prob);
@ -539,7 +540,8 @@ static char *validate_desc(const game_params *params, char *desc)
return NULL;
}
static game_state *new_game(midend *me, game_params *params, char *desc)
static game_state *new_game(midend *me, const game_params *params,
const char *desc)
{
const char *prob;
game_state *st = new_game_int(params, desc, &prob);
@ -580,7 +582,7 @@ static char *generate_desc(game_state *new)
return desc;
}
static void game_text_hborder(game_state *state, char **p_r)
static void game_text_hborder(const game_state *state, char **p_r)
{
char *p = *p_r;
int x;
@ -594,12 +596,12 @@ static void game_text_hborder(game_state *state, char **p_r)
*p_r = p;
}
static int game_can_format_as_text_now(game_params *params)
static int game_can_format_as_text_now(const game_params *params)
{
return TRUE;
}
static char *game_text_format(game_state *state)
static char *game_text_format(const game_state *state)
{
int len, x, y, i;
char *ret, *p;
@ -680,7 +682,7 @@ typedef struct rowcol {
const char *name;
} rowcol;
static rowcol mkrowcol(game_state *state, int num, int roworcol)
static rowcol mkrowcol(const game_state *state, int num, int roworcol)
{
rowcol rc;
@ -705,7 +707,8 @@ static rowcol mkrowcol(game_state *state, int num, int roworcol)
return rc;
}
static int count_rowcol(game_state *state, int num, int roworcol, int which)
static int count_rowcol(const game_state *state, int num, int roworcol,
int which)
{
int i, count = 0;
rowcol rc = mkrowcol(state, num, roworcol);
@ -1393,7 +1396,8 @@ static int solve_state(game_state *state, int diff)
}
static char *game_state_diff(game_state *src, game_state *dst, int issolve)
static char *game_state_diff(const game_state *src, const game_state *dst,
int issolve)
{
char *ret = NULL, buf[80], c;
int retlen = 0, x, y, i, k;
@ -1432,7 +1436,7 @@ static char *game_state_diff(game_state *src, game_state *dst, int issolve)
return ret;
}
static void solve_from_aux(game_state *state, char *aux)
static void solve_from_aux(const game_state *state, const char *aux)
{
int i;
assert(strlen(aux) == state->wh);
@ -1442,8 +1446,8 @@ static void solve_from_aux(game_state *state, char *aux)
}
}
static char *solve_game(game_state *state, game_state *currstate,
char *aux, char **error)
static char *solve_game(const game_state *state, const game_state *currstate,
const char *aux, char **error)
{
game_state *solved = dup_game(currstate);
char *move = NULL;
@ -1701,7 +1705,7 @@ struct game_ui {
int cur_x, cur_y, cur_visible;
};
static game_ui *new_ui(game_state *state)
static game_ui *new_ui(const game_state *state)
{
game_ui *ui = snew(game_ui);
ui->cur_x = ui->cur_y = 0;
@ -1714,17 +1718,17 @@ static void free_ui(game_ui *ui)
sfree(ui);
}
static char *encode_ui(game_ui *ui)
static char *encode_ui(const game_ui *ui)
{
return NULL;
}
static void decode_ui(game_ui *ui, char *encoding)
static void decode_ui(game_ui *ui, const char *encoding)
{
}
static void game_changed_state(game_ui *ui, game_state *oldstate,
game_state *newstate)
static void game_changed_state(game_ui *ui, const game_state *oldstate,
const game_state *newstate)
{
if (!oldstate->completed && newstate->completed)
ui->cur_visible = 0;
@ -1755,8 +1759,9 @@ struct game_drawstate {
#define COORD(x) ( (x+1) * TILE_SIZE + BORDER )
#define FROMCOORD(x) ( (x - BORDER) / TILE_SIZE - 1 )
static char *interpret_move(game_state *state, game_ui *ui, const game_drawstate *ds,
int x, int y, int button)
static char *interpret_move(const game_state *state, game_ui *ui,
const game_drawstate *ds,
int x, int y, int button)
{
int gx = FROMCOORD(x), gy = FROMCOORD(y), idx, curr;
char *nullret = NULL, buf[80], movech;
@ -1818,7 +1823,7 @@ static char *interpret_move(game_state *state, game_ui *ui, const game_drawstate
return dupstr(buf);
}
static game_state *execute_move(game_state *state, char *move)
static game_state *execute_move(const game_state *state, const char *move)
{
game_state *ret = dup_game(state);
int x, y, n, idx, idx2;
@ -1878,8 +1883,8 @@ badmove:
* Drawing routines.
*/
static void game_compute_size(game_params *params, int tilesize,
int *x, int *y)
static void game_compute_size(const game_params *params, int tilesize,
int *x, int *y)
{
/* Ick: fake up `ds->tilesize' for macro expansion purposes */
struct { int tilesize; } ads, *ds = &ads;
@ -1890,7 +1895,7 @@ static void game_compute_size(game_params *params, int tilesize,
}
static void game_set_size(drawing *dr, game_drawstate *ds,
game_params *params, int tilesize)
const game_params *params, int tilesize)
{
ds->tilesize = tilesize;
}
@ -1928,7 +1933,7 @@ static float *game_colours(frontend *fe, int *ncolours)
return ret;
}
static game_drawstate *game_new_drawstate(drawing *dr, game_state *state)
static game_drawstate *game_new_drawstate(drawing *dr, const game_state *state)
{
struct game_drawstate *ds = snew(struct game_drawstate);
@ -2128,9 +2133,10 @@ static void draw_tile(drawing *dr, game_drawstate *ds, int *dominoes,
}
static void game_redraw(drawing *dr, game_drawstate *ds, game_state *oldstate,
game_state *state, int dir, game_ui *ui,
float animtime, float flashtime)
static void game_redraw(drawing *dr, game_drawstate *ds,
const game_state *oldstate, const game_state *state,
int dir, const game_ui *ui,
float animtime, float flashtime)
{
int x, y, w = state->w, h = state->h, which, i, j, flash;
unsigned long c = 0;
@ -2219,14 +2225,14 @@ static void game_redraw(drawing *dr, game_drawstate *ds, game_state *oldstate,
ds->started = 1;
}
static float game_anim_length(game_state *oldstate, game_state *newstate,
int dir, game_ui *ui)
static float game_anim_length(const game_state *oldstate,
const game_state *newstate, int dir, game_ui *ui)
{
return 0.0F;
}
static float game_flash_length(game_state *oldstate, game_state *newstate,
int dir, game_ui *ui)
static float game_flash_length(const game_state *oldstate,
const game_state *newstate, int dir, game_ui *ui)
{
if (!oldstate->completed && newstate->completed &&
!oldstate->solved && !newstate->solved)
@ -2234,17 +2240,17 @@ static float game_flash_length(game_state *oldstate, game_state *newstate,
return 0.0F;
}
static int game_status(game_state *state)
static int game_status(const game_state *state)
{
return state->completed ? +1 : 0;
}
static int game_timing_state(game_state *state, game_ui *ui)
static int game_timing_state(const game_state *state, game_ui *ui)
{
return TRUE;
}
static void game_print_size(game_params *params, float *x, float *y)
static void game_print_size(const game_params *params, float *x, float *y)
{
int pw, ph;
@ -2256,7 +2262,7 @@ static void game_print_size(game_params *params, float *x, float *y)
*y = ph / 100.0F;
}
static void game_print(drawing *dr, game_state *state, int tilesize)
static void game_print(drawing *dr, const game_state *state, int tilesize)
{
int w = state->w, h = state->h;
int ink = print_mono_colour(dr, 0);