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 | |
29 | extern size_t shstr_alloc; |
31 | extern size_t shstr_alloc; |
30 | |
32 | |
31 | extern int buf_overflow (const char *buf1, const char *buf2, int bufsize); |
33 | extern int buf_overflow (const char *buf1, const char *buf2, int bufsize); |
32 | |
34 | |
|
|
35 | template<int size> |
33 | struct shstr |
36 | struct 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. |
|
|
50 | struct 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 | 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 | |
|
|
122 | protected: |
|
|
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 | |
|
|
130 | inline bool operator ==(const shstr_tmp &a, const shstr_tmp &b) |
|
|
131 | { |
|
|
132 | return a.s == b.s; |
|
|
133 | } |
|
|
134 | |
|
|
135 | inline bool operator !=(const shstr_tmp &a, const shstr_tmp &b) |
|
|
136 | { |
|
|
137 | return a.s != b.s; |
|
|
138 | } |
|
|
139 | |
|
|
140 | inline int strlen (shstr_tmp sh) |
|
|
141 | { |
|
|
142 | return sh.length (); |
|
|
143 | } |
|
|
144 | |
|
|
145 | static inline std::ostream &operator <<(std::ostream &o, shstr_tmp sh) |
|
|
146 | { |
|
|
147 | o.write (sh.s, sh.length ()); |
|
|
148 | |
|
|
149 | return o; |
|
|
150 | } |
|
|
151 | |
|
|
152 | struct 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 |
50 | { |
160 | { |
51 | return refcnt (s); |
161 | return refcnt (s); |
52 | } |
162 | } |
53 | |
163 | |
54 | int length () const |
164 | shstr () |
55 | { |
165 | { |
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 | } |
166 | } |
66 | |
167 | |
67 | static const char *find (const char *s); |
168 | static const char *find (const char *s); |
68 | static const char *intern (const char *s); |
169 | static const char *intern (const char *s); |
69 | |
170 | |
70 | static void gc (); // garbage collect a few strings |
171 | static void gc (); // garbage collect a few strings |
71 | |
172 | |
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) |
173 | shstr (const shstr &sh) |
84 | : s (sh.s) |
174 | : shstr_tmp (sh) |
85 | { |
175 | { |
86 | ++refcnt (); |
176 | ++refcnt (); |
87 | } |
177 | } |
88 | |
178 | |
|
|
179 | shstr (const shstr_tmp &sh) |
|
|
180 | : shstr_tmp (sh) |
|
|
181 | { |
|
|
182 | ++refcnt (); |
|
|
183 | } |
|
|
184 | |
89 | explicit shstr (const char *s) |
185 | explicit shstr (const char *str) |
90 | : s (intern (s)) |
186 | : shstr_tmp (0, is_constant (str) && !str ? null () : intern (str)) |
91 | { |
187 | { |
92 | } |
188 | } |
93 | |
189 | |
94 | ~shstr () |
190 | ~shstr () |
95 | { |
191 | { |
96 | --refcnt (); |
192 | --refcnt (); |
97 | } |
193 | } |
98 | |
194 | |
|
|
195 | using shstr_tmp::operator &; |
|
|
196 | using shstr_tmp::operator const char *; |
|
|
197 | |
|
|
198 | // (note: not the copy constructor) |
99 | const shstr &operator =(const shstr &sh) |
199 | shstr &operator =(const shstr_tmp &sh) |
100 | { |
200 | { |
101 | --refcnt (); |
201 | --refcnt (); |
102 | s = sh.s; |
202 | s = sh.s; |
103 | ++refcnt (); |
203 | ++refcnt (); |
104 | |
204 | |
105 | return *this; |
205 | return *this; |
106 | } |
206 | } |
107 | |
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 |
108 | const shstr &operator =(const char *str) |
215 | shstr &operator =(const char *str) |
109 | { |
216 | { |
110 | --refcnt (); |
217 | --refcnt (); |
111 | |
218 | 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 | |
219 | |
118 | return *this; |
220 | return *this; |
119 | } |
221 | } |
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 | }; |
222 | }; |
131 | |
223 | |
132 | inline int strlen (const shstr &sh) |
|
|
133 | { |
|
|
134 | return sh.length (); |
|
|
135 | } |
|
|
136 | |
|
|
137 | inline 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 | |
|
|
149 | static 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 |
224 | // only good for mass comparisons to shstr objects, or very |
|
|
225 | // temporary passing, basically a non-refcounted shstr |
156 | struct shstr_cmp |
226 | struct shstr_cmp |
157 | { |
227 | { |
158 | const char *s; |
228 | const char *s; |
159 | |
229 | |
|
|
230 | // initialies to the non-matching string (as opposed to the null string) |
|
|
231 | shstr_cmp () |
|
|
232 | { |
|
|
233 | s = 0; |
|
|
234 | } |
|
|
235 | |
160 | explicit shstr_cmp (const char *s) |
236 | shstr_cmp (const char *str) |
161 | : s (shstr::find (s)) |
237 | : s (shstr::find (str)) |
162 | { |
238 | { |
163 | } |
239 | } |
164 | |
240 | |
165 | shstr_cmp (const shstr_cmp &sh) |
241 | shstr_cmp (shstr_tmp sh) |
166 | : s (sh.s) |
242 | : s (sh.s) |
167 | { |
243 | { |
168 | } |
244 | } |
169 | |
245 | |
170 | 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 | |
171 | operator const char *() const { return s; } |
249 | operator const char *() const { return s; } |
172 | }; |
250 | }; |
173 | |
251 | |
174 | inline bool operator ==(const shstr_cmp &a, const shstr &b) |
252 | inline bool operator ==(const shstr_cmp &a, const shstr_tmp &b) |
175 | { |
253 | { |
176 | return a.s == b.s; |
254 | return a.s == b.s; |
177 | } |
255 | } |
178 | |
256 | |
179 | inline bool operator ==(const shstr &a, const shstr_cmp &b) |
257 | inline bool operator ==(const shstr_tmp &a, const shstr_cmp &b) |
180 | { |
258 | { |
181 | return b == a; |
259 | return a.s == b.s; |
182 | } |
260 | } |
183 | |
261 | |
184 | extern const shstr shstr_null; |
|
|
185 | |
|
|
186 | #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) |
187 | # include "shstrinc.h" |
264 | # include "shstrinc.h" |
188 | #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); |
|
|
270 | template<class any> void strstr (const shstr_tmp &a, any b); |
189 | |
271 | |
190 | #endif |
272 | #endif |
191 | |
273 | |