/*
* Empire - A multi-player, client/server Internet based war game.
- * Copyright (C) 1986-2005, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ * Copyright (C) 1986-2009, Dave Pare, Jeff Bailey, Thomas Ruschak,
* Ken Stevens, Steve McClure
*
* This program is free software; you can redistribute it and/or modify
*
* ---
*
- * See the "LEGAL", "LICENSE", "CREDITS" and "README" files for all the
- * related information and legal notices. It is expected that any future
- * projects/authors will amend these files as needed.
+ * See files README, COPYING and CREDITS in the root of the source
+ * tree for related information and legal notices. It is expected
+ * that future projects/authors will amend these files as needed.
*
* ---
*
- * file.h: Describes Empire files and their contents
- *
+ * file.h: Describes Empire tables (`files' for historical reasons)
+ *
* Known contributors to this file:
- *
+ * Markus Armbruster, 2005-2008
*/
-#ifndef _FILE_H_
-#define _FILE_H_
+#ifndef FILE_H
+#define FILE_H
-#include <stddef.h>
+#include <time.h>
struct empfile {
- int ef_uid; /* Table ID */
+ /* Members with immutable values */
+ int uid; /* Table ID */
char *name; /* Empire name (e.g., "treaty") */
- char *file; /* file name (relative to data directory) */
- int flags; /* misc stuff */
- int size; /* size of object */
- void (*init) (int, char *); /* call this when object is created */
- int (*postread) (int, char *); /* specific massage routines for items */
- int (*prewrite) (int, char *);
- int fd; /* file descriptor, -1 if not open */
- int baseid; /* starting item in cache */
- int cids; /* # ids in cache */
- int csize; /* size of cache in bytes */
+ char *file; /* file name, relative to gamedir for
+ game state, to builtindir for config */
+ struct castr *cadef; /* table column selectors (column meta-data) */
+ int size; /* size of a table entry */
+ int flags; /* only EFF_IMMUTABLE immutable, see below
+ for use of remaining bits */
+
+ /* Members whose values are fixed when the cache is mapped */
char *cache; /* pointer to cache */
- int fids; /* # of ids in file */
- struct castr *cadef; /* ca defs selection list */
+ int csize; /* cache size, in entries */
+ /* flags bits EFF_MEM, EFF_PRIVATE, EFF_NOTIME also fixed then */
+
+ /* Members whose values may vary throughout operation */
+ int baseid; /* id of first entry in cache */
+ int cids; /* # entries in cache */
+ int fids; /* # entries in table */
+ int fd; /* file descriptor, -1 if not open */
+ /* flags bit EFF_CUSTOM also varies */
+
+ /* User callbacks, may all be null */
+ /*
+ * Called after element initialization. ELT is the element.
+ */
+ void (*oninit)(void *elt);
+ /*
+ * Called after read. ID is the element id, and ELT is the
+ * element read. May modify the element. Modifications are
+ * visible to caller of ef_read(), but have no effect on the file.
+ */
+ void (*postread)(int id, void *elt);
+ /*
+ * Called before write. ID is the element id, OLD is the element
+ * being updated (null unless it is cached) and ELT is the element
+ * being written. May modify the element. Modifications will be
+ * visible to caller of ef_write() and are written to the file.
+ */
+ void (*prewrite)(int id, void *old, void *elt);
+ /*
+ * Called after table size changed, with file type as argument.
+ * Return -1 and set errno to make the operation fail.
+ */
+ int (*onresize)(int type);
+};
+
+struct emptypedstr {
+ signed ef_type: 8;
+ unsigned seqno: 12;
+ unsigned generation: 12;
+ int uid;
+ time_t timestamp;
};
/*
- * struct empfile flags
- *
+ * Flag bits for struct empfile member flags
+ * Immutable flags are properties of the table and thus cannot change.
+ * The remaining flags record how the table is being used.
+ */
+/* Immutable flags, fixed at compile-time */
+/* Dereferencing entry address cast to struct emptypedstr * is safe */
+#define EFF_TYPED bit(0)
+/*
* EFF_XY / EFF_OWNER / EFF_GROUP assert that coordinates / owner /
- * group of such a file's record can be safely obtained by
- * dereferencing its memory address cast to struct genitem *.
+ * group of such a table's entries can be safely obtained by
+ * dereferencing the entry's address cast to struct empobj *.
*/
-#define EFF_XY bit(0)
-#define EFF_OWNER bit(1)
-#define EFF_GROUP bit(2)
+#define EFF_XY bit(1)
+#define EFF_OWNER bit(2)
+#define EFF_GROUP bit(3)
+/* Table is allocated statically */
+#define EFF_STATIC bit(4)
+/* Table has a sentinel (all zero, not counted as elt), implies EFF_MEM */
+#define EFF_SENTINEL bit(5)
+/* All the immutable flags */
+#define EFF_IMMUTABLE \
+ (EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP | EFF_STATIC)
+/* Flags set when table contents is mapped */
/* Table is entirely in memory */
-#define EFF_MEM bit(3)
-/* Table is read-only */
-#define EFF_RDONLY bit(4)
+#define EFF_MEM bit(8)
+/* Table is privately mapped: changes don't affect the underlying file */
+#define EFF_PRIVATE bit(9)
+/* Table is customized (configuration tables only) */
+#define EFF_CUSTOM bit(10)
+/* Don't update timestamps */
+#define EFF_NOTIME bit(11)
+/* Transient flags, only occur in argument of ef_open() */
/* Create table file, clobbering any existing file */
-#define EFF_CREATE bit(5)
-/* Table is allocated statically */
-
-/* Flags that may be passed to ef_open() */
-#define EFF_OPEN (EFF_MEM | EFF_RDONLY | EFF_CREATE)
+#define EFF_CREATE bit(16)
/*
* Empire `file types'
* These are really table IDs. Some tables are backed by files, some
- * are compiled into the server.
- * Historically, only table IDs 0..EF_MAX-1 existed. All the
- * functions operating on table IDs still reject the new indexes >=
- * EF_MAX. This needs to be rectified, carefully checking existing
- * code, which could rely on unspoken assumptions about these tables.
+ * are compiled into the server, some initialized from configuration
+ * files.
*/
-/* Error value */
-#define EF_BAD -1
-/* Dynamic game data tables: 0..EF_MAX-1 */
-#define EF_SECTOR 0
-#define EF_SHIP 1
-#define EF_PLANE 2
-#define EF_LAND 3
-#define EF_NUKE 4
-#define EF_NEWS 5
-#define EF_TREATY 6
-#define EF_TRADE 7
-#define EF_POWER 8
-#define EF_NATION 9
-#define EF_LOAN 10
-#define EF_MAP 11
-#define EF_BMAP 12
-#define EF_COMM 13
-#define EF_LOST 14
-#define EF_MAX 15
-/* Static game data (configuation): EF_MAX.. */
-#define EF_SECTOR_CHR 15
-#define EF_SHIP_CHR 16
-#define EF_PLANE_CHR 17
-#define EF_LAND_CHR 18
-#define EF_NUKE_CHR 19
-#if 0 /* doesn't exist yet */
-#define EF_NEWS_CHR
-#endif
-#define EF_TREATY_CHR 20
-#define EF_ITEM 21
-#define EF_INFRASTRUCTURE 22
-#define EF_PRODUCT 23
-#define EF_TABLE 24
-#define EF_SHIP_CHR_FLAGS 25
-#define EF_PLANE_CHR_FLAGS 26
-#define EF_LAND_CHR_FLAGS 27
-#define EF_NUKE_CHR_FLAGS 28
-
-struct fileinit {
- int ef_type;
- void (*init) (int, char *);
- int (*postread) (int, char *);
- int (*prewrite) (int, char *);
+enum {
+ /* Error value */
+ EF_BAD = -1,
+ /* Dynamic game data tables */
+ EF_SECTOR,
+ EF_SHIP,
+ EF_PLANE,
+ EF_LAND,
+ EF_NUKE,
+ EF_NEWS,
+ EF_TREATY,
+ EF_TRADE,
+ EF_POWER,
+ EF_NATION,
+ EF_LOAN,
+ EF_MAP,
+ EF_BMAP,
+ EF_COMM,
+ EF_LOST,
+ EF_REALM,
+ EF_GAME,
+ EF_DYNMAX = EF_GAME,
+ /* Static game data (configuration) */
+ /* Order is relevant; see read_builtin_tables() */
+ EF_ITEM,
+ EF_PRODUCT,
+ EF_SECTOR_CHR,
+ EF_SHIP_CHR,
+ EF_PLANE_CHR,
+ EF_LAND_CHR,
+ EF_NUKE_CHR,
+ EF_NEWS_CHR,
+ EF_INFRASTRUCTURE,
+ EF_UPDATES, /* not actually static */
+ EF_TABLE,
+ EF_VERSION,
+ EF_META, /* not really configuration */
+ /* Symbol tables */
+ EF_AGREEMENT_STATUS,
+ EF_LAND_CHR_FLAGS,
+ EF_LEVEL,
+ EF_META_FLAGS,
+ EF_META_TYPE,
+ EF_MISSIONS,
+ EF_NATION_FLAGS,
+ EF_NATION_REJECTS,
+ EF_NATION_RELATIONS,
+ EF_NATION_STATUS,
+ EF_NUKE_CHR_FLAGS,
+ EF_PACKING,
+ EF_PAGE_HEADINGS,
+ EF_PLAGUE_STAGES,
+ EF_PLANE_CHR_FLAGS,
+ EF_PLANE_FLAGS,
+ EF_RESOURCES,
+ EF_RETREAT_FLAGS,
+ EF_SECTOR_NAVIGATION,
+ EF_SHIP_CHR_FLAGS,
+ EF_TREATY_FLAGS,
+ /* Views */
+ EF_COUNTRY,
+ /* Number of types: */
+ EF_MAX
};
+#define EF_IS_GAME_STATE(type) (EF_SECTOR <= (type) && (type) <= EF_DYNMAX)
+#define EF_IS_VIEW(type) (EF_COUNTRY <= (type) && (type) < EF_MAX)
+
extern struct castr *ef_cadef(int);
extern int ef_read(int, int, void *);
+extern void ef_make_stale(void);
+extern void ef_mark_fresh(int, void *);
extern void *ef_ptr(int, int);
extern char *ef_nameof(int);
extern time_t ef_mtime(int);
-extern int ef_open(int, int);
-extern int ef_check(int);
+extern int ef_open(int, int, int);
+extern int ef_open_view(int, int);
extern int ef_close(int);
extern int ef_flush(int);
+extern void ef_blank(int, int, void *);
extern int ef_write(int, int, void *);
+extern void ef_set_uid(int, void *, int);
extern int ef_extend(int, int);
extern int ef_ensure_space(int, int, int);
-extern void ef_zapcache(int);
+extern int ef_truncate(int, int);
extern int ef_nelem(int);
extern int ef_flags(int);
extern int ef_byname(char *);
+extern int ef_byname_from(char *, int *);
+extern int ef_verify(void);
+extern int ef_elt_byname(int, char *);
-extern struct empfile empfile[];
+extern struct empfile empfile[EF_MAX + 1];
+extern void empfile_init(void);
+extern void empfile_fixup(void);
-#endif /* _FILE_H_ */
+#endif