Add a DEMOTE_WORD() macro.
[open-adventure.git] / advent.h
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <stdbool.h>
4 #include <stdarg.h>
5
6 #include "dungeon.h"
7
8 #define LINESIZE       1024
9 #define NDWARVES       6          // number of dwarves
10 #define PIRATE         NDWARVES   // must be NDWARVES-1 when zero-origin
11 #define DALTLC         LOC_NUGGET // alternate dwarf location
12 #define INVLIMIT       7          // inverntory limit (# of objects)
13 #define INTRANSITIVE   -1         // illegal object number
14 #define SPECIALBASE    300        // base number of special rooms
15 #define GAMELIMIT      330        // base limit of turns
16 #define NOVICELIMIT    1000       // limit of turns for novice
17 #define WARNTIME       30         // late game starts at game.limit-this
18 #define FLASHTIME      50         // turns from first warning till blinding flash
19 #define PANICTIME      15         // time left after closing
20 #define BATTERYLIFE    2500       // turn limit increment from batteries
21 #define WORD_NOT_FOUND -1         // "Word not found" flag value for the vocab hash functions.
22 #define CARRIED        -1         // Player is toting it
23 #define READ_MODE      "rb"       // b is not needed for POSIX but harmless
24 #define WRITE_MODE     "wb"       // b is not needed for POSIX but harmless
25
26 /*
27  *  MOD(N,M)    = Arithmetic modulus
28  *  AT(OBJ)     = true if on either side of two-placed object
29  *  CNDBIT(L,N) = true if COND(L) has bit n set (bit 0 is units bit)
30  *  DARK(LOC)   = true if location "LOC" is dark
31  *  FORCED(LOC) = true if LOC moves without asking for input (COND=2)
32  *  FOREST(LOC) = true if LOC is part of the forest
33  *  GSTONE(OBJ) = true if OBJ is a gemstone
34  *  HERE(OBJ)   = true if the OBJ is at "LOC" (or is being carried)
35  *  LIQUID()    = object number of liquid in bottle
36  *  LIQLOC(LOC) = object number of liquid (if any) at LOC
37  *  PCT(N)      = true N% of the time (N integer from 0 to 100)
38  *  TOTING(OBJ) = true if the OBJ is being carried */
39 #define DESTROY(N)   move(N, LOC_NOWHERE)
40 #define MOD(N,M)     ((N) % (M))
41 #define TOTING(OBJ)  (game.place[OBJ] == CARRIED)
42 #define AT(OBJ)      (game.place[OBJ] == game.loc || game.fixed[OBJ] == game.loc)
43 #define HERE(OBJ)    (AT(OBJ) || TOTING(OBJ))
44 #define LIQ2(PBOTL)  ((1-(PBOTL))*WATER+((PBOTL)/2)*(WATER+OIL))
45 #define LIQUID()     (LIQ2(game.prop[BOTTLE]<0 ? -1-game.prop[BOTTLE] : game.prop[BOTTLE]))
46 #define LIQLOC(LOC)  (LIQ2((MOD(conditions[LOC]/2*2,8)-5)*MOD(conditions[LOC]/4,2)+1))
47 #define CNDBIT(L,N)  (tstbit(conditions[L],N))
48 #define FORCED(LOC)  CNDBIT(LOC, COND_FORCED)
49 #define DARK(DUMMY)  ((!tstbit(conditions[game.loc],COND_LIT)) && (game.prop[LAMP] == LAMP_DARK || !HERE(LAMP)))
50 #define PCT(N)       (randrange(100) < (N))
51 #define GSTONE(OBJ)  ((OBJ) == EMERALD || (OBJ) == RUBY || (OBJ) == AMBER || (OBJ) == SAPPH)
52 #define FOREST(LOC)  CNDBIT(LOC, COND_FOREST)
53 #define SPECIAL(LOC) ((LOC) > SPECIALBASE)
54 #define OUTSID(LOC)  (CNDBIT(LOC, COND_ABOVE) || FOREST(LOC))
55 #define INDEEP(LOC)  ((LOC) >= LOC_MISTHALL && !OUTSID(LOC))
56 #define BUG(x)       bug(x, #x)
57 #define MOTION_WORD(n)  ((n) + 0)
58 #define OBJECT_WORD(n)  ((n) + 1000)
59 #define ACTION_WORD(n)  ((n) + 2000)
60 #define SPECIAL_WORD(n) ((n) + 3000)
61 #define PROMOTE_WORD(n) ((n) + 1000)
62 #define DEMOTE_WORD(n)  ((n) - 1000)
63
64 enum bugtype {
65     SPECIAL_TRAVEL_500_GT_L_GT_300_EXCEEDS_GOTO_LIST,
66     VOCABULARY_TYPE_N_OVER_1000_NOT_BETWEEN_0_AND_3,
67     INTRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
68     TRANSITIVE_ACTION_VERB_EXCEEDS_GOTO_LIST,
69     CONDITIONAL_TRAVEL_ENTRY_WITH_NO_ALTERATION,
70     LOCATION_HAS_NO_TRAVEL_ENTRIES,
71     HINT_NUMBER_EXCEEDS_GOTO_LIST,
72     SPEECHPART_NOT_TRANSITIVE_OR_INTRANSITIVE_OR_UNKNOWN,
73     ACTION_RETURNED_PHASE_CODE_BEYOND_END_OF_SWITCH,
74 };
75
76 enum speaktype {touch, look, hear, study, change};
77
78 enum termination {endgame, quitgame, scoregame};
79
80 enum speechpart {unknown, intransitive, transitive};
81
82 /* Phase codes for action returns.
83  * These were at one time FORTRAN line numbers.
84  * The values don't matter, but perturb their order at your peril.
85  */
86 enum phase_codes {
87     GO_TERMINATE,
88     GO_MOVE,
89     GO_TOP,
90     GO_CLEAROBJ,
91     GO_CHECKHINT,
92     GO_CHECKFOO,
93     GO_DIRECTION,
94     GO_LOOKUP,
95     GO_WORD2,
96     GO_SPECIALS,
97     GO_UNKNOWN,
98     GO_ACTION,
99     GO_DWARFWAKE,
100 };
101
102 typedef long token_t;  // word token - someday this will be char[TOKLEN+1]
103 typedef long vocab_t;  // index into a vocabulary array */
104
105 struct game_t {
106     unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
107     long abbnum;                 // How often to print non-abbreviated descriptions
108     long blklin;
109     long bonus;
110     long chloc;
111     long chloc2;
112     long clock1;                 // # turns from finding last treasure till closing
113     long clock2;                 // # turns from first warning till blinding flash
114     bool clshnt;                 // has player read the clue in the endgame?
115     bool closed;                 // whether we're all the way closed
116     bool closng;                 // whether it's closing time yet
117     long conds;                  // min value for cond(loc) if loc has any hints
118     long detail;
119
120     /*  dflag controls the level of activation of dwarves:
121      *  0       No dwarf stuff yet (wait until reaches Hall Of Mists)
122      *  1       Reached Hall Of Mists, but hasn't met first dwarf
123      *  2       Met first dwarf, others start moving, no knives thrown yet
124      *  3       A knife has been thrown (first set always misses)
125      *  3+      Dwarves are mad (increases their accuracy) */
126     long dflag;
127
128     long dkill;
129     long dtotal;
130     long foobar;                 // current progress in saying "FEE FIE FOE FOO".
131     long holdng;                 // number of objects being carried
132     long iwest;                  // How many times he's said "west" instead of "w"
133     long knfloc;                 // 0 if no knife here, loc if knife , -1 after caveat
134     long limit;                  // lifetime of lamp (not set here)
135     bool lmwarn;                 // has player been warned about lamp going dim?
136     long loc;
137     long newloc;
138     bool novice;                 // asked for instructions at start-up?
139     long numdie;                 // number of times killed so far
140     long oldloc;
141     long oldlc2;
142     long oldobj;
143     bool panic;                  // has player found out he's trapped in the cave?
144     long saved;                  // point penalty for saves
145     long tally;
146     long thresh;
147     long trndex;
148     long trnluz;                 // # points lost so far due to number of turns used
149     long turns;                  // how many commands he's given (ignores yes/no)
150     bool wzdark;                 // whether the loc he's leaving was dark
151     char zzword[6];              // randomly generated magic word from bird
152     bool blooded;                // has player drunk of dragon's blood?
153     long abbrev[NLOCATIONS + 1];
154     long atloc[NLOCATIONS + 1];
155     long dseen[NDWARVES + 1];    // true if dwarf has seen him
156     long dloc[NDWARVES + 1];     // location of dwarves, initially hard-wired in
157     long odloc[NDWARVES + 1];    // prior loc of each dwarf, initially garbage
158     long fixed[NOBJECTS + 1];
159     long link[NOBJECTS * 2 + 1];
160     long place[NOBJECTS + 1];
161     long hinted[NHINTS];         // hintlc[i] is how long he's been at LOC with cond bit i
162     long hintlc[NHINTS];         // hinted[i] is true iff hint i has been used.
163     long prop[NOBJECTS + 1];
164 };
165
166 struct command_t {
167     enum speechpart part;
168     vocab_t verb;
169     vocab_t obj;
170     token_t wd1, wd1x;
171     token_t wd2, wd2x;
172 };
173
174 extern struct game_t game;
175 extern FILE *logfp;
176 extern bool oldstyle, editline, prompt;
177
178 extern char* xstrdup(const char* s);
179 extern void* xmalloc(size_t size);
180 extern void packed_to_token(long, char token[]);
181 extern long token_to_packed(const char token[6]);
182 extern void tokenize(char*, long tokens[4]);
183 extern void vspeak(const char*, va_list);
184 extern bool wordeq(token_t, token_t);
185 extern bool wordempty(token_t);
186 extern void wordclear(token_t *);
187 extern void speak(const char*, ...);
188 extern void pspeak(vocab_t, enum speaktype, int, ...);
189 extern void rspeak(vocab_t, ...);
190 extern void echo_input(FILE*, char*, char*);
191 extern int word_count(char*);
192 extern char* get_input(void);
193 extern bool silent_yes(void);
194 extern bool yes(const char*, const char*, const char*);
195 extern int get_motion_vocab_id(const char*);
196 extern int get_object_vocab_id(const char*);
197 extern int get_action_vocab_id(const char*);
198 extern int get_special_vocab_id(const char*);
199 extern long get_vocab_id(const char*);
200 extern void juggle(long);
201 extern void move(long, long);
202 extern long put(long, long, long);
203 extern void carry(long, long);
204 extern void drop(long, long);
205 extern long atdwrf(long);
206 extern long setbit(long);
207 extern bool tstbit(long, int);
208 extern void make_zzword(char*);
209 extern void datime(long*, long*);
210 extern void set_seed(long);
211 extern unsigned long get_next_lcg_value(void);
212 extern long randrange(long);
213 extern long score(enum termination);
214 extern void terminate(enum termination) __attribute__((noreturn));
215 extern int savefile(FILE *, long);
216 extern int suspend(void);
217 extern int resume(void);
218 extern int restore(FILE *);
219 extern long initialise(void);
220 extern int action(struct command_t *command);
221
222 /* Alas, declaring this static confuses the coverage analyzer */
223 void bug(enum bugtype, const char *) __attribute__((__noreturn__));
224
225 /* end */