nethack-gwaa-kiwi/nethack
1
0
Fork 0
Code Pull Requests Activity
Files
63a78edcfa50062980dd8cd4c3fba1c7ba2efe84
nethack/include/sfprocs.h
nhmall a654d08c3b save/restore changes - part 3 
This is the third of a series of savefile-related changes.

    This adds early-days experimental support for a completely optional
    'sfctool' utility (savefile conversion tool), to be able to export
    a savefile's contents into a more portable format. There are likely
    to be bugs at this stage. In this initial first-attempt, the export
    format is a very simple ascii output.

    NetHack can be built entirely, without also building this tool.
    NetHack has no dependencies on the tool.

    Attempts were made to minimize duplication of existing NetHack code.
    To achieve that, unfortunately, #ifdef SFCTOOL and #ifndef SFCTOOL
    had to be sprinkled around through some of the existing NetHack
    source code, so that it could be re-used for building the utility.

    The process for building the sfctool typically recompiles the source
    files with #define SFCTOOL and a distinct object file with SF- is
    produced.

sfctool notes:

    Universal ctags is used and required to produce the sfctool utility.

    Some targets were added to the Unix and Windows Makefiles to
    facilitate the build process.

         make sfctool

    That should build a copy in util.

    Note: At present, the Unix Makefiles do not copy sfctool over to the
          NetHack playground during 'make install' or 'make update'.
          Until that gets resolved by someone, The tool will
          have to be manually copied there by the builder/admin if
          desired.
          cp util/sfctool ~/nh/install/games/lib/nethackdir/sfctool

    Also, a separate Visual Studio sfctool.sln solution was written and
    placed in sys/windows/vs. That has has only very limited testing.

    Usage:

      i)  To convert an existing savefile to an exportascii format
          that co-resides with the savefile:

          sfctool -c savefile

          That *must* be executed on the same platform / architecture /
          data model that produced the save file in the first place.

     ii)  To unconvert an existing exportascii format export file to a
          historical format savefile that can then be used by NetHack:

          sfctool -u savefile

          That must be executed on the same target platform / architecture /
          data model that was used to build the NetHack that will
          utilize the save file that results.

     A Windows example:

          sfctool -c Fred.NetHack-saved-game

          That should result in creation of Fred.NetHack-saved-game.exportascii
          from existing savefile:
              %USERPROFILE%\AppData\Local\NetHack\3.7\Fred.NetHack-saved-game

     A Unix example:

          sfctool -c 1000wizard

          That should result in creation of 1000wizard.exportascii.gz
          from existing savefile in the playground save directory:
              1000wizard.gz

  Current Mechanics:
     1. Makefile recipe, or script uses universal ctags to produce
        util/sf.tags.

     2. util/sftags is built and executed to read util/sf.tags and
        generate: include/sfproto.h and src/sfdata.c.

     3. util/sfctool is built from the following:
        generated file compiled with -DSFCTOOL:
                    src/sfdata.c       -> sfdata.o
        existing files compiled with -DSFCTOOL:
                    util/sfctool.c     -> sfctool.o
                    util/sfexpasc.c    -> sfexpasc.o
                    src/alloc.c        -> sf-alloc.o
                    src/monst.c        -> sf-monst.o
                    src/objects.c      -> sf-objects.o
                    src/sfbase.c       -> sfbase.o
                    src/sfstruct.c     -> sfstruct.o
                    src/nhlua.c        -> sf-nhlua.o
                    util/panic.c       -> panic.o
                    src/date.c         -> sf-date.o
                    src/decl.c         -> sf-decl.o
                    src/artifact.c     -> sf-artifact.o
                    src/dungeon.c      -> sf-dungeon.o
                    src/end.c          -> sf-end.o
                    src/engrave.c      -> sf-engrave.o
                    src/cfgfiles.c     -> sf-cfgfiles.o
                    src/files.c        -> sf-files.o
                    src/light.c        -> sf-light.o
                    src/mdlib.c        -> sf-mdlib.o
                    src/mkmaze.c       -> sf-mkmaze.o
                    src/mkroom.c       -> sf-mkroom.o
                    src/o_init.c       -> sf-o_init.o
                    src/region.c       -> sf-region.o
                    src/restore.c      -> sf-restore.o
                    src/rumors.c       -> sf-rumors.o
                    src/sys.c          -> sf-sys.o
                    src/timeout.c      -> sf-timeout.o
                    src/track.c        -> sf-track.o
                    src/version.c      -> sf-version.o
                    src/worm.c         -> sf-worm.o
                    src/strutil.c      -> strutil.o
2025-05-25 20:38:17 -04:00

203 lines
6.2 KiB
C
Raw Blame History

