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-2005, 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 the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
  23  *  related information and legal notices. It is expected that any future
  24  *  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
  32  */
  33
  34 #ifndef _FILE_H_
  35 #define _FILE_H_
  36
  37 #include <stddef.h>
  38
  39 struct empfile {
  40     int ef_uid;                 /* Table ID */
  41     char *name;                 /* Empire name (e.g., "treaty") */
  42     char *file;                 /* if backed by file, file name relative to
  43                                    data directory */
  44     int flags;                  /* EFF_XY, ... */
  45     int size;                   /* size of a table entry */
  46     void (*init)(int, char *);  /* called after entry creation, unless null */
  47     int (*postread)(int, char *); /* called after read, unless null */
  48     int (*prewrite)(int, char *); /* called before write, unless null */
  49     int fd;                     /* file descriptor, -1 if not open */
  50     int baseid;                 /* id of first entry in cache */
  51     int cids;                   /* # entries in cache */
  52     int csize;                  /* cache size, in entries */
  53     char *cache;                /* pointer to cache */
  54     int fids;                   /* # entries in table */
  55     struct castr *cadef;        /* table column selectors (column meta-data) */
  56 };
  57
  58 /*
  59  * struct empfile flags
  60  */
  61 /*
  62  * EFF_XY / EFF_OWNER / EFF_GROUP assert that coordinates / owner /
  63  * group of such a table's entries can be safely obtained by
  64  * dereferencing entry address cast to struct genitem *.
  65  */
  66 #define EFF_XY          bit(0)
  67 #define EFF_OWNER       bit(1)
  68 #define EFF_GROUP       bit(2)
  69 /* Table is entirely in memory */
  70 #define EFF_MEM         bit(3)
  71 /* Table is read-only */
  72 #define EFF_RDONLY      bit(4)
  73 /* Create table file, clobbering any existing file */
  74 #define EFF_CREATE      bit(5)
  75 /* Table is allocated statically */
  76 #define EFF_STATIC      bit(6)
  77
  78 /* Flags that may be passed to ef_open() */
  79 #define EFF_OPEN        (EFF_MEM | EFF_RDONLY | EFF_CREATE)
  80
  81 /*
  82  * Empire `file types'
  83  * These are really table IDs.  Some tables are backed by files, some
  84  * are compiled into the server.
  85  * Historically, only table IDs 0..EF_MAX-1 existed.  All the
  86  * functions operating on table IDs still reject the new indexes >=
  87  * EF_MAX.  This needs to be rectified, carefully checking existing
  88  * code, which could rely on unspoken assumptions about these tables.
  89  */
  90 /* Error value */
  91 #define EF_BAD          -1
  92 /* Dynamic game data tables: 0..EF_MAX-1 */
  93 #define EF_SECTOR       0
  94 #define EF_SHIP         1
  95 #define EF_PLANE        2
  96 #define EF_LAND         3
  97 #define EF_NUKE         4
  98 #define EF_NEWS         5
  99 #define EF_TREATY       6
 100 #define EF_TRADE        7
 101 #define EF_POWER        8
 102 #define EF_NATION       9
 103 #define EF_LOAN         10
 104 #define EF_MAP          11
 105 #define EF_BMAP         12
 106 #define EF_COMM         13
 107 #define EF_LOST         14
 108 #define EF_MAX          15
 109 /* Static game data (configuration): EF_MAX.. */
 110 #define EF_SECTOR_CHR   15
 111 #define EF_SHIP_CHR     16
 112 #define EF_PLANE_CHR    17
 113 #define EF_LAND_CHR     18
 114 #define EF_NUKE_CHR     19
 115 #if 0 /* doesn't exist yet */
 116 #define EF_NEWS_CHR
 117 #endif
 118 #define EF_TREATY_CHR   20
 119 #define EF_ITEM         21
 120 #define EF_INFRASTRUCTURE   22
 121 #define EF_PRODUCT      23
 122 #define EF_TABLE        24
 123 #define EF_SHIP_CHR_FLAGS       25
 124 #define EF_PLANE_CHR_FLAGS      26
 125 #define EF_LAND_CHR_FLAGS       27
 126 #define EF_NUKE_CHR_FLAGS       28
 127
 128 struct fileinit {
 129     int ef_type;
 130     void (*init) (int, char *);
 131     int (*postread) (int, char *);
 132     int (*prewrite) (int, char *);
 133 };
 134
 135 extern struct castr *ef_cadef(int);
 136 extern int ef_read(int, int, void *);
 137 extern void *ef_ptr(int, int);
 138 extern char *ef_nameof(int);
 139 extern time_t ef_mtime(int);
 140 extern int ef_open(int, int);
 141 extern int ef_check(int);
 142 extern int ef_close(int);
 143 extern int ef_flush(int);
 144 extern int ef_write(int, int, void *);
 145 extern int ef_extend(int, int);
 146 extern int ef_ensure_space(int, int, int);
 147 extern int ef_nelem(int);
 148 extern int ef_flags(int);
 149 extern int ef_byname(char *);
 150
 151 extern struct empfile empfile[];
 152
 153 #endif /* _FILE_H_ */