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.19 by root, Tue Oct 16 05:34:24 2007 UTC vs.
Revision 1.32 by root, Thu Jan 1 20:49:48 2009 UTC

1/* 1/*
2 * This file is part of Crossfire TRT, the Roguelike Realtime MORPG. 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 6 * Deliantra is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by 7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or 8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) 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, 11 * This program is distributed in the hope that it will be useful,
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 GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>. 17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 * 18 *
19 * 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>
20 */ 20 */
21 21
22#ifndef SHSTR_H__ 22#ifndef SHSTR_H__
23#define SHSTR_H__ 23#define SHSTR_H__
24 24
25#include <cstring>
25#include <sstream> 26#include <sstream>
26 27
27#include "util.h" 28#include "traits.h"
28 29
29extern size_t shstr_alloc; 30extern size_t shstr_alloc;
30 31
31extern int buf_overflow (const char *buf1, const char *buf2, int bufsize); 32extern int buf_overflow (const char *buf1, const char *buf2, int bufsize);
32 33
34template<int size>
33struct shstr 35struct shstr_vec
34{ 36{
35 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.
47struct shstr_tmp
48{
49 static shstr_vec<sizeof ("(null)")> nullvec;
50 static const char *null () { return nullvec.string; } // this is the null pointer value
36 51
37 const char *s; 52 const char *s;
38 53
39 static int &refcnt (const char *s)
40 {
41 return *((int *)s - 1);
42 }
43
44 static int &length (const char *s) 54 static unsigned int &length (const char *s)
45 { 55 {
46 return *((int *)s - 2); 56 return *((unsigned int *)s - 2);
47 } 57 }
48 58
49 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 // returns true if the substring is contained in the shstr
74 // if the shstr is 0, then this always returns false.
75 // the shstr is (theoretically) treated as a comma/colon/space etc. separated list.
76 bool contains (const char *substring) const
77 {
78 return s != null () && strstr (s, substring);
79 }
80
81 //TODO: case sensitive should be eradicated
82 bool eq_nc (const char *otherstring) const
83 {
84 return !strcasecmp (s, otherstring);
85 }
86
87 shstr_tmp ()
88 : s (null ())
89 {
90 }
91
92 shstr_tmp (const shstr_tmp &sh)
93 : s (sh.s)
94 {
95 }
96
97 shstr_tmp operator =(const shstr_tmp &sh)
98 {
99 s = sh.s;
100
101 return *this;
102 }
103
104 // this is used for informational messages and the like
105 const char *operator &() const { return s; }
106
107 operator const char *() const { return s == null () ? 0 : s; }
108
109protected:
110 // dummy is there so it isn't used as type converter accidentally
111 shstr_tmp (int dummy, const char *s)
112 : s(s)
113 {
114 }
115};
116
117inline bool operator ==(const shstr_tmp &a, const shstr_tmp &b)
118{
119 return a.s == b.s;
120}
121
122inline bool operator !=(const shstr_tmp &a, const shstr_tmp &b)
123{
124 return a.s != b.s;
125}
126
127inline int strlen (shstr_tmp sh)
128{
129 return sh.length ();
130}
131
132static std::ostream &operator <<(std::ostream &o, shstr_tmp sh)
133{
134 o.write (sh.s, sh.length ());
135
136 return o;
137}
138
139struct shstr : shstr_tmp
140{
141 static unsigned int &refcnt (const char *s)
142 {
143 return *((unsigned int *)s - 1);
144 }
145
146 unsigned int &refcnt () const
50 { 147 {
51 return refcnt (s); 148 return refcnt (s);
52 } 149 }
53 150
54 int length () const 151 shstr ()
55 { 152 {
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 } 153 }
66 154
67 static const char *find (const char *s); 155 static const char *find (const char *s);
68 static const char *intern (const char *s); 156 static const char *intern (const char *s);
69 157
70 static void gc (); // garbage collect a few strings 158 static void gc (); // garbage collect a few strings
71 159
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) 160 shstr (const shstr &sh)
84 : s (sh.s) 161 : shstr_tmp (sh)
85 { 162 {
86 ++refcnt (); 163 ++refcnt ();
87 } 164 }
88 165
166 shstr (const shstr_tmp &sh)
167 : shstr_tmp (sh)
168 {
169 ++refcnt ();
170 }
171
89 explicit shstr (const char *s) 172 explicit shstr (const char *str)
90 : s (intern (s)) 173 : shstr_tmp (0, is_constant (str) && !str ? null () : intern (str))
91 { 174 {
92 } 175 }
93 176
94 ~shstr () 177 ~shstr ()
95 { 178 {
96 --refcnt (); 179 --refcnt ();
97 } 180 }
98 181
182 using shstr_tmp::operator &;
183 using shstr_tmp::operator const char *;
184
185 // (note: not the copy constructor)
99 const shstr &operator =(const shstr &sh) 186 shstr &operator =(const shstr_tmp &sh)
100 { 187 {
101 --refcnt (); 188 --refcnt ();
102 s = sh.s; 189 s = sh.s;
103 ++refcnt (); 190 ++refcnt ();
104 191
105 return *this; 192 return *this;
106 } 193 }
107 194
195 // here it comes
196 shstr &operator =(const shstr &sh)
197 {
198 return (*this) = (shstr_tmp)sh;
199 }
200
201 // shstr_tmp doesn't have this one
108 const shstr &operator =(const char *str) 202 shstr &operator =(const char *str)
109 { 203 {
110 --refcnt (); 204 --refcnt ();
111 205 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 206
118 return *this; 207 return *this;
119 } 208 }
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}; 209};
131 210
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 211// only good for mass comparisons to shstr objects, or very
212// temporary passing, basically a non-refcounted shstr
156struct shstr_cmp 213struct shstr_cmp
157{ 214{
158 const char *s; 215 const char *s;
159 216
217 // initialies to the non-matching string (as opposed to the null string)
218 shstr_cmp ()
219 {
220 s = 0;
221 }
222
160 explicit shstr_cmp (const char *s) 223 shstr_cmp (const char *str)
161 : s (shstr::find (s)) 224 : s (shstr::find (str))
162 { 225 {
163 } 226 }
164 227
165 shstr_cmp (const shstr_cmp &sh) 228 shstr_cmp (shstr_tmp sh)
166 : s (sh.s) 229 : s (sh.s)
167 { 230 {
168 } 231 }
169 232
170 shstr_cmp &operator =(const shstr_cmp sh) { s = sh.s; return *this; } 233 // this is used for informational messages and the like
234 const char *operator &() const { return s; }
235
171 operator const char *() const { return s; } 236 operator const char *() const { return s; }
172}; 237};
173 238
174inline bool operator ==(const shstr_cmp &a, const shstr &b) 239inline bool operator ==(const shstr_cmp &a, const shstr_tmp &b)
175{ 240{
176 return a.s == b.s; 241 return a.s == b.s;
177} 242}
178 243
179inline bool operator ==(const shstr &a, const shstr_cmp &b) 244inline bool operator ==(const shstr_tmp &a, const shstr_cmp &b)
180{ 245{
181 return b == a; 246 return a.s == b.s;
182} 247}
183 248
184#define def(str) extern const shstr shstr_ ## str; 249#define def2(id,str) extern const shstr id;
250#define def(id) def2(shstr_ ## id, # id)
185# include "shstrinc.h" 251# include "shstrinc.h"
186#undef def 252#undef def
253#undef def2
254
255// undefined external reference to catch people using str* functions when they shouldn't
256//template<class any> void strcmp (const shstr_tmp &a, any b);
257template<class any> void strstr (const shstr_tmp &a, any b);
187 258
188#endif 259#endif
189 260

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines