ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/common/arch.C
Revision: 1.115
Committed: Sat Nov 17 23:33:17 2018 UTC (5 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.114: +10 -11 lines
Log Message:
*** empty log message ***

File Contents

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