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-2009, 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 element initialization.  ELT is the element.
  65      */
  66     void (*oninit)(void *elt);
  67     /*
  68      * Called after read.  ID is the element id, and ELT is the
  69      * element read.  May modify the element.  Modifications are
  70      * visible to caller of ef_read(), but have no effect on the file.
  71      */
  72     void (*postread)(int id, void *elt);
  73     /*
  74      * Called before write.  ID is the element id, OLD is the element
  75      * being updated (null unless it is cached) and ELT is the element
  76      * being written.  May modify the element.  Modifications will be
  77      * visible to caller of ef_write() and are written to the file.
  78      */
  79     void (*prewrite)(int id, void *old, void *elt);
  80     /*
  81      * Called after table size changed, with file type as argument.
  82      * Return -1 and set errno to make the operation fail.
  83      */
  84     int (*onresize)(int type);
  85 };
  86
  87 struct emptypedstr {
  88     signed ef_type: 8;
  89     unsigned seqno: 12;
  90     unsigned generation: 12;
  91     int uid;
  92     time_t timestamp;
  93 };
  94
  95 /*
  96  * Flag bits for struct empfile member flags
  97  * Immutable flags are properties of the table and thus cannot change.
  98  * The remaining flags record how the table is being used.
  99  */
 100 /* Immutable flags, fixed at compile-time */
 101 /* Dereferencing entry address cast to struct emptypedstr * is safe */
 102 #define EFF_TYPED       bit(0)
 103 /*
 104  * EFF_XY / EFF_OWNER / EFF_GROUP assert that coordinates / owner /
 105  * group of such a table's entries can be safely obtained by
 106  * dereferencing the entry's address cast to struct empobj *.
 107  */
 108 #define EFF_XY          bit(1)
 109 #define EFF_OWNER       bit(2)
 110 #define EFF_GROUP       bit(3)
 111 /* Table is allocated statically */
 112 #define EFF_STATIC      bit(4)
 113 /* Table has a sentinel (all zero, not counted as elt), implies EFF_MEM */
 114 #define EFF_SENTINEL    bit(5)
 115 /* All the immutable flags */
 116 #define EFF_IMMUTABLE \
 117     (EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP | EFF_STATIC)
 118 /* Flags set when table contents is mapped */
 119 /* Table is entirely in memory */
 120 #define EFF_MEM         bit(8)
 121 /* Table is privately mapped: changes don't affect the underlying file */
 122 #define EFF_PRIVATE     bit(9)
 123 /* Table is customized (configuration tables only) */
 124 #define EFF_CUSTOM      bit(10)
 125 /* Don't update timestamps */
 126 #define EFF_NOTIME      bit(11)
 127 /* Transient flags, only occur in argument of ef_open() */
 128 /* Create table file, clobbering any existing file */
 129 #define EFF_CREATE      bit(16)
 130
 131 /*
 132  * Empire `file types'
 133  * These are really table IDs.  Some tables are backed by files, some
 134  * are compiled into the server, some initialized from configuration
 135  * files.
 136  */
 137 enum {
 138     /* Error value */
 139     EF_BAD = -1,
 140     /* Dynamic game data tables */
 141     EF_SECTOR,
 142     EF_SHIP,
 143     EF_PLANE,
 144     EF_LAND,
 145     EF_NUKE,
 146     EF_NEWS,
 147     EF_TREATY,
 148     EF_TRADE,
 149     EF_POWER,
 150     EF_NATION,
 151     EF_LOAN,
 152     EF_MAP,
 153     EF_BMAP,
 154     EF_COMM,
 155     EF_LOST,
 156     EF_REALM,
 157     EF_GAME,
 158     EF_DYNMAX = EF_GAME,
 159     /* Static game data (configuration) */
 160     /* Order is relevant; see read_builtin_tables() */
 161     EF_ITEM,
 162     EF_PRODUCT,
 163     EF_SECTOR_CHR,
 164     EF_SHIP_CHR,
 165     EF_PLANE_CHR,
 166     EF_LAND_CHR,
 167     EF_NUKE_CHR,
 168     EF_NEWS_CHR,
 169     EF_INFRASTRUCTURE,
 170     EF_UPDATES,                 /* not actually static */
 171     EF_TABLE,
 172     EF_VERSION,
 173     EF_META,                    /* not really configuration */
 174     /* Symbol tables */
 175     EF_AGREEMENT_STATUS,
 176     EF_LAND_CHR_FLAGS,
 177     EF_LEVEL,
 178     EF_META_FLAGS,
 179     EF_META_TYPE,
 180     EF_MISSIONS,
 181     EF_NATION_FLAGS,
 182     EF_NATION_REJECTS,
 183     EF_NATION_RELATIONS,
 184     EF_NATION_STATUS,
 185     EF_NUKE_CHR_FLAGS,
 186     EF_PACKING,
 187     EF_PAGE_HEADINGS,
 188     EF_PLAGUE_STAGES,
 189     EF_PLANE_CHR_FLAGS,
 190     EF_PLANE_FLAGS,
 191     EF_RESOURCES,
 192     EF_RETREAT_FLAGS,
 193     EF_SECTOR_NAVIGATION,
 194     EF_SHIP_CHR_FLAGS,
 195     EF_TREATY_FLAGS,
 196     /* Views */
 197     EF_COUNTRY,
 198     /* Number of types: */
 199     EF_MAX
 200 };
 201
 202 #define EF_IS_GAME_STATE(type) (EF_SECTOR <= (type) && (type) <= EF_DYNMAX)
 203 #define EF_IS_VIEW(type) (EF_COUNTRY <= (type) && (type) < EF_MAX)
 204
 205 extern struct castr *ef_cadef(int);
 206 extern int ef_read(int, int, void *);
 207 extern void ef_make_stale(void);
 208 extern void ef_mark_fresh(int, void *);
 209 extern void *ef_ptr(int, int);
 210 extern char *ef_nameof(int);
 211 extern time_t ef_mtime(int);
 212 extern int ef_open(int, int, int);
 213 extern int ef_open_view(int, int);
 214 extern int ef_close(int);
 215 extern int ef_flush(int);
 216 extern void ef_blank(int, int, void *);
 217 extern int ef_write(int, int, void *);
 218 extern void ef_set_uid(int, void *, int);
 219 extern int ef_extend(int, int);
 220 extern int ef_ensure_space(int, int, int);
 221 extern int ef_truncate(int, int);
 222 extern int ef_nelem(int);
 223 extern int ef_flags(int);
 224 extern int ef_byname(char *);
 225 extern int ef_byname_from(char *, int *);
 226 extern int ef_verify(void);
 227 extern int ef_elt_byname(int, char *);
 228
 229 extern struct empfile empfile[EF_MAX + 1];
 230 extern void empfile_init(void);
 231 extern void empfile_fixup(void);
 232
 233 #endif