--- deliantra/server/common/region.C 2007/01/25 03:54:44 1.17 +++ deliantra/server/common/region.C 2007/01/29 15:04:21 1.20 @@ -22,10 +22,19 @@ * The authors can be reached via e-mail at */ - #include #include +region * +region::default_region () +{ + for (region *reg = first_region; reg; reg = reg->next) + if (reg->fallback) + return reg; + + return first_region; +} + /* * Pass a char array, returns a pointer to the region of the same name. * if it can't find a region of the same name it returns the first region @@ -35,58 +44,15 @@ * used by the map parsing code. */ region * -get_region_by_name (const char *region_name) +region::find (const char *name) { - region *reg; - char *p = strchr (region_name, '\n'); - - if (p) - *p = '\0'; - for (reg = first_region; reg != NULL; reg = reg->next) - if (!strcmp (reg->name, region_name)) + for (region *reg = first_region; reg; reg = reg->next) + if (!strcmp (reg->name, name)) return reg; - for (reg = first_region; reg != NULL; reg = reg->next) - { - if (reg->fallback) - { - LOG (llevDebug, "region called %s requested, but not found, fallback used.\n", region_name); - return reg; - } - } - LOG (llevInfo, "Got no region or fallback for region %s.\n", region_name); - return NULL; -} - -/* This might need optimising at some point. */ -region * -get_region_by_map (maptile *m) -{ - return get_region_by_name (get_name_of_region_for_map (m)); -} - -/* - * Since we won't assume all maps have a region set properly, we need an - * explicit check that it is, this is much nicer here than scattered throughout - * the map code. - */ + LOG (llevError, "region called %s requested, but not found, using fallback.\n", name); -const char * -get_name_of_region_for_map (const maptile *m) -{ - region *reg; - - if (m->default_region) - return m->default_region->name; - - for (reg = first_region; reg; reg = reg->next) - { - if (reg->fallback) - return reg->name; - } - - LOG (llevInfo, "map %s had no region and I couldn't find a fallback to use.\n", &m->name); - return "unknown"; + return default_region (); } /* @@ -102,7 +68,7 @@ * */ region * -get_region_from_string (const char *name) +region::find_fuzzy (const char *name) { region *reg; char *substr; @@ -110,52 +76,59 @@ if (name == NULL) { - for (reg = first_region; reg->parent != NULL; reg = reg->parent); + for (reg = first_region; reg->parent; reg = reg->parent) + ; + return reg; } + p = strchr (name, '\n'); if (p) *p = '\0'; - for (reg = first_region; reg != NULL; reg = reg->next) + + for (reg = first_region; reg; reg = reg->next) if (!strcasecmp (reg->name, name)) return reg; - for (reg = first_region; reg != NULL; reg = reg->next) - if (reg->longname != NULL) - { - if (!strcasecmp (reg->longname, name)) - return reg; - } + for (reg = first_region; reg; reg = reg->next) + if (reg->longname) + if (!strcasecmp (reg->longname, name)) + return reg; substr = NULL; - for (reg = first_region; reg != NULL; reg = reg->next) - if (reg->longname != NULL) + for (reg = first_region; reg; reg = reg->next) + if (reg->longname) { substr = strstr (reg->longname, name); - if (substr != NULL) + if (substr) return reg; } - for (reg = first_region; reg != NULL; reg = reg->next) - if (reg->longname != NULL) + + for (reg = first_region; reg; reg = reg->next) + if (reg->longname) { /* - * This is not a bug, we want the region that is most identifiably a discrete + * This is not a bug, we want the region that is most identifiably a discrete * area in the game, eg if we have 'scor', we want to return 'scorn' and not * 'scornarena', regardless of their order on the list so we only look at those * regions with a longname set. */ substr = strstr (reg->name, name); - if (substr != NULL) + if (substr) return reg; } - for (reg = first_region; reg != NULL; reg = reg->next) + + for (reg = first_region; reg; reg = reg->next) { substr = strstr (reg->name, name); - if (substr != NULL) + if (substr) return reg; } + /* if we are still here, we are going to have to give up, and give the top level region */ - for (reg = first_region; reg->parent != NULL; reg = reg->parent); + for (reg = first_region; reg->parent; reg = reg->parent) + ; + return reg; } @@ -165,59 +138,25 @@ * if passed a NULL region returns -1 */ -int +static int region_is_child_of_region (const region * child, const region * r) { if (r == NULL) return -1; + if (child == NULL) return 0; + if (!strcmp (child->name, r->name)) return 1; + else if (child->parent != NULL) return region_is_child_of_region (child->parent, r); else return 0; } -/* - * the longname of a region is not a required field, any given region - * may want to not set it and use the parent's one instead. so, we: - * 1. check if a longname is set and if so return it. - * 2. check if there is a parent and try and call the function against that - * 3. return a obviously wrong string if we can't get a longname, this should - * never happen. We also log a debug message. - */ -const char * -get_region_longname (const region * r) -{ - - if (r->longname != NULL) - return r->longname; - else if (r->parent != NULL) - return get_region_longname (r->parent); - else - { - LOG (llevDebug, "NOTICE region %s has no parent and no longname.\n", r->name); - return "no name can be found for the current region"; - } -} - -const char * -get_region_msg (const region * r) -{ - if (r->msg != NULL) - return r->msg; - else if (r->parent != NULL) - return get_region_msg (r->parent); - else - { - LOG (llevDebug, "NOTICE region %s has no parent and no msg.\n", r->name); - return "no description can be found for the current region"; - } -} - /** Returns an object which is an exit through which the player represented by op should be * sent in order to be imprisoned. If there is no suitable place to which an exit can be * constructed, then NULL will be returned. The caller is responsible for freeing the object @@ -234,8 +173,9 @@ LOG (llevError, "region.c: get_jail_exit called against non-player object.\n"); return NULL; } - reg = get_region_by_map (op->map); - while (reg != NULL) + + reg = op->region (); + while (reg) { if (reg->jailmap) { @@ -250,207 +190,154 @@ else reg = reg->parent; } - LOG (llevDebug, "No suitable jailmap for region %s was found.\n", reg->name); + + LOG (llevDebug, "No suitable jailmap for region %s was found.\n", ®->name); return NULL; } -/* - * First initialises the archtype hash-table (init_archetable()). - * Reads and parses the archetype file (with the first and second-pass - * functions). - * Then initialises treasures by calling load_treasures(). - */ -void -init_regions (void) +static void +assign_region_parents (void) { - FILE *fp; - char filename[MAX_BUF]; - int comp; - - if (first_region != NULL) /* Only do this once */ - return; + region *reg; + uint32 parent_count = 0; + uint32 region_count = 0; - sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions); - LOG (llevDebug, "Reading regions from %s...\n", filename); - if ((fp = open_and_uncompress (filename, 0, &comp)) == NULL) + for (reg = first_region; reg && reg->next; reg = reg->next) { - LOG (llevError, " Can't open regions file %s in init_regions.\n", filename); - return; - } - parse_regions (fp); - assign_region_parents (); - LOG (llevDebug, " done\n"); - - close_and_delete (fp, comp); -} + if (reg->parent_name) + { + reg->parent = region::find (reg->parent_name); + parent_count++; + } -/* - * Allocates and zeros a region struct, this isn't free()'d anywhere, so might - * be a memory leak, but it shouldn't matter too much since it isn't called that - * often.... - */ + region_count++; + } -region * -get_region_struct (void) -{ - return new region; + LOG (llevDebug, "Assigned %u regions with %u parents.\n", region_count, parent_count); } /* * Reads/parses the region file, and copies into a linked list * of region structs. */ -void -parse_regions (FILE * fp) +static bool +parse_regions (object_thawer &fp) { region *newreg; region *reg; - char buf[HUGE_BUF], msgbuf[HUGE_BUF], *key = NULL, *value, *end; - int msgpos = 0; - newreg = NULL; - while (fgets (buf, HUGE_BUF - 1, fp) != NULL) + for (;;) { - buf[HUGE_BUF - 1] = 0; - key = buf; - while (isspace (*key)) - key++; - if (*key == 0) - continue; /* empty line */ - value = strchr (key, ' '); - if (!value) - { - end = strchr (key, '\n'); - *end = 0; - } - else - { - *value = 0; - value++; - while (isspace (*value)) - value++; - end = strchr (value, '\n'); - } - - /* - * This is a bizzare mutated form of the map and archetype parser - * rolled into one. Key is the field name, value is what it should - * be set to. - * We've already done the work to null terminate key, - * and strip off any leading spaces for both of these. - * We have not touched the newline at the end of the line - - * these might be needed for some values. the end pointer - * points to the first of the newlines. - * value could be NULL! It would be easy enough to just point - * this to "" to prevent cores, but that would let more errors slide - * through. - */ - if (!strcmp (key, "region")) - { - *end = 0; - newreg = get_region_struct (); - newreg->name = strdup (value); - } - else if (!strcmp (key, "parent")) - { - /* - * Note that this is in the initialisation code, so we don't actually - * assign the pointer to the parent yet, because it might not have been - * parsed. - */ - *end = 0; - newreg->parent_name = strdup (value); - } - else if (!strcmp (key, "longname")) - { - *end = 0; - newreg->longname = strdup (value); - } - else if (!strcmp (key, "jail")) - { - /* jail entries are of the form: /path/to/map x y */ - char path[MAX_BUF]; - int x, y; - - if (sscanf (value, "%[^ ] %d %d\n", path, &x, &y) != 3) - { - LOG (llevError, "region.c: malformated regions entry: jail %s\n", value); - continue; - } - newreg->jailmap = strdup (path); - newreg->jailx = x; - newreg->jaily = y; - } - else if (!strcmp (key, "msg")) - { - while (fgets (buf, HUGE_BUF - 1, fp) != NULL) - { - if (!strcmp (buf, "endmsg\n")) - break; - else - { - strcpy (msgbuf + msgpos, buf); - msgpos += strlen (buf); - } - } - /* - * There may be regions with empty messages (eg, msg/endmsg - * with nothing between). When maps are loaded, this is done - * so better do it here too... - */ - if (msgpos != 0) - newreg->msg = strdup (msgbuf); - - /* we have to reset msgpos, or the next region will store both msg blocks. */ - msgpos = 0; - } - else if (!strcmp (key, "fallback")) - { - *end = 0; - newreg->fallback = atoi (value); - } - else if (!strcmp (key, "end")) - { - /* Place this new region last on the list, if the list is empty put it first */ - for (reg = first_region; reg != NULL && reg->next != NULL; reg = reg->next); + keyword kw = fp.get_kv (); - if (reg == NULL) - first_region = newreg; - else - reg->next = newreg; - newreg = NULL; - } - else if (!strcmp (key, "nomore")) + switch (kw) { - /* we have reached the end of the region specs.... */ - break; - } - else - { - /* we should never get here, if we have, then something is wrong */ - LOG (llevError, "Got unknown value in region file: %s %s\n", key, value); + case KW_EOF: + if (newreg) + { + LOG (llevError, "%s: end of file while reading regions.\n", fp.name); + return false; + } + else + return true; + + case KW_end: + /* Place this new region last on the list, if the list is empty put it first */ + for (reg = first_region; reg && reg->next; reg = reg->next) + ; + + if (!reg) + first_region = newreg; + else + reg->next = newreg; + + newreg = 0; + break; + + default: + case KW_ERROR: + LOG (llevError, "%s: skipping errornous line (%s) while reading regions.\n", fp.name, fp.last_keyword); + break; + + case KW_region: + newreg = new region; + fp.get (newreg->name); + break; + + case KW_parent: + /* + * Note that this is in the initialisation code, so we don't actually + * assign the pointer to the parent yet, because it might not have been + * parsed. + */ + fp.get (newreg->parent_name); + break; + + case KW_longname: + newreg->longname = strdup (fp.get_str ()); + break; + + case KW_jail_map: + fp.get (newreg->jailmap); + break; + + case KW_jail_x: + fp.get (newreg->jailx); + break; + + case KW_jail_y: + fp.get (newreg->jaily); + break; + + case KW_msg: + fp.get_ml (KW_endmsg, newreg->msg); + break; + + case KW_fallback: + fp.get (newreg->fallback); + break; + + case KW_nomore: + /* we have reached the end of the region specs.... */ + return true; } } - if (!key || strcmp (key, "nomore")) - LOG (llevError, "Got premature eof on regions file!\n"); } +/* + * First initialises the archtype hash-table (init_archetable()). + * Reads and parses the archetype file (with the first and second-pass + * functions). + * Then initialises treasures by calling load_treasures(). + */ void -assign_region_parents (void) +init_regions (void) { - region *reg; - uint32 parent_count = 0; - uint32 region_count = 0; + char filename[MAX_BUF]; + int comp; - for (reg = first_region; reg != NULL && reg->next != NULL; reg = reg->next) + if (first_region != NULL) /* Only do this once */ + return; + + // make sure one region is always available + first_region = new region; + first_region->name = ""; + first_region->longname = strdup ("Built-in Region"); + + sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions); + LOG (llevDebug, "Reading regions from %s...\n", filename); + + object_thawer fp (filename); + + if (!fp) { - if (reg->parent_name != NULL) - { - reg->parent = get_region_by_name (reg->parent_name); - parent_count++; - } - region_count++; + LOG (llevError, " Can't open regions file %s in init_regions.\n", filename); + return; } - LOG (llevDebug, "Assigned %u regions with %u parents.\n", region_count, parent_count); + + parse_regions (fp); + + assign_region_parents (); + LOG (llevDebug, " done\n"); }