server/common/arch.C

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 * 
 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002,2007 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992,2007 Frank Tore Johansen
 * 
 * Deliantra is free software: you can redistribute it and/or modify it under
 * the terms of the Affero GNU General Public License as published by the
 * Free Software Foundation, either version 3 of the License, or (at your
 * option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the Affero GNU General Public License
 * and the GNU General Public License along with this program. If not, see
 * <http://www.gnu.org/licenses/>.
 * 
 * The authors can be reached via e-mail to <support@deliantra.net>
 */

#include <cassert>

#include <global.h>
#include <loader.h>

#include <tr1/functional>
#include <tr1/unordered_map>

archetype *loading_arch; // ugly flag to object loader etc. to suppress/request special processing
arch_ptr archetype::empty;

// the hashtable
typedef std::tr1::unordered_map
  <
    const char *,
    arch_ptr,
    str_hash,
    str_equal,
    slice_allocator< std::pair<const char *const, arch_ptr> >
  > HT;

static HT ht (10000);
archvec archetypes;
static unordered_vector<archetype *> allarch;
static int dirtycnt;

// the vector of other_arch references to be resolved
static std::vector< std::pair<arch_ptr *, shstr> > postponed_arch_ref;
// the vector of loaded but not yet committed archetypes
static std::vector<archetype *> postponed_arch;

//+GPL

/*
 * Creates an object.  This function is called by get_archetype ()
 * if it fails to find the appropriate archetype.
 * Thus get_archetype() will be guaranteed to always return
 * an object, and never NULL.
 */
static object *
create_singularity (const char *name)
{
  LOG (llevError | logBacktrace, "FATAL: creating singularity for '%s'.\n", name);

  if (!strcmp (name, "bug"))
    abort ();

  object *op = archetype::get (shstr_bug);
  op->name = op->name_pl = format ("bug, please report (missing archetype %s)", name);

  return op;
}

/**
 * GROS -  This function retrieves an archetype given the name that appears
 * during the game (for example, "writing pen" instead of "stylus").
 * It does not use the hashtable system, but browse the whole archlist each time.
 * I suggest not to use it unless you really need it because of performance issue.
 * It is currently used by scripting extensions (create-object).
 * Params:
 * - name: the name we're searching for (ex: "writing pen");
 * Return value:
 * - the archetype found or null if nothing was found.
 */
archetype *
find_archetype_by_object_name (const char *name)
{
  shstr_cmp name_cmp (name);

  for_all_archetypes (at)
    if (at->name == name_cmp)
      return at;

  return 0;
}

/**
 * This function retrieves an archetype by type and name that appears during
 * the game. It is basically the same as find_archetype_by_object_name()
 * except that it considers only items of the given type.
 */
archetype *
find_archetype_by_object_type_name (int type, const char *name)
{
  shstr_cmp name_cmp (name);

  for_all_archetypes (at)
    if (at->name == name_cmp && at->type == type)
      return at;

  return 0;
}

/* This is a lot like the above function.  Instead, we are trying to match
 * the arch->skill values.  type is the type of object to match
 * against (eg, to only match against skills or only skill objects for example).
 * If type is -1, ew don't match on type.
 */
object *
get_archetype_by_skill_name (const char *skill, int type)
{
  shstr_cmp skill_cmp (skill);

  for_all_archetypes (at)
    if (at->skill == skill_cmp && (type == -1 || type == at->type))
      return at->instance ();

  return 0;
}

/* similiar to above - this returns the first archetype
 * that matches both the type and subtype.  type and subtype
 * can be -1 to say ignore, but in this case, the match it does
 * may not be very useful.  This function is most useful when
 * subtypes are known to be unique for a particular type
 * (eg, skills)
 */
archetype *
get_archetype_by_type_subtype (int type, int subtype)
{
  for_all_archetypes (at)
    if ((type == -1 || type == at->type) && (subtype == -1 || subtype == at->subtype))
      return at;

  return 0;
}

/**
 * GROS - this returns a new object given the name that appears during the game
 * (for example, "writing pen" instead of "stylus").
 * Params:
 * - name: The name we're searching for (ex: "writing pen");
 * Return value:
 * - a corresponding object if found; a singularity object if not found.
 * Note by MSW - it appears that it takes the full name and keeps
 * shortening it until it finds a match.  I re-wrote this so that it
 * doesn't allocate it each time - not that this function is used much,
 * but it otherwise had a big memory leak.
 */
object *
get_archetype_by_object_name (const char *name)
{
  char tmpname[MAX_BUF];

  assign (tmpname, name);

  for (int i = strlen (tmpname); i > 0; i--)
    {
      tmpname[i] = 0;

      if (archetype *at = find_archetype_by_object_name (tmpname))
        return at->instance ();
    }

  return create_singularity (name);
}

/* This is a subset of the parse_id command.  Basically, name can be
 * a string seperated lists of things to match, with certain keywords.
 * pl is the player (only needed to set count properly)
 * op is the item we are trying to match.  Calling function takes care
 * of what action might need to be done and if it is valid
 * (pickup, drop, etc.)  Return NONZERO if we have a match.  A higher
 * value means a better match.  0 means no match.
 *
 * Brief outline of the procedure:
 * We take apart the name variable into the individual components.
 * cases for 'all' and unpaid are pretty obvious.
 * Next, we check for a count (either specified in name, or in the
 * player object.)
 * If count is 1, make a quick check on the name.
 * IF count is >1, we need to make plural name.  Return if match.
 * Last, make a check on the full name.
 */
int
item_matched_string (object *pl, object *op, const char *name)
{
  char *cp, local_name[MAX_BUF];
  int count, retval = 0;

  assign (local_name, name);    /* strtok is destructive to name */

  for (cp = strtok (local_name, ","); cp; cp = strtok (NULL, ","))
    {
      while (cp[0] == ' ')
        ++cp;                   /* get rid of spaces */

      /*      LOG(llevDebug,"Trying to match %s\n", cp); */
      /* All is a very generic match - low match value */
      if (!strcmp (cp, "all"))
        return 1;

      /* unpaid is a little more specific */
      if (!strcmp (cp, "unpaid") && QUERY_FLAG (op, FLAG_UNPAID))
        return 2;

      if (!strcmp (cp, "cursed") && QUERY_FLAG (op, FLAG_KNOWN_CURSED) && (QUERY_FLAG (op, FLAG_CURSED) || QUERY_FLAG (op, FLAG_DAMNED)))
        return 2;

      if (!strcmp (cp, "unlocked") && !QUERY_FLAG (op, FLAG_INV_LOCKED))
        return 2;

      /* Allow for things like '100 arrows' */
      if ((count = atoi (cp)) != 0)
        {
          cp = strchr (cp, ' ');
          while (cp && cp[0] == ' ')
            ++cp;               /* get rid of spaces */
        }
      else
        {
          if (pl->type == PLAYER)
            count = pl->contr->count;
          else
            count = 0;
        }

      if (!cp || cp[0] == '\0' || count < 0)
        return 0;


      /* The code here should go from highest retval to lowest.  That
       * is because of the 'else' handling - we don't want to match on
       * something and set a low retval, even though it may match a higher retcal
       * later.  So keep it in descending order here, so we try for the best
       * match first, and work downward.
       */
      const char *qbn0, *qbn1, *qsn; // query base name/short name caches

      if (!strcasecmp (cp, query_name (op)))
        retval = 20;
      else if (!strcasecmp (cp, qsn = query_short_name (op)))
        retval = 18;
      else if (!strcasecmp (cp, qbn0 = query_base_name (op, 0)))
        retval = 16;
      else if (!strcasecmp (cp, qbn1 = query_base_name (op, 1)))
        retval = 16;
      else if (op->custom_name && !strcasecmp (cp, op->custom_name))
        retval = 15;
      else if (!strncasecmp (cp, qbn0, strlen (cp)))
        retval = 14;
      else if (!strncasecmp (cp, qbn1, strlen (cp)))
        retval = 14;
      /* Do substring checks, so things like 'Str+1' will match.
       * retval of these should perhaps be lower - they are lower
       * then the specific strcasecmp aboves, but still higher than
       * some other match criteria.
       */
      else if (strstr (qbn1, cp))
        retval = 12;
      else if (strstr (qbn0, cp))
        retval = 12;
      else if (strstr (qsn, cp))
        retval = 12;
      /* Check against plural/non plural based on count. */
      else if (count > 1 && !strcasecmp (cp, op->name_pl))
        retval = 6;
      else if (count == 1 && !strcasecmp (op->name, cp))
        retval = 6;
      /* base name matched - not bad */
      else if (strcasecmp (cp, op->name) == 0 && !count)
        retval = 4;
      /* Check for partial custom name, but give a real low priority */
      else if (op->custom_name.contains (cp))
        retval = 3;

      if (retval)
        {
          if (pl->type == PLAYER)
            pl->contr->count = count;

          return retval;
        }
    }

  return 0;
}

//-GPL

archetype::archetype (const char *name)
{
  arch = this;
  this->archname = this->name = this->name_pl = name;
}

archetype::~archetype ()
{
  unlink ();
}

void
archetype::link ()
{
  if (!archetypes.contains (this))
    {
      archetypes.insert (this);
      ht.insert (std::make_pair (archname, this));
    }
}

void
archetype::unlink ()
{
  if (archetypes.contains (this))
    {
      archetypes.erase (this);
      ht.erase (archname);
    }
}

/*
 * Finds, using the hashtable, which archetype matches the given name.
 * returns a pointer to the found archetype, otherwise NULL.
 */
archetype *
archetype::find (const char *name)
{
  if (!name)
    return 0;

  auto (i, ht.find (name));

  if (i == ht.end ())
    return 0;
  else
    return i->second;
}

void
archetype::post_load_check ()
{
  object::post_load_check ();

  assert (("obj_original MUST NOT be set for archetypes", !flag [FLAG_OBJ_ORIGINAL]));
}

archetype *
archetype::read (object_thawer &f)
{
  assert (f.kw == KW_object);

  std::vector<archetype *> parts;

  coroapi::cede_to_tick ();

  for (;;)
    {
      archetype *at = new archetype (f.get_str ());

      f.next ();

#if 0
      // implementing it here in the server does neither allow multiple inheritence
      // nor does it cleanly "just override". it would allow use in map files, though,
      // and other resource files dynamically laoded (as opposed to being preprocessed).
      // not that any of this is relevant as of yet...
      if (f.kw == KW_inherit)
        {
          if (archetype *at = find (f.get_str ()))
            *op = at->clone;
          else
            LOG (llevError, "archetype '%s' tries to inherit from non-existent archetype '%s'.\n",
                 &at->archname, f.get_str ());

          f.next ();
        }
#endif

      loading_arch = at; // hack to tell parse_kv et al. to behave
      bool parse_ok = at->parse_kv (f);
      loading_arch = 0;

      if (!parse_ok)
        goto fail;

      loading_arch = at; // hack to tell parse_kv et al. to behave
      at->post_load_check ();
      loading_arch = 0;

      parts.push_back (at);

      if (f.kw != KW_more)
        break;

      f.next ();

      if (f.kw != KW_object)
        {
          f.parse_error ("more object");
          goto fail;
        }
    }

  {
    auto (at, parts.begin ());

    archetype *new_head = parts.front ();
    archetype *old_head = find (new_head->archname);

    if (old_head && !old_head->is_head ())
      {
        LOG (llevError, "%s: unable to overwrite non-head archetype '%s' with head archetype, skipping.\n",
             &new_head->archname, &old_head->archname);
        goto fail;
      }

    // check that all archetypes belong to the same old object or are new
    for (auto (at, parts.begin ()); at != parts.end (); ++at)
      {
        archetype *new_part = *at;
        archetype *old_part = find (new_part->archname);

        if (old_part && old_part->head_ () != old_head)
          {
            LOG (llevError, "%s: unable to overwrite archetype '%s' with archetype of different object, skipping.\n",
                 &new_part->archname, &((archetype *)old_part->head_ ())->archname);
            goto fail;
          }
      }

    // assemble new chain
    new_head->min_x = new_head->max_x = new_head->x;
    new_head->min_y = new_head->max_y = new_head->y;

    archetype *less = new_head;
    for (auto (p, parts.begin () + 1); p != parts.end (); ++p)
      {
        archetype *at = *p;

        // some flags get inherited from the head (probably a lot more)
        // doing it here doesn't feel too cozy, but it allows code
        // to ignore head checks for these flags, which saves time
        at->flag [FLAG_ALIVE]    = new_head->flag [FLAG_ALIVE];
        at->flag [FLAG_NO_PICK]  = new_head->flag [FLAG_NO_PICK];
        at->flag [FLAG_MONSTER]  = new_head->flag [FLAG_MONSTER];
        at->flag [FLAG_IS_FLOOR] = new_head->flag [FLAG_IS_FLOOR];

        new_head->min_x = min (new_head->min_x, at->x);
        new_head->min_y = min (new_head->min_y, at->y);
        new_head->max_x = max (new_head->max_x, at->x);
        new_head->max_y = max (new_head->max_y, at->y);

        at->head = new_head;
        less->more = at;
        less = at;
      }

    postponed_arch.insert (postponed_arch.end (), parts.begin (), parts.end ());

    return new_head;
  }

fail:
  for (auto (p, parts.begin ()); p != parts.end (); ++p)
    (*p)->destroy ();

  return 0;
}

void
archetype::postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch)
{
  ref = 0;
  postponed_arch_ref.push_back (std::pair<arch_ptr *, shstr>(&ref, shstr (other_arch)));
}

