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.23 by root, Sun Dec 28 06:59:27 2008 UTC vs.
Revision 1.43 by root, Wed Nov 16 23:42:01 2016 UTC

1/* 1/*
2 * This file is part of Deliantra, the Roguelike Realtime MMORPG. 2 * This file is part of Deliantra, the Roguelike Realtime MMORPG.
3 * 3 *
4 * Copyright (©) 2005,2006,2007,2008 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009,2010,2011,2012,2013,2014,2015,2016 Marc Alexander Lehmann / Robin Redeker / the Deliantra team
5 * 5 *
6 * Deliantra 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 <support@deliantra.net> 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"
28 30
29extern size_t shstr_alloc; 31extern size_t shstr_alloc;
30 32
31extern int buf_overflow (const char *buf1, const char *buf2, int bufsize); 33extern int buf_overflow (const char *buf1, const char *buf2, int bufsize);
32 34
35template<int size>
33struct shstr 36struct shstr_vec
34{ 37{
35 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
36 54
37 const char *s; 55 const char *s;
38 56
39 static int &refcnt (const char *s) 57 static unsigned int &hash (const char *s)
40 { 58 {
41 return *((int *)s - 1); 59 return *((unsigned int *)s - 3);
42 } 60 }
43 61
62 int hash () const
63 {
64 return hash (s);
65 }
66
44 static int &length (const char *s) 67 static unsigned int &length (const char *s)
45 { 68 {
46 return *((int *)s - 2); 69 return *((unsigned int *)s - 2);
47 } 70 }
48 71
49 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 //TODO: case sensitive should be eradicated
92 bool eq_nc (const char *otherstring) const
93 {
94 return !strcasecmp (s, otherstring);
95 }
96
97 shstr_tmp ()
98 : s (null ())
99 {
100 }
101
102 shstr_tmp (const shstr_tmp &sh)
103 : s (sh.s)
104 {
105 }
106
107 shstr_tmp operator =(const shstr_tmp &sh)
108 {
109 s = sh.s;
110
111 return *this;
112 }
113
114 // this is used for informational messages and the like
115 const char *operator &() const { return s; }
116
117 operator const char *() const { return s == null () ? 0 : s; }
118
119protected:
120 // dummy is there so it isn't used as type converter accidentally
121 shstr_tmp (int dummy, const char *s)
122 : s(s)
123 {
124 }
125};
126
127inline bool operator ==(const shstr_tmp &a, const shstr_tmp &b)
128{
129 return a.s == b.s;
130}
131
132inline bool operator !=(const shstr_tmp &a, const shstr_tmp &b)
133{
134 return a.s != b.s;
135}
136
137inline int strlen (shstr_tmp sh)
138{
139 return sh.length ();
140}
141
142static inline std::ostream &operator <<(std::ostream &o, shstr_tmp sh)
143{
144 o.write (sh.s, sh.length ());
145
146 return o;
147}
148
149struct shstr : shstr_tmp
150{
151 static unsigned int &refcnt (const char *s)
152 {
153 return *((unsigned int *)s - 1);
154 }
155
156 unsigned int &refcnt () const
50 { 157 {
51 return refcnt (s); 158 return refcnt (s);
52 } 159 }
53 160
54 int length () const 161 shstr ()
55 { 162 {
56 return length (s);
57 }
58
59 // returns wether this shared string begins with the given prefix,
60 // used mainly for searched when users give only the start of a name.
61 bool begins_with (const char *prefix) const
62 {
63 int plen = strlen (prefix);
64 return !strncasecmp (s, prefix, plen) && length () >= plen;
65 } 163 }
66 164
67 static const char *find (const char *s); 165 static const char *find (const char *s);
68 static const char *intern (const char *s); 166 static const char *intern (const char *s);
69 167
70 static void gc (); // garbage collect a few strings 168 static void gc (); // garbage collect a few strings
71 169
72 // this is used for informational messages and the like
73 const char *operator &() const { return s; }
74
75 const char &operator [](int i) const { return s[i]; }
76 operator const char *() const { return s == null ? 0 : s; }
77
78 shstr ()
79 : s (null)
80 {
81 }
82
83 shstr (const shstr &sh) 170 shstr (const shstr &sh)
84 : s (sh.s) 171 : shstr_tmp (sh)
85 { 172 {
86 ++refcnt (); 173 ++refcnt ();
87 } 174 }
88 175
176 shstr (const shstr_tmp &sh)
177 : shstr_tmp (sh)
178 {
179 ++refcnt ();
180 }
181
89 explicit shstr (const char *s) 182 explicit shstr (const char *str)
90 : s (intern (s)) 183 : shstr_tmp (0, is_constant (str) && !str ? null () : intern (str))
91 { 184 {
92 } 185 }
93 186
94 ~shstr () 187 ~shstr ()
95 { 188 {
96 --refcnt (); 189 --refcnt ();
97 } 190 }
98 191
192 using shstr_tmp::operator &;
193 using shstr_tmp::operator const char *;
194
195 // (note: not the copy constructor)
99 const shstr &operator =(const shstr &sh) 196 shstr &operator =(const shstr_tmp &sh)
100 { 197 {
101 --refcnt (); 198 --refcnt ();
102 s = sh.s; 199 s = sh.s;
103 ++refcnt (); 200 ++refcnt ();
104 201
105 return *this; 202 return *this;
106 } 203 }
107 204
205 // here it comes
206 shstr &operator =(const shstr &sh)
207 {
208 return (*this) = (shstr_tmp)sh;
209 }
210
211 // shstr_tmp doesn't have this one
108 const shstr &operator =(const char *str) 212 shstr &operator =(const char *str)
109 { 213 {
110 --refcnt (); 214 --refcnt ();
111 215 s = is_constant (str) && !str ? null () : intern (str);
112 // this optimises the important case of str == constant 0
113 if (is_constant (str))
114 s = str ? intern (str) : null;
115 else
116 s = intern (str);
117 216
118 return *this; 217 return *this;
119 } 218 }
120
121 bool operator !=(const shstr &b)
122 {
123 return !(*this == b);
124 }
125}; 219};
126 220
127inline bool operator ==(const shstr &a, const shstr &b)
128{
129 return a.s == b.s;
130}
131
132inline int strlen (const shstr &sh)
133{
134 return sh.length ();
135}
136
137inline int strcmp (const shstr &a, const shstr &b)
138{
139 // TODO: use this to find all the occurences of people using strcmp
140 // all uses should be bogus, as we should be never interested in
141 // comparing shstr's alphabetically
142#if 0
143 extern void do_not_use_strcmp_to_compare_shstr_values ();
144 do_not_use_strcmp_to_compare_shstr_values ();
145#endif
146 return a != b;
147}
148
149static std::ostream &operator <<(std::ostream &o, const shstr &sh)
150{
151 o.write (sh.s, sh.length ());
152 return o;
153}
154
155// only good for mass comparisons to shstr objects 221// only good for mass comparisons to shstr objects, or very
222// temporary passing, basically a non-refcounted shstr
156struct shstr_cmp 223struct shstr_cmp
157{ 224{
158 const char *s; 225 const char *s;
159 226
227 // initialies to the non-matching string (as opposed to the null string)
228 shstr_cmp ()
229 {
230 s = 0;
231 }
232
160 explicit shstr_cmp (const char *s) 233 shstr_cmp (const char *str)
161 : s (shstr::find (s)) 234 : s (shstr::find (str))
162 { 235 {
163 } 236 }
164 237
165 shstr_cmp (const shstr_cmp &sh) 238 shstr_cmp (shstr_tmp sh)
166 : s (sh.s)
167 {
168 }
169
170 shstr_cmp (const shstr &sh)
171 : s (sh.s) 239 : s (sh.s)
172 { 240 {
173 } 241 }
174 242
175 // this is used for informational messages and the like 243 // this is used for informational messages and the like
176 const char *operator &() const { return s; } 244 const char *operator &() const { return s; }
177 245
178 shstr_cmp &operator =(const shstr_cmp sh) { s = sh.s; return *this; }
179 operator const char *() const { return s; } 246 operator const char *() const { return s; }
180}; 247};
181 248
182inline bool operator ==(const shstr_cmp &a, const shstr &b) 249inline bool operator ==(const shstr_cmp &a, const shstr_tmp &b)
183{ 250{
184 return a.s == b.s; 251 return a.s == b.s;
185} 252}
186 253
187inline bool operator ==(const shstr &a, const shstr_cmp &b) 254inline bool operator ==(const shstr_tmp &a, const shstr_cmp &b)
188{ 255{
189 return b == a; 256 return a.s == b.s;
190} 257}
191 258
192extern const shstr shstr_null;
193
194#define def(str) extern const shstr shstr_ ## str; 259#define def2(id,str) extern const shstr id;
260#define def(id) def2(shstr_ ## id, # id)
195# include "shstrinc.h" 261# include "shstrinc.h"
196#undef def 262#undef def
263#undef def2
264
265// undefined external reference to catch people using str* functions when they shouldn't
266//template<class any> void strcmp (const shstr_tmp &a, any b);
267template<class any> void strstr (const shstr_tmp &a, any b);
197 268
198#endif 269#endif
199 270

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines