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 Affero 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 Affero GNU General Public License
 * and 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 ();
}

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.43
Committed:	Mon Oct 12 14:00:57 2009 UTC (14 years, 7 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_82, rel-2_81
Changes since 1.42:	+7 -6 lines
Log Message:	clarify license
#	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.43	* Deliantra is free software: you can redistribute it and/or modify it under
9			* the terms of the Affero GNU General Public License as published by the
10			* Free Software Foundation, either version 3 of the License, or (at your
11			* 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.43	* You should have received a copy of the Affero GNU General Public License
19			* and the GNU General Public License along with this program. If not, see
20			* <http://www.gnu.org/licenses/>.
21	root	1.32	*
22	root	1.37	* The authors can be reached via e-mail to <support@deliantra.net>
23	pippijn	1.16	*/
24	elmex	1.1
25			#include <global.h>
26	pippijn	1.8	#include <unistd.h>
27	root	1.4
28	root	1.21	regionvec regions;
29
30	root	1.18	region *
31			region::default_region ()
32			{
33	root	1.21	for_all_regions (rgn)
34			if (rgn->fallback)
35			return rgn;
36	root	1.18
37	root	1.21	return regions [0];
38	root	1.18	}
39
40	elmex	1.1	/*
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	root	1.4	region *
49	root	1.41	region::find (shstr_cmp name)
50	root	1.4	{
51	root	1.21	for_all_regions (rgn)
52	root	1.41	if (rgn->name == name)
53	root	1.21	return rgn;
54	root	1.4
55	root	1.41	LOG (llevError, "region called %s requested, but not found, using fallback.\n", &name);
56	root	1.4
57	root	1.18	return default_region ();
58	elmex	1.1	}
59
60	root	1.35	void
61			region::do_destroy ()
62			{
63			regions.erase (this);
64
65			attachable::do_destroy ();
66
67			refcnt_dec ();
68			}
69
70	elmex	1.1	/*
71			* returns 1 if the player is in the region reg, or a child region thereof
72			* otherwise returns 0
73			* if passed a NULL region returns -1
74			*/
75	root	1.19	static int
76	root	1.4	region_is_child_of_region (const region * child, const region * r)
77			{
78	root	1.40	if (!r)
79	root	1.4	return -1;
80	root	1.19
81	root	1.40	if (!child)
82	root	1.4	return 0;
83	root	1.19
84	root	1.40	if (child->name == r->name)
85	root	1.4	return 1;
86	root	1.19
87	root	1.40	if (child->parent)
88	root	1.4	return region_is_child_of_region (child->parent, r);
89	root	1.40
90			return 0;
91	elmex	1.1	}
92
93			/** Returns an object which is an exit through which the player represented by op should be
94			* sent in order to be imprisoned. If there is no suitable place to which an exit can be
95			* constructed, then NULL will be returned. The caller is responsible for freeing the object
96			* created by this function.
97			*/
98	root	1.4	object *
99			get_jail_exit (object *op)
100			{
101			if (op->type != PLAYER)
102			{
103			LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
104			return NULL;
105			}
106	root	1.19
107	root	1.38	region *reg = op->region ();
108	root	1.19	while (reg)
109	root	1.4	{
110			if (reg->jailmap)
111			{
112	root	1.38	object *exit = object::create ();
113	root	1.4	EXIT_PATH (exit) = reg->jailmap;
114			/* damned exits reset savebed and remove teleports, so the prisoner can't escape */
115			SET_FLAG (exit, FLAG_DAMNED);
116			EXIT_X (exit) = reg->jailx;
117			EXIT_Y (exit) = reg->jaily;
118			return exit;
119	root	1.2	}
120	root	1.4	else
121			reg = reg->parent;
122	elmex	1.1	}
123	root	1.19
124	root	1.21	LOG (llevError, "No suitable jailmap for region %s was found.\n", &reg->name);
125
126			return 0;
127	elmex	1.1	}
128
129	root	1.25	region *
130	root	1.26	region::read (object_thawer &f)
131	root	1.19	{
132	root	1.26	assert (f.kw == KW_region);
133
134	root	1.21	region *rgn = new region;
135	root	1.35	rgn->refcnt_inc ();
136
137	root	1.25	f.get (rgn->name);
138	root	1.26	f.next ();
139	root	1.19
140	root	1.20	for (;;)
141			{
142	root	1.25	switch (f.kw)
143	root	1.20	{
144			case KW_parent:
145	root	1.25	rgn->parent = region::find (f.get_str ());
146	root	1.20	break;
147
148	root	1.31	case KW_msg: f.get_ml (KW_endmsg, rgn->msg); break;
149			case KW_longname: f.get (rgn->longname); break;
150			case KW_jail_map: f.get (rgn->jailmap); break;
151			case KW_jail_x: f.get (rgn->jailx); break;
152			case KW_jail_y: f.get (rgn->jaily); break;
153			case KW_portal_map: f.get (rgn->portalmap);break;
154			case KW_portal_x: f.get (rgn->portalx); break;
155			case KW_portal_y: f.get (rgn->portaly); break;
156			case KW_fallback: f.get (rgn->fallback); break;
157			case KW_chance: f.get (rgn->treasure_density); break;
158	root	1.30
159			case KW_randomitems:
160			rgn->treasure = treasurelist::get (f.get_str ());
161			break;
162	root	1.20
163	root	1.21	case KW_end:
164	root	1.29	f.next ();
165
166	root	1.35	// cannot use find as that will request the default region
167	root	1.25	for_all_regions (old)
168			if (old->name == rgn->name)
169			{
170	root	1.35	old->destroy ();
171			break;
172	root	1.25	}
173
174			// just append
175			regions.push_back (rgn);
176			return rgn;
177	root	1.21
178	root	1.34	case KW_ERROR:
179	root	1.36	rgn->set_key_text (f.kw_str, f.value);
180	root	1.34	//fprintf (stderr, "region addkv(%s,%s)\n", f.kw_str, f.value);//D
181			break;
182
183	root	1.21	default:
184	root	1.25	if (!f.parse_error ("region", rgn->name))
185			{
186	root	1.35	rgn->destroy ();
187	root	1.25	return 0;
188			}
189	root	1.21	break;
190	root	1.20	}
191	root	1.25
192	root	1.26	f.next ();
193	root	1.20	}
194			}
195
196			/*
197	elmex	1.1	* First initialises the archtype hash-table (init_archetable()).
198			* Reads and parses the archetype file (with the first and second-pass
199			* functions).
200			*/
201	root	1.4	void
202			init_regions (void)
203			{
204	root	1.21	if (!regions.size ())
205			{
206			// make sure one region is always available
207			region *rgn = new region;
208			rgn->name = "<builtin>";
209			rgn->longname = "Built-in Region";
210			regions.push_back (rgn);
211			}
212	elmex	1.1	}
213	root	1.24