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