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.19 by root, Mon Jan 29 14:46:01 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
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}
36 37
37/* 38/*
38 * 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.
39 * 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
40 * with the 'fallback' property set. 41 * with the 'fallback' property set.
41 * 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
42 * message and returns NULL 43 * message and returns NULL
43 * used by the map parsing code. 44 * used by the map parsing code.
44 */ 45 */
45region * 46region *
46get_region_by_name (const char *region_name) 47region::find (const char *name)
47{ 48{
48 region *reg;
49 char *p = strchr (region_name, '\n');
50
51 if (p)
52 *p = '\0';
53 for (reg = first_region; reg != NULL; reg = reg->next) 49 for (region *reg = first_region; reg; reg = reg->next)
54 if (!strcmp (reg->name, region_name)) 50 if (!strcmp (reg->name, name))
55 return reg; 51 return reg;
56 52
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); 53 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 54
69/* This might need optimising at some point. */ 55 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} 56}
97 57
98/* 58/*
99 * Tries to find a region that 'name' corresponds to. 59 * Tries to find a region that 'name' corresponds to.
100 * It looks, in order, for: 60 * It looks, in order, for:
… …
106 * (there should be only one of these - the top level one) 66 * (there should be only one of these - the top level one)
107 * 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
108 * 68 *
109 */ 69 */
110region * 70region *
111get_region_from_string (const char *name) 71region::find_fuzzy (const char *name)
112{ 72{
113 region *reg; 73 region *reg;
114 char *substr; 74 char *substr;
115 char *p; 75 char *p;
116 76
117 if (name == NULL) 77 if (name == NULL)
118 { 78 {
119 for (reg = first_region; reg->parent != NULL; reg = reg->parent); 79 for (reg = first_region; reg->parent; reg = reg->parent)
80 ;
81
120 return reg; 82 return reg;
121 } 83 }
84
122 p = strchr (name, '\n'); 85 p = strchr (name, '\n');
123 if (p) 86 if (p)
124 *p = '\0'; 87 *p = '\0';
88
125 for (reg = first_region; reg != NULL; reg = reg->next) 89 for (reg = first_region; reg; reg = reg->next)
126 if (!strcasecmp (reg->name, name)) 90 if (!strcasecmp (reg->name, name))
127 return reg; 91 return reg;
128 92
129 for (reg = first_region; reg != NULL; reg = reg->next) 93 for (reg = first_region; reg; reg = reg->next)
130 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)
131 { 101 {
132 if (!strcasecmp (reg->longname, name)) 102 substr = strstr (reg->longname, name);
103 if (substr)
133 return reg; 104 return reg;
134 } 105 }
135 106
136 substr = NULL;
137 for (reg = first_region; reg != NULL; reg = reg->next) 107 for (reg = first_region; reg; reg = reg->next)
138 if (reg->longname != NULL) 108 if (reg->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 { 109 {
147 /* 110 /*
148 * 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
149 * 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
150 * '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
151 * regions with a longname set. 114 * regions with a longname set.
152 */ 115 */
153 substr = strstr (reg->name, name); 116 substr = strstr (reg->name, name);
154 if (substr != NULL) 117 if (substr)
155 return reg; 118 return reg;
156 } 119 }
120
157 for (reg = first_region; reg != NULL; reg = reg->next) 121 for (reg = first_region; reg; reg = reg->next)
158 { 122 {
159 substr = strstr (reg->name, name); 123 substr = strstr (reg->name, name);
160 if (substr != NULL) 124 if (substr)
161 return reg; 125 return reg;
162 } 126 }
127
163 /* 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 */
164 for (reg = first_region; reg->parent != NULL; reg = reg->parent); 129 for (reg = first_region; reg->parent; reg = reg->parent)
130 ;
131
165 return reg; 132 return reg;
166} 133}
167 134
168/* 135/*
169 * 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
170 * otherwise returns 0 137 * otherwise returns 0
171 * if passed a NULL region returns -1 138 * if passed a NULL region returns -1
172 */ 139 */
173 140
174int 141static int
175region_is_child_of_region (const region * child, const region * r) 142region_is_child_of_region (const region * child, const region * r)
176{ 143{
177 144
178 if (r == NULL) 145 if (r == NULL)
179 return -1; 146 return -1;
147
180 if (child == NULL) 148 if (child == NULL)
181 return 0; 149 return 0;
150
182 if (!strcmp (child->name, r->name)) 151 if (!strcmp (child->name, r->name))
183 return 1; 152 return 1;
153
184 else if (child->parent != NULL) 154 else if (child->parent != NULL)
185 return region_is_child_of_region (child->parent, r); 155 return region_is_child_of_region (child->parent, r);
186 else 156 else
187 return 0; 157 return 0;
188} 158}
189 159
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 160/** 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 161 * 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 162 * constructed, then NULL will be returned. The caller is responsible for freeing the object
230 * created by this function. 163 * created by this function.
231 */ 164 */
… …
238 if (op->type != PLAYER) 171 if (op->type != PLAYER)
239 { 172 {
240 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");
241 return NULL; 174 return NULL;
242 } 175 }
243 reg = get_region_by_map (op->map); 176
177 reg = op->region ();
244 while (reg != NULL) 178 while (reg)
245 { 179 {
246 if (reg->jailmap) 180 if (reg->jailmap)
247 { 181 {
248 exit = get_object (); 182 exit = object::create ();
249 EXIT_PATH (exit) = reg->jailmap; 183 EXIT_PATH (exit) = reg->jailmap;
250 /* damned exits reset savebed and remove teleports, so the prisoner can't escape */ 184 /* damned exits reset savebed and remove teleports, so the prisoner can't escape */
251 SET_FLAG (exit, FLAG_DAMNED); 185 SET_FLAG (exit, FLAG_DAMNED);
252 EXIT_X (exit) = reg->jailx; 186 EXIT_X (exit) = reg->jailx;
253 EXIT_Y (exit) = reg->jaily; 187 EXIT_Y (exit) = reg->jaily;
254 return exit; 188 return exit;
255 } 189 }
256 else 190 else
257 reg = reg->parent; 191 reg = reg->parent;
258 } 192 }
193
259 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);
260 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);
261} 217}
262 218
263/* 219/*
264 * First initialises the archtype hash-table (init_archetable()). 220 * First initialises the archtype hash-table (init_archetable()).
265 * Reads and parses the archetype file (with the first and second-pass 221 * Reads and parses the archetype file (with the first and second-pass
… …
274 int comp; 230 int comp;
275 231
276 if (first_region != NULL) /* Only do this once */ 232 if (first_region != NULL) /* Only do this once */
277 return; 233 return;
278 234
235 // make sure one region is always available
236 first_region = new region;
237 first_region->name = "<builtin>";
238 first_region->longname = strdup ("Built-in Region");
239
279 sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions); 240 sprintf (filename, "%s/%s/%s", settings.datadir, settings.mapdir, settings.regions);
280 LOG (llevDebug, "Reading regions from %s...\n", filename); 241 LOG (llevDebug, "Reading regions from %s...\n", filename);
281 if ((fp = open_and_uncompress (filename, 0, &comp)) == NULL) 242 if ((fp = open_and_uncompress (filename, 0, &comp)) == NULL)
282 { 243 {
283 LOG (llevError, " Can't open regions file %s in init_regions.\n", filename); 244 LOG (llevError, " Can't open regions file %s in init_regions.\n", filename);
284 return; 245 return;
285 } 246 }
247
286 parse_regions (fp); 248 parse_regions (fp);
287 assign_region_parents (); 249 assign_region_parents ();
288 LOG (llevDebug, " done\n"); 250 LOG (llevDebug, " done\n");
289 251
290 close_and_delete (fp, comp); 252 close_and_delete (fp, comp);
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} 253}
313 254
314/* 255/*
315 * Reads/parses the region file, and copies into a linked list 256 * Reads/parses the region file, and copies into a linked list
316 * of region structs. 257 * of region structs.
… …
362 * through. 303 * through.
363 */ 304 */
364 if (!strcmp (key, "region")) 305 if (!strcmp (key, "region"))
365 { 306 {
366 *end = 0; 307 *end = 0;
367 newreg = get_region_struct (); 308 newreg = new region;
368 newreg->name = strdup_local (value); 309 newreg->name = value;
369 } 310 }
370 else if (!strcmp (key, "parent")) 311 else if (!strcmp (key, "parent"))
371 { 312 {
372 /* 313 /*
373 * Note that this is in the initialisation code, so we don't actually 314 * 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 315 * assign the pointer to the parent yet, because it might not have been
375 * parsed. 316 * parsed.
376 */ 317 */
377 *end = 0; 318 *end = 0;
378 newreg->parent_name = strdup_local (value); 319 newreg->parent_name = value;
379 } 320 }
380 else if (!strcmp (key, "longname")) 321 else if (!strcmp (key, "longname"))
381 { 322 {
382 *end = 0; 323 *end = 0;
383 newreg->longname = strdup_local (value); 324 newreg->longname = strdup (value);
384 } 325 }
385 else if (!strcmp (key, "jail")) 326 else if (!strcmp (key, "jail"))
386 { 327 {
387 /* jail entries are of the form: /path/to/map x y */ 328 /* jail entries are of the form: /path/to/map x y */
388 char path[MAX_BUF]; 329 char path[MAX_BUF];
… …
391 if (sscanf (value, "%[^ ] %d %d\n", path, &x, &y) != 3) 332 if (sscanf (value, "%[^ ] %d %d\n", path, &x, &y) != 3)
392 { 333 {
393 LOG (llevError, "region.c: malformated regions entry: jail %s\n", value); 334 LOG (llevError, "region.c: malformated regions entry: jail %s\n", value);
394 continue; 335 continue;
395 } 336 }
396 newreg->jailmap = strdup_local (path); 337 newreg->jailmap = strdup (path);
397 newreg->jailx = x; 338 newreg->jailx = x;
398 newreg->jaily = y; 339 newreg->jaily = y;
399 } 340 }
400 else if (!strcmp (key, "msg")) 341 else if (!strcmp (key, "msg"))
401 { 342 {
… …
413 * There may be regions with empty messages (eg, msg/endmsg 354 * There may be regions with empty messages (eg, msg/endmsg
414 * with nothing between). When maps are loaded, this is done 355 * with nothing between). When maps are loaded, this is done
415 * so better do it here too... 356 * so better do it here too...
416 */ 357 */
417 if (msgpos != 0) 358 if (msgpos != 0)
418 newreg->msg = strdup_local (msgbuf); 359 newreg->msg = strdup (msgbuf);
419 360
420 /* we have to reset msgpos, or the next region will store both msg blocks. */ 361 /* we have to reset msgpos, or the next region will store both msg blocks. */
421 msgpos = 0; 362 msgpos = 0;
422 } 363 }
423 else if (!strcmp (key, "fallback")) 364 else if (!strcmp (key, "fallback"))
… …
449 } 390 }
450 if (!key || strcmp (key, "nomore")) 391 if (!key || strcmp (key, "nomore"))
451 LOG (llevError, "Got premature eof on regions file!\n"); 392 LOG (llevError, "Got premature eof on regions file!\n");
452} 393}
453 394
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