ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/common/arch.C
Revision: 1.119
Committed: Sat Dec 1 20:22:12 2018 UTC (5 years, 5 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: HEAD
Changes since 1.118: +1 -1 lines
Log Message:
slight cleanup

File Contents

# Content
1 /*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 *
4 * Copyright (©) 2017,2018 Marc Alexander Lehmann / the Deliantra team
5 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
6 * Copyright (©) 2002 Mark Wedel & Crossfire Development Team
7 * Copyright (©) 1992 Frank Tore Johansen
8 *
9 * Deliantra is free software: you can redistribute it and/or modify it under
10 * the terms of the Affero GNU General Public License as published by the
11 * Free Software Foundation, either version 3 of the License, or (at your
12 * option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the Affero GNU General Public License
20 * and the GNU General Public License along with this program. If not, see
21 * <http://www.gnu.org/licenses/>.
22 *
23 * The authors can be reached via e-mail to <support@deliantra.net>
24 */
25
26 #include <cassert>
27 #include <functional>
28
29 #include <flat_hash_map.hpp>
30
31 #include <global.h>
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 ska::flat_hash_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 archetype::get ()
60 * if it fails to find the appropriate archetype.
61 * Thus archetype::get() 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") && op->flag [FLAG_UNPAID])
219 return 2;
220
221 if (!strcmp (cp, "cursed") && op->flag [FLAG_KNOWN_CURSED] && (op->flag [FLAG_CURSED] || op->flag [FLAG_DAMNED]))
222 return 2;
223
224 if (!strcmp (cp, "unlocked") && !op->flag [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 void
306 archetype::do_delete ()
307 {
308 delete this;
309 }
310
311 archetype::archetype (const char *name)
312 {
313 arch = this;
314 this->archname = this->name = this->name_pl = name;
315 }
316
317 archetype::~archetype ()
318 {
319 unlink ();
320 }
321
322 void
323 archetype::link ()
324 {
325 if (!archetypes.contains (this))
326 {
327 archetypes.insert (this);
328 ht.insert (std::make_pair (archname, this));
329 }
330 }
331
332 void
333 archetype::unlink ()
334 {
335 if (archetypes.contains (this))
336 {
337 archetypes.erase (this);
338 ht.erase (archname);
339 }
340 }
341
342 /*
343 * Finds, using the hashtable, which archetype matches the given name.
344 * returns a pointer to the found archetype, otherwise NULL.
345 */
346 archetype *
347 archetype::find (const char *name)
348 {
349 if (!name)
350 return 0;
351
352 auto i = ht.find (name);
353
354 if (i == ht.end ())
355 return 0;
356 else
357 return i->second;
358 }
359
360 void
361 archetype::post_load_check ()
362 {
363 assert (("obj_original MUST NOT be set for archetypes", !flag [FLAG_OBJ_ORIGINAL]));
364
365 if (type == SKILL)
366 add_skill_archetype (this);
367
368 object::post_load_check ();
369 }
370
371 archetype *
372 archetype::read (object_thawer &f)
373 {
374 assert (f.kw == KW_object);
375
376 std::vector<archetype *> parts;
377
378 coroapi::cede_to_tick ();
379
380 for (;;)
381 {
382 archetype *at = new archetype (f.get_str ());
383
384 f.next ();
385
386 #if 0
387 // implementing it here in the server does neither allow multiple inheritence
388 // nor does it cleanly "just override". it would allow use in map files, though,
389 // and other resource files dynamically loaded (as opposed to being preprocessed).
390 // not that any of this is relevant as of yet...
391 if (f.kw == KW_inherit)
392 {
393 if (archetype *at = find (f.get_str ()))
394 *op = at->clone;
395 else
396 LOG (llevError, "archetype '%s' tries to inherit from non-existent archetype '%s'.\n",
397 &at->archname, f.get_str ());
398
399 f.next ();
400 }
401 #endif
402
403 loading_arch = at; // hack to tell parse_kv et al. to behave
404 bool parse_ok = at->parse_kv (f);
405 loading_arch = 0;
406
407 if (!parse_ok)
408 goto fail;
409
410 loading_arch = at; // hack to tell parse_kv et al. to behave
411 at->post_load_check ();
412 loading_arch = 0;
413
414 parts.push_back (at);
415
416 if (f.kw != KW_more)
417 break;
418
419 f.next ();
420
421 if (f.kw != KW_object)
422 {
423 f.parse_error ("more object");
424 goto fail;
425 }
426 }
427
428 {
429 archetype *new_head = parts.front ();
430 archetype *old_head = find (new_head->archname);
431
432 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
439 // check that all archetypes belong to the same old object or are new
440 for (auto &&at : parts)
441 {
442 archetype *new_part = at;
443 archetype *old_part = find (new_part->archname);
444
445 if (old_part && old_part->head_ () != old_head)
446 {
447 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 goto fail;
450 }
451 }
452
453 // assemble new chain
454 new_head->max_x = new_head->x;
455
456 archetype *less = new_head;
457 for (auto &&p = parts.begin () + 1; p != parts.end (); ++p)
458 {
459 archetype *at = *p;
460
461 // some flags get inherited from the head (probably a lot more)
462 // 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 new_head->max_x = max (new_head->max_x, at->x);
470
471 at->head = new_head;
472 less->more = at;
473 less = at;
474 }
475
476 postponed_arch.insert (postponed_arch.end (), parts.begin (), parts.end ());
477
478 return new_head;
479 }
480
481 fail:
482 for (auto &&at : parts)
483 at->destroy ();
484
485 return 0;
486 }
487
488 void
489 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 {
498 // unlink old archetypes and link in new ones */
499 for (auto &&at : postponed_arch)
500 {
501 if (archetype *old = find (at->archname))
502 old->unlink ();
503
504 allarch.push_back (at);
505
506 at->link ();
507 ++dirtycnt;
508 }
509
510 postponed_arch.clear ();
511
512 // now resolve arch references
513 for (auto &&p : postponed_arch_ref) // not yet C++17
514 {
515 arch_ptr *ap = p.first;
516 archetype *at = find (p.second);
517
518 if (!at)
519 LOG (llevError, "unable to resolve postponed arch reference to '%s'", &p.second);
520
521 *ap = at;
522 }
523
524 postponed_arch_ref.clear ();
525
526 empty = find (shstr_empty_archetype);
527 }
528
529 void
530 archetype::gc ()
531 {
532 int cnt = max (1, min<int> (allarch.size () / 128, dirtycnt));
533 dirtycnt = max (0, dirtycnt - cnt);
534
535 do
536 {
537 static int idx;
538
539 if (idx >= allarch.size ())
540 if (idx)
541 idx = 0;
542 else
543 return;
544
545 archetype *at = allarch [idx];
546
547 if (at->refcnt_cnt () > 1) // all arches have ONE refcount from their object
548 ++idx;
549 else
550 {
551 //LOG (llevDebug, "garbage collect arch %s", &at->archname);
552 assert (at->arch == at); // verify that refcnt == 1 is truly valid
553 allarch.erase (idx);
554
555 // break chain
556 for (object *op = at->head_ (); op; )
557 {
558 object *next = op->more;
559 op->head = 0;
560 op->more = 0;
561 op = next;
562 }
563
564 at->destroy ();
565 at->arch = 0;
566 }
567 }
568 while (--cnt);
569 }
570
571 object *
572 archetype::instance ()
573 {
574 object *op = clone ();
575 op->instantiate ();
576 return op;
577 }
578
579 //+GPL
580
581 /*
582 * Finds which archetype matches the given name, and returns a new
583 * object containing a copy of the archetype.
584 */
585 object *
586 archetype::get (const char *name)
587 {
588 archetype *at = find (name);
589
590 if (!at)
591 return create_singularity (name);
592
593 return at->instance ();
594 }
595
596 /*
597 * Returns the first archetype using the given type.
598 * Used in treasure-generation.
599 */
600 static archetype *
601 type_to_archetype (int type)
602 {
603 for_all_archetypes (at)
604 if (at->type == type && at->head_ () != at)
605 return at;
606
607 return 0;
608 }
609
610 /*
611 * Returns a new object copied from the first archetype matching
612 * the given type.
613 * Used in treasure-generation.
614 */
615 object *
616 clone_arch (int type)
617 {
618 archetype *at = type_to_archetype (type);
619
620 if (!at)
621 {
622 LOG (llevError, "Can't clone archetype %d\n", type);
623 return 0;
624 }
625
626 return at->instance ();
627 }
628
629 /*
630 * member: make instance from class
631 */
632 object *
633 object_create_arch (archetype *at)
634 {
635 object *op, *prev = 0, *head = 0;
636
637 while (at)
638 {
639 op = at->instance ();
640
641 op->x = at->x;
642 op->y = at->y;
643
644 if (head)
645 op->head = head, prev->more = op;
646
647 if (!head)
648 head = op;
649
650 prev = op;
651 at = (archetype *)at->more;
652 }
653
654 return head;
655 }
656
657 //-GPL
658