git.pond.sub.org Git - empserver/blob - include/file.h

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2008, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  file.h: Describes Empire tables (`files' for historical reasons)
  29  *
  30  *  Known contributors to this file:
  31  *     Markus Armbruster, 2005-2008
  32  */
  33
  34 #ifndef FILE_H
  35 #define FILE_H
  36
  37 #include <time.h>
  38
  39 struct empfile {
  40     /* Members with immutable values */
  41     int uid;                    /* Table ID */
  42     char *name;                 /* Empire name (e.g., "treaty") */
  43     char *file;                 /* file name, relative to gamedir for
  44                                    game state, to builtindir for config */
  45     struct castr *cadef;        /* table column selectors (column meta-data) */
  46     int size;                   /* size of a table entry */
  47     int flags;                  /* only EFF_IMMUTABLE immutable, see below
  48                                    for use of remaining bits */
  49
  50     /* Members whose values are fixed when the cache is mapped */
  51     char *cache;                /* pointer to cache */
  52     int csize;                  /* cache size, in entries */
  53     /* flags bits EFF_MEM, EFF_PRIVATE, EFF_NOTIME also fixed then */
  54
  55     /* Members whose values may vary throughout operation */
  56     int baseid;                 /* id of first entry in cache */
  57     int cids;                   /* # entries in cache */
  58     int fids;                   /* # entries in table */
  59     int fd;                     /* file descriptor, -1 if not open */
  60     /* flags bit EFF_CUSTOM also varies */
  61
  62     /* User callbacks, may all be null */
  63     /*
  64      * Called after read.  ID is the element id, and ELT is the
  65      * element read.  May modify the element.  Modifications are
  66      * visible to caller of ef_read(), but have no effect on the file.
  67      */
  68     void (*postread)(int id, void *elt);
  69     /*
  70      * Called before write.  ID is the element id, and ELT is the
  71      * element being written.  May modify the element.  Modifications
  72      * will be visible to caller of ef_write() and are written to the
  73      * file.
  74      */
  75     void (*prewrite)(int id, void *elt);
  76 };
  77
  78 struct emptypedstr {
  79     short ef_type;
  80     short uid;
  81     unsigned seqno;
  82     time_t timestamp;
  83 };
  84
  85 /*
  86  * Flag bits for struct empfile member flags
  87  * Immutable flags are properties of the table and thus cannot change.
  88  * The remaining flags record how the table is being used.
  89  */
  90 /* Immutable flags, fixed at compile-time */
  91 /* Dereferencing entry address cast to struct emptypedstr * is safe */
  92 #define EFF_TYPED       bit(0)
  93 /*
  94  * EFF_XY / EFF_OWNER / EFF_GROUP assert that coordinates / owner /
  95  * group of such a table's entries can be safely obtained by
  96  * dereferencing the entry's address cast to struct empobj *.
  97  */
  98 #define EFF_XY          bit(1)
  99 #define EFF_OWNER       bit(2)
 100 #define EFF_GROUP       bit(3)
 101 /* Table is allocated statically */
 102 #define EFF_STATIC      bit(4)
 103 /* Table has a sentinel (all zero, not counted as elt), implies EFF_MEM */
 104 #define EFF_SENTINEL    bit(5)
 105 /* All the immutable flags */
 106 #define EFF_IMMUTABLE \
 107     (EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP | EFF_STATIC)
 108 /* Flags set when table contents is mapped */
 109 /* Table is entirely in memory */
 110 #define EFF_MEM         bit(8)
 111 /* Table is privately mapped: changes don't affect the underlying file */
 112 #define EFF_PRIVATE     bit(9)
 113 /* Table is customized (configuration tables only) */
 114 #define EFF_CUSTOM      bit(10)
 115 /* Don't update timestamps */
 116 #define EFF_NOTIME      bit(11)
 117 /* Transient flags, only occur in argument of ef_open() */
 118 /* Create table file, clobbering any existing file */
 119 #define EFF_CREATE      bit(16)
 120
 121 /*
 122  * Empire `file types'
 123  * These are really table IDs.  Some tables are backed by files, some
 124  * are compiled into the server, some initialized from configuration
 125  * files.
 126  */
 127 enum {
 128     /* Error value */
 129     EF_BAD = -1,
 130     /* Dynamic game data tables */
 131     EF_SECTOR,
 132     EF_SHIP,
 133     EF_PLANE,
 134     EF_LAND,
 135     EF_NUKE,
 136     EF_NEWS,
 137     EF_TREATY,
 138     EF_TRADE,
 139     EF_POWER,
 140     EF_NATION,
 141     EF_LOAN,
 142     EF_MAP,
 143     EF_BMAP,
 144     EF_COMM,
 145     EF_LOST,
 146     EF_REALM,
 147     EF_GAME,
 148     EF_DYNMAX = EF_GAME,
 149     /* Static game data (configuration) */
 150     /* Order is relevant; see read_builtin_tables() */
 151     EF_ITEM,
 152     EF_PRODUCT,
 153     EF_SECTOR_CHR,
 154     EF_SHIP_CHR,
 155     EF_PLANE_CHR,
 156     EF_LAND_CHR,
 157     EF_NUKE_CHR,
 158     EF_NEWS_CHR,
 159     EF_INFRASTRUCTURE,
 160     EF_UPDATES,                 /* not actually static */
 161     EF_TABLE,
 162     EF_VERSION,
 163     EF_META,                    /* not really configuration */
 164     /* Symbol tables */
 165     EF_AGREEMENT_STATUS,
 166     EF_LAND_CHR_FLAGS,
 167     EF_LEVEL,
 168     EF_META_FLAGS,
 169     EF_META_TYPE,
 170     EF_MISSIONS,
 171     EF_NATION_FLAGS,
 172     EF_NATION_REJECTS,
 173     EF_NATION_RELATIONS,
 174     EF_NATION_STATUS,
 175     EF_NUKE_CHR_FLAGS,
 176     EF_PACKING,
 177     EF_PAGE_HEADINGS,
 178     EF_PLAGUE_STAGES,
 179     EF_PLANE_CHR_FLAGS,
 180     EF_PLANE_FLAGS,
 181     EF_RESOURCES,
 182     EF_RETREAT_FLAGS,
 183     EF_SECTOR_NAVIGATION,
 184     EF_SHIP_CHR_FLAGS,
 185     EF_TREATY_FLAGS,
 186     /* Views */
 187     EF_COUNTRY,
 188     /* Number of types: */
 189     EF_MAX
 190 };
 191
 192 #define EF_IS_GAME_STATE(type) (EF_SECTOR <= (type) && (type) <= EF_DYNMAX)
 193 #define EF_IS_VIEW(type) (EF_COUNTRY <= (type) && (type) < EF_MAX)
 194
 195 extern struct castr *ef_cadef(int);
 196 extern int ef_read(int, int, void *);
 197 extern void *ef_ptr(int, int);
 198 extern char *ef_nameof(int);
 199 extern time_t ef_mtime(int);
 200 extern int ef_open(int, int, int);
 201 extern int ef_open_view(int, int);
 202 extern int ef_close(int);
 203 extern int ef_flush(int);
 204 extern void ef_blank(int, int, void *);
 205 extern int ef_write(int, int, void *);
 206 extern void ef_set_uid(int, void *, int);
 207 extern int ef_extend(int, int);
 208 extern int ef_ensure_space(int, int, int);
 209 extern int ef_truncate(int, int);
 210 extern int ef_nelem(int);
 211 extern int ef_flags(int);
 212 extern int ef_byname(char *);
 213 extern int ef_byname_from(char *, int *);
 214 extern int ef_verify(void);
 215 extern int ef_elt_byname(int, char *);
 216
 217 extern struct empfile empfile[EF_MAX + 1];
 218 extern void empfile_init(void);
 219 extern void empfile_fixup(void);
 220
 221 #endif