void
archetype::commit_load ()
{
  // unlink old archetypes and link in new ones */
  for (auto (p, postponed_arch.begin ()); p != postponed_arch.end (); ++p)
    {
      archetype *at = *p;

      if (archetype *old = find (at->archname))
        old->unlink ();

      allarch.push_back (at);

      at->link ();
      ++dirtycnt;
    }

  postponed_arch.clear ();

  // now resolve arch references
  for (auto (p, postponed_arch_ref.begin ()); p != postponed_arch_ref.end (); ++p)
    {
      arch_ptr *ap = p->first;
      archetype *at = find (p->second);

      if (!at)
        LOG (llevError, "unable to resolve postponed arch reference to '%s'", &p->second);

      *ap = at;
    }

  postponed_arch_ref.clear ();

  empty = find (shstr_empty_archetype);
}

void
archetype::gc ()
{
  int cnt = max (1, min (allarch.size () / 128, dirtycnt));
  dirtycnt = max (0, dirtycnt - cnt);

  do
    {
      static int idx;

      if (idx >= allarch.size ())
        if (idx)
          idx = 0;
        else
          return;

      archetype *at = allarch [idx];

      if (at->refcnt_cnt () > 1) // all arches have ONE refcount from their object
        ++idx;
      else
        {
          LOG (llevDebug, "garbage collect arch %s", &at->archname);
          assert (at->arch == at); // verify that refcnt == 1 is truly valid
          allarch.erase (idx);

          // break chain
          for (object *op = at->head_ (); op; )
            {
              object *next = op->more;
              op->head = 0;
              op->more = 0;
              op = next;
            }

          at->destroy ();
          at->arch = 0;
        }
    }
  while (--cnt);
}

