ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/common/arch.C
Revision: 1.41
Committed: Thu Feb 8 03:09:31 2007 UTC (17 years, 3 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.40: +1 -1 lines
Log Message:
Object => object

File Contents

# Content
1 /*
2 * CrossFire, A Multiplayer game for X-windows
3 *
4 * Copyright (C) 2005, 2006, 2007 Marc Lehmann & Crossfire+ Development Team
5 * Copyright (C) 2002 Mark Wedel & Crossfire Development Team
6 * Copyright (C) 1992 Frank Tore Johansen
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your 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 GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 *
22 * The authors can be reached via e-mail at <crossfire@schmorp.de>
23 */
24
25 #include <cassert>
26
27 #include <global.h>
28 #include <funcpoint.h>
29 #include <loader.h>
30
31 #include <tr1/functional>
32 #include <tr1/unordered_map>
33
34 int arch_init; /* True if doing arch initialization */
35
36 /* The naming of these functions is really poor - they are all
37 * pretty much named '.._arch_...', but they may more may not
38 * return archetypes. Some make the arch_to_object call, and thus
39 * return an object. Perhaps those should be called 'archob' functions
40 * to denote they return an object derived from the archetype.
41 * MSW 2003-04-29
42 */
43
44 // the hashtable
45 typedef std::tr1::unordered_map
46 <
47 const char *,
48 arch_ptr,
49 str_hash,
50 str_equal,
51 slice_allocator< std::pair<const char *const, arch_ptr> >
52 > HT;
53
54 static HT ht (5000);
55
56 /**
57 * GROS - This function retrieves an archetype given the name that appears
58 * during the game (for example, "writing pen" instead of "stylus").
59 * It does not use the hashtable system, but browse the whole archlist each time.
60 * I suggest not to use it unless you really need it because of performance issue.
61 * It is currently used by scripting extensions (create-object).
62 * Params:
63 * - name: the name we're searching for (ex: "writing pen");
64 * Return value:
65 * - the archetype found or null if nothing was found.
66 */
67 archetype *
68 find_archetype_by_object_name (const char *name)
69 {
70 shstr_cmp name_cmp (name);
71
72 for (archetype *at = first_archetype; at; at = at->next)
73 if (at->clone.name == name_cmp)
74 return at;
75
76 return 0;
77 }
78
79 /**
80 * This function retrieves an archetype by type and name that appears during
81 * the game. It is basically the same as find_archetype_by_object_name()
82 * except that it considers only items of the given type.
83 */
84 archetype *
85 find_archetype_by_object_type_name (int type, const char *name)
86 {
87 shstr_cmp name_cmp (name);
88
89 for (archetype *at = first_archetype; at; at = at->next)
90 if (at->clone.name == name_cmp && at->clone.type == type)
91 return at;
92
93 return 0;
94 }
95
96 /* This is a lot like the above function. Instead, we are trying to match
97 * the arch->skill values. type is the type of object to match
98 * against (eg, to only match against skills or only skill objects for example).
99 * If type is -1, ew don't match on type.
100 */
101 object *
102 get_archetype_by_skill_name (const char *skill, int type)
103 {
104 shstr_cmp skill_cmp (skill);
105
106 for (archetype *at = first_archetype; at; at = at->next)
107 if (at->clone.skill == skill_cmp && (type == -1 || type == at->clone.type))
108 return arch_to_object (at);
109
110 return 0;
111 }
112
113 /* similiar to above - this returns the first archetype
114 * that matches both the type and subtype. type and subtype
115 * can be -1 to say ignore, but in this case, the match it does
116 * may not be very useful. This function is most useful when
117 * subtypes are known to be unique for a particular type
118 * (eg, skills)
119 */
120 archetype *
121 get_archetype_by_type_subtype (int type, int subtype)
122 {
123 for (archetype *at = first_archetype; at; at = at->next)
124 if ((type == -1 || type == at->clone.type) && (subtype == -1 || subtype == at->clone.subtype))
125 return at;
126
127 return 0;
128 }
129
130 /**
131 * GROS - this returns a new object given the name that appears during the game
132 * (for example, "writing pen" instead of "stylus").
133 * Params:
134 * - name: The name we're searching for (ex: "writing pen");
135 * Return value:
136 * - a corresponding object if found; a singularity object if not found.
137 * Note by MSW - it appears that it takes the full name and keeps
138 * shortening it until it finds a match. I re-wrote this so that it
139 * doesn't malloc it each time - not that this function is used much,
140 * but it otherwise had a big memory leak.
141 */
142 object *
143 get_archetype_by_object_name (const char *name)
144 {
145 char tmpname[MAX_BUF];
146 int i;
147
148 assign (tmpname, name);
149
150 for (i = strlen (tmpname); i > 0; i--)
151 {
152 tmpname[i] = 0;
153
154 if (archetype *at = find_archetype_by_object_name (tmpname))
155 return arch_to_object (at);
156 }
157
158 return create_singularity (name);
159 }
160
161 /* This is a subset of the parse_id command. Basically, name can be
162 * a string seperated lists of things to match, with certain keywords.
163 * pl is the player (only needed to set count properly)
164 * op is the item we are trying to match. Calling function takes care
165 * of what action might need to be done and if it is valid
166 * (pickup, drop, etc.) Return NONZERO if we have a match. A higher
167 * value means a better match. 0 means no match.
168 *
169 * Brief outline of the procedure:
170 * We take apart the name variable into the individual components.
171 * cases for 'all' and unpaid are pretty obvious.
172 * Next, we check for a count (either specified in name, or in the
173 * player object.)
174 * If count is 1, make a quick check on the name.
175 * IF count is >1, we need to make plural name. Return if match.
176 * Last, make a check on the full name.
177 */
178 int
179 item_matched_string (object *pl, object *op, const char *name)
180 {
181 char *cp, local_name[MAX_BUF];
182 int count, retval = 0;
183
184 assign (local_name, name); /* strtok is destructive to name */
185
186 for (cp = strtok (local_name, ","); cp; cp = strtok (NULL, ","))
187 {
188 while (cp[0] == ' ')
189 ++cp; /* get rid of spaces */
190
191 /* LOG(llevDebug,"Trying to match %s\n", cp); */
192 /* All is a very generic match - low match value */
193 if (!strcmp (cp, "all"))
194 return 1;
195
196 /* unpaid is a little more specific */
197 if (!strcmp (cp, "unpaid") && QUERY_FLAG (op, FLAG_UNPAID))
198 return 2;
199 if (!strcmp (cp, "cursed") && QUERY_FLAG (op, FLAG_KNOWN_CURSED) && (QUERY_FLAG (op, FLAG_CURSED) || QUERY_FLAG (op, FLAG_DAMNED)))
200 return 2;
201
202 if (!strcmp (cp, "unlocked") && !QUERY_FLAG (op, FLAG_INV_LOCKED))
203 return 2;
204
205 /* Allow for things like '100 arrows' */
206 if ((count = atoi (cp)) != 0)
207 {
208 cp = strchr (cp, ' ');
209 while (cp && cp[0] == ' ')
210 ++cp; /* get rid of spaces */
211 }
212 else
213 {
214 if (pl->type == PLAYER)
215 count = pl->contr->count;
216 else
217 count = 0;
218 }
219
220 if (!cp || cp[0] == '\0' || count < 0)
221 return 0;
222
223
224 /* The code here should go from highest retval to lowest. That
225 * is because of the 'else' handling - we don't want to match on
226 * something and set a low retval, even though it may match a higher retcal
227 * later. So keep it in descending order here, so we try for the best
228 * match first, and work downward.
229 */
230 if (!strcasecmp (cp, query_name (op)))
231 retval = 20;
232 else if (!strcasecmp (cp, query_short_name (op)))
233 retval = 18;
234 else if (!strcasecmp (cp, query_base_name (op, 0)))
235 retval = 16;
236 else if (!strcasecmp (cp, query_base_name (op, 1)))
237 retval = 16;
238 else if (op->custom_name && !strcasecmp (cp, op->custom_name))
239 retval = 15;
240 else if (!strncasecmp (cp, query_base_name (op, 0), strlen (cp)))
241 retval = 14;
242 else if (!strncasecmp (cp, query_base_name (op, 1), strlen (cp)))
243 retval = 14;
244 /* Do substring checks, so things like 'Str+1' will match.
245 * retval of these should perhaps be lower - they are lower
246 * then the specific strcasecmp aboves, but still higher than
247 * some other match criteria.
248 */
249 else if (strstr (query_base_name (op, 1), cp))
250 retval = 12;
251 else if (strstr (query_base_name (op, 0), cp))
252 retval = 12;
253 else if (strstr (query_short_name (op), cp))
254 retval = 12;
255 /* Check against plural/non plural based on count. */
256 else if (count > 1 && !strcasecmp (cp, op->name_pl))
257 retval = 6;
258 else if (count == 1 && !strcasecmp (op->name, cp))
259 retval = 6;
260 /* base name matched - not bad */
261 else if (strcasecmp (cp, op->name) == 0 && !count)
262 retval = 4;
263 /* Check for partial custom name, but give a real low priority */
264 else if (op->custom_name && strstr (op->custom_name, cp))
265 retval = 3;
266
267 if (retval)
268 {
269 if (pl->type == PLAYER)
270 pl->contr->count = count;
271
272 return retval;
273 }
274 }
275
276 return 0;
277 }
278
279 /*
280 * Initialises the internal linked list of archetypes (read from file).
281 * Then the global "empty_archetype" pointer is initialised.
282 * Then the blocksview[] array is initialised.
283 */
284
285 void
286 init_archetypes (void)
287 { /* called from add_player() and edit() */
288 if (first_archetype != NULL) /* Only do this once */
289 return;
290
291 arch_init = 1;
292 load_archetypes ();
293 arch_init = 0;
294 empty_archetype = archetype::find ("empty_archetype");
295
296 /* init_blocksview();*/
297 }
298
299 /*
300 * An alternative way to init the hashtable which is slower, but _works_...
301 */
302 void
303 init_archetable (void)
304 {
305 archetype *at;
306
307 LOG (llevDebug, " Setting up archetable...\n");
308
309 for (at = first_archetype; at; at = at->more ? at->more : at->next)
310 at->hash_add ();
311
312 LOG (llevDebug, "done\n");
313 }
314
315 void
316 free_all_archs (void)
317 {
318 archetype *at, *next;
319 int i = 0, f = 0;
320
321 for (at = first_archetype; at; at = next)
322 {
323 if (at->more)
324 next = at->more;
325 else
326 next = at->next;
327
328 delete
329 at;
330
331 i++;
332 }
333
334 LOG (llevDebug, "Freed %d archetypes, %d faces\n", i, f);
335 }
336
337 archetype::archetype ()
338 {
339 CLEAR_FLAG (&clone, FLAG_FREED); /* This shouldn't matter, since copy_to */
340 SET_FLAG (&clone, FLAG_REMOVED); /* doesn't copy these flags... */
341 }
342
343 archetype::~archetype ()
344 {
345 }
346
347 /*
348 * Reads/parses the archetype-file, and copies into a linked list
349 * of archetype-structures.
350 */
351 void
352 first_arch_pass (object_thawer & fp)
353 {
354 archetype *head = 0, *last_more = 0;
355
356 archetype *at = new archetype;
357 at->clone.arch = first_archetype = at;
358
359 while (int i = load_object (fp, &at->clone, 0))
360 {
361 at->clone.speed_left = (float) (-0.1);
362 /* copy the body_info to the body_used - this is only really
363 * need for monsters, but doesn't hurt to do it for everything.
364 * by doing so, when a monster is created, it has good starting
365 * values for the body_used info, so when items are created
366 * for it, they can be properly equipped.
367 */
368 memcpy (&at->clone.body_used, &at->clone.body_info, sizeof (at->clone.body_info));
369
370 switch (i)
371 {
372 case LL_NORMAL: /* A new archetype, just link it with the previous */
373 if (last_more != NULL)
374 last_more->next = at;
375 if (head != NULL)
376 head->next = at;
377 head = last_more = at;
378 #if 0
379 if (!op->type)
380 LOG (llevDebug, " WARNING: Archetype %s has no type info!\n", op->arch->name);
381 #endif
382 at->tail_x = 0;
383 at->tail_y = 0;
384 break;
385
386 case LL_MORE: /* Another part of the previous archetype, link it correctly */
387
388 at->head = head;
389 at->clone.head = &head->clone;
390 if (last_more != NULL)
391 {
392 last_more->more = at;
393 last_more->clone.more = &at->clone;
394 }
395 last_more = at;
396
397 /* If this multipart image is still composed of individual small
398 * images, don't set the tail_.. values. We can't use them anyways,
399 * and setting these to zero makes the map sending to the client much
400 * easier as just looking at the head, we know what to do.
401 */
402 if (at->clone.face != head->clone.face)
403 {
404 head->tail_x = 0;
405 head->tail_y = 0;
406 }
407 else
408 {
409 if (at->clone.x > head->tail_x)
410 head->tail_x = at->clone.x;
411 if (at->clone.y > head->tail_y)
412 head->tail_y = at->clone.y;
413 }
414 break;
415
416 }
417
418 at = new archetype;
419
420 at->clone.arch = at;
421 }
422
423 delete at;
424 }
425
426 /*
427 * Reads the archetype file once more, and links all pointers between
428 * archetypes.
429 */
430
431 void
432 second_arch_pass (object_thawer & thawer)
433 {
434 char buf[MAX_BUF], *variable = buf, *argument, *cp;
435 archetype *at = NULL, *other;
436
437 while (fgets (buf, MAX_BUF, thawer) != NULL)
438 {
439 if (*buf == '#')
440 continue;
441 if ((argument = strchr (buf, ' ')) != NULL)
442 {
443 *argument = '\0', argument++;
444 cp = argument + strlen (argument) - 1;
445 while (isspace (*cp))
446 {
447 *cp = '\0';
448 cp--;
449 }
450 }
451 if (!strcmp ("object", variable))
452 {
453 if ((at = archetype::find (argument)) == NULL)
454 LOG (llevError, "Warning: failed to find arch %s\n", argument);
455 }
456 else if (!strcmp ("other_arch", variable))
457 {
458 if (at != NULL && at->clone.other_arch == NULL)
459 {
460 if ((other = archetype::find (argument)) == NULL)
461 LOG (llevError, "Warning: failed to find other_arch %s\n", argument);
462 else if (at != NULL)
463 at->clone.other_arch = other;
464 }
465 }
466 else if (!strcmp ("randomitems", variable))
467 {
468 if (at != NULL)
469 {
470 treasurelist *tl = find_treasurelist (argument);
471
472 if (tl == NULL)
473 LOG (llevError, "Failed to link treasure to arch (%s): %s\n", &at->name, argument);
474 else
475 at->clone.randomitems = tl;
476 }
477 }
478 }
479 }
480
481 #ifdef DEBUG
482 void
483 check_generators (void)
484 {
485 archetype *at;
486
487 for (at = first_archetype; at != NULL; at = at->next)
488 if (QUERY_FLAG (&at->clone, FLAG_GENERATOR) && at->clone.other_arch == NULL)
489 LOG (llevError, "Warning: %s is generator but lacks other_arch.\n", &at->name);
490 }
491 #endif
492
493 /*
494 * First initialises the archtype hash-table (init_archetable()).
495 * Reads and parses the archetype file (with the first and second-pass
496 * functions).
497 * Then initialises treasures by calling load_treasures().
498 */
499
500 void
501 load_archetypes (void)
502 {
503 char filename[MAX_BUF];
504
505 sprintf (filename, "%s/%s", settings.datadir, settings.archetypes);
506 LOG (llevDebug, "Reading archetypes from %s:\n", filename);
507
508 {
509 object_thawer
510 thawer (filename);
511
512 LOG (llevDebug, " arch-pass 1...\n");
513 first_arch_pass (thawer);
514 LOG (llevDebug, " done\n");
515 }
516
517 init_archetable ();
518 warn_archetypes = 1;
519
520 {
521 object_thawer
522 thawer (filename);
523
524 LOG (llevDebug, " loading treasure...\n");
525 load_treasures ();
526 LOG (llevDebug, " done\n");
527 LOG (llevDebug, " arch-pass 2...\n");
528 second_arch_pass (thawer);
529 LOG (llevDebug, " done\n");
530 #ifdef DEBUG
531 check_generators ();
532 #endif
533 }
534 LOG (llevDebug, " done\n");
535 }
536
537 /*
538 * Creates and returns a new object which is a copy of the given archetype.
539 * This function returns NULL on failure.
540 */
541 object *
542 arch_to_object (archetype *at)
543 {
544 object *op;
545
546 if (at == NULL)
547 {
548 if (warn_archetypes)
549 LOG (llevError, "Couldn't find archetype.\n");
550
551 return NULL;
552 }
553
554 op = at->clone.clone ();
555 op->arch = at;
556 op->instantiate ();
557 return op;
558 }
559
560 /*
561 * Creates an object. This function is called by get_archetype()
562 * if it fails to find the appropriate archetype.
563 * Thus get_archetype() will be guaranteed to always return
564 * an object, and never NULL.
565 */
566 object *
567 create_singularity (const char *name)
568 {
569 object *op;
570 char buf[MAX_BUF];
571
572 sprintf (buf, "%s (%s)", ARCH_SINGULARITY, name);
573 op = object::create ();
574 op->name = op->name_pl = buf;
575 SET_FLAG (op, FLAG_NO_PICK);
576 return op;
577 }
578
579 /*
580 * Finds which archetype matches the given name, and returns a new
581 * object containing a copy of the archetype.
582 */
583 object *
584 get_archetype (const char *name)
585 {
586 archetype *at = archetype::find (name);
587
588 if (!at)
589 return create_singularity (name);
590
591 return arch_to_object (at);
592 }
593
594 /*
595 * Hash-function used by the arch-hashtable.
596 */
597
598 unsigned long
599 hasharch (const char *str, int tablesize)
600 {
601 unsigned long hash = 0;
602 unsigned int i = 0;
603 const char *p;
604
605 /* use the one-at-a-time hash function, which supposedly is
606 * better than the djb2-like one used by perl5.005, but
607 * certainly is better then the bug used here before.
608 * see http://burtleburtle.net/bob/hash/doobs.html
609 */
610 for (p = str; i < MAXSTRING && *p; p++, i++)
611 {
612 hash += *p;
613 hash += hash << 10;
614 hash ^= hash >> 6;
615 }
616
617 hash += hash << 3;
618 hash ^= hash >> 11;
619 hash += hash << 15;
620
621 return hash % tablesize;
622 }
623
624 /*
625 * Finds, using the hashtable, which archetype matches the given name.
626 * returns a pointer to the found archetype, otherwise NULL.
627 */
628 archetype *
629 archetype::find (const char *name)
630 {
631 if (!name)
632 return 0;
633
634 AUTODECL (i, ht.find (name));
635
636 if (i == ht.end ())
637 return 0;
638 else
639 return i->second;
640 }
641
642 /*
643 * Adds an archetype to the hashtable.
644 */
645 void
646 archetype::hash_add ()
647 {
648 ht.insert (std::make_pair (name, this));
649 }
650
651 void
652 archetype::hash_del ()
653 {
654 ht.erase (name);
655 }
656
657 /*
658 * Returns the first archetype using the given type.
659 * Used in treasure-generation.
660 */
661 archetype *
662 type_to_archetype (int type)
663 {
664 archetype *at;
665
666 for (at = first_archetype; at; at = at->more == 0 ? at->next : at->more)
667 if (at->clone.type == type)
668 return at;
669
670 return 0;
671 }
672
673 /*
674 * Returns a new object copied from the first archetype matching
675 * the given type.
676 * Used in treasure-generation.
677 */
678
679 object *
680 clone_arch (int type)
681 {
682 archetype *at;
683
684 if ((at = type_to_archetype (type)) == NULL)
685 {
686 LOG (llevError, "Can't clone archetype %d\n", type);
687 return 0;
688 }
689
690 object *op = at->clone.clone ();
691 op->instantiate ();
692 return op;
693 }
694
695 /*
696 * member: make instance from class
697 */
698
699 object *
700 object_create_arch (archetype *at)
701 {
702 object *op, *prev = 0, *head = 0;
703
704 while (at)
705 {
706 op = arch_to_object (at);
707 op->x = at->clone.x;
708 op->y = at->clone.y;
709
710 if (head)
711 op->head = head, prev->more = op;
712
713 if (!head)
714 head = op;
715
716 prev = op;
717 at = at->more;
718 }
719
720 return (head);
721 }
722