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.21 by root, Sat May 3 11:14:50 2008 UTC vs.
Revision 1.35 by root, Fri Nov 6 13:45:28 2009 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 Marc Alexander Lehmann / Robin Redeker / the Deliantra team 4 * Copyright (©) 2005,2006,2007,2008,2009 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 len;
39 uint32_t refcnt;
40 char string[size];
41};
42
43// this class is a non-refcounted shared string
44// it cannot be used to create or store shared strings, but
45// it can be used to apss shared strings around, i.e. as function arguments
46// or return values. their lifetime must not span a gc () call, i.e.
47// they are only valid as temporary values within the same server tick.
48struct shstr_tmp
49{
50 static shstr_vec<sizeof ("(null)")> nullvec;
51 static const char *null () { return nullvec.string; } // this is the null pointer value
36 52
37 const char *s; 53 const char *s;
38 54
39 static int &refcnt (const char *s)
40 {
41 return *((int *)s - 1);
42 }
43
44 static int &length (const char *s) 55 static unsigned int &length (const char *s)
45 { 56 {
46 return *((int *)s - 2); 57 return *((unsigned int *)s - 2);
47 } 58 }
48 59
49 int &refcnt () const 60 int length () const
61 {
62 return length (s);
63 }
64
65 // returns whether this shared string begins with the given prefix,
66 // used mainly for searches when users give only the start of a name.
67 bool starts_with (const char *prefix) const
68 {
69 int plen = strlen (prefix);
70
71 return length () >= plen && !strncasecmp (s, prefix, plen);
72 }
73
74 // returns true if the substring is contained in the shstr
75 // if the shstr is 0, then this always returns false.
76 // the shstr is (theoretically) treated as a comma/colon/space etc. separated list.
77 bool contains (const char *substring) const
78 {
79 return s != null () && strstr (s, substring);
80 }
81
82 //TODO: case sensitive should be eradicated
83 bool eq_nc (const char *otherstring) const
84 {
85 return !strcasecmp (s, otherstring);
86 }
87
88 shstr_tmp ()
89 : s (null ())
90 {
91 }
92
93 shstr_tmp (const shstr_tmp &sh)
94 : s (sh.s)
95 {
96 }
97
98 shstr_tmp operator =(const shstr_tmp &sh)
99 {
100 s = sh.s;
101
102 return *this;
103 }
104
105 // this is used for informational messages and the like
106 const char *operator &() const { return s; }
107
108 operator const char *() const { return s == null () ? 0 : s; }
109
110protected:
111 // dummy is there so it isn't used as type converter accidentally
112 shstr_tmp (int dummy, const char *s)
113 : s(s)
114 {
115 }
116};
117
118inline bool operator ==(const shstr_tmp &a, const shstr_tmp &b)
119{
120 return a.s == b.s;
121}
122
123inline bool operator !=(const shstr_tmp &a, const shstr_tmp &b)
124{
125 return a.s != b.s;
126}
127
128inline int strlen (shstr_tmp sh)
129{
130 return sh.length ();
131}
132
133static inline std::ostream &operator <<(std::ostream &o, shstr_tmp sh)
134{
135 o.write (sh.s, sh.length ());
136
137 return o;
138}
139
140struct shstr : shstr_tmp
141{
142 static unsigned int &refcnt (const char *s)
143 {
144 return *((unsigned int *)s - 1);
145 }
146
147 unsigned int &refcnt () const
50 { 148 {
51 return refcnt (s); 149 return refcnt (s);
52 } 150 }
53 151
54 int length () const 152 shstr ()
55 { 153 {
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 } 154 }
66 155
67 static const char *find (const char *s); 156 static const char *find (const char *s);
68 static const char *intern (const char *s); 157 static const char *intern (const char *s);
69 158
70 static void gc (); // garbage collect a few strings 159 static void gc (); // garbage collect a few strings
71 160
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) 161 shstr (const shstr &sh)
84 : s (sh.s) 162 : shstr_tmp (sh)
85 { 163 {
86 ++refcnt (); 164 ++refcnt ();
87 } 165 }
88 166
167 shstr (const shstr_tmp &sh)
168 : shstr_tmp (sh)
169 {
170 ++refcnt ();
171 }
172
89 explicit shstr (const char *s) 173 explicit shstr (const char *str)
90 : s (intern (s)) 174 : shstr_tmp (0, is_constant (str) && !str ? null () : intern (str))
91 { 175 {
92 } 176 }
93 177
94 ~shstr () 178 ~shstr ()
95 { 179 {
96 --refcnt (); 180 --refcnt ();
97 } 181 }
98 182
183 using shstr_tmp::operator &;
184 using shstr_tmp::operator const char *;
185
186 // (note: not the copy constructor)
99 const shstr &operator =(const shstr &sh) 187 shstr &operator =(const shstr_tmp &sh)
100 { 188 {
101 --refcnt (); 189 --refcnt ();
102 s = sh.s; 190 s = sh.s;
103 ++refcnt (); 191 ++refcnt ();
104 192
105 return *this; 193 return *this;
106 } 194 }
107 195
196 // here it comes
197 shstr &operator =(const shstr &sh)
198 {
199 return (*this) = (shstr_tmp)sh;
200 }
201
202 // shstr_tmp doesn't have this one
108 const shstr &operator =(const char *str) 203 shstr &operator =(const char *str)
109 { 204 {
110 --refcnt (); 205 --refcnt ();
111 206 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 207
118 return *this; 208 return *this;
119 } 209 }
120
121 bool operator ==(const shstr &b)
122 {
123 return s == b.s;
124 }
125
126 bool operator !=(const shstr &b)
127 {
128 return !(*this == b);
129 }
130}; 210};
131 211
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 212// only good for mass comparisons to shstr objects, or very
213// temporary passing, basically a non-refcounted shstr
156struct shstr_cmp 214struct shstr_cmp
157{ 215{
158 const char *s; 216 const char *s;
159 217
218 // initialies to the non-matching string (as opposed to the null string)
219 shstr_cmp ()
220 {
221 s = 0;
222 }
223
160 explicit shstr_cmp (const char *s) 224 shstr_cmp (const char *str)
161 : s (shstr::find (s)) 225 : s (shstr::find (str))
162 { 226 {
163 } 227 }
164 228
165 shstr_cmp (const shstr_cmp &sh) 229 shstr_cmp (shstr_tmp sh)
166 : s (sh.s) 230 : s (sh.s)
167 { 231 {
168 } 232 }
169 233
170 shstr_cmp &operator =(const shstr_cmp sh) { s = sh.s; return *this; } 234 // this is used for informational messages and the like
235 const char *operator &() const { return s; }
236
171 operator const char *() const { return s; } 237 operator const char *() const { return s; }
172}; 238};
173 239
174inline bool operator ==(const shstr_cmp &a, const shstr &b) 240inline bool operator ==(const shstr_cmp &a, const shstr_tmp &b)
175{ 241{
176 return a.s == b.s; 242 return a.s == b.s;
177} 243}
178 244
179inline bool operator ==(const shstr &a, const shstr_cmp &b) 245inline bool operator ==(const shstr_tmp &a, const shstr_cmp &b)
180{ 246{
181 return b == a; 247 return a.s == b.s;
182} 248}
183 249
184extern const shstr shstr_null;
185
186#define def(str) extern const shstr shstr_ ## str; 250#define def2(id,str) extern const shstr id;
251#define def(id) def2(shstr_ ## id, # id)
187# include "shstrinc.h" 252# include "shstrinc.h"
188#undef def 253#undef def
254#undef def2
255
256// undefined external reference to catch people using str* functions when they shouldn't
257//template<class any> void strcmp (const shstr_tmp &a, any b);
258template<class any> void strstr (const shstr_tmp &a, any b);
189 259
190#endif 260#endif
191 261

Diff Legend

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