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.14 by pippijn, Tue Jan 2 23:39:21 2007 UTC vs.
Revision 1.23 by root, Thu Feb 1 19:40:42 2007 UTC

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

Diff Legend

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