server/common/arch.C

/*
 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
 *
 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
 * Copyright (©) 2002 Mark Wedel & Crossfire Development Team
 * Copyright (©) 1992 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 <functional>

#include <flat_hash_map.hpp>

#include <global.h>

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

// the hashtable
typedef ska::flat_hash_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 archetype::get ()
 * if it fails to find the appropriate archetype.
 * Thus archetype::get() 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") && op->flag [FLAG_UNPAID])
        return 2;

      if (!strcmp (cp, "cursed") && op->flag [FLAG_KNOWN_CURSED] && (op->flag [FLAG_CURSED] || op->flag [FLAG_DAMNED]))
        return 2;

      if (!strcmp (cp, "unlocked") && !op->flag [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

void
archetype::do_delete ()
{
  delete this;
}

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 ()
{
  assert (("obj_original MUST NOT be set for archetypes", !flag [FLAG_OBJ_ORIGINAL]));

  if (type == SKILL)
    add_skill_archetype (this);

  object::post_load_check ();
}

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 loaded (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->max_x = new_head->x;

    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->max_x = max (new_head->max_x, at->x);

        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<int> (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 *
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.115
Committed:	Sat Nov 17 23:33:17 2018 UTC (5 years, 6 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.114:	+10 -11 lines
Log Message:	* empty log message *
#	Content
1	/*
2	* This file is part of Deliantra, the Roguelike Realtime MMORPG.
3	*
4	* Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5	* Copyright (©) 2002 Mark Wedel & Crossfire Development Team
6	* Copyright (©) 1992 Frank Tore Johansen
7	*
8	* 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	*
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 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	*
22	* The authors can be reached via e-mail to <support@deliantra.net>
23	*/
24
25	#include <cassert>
26	#include <functional>
27
28	#include <flat_hash_map.hpp>
29
30	#include <global.h>
31
32	archetype *loading_arch; // ugly flag to object loader etc. to suppress/request special processing
33	arch_ptr archetype::empty;
34
35	// the hashtable
36	typedef ska::flat_hash_map<
37	const char *,
38	arch_ptr,
39	str_hash,
40	str_equal,
41	slice_allocator< std::pair<const char *const, arch_ptr> >
42	> HT;
43
44	static HT ht (10000);
45	archvec archetypes;
46	static unordered_vector<archetype *> allarch;
47	static int dirtycnt;
48
49	// the vector of other_arch references to be resolved
50	static std::vector< std::pair<arch_ptr *, shstr> > postponed_arch_ref;
51	// the vector of loaded but not yet committed archetypes
52	static std::vector<archetype *> postponed_arch;
53
54	//+GPL
55
56	/*
57	* Creates an object. This function is called by archetype::get ()
58	* if it fails to find the appropriate archetype.
59	* Thus archetype::get() will be guaranteed to always return
60	* an object, and never NULL.
61	*/
62	static object *
63	create_singularity (const char *name)
64	{
65	LOG (llevError \| logBacktrace, "FATAL: creating singularity for '%s'.\n", name);
66
67	if (!strcmp (name, "bug"))
68	abort ();
69
70	object *op = archetype::get (shstr_bug);
71	op->name = op->name_pl = format ("bug, please report (missing archetype %s)", name);
72
73	return op;
74	}
75
76	/**
77	* GROS - This function retrieves an archetype given the name that appears
78	* during the game (for example, "writing pen" instead of "stylus").
79	* It does not use the hashtable system, but browse the whole archlist each time.
80	* I suggest not to use it unless you really need it because of performance issue.
81	* It is currently used by scripting extensions (create-object).
82	* Params:
83	* - name: the name we're searching for (ex: "writing pen");
84	* Return value:
85	* - the archetype found or null if nothing was found.
86	*/
87	archetype *
88	find_archetype_by_object_name (const char *name)
89	{
90	shstr_cmp name_cmp (name);
91
92	for_all_archetypes (at)
93	if (at->name == name_cmp)
94	return at;
95
96	return 0;
97	}
98
99	/**
100	* This function retrieves an archetype by type and name that appears during
101	* the game. It is basically the same as find_archetype_by_object_name()
102	* except that it considers only items of the given type.
103	*/
104	archetype *
105	find_archetype_by_object_type_name (int type, const char *name)
106	{
107	shstr_cmp name_cmp (name);
108
109	for_all_archetypes (at)
110	if (at->name == name_cmp && at->type == type)
111	return at;
112
113	return 0;
114	}
115
116	/* This is a lot like the above function. Instead, we are trying to match
117	* the arch->skill values. type is the type of object to match
118	* against (eg, to only match against skills or only skill objects for example).
119	* If type is -1, ew don't match on type.
120	*/
121	object *
122	get_archetype_by_skill_name (const char *skill, int type)
123	{
124	shstr_cmp skill_cmp (skill);
125
126	for_all_archetypes (at)
127	if (at->skill == skill_cmp && (type == -1 \|\| type == at->type))
128	return at->instance ();
129
130	return 0;
131	}
132
133	/* similiar to above - this returns the first archetype
134	* that matches both the type and subtype. type and subtype
135	* can be -1 to say ignore, but in this case, the match it does
136	* may not be very useful. This function is most useful when
137	* subtypes are known to be unique for a particular type
138	* (eg, skills)
139	*/
140	archetype *
141	get_archetype_by_type_subtype (int type, int subtype)
142	{
143	for_all_archetypes (at)
144	if ((type == -1 \|\| type == at->type) && (subtype == -1 \|\| subtype == at->subtype))
145	return at;
146
147	return 0;
148	}
149
150	/**
151	* GROS - this returns a new object given the name that appears during the game
152	* (for example, "writing pen" instead of "stylus").
153	* Params:
154	* - name: The name we're searching for (ex: "writing pen");
155	* Return value:
156	* - a corresponding object if found; a singularity object if not found.
157	* Note by MSW - it appears that it takes the full name and keeps
158	* shortening it until it finds a match. I re-wrote this so that it
159	* doesn't allocate it each time - not that this function is used much,
160	* but it otherwise had a big memory leak.
161	*/
162	object *
163	get_archetype_by_object_name (const char *name)
164	{
165	char tmpname[MAX_BUF];
166
167	assign (tmpname, name);
168
169	for (int i = strlen (tmpname); i > 0; i--)
170	{
171	tmpname[i] = 0;
172
173	if (archetype *at = find_archetype_by_object_name (tmpname))
174	return at->instance ();
175	}
176
177	return create_singularity (name);
178	}
179
180	/* This is a subset of the parse_id command. Basically, name can be
181	* a string seperated lists of things to match, with certain keywords.
182	* pl is the player (only needed to set count properly)
183	* op is the item we are trying to match. Calling function takes care
184	* of what action might need to be done and if it is valid
185	* (pickup, drop, etc.) Return NONZERO if we have a match. A higher
186	* value means a better match. 0 means no match.
187	*
188	* Brief outline of the procedure:
189	* We take apart the name variable into the individual components.
190	* cases for 'all' and unpaid are pretty obvious.
191	* Next, we check for a count (either specified in name, or in the
192	* player object.)
193	* If count is 1, make a quick check on the name.
194	* IF count is >1, we need to make plural name. Return if match.
195	* Last, make a check on the full name.
196	*/
197	int
198	item_matched_string (object pl, object op, const char *name)
199	{
200	char *cp, local_name[MAX_BUF];
201	int count, retval = 0;
202
203	assign (local_name, name); /* strtok is destructive to name */
204
205	for (cp = strtok (local_name, ","); cp; cp = strtok (NULL, ","))
206	{
207	while (cp[0] == ' ')
208	++cp; /* get rid of spaces */
209
210	/* LOG(llevDebug,"Trying to match %s\n", cp); */
211	/* All is a very generic match - low match value */
212	if (!strcmp (cp, "all"))
213	return 1;
214
215	/* unpaid is a little more specific */
216	if (!strcmp (cp, "unpaid") && op->flag [FLAG_UNPAID])
217	return 2;
218
219	if (!strcmp (cp, "cursed") && op->flag [FLAG_KNOWN_CURSED] && (op->flag [FLAG_CURSED] \|\| op->flag [FLAG_DAMNED]))
220	return 2;
221
222	if (!strcmp (cp, "unlocked") && !op->flag [FLAG_INV_LOCKED])
223	return 2;
224
225	/* Allow for things like '100 arrows' */
226	if ((count = atoi (cp)) != 0)
227	{
228	cp = strchr (cp, ' ');
229	while (cp && cp[0] == ' ')
230	++cp; /* get rid of spaces */
231	}
232	else
233	{
234	if (pl->type == PLAYER)
235	count = pl->contr->count;
236	else
237	count = 0;
238	}
239
240	if (!cp \|\| cp[0] == '\0' \|\| count < 0)
241	return 0;
242
243
244	/* The code here should go from highest retval to lowest. That
245	* is because of the 'else' handling - we don't want to match on
246	* something and set a low retval, even though it may match a higher retcal
247	* later. So keep it in descending order here, so we try for the best
248	* match first, and work downward.
249	*/
250	const char qbn0, qbn1, *qsn; // query base name/short name caches
251
252	if (!strcasecmp (cp, query_name (op)))
253	retval = 20;
254	else if (!strcasecmp (cp, qsn = query_short_name (op)))
255	retval = 18;
256	else if (!strcasecmp (cp, qbn0 = query_base_name (op, 0)))
257	retval = 16;
258	else if (!strcasecmp (cp, qbn1 = query_base_name (op, 1)))
259	retval = 16;
260	else if (op->custom_name && !strcasecmp (cp, op->custom_name))
261	retval = 15;
262	else if (!strncasecmp (cp, qbn0, strlen (cp)))
263	retval = 14;
264	else if (!strncasecmp (cp, qbn1, strlen (cp)))
265	retval = 14;
266	/* Do substring checks, so things like 'Str+1' will match.
267	* retval of these should perhaps be lower - they are lower
268	* then the specific strcasecmp aboves, but still higher than
269	* some other match criteria.
270	*/
271	else if (strstr (qbn1, cp))
272	retval = 12;
273	else if (strstr (qbn0, cp))
274	retval = 12;
275	else if (strstr (qsn, cp))
276	retval = 12;
277	/* Check against plural/non plural based on count. */
278	else if (count > 1 && !strcasecmp (cp, op->name_pl))
279	retval = 6;
280	else if (count == 1 && !strcasecmp (op->name, cp))
281	retval = 6;
282	/* base name matched - not bad */
283	else if (strcasecmp (cp, op->name) == 0 && !count)
284	retval = 4;
285	/* Check for partial custom name, but give a real low priority */
286	else if (op->custom_name.contains (cp))
287	retval = 3;
288
289	if (retval)
290	{
291	if (pl->type == PLAYER)
292	pl->contr->count = count;
293
294	return retval;
295	}
296	}
297
298	return 0;
299	}
300
301	//-GPL
302
303	void
304	archetype::do_delete ()
305	{
306	delete this;
307	}
308
309	archetype::archetype (const char *name)
310	{
311	arch = this;
312	this->archname = this->name = this->name_pl = name;
313	}
314
315	archetype::~archetype ()
316	{
317	unlink ();
318	}
319
320	void
321	archetype::link ()
322	{
323	if (!archetypes.contains (this))
324	{
325	archetypes.insert (this);
326	ht.insert (std::make_pair (archname, this));
327	}
328	}
329
330	void
331	archetype::unlink ()
332	{
333	if (archetypes.contains (this))
334	{
335	archetypes.erase (this);
336	ht.erase (archname);
337	}
338	}
339
340	/*
341	* Finds, using the hashtable, which archetype matches the given name.
342	* returns a pointer to the found archetype, otherwise NULL.
343	*/
344	archetype *
345	archetype::find (const char *name)
346	{
347	if (!name)
348	return 0;
349
350	auto (i, ht.find (name));
351
352	if (i == ht.end ())
353	return 0;
354	else
355	return i->second;
356	}
357
358	void
359	archetype::post_load_check ()
360	{
361	assert (("obj_original MUST NOT be set for archetypes", !flag [FLAG_OBJ_ORIGINAL]));
362
363	if (type == SKILL)
364	add_skill_archetype (this);
365
366	object::post_load_check ();
367	}
368
369	archetype *
370	archetype::read (object_thawer &f)
371	{
372	assert (f.kw == KW_object);
373
374	std::vector<archetype *> parts;
375
376	coroapi::cede_to_tick ();
377
378	for (;;)
379	{
380	archetype *at = new archetype (f.get_str ());
381
382	f.next ();
383
384	#if 0
385	// implementing it here in the server does neither allow multiple inheritence
386	// nor does it cleanly "just override". it would allow use in map files, though,
387	// and other resource files dynamically loaded (as opposed to being preprocessed).
388	// not that any of this is relevant as of yet...
389	if (f.kw == KW_inherit)
390	{
391	if (archetype *at = find (f.get_str ()))
392	*op = at->clone;
393	else
394	LOG (llevError, "archetype '%s' tries to inherit from non-existent archetype '%s'.\n",
395	&at->archname, f.get_str ());
396
397	f.next ();
398	}
399	#endif
400
401	loading_arch = at; // hack to tell parse_kv et al. to behave
402	bool parse_ok = at->parse_kv (f);
403	loading_arch = 0;
404
405	if (!parse_ok)
406	goto fail;
407
408	loading_arch = at; // hack to tell parse_kv et al. to behave
409	at->post_load_check ();
410	loading_arch = 0;
411
412	parts.push_back (at);
413
414	if (f.kw != KW_more)
415	break;
416
417	f.next ();
418
419	if (f.kw != KW_object)
420	{
421	f.parse_error ("more object");
422	goto fail;
423	}
424	}
425
426	{
427	auto (at, parts.begin ());
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.begin ()); at != parts.end (); ++at)
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 (p, parts.begin ()); p != parts.end (); ++p)
483	(*p)->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 (p, postponed_arch.begin ()); p != postponed_arch.end (); ++p)
500	{
501	archetype at = p;
502
503	if (archetype *old = find (at->archname))
504	old->unlink ();
505
506	allarch.push_back (at);
507
508	at->link ();
509	++dirtycnt;
510	}
511
512	postponed_arch.clear ();
513
514	// now resolve arch references
515	for (auto (p, postponed_arch_ref.begin ()); p != postponed_arch_ref.end (); ++p)
516	{
517	arch_ptr *ap = p->first;
518	archetype *at = find (p->second);
519
520	if (!at)
521	LOG (llevError, "unable to resolve postponed arch reference to '%s'", &p->second);
522
523	*ap = at;
524	}
525
526	postponed_arch_ref.clear ();
527
528	empty = find (shstr_empty_archetype);
529	}
530
531	void
532	archetype::gc ()
533	{
534	int cnt = max (1, min<int> (allarch.size () / 128, dirtycnt));
535	dirtycnt = max (0, dirtycnt - cnt);
536
537	do
538	{
539	static int idx;
540
541	if (idx >= allarch.size ())
542	if (idx)
543	idx = 0;
544	else
545	return;
546
547	archetype *at = allarch [idx];
548
549	if (at->refcnt_cnt () > 1) // all arches have ONE refcount from their object
550	++idx;
551	else
552	{
553	//LOG (llevDebug, "garbage collect arch %s", &at->archname);
554	assert (at->arch == at); // verify that refcnt == 1 is truly valid
555	allarch.erase (idx);
556
557	// break chain
558	for (object *op = at->head_ (); op; )
559	{
560	object *next = op->more;
561	op->head = 0;
562	op->more = 0;
563	op = next;
564	}
565
566	at->destroy ();
567	at->arch = 0;
568	}
569	}
570	while (--cnt);
571	}
572
573	object *
574	archetype::instance ()
575	{
576	object *op = clone ();
577	op->instantiate ();
578	return op;
579	}
580
581	//+GPL
582
583	/*
584	* Finds which archetype matches the given name, and returns a new
585	* object containing a copy of the archetype.
586	*/
587	object *
588	archetype::get (const char *name)
589	{
590	archetype *at = find (name);
591
592	if (!at)
593	return create_singularity (name);
594
595	return at->instance ();
596	}
597
598	/*
599	* Returns the first archetype using the given type.
600	* Used in treasure-generation.
601	*/
602	static archetype *
603	type_to_archetype (int type)
604	{
605	for_all_archetypes (at)
606	if (at->type == type && at->head_ () != at)
607	return at;
608
609	return 0;
610	}
611
612	/*
613	* Returns a new object copied from the first archetype matching
614	* the given type.
615	* Used in treasure-generation.
616	*/
617	object *
618	clone_arch (int type)
619	{
620	archetype *at = type_to_archetype (type);
621
622	if (!at)
623	{
624	LOG (llevError, "Can't clone archetype %d\n", type);
625	return 0;
626	}
627
628	return at->instance ();
629	}
630
631	/*
632	* member: make instance from class
633	*/
634	object *
635	object_create_arch (archetype *at)
636	{
637	object op, prev = 0, *head = 0;
638
639	while (at)
640	{
641	op = at->instance ();
642
643	op->x = at->x;
644	op->y = at->y;
645
646	if (head)
647	op->head = head, prev->more = op;
648
649	if (!head)
650	head = op;
651
652	prev = op;
653	at = (archetype *)at->more;
654	}
655
656	return head;
657	}
658
659	//-GPL
660