object *
archetype::instance ()
{
  object *op = clone ();
  op->instantiate ();
  return op;
}

//+GPL

/*
 * Finds which archetype matches the given name, and returns a new
 * object containing a copy of the archetype.
 */
object *
get_archetype (const char *name)
{
  return archetype::get (name);
}

object *
archetype::get (const char *name)
{
  archetype *at = find (name);

  if (!at)
    return create_singularity (name);

  return at->instance ();
}

/*
 * Returns the first archetype using the given type.
 * Used in treasure-generation.
 */
static archetype *
type_to_archetype (int type)
{
  for_all_archetypes (at)
    if (at->type == type && at->head_ () != at)
      return at;

  return 0;
}

/*
 * Returns a new object copied from the first archetype matching
 * the given type.
 * Used in treasure-generation.
 */
object *
clone_arch (int type)
{
  archetype *at = type_to_archetype (type);

  if (!at)
    {
      LOG (llevError, "Can't clone archetype %d\n", type);
      return 0;
    }

  return at->instance ();
}

/*
 * member: make instance from class
 */
object *
object_create_arch (archetype *at)
{
  object *op, *prev = 0, *head = 0;

  while (at)
    {
      op = at->instance ();

      op->x = at->x;
      op->y = at->y;

      if (head)
        op->head = head, prev->more = op;

      if (!head)
        head = op;

      prev = op;
      at = (archetype *)at->more;
    }

  return head;
}

