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