ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/common/arch.C
Revision: 1.96
Committed: Sat Nov 7 18:30:05 2009 UTC (14 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.95: +1 -1 lines
Log Message:
lots of cleanups

File Contents

# User Rev Content
1 elmex 1.1 /*
2 root 1.71 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 pippijn 1.37 *
4 root 1.73 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 root 1.61 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
6     * Copyright (©) 1992,2007 Frank Tore Johansen
7 pippijn 1.37 *
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 pippijn 1.37 *
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 pippijn 1.37 *
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.61 *
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    
27 elmex 1.1 #include <global.h>
28     #include <loader.h>
29    
30 root 1.38 #include <tr1/functional>
31     #include <tr1/unordered_map>
32 elmex 1.1
33 root 1.74 archetype *loading_arch; // ugly flag to object loader etc. to suppress/request special processing
34     arch_ptr archetype::empty;
35 root 1.46
36 root 1.12 // the hashtable
37 root 1.18 typedef std::tr1::unordered_map
38     <
39 root 1.38 const char *,
40 root 1.26 arch_ptr,
41 root 1.38 str_hash,
42     str_equal,
43     slice_allocator< std::pair<const char *const, arch_ptr> >
44 root 1.18 > HT;
45    
46 root 1.74 static HT ht (10000);
47 root 1.62 archvec archetypes;
48 root 1.74 static unordered_vector<archetype *> allarch;
49     static int dirtycnt;
50 root 1.12
51 root 1.73 // 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 root 1.92 //+GPL
57    
58 root 1.93 /*
59 root 1.96 * Creates an object. This function is called by get_archetype ()
60 root 1.93 * 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 root 1.94 static object *
65 root 1.93 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 elmex 1.1 /**
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 root 1.12 archetype *
90     find_archetype_by_object_name (const char *name)
91     {
92 root 1.39 shstr_cmp name_cmp (name);
93 elmex 1.1
94 root 1.63 for_all_archetypes (at)
95 root 1.66 if (at->name == name_cmp)
96 root 1.39 return at;
97 elmex 1.1
98 root 1.39 return 0;
99 elmex 1.1 }
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 root 1.12 archetype *
107     find_archetype_by_object_type_name (int type, const char *name)
108     {
109 root 1.39 shstr_cmp name_cmp (name);
110 elmex 1.1
111 root 1.63 for_all_archetypes (at)
112 root 1.66 if (at->name == name_cmp && at->type == type)
113 root 1.39 return at;
114 elmex 1.1
115 root 1.39 return 0;
116 elmex 1.1 }
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 root 1.12 object *
124     get_archetype_by_skill_name (const char *skill, int type)
125     {
126 root 1.39 shstr_cmp skill_cmp (skill);
127 elmex 1.1
128 root 1.63 for_all_archetypes (at)
129     if (at->skill == skill_cmp && (type == -1 || type == at->type))
130 root 1.80 return at->instance ();
131 root 1.35
132     return 0;
133 elmex 1.1 }
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 root 1.12 archetype *
143     get_archetype_by_type_subtype (int type, int subtype)
144     {
145 root 1.63 for_all_archetypes (at)
146     if ((type == -1 || type == at->type) && (subtype == -1 || subtype == at->subtype))
147 root 1.39 return at;
148 elmex 1.1
149 root 1.39 return 0;
150 elmex 1.1 }
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 root 1.78 * doesn't allocate it each time - not that this function is used much,
162 elmex 1.1 * but it otherwise had a big memory leak.
163     */
164 root 1.12 object *
165     get_archetype_by_object_name (const char *name)
166     {
167 root 1.17 char tmpname[MAX_BUF];
168    
169     assign (tmpname, name);
170 root 1.12
171 root 1.90 for (int i = strlen (tmpname); i > 0; i--)
172 root 1.12 {
173     tmpname[i] = 0;
174 root 1.17
175 root 1.39 if (archetype *at = find_archetype_by_object_name (tmpname))
176 root 1.80 return at->instance ();
177 elmex 1.1 }
178 root 1.17
179 root 1.12 return create_singularity (name);
180 elmex 1.1 }
181    
182 root 1.65 /* 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 root 1.12 int
200 root 1.15 item_matched_string (object *pl, object *op, const char *name)
201 elmex 1.1 {
202 root 1.22 char *cp, local_name[MAX_BUF];
203     int count, retval = 0;
204 root 1.15
205 root 1.40 assign (local_name, name); /* strtok is destructive to name */
206 root 1.12
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 root 1.90
221 root 1.12 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 root 1.91 const char *qbn0, *qbn1, *qsn; // query base name/short name caches
253    
254 root 1.12 if (!strcasecmp (cp, query_name (op)))
255     retval = 20;
256 root 1.91 else if (!strcasecmp (cp, qsn = query_short_name (op)))
257 root 1.12 retval = 18;
258 root 1.91 else if (!strcasecmp (cp, qbn0 = query_base_name (op, 0)))
259 root 1.12 retval = 16;
260 root 1.91 else if (!strcasecmp (cp, qbn1 = query_base_name (op, 1)))
261 root 1.12 retval = 16;
262     else if (op->custom_name && !strcasecmp (cp, op->custom_name))
263     retval = 15;
264 root 1.91 else if (!strncasecmp (cp, qbn0, strlen (cp)))
265 root 1.12 retval = 14;
266 root 1.91 else if (!strncasecmp (cp, qbn1, strlen (cp)))
267 root 1.12 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 root 1.91 else if (strstr (qbn1, cp))
274 root 1.12 retval = 12;
275 root 1.91 else if (strstr (qbn0, cp))
276 root 1.12 retval = 12;
277 root 1.91 else if (strstr (qsn, cp))
278 root 1.12 retval = 12;
279     /* Check against plural/non plural based on count. */
280     else if (count > 1 && !strcasecmp (cp, op->name_pl))
281 root 1.23 retval = 6;
282 root 1.12 else if (count == 1 && !strcasecmp (op->name, cp))
283 root 1.23 retval = 6;
284 root 1.12 /* 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 root 1.88 else if (op->custom_name.contains (cp))
289 root 1.12 retval = 3;
290    
291     if (retval)
292     {
293     if (pl->type == PLAYER)
294     pl->contr->count = count;
295 root 1.23
296 root 1.12 return retval;
297 root 1.7 }
298 elmex 1.1 }
299 root 1.23
300 root 1.12 return 0;
301 elmex 1.1 }
302    
303 root 1.92 //-GPL
304    
305 root 1.63 archetype::archetype (const char *name)
306 root 1.12 {
307 root 1.63 arch = this;
308     this->archname = this->name = this->name_pl = name;
309 root 1.46 }
310 root 1.12
311 root 1.46 archetype::~archetype ()
312     {
313 root 1.63 unlink ();
314 elmex 1.1 }
315    
316 root 1.63 void
317     archetype::link ()
318 elmex 1.1 {
319 root 1.63 if (!archetypes.contains (this))
320 root 1.74 {
321     archetypes.insert (this);
322     ht.insert (std::make_pair (archname, this));
323     }
324 elmex 1.1 }
325    
326 root 1.46 void
327 root 1.63 archetype::unlink ()
328     {
329     if (archetypes.contains (this))
330 root 1.74 {
331     archetypes.erase (this);
332     ht.erase (archname);
333     }
334 root 1.63 }
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     archetype *
355 root 1.53 archetype::read (object_thawer &f)
356 root 1.12 {
357 root 1.43 assert (f.kw == KW_object);
358    
359 root 1.63 std::vector<archetype *> parts;
360 root 1.12
361 root 1.72 coroapi::cede_to_tick ();
362 root 1.52
363 root 1.49 for (;;)
364 root 1.43 {
365 root 1.73 archetype *at = new archetype (f.get_str ());
366 root 1.63
367 root 1.54 f.next ();
368 root 1.49
369 root 1.56 #if 0
370 root 1.63 // implementing it here in the server does neither allow multiple inheritence
371     // nor does it cleanly "just override". it would allow use in map files, though,
372     // and other resource files dynamically laoded (as opposed to being preprocessed).
373     // not that any of this is relevant as of yet...
374 root 1.55 if (f.kw == KW_inherit)
375     {
376     if (archetype *at = find (f.get_str ()))
377     *op = at->clone;
378     else
379     LOG (llevError, "archetype '%s' tries to inherit from non-existent archetype '%s'.\n",
380 root 1.63 &at->archname, f.get_str ());
381 root 1.55
382     f.next ();
383     }
384 root 1.56 #endif
385 root 1.55
386 root 1.69 loading_arch = at; // hack to tell parse_kv et al. to behave
387     bool parse_ok = at->parse_kv (f);
388     loading_arch = 0;
389    
390     if (!parse_ok)
391 root 1.49 goto fail;
392    
393 root 1.69 loading_arch = at; // hack to tell parse_kv et al. to behave
394 root 1.63 at->post_load_check ();
395 root 1.69 loading_arch = 0;
396 root 1.59
397 root 1.63 parts.push_back (at);
398 root 1.12
399 root 1.49 if (f.kw != KW_more)
400     break;
401 root 1.46
402 root 1.43 f.next ();
403 root 1.54
404     if (f.kw != KW_object)
405     {
406     f.parse_error ("more object");
407     goto fail;
408     }
409 root 1.49 }
410 root 1.43
411 root 1.49 {
412 root 1.63 auto (at, parts.begin ());
413 root 1.12
414 root 1.63 archetype *new_head = parts.front ();
415     archetype *old_head = find (new_head->archname);
416    
417 root 1.64 if (old_head && !old_head->is_head ())
418     {
419     LOG (llevError, "%s: unable to overwrite non-head archetype '%s' with head archetype, skipping.\n",
420     &new_head->archname, &old_head->archname);
421     goto fail;
422     }
423 root 1.63
424     // check that all archetypes belong to the same old object or are new
425     for (auto (at, parts.begin ()); at != parts.end (); ++at)
426 root 1.49 {
427 root 1.63 archetype *new_part = *at;
428     archetype *old_part = find (new_part->archname);
429 root 1.49
430 root 1.63 if (old_part && old_part->head_ () != old_head)
431 root 1.49 {
432 root 1.63 LOG (llevError, "%s: unable to overwrite archetype '%s' with archetype of different object, skipping.\n",
433     &new_part->archname, &((archetype *)old_part->head_ ())->archname);
434 root 1.49 goto fail;
435     }
436     }
437    
438 root 1.64 // assemble new chain
439 root 1.63 new_head->min_x = new_head->max_x = new_head->x;
440     new_head->min_y = new_head->max_y = new_head->y;
441 root 1.49
442 root 1.63 archetype *less = new_head;
443 root 1.51 for (auto (p, parts.begin () + 1); p != parts.end (); ++p)
444 root 1.49 {
445 root 1.63 archetype *at = *p;
446 root 1.49
447 root 1.74 // some flags get inherited from the head (probably a lot more)
448 root 1.67 // doing it here doesn't feel too cozy, but it allows code
449     // to ignore head checks for these flags, which saves time
450     at->flag [FLAG_ALIVE] = new_head->flag [FLAG_ALIVE];
451     at->flag [FLAG_NO_PICK] = new_head->flag [FLAG_NO_PICK];
452     at->flag [FLAG_MONSTER] = new_head->flag [FLAG_MONSTER];
453     at->flag [FLAG_IS_FLOOR] = new_head->flag [FLAG_IS_FLOOR];
454    
455 root 1.74 new_head->min_x = min (new_head->min_x, at->x);
456     new_head->min_y = min (new_head->min_y, at->y);
457     new_head->max_x = max (new_head->max_x, at->x);
458     new_head->max_y = max (new_head->max_y, at->y);
459 root 1.49
460 root 1.64 at->head = new_head;
461     less->more = at;
462     less = at;
463 root 1.63 }
464 root 1.49
465 root 1.73 postponed_arch.insert (postponed_arch.end (), parts.begin (), parts.end ());
466 root 1.53
467 root 1.63 return new_head;
468 root 1.49 }
469 root 1.43
470 root 1.49 fail:
471 root 1.51 for (auto (p, parts.begin ()); p != parts.end (); ++p)
472 root 1.85 (*p)->destroy ();
473 root 1.43
474 root 1.53 return 0;
475 root 1.43 }
476    
477 root 1.53 void
478 root 1.73 archetype::postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch)
479     {
480     ref = 0;
481     postponed_arch_ref.push_back (std::pair<arch_ptr *, shstr>(&ref, shstr (other_arch)));
482     }
483    
484     void
485     archetype::commit_load ()
486 root 1.43 {
487 root 1.73 // unlink old archetypes and link in new ones */
488     for (auto (p, postponed_arch.begin ()); p != postponed_arch.end (); ++p)
489     {
490     archetype *at = *p;
491    
492     if (archetype *old = find (at->archname))
493     old->unlink ();
494    
495 root 1.74 allarch.push_back (at);
496    
497 root 1.73 at->link ();
498 root 1.74 ++dirtycnt;
499 root 1.73 }
500    
501     postponed_arch.clear ();
502    
503     // now resolve arch references
504     for (auto (p, postponed_arch_ref.begin ()); p != postponed_arch_ref.end (); ++p)
505     {
506     arch_ptr *ap = p->first;
507     archetype *at = find (p->second);
508    
509     if (!at)
510     LOG (llevError, "unable to resolve postponed arch reference to '%s'", &p->second);
511    
512     *ap = at;
513     }
514    
515     postponed_arch_ref.clear ();
516    
517     empty = find (shstr_empty_archetype);
518 elmex 1.1 }
519    
520 root 1.74 void
521     archetype::gc ()
522     {
523     int cnt = max (1, min (allarch.size () / 128, dirtycnt));
524     dirtycnt = max (0, dirtycnt - cnt);
525    
526     do
527     {
528     static int idx;
529    
530     if (idx >= allarch.size ())
531     if (idx)
532     idx = 0;
533     else
534     return;
535    
536     archetype *at = allarch [idx];
537    
538     if (at->refcnt_cnt () > 1) // all arches have ONE refcount from their object
539     ++idx;
540     else
541     {
542 root 1.86 LOG (llevDebug, "garbage collect arch %s", &at->archname);
543 root 1.79 assert (at->arch == at); // verify that refcnt == 1 is truly valid
544 root 1.74 allarch.erase (idx);
545 root 1.77
546     // break chain
547     for (object *op = at->head_ (); op; )
548     {
549     object *next = op->more;
550     op->head = 0;
551     op->more = 0;
552     op = next;
553     }
554    
555 root 1.85 at->destroy ();
556 root 1.74 at->arch = 0;
557     }
558     }
559     while (--cnt);
560     }
561    
562 root 1.70 object *
563     archetype::instance ()
564     {
565 root 1.80 object *op = clone ();
566     op->instantiate ();
567     return op;
568 root 1.70 }
569    
570 root 1.92 //+GPL
571    
572 elmex 1.1 /*
573     * Finds which archetype matches the given name, and returns a new
574     * object containing a copy of the archetype.
575     */
576 root 1.12 object *
577     get_archetype (const char *name)
578     {
579 root 1.80 return archetype::get (name);
580 elmex 1.1 }
581    
582 root 1.76 object *
583     archetype::get (const char *name)
584     {
585 root 1.80 archetype *at = find (name);
586    
587     if (!at)
588     return create_singularity (name);
589    
590     return at->instance ();
591 root 1.76 }
592    
593 elmex 1.1 /*
594     * Returns the first archetype using the given type.
595     * Used in treasure-generation.
596     */
597 root 1.95 static archetype *
598 root 1.12 type_to_archetype (int type)
599     {
600 root 1.63 for_all_archetypes (at)
601     if (at->type == type && at->head_ () != at)
602 elmex 1.1 return at;
603 root 1.20
604     return 0;
605 elmex 1.1 }
606    
607     /*
608     * Returns a new object copied from the first archetype matching
609     * the given type.
610     * Used in treasure-generation.
611     */
612 root 1.12 object *
613     clone_arch (int type)
614     {
615 root 1.80 archetype *at = type_to_archetype (type);
616 elmex 1.1
617 root 1.80 if (!at)
618 root 1.12 {
619     LOG (llevError, "Can't clone archetype %d\n", type);
620 root 1.30 return 0;
621 root 1.12 }
622 root 1.20
623 root 1.80 return at->instance ();
624 elmex 1.1 }
625    
626     /*
627     * member: make instance from class
628     */
629 root 1.12 object *
630 root 1.15 object_create_arch (archetype *at)
631 elmex 1.1 {
632 root 1.20 object *op, *prev = 0, *head = 0;
633 elmex 1.1
634 root 1.12 while (at)
635     {
636 root 1.80 op = at->instance ();
637 root 1.63
638     op->x = at->x;
639     op->y = at->y;
640 root 1.20
641 root 1.12 if (head)
642     op->head = head, prev->more = op;
643 root 1.20
644 root 1.12 if (!head)
645     head = op;
646 root 1.20
647 root 1.12 prev = op;
648 root 1.63 at = (archetype *)at->more;
649 elmex 1.1 }
650 root 1.20
651 root 1.63 return head;
652 elmex 1.1 }
653    
654 root 1.92 //-GPL
655