server/common/region.C

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2001-2003,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <support@deliantra.net>
 */

#include <global.h>
#include <unistd.h>

regionvec regions;

region *
region::default_region ()
{
  for_all_regions (rgn)
    if (rgn->fallback)
      return rgn;

  return regions [0];
}

/* 
 * 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
 * with the 'fallback' property set.
 * if it can't find a matching name /or/ a fallback region it logs an info message 
 * message and returns NULL
 * used by the map parsing code. 
 */
region *
region::find (shstr_cmp name)
{
  for_all_regions (rgn)
    if (rgn->name == name)
      return rgn;

  LOG (llevError, "region called %s requested, but not found, using fallback.\n", &name);

  return default_region ();
}

/*
 * Tries to find a region that 'name' corresponds to.
 * It looks, in order, for:
 * an exact match to region name (case insensitive)
 * an exact match to longname (case insensitive)
 * a substring that matches to the longname (eg Kingdom)
 * a substring that matches to the region name (eg nav)
 * if it can find none of these it returns the first parentless region 
 * (there should be only one of these - the top level one)
 * If we got a NULL, then just return the top level region
 * 
 */
region *
region::find_fuzzy (const char *name)
{
  if (!name)
    return default_region ();

  // TODO: bug, changes possibly const string
  char *p = strchr (name, '\n');
  if (p)
    *p = '\0';

  for_all_regions (rgn)
    if (rgn->name.eq_nc (name))
      return rgn;

  for_all_regions (rgn)
    if (rgn->longname.eq_nc (name))
      return rgn;

  for_all_regions (rgn)
    if (rgn->longname.contains (name))
      return rgn;

  for_all_regions (rgn)
    /* 
     * 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.
     */
    if (rgn->longname && rgn->name.contains (name))
      return rgn;

  for_all_regions (rgn)
    if (rgn->name.contains (name))
      return rgn;

  return default_region ();
}

void
region::do_destroy ()
{
  regions.erase (this);

  attachable::do_destroy ();

  refcnt_dec ();
}

/* 
 * returns 1 if the player is in the region reg, or a child region thereof
 * otherwise returns 0
 * if passed a NULL region returns -1
 */
static int
region_is_child_of_region (const region * child, const region * r)
{
  if (!r)
    return -1;

  if (!child)
    return 0;

  if (child->name == r->name)
    return 1;

  if (child->parent)
    return region_is_child_of_region (child->parent, r);

  return 0;
}

/** 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
 *  created by this function.
 */
object *
get_jail_exit (object *op)
{
  if (op->type != PLAYER)
    {
      LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
      return NULL;
    }

  region *reg = op->region ();
  while (reg)
    {
      if (reg->jailmap)
        {
          object *exit = object::create ();
          EXIT_PATH (exit) = reg->jailmap;
          /* damned exits reset savebed and remove teleports, so the prisoner can't escape */
          SET_FLAG (exit, FLAG_DAMNED);
          EXIT_X (exit) = reg->jailx;
          EXIT_Y (exit) = reg->jaily;
          return exit;
        }
      else
        reg = reg->parent;
    }

  LOG (llevError, "No suitable jailmap for region %s was found.\n", &reg->name);

  return 0;
}

region *
region::read (object_thawer &f)
{
  assert (f.kw == KW_region);

  region *rgn = new region;
  rgn->refcnt_inc ();

  f.get (rgn->name);
  f.next ();

  for (;;)
    {
      switch (f.kw)
        {
          case KW_parent:
            rgn->parent = region::find (f.get_str ());
            break;

          case KW_msg:        f.get_ml (KW_endmsg, rgn->msg); break;
          case KW_longname:   f.get (rgn->longname); break;
          case KW_jail_map:   f.get (rgn->jailmap);  break;
          case KW_jail_x:     f.get (rgn->jailx);    break;
          case KW_jail_y:     f.get (rgn->jaily);    break;
          case KW_portal_map: f.get (rgn->portalmap);break;
          case KW_portal_x:   f.get (rgn->portalx);  break;
          case KW_portal_y:   f.get (rgn->portaly);  break;
          case KW_fallback:   f.get (rgn->fallback); break;
          case KW_chance:     f.get (rgn->treasure_density); break;

          case KW_randomitems:
            rgn->treasure = treasurelist::get (f.get_str ());
            break;

          case KW_end:
            f.next ();

            // cannot use find as that will request the default region
            for_all_regions (old)
              if (old->name == rgn->name)
                {
                  old->destroy ();
                  break;
                }

            // just append
            regions.push_back (rgn);
            return rgn;

          case KW_ERROR:
            rgn->set_key_text (f.kw_str, f.value);
            //fprintf (stderr, "region addkv(%s,%s)\n", f.kw_str, f.value);//D
            break;

          default:
            if (!f.parse_error ("region", rgn->name))
              {
                rgn->destroy ();
                return 0;
              }
            break;
        }

      f.next ();
    }
}

