ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/deliantra/server/include/shstr.h
(Generate patch)

Comparing deliantra/server/include/shstr.h (file contents):
Revision 1.18 by root, Tue Jul 10 05:51:38 2007 UTC vs.
Revision 1.38 by root, Fri Mar 26 01:04:44 2010 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007 Marc Alexander Lehmann / Robin Redeker / the Crossfire TRT team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Crossfire TRT is free software: you can redistribute it and/or modify 6 * Deliantra is free software: you can redistribute it and/or modify it under
7 * it under the terms of the GNU General Public License as published by 7 * the terms of the Affero GNU General Public License as published by the
8 * the Free Software Foundation, either version 3 of the License, or 8 * Free Software Foundation, either version 3 of the License, or (at your
9 * (at your option) any later version. 9 * option) any later version.
10 * 10 *
11 * This program is distributed in the hope that it will be useful, 11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details. 14 * GNU General Public License for more details.
15 * 15 *
16 * You should have received a copy of the GNU General Public License 16 * You should have received a copy of the Affero GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * and the GNU General Public License along with this program. If not, see
18 * <http://www.gnu.org/licenses/>.
18 * 19 *
19 * The authors can be reached via e-mail to <crossfire@schmorp.de> 20 * The authors can be reached via e-mail to <support@deliantra.net>
20 */ 21 */
21 22
22#ifndef SHSTR_H__ 23#ifndef SHSTR_H__
23#define SHSTR_H__ 24#define SHSTR_H__
24 25
26#include <cstring>
25#include <sstream> 27#include <sstream>
26 28
27#include "util.h" 29#include "traits.h"
30
31extern size_t shstr_alloc;
28 32
29extern int buf_overflow (const char *buf1, const char *buf2, int bufsize); 33extern int buf_overflow (const char *buf1, const char *buf2, int bufsize);
30 34
35template<int size>
31struct shstr 36struct shstr_vec
32{ 37{
33 static const char *null; 38 uint32_t hash;
39 uint32_t len;
40 uint32_t refcnt;
41 // pointer points here
42 char string [size];
43};
44
45// this class is a non-refcounted shared string
46// it cannot be used to create or store shared strings, but
47// it can be used to pass shared strings around, i.e. as function arguments
48// or return values. their lifetime must not span a gc () call, i.e.
49// they are only valid as temporary values within the same server tick.
50struct shstr_tmp
51{
52 static shstr_vec<sizeof ("(null)")> nullvec;
53 static const char *null () { return nullvec.string; } // this is the null pointer value
34 54
35 const char *s; 55 const char *s;
36 56
37 static int &refcnt (const char *s) 57 static unsigned int &hash (const char *s)
38 { 58 {
39 return *((int *)s - 1); 59 return *((unsigned int *)s - 3);
40 } 60 }
41 61
62 int hash () const
63 {
64 return hash (s);
65 }
66
42 static int &length (const char *s) 67 static unsigned int &length (const char *s)
43 { 68 {
44 return *((int *)s - 2); 69 return *((unsigned int *)s - 2);
45 } 70 }
46 71
47 int &refcnt () const 72 int length () const
73 {
74 return length (s);
75 }
76
77 // returns whether this shared string begins with the given prefix,
78 // used mainly for searches when users give only the start of a name.
79 bool starts_with (const char *prefix) const
80 {
81 int plen = strlen (prefix);
82
83 return length () >= plen && !strncasecmp (s, prefix, plen);
84 }
85
86 // returns true if the substring is contained in the shstr
87 // if the shstr is 0, then this always returns false.
88 // the shstr is (theoretically) treated as a comma/colon/space etc. separated list.
89 bool contains (const char *substring) const
90 {
91 return s != null () && strstr (s, substring);
92 }
93
94 //TODO: case sensitive should be eradicated
95 bool eq_nc (const char *otherstring) const
96 {
97 return !strcasecmp (s, otherstring);
98 }
99
100 shstr_tmp ()
101 : s (null ())
102 {
103 }
104
105 shstr_tmp (const shstr_tmp &sh)
106 : s (sh.s)
107 {
108 }
109
110 shstr_tmp operator =(const shstr_tmp &sh)
111 {
112 s = sh.s;
113
114 return *this;
115 }
116
117 // this is used for informational messages and the like
118 const char *operator &() const { return s; }
119
120 operator const char *() const { return s == null () ? 0 : s; }
121
122protected:
123 // dummy is there so it isn't used as type converter accidentally
124 shstr_tmp (int dummy, const char *s)
125 : s(s)
126 {
127 }
128};
129
130inline bool operator ==(const shstr_tmp &a, const shstr_tmp &b)
131{
132 return a.s == b.s;
133}
134
135inline bool operator !=(const shstr_tmp &a, const shstr_tmp &b)
136{
137 return a.s != b.s;
138}
139
140inline int strlen (shstr_tmp sh)
141{
142 return sh.length ();
143}
144
145static inline std::ostream &operator <<(std::ostream &o, shstr_tmp sh)
146{
147 o.write (sh.s, sh.length ());
148
149 return o;
150}
151
152struct shstr : shstr_tmp
153{
154 static unsigned int &refcnt (const char *s)
155 {
156 return *((unsigned int *)s - 1);
157 }
158
159 unsigned int &refcnt () const
48 { 160 {
49 return refcnt (s); 161 return refcnt (s);
50 } 162 }
51 163
52 int length () const 164 shstr ()
53 { 165 {
54 return length (s);
55 }
56
57 // returns wether this shared string begins with the given prefix,
58 // used mainly for searched when users give only the start of a name.
59 bool begins_with (const char *prefix) const
60 {
61 int plen = strlen (prefix);
62 return !strncasecmp (s, prefix, plen) && length () >= plen;
63 } 166 }
64 167
65 static const char *find (const char *s); 168 static const char *find (const char *s);
66 static const char *intern (const char *s); 169 static const char *intern (const char *s);
67 170
68 static void gc (); // garbage collect a few strings 171 static void gc (); // garbage collect a few strings
69 172
70 // this is used for informational messages and the like
71 const char *operator &() const { return s; }
72
73 const char &operator [](int i) const { return s[i]; }
74 operator const char *() const { return s == null ? 0 : s; }
75
76 shstr ()
77 : s (null)
78 {
79 }
80
81 shstr (const shstr &sh) 173 shstr (const shstr &sh)
82 : s (sh.s) 174 : shstr_tmp (sh)
83 { 175 {
84 ++refcnt (); 176 ++refcnt ();
85 } 177 }
86 178
179 shstr (const shstr_tmp &sh)
180 : shstr_tmp (sh)
181 {
182 ++refcnt ();
183 }
184
87 explicit shstr (const char *s) 185 explicit shstr (const char *str)
88 : s (intern (s)) 186 : shstr_tmp (0, is_constant (str) && !str ? null () : intern (str))
89 { 187 {
90 } 188 }
91 189
92 ~shstr () 190 ~shstr ()
93 { 191 {
94 --refcnt (); 192 --refcnt ();
95 } 193 }
96 194
195 using shstr_tmp::operator &;
196 using shstr_tmp::operator const char *;
197
198 // (note: not the copy constructor)
97 const shstr &operator =(const shstr &sh) 199 shstr &operator =(const shstr_tmp &sh)
98 { 200 {
99 --refcnt (); 201 --refcnt ();
100 s = sh.s; 202 s = sh.s;
101 ++refcnt (); 203 ++refcnt ();
102 204
103 return *this; 205 return *this;
104 } 206 }
105 207
208 // here it comes
209 shstr &operator =(const shstr &sh)
210 {
211 return (*this) = (shstr_tmp)sh;
212 }
213
214 // shstr_tmp doesn't have this one
106 const shstr &operator =(const char *str) 215 shstr &operator =(const char *str)
107 { 216 {
108 --refcnt (); 217 --refcnt ();
109 218 s = is_constant (str) && !str ? null () : intern (str);
110 // this optimises the important case of str == constant 0
111 if (is_constant (str))
112 s = str ? intern (str) : null;
113 else
114 s = intern (str);
115 219
116 return *this; 220 return *this;
117 } 221 }
118
119 bool operator ==(const shstr &b)
120 {
121 return s == b.s;
122 }
123
124 bool operator !=(const shstr &b)
125 {
126 return !(*this == b);
127 }
128}; 222};
129 223
130inline int strlen (const shstr &sh)
131{
132 return sh.length ();
133}
134
135inline int strcmp (const shstr &a, const shstr &b)
136{
137 // TODO: use this to find all the occurences of people using strcmp
138 // all uses should be bogus, as we should be never interested in
139 // comparing shstr's alphabetically
140#if 0
141 extern void do_not_use_strcmp_to_compare_shstr_values ();
142 do_not_use_strcmp_to_compare_shstr_values ();
143#endif
144 return a != b;
145}
146
147static std::ostream &operator <<(std::ostream &o, const shstr &sh)
148{
149 o.write (sh.s, sh.length ());
150 return o;
151}
152
153// only good for mass comparisons to shstr objects 224// only good for mass comparisons to shstr objects, or very
225// temporary passing, basically a non-refcounted shstr
154struct shstr_cmp 226struct shstr_cmp
155{ 227{
156 const char *s; 228 const char *s;
157 229
230 // initialies to the non-matching string (as opposed to the null string)
231 shstr_cmp ()
232 {
233 s = 0;
234 }
235
158 explicit shstr_cmp (const char *s) 236 shstr_cmp (const char *str)
159 : s (shstr::find (s)) 237 : s (shstr::find (str))
160 { 238 {
161 } 239 }
162 240
163 shstr_cmp (const shstr_cmp &sh) 241 shstr_cmp (shstr_tmp sh)
164 : s (sh.s) 242 : s (sh.s)
165 { 243 {
166 } 244 }
167 245
168 shstr_cmp &operator =(const shstr_cmp sh) { s = sh.s; return *this; } 246 // this is used for informational messages and the like
247 const char *operator &() const { return s; }
248
169 operator const char *() const { return s; } 249 operator const char *() const { return s; }
170}; 250};
171 251
172inline bool operator ==(const shstr_cmp &a, const shstr &b) 252inline bool operator ==(const shstr_cmp &a, const shstr_tmp &b)
173{ 253{
174 return a.s == b.s; 254 return a.s == b.s;
175} 255}
176 256
177inline bool operator ==(const shstr &a, const shstr_cmp &b) 257inline bool operator ==(const shstr_tmp &a, const shstr_cmp &b)
178{ 258{
179 return b == a; 259 return a.s == b.s;
180} 260}
181 261
182#define def(str) extern const shstr shstr_ ## str; 262#define def2(id,str) extern const shstr id;
263#define def(id) def2(shstr_ ## id, # id)
183# include "shstrinc.h" 264# include "shstrinc.h"
184#undef def 265#undef def
266#undef def2
267
268// undefined external reference to catch people using str* functions when they shouldn't
269//template<class any> void strcmp (const shstr_tmp &a, any b);
270template<class any> void strstr (const shstr_tmp &a, any b);
185 271
186#endif 272#endif
187 273

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines