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

/**
 * 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;
}

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

/*
 * 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.
 */
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;
}

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