/*
 * First initialises the archtype hash-table (init_archetable()).
 * Reads and parses the archetype file (with the first and second-pass
 * functions).
 */
void
init_regions (void)
{
  if (!regions.size ())
    {
      // make sure one region is always available
      region *rgn = new region;
      rgn->name = "<builtin>";
      rgn->longname = "Built-in Region";
      regions.push_back (rgn);
    }
}

Revision:	1.41
Committed:	Thu Jan 1 11:41:17 2009 UTC (15 years, 5 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.40:	+19 -27 lines
Log Message:	* empty log message *
#	User	Rev	Content
1	elmex	1.1	/*
2	root	1.37	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	pippijn	1.16	*
4	root	1.39	* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	root	1.32	* Copyright (©) 2001-2003,2007 Mark Wedel & Crossfire Development Team
6			* Copyright (©) 1992,2007 Frank Tore Johansen
7	pippijn	1.16	*
8	root	1.37	* Deliantra is free software: you can redistribute it and/or modify
9	root	1.33	* it under the terms of the GNU General Public License as published by
10			* the Free Software Foundation, either version 3 of the License, or
11			* (at your option) any later version.
12	pippijn	1.16	*
13	root	1.33	* This program is distributed in the hope that it will be useful,
14			* but WITHOUT ANY WARRANTY; without even the implied warranty of
15			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16			* GNU General Public License for more details.
17	root	1.32	*
18	root	1.33	* You should have received a copy of the GNU General Public License
19			* along with this program. If not, see <http://www.gnu.org/licenses/>.
20	root	1.32	*
21	root	1.37	* The authors can be reached via e-mail to <support@deliantra.net>
22	pippijn	1.16	*/
23	elmex	1.1
24			#include <global.h>
25	pippijn	1.8	#include <unistd.h>
26	root	1.4
27	root	1.21	regionvec regions;
28
29	root	1.18	region *
30			region::default_region ()
31			{
32	root	1.21	for_all_regions (rgn)
33			if (rgn->fallback)
34			return rgn;
35	root	1.18
36	root	1.21	return regions [0];
37	root	1.18	}
38
39	elmex	1.1	/*
40			* Pass a char array, returns a pointer to the region of the same name.
41			* if it can't find a region of the same name it returns the first region
42			* with the 'fallback' property set.
43			* if it can't find a matching name /or/ a fallback region it logs an info message
44			* message and returns NULL
45			* used by the map parsing code.
46			*/
47	root	1.4	region *
48	root	1.41	region::find (shstr_cmp name)
49	root	1.4	{
50	root	1.21	for_all_regions (rgn)
51	root	1.41	if (rgn->name == name)
52	root	1.21	return rgn;
53	root	1.4
54	root	1.41	LOG (llevError, "region called %s requested, but not found, using fallback.\n", &name);
55	root	1.4
56	root	1.18	return default_region ();
57	elmex	1.1	}
58
59			/*
60			* Tries to find a region that 'name' corresponds to.
61			* It looks, in order, for:
62			* an exact match to region name (case insensitive)
63			* an exact match to longname (case insensitive)
64			* a substring that matches to the longname (eg Kingdom)
65			* a substring that matches to the region name (eg nav)
66			* if it can find none of these it returns the first parentless region
67			* (there should be only one of these - the top level one)
68			* If we got a NULL, then just return the top level region
69			*
70			*/
71	root	1.4	region *
72	root	1.19	region::find_fuzzy (const char *name)
73	root	1.4	{
74	root	1.21	if (!name)
75			return default_region ();
76	root	1.19
77	root	1.41	// TODO: bug, changes possibly const string
78	root	1.21	char *p = strchr (name, '\n');
79	root	1.4	if (p)
80			*p = '\0';
81	root	1.19
82	root	1.21	for_all_regions (rgn)
83	root	1.41	if (rgn->name.eq_nc (name))
84	root	1.21	return rgn;
85
86			for_all_regions (rgn)
87	root	1.41	if (rgn->longname.eq_nc (name))
88			return rgn;
89	root	1.21
90			for_all_regions (rgn)
91	root	1.41	if (rgn->longname.contains (name))
92			return rgn;
93	root	1.19
94	root	1.21	for_all_regions (rgn)
95	root	1.41	/*
96			* This is not a bug, we want the region that is most identifiably a discrete
97			* area in the game, eg if we have 'scor', we want to return 'scorn' and not
98			* 'scornarena', regardless of their order on the list so we only look at those
99			* regions with a longname set.
100			*/
101			if (rgn->longname && rgn->name.contains (name))
102			return rgn;
103	root	1.19
104	root	1.21	for_all_regions (rgn)
105	root	1.41	if (rgn->name.contains (name))
106			return rgn;
107	root	1.19
108	root	1.21	return default_region ();
109	elmex	1.1	}
110
111	root	1.35	void
112			region::do_destroy ()
113			{
114			regions.erase (this);
115
116			attachable::do_destroy ();
117
118			refcnt_dec ();
119			}
120
121	elmex	1.1	/*
122			* returns 1 if the player is in the region reg, or a child region thereof
123			* otherwise returns 0
124			* if passed a NULL region returns -1
125			*/
126	root	1.19	static int
127	root	1.4	region_is_child_of_region (const region * child, const region * r)
128			{
129	root	1.40	if (!r)
130	root	1.4	return -1;
131	root	1.19
132	root	1.40	if (!child)
133	root	1.4	return 0;
134	root	1.19
135	root	1.40	if (child->name == r->name)
136	root	1.4	return 1;
137	root	1.19
138	root	1.40	if (child->parent)
139	root	1.4	return region_is_child_of_region (child->parent, r);
140	root	1.40
141			return 0;
142	elmex	1.1	}
143
144			/** Returns an object which is an exit through which the player represented by op should be
145			* sent in order to be imprisoned. If there is no suitable place to which an exit can be
146			* constructed, then NULL will be returned. The caller is responsible for freeing the object
147			* created by this function.
148			*/
149	root	1.4	object *
150			get_jail_exit (object *op)
151			{
152			if (op->type != PLAYER)
153			{
154			LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
155			return NULL;
156			}
157	root	1.19
158	root	1.38	region *reg = op->region ();
159	root	1.19	while (reg)
160	root	1.4	{
161			if (reg->jailmap)
162			{
163	root	1.38	object *exit = object::create ();
164	root	1.4	EXIT_PATH (exit) = reg->jailmap;
165			/* damned exits reset savebed and remove teleports, so the prisoner can't escape */
166			SET_FLAG (exit, FLAG_DAMNED);
167			EXIT_X (exit) = reg->jailx;
168			EXIT_Y (exit) = reg->jaily;
169			return exit;
170	root	1.2	}
171	root	1.4	else
172			reg = reg->parent;
173	elmex	1.1	}
174	root	1.19
175	root	1.21	LOG (llevError, "No suitable jailmap for region %s was found.\n", &reg->name);
176
177			return 0;
178	elmex	1.1	}
179
180	root	1.25	region *
181	root	1.26	region::read (object_thawer &f)
182	root	1.19	{
183	root	1.26	assert (f.kw == KW_region);
184
185	root	1.21	region *rgn = new region;
186	root	1.35	rgn->refcnt_inc ();
187
188	root	1.25	f.get (rgn->name);
189	root	1.26	f.next ();
190	root	1.19
191	root	1.20	for (;;)
192			{
193	root	1.25	switch (f.kw)
194	root	1.20	{
195			case KW_parent:
196	root	1.25	rgn->parent = region::find (f.get_str ());
197	root	1.20	break;
198
199	root	1.31	case KW_msg: f.get_ml (KW_endmsg, rgn->msg); break;
200			case KW_longname: f.get (rgn->longname); break;
201			case KW_jail_map: f.get (rgn->jailmap); break;
202			case KW_jail_x: f.get (rgn->jailx); break;
203			case KW_jail_y: f.get (rgn->jaily); break;
204			case KW_portal_map: f.get (rgn->portalmap);break;
205			case KW_portal_x: f.get (rgn->portalx); break;
206			case KW_portal_y: f.get (rgn->portaly); break;
207			case KW_fallback: f.get (rgn->fallback); break;
208			case KW_chance: f.get (rgn->treasure_density); break;
209	root	1.30
210			case KW_randomitems:
211			rgn->treasure = treasurelist::get (f.get_str ());
212			break;
213	root	1.20
214	root	1.21	case KW_end:
215	root	1.29	f.next ();
216
217	root	1.35	// cannot use find as that will request the default region
218	root	1.25	for_all_regions (old)
219			if (old->name == rgn->name)
220			{
221	root	1.35	old->destroy ();
222			break;
223	root	1.25	}
224
225			// just append
226			regions.push_back (rgn);
227			return rgn;
228	root	1.21
229	root	1.34	case KW_ERROR:
230	root	1.36	rgn->set_key_text (f.kw_str, f.value);
231	root	1.34	//fprintf (stderr, "region addkv(%s,%s)\n", f.kw_str, f.value);//D
232			break;
233
234	root	1.21	default:
235	root	1.25	if (!f.parse_error ("region", rgn->name))
236			{
237	root	1.35	rgn->destroy ();
238	root	1.25	return 0;
239			}
240	root	1.21	break;
241	root	1.20	}
242	root	1.25
243	root	1.26	f.next ();
244	root	1.20	}
245			}
246
247			/*
248	elmex	1.1	* First initialises the archtype hash-table (init_archetable()).
249			* Reads and parses the archetype file (with the first and second-pass
250			* functions).
251			*/
252	root	1.4	void
253			init_regions (void)
254			{
255	root	1.21	if (!regions.size ())
256			{
257			// make sure one region is always available
258			region *rgn = new region;
259			rgn->name = "<builtin>";
260			rgn->longname = "Built-in Region";
261			regions.push_back (rgn);
262			}
263	elmex	1.1	}
264	root	1.24