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.4 by root, Sun Sep 10 16:00:23 2006 UTC vs.
Revision 1.23 by root, Thu Feb 1 19:40:42 2007 UTC

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

Diff Legend

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