ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/common/arch.C
Revision: 1.92
Committed: Thu Nov 5 15:43:21 2009 UTC (14 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.91: +8 -0 lines
Log Message:
mark gpl sections, common/

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