1 |
/* |
2 |
* This file is part of Deliantra, the Roguelike Realtime MMORPG. |
3 |
* |
4 |
* Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team |
5 |
* Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team |
6 |
* Copyright (©) 1992,2007 Frank Tore Johansen |
7 |
* |
8 |
* Deliantra is free software: you can redistribute it and/or modify it under |
9 |
* the terms of the Affero GNU General Public License as published by the |
10 |
* Free Software Foundation, either version 3 of the License, or (at your |
11 |
* option) any later version. |
12 |
* |
13 |
* This program is distributed in the hope that it will be useful, |
14 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 |
* GNU General Public License for more details. |
17 |
* |
18 |
* You should have received a copy of the Affero GNU General Public License |
19 |
* and the GNU General Public License along with this program. If not, see |
20 |
* <http://www.gnu.org/licenses/>. |
21 |
* |
22 |
* The authors can be reached via e-mail to <support@deliantra.net> |
23 |
*/ |
24 |
|
25 |
#include <cassert> |
26 |
|
27 |
#include <global.h> |
28 |
#include <loader.h> |
29 |
|
30 |
#include <tr1/functional> |
31 |
#include <tr1/unordered_map> |
32 |
|
33 |
archetype *loading_arch; // ugly flag to object loader etc. to suppress/request special processing |
34 |
arch_ptr archetype::empty; |
35 |
|
36 |
// the hashtable |
37 |
typedef std::tr1::unordered_map |
38 |
< |
39 |
const char *, |
40 |
arch_ptr, |
41 |
str_hash, |
42 |
str_equal, |
43 |
slice_allocator< std::pair<const char *const, arch_ptr> > |
44 |
> HT; |
45 |
|
46 |
static HT ht (10000); |
47 |
archvec archetypes; |
48 |
static unordered_vector<archetype *> allarch; |
49 |
static int dirtycnt; |
50 |
|
51 |
// the vector of other_arch references to be resolved |
52 |
static std::vector< std::pair<arch_ptr *, shstr> > postponed_arch_ref; |
53 |
// the vector of loaded but not yet committed archetypes |
54 |
static std::vector<archetype *> postponed_arch; |
55 |
|
56 |
//+GPL |
57 |
|
58 |
/* |
59 |
* Creates an object. This function is called by get_archetype () |
60 |
* if it fails to find the appropriate archetype. |
61 |
* Thus get_archetype() will be guaranteed to always return |
62 |
* an object, and never NULL. |
63 |
*/ |
64 |
static object * |
65 |
create_singularity (const char *name) |
66 |
{ |
67 |
LOG (llevError | logBacktrace, "FATAL: creating singularity for '%s'.\n", name); |
68 |
|
69 |
if (!strcmp (name, "bug")) |
70 |
abort (); |
71 |
|
72 |
object *op = archetype::get (shstr_bug); |
73 |
op->name = op->name_pl = format ("bug, please report (missing archetype %s)", name); |
74 |
|
75 |
return op; |
76 |
} |
77 |
|
78 |
/** |
79 |
* GROS - This function retrieves an archetype given the name that appears |
80 |
* during the game (for example, "writing pen" instead of "stylus"). |
81 |
* It does not use the hashtable system, but browse the whole archlist each time. |
82 |
* I suggest not to use it unless you really need it because of performance issue. |
83 |
* It is currently used by scripting extensions (create-object). |
84 |
* Params: |
85 |
* - name: the name we're searching for (ex: "writing pen"); |
86 |
* Return value: |
87 |
* - the archetype found or null if nothing was found. |
88 |
*/ |
89 |
archetype * |
90 |
find_archetype_by_object_name (const char *name) |
91 |
{ |
92 |
shstr_cmp name_cmp (name); |
93 |
|
94 |
for_all_archetypes (at) |
95 |
if (at->name == name_cmp) |
96 |
return at; |
97 |
|
98 |
return 0; |
99 |
} |
100 |
|
101 |
/** |
102 |
* This function retrieves an archetype by type and name that appears during |
103 |
* the game. It is basically the same as find_archetype_by_object_name() |
104 |
* except that it considers only items of the given type. |
105 |
*/ |
106 |
archetype * |
107 |
find_archetype_by_object_type_name (int type, const char *name) |
108 |
{ |
109 |
shstr_cmp name_cmp (name); |
110 |
|
111 |
for_all_archetypes (at) |
112 |
if (at->name == name_cmp && at->type == type) |
113 |
return at; |
114 |
|
115 |
return 0; |
116 |
} |
117 |
|
118 |
/* This is a lot like the above function. Instead, we are trying to match |
119 |
* the arch->skill values. type is the type of object to match |
120 |
* against (eg, to only match against skills or only skill objects for example). |
121 |
* If type is -1, ew don't match on type. |
122 |
*/ |
123 |
object * |
124 |
get_archetype_by_skill_name (const char *skill, int type) |
125 |
{ |
126 |
shstr_cmp skill_cmp (skill); |
127 |
|
128 |
for_all_archetypes (at) |
129 |
if (at->skill == skill_cmp && (type == -1 || type == at->type)) |
130 |
return at->instance (); |
131 |
|
132 |
return 0; |
133 |
} |
134 |
|
135 |
/* similiar to above - this returns the first archetype |
136 |
* that matches both the type and subtype. type and subtype |
137 |
* can be -1 to say ignore, but in this case, the match it does |
138 |
* may not be very useful. This function is most useful when |
139 |
* subtypes are known to be unique for a particular type |
140 |
* (eg, skills) |
141 |
*/ |
142 |
archetype * |
143 |
get_archetype_by_type_subtype (int type, int subtype) |
144 |
{ |
145 |
for_all_archetypes (at) |
146 |
if ((type == -1 || type == at->type) && (subtype == -1 || subtype == at->subtype)) |
147 |
return at; |
148 |
|
149 |
return 0; |
150 |
} |
151 |
|
152 |
/** |
153 |
* GROS - this returns a new object given the name that appears during the game |
154 |
* (for example, "writing pen" instead of "stylus"). |
155 |
* Params: |
156 |
* - name: The name we're searching for (ex: "writing pen"); |
157 |
* Return value: |
158 |
* - a corresponding object if found; a singularity object if not found. |
159 |
* Note by MSW - it appears that it takes the full name and keeps |
160 |
* shortening it until it finds a match. I re-wrote this so that it |
161 |
* doesn't allocate it each time - not that this function is used much, |
162 |
* but it otherwise had a big memory leak. |
163 |
*/ |
164 |
object * |
165 |
get_archetype_by_object_name (const char *name) |
166 |
{ |
167 |
char tmpname[MAX_BUF]; |
168 |
|
169 |
assign (tmpname, name); |
170 |
|
171 |
for (int i = strlen (tmpname); i > 0; i--) |
172 |
{ |
173 |
tmpname[i] = 0; |
174 |
|
175 |
if (archetype *at = find_archetype_by_object_name (tmpname)) |
176 |
return at->instance (); |
177 |
} |
178 |
|
179 |
return create_singularity (name); |
180 |
} |
181 |
|
182 |
/* This is a subset of the parse_id command. Basically, name can be |
183 |
* a string seperated lists of things to match, with certain keywords. |
184 |
* pl is the player (only needed to set count properly) |
185 |
* op is the item we are trying to match. Calling function takes care |
186 |
* of what action might need to be done and if it is valid |
187 |
* (pickup, drop, etc.) Return NONZERO if we have a match. A higher |
188 |
* value means a better match. 0 means no match. |
189 |
* |
190 |
* Brief outline of the procedure: |
191 |
* We take apart the name variable into the individual components. |
192 |
* cases for 'all' and unpaid are pretty obvious. |
193 |
* Next, we check for a count (either specified in name, or in the |
194 |
* player object.) |
195 |
* If count is 1, make a quick check on the name. |
196 |
* IF count is >1, we need to make plural name. Return if match. |
197 |
* Last, make a check on the full name. |
198 |
*/ |
199 |
int |
200 |
item_matched_string (object *pl, object *op, const char *name) |
201 |
{ |
202 |
char *cp, local_name[MAX_BUF]; |
203 |
int count, retval = 0; |
204 |
|
205 |
assign (local_name, name); /* strtok is destructive to name */ |
206 |
|
207 |
for (cp = strtok (local_name, ","); cp; cp = strtok (NULL, ",")) |
208 |
{ |
209 |
while (cp[0] == ' ') |
210 |
++cp; /* get rid of spaces */ |
211 |
|
212 |
/* LOG(llevDebug,"Trying to match %s\n", cp); */ |
213 |
/* All is a very generic match - low match value */ |
214 |
if (!strcmp (cp, "all")) |
215 |
return 1; |
216 |
|
217 |
/* unpaid is a little more specific */ |
218 |
if (!strcmp (cp, "unpaid") && QUERY_FLAG (op, FLAG_UNPAID)) |
219 |
return 2; |
220 |
|
221 |
if (!strcmp (cp, "cursed") && QUERY_FLAG (op, FLAG_KNOWN_CURSED) && (QUERY_FLAG (op, FLAG_CURSED) || QUERY_FLAG (op, FLAG_DAMNED))) |
222 |
return 2; |
223 |
|
224 |
if (!strcmp (cp, "unlocked") && !QUERY_FLAG (op, FLAG_INV_LOCKED)) |
225 |
return 2; |
226 |
|
227 |
/* Allow for things like '100 arrows' */ |
228 |
if ((count = atoi (cp)) != 0) |
229 |
{ |
230 |
cp = strchr (cp, ' '); |
231 |
while (cp && cp[0] == ' ') |
232 |
++cp; /* get rid of spaces */ |
233 |
} |
234 |
else |
235 |
{ |
236 |
if (pl->type == PLAYER) |
237 |
count = pl->contr->count; |
238 |
else |
239 |
count = 0; |
240 |
} |
241 |
|
242 |
if (!cp || cp[0] == '\0' || count < 0) |
243 |
return 0; |
244 |
|
245 |
|
246 |
/* The code here should go from highest retval to lowest. That |
247 |
* is because of the 'else' handling - we don't want to match on |
248 |
* something and set a low retval, even though it may match a higher retcal |
249 |
* later. So keep it in descending order here, so we try for the best |
250 |
* match first, and work downward. |
251 |
*/ |
252 |
const char *qbn0, *qbn1, *qsn; // query base name/short name caches |
253 |
|
254 |
if (!strcasecmp (cp, query_name (op))) |
255 |
retval = 20; |
256 |
else if (!strcasecmp (cp, qsn = query_short_name (op))) |
257 |
retval = 18; |
258 |
else if (!strcasecmp (cp, qbn0 = query_base_name (op, 0))) |
259 |
retval = 16; |
260 |
else if (!strcasecmp (cp, qbn1 = query_base_name (op, 1))) |
261 |
retval = 16; |
262 |
else if (op->custom_name && !strcasecmp (cp, op->custom_name)) |
263 |
retval = 15; |
264 |
else if (!strncasecmp (cp, qbn0, strlen (cp))) |
265 |
retval = 14; |
266 |
else if (!strncasecmp (cp, qbn1, strlen (cp))) |
267 |
retval = 14; |
268 |
/* Do substring checks, so things like 'Str+1' will match. |
269 |
* retval of these should perhaps be lower - they are lower |
270 |
* then the specific strcasecmp aboves, but still higher than |
271 |
* some other match criteria. |
272 |
*/ |
273 |
else if (strstr (qbn1, cp)) |
274 |
retval = 12; |
275 |
else if (strstr (qbn0, cp)) |
276 |
retval = 12; |
277 |
else if (strstr (qsn, cp)) |
278 |
retval = 12; |
279 |
/* Check against plural/non plural based on count. */ |
280 |
else if (count > 1 && !strcasecmp (cp, op->name_pl)) |
281 |
retval = 6; |
282 |
else if (count == 1 && !strcasecmp (op->name, cp)) |
283 |
retval = 6; |
284 |
/* base name matched - not bad */ |
285 |
else if (strcasecmp (cp, op->name) == 0 && !count) |
286 |
retval = 4; |
287 |
/* Check for partial custom name, but give a real low priority */ |
288 |
else if (op->custom_name.contains (cp)) |
289 |
retval = 3; |
290 |
|
291 |
if (retval) |
292 |
{ |
293 |
if (pl->type == PLAYER) |
294 |
pl->contr->count = count; |
295 |
|
296 |
return retval; |
297 |
} |
298 |
} |
299 |
|
300 |
return 0; |
301 |
} |
302 |
|
303 |
//-GPL |
304 |
|
305 |
archetype::archetype (const char *name) |
306 |
{ |
307 |
arch = this; |
308 |
this->archname = this->name = this->name_pl = name; |
309 |
} |
310 |
|
311 |
archetype::~archetype () |
312 |
{ |
313 |
unlink (); |
314 |
} |
315 |
|
316 |
void |
317 |
archetype::link () |
318 |
{ |
319 |
if (!archetypes.contains (this)) |
320 |
{ |
321 |
archetypes.insert (this); |
322 |
ht.insert (std::make_pair (archname, this)); |
323 |
} |
324 |
} |
325 |
|
326 |
void |
327 |
archetype::unlink () |
328 |
{ |
329 |
if (archetypes.contains (this)) |
330 |
{ |
331 |
archetypes.erase (this); |
332 |
ht.erase (archname); |
333 |
} |
334 |
} |
335 |
|
336 |
/* |
337 |
* Finds, using the hashtable, which archetype matches the given name. |
338 |
* returns a pointer to the found archetype, otherwise NULL. |
339 |
*/ |
340 |
archetype * |
341 |
archetype::find (const char *name) |
342 |
{ |
343 |
if (!name) |
344 |
return 0; |
345 |
|
346 |
auto (i, ht.find (name)); |
347 |
|
348 |
if (i == ht.end ()) |
349 |
return 0; |
350 |
else |
351 |
return i->second; |
352 |
} |
353 |
|
354 |
void |
355 |
archetype::post_load_check () |
356 |
{ |
357 |
object::post_load_check (); |
358 |
|
359 |
assert (("obj_original MUST NOT be set for archetypes", !flag [FLAG_OBJ_ORIGINAL])); |
360 |
} |
361 |
|
362 |
archetype * |
363 |
archetype::read (object_thawer &f) |
364 |
{ |
365 |
assert (f.kw == KW_object); |
366 |
|
367 |
std::vector<archetype *> parts; |
368 |
|
369 |
coroapi::cede_to_tick (); |
370 |
|
371 |
for (;;) |
372 |
{ |
373 |
archetype *at = new archetype (f.get_str ()); |
374 |
|
375 |
f.next (); |
376 |
|
377 |
#if 0 |
378 |
// implementing it here in the server does neither allow multiple inheritence |
379 |
// nor does it cleanly "just override". it would allow use in map files, though, |
380 |
// and other resource files dynamically laoded (as opposed to being preprocessed). |
381 |
// not that any of this is relevant as of yet... |
382 |
if (f.kw == KW_inherit) |
383 |
{ |
384 |
if (archetype *at = find (f.get_str ())) |
385 |
*op = at->clone; |
386 |
else |
387 |
LOG (llevError, "archetype '%s' tries to inherit from non-existent archetype '%s'.\n", |
388 |
&at->archname, f.get_str ()); |
389 |
|
390 |
f.next (); |
391 |
} |
392 |
#endif |
393 |
|
394 |
loading_arch = at; // hack to tell parse_kv et al. to behave |
395 |
bool parse_ok = at->parse_kv (f); |
396 |
loading_arch = 0; |
397 |
|
398 |
if (!parse_ok) |
399 |
goto fail; |
400 |
|
401 |
loading_arch = at; // hack to tell parse_kv et al. to behave |
402 |
at->post_load_check (); |
403 |
loading_arch = 0; |
404 |
|
405 |
parts.push_back (at); |
406 |
|
407 |
if (f.kw != KW_more) |
408 |
break; |
409 |
|
410 |
f.next (); |
411 |
|
412 |
if (f.kw != KW_object) |
413 |
{ |
414 |
f.parse_error ("more object"); |
415 |
goto fail; |
416 |
} |
417 |
} |
418 |
|
419 |
{ |
420 |
auto (at, parts.begin ()); |
421 |
|
422 |
archetype *new_head = parts.front (); |
423 |
archetype *old_head = find (new_head->archname); |
424 |
|
425 |
if (old_head && !old_head->is_head ()) |
426 |
{ |
427 |
LOG (llevError, "%s: unable to overwrite non-head archetype '%s' with head archetype, skipping.\n", |
428 |
&new_head->archname, &old_head->archname); |
429 |
goto fail; |
430 |
} |
431 |
|
432 |
// check that all archetypes belong to the same old object or are new |
433 |
for (auto (at, parts.begin ()); at != parts.end (); ++at) |
434 |
{ |
435 |
archetype *new_part = *at; |
436 |
archetype *old_part = find (new_part->archname); |
437 |
|
438 |
if (old_part && old_part->head_ () != old_head) |
439 |
{ |
440 |
LOG (llevError, "%s: unable to overwrite archetype '%s' with archetype of different object, skipping.\n", |
441 |
&new_part->archname, &((archetype *)old_part->head_ ())->archname); |
442 |
goto fail; |
443 |
} |
444 |
} |
445 |
|
446 |
// assemble new chain |
447 |
new_head->min_x = new_head->max_x = new_head->x; |
448 |
new_head->min_y = new_head->max_y = new_head->y; |
449 |
|
450 |
archetype *less = new_head; |
451 |
for (auto (p, parts.begin () + 1); p != parts.end (); ++p) |
452 |
{ |
453 |
archetype *at = *p; |
454 |
|
455 |
// some flags get inherited from the head (probably a lot more) |
456 |
// doing it here doesn't feel too cozy, but it allows code |
457 |
// to ignore head checks for these flags, which saves time |
458 |
at->flag [FLAG_ALIVE] = new_head->flag [FLAG_ALIVE]; |
459 |
at->flag [FLAG_NO_PICK] = new_head->flag [FLAG_NO_PICK]; |
460 |
at->flag [FLAG_MONSTER] = new_head->flag [FLAG_MONSTER]; |
461 |
at->flag [FLAG_IS_FLOOR] = new_head->flag [FLAG_IS_FLOOR]; |
462 |
|
463 |
new_head->min_x = min (new_head->min_x, at->x); |
464 |
new_head->min_y = min (new_head->min_y, at->y); |
465 |
new_head->max_x = max (new_head->max_x, at->x); |
466 |
new_head->max_y = max (new_head->max_y, at->y); |
467 |
|
468 |
at->head = new_head; |
469 |
less->more = at; |
470 |
less = at; |
471 |
} |
472 |
|
473 |
postponed_arch.insert (postponed_arch.end (), parts.begin (), parts.end ()); |
474 |
|
475 |
return new_head; |
476 |
} |
477 |
|
478 |
fail: |
479 |
for (auto (p, parts.begin ()); p != parts.end (); ++p) |
480 |
(*p)->destroy (); |
481 |
|
482 |
return 0; |
483 |
} |
484 |
|
485 |
void |
486 |
archetype::postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch) |
487 |
{ |
488 |
ref = 0; |
489 |
postponed_arch_ref.push_back (std::pair<arch_ptr *, shstr>(&ref, shstr (other_arch))); |
490 |
} |
491 |
|
492 |
void |
493 |
archetype::commit_load () |
494 |
{ |
495 |
// unlink old archetypes and link in new ones */ |
496 |
for (auto (p, postponed_arch.begin ()); p != postponed_arch.end (); ++p) |
497 |
{ |
498 |
archetype *at = *p; |
499 |
|
500 |
if (archetype *old = find (at->archname)) |
501 |
old->unlink (); |
502 |
|
503 |
allarch.push_back (at); |
504 |
|
505 |
at->link (); |
506 |
++dirtycnt; |
507 |
} |
508 |
|
509 |
postponed_arch.clear (); |
510 |
|
511 |
// now resolve arch references |
512 |
for (auto (p, postponed_arch_ref.begin ()); p != postponed_arch_ref.end (); ++p) |
513 |
{ |
514 |
arch_ptr *ap = p->first; |
515 |
archetype *at = find (p->second); |
516 |
|
517 |
if (!at) |
518 |
LOG (llevError, "unable to resolve postponed arch reference to '%s'", &p->second); |
519 |
|
520 |
*ap = at; |
521 |
} |
522 |
|
523 |
postponed_arch_ref.clear (); |
524 |
|
525 |
empty = find (shstr_empty_archetype); |
526 |
} |
527 |
|
528 |
void |
529 |
archetype::gc () |
530 |
{ |
531 |
int cnt = max (1, min (allarch.size () / 128, dirtycnt)); |
532 |
dirtycnt = max (0, dirtycnt - cnt); |
533 |
|
534 |
do |
535 |
{ |
536 |
static int idx; |
537 |
|
538 |
if (idx >= allarch.size ()) |
539 |
if (idx) |
540 |
idx = 0; |
541 |
else |
542 |
return; |
543 |
|
544 |
archetype *at = allarch [idx]; |
545 |
|
546 |
if (at->refcnt_cnt () > 1) // all arches have ONE refcount from their object |
547 |
++idx; |
548 |
else |
549 |
{ |
550 |
LOG (llevDebug, "garbage collect arch %s", &at->archname); |
551 |
assert (at->arch == at); // verify that refcnt == 1 is truly valid |
552 |
allarch.erase (idx); |
553 |
|
554 |
// break chain |
555 |
for (object *op = at->head_ (); op; ) |
556 |
{ |
557 |
object *next = op->more; |
558 |
op->head = 0; |
559 |
op->more = 0; |
560 |
op = next; |
561 |
} |
562 |
|
563 |
at->destroy (); |
564 |
at->arch = 0; |
565 |
} |
566 |
} |
567 |
while (--cnt); |
568 |
} |
569 |
|
570 |
object * |
571 |
archetype::instance () |
572 |
{ |
573 |
object *op = clone (); |
574 |
op->instantiate (); |
575 |
return op; |
576 |
} |
577 |
|
578 |
//+GPL |
579 |
|
580 |
/* |
581 |
* Finds which archetype matches the given name, and returns a new |
582 |
* object containing a copy of the archetype. |
583 |
*/ |
584 |
object * |
585 |
get_archetype (const char *name) |
586 |
{ |
587 |
return archetype::get (name); |
588 |
} |
589 |
|
590 |
object * |
591 |
archetype::get (const char *name) |
592 |
{ |
593 |
archetype *at = find (name); |
594 |
|
595 |
if (!at) |
596 |
return create_singularity (name); |
597 |
|
598 |
return at->instance (); |
599 |
} |
600 |
|
601 |
/* |
602 |
* Returns the first archetype using the given type. |
603 |
* Used in treasure-generation. |
604 |
*/ |
605 |
static archetype * |
606 |
type_to_archetype (int type) |
607 |
{ |
608 |
for_all_archetypes (at) |
609 |
if (at->type == type && at->head_ () != at) |
610 |
return at; |
611 |
|
612 |
return 0; |
613 |
} |
614 |
|
615 |
/* |
616 |
* Returns a new object copied from the first archetype matching |
617 |
* the given type. |
618 |
* Used in treasure-generation. |
619 |
*/ |
620 |
object * |
621 |
clone_arch (int type) |
622 |
{ |
623 |
archetype *at = type_to_archetype (type); |
624 |
|
625 |
if (!at) |
626 |
{ |
627 |
LOG (llevError, "Can't clone archetype %d\n", type); |
628 |
return 0; |
629 |
} |
630 |
|
631 |
return at->instance (); |
632 |
} |
633 |
|
634 |
/* |
635 |
* member: make instance from class |
636 |
*/ |
637 |
object * |
638 |
object_create_arch (archetype *at) |
639 |
{ |
640 |
object *op, *prev = 0, *head = 0; |
641 |
|
642 |
while (at) |
643 |
{ |
644 |
op = at->instance (); |
645 |
|
646 |
op->x = at->x; |
647 |
op->y = at->y; |
648 |
|
649 |
if (head) |
650 |
op->head = head, prev->more = op; |
651 |
|
652 |
if (!head) |
653 |
head = op; |
654 |
|
655 |
prev = op; |
656 |
at = (archetype *)at->more; |
657 |
} |
658 |
|
659 |
return head; |
660 |
} |
661 |
|
662 |
//-GPL |
663 |
|