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
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.
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.
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
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.
28 * file.h: Describes Empire tables (`files' for historical reasons)
30 * Known contributors to this file:
31 * Markus Armbruster, 2005-2008
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 */
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 */
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 */
62 /* User callbacks, may all be null */
64 * Called after element initialization. ELT is the element.
66 void (*oninit)(void *elt);
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.
72 void (*postread)(int id, void *elt);
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.
79 void (*prewrite)(int id, void *old, void *elt);
81 * Called after table size changed, with file type as argument.
82 * Return -1 and set errno to make the operation fail.
84 int (*onresize)(int type);
95 * Flag bits for struct empfile member flags
96 * Immutable flags are properties of the table and thus cannot change.
97 * The remaining flags record how the table is being used.
99 /* Immutable flags, fixed at compile-time */
100 /* Dereferencing entry address cast to struct emptypedstr * is safe */
101 #define EFF_TYPED bit(0)
103 * EFF_XY / EFF_OWNER / EFF_GROUP assert that coordinates / owner /
104 * group of such a table's entries can be safely obtained by
105 * dereferencing the entry's address cast to struct empobj *.
107 #define EFF_XY bit(1)
108 #define EFF_OWNER bit(2)
109 #define EFF_GROUP bit(3)
110 /* Table is allocated statically */
111 #define EFF_STATIC bit(4)
112 /* Table has a sentinel (all zero, not counted as elt), implies EFF_MEM */
113 #define EFF_SENTINEL bit(5)
114 /* All the immutable flags */
115 #define EFF_IMMUTABLE \
116 (EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP | EFF_STATIC)
117 /* Flags set when table contents is mapped */
118 /* Table is entirely in memory */
119 #define EFF_MEM bit(8)
120 /* Table is privately mapped: changes don't affect the underlying file */
121 #define EFF_PRIVATE bit(9)
122 /* Table is customized (configuration tables only) */
123 #define EFF_CUSTOM bit(10)
124 /* Don't update timestamps */
125 #define EFF_NOTIME bit(11)
126 /* Transient flags, only occur in argument of ef_open() */
127 /* Create table file, clobbering any existing file */
128 #define EFF_CREATE bit(16)
131 * Empire `file types'
132 * These are really table IDs. Some tables are backed by files, some
133 * are compiled into the server, some initialized from configuration
139 /* Dynamic game data tables */
158 /* Static game data (configuration) */
159 /* Order is relevant; see read_builtin_tables() */
169 EF_UPDATES, /* not actually static */
172 EF_META, /* not really configuration */
192 EF_SECTOR_NAVIGATION,
197 /* Number of types: */
201 #define EF_IS_GAME_STATE(type) (EF_SECTOR <= (type) && (type) <= EF_DYNMAX)
202 #define EF_IS_VIEW(type) (EF_COUNTRY <= (type) && (type) < EF_MAX)
204 extern struct castr *ef_cadef(int);
205 extern int ef_read(int, int, void *);
206 extern void *ef_ptr(int, int);
207 extern char *ef_nameof(int);
208 extern time_t ef_mtime(int);
209 extern int ef_open(int, int, int);
210 extern int ef_open_view(int, int);
211 extern int ef_close(int);
212 extern int ef_flush(int);
213 extern void ef_blank(int, int, void *);
214 extern int ef_write(int, int, void *);
215 extern void ef_set_uid(int, void *, int);
216 extern int ef_extend(int, int);
217 extern int ef_ensure_space(int, int, int);
218 extern int ef_truncate(int, int);
219 extern int ef_nelem(int);
220 extern int ef_flags(int);
221 extern int ef_byname(char *);
222 extern int ef_byname_from(char *, int *);
223 extern int ef_verify(void);
224 extern int ef_elt_byname(int, char *);
226 extern struct empfile empfile[EF_MAX + 1];
227 extern void empfile_init(void);
228 extern void empfile_fixup(void);