ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/common/region.C
(Generate patch)

Comparing deliantra/server/common/region.C (file contents):
Revision 1.8 by pippijn, Mon Dec 11 19:46:46 2006 UTC vs.
Revision 1.56 by root, Wed Nov 16 23:41:59 2016 UTC

1/* 1/*
2 CrossFire, A Multiplayer game for X-windows 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 3 *
4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
4 Copyright (C) 2001-2003 Mark Wedel & Crossfire Development Team 5 * Copyright (©) 2001-2003 Mark Wedel & Crossfire Development Team
5 Copyright (C) 1992 Frank Tore Johansen 6 * Copyright (©) 1992 Frank Tore Johansen
6 7 *
7 This program is free software; you can redistribute it and/or modify 8 * Deliantra is free software: you can redistribute it and/or modify it under
8 it under the terms of the GNU General Public License as published by 9 * the terms of the Affero GNU General Public License as published by the
9 the Free Software Foundation; either version 2 of the License, or 10 * Free Software Foundation, either version 3 of the License, or (at your
10 (at your option) any later version. 11 * option) any later version.
11 12 *
12 This program is distributed in the hope that it will be useful, 13 * This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details. 16 * GNU General Public License for more details.
16 17 *
17 You should have received a copy of the GNU General Public License 18 * You should have received a copy of the Affero GNU General Public License
18 along with this program; if not, write to the Free Software 19 * and the GNU General Public License along with this program. If not, see
19 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. 20 * <http://www.gnu.org/licenses/>.
20 21 *
21 The authors can be reached via e-mail at <crossfire@schmorp.de> 22 * The authors can be reached via e-mail to <support@deliantra.net>
22*/ 23 */
23
24 24
25#include <global.h> 25#include <global.h>
26#include <unistd.h> 26#include <unistd.h>
27 27
28/* 28regionvec regions;
29 * Pass a char array, returns a pointer to the region of the same name. 29
30 * if it can't find a region of the same name it returns the first region
31 * with the 'fallback' property set.
32 * if it can't find a matching name /or/ a fallback region it logs an info message
33 * message and returns NULL
34 * used by the map parsing code.
35 */
36region * 30region *
37get_region_by_name (const char *region_name) 31region::default_region ()
38{ 32{
39 region *reg; 33 for_all_regions (rgn)
40 char *p = strchr (region_name, '\n'); 34 if (rgn->fallback)
41
42 if (p)
43 *p = '\0';
44 for (reg = first_region; reg != NULL; reg = reg->next)
45 if (!strcmp (reg->name, region_name))
46 return reg; 35 return rgn;
47 36
48 for (reg = first_region; reg != NULL; reg = reg->next) 37 return regions [0];
49 {
50 if (reg->fallback)
51 {
52 LOG (llevDebug, "region called %s requested, but not found, fallback used.\n", region_name);
53 return reg;
54 }
55 }
56 LOG (llevInfo, "Got no region or fallback for region %s.\n", region_name);
57 return NULL;
58} 38}
59 39
60/* This might need optimising at some point. */
61region * 40region *
62get_region_by_map (maptile *m) 41region::find (shstr_cmp name)
63{ 42{
64 return get_region_by_name (get_name_of_region_for_map (m)); 43 for_all_regions (rgn)
65} 44 if (rgn->name == name)
66
67/*
68 * Since we won't assume all maps have a region set properly, we need an
69 * explicit check that it is, this is much nicer here than scattered throughout
70 * the map code.
71 */
72
73const char *
74get_name_of_region_for_map (const maptile *m)
75{
76 region *reg;
77
78 if (m->region != NULL)
79 return m->region->name;
80 for (reg = first_region; reg != NULL; reg = reg->next)
81 {
82 if (reg->fallback)
83 return reg->name;
84 }
85 LOG (llevInfo, "map %s had no region and I couldn't find a fallback to use.\n", m->name);
86 return "unknown";
87}
88
89/*
90 * Tries to find a region that 'name' corresponds to.
91 * It looks, in order, for:
92 * an exact match to region name (case insensitive)
93 * an exact match to longname (case insensitive)
94 * a substring that matches to the longname (eg Kingdom)
95 * a substring that matches to the region name (eg nav)
96 * if it can find none of these it returns the first parentless region
97 * (there should be only one of these - the top level one)
98 * If we got a NULL, then just return the top level region
99 *
100 */
101region *
102get_region_from_string (const char *name)
103{
104 region *reg;
105 char *substr;
106 char *p;
107
108 if (name == NULL)
109 {
110 for (reg = first_region; reg->parent != NULL; reg = reg->parent);
111 return reg; 45 return rgn;
112 }
113 p = strchr (name, '\n');
114 if (p)
115 *p = '\0';
116 for (reg = first_region; reg != NULL; reg = reg->next)
117 if (!strcasecmp (reg->name, name))
118 return reg;
119 46
120 for (reg = first_region; reg != NULL; reg = reg->next) 47 return default_region ();
121 if (reg->longname != NULL) 48}
49
50void
51object_thawer::get (region_ptr &r) const
52{
53 shstr_cmp name = get_str ();
54
55 for_all_regions (rgn)
56 if (rgn->name == name)
122 { 57 {
123 if (!strcasecmp (reg->longname, name)) 58 r = rgn;
124 return reg; 59 return;
125 } 60 }
126 61
127 substr = NULL; 62 parse_error (format ("region called %s requested, but not found, using fallback.\n", get_str ()));
128 for (reg = first_region; reg != NULL; reg = reg->next) 63
129 if (reg->longname != NULL) 64 r = region::default_region ();
130 {
131 substr = strstr (reg->longname, name);
132 if (substr != NULL)
133 return reg;
134 }
135 for (reg = first_region; reg != NULL; reg = reg->next)
136 if (reg->longname != NULL)
137 {
138 /*
139 * This is not a bug, we want the region that is most identifiably a discrete
140 * area in the game, eg if we have 'scor', we want to return 'scorn' and not
141 * 'scornarena', regardless of their order on the list so we only look at those
142 * regions with a longname set.
143 */
144 substr = strstr (reg->name, name);
145 if (substr != NULL)
146 return reg;
147 }
148 for (reg = first_region; reg != NULL; reg = reg->next)
149 {
150 substr = strstr (reg->name, name);
151 if (substr != NULL)
152 return reg;
153 }
154 /* if we are still here, we are going to have to give up, and give the top level region */
155 for (reg = first_region; reg->parent != NULL; reg = reg->parent);
156 return reg;
157} 65}
66
67void
68region::do_destroy ()
69{
70 regions.erase (this);
71
72 attachable::do_destroy ();
73
74 refcnt_dec ();
75}
76
77//+GPL
158 78
159/* 79/*
160 * returns 1 if the player is in the region reg, or a child region thereof 80 * returns 1 if the player is in the region reg, or a child region thereof
161 * otherwise returns 0 81 * otherwise returns 0
162 * if passed a NULL region returns -1 82 * if passed a NULL region returns -1
163 */ 83 */
164 84static int
165int
166region_is_child_of_region (const region * child, const region * r) 85region_is_child_of_region (const region * child, const region * r)
167{ 86{
168 87 if (!r)
169 if (r == NULL)
170 return -1; 88 return -1;
171 if (child == NULL) 89
90 if (!child)
172 return 0; 91 return 0;
92
173 if (!strcmp (child->name, r->name)) 93 if (child->name == r->name)
174 return 1; 94 return 1;
95
175 else if (child->parent != NULL) 96 if (child->parent)
176 return region_is_child_of_region (child->parent, r); 97 return region_is_child_of_region (child->parent, r);
177 else 98
178 return 0; 99 return 0;
179}
180
181/*
182 * the longname of a region is not a required field, any given region
183 * may want to not set it and use the parent's one instead. so, we:
184 * 1. check if a longname is set and if so return it.
185 * 2. check if there is a parent and try and call the function against that
186 * 3. return a obviously wrong string if we can't get a longname, this should
187 * never happen. We also log a debug message.
188 */
189const char *
190get_region_longname (const region * r)
191{
192
193 if (r->longname != NULL)
194 return r->longname;
195 else if (r->parent != NULL)
196 return get_region_longname (r->parent);
197 else
198 {
199 LOG (llevDebug, "NOTICE region %s has no parent and no longname.\n", r->name);
200 return "no name can be found for the current region";
201 }
202}
203
204const char *
205get_region_msg (const region * r)
206{
207 if (r->msg != NULL)
208 return r->msg;
209 else if (r->parent != NULL)
210 return get_region_msg (r->parent);
211 else
212 {
213 LOG (llevDebug, "NOTICE region %s has no parent and no msg.\n", r->name);
214 return "no description can be found for the current region";
215 }
216} 100}
217 101
218/** Returns an object which is an exit through which the player represented by op should be 102/** Returns an object which is an exit through which the player represented by op should be
219 * sent in order to be imprisoned. If there is no suitable place to which an exit can be 103 * sent in order to be imprisoned. If there is no suitable place to which an exit can be
220 * constructed, then NULL will be returned. The caller is responsible for freeing the object 104 * constructed, then NULL will be returned. The caller is responsible for freeing the object
221 * created by this function. 105 * created by this function.
222 */ 106 */
223object * 107object *
224get_jail_exit (object *op) 108get_jail_exit (object *op)
225{ 109{
226 region *reg;
227 object *exit;
228
229 if (op->type != PLAYER) 110 if (op->type != PLAYER)
230 { 111 {
231 LOG (llevError, "region.c: get_jail_exit called against non-player object.\n"); 112 LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
232 return NULL; 113 return NULL;
233 } 114 }
234 reg = get_region_by_map (op->map); 115
116 region *reg = op->region ();
235 while (reg != NULL) 117 while (reg)
236 { 118 {
237 if (reg->jailmap) 119 if (reg->jailmap)
238 { 120 {
239 exit = get_object (); 121 object *exit = object::create ();
240 EXIT_PATH (exit) = reg->jailmap; 122 EXIT_PATH (exit) = reg->jailmap;
241 /* damned exits reset savebed and remove teleports, so the prisoner can't escape */ 123 /* damned exits reset savebed and remove teleports, so the prisoner can't escape */
242 SET_FLAG (exit, FLAG_DAMNED); 124 exit->set_flag (FLAG_DAMNED);
243 EXIT_X (exit) = reg->jailx; 125 EXIT_X (exit) = reg->jailx;
244 EXIT_Y (exit) = reg->jaily; 126 EXIT_Y (exit) = reg->jaily;
245 return exit; 127 return exit;
246 } 128 }
247 else 129 else
248 reg = reg->parent; 130 reg = reg->parent;
249 } 131 }
132
250 LOG (llevDebug, "No suitable jailmap for region %s was found.\n", reg->name); 133 LOG (llevError, "No suitable jailmap for region %s was found.\n", &reg->name);
251 return NULL;
252}
253 134
254/*
255 * First initialises the archtype hash-table (init_archetable()).
256 * Reads and parses the archetype file (with the first and second-pass
257 * functions).
258 * Then initialises treasures by calling load_treasures().
259 */
260void
261init_regions (void)
262{
263 FILE *fp;
264 char filename[MAX_BUF];
265 int comp;
266
267 if (first_region != NULL) /* Only do this once */
268 return; 135 return 0;
136}
269 137
270 sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions); 138//-GPL
271 LOG (llevDebug, "Reading regions from %s...\n", filename); 139
272 if ((fp = open_and_uncompress (filename, 0, &comp)) == NULL) 140region *
141region::read (object_thawer &f)
142{
143 assert (f.kw == KW_region);
144
145 region *rgn = new region;
146 rgn->refcnt_inc ();
147
148 f.get (rgn->name);
149 f.next ();
150
151 for (;;)
273 { 152 {
274 LOG (llevError, " Can't open regions file %s in init_regions.\n", filename); 153 switch (f.kw)
275 return; 154 {
155 case KW_parent:
156 f.get (rgn->parent);
157 break;
158
159 case KW_msg: f.get_ml (KW_endmsg, rgn->msg); break;
160 case KW_longname: f.get (rgn->longname); break;
161 case KW_jail_map: f.get (rgn->jailmap); break;
162 case KW_jail_x: f.get (rgn->jailx); break;
163 case KW_jail_y: f.get (rgn->jaily); break;
164 case KW_portal_map: f.get (rgn->portalmap);break;
165 case KW_fallback: f.get (rgn->fallback); break;
166 case KW_chance: f.get (rgn->treasure_density); break;
167
168 case KW_randomitems:
169 rgn->treasure = treasurelist::get (f.get_str ());
170 break;
171
172 case KW_end:
173 f.next ();
174
175 // cannot use find as that will request the default region
176 for_all_regions (old)
177 if (old->name == rgn->name)
178 {
179 old->destroy ();
180 break;
181 }
182
183 // just append
184 regions.push_back (rgn);
185 return rgn;
186
187 case KW_ERROR:
188 rgn->set_key_text (f.kw_str, f.value);
189 //fprintf (stderr, "region addkv(%s,%s)\n", f.kw_str, f.value);//D
190 break;
191
192 default:
193 if (!f.parse_error ("region", rgn->name))
194 {
195 rgn->destroy ();
196 return 0;
197 }
198 break;
199 }
200
201 f.next ();
276 } 202 }
277 parse_regions (fp);
278 assign_region_parents ();
279 LOG (llevDebug, " done\n");
280
281 close_and_delete (fp, comp);
282} 203}
283 204
284/*
285 * Allocates and zeros a region struct, this isn't free()'d anywhere, so might
286 * be a memory leak, but it shouldn't matter too much since it isn't called that
287 * often....
288 */
289
290region *
291get_region_struct (void)
292{
293
294 region *reg;
295
296 reg = (region *) CALLOC (1, sizeof (region));
297 if (reg == NULL)
298 fatal (OUT_OF_MEMORY);
299
300 memset (reg, '\0', sizeof (region));
301
302 return reg;
303}
304
305/*
306 * Reads/parses the region file, and copies into a linked list
307 * of region structs.
308 */
309void
310parse_regions (FILE * fp)
311{
312 region *newreg;
313 region *reg;
314
315 char buf[HUGE_BUF], msgbuf[HUGE_BUF], *key = NULL, *value, *end;
316 int msgpos = 0;
317
318 newreg = NULL;
319 while (fgets (buf, HUGE_BUF - 1, fp) != NULL)
320 {
321 buf[HUGE_BUF - 1] = 0;
322 key = buf;
323 while (isspace (*key))
324 key++;
325 if (*key == 0)
326 continue; /* empty line */
327 value = strchr (key, ' ');
328 if (!value)
329 {
330 end = strchr (key, '\n');
331 *end = 0;
332 }
333 else
334 {
335 *value = 0;
336 value++;
337 while (isspace (*value))
338 value++;
339 end = strchr (value, '\n');
340 }
341
342 /*
343 * This is a bizzare mutated form of the map and archetype parser
344 * rolled into one. Key is the field name, value is what it should
345 * be set to.
346 * We've already done the work to null terminate key,
347 * and strip off any leading spaces for both of these.
348 * We have not touched the newline at the end of the line -
349 * these might be needed for some values. the end pointer
350 * points to the first of the newlines.
351 * value could be NULL! It would be easy enough to just point
352 * this to "" to prevent cores, but that would let more errors slide
353 * through.
354 */
355 if (!strcmp (key, "region"))
356 {
357 *end = 0;
358 newreg = get_region_struct ();
359 newreg->name = strdup_local (value);
360 }
361 else if (!strcmp (key, "parent"))
362 {
363 /*
364 * Note that this is in the initialisation code, so we don't actually
365 * assign the pointer to the parent yet, because it might not have been
366 * parsed.
367 */
368 *end = 0;
369 newreg->parent_name = strdup_local (value);
370 }
371 else if (!strcmp (key, "longname"))
372 {
373 *end = 0;
374 newreg->longname = strdup_local (value);
375 }
376 else if (!strcmp (key, "jail"))
377 {
378 /* jail entries are of the form: /path/to/map x y */
379 char path[MAX_BUF];
380 int x, y;
381
382 if (sscanf (value, "%[^ ] %d %d\n", path, &x, &y) != 3)
383 {
384 LOG (llevError, "region.c: malformated regions entry: jail %s\n", value);
385 continue;
386 }
387 newreg->jailmap = strdup_local (path);
388 newreg->jailx = x;
389 newreg->jaily = y;
390 }
391 else if (!strcmp (key, "msg"))
392 {
393 while (fgets (buf, HUGE_BUF - 1, fp) != NULL)
394 {
395 if (!strcmp (buf, "endmsg\n"))
396 break;
397 else
398 {
399 strcpy (msgbuf + msgpos, buf);
400 msgpos += strlen (buf);
401 }
402 }
403 /*
404 * There may be regions with empty messages (eg, msg/endmsg
405 * with nothing between). When maps are loaded, this is done
406 * so better do it here too...
407 */
408 if (msgpos != 0)
409 newreg->msg = strdup_local (msgbuf);
410
411 /* we have to reset msgpos, or the next region will store both msg blocks. */
412 msgpos = 0;
413 }
414 else if (!strcmp (key, "fallback"))
415 {
416 *end = 0;
417 newreg->fallback = atoi (value);
418 }
419 else if (!strcmp (key, "end"))
420 {
421 /* Place this new region last on the list, if the list is empty put it first */
422 for (reg = first_region; reg != NULL && reg->next != NULL; reg = reg->next);
423
424 if (reg == NULL)
425 first_region = newreg;
426 else
427 reg->next = newreg;
428 newreg = NULL;
429 }
430 else if (!strcmp (key, "nomore"))
431 {
432 /* we have reached the end of the region specs.... */
433 break;
434 }
435 else
436 {
437 /* we should never get here, if we have, then something is wrong */
438 LOG (llevError, "Got unknown value in region file: %s %s\n", key, value);
439 }
440 }
441 if (!key || strcmp (key, "nomore"))
442 LOG (llevError, "Got premature eof on regions file!\n");
443}
444
445void
446assign_region_parents (void)
447{
448 region *reg;
449 uint32 parent_count = 0;
450 uint32 region_count = 0;
451
452 for (reg = first_region; reg != NULL && reg->next != NULL; reg = reg->next)
453 {
454 if (reg->parent_name != NULL)
455 {
456 reg->parent = get_region_by_name (reg->parent_name);
457 parent_count++;
458 }
459 region_count++;
460 }
461 LOG (llevDebug, "Assigned %u regions with %u parents.", region_count, parent_count);
462}

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines