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