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