f4a6da2e52
This is the second of a series of changes related to save/restore.
No EDITLEVEL bump has been included, because although the code
is changed extensively by this, the content of the savefiles have
not been changed.
Push the use of the structlevel bwrite() and mread() function use
out of the core and into sfstruct.c. This is groundwork for upcoming
changes.
In the core, replace the bwrite() and mread() calls with the
use of type-specific savefile output (Sfo) and savefile
input (Sfi) macros. The macros are defined in a new header file
savefile.h, which also contains the prototypes for the sfo_* and
sfi_* functions that the macros ultimately expand to. The functions
themselves are in src/sfbase.c.
On C99, each Sfo or Sfi macro expansion refers directly to the
corresponding type-specific sfo_* or sfi_* function.
If C23 or later is is use, the majority (all but 3 types) of the
macros refer to a single _Generic output routine sfo(nhfp, dt, tag),
and a single _Generic input routine sfi(nhfp, dt, tag), which handles
the dispatch of the type-specific underlying functions. This was
somewhat experimental, but turned out to be practical because the
compiler would gripe if the type for a variable was not included in
the _Generic when passed as an argument, so it could be fixed.
This alters the savefile verication process by having a common set
return values for the related functions such as uptodate(),
check_version(), etc. The new return values return more information
about savefile incompatibilities, beyond failure/sucess. The
additional information will be useful for an upcoming addition.
The expanded return values are:
SF_UPTODATE (0) everything matched and looks good
SF_OUTDATED (1) savefile is outdated
SF_CRITICAL_BYTE_COUNT_MISMATCH (2) critical size count mismatch
SF_DM_IL32LLP64_ON_ILP32LL64 (3) Windows x64 savefile on x86
SF_DM_I32LP64_ON_ILP32LL64 (4) Unix 64 savefile on x86
SF_DM_ILP32LL64_ON_I32LP64 (5) x86 savefile on Unix 64
SF_DM_ILP32LL64_ON_IL32LLP64 (6) x86 savefile on Windows x64
SF_DM_I32LP64_ON_IL32LLP64 (7) Unix 64 savefile on Windows x64
SF_DM_IL32LLP64_ON_I32LP64 (8) Windows x64 savefile on Unix 64
SF_DM_MISMATCH (9) some other mismatch
The callers in the core have been adjusted to deal with the expanded
return values.
Other miscellaneous inclusions:
- go.oracle_loc -> svo.oracle_loc.
- add a bit (1UL << 30) to called SFCTOOL_BIT as groundwork
for changes to follow.
87 lines
3.9 KiB
C
87 lines
3.9 KiB
C
/* NetHack 3.7 hacklib.h $NHDT-Date: 1725653010 2024/09/06 20:03:30 $ $NHDT-Branch: NetHack-3.7 $:$NHDT-Revision: 1.0 $ */
|
|
/* Copyright (c) Steve Creps, 1988. */
|
|
/* NetHack may be freely redistributed. See license for details. */
|
|
|
|
#ifndef HACKLIB_H
|
|
#define HACKLIB_H
|
|
|
|
/*
|
|
* hacklib true library functions
|
|
*/
|
|
extern boolean digit(char);
|
|
extern boolean letter(char);
|
|
extern char highc(char);
|
|
extern char lowc(char);
|
|
extern char *lcase(char *) NONNULL NONNULLARG1;
|
|
extern char *ucase(char *) NONNULL NONNULLARG1;
|
|
extern char *upstart(char *); /* ought to be changed to NONNULL NONNULLARG1
|
|
* and the code changed to not allow NULL arg */
|
|
extern char *upwords(char *) NONNULL NONNULLARG1;
|
|
extern char *mungspaces(char *) NONNULL NONNULLARG1;
|
|
extern char *trimspaces(char *) NONNULL NONNULLARG1;
|
|
extern char *strip_newline(char *) NONNULL NONNULLARG1;
|
|
extern char *eos(char *) NONNULL NONNULLARG1;
|
|
extern const char *c_eos(const char *) NONNULL NONNULLARG1;
|
|
extern boolean str_start_is(const char *, const char *, boolean) NONNULLPTRS;
|
|
extern boolean str_end_is(const char *, const char *) NONNULLPTRS;
|
|
extern int str_lines_maxlen(const char *);
|
|
extern char *strkitten(char *, char) NONNULL NONNULLARG1;
|
|
extern void copynchars(char *, const char *, int) NONNULLARG12;
|
|
extern char chrcasecpy(int, int);
|
|
extern char *strcasecpy(char *, const char *) NONNULL NONNULLPTRS;
|
|
extern char *s_suffix(const char *) NONNULL NONNULLARG1;
|
|
extern char *ing_suffix(const char *) NONNULL NONNULLARG1;
|
|
extern char *xcrypt(const char *, char *) NONNULL NONNULLPTRS;
|
|
extern boolean onlyspace(const char *) NONNULLARG1;
|
|
extern char *tabexpand(char *) NONNULL NONNULLARG1;
|
|
extern char *visctrl(char) NONNULL;
|
|
extern char *stripchars(char *, const char *,
|
|
const char *) NONNULL NONNULLPTRS;
|
|
extern char *stripdigits(char *) NONNULL NONNULLARG1;
|
|
extern char *strsubst(char *, const char *, const char *) NONNULL NONNULLPTRS;
|
|
extern int strNsubst(char *, const char *, const char *, int) NONNULLPTRS;
|
|
extern const char *findword(const char *, const char *, int,
|
|
boolean) NONNULLARG2;
|
|
extern const char *ordin(int) NONNULL;
|
|
extern char *sitoa(int) NONNULL;
|
|
extern int sgn(int);
|
|
extern int distmin(coordxy, coordxy, coordxy, coordxy);
|
|
extern int dist2(coordxy, coordxy, coordxy, coordxy);
|
|
extern int isqrt(int);
|
|
extern boolean online2(coordxy, coordxy, coordxy, coordxy);
|
|
#ifndef STRNCMPI
|
|
extern int strncmpi(const char *, const char *, int) NONNULLPTRS;
|
|
#endif
|
|
#ifndef STRSTRI
|
|
extern char *strstri(const char *, const char *) NONNULLPTRS;
|
|
#endif
|
|
#define FITSint(x) FITSint_(x, __func__, __LINE__)
|
|
extern int FITSint_(long long, const char *, int);
|
|
#define FITSuint(x) FITSuint_(x, __func__, __LINE__)
|
|
extern unsigned FITSuint_(unsigned long long, const char *, int);
|
|
extern int case_insensitive_comp(const char *, const char *);
|
|
extern boolean fuzzymatch(const char *, const char *,
|
|
const char *, boolean) NONNULLPTRS;
|
|
extern int swapbits(int, int, int);
|
|
/* note: the snprintf CPP wrapper includes the "fmt" argument in "..."
|
|
(__VA_ARGS__) to allow for zero arguments after fmt */
|
|
extern void nh_snprintf(const char *func, int line, char *str,
|
|
size_t size, const char *fmt, ...) PRINTF_F(5, 6);
|
|
extern void nh_snprintf_w_impossible(const char *func, int line, char *str,
|
|
size_t size, const char *fmt, ...) PRINTF_F(5, 6);
|
|
|
|
#define Snprintf(str, size, ...) \
|
|
nh_snprintf(__func__, __LINE__, str, size, __VA_ARGS__)
|
|
|
|
#if 0
|
|
/*#define Strlen(s) Strlen_(s, __func__, __LINE__)*/
|
|
extern unsigned Strlen_(const char *, const char *, int) NONNULLPTRS;
|
|
#endif
|
|
extern int unicodeval_to_utf8str(int, uint8 *, size_t);
|
|
extern boolean copy_bytes(int, int);
|
|
extern const char *datamodel(void);
|
|
extern const char *what_datamodel_is_this(int, int, int, int, int);
|
|
|
|
#endif /* HACKLIB_H */
|
|
|