home · contact · privacy
Server: Make config file set number of objects' start appearances.
[plomrogue] / src / server / configfile.c
1 /* src/server/configfile.c */
2
3 #include <stddef.h> /* size_t, NULL */
4 #include <stdio.h> /* snprintf() */
5 #include <stdint.h> /* uint8_t */
6 #include <stdlib.h> /* atoi(), free() */
7 #include <string.h> /* strcmp() */
8 #include "../common/parse_file.h" /* EDIT_STARTED, parsetest_int(),parse_file(),
9                                    * parsetest_too_many_values(),parse_id_uniq()
10                                    * parse_unknown_arg(), parse_init_entry(),
11                                    * parse_and_reduce_to_readyflag(),parse_val()
12                                    */
13 #include "../common/rexit.h" /* exit_err(), exit_trouble() */
14 #include "../common/try_malloc.h" /* try_malloc() */
15 #include "cleanup.h" /* set_cleanup_flag(), CLEANUP_MAP_OBJ_DEFS,
16                       * CLEANUP_MAP_OBJ_ACTS
17                       */
18 #include "map_object_actions.h" /* struct MapObjAct */
19 #include "map_objects.h" /* struct MapObj, struct MapObjDef */
20 #include "world.h" /* world global */
21
22
23
24 /* Flags defining state of object and action entry reading ((un-)finished /
25  * ready for starting the reading of a new definition etc.)
26  */
27 enum flag
28 {
29     HEIGHT_SET     = 0x02,
30     WIDTH_SET      = 0x04,
31     ORTH_SET       = 0x08,
32     DIAG_SET       = 0x10,
33     NAME_SET       = 0x02,
34     EFFORT_SET     = 0x04,
35     CORPSE_ID_SET  = 0x04,
36     SYMBOL_SET     = 0x08,
37     LIFEPOINTS_SET = 0x10,
38     CONSUMABLE_SET = 0x20,
39     START_N_SET    = 0x40,
40     READY_ACT = NAME_SET | EFFORT_SET,
41     READY_OBJ = NAME_SET | CORPSE_ID_SET | SYMBOL_SET | LIFEPOINTS_SET
42                 | CONSUMABLE_SET | START_N_SET,
43     READY_MAP = HEIGHT_SET | WIDTH_SET | ORTH_SET | DIAG_SET
44 };
45
46
47
48 /* What MapObjDef and MapObjAct structs have in common at their top. Use this to
49  * allow same functions run over structs of both types.
50  */
51 struct EntryHead
52 {
53     uint8_t id;
54     struct EntryHead * next;
55 };
56
57
58
59 /* Interpret "token0" and "token1" as data to write into the MapObjAct /
60  * MapObjDef DB.
61  *
62  * Individual MapObjDef / MapObjAct DB entries are put together line by line
63  * before being written. Writing only happens after all necessary members of an
64  * entry have been assembled, and when additionally a) a new entry is started by
65  * a "token0" of "ACTION" or "OBJECT"; or b) "token0" is NULL.
66  *
67  * Also check against the line parse_file() read tokens from having more tokens.
68  */
69 static void tokens_into_entries(char * token0, char * token1);
70
71 /* Start reading a new DB entry of "size" from tokens if "token0" matches
72  * "comparand". Set EDIT_STARTED in "flags" to mark beginning of new entry
73  * reading. Check that "token1" id of new entry has not already been used in DB
74  * starting at "entry_cmp".
75  */
76 static uint8_t start_entry(char * token0, char * token1, char * comparand,
77                          uint8_t * flags, size_t size,
78                          struct EntryHead ** entry,
79                          struct EntryHead * entry_cmp);
80
81 /* Start reading map definition if "token0" matches "comparand". Set "map_flags"
82  * to EDIT_STARTED to mark beginning of map definition reading.
83  */
84 static uint8_t start_map(char * token0, char * comparand, uint8_t * map_flags);
85
86 /* Write DB entry pointed to by "entry" to its appropriate location. */
87 static void write_if_entry(struct EntryHead ** entry,
88                            struct EntryHead *** entry_p_p_p);
89
90 /* Ensure that all .corpse_id members in the MapObjDef DB fit .id members of
91  * MapObjDef DB entries.
92  */
93 static void test_corpse_ids();
94
95 /* Try to read tokens as members for the definition currently edited, which may
96  * be "mod" or "moa" or that of world.map. What member of which of the three is
97  * set depends on which of the flags has EDIT_STARTED set and on the key name in
98  * "token0". Return 1 if interpretation succeeds, else 0.
99  *
100  * Note that MapObjAct entries' .name also determines their .func.
101  */
102 static uint8_t set_members(char * token0, char * token1, uint8_t * object_flags,
103                            uint8_t * action_flags, uint8_t * map_flags,
104                            struct MapObjDef * mod, struct MapObjAct * moa);
105
106 /* set_members() helper specifically for editing world.map members. */
107 static uint8_t set_map_members(char * token0,char * token1,uint8_t * map_flags);
108
109 /* If "name" fits "moa"->name, set "moa"->func to "func". (Derives MapObjAct
110  * .func from .name for set_members().
111  */
112 static uint8_t try_func_name(struct MapObjAct * moa,
113                              char * name, void (* func) (struct MapObj *));
114
115
116
117 static void tokens_into_entries(char * token0, char * token1)
118 {
119     char * str_act = "ACTION";
120     char * str_obj = "OBJECT";
121     char * str_map = "MAP_TYPE";
122     static struct MapObjAct ** moa_p_p = &world.map_obj_acts;
123     static struct MapObjDef ** mod_p_p = &world.map_obj_defs;
124     static uint8_t action_flags = READY_ACT;
125     static uint8_t object_flags = READY_OBJ;
126     static uint8_t map_flags = READY_MAP;
127     static struct EntryHead * moa = NULL;
128     static struct EntryHead * mod = NULL;
129     if (!token0 || !strcmp(token0, str_act) || !strcmp(token0, str_obj)
130                 || !strcmp(token0, str_map))
131     {
132         parse_and_reduce_to_readyflag(&action_flags, READY_ACT);
133         parse_and_reduce_to_readyflag(&object_flags, READY_OBJ);
134         parse_and_reduce_to_readyflag(&map_flags, READY_MAP);
135         write_if_entry(&moa, (struct EntryHead ***) &moa_p_p);
136         write_if_entry(&mod, (struct EntryHead ***) &mod_p_p);
137     }
138     if (token0)
139     {
140         parsetest_too_many_values();
141         if (!(   start_entry(token0, token1, str_act, &action_flags,
142                              sizeof(struct MapObjAct),(struct EntryHead**) &moa,
143                              (struct EntryHead *) world.map_obj_acts)
144               || start_entry(token0, token1, str_obj, &object_flags,
145                              sizeof(struct MapObjDef),(struct EntryHead**) &mod,
146                              (struct EntryHead *) world.map_obj_defs)
147               || start_map(token0, str_map, &map_flags)
148               || set_members(token0, token1, &object_flags, &action_flags,
149                               &map_flags, (struct MapObjDef *)mod,
150                               (struct MapObjAct *) moa)))
151         {
152             parse_unknown_arg();
153         }
154     }
155 }
156
157
158
159 static uint8_t start_entry(char * token0, char * token1, char * comparand,
160                            uint8_t * flags, size_t size,
161                            struct EntryHead ** entry,
162                            struct EntryHead * entry_cmp)
163 {
164     if (strcmp(token0, comparand))
165     {
166         return 0;
167     }
168     *entry = (struct EntryHead *) parse_init_entry(flags, size);
169     parsetest_int(token1, '8');
170     (*entry)-> id = atoi(token1);
171     for (; NULL != entry_cmp; entry_cmp = entry_cmp->next)
172     {
173         parse_id_uniq((*entry)->id == entry_cmp->id);
174     }
175     return 1;
176 }
177
178
179
180 static uint8_t start_map(char * token0, char * comparand, uint8_t * map_flags)
181 {
182     if (strcmp(token0, comparand))
183     {
184         return 0;
185     }
186     *map_flags = EDIT_STARTED;
187     return 1;
188 }
189
190
191
192 static void write_if_entry(struct EntryHead ** entry,
193                            struct EntryHead *** entry_p_p_p)
194 {
195     if (*entry)
196     {
197         (*entry)->next = NULL;
198         **entry_p_p_p = *entry;
199         *entry_p_p_p = &((*entry)->next);
200         *entry = NULL;   /* So later runs of this don't re-append same entry. */
201     }
202 }
203
204
205
206 static void test_corpse_ids()
207 {
208     char * f_name = "test_corpse_ids()";
209     char * prefix = "In the object definitions DB, one object corpse ID does "
210                     "not reference any known object in the DB. ID of "
211                     "responsible object: ";
212     size_t size = strlen(prefix) + 3 + 1; /* 3: uint8_t representation strlen */
213     char * err_corpse = try_malloc(size, f_name);
214     struct MapObjDef * test_entry_0 = world.map_obj_defs;
215     for (; test_entry_0; test_entry_0 = test_entry_0->next)
216     {
217         uint8_t corpse_id_found = 0;
218         struct MapObjDef * test_entry_1 = world.map_obj_defs;
219         for (; test_entry_1; test_entry_1 = test_entry_1->next)
220         {
221             if (test_entry_0->corpse_id == test_entry_1->id)
222             {
223                 corpse_id_found = 1;
224             }
225         }
226         int test = snprintf(err_corpse, size, "%s%d", prefix, test_entry_0->id);
227         exit_trouble(test < 0, f_name, "snprintf()");
228         exit_err(!corpse_id_found, err_corpse);
229     }
230     free(err_corpse);
231 }
232
233
234
235 static uint8_t set_map_members(char * token0, char * token1, uint8_t * map_flags)
236 {
237     if      (   parse_val(token0, token1, "HEIGHT", map_flags,
238                           HEIGHT_SET, 'i', (char *) &world.map.size.y)
239              || parse_val(token0, token1, "WIDTH", map_flags,
240                           WIDTH_SET, 'i', (char *) &world.map.size.x))
241     {
242         int test = atoi(token1) > 256 || atoi(token1) < 1;
243         err_line(test, "Value must be >= 1 and <= 256.");
244         return 1;
245     }
246     else if (    parse_val(token0, token1, "DIST_ORTHOGONAL", map_flags,
247                           ORTH_SET, '8', (char *) &world.map.dist_orthogonal)
248              ||  parse_val(token0, token1, "DIST_DIAGONAL", map_flags,
249                           DIAG_SET, '8', (char *) &world.map.dist_diagonal))
250     {
251         err_line(0 == atoi(token1), "Value must not be zero.");
252         return 1;
253     }
254     return 0;
255 }
256
257
258
259 static uint8_t set_members(char * token0, char * token1, uint8_t * object_flags,
260                            uint8_t * action_flags, uint8_t * map_flags,
261                            struct MapObjDef * mod, struct MapObjAct * moa)
262 {
263     if (   *action_flags & EDIT_STARTED
264         && parse_val(token0, token1, "NAME", action_flags,
265                      NAME_SET, 's', (char *) &moa->name))
266     {
267         if (!(   try_func_name(moa, "move", actor_move)
268               || try_func_name(moa, "pick_up", actor_pick)
269               || try_func_name(moa, "drop", actor_drop)
270               || try_func_name(moa, "use", actor_use)))
271         {
272             moa->func = actor_wait;
273         }
274         *action_flags = *action_flags | NAME_SET;
275         return 1;
276     }
277     else if (   set_map_members(token0, token1, map_flags)
278              || parse_val(token0, token1, "NAME", object_flags,
279                           NAME_SET, 's', (char *) &mod->name)
280              || parse_val(token0, token1, "SYMBOL", object_flags,
281                           SYMBOL_SET, 'c', (char *) &mod->char_on_map)
282              || parse_val(token0, token1, "EFFORT", action_flags,
283                           EFFORT_SET, '8', (char *) &moa->effort)
284              || parse_val(token0, token1, "START_NUMBER", object_flags,
285                           START_N_SET, '8', (char *) &mod->start_n)
286              || parse_val(token0, token1, "LIFEPOINTS", object_flags,
287                           LIFEPOINTS_SET, '8', (char *) &mod->lifepoints)
288              || parse_val(token0, token1, "CONSUMABLE", object_flags,
289                           CONSUMABLE_SET, '8', (char *) &mod->consumable)
290              || parse_val(token0, token1, "CORPSE_ID", object_flags,
291                           CORPSE_ID_SET, '8', (char *) &mod->corpse_id))
292     {
293         return 1;
294     }
295     return 0;
296 }
297
298
299
300 static uint8_t try_func_name(struct MapObjAct * moa, char * name,
301                              void (* func) (struct MapObj *))
302 {
303     if (0 == strcmp(moa->name, name))
304     {
305         moa->func = func;
306         return 1;
307     }
308     return 0;
309 }
310
311
312
313 extern void read_config_file()
314 {
315     parse_file(world.path_config, tokens_into_entries);
316     exit_err(!world.map.size.y, "Map not defined in config file.");
317     set_cleanup_flag(CLEANUP_MAP_OBJECT_ACTS | CLEANUP_MAP_OBJECT_DEFS);
318     test_corpse_ids();
319 }