/* NetHack 3.6 sfprocs.h Tue Nov 6 19:38:48 2018 */
/* Copyright (c) NetHack Development Team 2025. */
/* NetHack may be freely redistributed. See license for details. */
#ifndef SFPROCS_H
#define SFPROCS_H
#define NHTYPE_SIMPLE 1
#define NHTYPE_COMPLEX 2
#define SF_PROTO(dtyp) \
extern void sfo_##dtyp(NHFILE *, dtyp *, const char *); \
extern void sfi_##dtyp(NHFILE *, dtyp *, const char *); \
extern void sfo_x_##dtyp(NHFILE *, dtyp *, const char *); \
extern void sfi_x_##dtyp(NHFILE *, dtyp *, const char *)
#define SF_PROTO_C(keyw, dtyp) \
extern void sfo_##dtyp(NHFILE *, keyw dtyp *, const char *); \
extern void sfi_##dtyp(NHFILE *, keyw dtyp *, const char *); \
extern void sfo_x_##dtyp(NHFILE *, keyw dtyp *, const char *); \
extern void sfi_x_##dtyp(NHFILE *, keyw dtyp *, const char *)
#define SF_PROTO_X(xxx, dtyp) \
extern void sfo_##dtyp(NHFILE *, xxx *, const char *, int bfsz); \
extern void sfi_##dtyp(NHFILE *, xxx *, const char *, int bfsz); \
extern void sfo_x_##dtyp(NHFILE *, xxx *, const char *, int bfsz); \
extern void sfi_x_##dtyp(NHFILE *, xxx *, const char *, int bfsz)
SF_PROTO_C(struct, arti_info);
SF_PROTO_C(struct, nhrect);
SF_PROTO_C(struct, branch);
SF_PROTO_C(struct, bubble);
SF_PROTO_C(struct, cemetery);
SF_PROTO_C(struct, context_info);
SF_PROTO_C(struct, nhcoord);
SF_PROTO_C(struct, damage);
SF_PROTO_C(struct, dest_area);
SF_PROTO_C(struct, dgn_topology);
SF_PROTO_C(struct, dungeon);
SF_PROTO_C(struct, d_level);
SF_PROTO_C(struct, ebones);
SF_PROTO_C(struct, edog);
SF_PROTO_C(struct, egd);
SF_PROTO_C(struct, emin);
SF_PROTO_C(struct, engr);
SF_PROTO_C(struct, epri);
SF_PROTO_C(struct, eshk);
SF_PROTO_C(struct, fe);
SF_PROTO_C(struct, flag);
SF_PROTO_C(struct, fruit);
SF_PROTO_C(struct, gamelog_line);
SF_PROTO_C(struct, kinfo);
SF_PROTO_C(struct, levelflags);
SF_PROTO_C(struct, ls_t);
SF_PROTO_C(struct, linfo);
SF_PROTO_C(struct, mapseen_feat);
SF_PROTO_C(struct, mapseen_flags);
SF_PROTO_C(struct, mapseen_rooms);
SF_PROTO_C(struct, mkroom);
SF_PROTO_C(struct, monst);
SF_PROTO_C(struct, mvitals);
SF_PROTO_C(struct, obj);
SF_PROTO_C(struct, objclass);
SF_PROTO_C(struct, q_score);
SF_PROTO_C(struct, rm);
SF_PROTO_C(struct, spell);
SF_PROTO_C(struct, stairway);
SF_PROTO_C(struct, s_level);
SF_PROTO_C(struct, trap);
SF_PROTO_C(struct, version_info);
SF_PROTO_C(struct, you);
SF_PROTO_C(union, any);
SF_PROTO(int16);
SF_PROTO(int32);
SF_PROTO(int64);
SF_PROTO(uchar);
SF_PROTO(uint16);
SF_PROTO(uint32);
SF_PROTO(uint64);
SF_PROTO(long);
SF_PROTO(ulong);
SF_PROTO(xint8);
SF_PROTO(boolean);
SF_PROTO(schar);
SF_PROTO(aligntyp);
SF_PROTO(genericptr);
SF_PROTO(size_t);
SF_PROTO(time_t);
SF_PROTO(int);
SF_PROTO(unsigned);
SF_PROTO(coordxy);
SF_PROTO(short);
SF_PROTO(xint16);
SF_PROTO(ushort);
SF_PROTO_X(uint8_t, bitfield);
SF_PROTO_X(char, char);
#undef SF_PROTO
#undef SF_PROTO_C
#undef SF_PROTO_X
#define SF_ENTRY(dtyp) \
void (*sf_##dtyp)(NHFILE *, dtyp *, const char *)
#define SF_ENTRY_C(keyw, dtyp) \
void (*sf_##dtyp)(NHFILE *, keyw dtyp *, const char *)
#define SF_ENTRY_X(xxx, dtyp) \
void (*sf_##dtyp)(NHFILE *, xxx *, const char *, int bfsz)
struct sf_procs {
SF_ENTRY_C(struct, arti_info);
SF_ENTRY_C(struct, nhrect);
SF_ENTRY_C(struct, branch);
SF_ENTRY_C(struct, bubble);
SF_ENTRY_C(struct, cemetery);
SF_ENTRY_C(struct, context_info);
SF_ENTRY_C(struct, nhcoord);
SF_ENTRY_C(struct, damage);
SF_ENTRY_C(struct, dest_area);
SF_ENTRY_C(struct, dgn_topology);
SF_ENTRY_C(struct, dungeon);
SF_ENTRY_C(struct, d_level);
SF_ENTRY_C(struct, ebones);
SF_ENTRY_C(struct, edog);
SF_ENTRY_C(struct, egd);
SF_ENTRY_C(struct, emin);
SF_ENTRY_C(struct, engr);
SF_ENTRY_C(struct, epri);
SF_ENTRY_C(struct, eshk);
SF_ENTRY_C(struct, fe);
SF_ENTRY_C(struct, flag);
SF_ENTRY_C(struct, fruit);
SF_ENTRY_C(struct, gamelog_line);
SF_ENTRY_C(struct, kinfo);
SF_ENTRY_C(struct, levelflags);
SF_ENTRY_C(struct, ls_t);
SF_ENTRY_C(struct, linfo);
SF_ENTRY_C(struct, mapseen_feat);
SF_ENTRY_C(struct, mapseen_flags);
SF_ENTRY_C(struct, mapseen_rooms);
SF_ENTRY_C(struct, mkroom);
SF_ENTRY_C(struct, monst);
SF_ENTRY_C(struct, mvitals);
SF_ENTRY_C(struct, obj);
SF_ENTRY_C(struct, objclass);
SF_ENTRY_C(struct, q_score);
SF_ENTRY_C(struct, rm);
SF_ENTRY_C(struct, spell);
SF_ENTRY_C(struct, stairway);
SF_ENTRY_C(struct, s_level);
SF_ENTRY_C(struct, trap);
SF_ENTRY_C(struct, version_info);
SF_ENTRY_C(struct, you);
SF_ENTRY_C(union, any);
SF_ENTRY(aligntyp);
SF_ENTRY(boolean);
SF_ENTRY(coordxy);
SF_ENTRY(genericptr);
SF_ENTRY(int);
SF_ENTRY(int16);
SF_ENTRY(int32);
SF_ENTRY(int64);
SF_ENTRY(long);
SF_ENTRY(schar);
SF_ENTRY(short);
SF_ENTRY(size_t);
SF_ENTRY(time_t);
SF_ENTRY(uchar);
SF_ENTRY(uint16);
SF_ENTRY(uint32);
SF_ENTRY(uint64);
SF_ENTRY(ulong);
SF_ENTRY(unsigned);
SF_ENTRY(ushort);
SF_ENTRY(xint16);
SF_ENTRY(xint8);
SF_ENTRY_X(char, char);
SF_ENTRY_X(uint8_t, bitfield);
};
#undef SF_ENTRY
#undef SF_ENTRY_C
#undef SF_ENTRY_X
struct sf_structlevel_procs {
const char *ext;
struct sf_procs fn; /* called for structlevel (historical) */
};
struct sf_fieldlevel_procs {
const char *ext;
struct sf_procs fn_x; /* called for fieldlevel */
};
extern struct sf_structlevel_procs sfoprocs[NUM_SAVEFORMATS], sfiprocs[NUM_SAVEFORMATS];
extern void sf_setprocs(int, struct sf_structlevel_procs *, struct sf_structlevel_procs *);
extern void sf_setflprocs(int, struct sf_fieldlevel_procs *, struct sf_fieldlevel_procs *);
extern struct sf_structlevel_procs sfoprocs[NUM_SAVEFORMATS], sfiprocs[NUM_SAVEFORMATS];
extern struct sf_fieldlevel_procs sfoflprocs[NUM_SAVEFORMATS], sfiflprocs[NUM_SAVEFORMATS];
extern struct sf_structlevel_procs historical_sfo_procs;
extern struct sf_structlevel_procs historical_sfi_procs;
extern struct sf_fieldlevel_procs exportascii_sfo_procs;
extern struct sf_fieldlevel_procs exportascii_sfi_procs;
#endif /* SFPROCS_H */
View Git Blame Copy Permalink