server/include/shstr.h

/*
 * This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
 * 
 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
 * 
 * Crossfire TRT is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 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 GNU General Public License along
 * with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 * 
 * The authors can be reached via e-mail to <crossfire@schmorp.de>
 */

#ifndef SHSTR_H__
#define SHSTR_H__

#include <sstream>

#include "util.h"

extern int buf_overflow (const char *buf1, const char *buf2, int bufsize);

struct shstr
{
  static const char *null;

  const char *s;

  static int &refcnt (const char *s)
  {
    return *((int *)s - 1);
  }

  static int &length (const char *s)
  {
    return *((int *)s - 2);
  }

  int &refcnt () const
  {
    return refcnt (s);
  }

  int length () const
  {
    return length (s);
  }

  // returns wether this shared string begins with the given prefix,
  // used mainly for searched when users give only the start of a name.
  bool begins_with (const char *prefix) const
  {
    int plen = strlen (prefix);
    return !strncasecmp (s, prefix, plen) && length () >= plen;
  }

  static const char *find (const char *s);
  static const char *intern (const char *s);

  static void gc (); // garbage collect a few strings

  // this is used for informational messages and the like
  const char *operator &() const { return s; }

  const char &operator [](int i) const { return s[i]; }
  operator const char *() const { return s == null ? 0 : s; }

  shstr ()
  : s (null)
  {
  }

  shstr (const shstr &sh)
  : s (sh.s)
  {
    ++refcnt ();
  }

  explicit shstr (const char *s)
  : s (intern (s))
  {
  }

  ~shstr ()
  {
    --refcnt ();
  }

  const shstr &operator =(const shstr &sh)
  {
    --refcnt ();
    s = sh.s;
    ++refcnt ();

    return *this;
  }

  const shstr &operator =(const char *str)
  {
    --refcnt ();

    // this optimises the important case of str == constant 0
    if (is_constant (str))
      s = str ? intern (str) : null;
    else
      s = intern (str);

    return *this;
  }

  bool operator ==(const shstr &b)
  {
    return s == b.s;
  }

  bool operator !=(const shstr &b)
  {
    return !(*this == b);
  }
};

inline int strlen (const shstr &sh)
{
  return sh.length ();
}

inline int strcmp (const shstr &a, const shstr &b)
{
  // TODO: use this to find all the occurences of people using strcmp
  // all uses should be bogus, as we should be never interested in
  // comparing shstr's alphabetically
#if 0
  extern void do_not_use_strcmp_to_compare_shstr_values ();
  do_not_use_strcmp_to_compare_shstr_values ();
#endif
  return a != b;
}

static std::ostream &operator <<(std::ostream &o, const shstr &sh)
{
  o.write (sh.s, sh.length ());
  return o;
}

// only good for mass comparisons to shstr objects
struct shstr_cmp
{
  const char *s;

  explicit shstr_cmp (const char *s)
  : s (shstr::find (s))
  {
  }

  shstr_cmp (const shstr_cmp &sh)
  : s (sh.s)
  {
  }

  shstr_cmp &operator =(const shstr_cmp sh) { s = sh.s; return *this; }
  operator const char *() const { return s; }
};

inline bool operator ==(const shstr_cmp &a, const shstr &b)
{
  return a.s == b.s;
}

inline bool operator ==(const shstr &a, const shstr_cmp &b)
{
  return b == a;
}

extern const shstr undead_name; /* Used in hit_player() in main.c */

#endif

