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.11 by root, Thu Dec 14 22:45:40 2006 UTC vs.
Revision 1.20 by root, Mon Jan 29 15:04:21 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
28region *
29region::default_region ()
30{
31 for (region *reg = first_region; reg; reg = reg->next)
32 if (reg->fallback)
33 return reg;
34
35 return first_region;
36}
27 37
28/* 38/*
29 * Pass a char array, returns a pointer to the region of the same name. 39 * 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 40 * if it can't find a region of the same name it returns the first region
31 * with the 'fallback' property set. 41 * with the 'fallback' property set.
32 * if it can't find a matching name /or/ a fallback region it logs an info message 42 * if it can't find a matching name /or/ a fallback region it logs an info message
33 * message and returns NULL 43 * message and returns NULL
34 * used by the map parsing code. 44 * used by the map parsing code.
35 */ 45 */
36region * 46region *
37get_region_by_name (const char *region_name) 47region::find (const char *name)
38{ 48{
39 region *reg;
40 char *p = strchr (region_name, '\n');
41
42 if (p)
43 *p = '\0';
44 for (reg = first_region; reg != NULL; reg = reg->next) 49 for (region *reg = first_region; reg; reg = reg->next)
45 if (!strcmp (reg->name, region_name)) 50 if (!strcmp (reg->name, name))
46 return reg; 51 return reg;
47 52
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); 53 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 54
60/* This might need optimising at some point. */ 55 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 != 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} 56}
88 57
89/* 58/*
90 * Tries to find a region that 'name' corresponds to. 59 * Tries to find a region that 'name' corresponds to.
91 * It looks, in order, for: 60 * It looks, in order, for:
… …
97 * (there should be only one of these - the top level one) 66 * (there should be only one of these - the top level one)
98 * If we got a NULL, then just return the top level region 67 * If we got a NULL, then just return the top level region
99 * 68 *
100 */ 69 */
101region * 70region *
102get_region_from_string (const char *name) 71region::find_fuzzy (const char *name)
103{ 72{
104 region *reg; 73 region *reg;
105 char *substr; 74 char *substr;
106 char *p; 75 char *p;
107 76
108 if (name == NULL) 77 if (name == NULL)
109 { 78 {
110 for (reg = first_region; reg->parent != NULL; reg = reg->parent); 79 for (reg = first_region; reg->parent; reg = reg->parent)
80 ;
81
111 return reg; 82 return reg;
112 } 83 }
84
113 p = strchr (name, '\n'); 85 p = strchr (name, '\n');
114 if (p) 86 if (p)
115 *p = '\0'; 87 *p = '\0';
88
116 for (reg = first_region; reg != NULL; reg = reg->next) 89 for (reg = first_region; reg; reg = reg->next)
117 if (!strcasecmp (reg->name, name)) 90 if (!strcasecmp (reg->name, name))
118 return reg; 91 return reg;
119 92
120 for (reg = first_region; reg != NULL; reg = reg->next) 93 for (reg = first_region; reg; reg = reg->next)
121 if (reg->longname != NULL) 94 if (reg->longname)
95 if (!strcasecmp (reg->longname, name))
96 return reg;
97
98 substr = NULL;
99 for (reg = first_region; reg; reg = reg->next)
100 if (reg->longname)
122 { 101 {
123 if (!strcasecmp (reg->longname, name)) 102 substr = strstr (reg->longname, name);
103 if (substr)
124 return reg; 104 return reg;
125 } 105 }
126 106
127 substr = NULL;
128 for (reg = first_region; reg != NULL; reg = reg->next) 107 for (reg = first_region; reg; reg = reg->next)
129 if (reg->longname != NULL) 108 if (reg->longname)
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 { 109 {
138 /* 110 /*
139 * This is not a bug, we want the region that is most identifiably a discrete 111 * 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 112 * 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 113 * 'scornarena', regardless of their order on the list so we only look at those
142 * regions with a longname set. 114 * regions with a longname set.
143 */ 115 */
144 substr = strstr (reg->name, name); 116 substr = strstr (reg->name, name);
145 if (substr != NULL) 117 if (substr)
146 return reg; 118 return reg;
147 } 119 }
120
148 for (reg = first_region; reg != NULL; reg = reg->next) 121 for (reg = first_region; reg; reg = reg->next)
149 { 122 {
150 substr = strstr (reg->name, name); 123 substr = strstr (reg->name, name);
151 if (substr != NULL) 124 if (substr)
152 return reg; 125 return reg;
153 } 126 }
127
154 /* if we are still here, we are going to have to give up, and give the top level region */ 128 /* 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); 129 for (reg = first_region; reg->parent; reg = reg->parent)
130 ;
131
156 return reg; 132 return reg;
157} 133}
158 134
159/* 135/*
160 * returns 1 if the player is in the region reg, or a child region thereof 136 * returns 1 if the player is in the region reg, or a child region thereof
161 * otherwise returns 0 137 * otherwise returns 0
162 * if passed a NULL region returns -1 138 * if passed a NULL region returns -1
163 */ 139 */
164 140
165int 141static int
166region_is_child_of_region (const region * child, const region * r) 142region_is_child_of_region (const region * child, const region * r)
167{ 143{
168 144
169 if (r == NULL) 145 if (r == NULL)
170 return -1; 146 return -1;
147
171 if (child == NULL) 148 if (child == NULL)
172 return 0; 149 return 0;
150
173 if (!strcmp (child->name, r->name)) 151 if (!strcmp (child->name, r->name))
174 return 1; 152 return 1;
153
175 else if (child->parent != NULL) 154 else if (child->parent != NULL)
176 return region_is_child_of_region (child->parent, r); 155 return region_is_child_of_region (child->parent, r);
177 else 156 else
178 return 0; 157 return 0;
179} 158}
180 159
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}
217
218/** Returns an object which is an exit through which the player represented by op should be 160/** 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 161 * 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 162 * constructed, then NULL will be returned. The caller is responsible for freeing the object
221 * created by this function. 163 * created by this function.
222 */ 164 */
… …
229 if (op->type != PLAYER) 171 if (op->type != PLAYER)
230 { 172 {
231 LOG (llevError, "region.c: get_jail_exit called against non-player object.\n"); 173 LOG (llevError, "region.c: get_jail_exit called against non-player object.\n");
232 return NULL; 174 return NULL;
233 } 175 }
234 reg = get_region_by_map (op->map); 176
177 reg = op->region ();
235 while (reg != NULL) 178 while (reg)
236 { 179 {
237 if (reg->jailmap) 180 if (reg->jailmap)
238 { 181 {
239 exit = object::create (); 182 exit = object::create ();
240 EXIT_PATH (exit) = reg->jailmap; 183 EXIT_PATH (exit) = reg->jailmap;
… …
245 return exit; 188 return exit;
246 } 189 }
247 else 190 else
248 reg = reg->parent; 191 reg = reg->parent;
249 } 192 }
193
250 LOG (llevDebug, "No suitable jailmap for region %s was found.\n", reg->name); 194 LOG (llevDebug, "No suitable jailmap for region %s was found.\n", &reg->name);
251 return NULL; 195 return NULL;
196}
197
198static void
199assign_region_parents (void)
200{
201 region *reg;
202 uint32 parent_count = 0;
203 uint32 region_count = 0;
204
205 for (reg = first_region; reg && reg->next; reg = reg->next)
206 {
207 if (reg->parent_name)
208 {
209 reg->parent = region::find (reg->parent_name);
210 parent_count++;
211 }
212
213 region_count++;
214 }
215
216 LOG (llevDebug, "Assigned %u regions with %u parents.\n", region_count, parent_count);
217}
218
219/*
220 * Reads/parses the region file, and copies into a linked list
221 * of region structs.
222 */
223static bool
224parse_regions (object_thawer &fp)
225{
226 region *newreg;
227 region *reg;
228
229 newreg = NULL;
230 for (;;)
231 {
232 keyword kw = fp.get_kv ();
233
234 switch (kw)
235 {
236 case KW_EOF:
237 if (newreg)
238 {
239 LOG (llevError, "%s: end of file while reading regions.\n", fp.name);
240 return false;
241 }
242 else
243 return true;
244
245 case KW_end:
246 /* Place this new region last on the list, if the list is empty put it first */
247 for (reg = first_region; reg && reg->next; reg = reg->next)
248 ;
249
250 if (!reg)
251 first_region = newreg;
252 else
253 reg->next = newreg;
254
255 newreg = 0;
256 break;
257
258 default:
259 case KW_ERROR:
260 LOG (llevError, "%s: skipping errornous line (%s) while reading regions.\n", fp.name, fp.last_keyword);
261 break;
262
263 case KW_region:
264 newreg = new region;
265 fp.get (newreg->name);
266 break;
267
268 case KW_parent:
269 /*
270 * Note that this is in the initialisation code, so we don't actually
271 * assign the pointer to the parent yet, because it might not have been
272 * parsed.
273 */
274 fp.get (newreg->parent_name);
275 break;
276
277 case KW_longname:
278 newreg->longname = strdup (fp.get_str ());
279 break;
280
281 case KW_jail_map:
282 fp.get (newreg->jailmap);
283 break;
284
285 case KW_jail_x:
286 fp.get (newreg->jailx);
287 break;
288
289 case KW_jail_y:
290 fp.get (newreg->jaily);
291 break;
292
293 case KW_msg:
294 fp.get_ml (KW_endmsg, newreg->msg);
295 break;
296
297 case KW_fallback:
298 fp.get (newreg->fallback);
299 break;
300
301 case KW_nomore:
302 /* we have reached the end of the region specs.... */
303 return true;
304 }
305 }
252} 306}
253 307
254/* 308/*
255 * First initialises the archtype hash-table (init_archetable()). 309 * First initialises the archtype hash-table (init_archetable()).
256 * Reads and parses the archetype file (with the first and second-pass 310 * Reads and parses the archetype file (with the first and second-pass
… …
258 * Then initialises treasures by calling load_treasures(). 312 * Then initialises treasures by calling load_treasures().
259 */ 313 */
260void 314void
261init_regions (void) 315init_regions (void)
262{ 316{
263 FILE *fp;
264 char filename[MAX_BUF]; 317 char filename[MAX_BUF];
265 int comp; 318 int comp;
266 319
267 if (first_region != NULL) /* Only do this once */ 320 if (first_region != NULL) /* Only do this once */
268 return; 321 return;
269 322
323 // make sure one region is always available
324 first_region = new region;
325 first_region->name = "<builtin>";
326 first_region->longname = strdup ("Built-in Region");
327
270 sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions); 328 sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions);
271 LOG (llevDebug, "Reading regions from %s...\n", filename); 329 LOG (llevDebug, "Reading regions from %s...\n", filename);
272 if ((fp = open_and_uncompress (filename, 0, &comp)) == NULL) 330
331 object_thawer fp (filename);
332
333 if (!fp)
273 { 334 {
274 LOG (llevError, " Can't open regions file %s in init_regions.\n", filename); 335 LOG (llevError, " Can't open regions file %s in init_regions.\n", filename);
275 return; 336 return;
276 } 337 }
338
277 parse_regions (fp); 339 parse_regions (fp);
340
278 assign_region_parents (); 341 assign_region_parents ();
279 LOG (llevDebug, " done\n"); 342 LOG (llevDebug, " done\n");
280
281 close_and_delete (fp, comp);
282} 343}
283
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 return new region;
294}
295
296/*
297 * Reads/parses the region file, and copies into a linked list
298 * of region structs.
299 */
300void
301parse_regions (FILE * fp)
302{
303 region *newreg;
304 region *reg;
305
306 char buf[HUGE_BUF], msgbuf[HUGE_BUF], *key = NULL, *value, *end;
307 int msgpos = 0;
308
309 newreg = NULL;
310 while (fgets (buf, HUGE_BUF - 1, fp) != NULL)
311 {
312 buf[HUGE_BUF - 1] = 0;
313 key = buf;
314 while (isspace (*key))
315 key++;
316 if (*key == 0)
317 continue; /* empty line */
318 value = strchr (key, ' ');
319 if (!value)
320 {
321 end = strchr (key, '\n');
322 *end = 0;
323 }
324 else
325 {
326 *value = 0;
327 value++;
328 while (isspace (*value))
329 value++;
330 end = strchr (value, '\n');
331 }
332
333 /*
334 * This is a bizzare mutated form of the map and archetype parser
335 * rolled into one. Key is the field name, value is what it should
336 * be set to.
337 * We've already done the work to null terminate key,
338 * and strip off any leading spaces for both of these.
339 * We have not touched the newline at the end of the line -
340 * these might be needed for some values. the end pointer
341 * points to the first of the newlines.
342 * value could be NULL! It would be easy enough to just point
343 * this to "" to prevent cores, but that would let more errors slide
344 * through.
345 */
346 if (!strcmp (key, "region"))
347 {
348 *end = 0;
349 newreg = get_region_struct ();
350 newreg->name = strdup (value);
351 }
352 else if (!strcmp (key, "parent"))
353 {
354 /*
355 * Note that this is in the initialisation code, so we don't actually
356 * assign the pointer to the parent yet, because it might not have been
357 * parsed.
358 */
359 *end = 0;
360 newreg->parent_name = strdup (value);
361 }
362 else if (!strcmp (key, "longname"))
363 {
364 *end = 0;
365 newreg->longname = strdup (value);
366 }
367 else if (!strcmp (key, "jail"))
368 {
369 /* jail entries are of the form: /path/to/map x y */
370 char path[MAX_BUF];
371 int x, y;
372
373 if (sscanf (value, "%[^ ] %d %d\n", path, &x, &y) != 3)
374 {
375 LOG (llevError, "region.c: malformated regions entry: jail %s\n", value);
376 continue;
377 }
378 newreg->jailmap = strdup (path);
379 newreg->jailx = x;
380 newreg->jaily = y;
381 }
382 else if (!strcmp (key, "msg"))
383 {
384 while (fgets (buf, HUGE_BUF - 1, fp) != NULL)
385 {
386 if (!strcmp (buf, "endmsg\n"))
387 break;
388 else
389 {
390 strcpy (msgbuf + msgpos, buf);
391 msgpos += strlen (buf);
392 }
393 }
394 /*
395 * There may be regions with empty messages (eg, msg/endmsg
396 * with nothing between). When maps are loaded, this is done
397 * so better do it here too...
398 */
399 if (msgpos != 0)
400 newreg->msg = strdup (msgbuf);
401
402 /* we have to reset msgpos, or the next region will store both msg blocks. */
403 msgpos = 0;
404 }
405 else if (!strcmp (key, "fallback"))
406 {
407 *end = 0;
408 newreg->fallback = atoi (value);
409 }
410 else if (!strcmp (key, "end"))
411 {
412 /* Place this new region last on the list, if the list is empty put it first */
413 for (reg = first_region; reg != NULL && reg->next != NULL; reg = reg->next);
414
415 if (reg == NULL)
416 first_region = newreg;
417 else
418 reg->next = newreg;
419 newreg = NULL;
420 }
421 else if (!strcmp (key, "nomore"))
422 {
423 /* we have reached the end of the region specs.... */
424 break;
425 }
426 else
427 {
428 /* we should never get here, if we have, then something is wrong */
429 LOG (llevError, "Got unknown value in region file: %s %s\n", key, value);
430 }
431 }
432 if (!key || strcmp (key, "nomore"))
433 LOG (llevError, "Got premature eof on regions file!\n");
434}
435
436void
437assign_region_parents (void)
438{
439 region *reg;
440 uint32 parent_count = 0;
441 uint32 region_count = 0;
442
443 for (reg = first_region; reg != NULL && reg->next != NULL; reg = reg->next)
444 {
445 if (reg->parent_name != NULL)
446 {
447 reg->parent = get_region_by_name (reg->parent_name);
448 parent_count++;
449 }
450 region_count++;
451 }
452 LOG (llevDebug, "Assigned %u regions with %u parents.", region_count, parent_count);
453}

Diff Legend

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