//-GPL

Revision:	1.97
Committed:	Sun Nov 8 22:28:10 2009 UTC (14 years, 7 months ago) by root
Content type:	text/plain
Branch:	MAIN
CVS Tags:	rel-2_92
Changes since 1.96:	+8 -0 lines
Log Message:	skip flag checking loop, if possible
#	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	root	1.97	void
355			archetype::post_load_check ()
356			{
357			object::post_load_check ();
358
359			assert (("obj_original MUST NOT be set for archetypes", !flag [FLAG_OBJ_ORIGINAL]));
360			}
361
362	root	1.63	archetype *
363	root	1.53	archetype::read (object_thawer &f)
364	root	1.12	{
365	root	1.43	assert (f.kw == KW_object);
366
367	root	1.63	std::vector<archetype *> parts;
368	root	1.12
369	root	1.72	coroapi::cede_to_tick ();
370	root	1.52
371	root	1.49	for (;;)
372	root	1.43	{
373	root	1.73	archetype *at = new archetype (f.get_str ());
374	root	1.63
375	root	1.54	f.next ();
376	root	1.49
377	root	1.56	#if 0
378	root	1.63	// implementing it here in the server does neither allow multiple inheritence
379			// nor does it cleanly "just override". it would allow use in map files, though,
380			// and other resource files dynamically laoded (as opposed to being preprocessed).
381			// not that any of this is relevant as of yet...
382	root	1.55	if (f.kw == KW_inherit)
383			{
384			if (archetype *at = find (f.get_str ()))
385			*op = at->clone;
386			else
387			LOG (llevError, "archetype '%s' tries to inherit from non-existent archetype '%s'.\n",
388	root	1.63	&at->archname, f.get_str ());
389	root	1.55
390			f.next ();
391			}
392	root	1.56	#endif
393	root	1.55
394	root	1.69	loading_arch = at; // hack to tell parse_kv et al. to behave
395			bool parse_ok = at->parse_kv (f);
396			loading_arch = 0;
397
398			if (!parse_ok)
399	root	1.49	goto fail;
400
401	root	1.69	loading_arch = at; // hack to tell parse_kv et al. to behave
402	root	1.63	at->post_load_check ();
403	root	1.69	loading_arch = 0;
404	root	1.59
405	root	1.63	parts.push_back (at);
406	root	1.12
407	root	1.49	if (f.kw != KW_more)
408			break;
409	root	1.46
410	root	1.43	f.next ();
411	root	1.54
412			if (f.kw != KW_object)
413			{
414			f.parse_error ("more object");
415			goto fail;
416			}
417	root	1.49	}
418	root	1.43
419	root	1.49	{
420	root	1.63	auto (at, parts.begin ());
421	root	1.12
422	root	1.63	archetype *new_head = parts.front ();
423			archetype *old_head = find (new_head->archname);
424
425	root	1.64	if (old_head && !old_head->is_head ())
426			{
427			LOG (llevError, "%s: unable to overwrite non-head archetype '%s' with head archetype, skipping.\n",
428			&new_head->archname, &old_head->archname);
429			goto fail;
430			}
431	root	1.63
432			// check that all archetypes belong to the same old object or are new
433			for (auto (at, parts.begin ()); at != parts.end (); ++at)
434	root	1.49	{
435	root	1.63	archetype new_part = at;
436			archetype *old_part = find (new_part->archname);
437	root	1.49
438	root	1.63	if (old_part && old_part->head_ () != old_head)
439	root	1.49	{
440	root	1.63	LOG (llevError, "%s: unable to overwrite archetype '%s' with archetype of different object, skipping.\n",
441			&new_part->archname, &((archetype *)old_part->head_ ())->archname);
442	root	1.49	goto fail;
443			}
444			}
445
446	root	1.64	// assemble new chain
447	root	1.63	new_head->min_x = new_head->max_x = new_head->x;
448			new_head->min_y = new_head->max_y = new_head->y;
449	root	1.49
450	root	1.63	archetype *less = new_head;
451	root	1.51	for (auto (p, parts.begin () + 1); p != parts.end (); ++p)
452	root	1.49	{
453	root	1.63	archetype at = p;
454	root	1.49
455	root	1.74	// some flags get inherited from the head (probably a lot more)
456	root	1.67	// doing it here doesn't feel too cozy, but it allows code
457			// to ignore head checks for these flags, which saves time
458			at->flag [FLAG_ALIVE] = new_head->flag [FLAG_ALIVE];
459			at->flag [FLAG_NO_PICK] = new_head->flag [FLAG_NO_PICK];
460			at->flag [FLAG_MONSTER] = new_head->flag [FLAG_MONSTER];
461			at->flag [FLAG_IS_FLOOR] = new_head->flag [FLAG_IS_FLOOR];
462
463	root	1.74	new_head->min_x = min (new_head->min_x, at->x);
464			new_head->min_y = min (new_head->min_y, at->y);
465			new_head->max_x = max (new_head->max_x, at->x);
466			new_head->max_y = max (new_head->max_y, at->y);
467	root	1.49
468	root	1.64	at->head = new_head;
469			less->more = at;
470			less = at;
471	root	1.63	}
472	root	1.49
473	root	1.73	postponed_arch.insert (postponed_arch.end (), parts.begin (), parts.end ());
474	root	1.53
475	root	1.63	return new_head;
476	root	1.49	}
477	root	1.43
478	root	1.49	fail:
479	root	1.51	for (auto (p, parts.begin ()); p != parts.end (); ++p)
480	root	1.85	(*p)->destroy ();
481	root	1.43
482	root	1.53	return 0;
483	root	1.43	}
484
485	root	1.53	void
486	root	1.73	archetype::postpone_arch_ref (arch_ptr &ref, const_utf8_string other_arch)
487			{
488			ref = 0;
489			postponed_arch_ref.push_back (std::pair<arch_ptr *, shstr>(&ref, shstr (other_arch)));
490			}
491
492			void
493			archetype::commit_load ()
494	root	1.43	{
495	root	1.73	// unlink old archetypes and link in new ones */
496			for (auto (p, postponed_arch.begin ()); p != postponed_arch.end (); ++p)
497			{
498			archetype at = p;
499
500			if (archetype *old = find (at->archname))
501			old->unlink ();
502
503	root	1.74	allarch.push_back (at);
504
505	root	1.73	at->link ();
506	root	1.74	++dirtycnt;
507	root	1.73	}
508
509			postponed_arch.clear ();
510
511			// now resolve arch references
512			for (auto (p, postponed_arch_ref.begin ()); p != postponed_arch_ref.end (); ++p)
513			{
514			arch_ptr *ap = p->first;
515			archetype *at = find (p->second);
516
517			if (!at)
518			LOG (llevError, "unable to resolve postponed arch reference to '%s'", &p->second);
519
520			*ap = at;
521			}
522
523			postponed_arch_ref.clear ();
524
525			empty = find (shstr_empty_archetype);
526	elmex	1.1	}
527
528	root	1.74	void
529			archetype::gc ()
530			{
531			int cnt = max (1, min (allarch.size () / 128, dirtycnt));
532			dirtycnt = max (0, dirtycnt - cnt);
533
534			do
535			{
536			static int idx;
537
538			if (idx >= allarch.size ())
539			if (idx)
540			idx = 0;
541			else
542			return;
543
544			archetype *at = allarch [idx];
545
546			if (at->refcnt_cnt () > 1) // all arches have ONE refcount from their object
547			++idx;
548			else
549			{
550	root	1.86	LOG (llevDebug, "garbage collect arch %s", &at->archname);
551	root	1.79	assert (at->arch == at); // verify that refcnt == 1 is truly valid
552	root	1.74	allarch.erase (idx);
553	root	1.77
554			// break chain
555			for (object *op = at->head_ (); op; )
556			{
557			object *next = op->more;
558			op->head = 0;
559			op->more = 0;
560			op = next;
561			}
562
563	root	1.85	at->destroy ();
564	root	1.74	at->arch = 0;
565			}
566			}
567			while (--cnt);
568			}
569
570	root	1.70	object *
571			archetype::instance ()
572			{
573	root	1.80	object *op = clone ();
574			op->instantiate ();
575			return op;
576	root	1.70	}
577
578	root	1.92	//+GPL
579
580	elmex	1.1	/*
581			* Finds which archetype matches the given name, and returns a new
582			* object containing a copy of the archetype.
583			*/
584	root	1.12	object *
585			get_archetype (const char *name)
586			{
587	root	1.80	return archetype::get (name);
588	elmex	1.1	}
589
590	root	1.76	object *
591			archetype::get (const char *name)
592			{
593	root	1.80	archetype *at = find (name);
594
595			if (!at)
596			return create_singularity (name);
597
598			return at->instance ();
599	root	1.76	}
600
601	elmex	1.1	/*
602			* Returns the first archetype using the given type.
603			* Used in treasure-generation.
604			*/
605	root	1.95	static archetype *
606	root	1.12	type_to_archetype (int type)
607			{
608	root	1.63	for_all_archetypes (at)
609			if (at->type == type && at->head_ () != at)
610	elmex	1.1	return at;
611	root	1.20
612			return 0;
613	elmex	1.1	}
614
615			/*
616			* Returns a new object copied from the first archetype matching
617			* the given type.
618			* Used in treasure-generation.
619			*/
620	root	1.12	object *
621			clone_arch (int type)
622			{
623	root	1.80	archetype *at = type_to_archetype (type);
624	elmex	1.1
625	root	1.80	if (!at)
626	root	1.12	{
627			LOG (llevError, "Can't clone archetype %d\n", type);
628	root	1.30	return 0;
629	root	1.12	}
630	root	1.20
631	root	1.80	return at->instance ();
632	elmex	1.1	}
633
634			/*
635			* member: make instance from class
636			*/
637	root	1.12	object *
638	root	1.15	object_create_arch (archetype *at)
639	elmex	1.1	{
640	root	1.20	object op, prev = 0, *head = 0;
641	elmex	1.1
642	root	1.12	while (at)
643			{
644	root	1.80	op = at->instance ();
645	root	1.63
646			op->x = at->x;
647			op->y = at->y;
648	root	1.20
649	root	1.12	if (head)
650			op->head = head, prev->more = op;
651	root	1.20
652	root	1.12	if (!head)
653			head = op;
654	root	1.20
655	root	1.12	prev = op;
656	root	1.63	at = (archetype *)at->more;
657	elmex	1.1	}
658	root	1.20
659	root	1.63	return head;
660	elmex	1.1	}
661
662	root	1.92	//-GPL
663