Varargs cleanup is almost finished.
[vms-empire.git] / empire.h
1 /*
2  *    Copyright (C) 1987, 1988 Chuck Simmons
3  * 
4  * See the file COPYING, distributed with empire, for restriction
5  * and warranty information.
6  */
7
8 /*
9 empire.h -- type and constant declarations
10 */
11
12 #include <stdbool.h>
13
14 #ifndef NULL
15 #define NULL 0
16 #endif
17
18 typedef unsigned char uchar;
19
20 typedef long loc_t;     /* represent a board location in 4-digit form */
21
22 typedef long count_t;   /* for iterating over or counting board locations */
23
24 #define ASSERT(x) if (!(x)) assert ("x", __FILE__, __LINE__);
25 #define ABORT assert ("aborting", __FILE__, __LINE__)
26
27 /* directions one can move */
28 #define NORTH 0
29 #define NORTHEAST 1
30 #define EAST 2
31 #define SOUTHEAST 3
32 #define SOUTH 4
33 #define SOUTHWEST 5
34 #define WEST 6
35 #define NORTHWEST 7
36
37 #define NUMTOPS 3 /* number of lines at top of screen for messages */
38 #define NUMSIDES 6 /* number of lines at side of screen */
39 #define STRSIZE 80 /* number of characters in a string */
40
41 /* Information we maintain about cities. */
42
43 #define UNOWNED 0
44 #define USER 1
45 #define COMP 2
46
47 /* Piece types. */
48 #define ARMY 0
49 #define FIGHTER 1
50 #define PATROL 2
51 #define DESTROYER 3
52 #define SUBMARINE 4
53 #define TRANSPORT 5
54 #define CARRIER 6
55 #define BATTLESHIP 7
56 #define SATELLITE 8
57 #define NUM_OBJECTS 9 /* number of defined objects */
58 #define NOPIECE ((char)255) /* a 'null' piece */
59
60 #define LIST_SIZE 5000 /* max number of pieces on board */
61
62 typedef struct city_info {
63         loc_t loc; /* location of city */
64         uchar owner; /* UNOWNED, USER, COMP */
65         long func[NUM_OBJECTS]; /* function for each object */
66         long work; /* units of work performed */
67         char prod; /* item being produced */
68 } city_info_t;
69
70 /*
71 Types of programmed movement.  Use negative numbers for special
72 functions, use positive numbers to move toward a specific location.
73 */
74
75 #define NOFUNC -1       /* no programmed function */
76 #define RANDOM -2       /* move randomly */
77 #define SENTRY -3       /* sleep */
78 #define FILL -4         /* fill transport */
79 #define LAND -5         /* land fighter at city */
80 #define EXPLORE -6      /* piece explores nearby */
81 #define ARMYLOAD -7     /* army moves toward and boards a transport */
82 #define ARMYATTACK -8   /* army looks for city to attack */
83 #define TTLOAD -9       /* transport moves toward loading armies */
84 #define REPAIR -10      /* ship moves toward port */
85 #define WFTRANSPORT -11 /* army boards a transport */
86 #define MOVE_N -12      /* move north */
87 #define MOVE_NE -13     /* move northeast */
88 #define MOVE_E -14      /* move east */
89 #define MOVE_SE -15     /* move southeast */
90 #define MOVE_S -16      /* move south */
91 #define MOVE_SW -17     /* move southwest */
92 #define MOVE_W -18      /* move west */
93 #define MOVE_NW -19     /* move northwest */
94
95 /* Index to list of function names. */
96 #define FUNCI(x) (-(x)-1)
97
98 /*
99 Macro to convert a movement function into a direction.
100 */
101
102 #define MOVE_DIR(a) (-(a)+MOVE_N)
103
104 /*
105 Information we maintain about each piece.
106 */
107
108 typedef struct { /* ptrs for doubly linked list */
109         struct piece_info *next; /* pointer to next in list */
110         struct piece_info *prev; /* pointer to prev in list */
111 } link_t;
112
113 typedef struct piece_info {
114         link_t piece_link; /* linked list of pieces of this type */
115         link_t loc_link; /* linked list of pieces at a location */
116         link_t cargo_link; /* linked list of cargo pieces */
117         int owner; /* owner of piece */
118         int type; /* type of piece */
119         loc_t loc; /* location of piece */
120         long func; /* programmed type of movement */
121         short hits; /* hits left */
122         int moved; /* moves made */
123         struct piece_info *ship; /* pointer to containing ship */
124         struct piece_info *cargo; /* pointer to cargo list */
125         short count; /* count of items on board */
126         short range; /* current range (if applicable) */
127 } piece_info_t;
128
129 /*
130 Macros to link and unlink an object from a doubly linked list.
131 */
132
133 #define LINK(head,obj,list) { \
134         obj->list.prev = NULL; \
135         obj->list.next = head; \
136         if (head) head->list.prev = obj; \
137         head = obj; \
138 }
139
140 #define UNLINK(head,obj,list) { \
141         if (obj->list.next) \
142                 obj->list.next->list.prev = obj->list.prev; \
143         if (obj->list.prev) \
144                 obj->list.prev->list.next = obj->list.next; \
145         else head = obj->list.next; \
146         obj->list.next = NULL; /* encourage mem faults in buggy code */ \
147         obj->list.prev = NULL; \
148 }
149
150 /* macros to set map and list of an object */
151 #define MAP(owner) ((owner) == USER ? user_map : comp_map)
152 #define LIST(owner) ((owner) == USER ? user_obj : comp_obj)
153
154 /* macro to step through adjacent cells */
155 #define FOR_ADJ(loc,new_loc,i) for (i=0; (i<8 ? new_loc=loc+dir_offset[i],1 : 0); i++)
156 #define FOR_ADJ_ON(loc,new_loc,i) FOR_ADJ(loc,new_loc,i) if (map[new_loc].on_board)
157
158 /*
159 We maintain attributes for each piece.  Attributes are currently constant,
160 but the way has been paved to allow user's to change attributes at the
161 beginning of a game.
162 */
163
164 #define INFINITY 10000000 /* a large number */
165
166 typedef struct piece_attr {
167         char sname; /* eg 'C' */
168         char name[20]; /* eg "aircraft carrier" */
169         char nickname[20]; /* eg "carrier" */
170         char article[20]; /* eg "an aircraft carrier" */
171         char plural[20]; /* eg "aircraft carriers" */
172         char terrain[4]; /* terrain piece can pass over eg "." */
173         uchar build_time; /* time needed to build unit */
174         uchar strength; /* attack strength */
175         uchar max_hits; /* number of hits when completely repaired */
176         uchar speed; /* number of squares moved per turn */
177         uchar capacity; /* max objects that can be held */
178         long range; /* range of piece */
179 } piece_attr_t;
180
181 /*
182 There are 3 maps.  'map' describes the world as it actually
183 exists; it tells whether each map cell is land, water or a city;
184 it tells whether or not a square is on the board.
185
186 'user_map' describes the user's view of the world.  'comp_map' describes
187 the computer's view of the world.
188
189 As of the 1.7 version, MAP_WIDTH and MAP_HEIGHT are now free paramaters.
190 You can change them and the code will adjust properly.
191 */
192
193 #define MAP_WIDTH 100
194 #define MAP_HEIGHT 60
195 #define MAP_SIZE (MAP_WIDTH * MAP_HEIGHT)
196
197 /* #define NUM_CITY 70 */
198 /* #define NUM_CITY (MAP_SIZE / 85) */
199 #define NUM_CITY ((100 * (MAP_WIDTH + MAP_HEIGHT)) / 228)
200
201 typedef struct real_map { /* a cell of the actual map */
202         char contents; /* '+', '.', or '*' */
203         bool on_board; /* TRUE iff on the board */
204         city_info_t *cityp; /* ptr to city at this location */
205         piece_info_t *objp; /* list of objects at this location */
206 } real_map_t;
207
208 typedef struct view_map { /* a cell of one player's world view */
209         char contents; /* '+', '.', '*', 'A', 'a', etc */
210         long seen; /* date when last updated */
211 } view_map_t;
212
213 /* Define information we maintain for a pathmap. */
214
215 typedef struct {
216         int cost; /* total cost to get here */
217         int inc_cost; /* incremental cost to get here */
218         char terrain; /* T_LAND, T_WATER, T_UNKNOWN, T_PATH */
219 } path_map_t;
220
221 #define T_UNKNOWN 0
222 #define T_PATH 1
223 #define T_LAND 2
224 #define T_WATER 4
225 #define T_AIR (T_LAND | T_WATER)
226
227 /* A record for counts we obtain when scanning a continent. */
228
229 typedef struct {
230         int user_cities; /* number of user cities on continent */
231         int user_objects[NUM_OBJECTS];
232         int comp_cities;
233         int comp_objects[NUM_OBJECTS];
234         int size; /* size of continent in cells */
235         int unowned_cities; /* number of unowned cities */
236         int unexplored; /* unexplored territory */
237 } scan_counts_t;
238
239 /* Define useful constants for accessing sectors. */
240
241 #define SECTOR_ROWS 5 /* number of vertical sectors */
242 #define SECTOR_COLS 2 /* number of horizontal sectors */
243 #define NUM_SECTORS (SECTOR_ROWS * SECTOR_COLS) /* total sectors */
244 #define ROWS_PER_SECTOR ((MAP_HEIGHT+SECTOR_ROWS-1)/SECTOR_ROWS)
245 #define COLS_PER_SECTOR ((MAP_WIDTH+SECTOR_COLS-1)/SECTOR_COLS)
246
247 /* Information we need for finding a path for moving a piece. */
248
249 typedef struct {
250         char city_owner; /* char that represents home city */
251         char *objectives; /* list of objectives */
252         int weights[11]; /* weight of each objective */
253 } move_info_t;
254
255 /* special weights */
256 #define W_TT_BUILD -1 /* special cost for city building a tt */
257
258 /* List of cells in the perimeter of our searching for a path. */
259
260 typedef struct {
261         long len; /* number of items in list */
262         long list[MAP_SIZE]; /* list of locations */
263 } perimeter_t;