/*
* Empire - A multi-player, client/server Internet based war game.
- * Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
+ * Copyright (C) 1986-2013, Dave Pare, Jeff Bailey, Thomas Ruschak,
* Ken Stevens, Steve McClure, Markus Armbruster
*
* Empire is free software: you can redistribute it and/or modify
* file.h: Describes Empire tables (`files' for historical reasons)
*
* Known contributors to this file:
- * Markus Armbruster, 2005-2008
+ * Markus Armbruster, 2005-2012
*/
#ifndef FILE_H
/* Members with immutable values */
int uid; /* Table ID */
char *name; /* Empire name (e.g., "treaty") */
+ char *pretty_name; /* prettier name, e.g. "land unit" */
char *file; /* file name, relative to gamedir for
game state, to builtindir for config */
struct castr *cadef; /* table column selectors (column meta-data) */
+ int base; /* view's base table, else EF_BAD */
int size; /* size of a table entry */
+ int nent; /* #table entries, -1 if variable */
int flags; /* only EFF_IMMUTABLE immutable, see below
for use of remaining bits */
/* User callbacks, may all be null */
/*
* Called after element initialization. ELT is the element.
+ * May modify the element.
*/
void (*oninit)(void *elt);
/*
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);
+ void (*onresize)(int type);
};
struct emptypedstr {
#define EFF_XY bit(1)
#define EFF_OWNER bit(2)
#define EFF_GROUP bit(3)
-/* Table is allocated statically */
+/* Table cache 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)
+ (EFF_TYPED | EFF_XY | EFF_OWNER | EFF_GROUP | EFF_STATIC | EFF_SENTINEL)
/* Flags set when table contents is mapped */
/* Table is entirely in memory */
#define EFF_MEM bit(8)
};
#define EF_IS_GAME_STATE(type) (EF_SECTOR <= (type) && (type) <= EF_DYNMAX)
-#define EF_IS_VIEW(type) (EF_COUNTRY <= (type) && (type) < EF_MAX)
+#define EF_IS_VIEW(type) (empfile[(type)].base != EF_BAD)
extern struct castr *ef_cadef(int);
extern int ef_read(int, int, void *);
extern void ef_mark_fresh(int, void *);
extern void *ef_ptr(int, int);
extern char *ef_nameof(int);
+extern char *ef_nameof_pretty(int);
extern time_t ef_mtime(int);
-extern int ef_open(int, int, int);
-extern int ef_open_view(int, int);
+extern int ef_open(int, int);
+extern int ef_open_view(int);
extern int ef_close(int);
extern int ef_flush(int);
extern void ef_blank(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 int ef_id_limit(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_verify_config(void);
+extern int ef_verify_state(int);
extern int ef_elt_byname(int, char *);
extern struct empfile empfile[EF_MAX + 1];