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