Annotation of parser3/src/include/pa_string.h, revision 1.144.2.28.2.19
1.41 paf 1: /** @file
1.43 paf 2: Parser: string class decl.
3:
1.144.2.18 paf 4: Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com)
1.124 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.1 paf 6: */
7:
8: #ifndef PA_STRING_H
9: #define PA_STRING_H
1.140 paf 10:
1.144.2.28.2. 9(paf 11:3): static const char* IDENT_STRING_H="$Date: 2003/03/21 14:27:51 $";
1.144.2.10 paf 12:
13: // includes
1.1 paf 14:
1.144.2.12 paf 15: #include "pa_types.h"
16: #include "pa_array.h"
1.4 paf 17:
1.144.2.28.2. (paf 18:): extern "C" { // cord's author forgot to do that
19:): #include "cord.h"
20:): };
21:):
1.144.2.12 paf 22: // forwards
1.144.2.10 paf 23:
1.144.2.28 paf 24: class Charset;
1.144.2.28.2. (paf 25:): class Table;
1.144.2.5 paf 26: class SQL_Connection;
27: class Dictionary;
1.144.2.15 paf 28: class Request_charsets;
1.144.2.28.2. (paf 29:): class String;
7(paf 30:3): typedef Array<const String*> ArrayString;
1.144.2.5 paf 31:
32: // helpers
1.144.2.28.2. 0(paf 33:3): /*
(paf 34:): /// appends clean piece to String @see String::append
7(paf 35:3): #define APPEND_CLEAN(src, length) append(src, length, String::L_CLEAN)
(paf 36:): /// appends piece to String as-is @see String::append
7(paf 37:3): #define APPEND_AS_IS(src, length) append(src, length, String::L_AS_IS)
(paf 38:): /// appends tainted piece to String @see String::append
7(paf 39:3): #define APPEND_TAINTED(src, length) append(src, length, String::L_TAINTED)
(paf 40:): /// handy: appends const char* piece to String @see String::append
41:): #define APPEND_CONST(src) APPEND_AS_IS(src, 0)
0(paf 42:3): */
(paf 43:): /// this is result of pos functions which mean that substr were not found
44:): #define STRING_NOT_FOUND ((size_t)-1)
45:):
7(paf 46:3): class StringBody {
47:3):
48:3): CORD body;
49:3):
50:3): public:
51:3):
52:3): StringBody(): body(CORD_EMPTY) {}
53:3): StringBody(CORD abody): body(abody) {}
54:3):
55:3): void clear() { body=CORD_EMPTY; }
56:3):
57:3): uint hash_code() const;
58:3):
59:3): size_t length() const { return CORD_len(body); }
60:3):
61:3): bool is_empty() const { return body==CORD_EMPTY; }
62:3):
63:3): void append(const char *str, size_t length) {
64:3): CORD_cat_char_star(body, str, length);
65:3): }
66:3): void append(char c) { CORD_cat_char(body, c); }
9(paf 67:3): void append(StringBody src) { CORD_cat(body, src.body); }
7(paf 68:3):
69:3): // could not figure out why this operator is needed [should do this chain: string->simple->==]
70:3): bool operator < (const StringBody& src) const { return CORD_cmp(body, src.body)<0; }
71:3): bool operator > (const StringBody& src) const { return CORD_cmp(body, src.body)>0; }
72:3): bool operator <= (const StringBody& src) const { return CORD_cmp(body, src.body)<=0; }
73:3): bool operator >= (const StringBody& src) const { return CORD_cmp(body, src.body)>=0; }
74:3): bool operator != (const StringBody& src) const { return CORD_cmp(body, src.body)!=0; }
75:3): bool operator == (const StringBody& src) const { return CORD_cmp(body, src.body)==0; }
76:3):
77:3): int ncmp(size_t x_begin, const StringBody y, size_t y_begin, size_t size) const {
78:3): return CORD_ncmp(body, x_begin, y.body, y_begin, size);
79:3): }
80:3):
81:3): char fetch(size_t index) const { return CORD_fetch(body, index); }
82:3):
83:3): };
(paf 84:):
1.144.2.2 paf 85: /**
86: String which knows the language of all it's fragments.
1.41 paf 87:
88: All pieces remember
89: - whether they are tainted or not,
90: and the language which should be used to detaint them
91: */
1.144.2.28.2. (paf 92:): class String: public PA_Object {
93:):
7(paf 94:3): friend class StringBody;
95:3):
1.144.2.2 paf 96: public:
1.1 paf 97:
1.106 parser 98: /** piece is tainted or not. the language to use when detaint
99: remember to change String_Untaint_lang_name @ untaint.C along
100: */
1.144.2.28.2. 7(paf 101:3): enum Language {
102:3): L_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
103:3): // these two must go before others, there are checks for >L_AS_IS
104:3): L_CLEAN, ///< clean
105:3): L_AS_IS, ///< leave all characters intact
1.122 paf 106:
1.144.2.28.2. 7(paf 107:3): L_PASS_APPENDED,
1.41 paf 108: /**<
109: leave language built into string being appended.
110: just a flag, that value not stored
111: */
1.144.2.28.2. 7(paf 112:3): L_TAINTED, ///< tainted, untaint language as assigned later
1.122 paf 113: // untaint languages. assigned by ^untaint[lang]{...}
1.144.2.28.2. 7(paf 114:3): L_FILE_SPEC, ///< file specification
115:3): L_HTTP_HEADER, ///< text in HTTP response header
116:3): L_MAIL_HEADER, ///< text in mail header
117:3): L_URI, ///< text in uri
118:3): L_TABLE, ///< ^table:set body
119:3): L_SQL, ///< ^table:sql body
120:3): L_JS, ///< JavaScript code
121:3): L_XML, ///< ^dom:set xml
122:3): L_HTML, ///< HTML code (for editing)
123:3): L_OPTIMIZE_BIT = 0x8000 ///< flag, requiring cstr whitespace optimization
1.27 paf 124: };
125:
1.144.2.28.2. (paf 126:): struct Fragment {
7(paf 127:3): Language lang; ///< untaint flag, later untaint language
0(paf 128:3): size_t length; ///< length
7(paf 129:3): Fragment(Language alang, size_t asize): lang(alang), length(asize) {}
(paf 130:): };
131:):
132:): class ArrayFragment: public Array<Fragment> {
6(paf 133:3): void append(element_type src) {
(paf 134:): *static_cast<Array<Fragment> *>(this)+=src;
135:): }
6(paf 136:3): /// hiding from accidental USE, use append_positions
137:3): void append(const ArrayFragment& src, int offset, int limit) {
138:3): static_cast<Array<Fragment> *>(this)->append(src, offset, limit);
139:3): }
(paf 140:): public:
141:): ArrayFragment& operator += (element_type src) {
142:): if(count()) { // not empty?
143:): // try to join with last
144:): Fragment& last=get(count()-1);
145:): if(last.lang==src.lang) {
0(paf 146:3): last.length+=src.length;
(paf 147:): return *this;
148:): }
149:): }
6(paf 150:3): append(src);
(paf 151:): return *this;
152:): }
6(paf 153:3): void append(const ArrayFragment& src) { append(src, 0, 0); }
154:3): void append_positions(const ArrayFragment& src, size_t substr_begin, size_t substr_end);
(paf 155:): };
156:):
157:): struct C {
158:): char *str;
0(paf 159:3): size_t length;
(paf 160:): operator char *() { return str; }
0(paf 161:3): C(char *astr, size_t asize): str(astr), length(asize) {}
(paf 162:): };
163:):
164:): private:
165:):
7(paf 166:3): StringBody body; ///< all characters of string
0(paf 167:3): ArrayFragment fragments; ///< fragment language+length info
(paf 168:):
1.8 paf 169: public:
170:
1.144.2.28.2. 1(paf 171:3): /// @todo check all places for length to be only HELPER length, and never be !=strlen(cstr)
0(paf 172:3): explicit String(const char* cstr=0, size_t helper_length=0, bool tainted=false);
1.14 paf 173: String(const String& src);
1.144.2.28.2. 7(paf 174:3): String(StringBody abody, Language alang): body(abody) {
175:3): fragments+=Fragment(alang, abody.length());
176:3): }
177:3):
178:3): /// for convinient hash lookup
179:3): operator StringBody() const { return body; }
180:3):
181:3): bool is_empty() const { return body.is_empty(); }
182:3): size_t length() const { return body.length(); }
(paf 183:):
2(paf 184:3): /// convert to CORD. if 'lang' known, forcing 'lang' to it
7(paf 185:3): CORD cstr_to_cord(Language lang=L_AS_IS,
186:3): SQL_Connection* connection=0,
(paf 187:): const Request_charsets *charsets=0) const;
188:):
2(paf 189:3): /// convert to constant C string. if 'lang' known, forcing 'lang' to it
7(paf 190:3): const char* cstr(Language lang=L_AS_IS,
191:3): SQL_Connection* connection=0,
1.144.2.14 paf 192: const Request_charsets *charsets=0) const {
1.144.2.28.2. (paf 193:): return CORD_to_const_char_star(cstr_to_cord(lang, connection, charsets));
194:): }
2(paf 195:3): /// convert to Modifiable C string. if 'lang' known, forcing 'lang' to it
7(paf 196:3): char *cstrm(Language lang=L_AS_IS,
197:3): SQL_Connection* connection=0,
(paf 198:): const Request_charsets *charsets=0) const {
199:): return CORD_to_char_star(cstr_to_cord(lang, connection, charsets));
1.144.2.9 paf 200: }
1.108 parser 201: /// puts pieces to buf
1.144.2.28.2. (paf 202:): C serialize(size_t prolog_size) const;
1.108 parser 203: /// appends pieces from buf to self
1.144.2.18 paf 204: bool deserialize(size_t prolog_size, void *buf, size_t buf_size, const char* file);
1.144.2.28.2. 6(paf 205:3): /** append fragment,
9(paf 206:3): @c length can be zero, it will be autocalced
6(paf 207:3): when length<strlen(str) makes heap copy of @c str piece
1.46 paf 208: */
1.144.2.28.2. 9(paf 209:3): String& append(const char* str, size_t length, Language lang);
(paf 210:):
7(paf 211:3): bool operator == (const char* y) const { return body==StringBody(y); }
(paf 212:):
213:): /// this starts with y
7(paf 214:3): bool starts_with(const char* y) const {
215:3): return body.ncmp(0/*x_begin*/, StringBody(y), 0/*y_begin*/, strlen(y))==0;
1.80 paf 216: }
1.144.2.28.2. (paf 217:): /// y starts with this
7(paf 218:3): bool this_starts(const char* y) const {
219:3): return body.ncmp(0/*x_begin*/, StringBody(y), 0/*y_begin*/, strlen(y))==0;
(paf 220:): }
1.80 paf 221:
1.144.2.28.2. 7(paf 222:3): String& append_to(String& dest, Language lang, bool forced) const;
223:3): String& append(const String& src, Language lang, bool forced=false) {
1.144.2.11 paf 224: return src.append_to(*this, lang, forced);
225: }
1.144.2.28.2. 7(paf 226:3): String& operator << (const String& src) { return append(src, L_PASS_APPENDED); }
227:3): String& operator << (const char* src) { return append(src, 0, L_AS_IS); }
9(paf 228:3): String& operator << (const StringBody& src) {
229:3): body.append(src);
230:3): fragments+=Fragment(L_AS_IS, src.length());
231:3): return *this;
232:3): }
1.100 parser 233:
1.142 paf 234: /// extracts first char of a string, if any
235: char first_char() const {
1.144.2.28.2. 7(paf 236:3): return is_empty()?0:body.fetch(0);
1.142 paf 237: }
1.144.2.28.2. 8(paf 238:3):
239:3): bool operator < (const String& src) const { return body<src.body; }
240:3): bool operator > (const String& src) const { return body>src.body; }
241:3): bool operator <= (const String& src) const { return body<=src.body; }
242:3): bool operator >= (const String& src) const { return body>=src.body; }
243:3): bool operator != (const String& src) const { return body!=src.body; }
244:3): bool operator == (const String& src) const { return body==src.body; }
1.54 paf 245:
246: /// extracts [start, finish) piece of string
1.144.2.28.2. 4(paf 247:3): const String& mid(size_t substr_begin, size_t substr_end) const;
(paf 248:):
249:): /**
7(paf 250:3): ignore lang if it's L_UNSPECIFIED
(paf 251:): but when specified: look for substring that lies in ONE fragment in THAT lang
252:): @return position of substr in string, -1 means "not found" [const char* version]
253:): */
254:): size_t pos(CORD substr,
7(paf 255:3): size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
256:3): /// String version of @see pos(const char*, int, Language)
(paf 257:): size_t pos(const String& substr,
7(paf 258:3): size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
1.62 paf 259:
1.144.2.22 paf 260: void split(ArrayString& result,
1.144.2.28.2. 5(paf 261:3): size_t& pos_after,
(paf 262:): const char* delim,
7(paf 263:3): Language lang=L_UNSPECIFIED, int limit=-1);
1.144.2.22 paf 264: void split(ArrayString& result,
1.144.2.28.2. 5(paf 265:3): size_t& pos_after,
1.62 paf 266: const String& delim,
1.144.2.28.2. 7(paf 267:3): Language lang=L_UNSPECIFIED, int limit=-1) const;
1.62 paf 268:
1.144.2.28.2. (paf 269:): typedef void (*Row_action)(Table* table, ArrayString* row,
1.136 paf 270: int prestart, int prefinish,
271: int poststart, int postfinish,
1.144.2.9 paf 272: void *info);
1.87 parser 273: /**
1.144.2.5 paf 274: @return table of found items, if any.
1.87 parser 275: table format is defined and fixed[can be used by others]:
276: @verbatim
277: prematch/match/postmatch/1/2/3/...
278: @endverbatim
279: */
1.144.2.28.2. (paf 280:): Table* match(Charset& source_charset,
1.64 paf 281: const String& regexp,
1.144.2.28.2. (paf 282:): const String& options,
1.99 parser 283: Row_action row_action, void *info,
1.144.2.27 paf 284: bool& just_matched) const;
1.87 parser 285: enum Change_case_kind {
286: CC_UPPER,
287: CC_LOWER
288: };
1.144.2.28.2. (paf 289:): String& change_case(Charset& source_charset,
1.144.2.17 paf 290: Change_case_kind kind);
1.144.2.28.2. (paf 291:): const String& replace(const Dictionary& dict) const;
292:): double as_double() const;
293:): int as_int() const;
1.137 paf 294:
1.7 paf 295: private: //disabled
296:
1.12 paf 297: String& operator = (const String&) { return *this; }
1.7 paf 298:
1.1 paf 299: };
1.144.2.7 paf 300:
301: /// simple hash code of string. used by Hash
1.144.2.28.2. 7(paf 302:3): inline uint hash_code(const StringBody& self) {
1.144.2.7 paf 303: return self.hash_code();
304: }
1.1 paf 305:
306: #endif
E-mail:
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to pa_string.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [parser3project] / parser3 / src / include