Revision:	1.16
Committed:	Mon May 28 21:15:56 2007 UTC (16 years, 11 months ago) by root
Content type:	text/plain
Branch:	MAIN
Changes since 1.15:	+22 -0 lines
Log Message:	- update copyrights in .h files, where applicable - rename preprocess to genkeywords
#	User	Rev	Content
1	root	1.16	/*
2			* This file is part of Crossfire TRT, the Multiplayer Online Role Playing Game.
3			*
4			* Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team
5			*
6			* Crossfire TRT is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU General Public License as published by the Free
8			* Software Foundation; either version 2 of the License, or (at your option)
9			* any later version.
10			*
11			* This program is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
13			* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14			* for more details.
15			*
16			* You should have received a copy of the GNU General Public License along
17			* with Crossfire TRT; if not, write to the Free Software Foundation, Inc. 51
18			* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19			*
20			* The authors can be reached via e-mail to <crossfire@schmorp.de>
21			*/
22
23	root	1.2	#ifndef SHSTR_H__
24			#define SHSTR_H__
25
26	root	1.13	#include <sstream>
27
28	root	1.8	#include "util.h"
29
30			extern int buf_overflow (const char buf1, const char buf2, int bufsize);
31	root	1.5
32			struct shstr
33			{
34	root	1.8	static const char *null;
35
36	root	1.5	const char *s;
37	root	1.4
38	root	1.7	static int &refcnt (const char *s)
39	root	1.5	{
40			return ((int )s - 1);
41			}
42
43	root	1.7	static int &length (const char *s)
44			{
45			return ((int )s - 2);
46			}
47
48			int &refcnt () const
49			{
50			return refcnt (s);
51			}
52
53			int length () const
54			{
55	root	1.8	return length (s);
56	root	1.7	}
57
58	root	1.15	// returns wether this shared string begins with the given prefix,
59			// used mainly for searched when users give only the start of a name.
60			bool begins_with (const char *prefix) const
61			{
62			int plen = strlen (prefix);
63			return !strncasecmp (s, prefix, plen) && length () >= plen;
64			}
65
66	root	1.5	static const char find (const char s);
67			static const char intern (const char s);
68
69			static void gc (); // garbage collect a few strings
70
71	root	1.6	// this is used for informational messages and the like
72	root	1.8	const char *operator &() const { return s; }
73	root	1.5
74	root	1.6	const char &operator [](int i) const { return s[i]; }
75	root	1.8	operator const char *() const { return s == null ? 0 : s; }
76	root	1.5
77			shstr ()
78	root	1.8	: s (null)
79	root	1.5	{
80			}
81
82	root	1.6	shstr (const shstr &sh)
83	root	1.5	: s (sh.s)
84			{
85	root	1.8	++refcnt ();
86	root	1.5	}
87
88			explicit shstr (const char *s)
89			: s (intern (s))
90			{
91			}
92
93			~shstr ()
94			{
95	root	1.8	--refcnt ();
96	root	1.5	}
97
98			const shstr &operator =(const shstr &sh)
99			{
100	root	1.8	--refcnt ();
101	root	1.5	s = sh.s;
102	root	1.8	++refcnt ();
103	root	1.5
104			return *this;
105			}
106
107			const shstr &operator =(const char *str)
108			{
109	root	1.8	--refcnt ();
110
111			// this optimises the important case of str == constant 0
112			if (is_constant (str))
113			s = str ? intern (str) : null;
114			else
115			s = intern (str);
116	root	1.1
117	root	1.5	return *this;
118			}
119	root	1.10
120			bool operator ==(const shstr &b)
121			{
122			return s == b.s;
123			}
124
125			bool operator !=(const shstr &b)
126			{
127			return !(*this == b);
128			}
129	root	1.5	};
130	root	1.1
131	root	1.5	inline int strlen (const shstr &sh)
132			{
133			return sh.length ();
134			}
135	root	1.2
136	root	1.12	inline int strcmp (const shstr &a, const shstr &b)
137			{
138			// TODO: use this to find all the occurences of people using strcmp
139			// all uses should be bogus, as we should be never interested in
140			// comparing shstr's alphabetically
141			#if 0
142			extern void do_not_use_strcmp_to_compare_shstr_values ();
143			do_not_use_strcmp_to_compare_shstr_values ();
144			#endif
145			return a != b;
146			}
147
148	root	1.14	static std::ostream &operator <<(std::ostream &o, const shstr &sh)
149	root	1.13	{
150			o.write (sh.s, sh.length ());
151			return o;
152			}
153
154	root	1.10	// only good for mass comparisons to shstr objects
155			struct shstr_cmp
156			{
157			const char *s;
158
159			explicit shstr_cmp (const char *s)
160			: s (shstr::find (s))
161			{
162			}
163
164	root	1.11	shstr_cmp (const shstr_cmp &sh)
165			: s (sh.s)
166			{
167			}
168
169			shstr_cmp &operator =(const shstr_cmp sh) { s = sh.s; return *this; }
170	root	1.10	operator const char *() const { return s; }
171			};
172
173			inline bool operator ==(const shstr_cmp &a, const shstr &b)
174	root	1.5	{
175			return a.s == b.s;
176			}
177	root	1.4
178	root	1.10	inline bool operator ==(const shstr &a, const shstr_cmp &b)
179	root	1.4	{
180	root	1.10	return b == a;
181	root	1.5	}
182	root	1.4
183	root	1.9	extern const shstr undead_name; /* Used in hit_player() in main.c */
184
185	root	1.2	#endif
186