Magic-number elimination.
[open-adventure.git] / advent.h
1 #include <stdio.h>
2 #include <stdlib.h>
3 #include <stdbool.h>
4
5 #include "common.h"
6
7 #define LINESIZE        100
8 #define NDWARVES        6               /* number of dwarves */
9 #define PIRATE          NDWARVES        /* must be NDWARVES-1 when zero-origin */
10 #define DALTLC          LOC_NUGGET      /* alternate dwarf location */
11 #define MINTRS          50              /* index of lowest reasure */
12 #define MAXTRS          79              /* index of highest reasure */
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 WARNTIME        30              /* late game starts at game.limit-this */
18 #define PANICTIME       15              /* time left after closing */
19 #define BATTERYLIFE     2500            /* turn limit increment from batteries */
20
21 typedef long token_t;   /* word token - someday this will be char[TOKLEN+1] */
22 typedef long vocab_t;   /* index into a vocabulary array */
23
24 struct game_t {
25     unsigned long lcg_a, lcg_c, lcg_m, lcg_x;
26     long abbnum;
27     long blklin;
28     long bonus;
29     long chloc;
30     long chloc2;
31     long clock1;
32     long clock2;
33     long clshnt;
34     long closed;
35     long closng;
36     long conds;
37     long detail;
38     long dflag;
39     long dkill;
40     long dtotal;
41     long foobar;
42     long holdng;
43     long iwest;
44     long knfloc;
45     long limit;
46     long lmwarn;
47     long loc;
48     long newloc;
49     long novice;
50     long numdie;
51     long oldloc;
52     long oldlc2;
53     long oldobj;
54     long panic;
55     long saved;
56     long tally;
57     long thresh;
58     long trndex;
59     long trnluz;
60     long turns;
61     long wzdark;
62     long zzword;
63     long abbrev[LOCSIZ+1];
64     long atloc[LOCSIZ+1];
65     long dseen[NDWARVES+1];
66     long dloc[NDWARVES+1];
67     long odloc[NDWARVES+1];
68     long fixed[NOBJECTS+1];
69     long link[NOBJECTS*2 + 1];
70     long place[NOBJECTS+1];
71     long hinted[HNTSIZ+1];
72     long hintlc[HNTSIZ+1];
73     long prop[NOBJECTS+1];
74 };
75
76 extern struct game_t game;
77
78 extern long LNLENG, LNPOSN, PARMS[];
79 extern char rawbuf[LINESIZE], INLINE[LINESIZE+1];
80 extern const char ascii_to_advent[];
81 extern const char advent_to_ascii[];
82 extern FILE *logfp;
83 extern bool oldstyle, editline, prompt;
84
85 /* b is not needed for POSIX but harmless */
86 #define READ_MODE "rb"
87 #define WRITE_MODE "wb"
88 extern void* xmalloc(size_t size);
89 extern char* xstrdup(const char*);
90 extern void packed_to_token(long, char token[]);
91 extern void speak(const char*);
92 extern void PSPEAK(vocab_t,int);
93 extern void RSPEAK(vocab_t);
94 extern void SETPRM(long,long,long);
95 extern bool GETIN(FILE *,token_t*,token_t*,token_t*,token_t*);
96 extern void echo_input(FILE*, char*, char*);
97 extern char* get_input(void);
98 extern bool YES(const char*, const char*, const char*);
99 extern long GETTXT(bool,bool,bool);
100 extern token_t MAKEWD(long);
101 extern long VOCAB(long,long);
102 extern void JUGGLE(long);
103 extern void MOVE(long,long);
104 extern long PUT(long,long,long);
105 extern void CARRY(long,long);
106 extern void DROP(long,long);
107 extern long ATDWRF(long);
108 extern long SETBIT(long);
109 extern bool TSTBIT(long,int);
110 extern long RNDVOC(long,long);
111 extern bool MAPLIN(FILE *);
112 extern void DATIME(long*, long*);
113
114 enum termination {endgame, quitgame, scoregame};
115
116 extern void set_seed(long);
117 extern unsigned long get_next_lcg_value(void);
118 extern long randrange(long);
119 extern long score(enum termination);
120 extern void terminate(enum termination) __attribute__((noreturn));
121 extern int suspend(void);
122 extern int resume(void);
123 extern int restore(FILE *);
124
125 /*
126  *  MOD(N,M)    = Arithmetic modulus
127  *  AT(OBJ)     = true if on either side of two-placed object
128  *  CNDBIT(L,N) = true if COND(L) has bit n set (bit 0 is units bit)
129  *  DARK(LOC)   = true if location "LOC" is dark
130  *  FORCED(LOC) = true if LOC moves without asking for input (COND=2)
131  *  FOREST(LOC) = true if LOC is part of the forest
132  *  GSTONE(OBJ) = true if OBJ is a gemstone
133  *  HERE(OBJ)   = true if the OBJ is at "LOC" (or is being carried)
134  *  LIQUID()    = object number of liquid in bottle
135  *  LIQLOC(LOC) = object number of liquid (if any) at LOC
136  *  PCT(N)      = true N% of the time (N integer from 0 to 100)
137  *  TOTING(OBJ) = true if the OBJ is being carried */
138
139 #define DESTROY(N)      MOVE(N, NOWHERE)
140 #define MOD(N,M)        ((N) % (M))
141 #define TOTING(OBJ)     (game.place[OBJ] == CARRIED)
142 #define AT(OBJ) (game.place[OBJ] == game.loc || game.fixed[OBJ] == game.loc)
143 #define HERE(OBJ)       (AT(OBJ) || TOTING(OBJ))
144 #define LIQ2(PBOTL)     ((1-(PBOTL))*WATER+((PBOTL)/2)*(WATER+OIL))
145 #define LIQUID()        (LIQ2(game.prop[BOTTLE]<0 ? -1-game.prop[BOTTLE] : game.prop[BOTTLE]))
146 #define LIQLOC(LOC)     (LIQ2((MOD(COND[LOC]/2*2,8)-5)*MOD(COND[LOC]/4,2)+1))
147 #define CNDBIT(L,N)     (TSTBIT(COND[L],N))
148 #define FORCED(LOC)     (COND[LOC] == 2)
149 #define DARK(DUMMY)     ((!CNDBIT(game.loc,LIGHT)) && (game.prop[LAMP] == 0 || !HERE(LAMP)))
150 #define PCT(N)          (randrange(100) < (N))
151 #define GSTONE(OBJ)     ((OBJ) == EMERALD || (OBJ) == RUBY || (OBJ) == AMBER || (OBJ) == SAPPH)
152 #define FOREST(LOC)     ((LOC) >= LOC_FOREST1 && (LOC) <= LOC_FOREST22)
153 #define VOCWRD(LETTRS,SECT)     (VOCAB(MAKEWD(LETTRS),SECT))
154 #define SPECIAL(LOC)    ((LOC) > SPECIALBASE)
155
156 /*  The following two functions were added to fix a bug (game.clock1 decremented
157  *  while in forest).  They should probably be replaced by using another
158  *  "cond" bit.  For now, however, a quick fix...  OUTSID(LOC) is true if
159  *  LOC is outside, INDEEP(LOC) is true if LOC is "deep" in the cave (hall
160  *  of mists or deeper).  Note special kludges for "Foof!" locs. */
161
162 #define OUTSID(LOC)     ((LOC) <= LOC_GRATE || FOREST(LOC) || (LOC) == PLAC[SAPPH] || (LOC) == LOC_FOOF2 || (LOC) == LOC_FOOF4)
163 #define INDEEP(LOC)     ((LOC) >= LOC_MISTHALL && !OUTSID(LOC) && (LOC) != LOC_FOOF1)
164
165 /* vocabulary items */ 
166 extern long AMBER, ATTACK, AXE, BACK, BATTERY, BEAR,
167    BIRD, BLOOD, BOTTLE, CAGE, CAVE, CAVITY, CHAIN, CHASM, CHEST,
168    CLAM, COINS, DOOR, DPRSSN, DRAGON, DWARF, EGGS,
169    EMERALD, ENTER, ENTRNC, FIND, FISSURE, FOOD, GRATE, HINT, INVENT,
170    JADE, KEYS, KNIFE, LAMP, LOCK, LOOK, MAGAZINE, MESSAG, MIRROR, NUGGET, NUL,
171    OGRE, OIL, OYSTER, PANIC, PEARL, PILLOW, PLANT, PLANT2, PYRAMID,
172    RESER, ROD, ROD2, RUBY, RUG, SAPPH, SAY, SIGN, SNAKE,
173    STEPS, STICK, STREAM, THROW, TRIDENT, TROLL, TROLL2,
174    URN, VASE, VEND, VOLCANO, WATER;
175
176 enum speechpart {unknown, intransitive, transitive};
177
178 void initialise(void);
179 int action(FILE *input, enum speechpart part, long verb, token_t obj);
180
181 /* Phase codes for action returns. 
182  * These were at one time FORTRAN line numbers.
183  * The values don't matter, but perturb their order at your peril.
184  */
185 #define GO_TERMINATE    2
186 #define GO_MOVE         8
187 #define GO_TOP          2000
188 #define GO_CLEAROBJ     2012
189 #define GO_CHECKHINT    2600
190 #define GO_CHECKFOO     2607
191 #define GO_DIRECTION    2620
192 #define GO_LOOKUP       2630
193 #define GO_WORD2        2800
194 #define GO_SPECIALS     1900
195 #define GO_UNKNOWN      8000
196 #define GO_ACTION       40000
197 #define GO_DWARFWAKE    19000
198
199 /* Symbols for cond bits */
200 #define LIGHT   0       /* Light */
201 #define OILY    1       /* If bit 2 is on: on for oil, off for water */
202 #define FLUID   2       /* Liquid asset, see bit 1 */
203 #define NOARRR  3       /* Pirate doesn't go here unless following player */
204 #define NOBACK  4       /* Cannot use "back" to move away */
205 /* Bits past 10 indicate areas of interest to "hint" routines */
206 #define HBASE   10      /* Base for location hint bitss */
207 #define HCAVE   11      /* Trying to get into cave */
208 #define HBIRD   12      /* Trying to catch bird */
209 #define HSNAKE  13      /* Trying to deal with snake */
210 #define HMAZE   14      /* Lost in maze */
211 #define HDARK   15      /* Pondering dark room */
212 #define HWITT   16      /* At Witt's End */
213 #define HCLIFF  17      /* Cliff with urn */
214 #define HWOODS  18      /* Lost in forest */
215 #define HOGRE   19      /* Trying to deal with ogre */
216 #define HJADE   20      /* Found all treasures except jade */
217
218 /* Special object statuses in game.place - can also be a location number (> 0) */
219 #define CARRIED         -1      /* Player is toting it */
220 #define NOWHERE 0       /* It's destroyed */
221
222 /* hack to ignore GCC Unused Result */
223 #define IGNORE(r) do{if (r){}}while(0)
224
225 /* end */
226