server/common/region.C

/*
 * CrossFire, A Multiplayer game for X-windows
 * 
 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
 * Copyright (C) 2001-2003 Mark Wedel & Crossfire Development Team
 * Copyright (C) 1992 Frank Tore Johansen
 * 
 * This program 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 2 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, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 * The authors can be reached via e-mail at <crossfire@schmorp.de>
 */

#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 (const char *name)
{
  for_all_regions (rgn)
    if (!strcmp (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 ();

  char *p = strchr (name, '\n');
  if (p)
    *p = '\0';

  for_all_regions (rgn)
    if (!strcasecmp (rgn->name, name))
      return rgn;

  for_all_regions (rgn)
    if (rgn->longname)
      if (!strcasecmp (rgn->longname, name))
        return rgn;

  for_all_regions (rgn)
    if (rgn->longname)
      {
        if (strstr (rgn->longname, name))
          return rgn;
      }

  for_all_regions (rgn)
    if (rgn->longname)
      {
        /* 
         * 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 (strstr (rgn->name, name))
          return rgn;
      }

  for_all_regions (rgn)
    {
      if (strstr (rgn->name, name))
        return rgn;
    }

  return default_region ();
}

/* 
 * 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 == 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;
}

/** 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)
{
  region *reg;
  object *exit;

  if (op->type != PLAYER)
    {
      LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
      return NULL;
    }

  reg = op->region ();
  while (reg)
    {
      if (reg->jailmap)
        {
          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;
  f.get (rgn->name);
  f.next ();

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

          case KW_longname: f.get (rgn->longname); break;
          case KW_match:    f.get (rgn->match);    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_fallback: f.get (rgn->fallback); break;
          case KW_msg:      f.get_ml (KW_endmsg, rgn->msg); break;

          case KW_end:
            f.next ();

            for_all_regions (old)
              if (old->name == rgn->name)
                {
                  // replace, copy new values (ugly)
                  rgn->index = old->index;
                  *old = *rgn;
                  delete rgn;

                  return old;
                }

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

          default:
            if (!f.parse_error ("region", rgn->name))
              {
                delete rgn;
                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.29
Committed:	Tue Apr 17 18:24:30 2007 UTC (17 years, 1 month ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.28:	+2 -0 lines
Log Message:	- treasurelists and regions can now be freely mixed within the same generic resource file. more to come.
#	Content
1	/*
2	* CrossFire, A Multiplayer game for X-windows
3	*
4	* Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5	* Copyright (C) 2001-2003 Mark Wedel & Crossfire Development Team
6	* Copyright (C) 1992 Frank Tore Johansen
7	*
8	* This program is free software; you can redistribute it and/or modify
9	* it under the terms of the GNU General Public License as published by
10	* the Free Software Foundation; either version 2 of the License, or
11	* (at your option) any later version.
12	*
13	* 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	*
18	* You should have received a copy of the GNU General Public License
19	* along with this program; if not, write to the Free Software
20	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21	*
22	* The authors can be reached via e-mail at <crossfire@schmorp.de>
23	*/
24
25	#include <global.h>
26	#include <unistd.h>
27
28	regionvec regions;
29
30	region *
31	region::default_region ()
32	{
33	for_all_regions (rgn)
34	if (rgn->fallback)
35	return rgn;
36
37	return regions [0];
38	}
39
40	/*
41	* Pass a char array, returns a pointer to the region of the same name.
42	* if it can't find a region of the same name it returns the first region
43	* with the 'fallback' property set.
44	* if it can't find a matching name /or/ a fallback region it logs an info message
45	* message and returns NULL
46	* used by the map parsing code.
47	*/
48	region *
49	region::find (const char *name)
50	{
51	for_all_regions (rgn)
52	if (!strcmp (rgn->name, name))
53	return rgn;
54
55	LOG (llevError, "region called %s requested, but not found, using fallback.\n", name);
56
57	return default_region ();
58	}
59
60	/*
61	* Tries to find a region that 'name' corresponds to.
62	* It looks, in order, for:
63	* an exact match to region name (case insensitive)
64	* an exact match to longname (case insensitive)
65	* a substring that matches to the longname (eg Kingdom)
66	* a substring that matches to the region name (eg nav)
67	* if it can find none of these it returns the first parentless region
68	* (there should be only one of these - the top level one)
69	* If we got a NULL, then just return the top level region
70	*
71	*/
72	region *
73	region::find_fuzzy (const char *name)
74	{
75	if (!name)
76	return default_region ();
77
78	char *p = strchr (name, '\n');
79	if (p)
80	*p = '\0';
81
82	for_all_regions (rgn)
83	if (!strcasecmp (rgn->name, name))
84	return rgn;
85
86	for_all_regions (rgn)
87	if (rgn->longname)
88	if (!strcasecmp (rgn->longname, name))
89	return rgn;
90
91	for_all_regions (rgn)
92	if (rgn->longname)
93	{
94	if (strstr (rgn->longname, name))
95	return rgn;
96	}
97
98	for_all_regions (rgn)
99	if (rgn->longname)
100	{
101	/*
102	* This is not a bug, we want the region that is most identifiably a discrete
103	* area in the game, eg if we have 'scor', we want to return 'scorn' and not
104	* 'scornarena', regardless of their order on the list so we only look at those
105	* regions with a longname set.
106	*/
107	if (strstr (rgn->name, name))
108	return rgn;
109	}
110
111	for_all_regions (rgn)
112	{
113	if (strstr (rgn->name, name))
114	return rgn;
115	}
116
117	return default_region ();
118	}
119
120	/*
121	* returns 1 if the player is in the region reg, or a child region thereof
122	* otherwise returns 0
123	* if passed a NULL region returns -1
124	*/
125
126	static int
127	region_is_child_of_region (const region * child, const region * r)
128	{
129
130	if (r == NULL)
131	return -1;
132
133	if (child == NULL)
134	return 0;
135
136	if (!strcmp (child->name, r->name))
137	return 1;
138
139	else if (child->parent != NULL)
140	return region_is_child_of_region (child->parent, r);
141	else
142	return 0;
143	}
144
145	/** Returns an object which is an exit through which the player represented by op should be
146	* sent in order to be imprisoned. If there is no suitable place to which an exit can be
147	* constructed, then NULL will be returned. The caller is responsible for freeing the object
148	* created by this function.
149	*/
150	object *
151	get_jail_exit (object *op)
152	{
153	region *reg;
154	object *exit;
155
156	if (op->type != PLAYER)
157	{
158	LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
159	return NULL;
160	}
161
162	reg = op->region ();
163	while (reg)
164	{
165	if (reg->jailmap)
166	{
167	exit = object::create ();
168	EXIT_PATH (exit) = reg->jailmap;
169	/* damned exits reset savebed and remove teleports, so the prisoner can't escape */
170	SET_FLAG (exit, FLAG_DAMNED);
171	EXIT_X (exit) = reg->jailx;
172	EXIT_Y (exit) = reg->jaily;
173	return exit;
174	}
175	else
176	reg = reg->parent;
177	}
178
179	LOG (llevError, "No suitable jailmap for region %s was found.\n", &reg->name);
180
181	return 0;
182	}
183
184	region *
185	region::read (object_thawer &f)
186	{
187	assert (f.kw == KW_region);
188
189	region *rgn = new region;
190	f.get (rgn->name);
191	f.next ();
192
193	for (;;)
194	{
195	switch (f.kw)
196	{
197	case KW_parent:
198	rgn->parent = region::find (f.get_str ());
199	break;
200
201	case KW_longname: f.get (rgn->longname); break;
202	case KW_match: f.get (rgn->match); break;
203	case KW_jail_map: f.get (rgn->jailmap); break;
204	case KW_jail_x: f.get (rgn->jailx); break;
205	case KW_jail_y: f.get (rgn->jaily); break;
206	case KW_fallback: f.get (rgn->fallback); break;
207	case KW_msg: f.get_ml (KW_endmsg, rgn->msg); break;
208
209	case KW_end:
210	f.next ();
211
212	for_all_regions (old)
213	if (old->name == rgn->name)
214	{
215	// replace, copy new values (ugly)
216	rgn->index = old->index;
217	old = rgn;
218	delete rgn;
219
220	return old;
221	}
222
223	// just append
224	regions.push_back (rgn);
225	return rgn;
226
227	default:
228	if (!f.parse_error ("region", rgn->name))
229	{
230	delete rgn;
231	return 0;
232	}
233	break;
234	}
235
236	f.next ();
237	}
238	}
239
240	/*
241	* First initialises the archtype hash-table (init_archetable()).
242	* Reads and parses the archetype file (with the first and second-pass
243	* functions).
244	*/
245	void
246	init_regions (void)
247	{
248	if (!regions.size ())
249	{
250	// make sure one region is always available
251	region *rgn = new region;
252	rgn->name = "<builtin>";
253	rgn->longname = "Built-in Region";
254	regions.push_back (rgn);
255	}
256	}
257