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