Use enums for object number mnemonics instead of VOCWRD() calls.
[open-adventure.git] / advent.h
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <stdbool.h>
4 #include <stdarg.h>
5
6 #include "common.h"
7 #include "newdb.h"
8
9 #define LINESIZE        100
10 #define NDWARVES        6               /* number of dwarves */
11 #define PIRATE          NDWARVES        /* must be NDWARVES-1 when zero-origin */
12 #define DALTLC          LOC_NUGGET      /* alternate dwarf location */
13 #define MAXPARMS        25              /* Max parameters for speak() */
14 #define INVLIMIT        7               /* inverntory limit (# of objects) */
15 #define INTRANSITIVE    -1              /* illegal object number */
16 #define SPECIALBASE     300             /* base number of special rooms */
17 #define GAMELIMIT       330             /* base limit of turns */
18 #define NOVICELIMIT     1000    /* limit of turns for novice */
19 #define WARNTIME        30              /* late game starts at game.limit-this */
20 #define FLASHTIME       50      /*turns from first warning till blinding flash */
21 #define PANICTIME       15              /* time left after closing */
22 #define BATTERYLIFE     2500            /* turn limit increment from batteries */
23
24 typedef long token_t;   /* word token - someday this will be char[TOKLEN+1] */
25 typedef long vocab_t;   /* index into a vocabulary array */
26
27 struct game_t {
28     unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
29     long abbnum;        /* How often to print non-abbreviated descriptions */
30     long blklin;
31     long bonus;
32     long chloc;
33     long chloc2;
34     long clock1;        /* # turns from finding last treasure till closing */
35     long clock2;        /* # turns from first warning till blinding flash */
36     bool clshnt;        /* has player read the clue in the endgame? */
37     bool closed;        /* whether we're all the way closed */
38     bool closng;        /* whether it's closing time yet */
39     long conds;         /* min value for cond(loc) if loc has any hints */
40     long detail;
41     long dflag;
42     long dkill;
43     long dtotal;
44     long foobar;        /* current progress in saying "FEE FIE FOE FOO". */
45     long holdng;        /* number of objects being carried */
46     long iwest;         /* How many times he's said "west" instead of "w" */
47     long knfloc;        /* 0 if no knife here, loc if knife , -1 after caveat */
48     long limit;         /* lifetime of lamp (not set here) */
49     bool lmwarn;        /* has player been warned about lamp going dim? */
50     long loc;
51     long newloc;
52     bool novice;        /* asked for instructions at start-up? */
53     long numdie;        /* number of times killed so far */
54     long oldloc;
55     long oldlc2;
56     long oldobj;
57     bool panic;         /* has player found out he's trapped in the cave? */
58     long saved;         /* point penalty for saves */
59     long tally;
60     long thresh;
61     long trndex;
62     long trnluz;        /* # points lost so far due to number of turns used */
63     long turns;         /* how many commands he's given (ignores yes/no) */
64     bool wzdark;        /* whether the loc he's leaving was dark */
65     long zzword;
66     bool blooded;       /* has player drunk of dragon's blood? */
67     long abbrev[NLOCATIONS + 1];
68     long atloc[NLOCATIONS + 1];
69     long dseen[NDWARVES + 1];
70     long dloc[NDWARVES + 1];
71     long odloc[NDWARVES + 1];
72     long fixed[NOBJECTS + 1];
73     long link[NOBJECTS * 2 + 1];
74     long place[NOBJECTS + 1];
75     long hinted[NHINTS];
76     long hintlc[NHINTS];
77     long prop[NOBJECTS + 1];
78 };
79
80 extern struct game_t game;
81
82 extern long LNLENG, LNPOSN;
83 extern char rawbuf[LINESIZE], INLINE[LINESIZE + 1];
84 extern const char ascii_to_advent[];
85 extern const char advent_to_ascii[];
86 extern FILE *logfp;
87 extern bool oldstyle, editline, prompt;
88
89 enum speaktype {touch, look, hear, study};
90
91 /* b is not needed for POSIX but harmless */
92 #define READ_MODE "rb"
93 #define WRITE_MODE "wb"
94 extern void* xmalloc(size_t size);
95 extern void packed_to_token(long, char token[]);
96 extern void token_to_packed(char token[], long*);
97 extern void vspeak(const char*, va_list);
98 extern bool wordeq(token_t, token_t);
99 extern bool wordempty(token_t);
100 extern void wordclear(token_t *);
101 extern void speak(const char*, ...);
102 extern void pspeak(vocab_t, enum speaktype, int, ...);
103 extern void rspeak(vocab_t, ...);
104 extern bool GETIN(FILE *, token_t*, token_t*, token_t*, token_t*);
105 extern void echo_input(FILE*, char*, char*);
106 extern char* get_input(void);
107 extern bool yes(const char*, const char*, const char*);
108 extern long GETTXT(bool, bool, bool);
109 extern token_t MAKEWD(long);
110 extern long vocab(long, long);
111 extern void juggle(long);
112 extern void move(long, long);
113 extern long put(long, long, long);
114 extern void carry(long, long);
115 extern void drop(long, long);
116 extern long atdwrf(long);
117 extern long setbit(long);
118 extern bool tstbit(long, int);
119 extern long rndvoc(long, long);
120 extern bool MAPLIN(FILE *);
121 extern void datime(long*, long*);
122
123 enum termination {endgame, quitgame, scoregame};
124
125 extern void set_seed(long);
126 extern unsigned long get_next_lcg_value(void);
127 extern long randrange(long);
128 extern long score(enum termination);
129 extern void terminate(enum termination) __attribute__((noreturn));
130 extern int suspend(void);
131 extern int resume(void);
132 extern int restore(FILE *);
133
134 /*
135  *  MOD(N,M)    = Arithmetic modulus
136  *  AT(OBJ)     = true if on either side of two-placed object
137  *  CNDBIT(L,N) = true if COND(L) has bit n set (bit 0 is units bit)
138  *  DARK(LOC)   = true if location "LOC" is dark
139  *  FORCED(LOC) = true if LOC moves without asking for input (COND=2)
140  *  FOREST(LOC) = true if LOC is part of the forest
141  *  GSTONE(OBJ) = true if OBJ is a gemstone
142  *  HERE(OBJ)   = true if the OBJ is at "LOC" (or is being carried)
143  *  LIQUID()    = object number of liquid in bottle
144  *  LIQLOC(LOC) = object number of liquid (if any) at LOC
145  *  PCT(N)      = true N% of the time (N integer from 0 to 100)
146  *  TOTING(OBJ) = true if the OBJ is being carried */
147
148 #define DESTROY(N)      move(N, LOC_NOWHERE)
149 #define MOD(N,M)        ((N) % (M))
150 #define TOTING(OBJ)     (game.place[OBJ] == CARRIED)
151 #define AT(OBJ) (game.place[OBJ] == game.loc || game.fixed[OBJ] == game.loc)
152 #define HERE(OBJ)       (AT(OBJ) || TOTING(OBJ))
153 #define LIQ2(PBOTL)     ((1-(PBOTL))*WATER+((PBOTL)/2)*(WATER+OIL))
154 #define LIQUID()        (LIQ2(game.prop[BOTTLE]<0 ? -1-game.prop[BOTTLE] : game.prop[BOTTLE]))
155 #define LIQLOC(LOC)     (LIQ2((MOD(conditions[LOC]/2*2,8)-5)*MOD(conditions[LOC]/4,2)+1))
156 #define CNDBIT(L,N)     (tstbit(conditions[L],N))
157 #define FORCED(LOC)     CNDBIT(LOC, COND_FORCED)
158 #define DARK(DUMMY)     ((!tstbit(conditions[game.loc],COND_LIT)) && (game.prop[LAMP] == LAMP_DARK || !HERE(LAMP)))
159 #define PCT(N)          (randrange(100) < (N))
160 #define GSTONE(OBJ)     ((OBJ) == EMERALD || (OBJ) == RUBY || (OBJ) == AMBER || (OBJ) == SAPPH)
161 #define FOREST(LOC)     CNDBIT(LOC, COND_FOREST)
162 #define VOCWRD(LETTRS,SECT)     (vocab(MAKEWD(LETTRS),SECT))
163 #define SPECIAL(LOC)    ((LOC) > SPECIALBASE)
164 #define OUTSID(LOC)     (CNDBIT(LOC, COND_ABOVE) || FOREST(LOC))
165
166 #define INDEEP(LOC)     ((LOC) >= LOC_MISTHALL && !OUTSID(LOC))
167
168 /* vocabulary items */
169 extern long NUL;
170 extern long BACK;
171 extern long LOOK;
172 extern long CAVE;
173 extern long FIND;
174 extern long INVENT;
175 extern long SAY;
176 extern long ENTER;
177 extern long STREAM;
178 extern long DPRSSN;
179 extern long ENTRNC;
180 extern long LOCK;
181 extern long THROW;
182
183 enum speechpart {unknown, intransitive, transitive};
184
185 struct command_t {
186     enum speechpart part;
187     vocab_t verb;
188     vocab_t obj;
189     token_t wd1, wd1x;
190     token_t wd2, wd2x;
191 };
192
193 void initialise(void);
194 int action(FILE *input, struct command_t *command);
195
196 /* Phase codes for action returns.
197  * These were at one time FORTRAN line numbers.
198  * The values don't matter, but perturb their order at your peril.
199  */
200 #define GO_TERMINATE    2
201 #define GO_MOVE         8
202 #define GO_TOP          2000
203 #define GO_CLEAROBJ     2012
204 #define GO_CHECKHINT    2600
205 #define GO_CHECKFOO     2607
206 #define GO_DIRECTION    2620
207 #define GO_LOOKUP       2630
208 #define GO_WORD2        2800
209 #define GO_SPECIALS     1900
210 #define GO_UNKNOWN      8000
211 #define GO_ACTION       40000
212 #define GO_DWARFWAKE    19000
213
214 /* Special object statuses in game.place - can also be a location number (> 0) */
215 #define CARRIED         -1      /* Player is toting it */
216
217 /* hack to ignore GCC Unused Result */
218 #define IGNORE(r) do{if (r){}}while(0)
219
220 /*
221  * FIXME: These constants should be replaced by strings, at their usage sites.
222  * They are sixbit-packed representations of vocabulary words.  This, and code
223  * left in misc.c, is the only place left in the runtime that knows about 
224  * word packing.
225  */
226 #define WORD_AXE        12405
227 #define WORD_BATTERY    201202005
228 #define WORD_BEAR       2050118
229 #define WORD_BIRD       2091804
230 #define WORD_BLOOD      212151504
231 #define WORD_BOTTLE     215202012
232 #define WORD_CAGE       3010705
233 #define WORD_CATCH      301200308
234 #define WORD_CAVITY     301220920
235 #define WORD_CHASM      308011913
236 #define WORD_CLAM       3120113
237 #define WORD_DOOR       4151518
238 #define WORD_DRAGON     418010715
239 #define WORD_DWARF      423011806
240 #define WORD_FISSURE    609191921
241 #define WORD_FOOD       6151504
242 #define WORD_GO         715
243 #define WORD_GRATE      718012005
244 #define WORD_KEYS       11052519
245 #define WORD_KNIFE      1114090605
246 #define WORD_LAMP       12011316
247 #define WORD_MAGAZINE   1301070126
248 #define WORD_MESSAG     1305191901
249 #define WORD_MIRROR     1309181815
250 #define WORD_OGRE       15071805
251 #define WORD_OIL        150912
252 #define WORD_OYSTER     1525192005
253 #define WORD_PILLOW     1609121215
254 #define WORD_PLANT      1612011420
255 #define WORD_POUR       16152118
256 #define WORD_RESER      1805190518
257 #define WORD_ROD        181504
258 #define WORD_SIGN       19090714
259 #define WORD_SNAKE      1914011105
260 #define WORD_STEPS      1920051619
261 #define WORD_TROLL      2018151212
262 #define WORD_URN        211814
263 #define WORD_VEND       1755140409
264 #define WORD_VOLCANO    1765120301
265 #define WORD_WATER      1851200518
266 #define WORD_AMBER      113020518
267 #define WORD_CHAIN      308010914
268 #define WORD_CHEST      308051920
269 #define WORD_COINS      315091419
270 #define WORD_EGGS       5070719
271 #define WORD_EMERALD    513051801
272 #define WORD_JADE       10010405
273 #define WORD_NUGGET     7151204
274 #define WORD_PEARL      1605011812
275 #define WORD_PYRAMID    1625180113
276 #define WORD_RUBY       18210225
277 #define WORD_RUG        182107
278 #define WORD_SAPPH      1901161608
279 #define WORD_TRIDENT    2018090405
280 #define WORD_VASE       22011905
281 #define WORD_BACK       2010311
282 #define WORD_CAVE       3012205
283 #define WORD_DPRSSN     405161805
284 #define WORD_ENTER      514200518
285 #define WORD_ENTRNC     514201801
286 #define WORD_LOOK       12151511
287 #define WORD_NUL        14211212
288 #define WORD_STREAM     1920180501
289 #define WORD_FIND       6091404
290 #define WORD_INVENT     914220514
291 #define WORD_LOCK       12150311
292 #define WORD_SAY        190125
293 #define WORD_THROW      2008181523
294 #define WORD_WEST       23051920
295 #define WORD_YES        250519
296 #define WORD_YINIT      25
297
298 /* end */
299