Annotation of parser3/src/include/pa_string.h, revision 1.176
1.41 paf 1: /** @file
1.43 paf 2: Parser: string class decl.
3:
1.165 paf 4: Copyright (c) 2001-2005 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.176 ! misha 11: static const char * const IDENT_STRING_H="$Date: 2009-01-25 01:59:42 $";
1.145 paf 12:
13: // includes
1.4 paf 14: #include "pa_types.h"
1.145 paf 15: #include "pa_array.h"
16:
17: extern "C" { // cord's author forgot to do that
18: #define CORD_NO_IO
19: #include "cord.h"
20: };
1.4 paf 21:
1.164 paf 22: // defines
23:
1.146 paf 24: // cord extension
25: /* Returns true if x does contain */
26: /* char not_c at positions i..i+n. Value i,i+n must be < CORD_len(x). */
27: int CORD_range_contains_chr_greater_then(CORD x, size_t i, size_t n, int c);
1.148 paf 28: size_t CORD_block_count(CORD x);
1.146 paf 29:
1.145 paf 30: // forwards
1.9 paf 31:
1.145 paf 32: class Charset;
1.135 paf 33: class Table;
1.71 paf 34: class SQL_Connection;
1.101 parser 35: class Dictionary;
1.145 paf 36: class Request_charsets;
37: class String;
38: typedef Array<const String*> ArrayString;
39:
1.155 paf 40: // generally useful
41:
42: int pa_atoi(const char* str, const String* problem_source=0);
43: double pa_atod(const char* str, const String* problem_source=0);
44:
1.145 paf 45: /// this is result of pos functions which mean that substr were not found
46: #define STRING_NOT_FOUND ((size_t)-1)
47:
1.146 paf 48: template<typename T>
49: inline size_t get_length(T current) {
50: return current;
51: }
1.147 paf 52:
1.42 paf 53: /**
1.146 paf 54: String which knows the lang of all it's langs.
1.41 paf 55:
56: All pieces remember
57: - whether they are tainted or not,
1.146 paf 58: and the lang which should be used to detaint them
1.41 paf 59: */
1.176 ! misha 60:
! 61:
1.145 paf 62: class String: public PA_Object {
1.1 paf 63: public:
1.48 paf 64:
1.146 paf 65: /** piece is tainted or not. the lang to use when detaint
1.106 parser 66: remember to change String_Untaint_lang_name @ untaint.C along
1.148 paf 67:
68: WARNING WARNING WARNING WARNING WARNING WARNING
69:
70: pos function compares(<=) languages, that is used in searching
71: for table column separator being L_CLEAN or L_AS_IS.
72: they search for AS_IS, meaning AS_IS|CLEAN [doing <=L_AS_IS check].
73:
74: letters assigned for debugging, but it's important for no language-letter
75: come before L_AS_IS other then L_CLEAN
76:
77: WARNING WARNING WARNING WARNING WARNING WARNING
1.106 parser 78: */
1.145 paf 79: enum Language {
1.146 paf 80: L_UNSPECIFIED=0, ///< no real string has parts of this lange: it's just convinient to check when string's empty
1.145 paf 81: // these two must go before others, there are checks for >L_AS_IS
1.170 misha 82: L_CLEAN='0', ///< clean WARNING: read above warning before changing
83: L_AS_IS='A', ///< leave all characters intact WARNING: read above warning before changing
1.122 paf 84:
1.148 paf 85: L_PASS_APPENDED='P',
1.41 paf 86: /**<
1.146 paf 87: leave lang built into string being appended.
1.41 paf 88: just a flag, that value not stored
89: */
1.170 misha 90: L_TAINTED='T', ///< tainted, untaint lang as assigned later
1.146 paf 91: // untaint langs. assigned by ^untaint[lang]{...}
1.170 misha 92: L_FILE_SPEC='F', ///< file specification
93: L_HTTP_HEADER='h', ///< text in HTTP response header
94: L_MAIL_HEADER='m', ///< text in mail header
95: L_URI='U', ///< text in uri
96: L_SQL='Q', ///< ^table:sql body
97: L_JS='J', ///< JavaScript code
1.148 paf 98: L_XML='X', ///< ^dom:set xml
1.170 misha 99: L_HTML='H', ///< HTML code
100: L_REGEX='R', ///< RegEx expression
101: L_HTTP_COOKIE='C', ///< cookies encoded as %uXXXX for compartibility with js functions encode/decode
1.175 misha 102: L_FILE_POST='f', ///temporary escaping zero-char
1.148 paf 103: // READ WARNING ABOVE BEFORE ADDING ANYTHING
1.146 paf 104: L_OPTIMIZE_BIT = 0x80 ///< flag, requiring cstr whitespace optimization
1.27 paf 105: };
106:
1.157 paf 107: enum Trim_kind {
108: TRIM_BOTH,
109: TRIM_START,
110: TRIM_END
111: };
112:
1.176 ! misha 113:
1.147 paf 114: union Languages {
1.146 paf 115:
1.147 paf 116: struct {
1.160 paf 117: #ifdef PA_LITTLE_ENDIAN
1.147 paf 118: Language lang:8;
119: int is_not_just_lang:sizeof(CORD)*8-8;
1.160 paf 120: #elif defined(PA_BIG_ENDIAN)
121: int is_not_just_lang:sizeof(CORD)*8-8;
122: Language lang:8;
123: #else
124: # error word endianness not determined for some obscure reason
125: #endif
1.147 paf 126: } opt;
127: CORD langs;
1.146 paf 128:
129: template<typename C>
130: CORD make_langs(C current) const {
1.147 paf 131: return opt.is_not_just_lang?
1.146 paf 132: langs
1.162 paf 133: :CORD_chars((char)opt.lang, get_length(current));
1.146 paf 134: }
135:
136: CORD make_langs(size_t aoffset, size_t alength) const {
1.147 paf 137: return opt.is_not_just_lang?
1.146 paf 138: CORD_substr(langs, aoffset, alength)
1.162 paf 139: :CORD_chars((char)opt.lang, alength);
1.145 paf 140: }
141:
1.157 paf 142: /// appending when 'langs' already contain something [simple cases handled elsewhere]
1.146 paf 143: template<typename C>
144: void append(C current,
145: const CORD to_nonempty_target_langs) {
146: assert(langs);
147:
1.147 paf 148: if(opt.is_not_just_lang)
1.146 paf 149: langs=CORD_cat(langs, to_nonempty_target_langs);
150: else { // we were "just lang"
151: size_t current_size=get_length(current);
152: assert(current_size);
153: langs=CORD_cat(
1.162 paf 154: CORD_chars((char)opt.lang, current_size), // first piece [making from just 'lang']
1.146 paf 155: to_nonempty_target_langs); // new piece
156: }
1.145 paf 157: }
1.146 paf 158:
1.145 paf 159: public:
1.146 paf 160:
161: const char* v() const;
1.164 paf 162: void dump() const;
1.146 paf 163:
164: Languages(): langs(0) {}
1.147 paf 165: Languages(Language alang) {
166: opt.lang=alang;
167: opt.is_not_just_lang=0;
168: }
1.146 paf 169:
170: /// MUST be called exactly prior to modification of current [uses it's length]
171: template<typename C>
172: void append(C current, Language alang, size_t asize) {
173: assert(alang);
174: assert(asize);
175:
1.147 paf 176: if(!opt.is_not_just_lang)
177: if(opt.lang) {
178: if(opt.lang==alang) // same length? ignoring
1.146 paf 179: return;
180: } else {
1.147 paf 181: opt.lang=alang; // to uninitialized
1.146 paf 182: return;
1.145 paf 183: }
1.146 paf 184:
1.162 paf 185: append(current, CORD_chars((char)alang, asize));
1.146 paf 186: }
187:
1.176 ! misha 188: template<typename C>
! 189: void appendHelper(C current, Language alang, C asize_helper) {
! 190: assert(alang);
! 191:
! 192: if(!opt.is_not_just_lang)
! 193: if(opt.lang) {
! 194: if(opt.lang==alang) // same length? ignoring
! 195: return;
! 196: } else {
! 197: opt.lang=alang; // to uninitialized
! 198: return;
! 199: }
! 200:
! 201: append(current, CORD_chars((char)alang, asize_helper.length()));
! 202: }
! 203:
! 204:
1.146 paf 205: /// MUST be called exactly prior to modification of current [uses it's length]
206: template<typename C>
1.176 ! misha 207: void append(C current, size_t appending_length, const Languages src) {
1.146 paf 208: assert(appending_length);
209:
210: if(!langs)
211: langs=src.langs; // to uninitialized
1.147 paf 212: else if(!src.opt.is_not_just_lang)
213: append(current, src.opt.lang, appending_length); // simplifying when simple source
1.146 paf 214: else
215: append(current, src.make_langs(appending_length));
216: }
1.176 ! misha 217:
! 218:
! 219: template<typename C>
! 220: void appendHelper(C current, C length_helper, const Languages src) {
! 221:
! 222: if(!langs)
! 223: langs=src.langs; // to uninitialized
! 224: else if(!src.opt.is_not_just_lang)
! 225: appendHelper(current, src.opt.lang, length_helper); // simplifying when simple source
! 226: else
! 227: append(current, src.make_langs(length_helper));
! 228: }
! 229:
! 230:
1.146 paf 231: /// MUST be called exactly prior to modification of current [uses it's length]
232: template<typename C>
233: void append(C current,
234: const Languages src, size_t aoffset, size_t alength) {
235: assert(alength);
236:
237: if(!langs) // to uninitialized?
1.147 paf 238: if(src.opt.is_not_just_lang)
1.146 paf 239: langs=CORD_substr(src.langs, aoffset, alength); // to uninitialized complex
240: else
1.147 paf 241: opt.lang=src.opt.lang; // to uninitialized simple
1.146 paf 242: else
1.147 paf 243: if(!opt.is_not_just_lang && !src.opt.is_not_just_lang && opt.lang==src.opt.lang) // both simple & of same language?
1.146 paf 244: return; // ignoring
245: else
246: append(current, src.make_langs(aoffset, alength));
247: }
248:
249: /// checks if we have lang<=alang all from aoffset to aoffset+alength
250: bool check_lang(Language alang, size_t aoffset, size_t alength) const {
251: if(alang==L_UNSPECIFIED) // ignore lang?
252: return true;
253:
1.147 paf 254: if(opt.is_not_just_lang)
1.146 paf 255: return CORD_range_contains_chr_greater_then(langs, aoffset, alength, (unsigned)alang)==0;
256: else
1.169 misha 257: return (unsigned)opt.lang<=(unsigned)alang;
1.146 paf 258: }
259:
1.148 paf 260: /// @returns count of blocks
261: /// @todo currently there can be adjucent blocks of same language. someday merge them
262: size_t count() const {
263: return opt.is_not_just_lang?
264: CORD_block_count(langs)
265: : opt.lang?
266: 1
267: : 0;
268: };
269:
1.146 paf 270: template<typename C, typename I>
271: void for_each(C current,
272: int callback(char, size_t, I), I info) const {
273:
1.147 paf 274: if(opt.is_not_just_lang)
1.146 paf 275: CORD_block_iter(langs, 0, (CORD_block_iter_fn)callback, info);
276: else
1.147 paf 277: callback(opt.lang, get_length(current), info);
1.146 paf 278: }
279:
1.164 paf 280: bool invariant(size_t current_length) const {
1.146 paf 281: if(!langs)
282: return current_length==0;
1.147 paf 283: if(opt.is_not_just_lang)
1.146 paf 284: return CORD_len(langs)==current_length;
285: return true; // uncheckable, actually
286: }
287: };
288:
289: class Body {
290:
291: CORD body;
292:
293: public:
294:
295: const char* v() const;
1.164 paf 296: void dump() const;
1.146 paf 297:
298: Body(): body(CORD_EMPTY) {}
299: Body(CORD abody): body(abody) {
300: assert(!body // no body
301: || *body // ordinary string
302: || body[1]==1 // CONCAT_HDR
303: || body[1]==4 // FN_HDR
304: || body[1]==6 // SUBSTR_HDR
305: );
306: }
307: /// WARNING: length is only HELPER length, str in ANY case should be zero-terminated
308: Body(const char* str, size_t helper_length): body(CORD_EMPTY) {
309: append_know_length(str, helper_length?helper_length:strlen(str));
310: }
311: static Body Format(int value);
312:
313: void clear() { body=CORD_EMPTY; }
314:
315: bool operator! () const { return is_empty(); }
316:
317: uint hash_code() const;
318:
319: const char* cstr() const { return CORD_to_const_char_star(body); }
320: char* cstrm() const { return CORD_to_char_star(body); }
321:
322: size_t length() const { return CORD_len(body); }
323:
324: bool is_empty() const { return body==CORD_EMPTY; }
325:
326: void append_know_length(const char *str, size_t known_length) {
327: if(known_length)
328: body=CORD_cat_char_star(body, str, known_length);
329: }
330: void append_strdup_know_length(const char* str, size_t known_length) {
331: if(known_length)
332: append_know_length(pa_strdup(str, known_length), known_length);
333: }
334: void append(char c) { body=CORD_cat_char(body, c); }
335: Body& operator << (const Body src) { body=CORD_cat(body, src.body); return *this; }
336: Body& operator << (const char* str) { append_know_length(str, strlen(str)); return *this; }
337:
338: // could not figure out why this operator is needed [should do this chain: string->simple->==]
339: bool operator < (const Body src) const { return CORD_cmp(body, src.body)<0; }
340: bool operator > (const Body src) const { return CORD_cmp(body, src.body)>0; }
341: bool operator <= (const Body src) const { return CORD_cmp(body, src.body)<=0; }
342: bool operator >= (const Body src) const { return CORD_cmp(body, src.body)>=0; }
343: bool operator != (const Body src) const { return CORD_cmp(body, src.body)!=0; }
344: bool operator == (const Body src) const { return CORD_cmp(body, src.body)==0; }
345:
346: int ncmp(size_t x_begin, const Body y, size_t y_begin, size_t size) const {
347: return CORD_ncmp(body, x_begin, y.body, y_begin, size);
1.145 paf 348: }
349:
1.146 paf 350: char fetch(size_t index) const { return CORD_fetch(body, index); }
351: Body mid(size_t index, size_t length) const { return CORD_substr(body, index, length); }
352: size_t pos(const char* substr, size_t offset=0) const { return CORD_str(body, offset, substr); }
353: size_t pos(const Body substr, size_t offset=0) const {
354: if(!substr.length())
355: return STRING_NOT_FOUND; // in this case CORD_str returns 0 [parser users got used to -1]
1.150 paf 356:
357: // CORD_str checks for bad offset [CORD_chr does not]
1.146 paf 358: return CORD_str(body, offset, substr.body);
359: }
360: size_t pos(char c,
361: size_t offset=0) const {
1.150 paf 362: if(offset>=length()) // CORD_chr does not check that [and ABORT's in that case]
363: return STRING_NOT_FOUND;
364:
1.146 paf 365: return CORD_chr(body, offset, c);
1.145 paf 366: }
1.146 paf 367:
1.159 paf 368: template<typename I> int for_each(
369: int (*f)(char c, I),
370: I info) const {
371: return CORD_iter(body, (CORD_iter_fn)f, (void*)info);
372: }
373:
374: template<typename I> int for_each(
1.149 paf 375: int (*f1)(char c, I),
376: int (*f2)(const char* s, I),
377: I info) const {
1.159 paf 378: return CORD_iter5(body, 0, (CORD_iter_fn)f1, (CORD_batched_iter_fn)f2, info);
1.148 paf 379: }
1.146 paf 380:
381: void set_pos(CORD_pos& pos, size_t index) const { CORD_set_pos(pos, body, index); }
382:
383: /*Body normalize() const {
384: return Body(CORD_balance(body));
385: }*/
1.157 paf 386:
387: /// @returns this or 0 or mid. if returns this or 0 out_* are not filled
388: Body trim(Trim_kind kind=TRIM_BOTH, const char* chars=0,
389: size_t* out_start=0, size_t* out_length=0) const;
1.145 paf 390: };
391:
392: struct C {
393: const char *str;
394: size_t length;
395: operator const char *() { return str; }
1.158 paf 396: C(): str(0), length(0) {}
1.145 paf 397: C(const char *astr, size_t asize): str(astr), length(asize) {}
398: };
399:
400: struct Cm {
401: char *str;
402: size_t length;
403: //operator char *() { return str; }
1.158 paf 404: Cm(): str(0), length(0) {}
1.145 paf 405: Cm(char *astr, size_t asize): str(astr), length(asize) {}
406: };
407:
408: private:
409:
1.152 paf 410: Body body; ///< all characters of string
1.146 paf 411: Languages langs; ///< string characters lang
412:
413: const char* v() const;
1.164 paf 414: void dump() const;
415: #define ASSERT_STRING_INVARIANT(string) \
416: assert((string).langs.invariant((string).body.length()))
1.145 paf 417:
1.8 paf 418: public:
1.151 paf 419:
420: static const String Empty;
1.8 paf 421:
1.145 paf 422: explicit String(const char* cstr=0, size_t helper_length=0, bool tainted=false);
423: explicit String(const C cstr, bool tainted=false);
1.146 paf 424: String(Body abody, Language alang): body(abody), langs(alang) {
425: ASSERT_STRING_INVARIANT(*this);
426: }
427: String(const String& src): body(src.body), langs(src.langs) {
428: ASSERT_STRING_INVARIANT(*this);
1.145 paf 429: }
430:
431: /// for convinient hash lookup
1.146 paf 432: operator const Body() const { return body; }
1.145 paf 433:
434: bool is_empty() const { return body.is_empty(); }
435: size_t length() const { return body.length(); }
1.171 misha 436: size_t length(Charset& charset) const;
1.145 paf 437:
438: /// convert to CORD. if 'lang' known, forcing 'lang' to it
1.146 paf 439: Body cstr_to_string_body(Language lang=L_AS_IS,
1.145 paf 440: SQL_Connection* connection=0,
441: const Request_charsets *charsets=0) const;
442:
443: /// convert to constant C string. if 'lang' known, forcing 'lang' to it
444: const char* cstr(Language lang=L_AS_IS,
445: SQL_Connection* connection=0,
446: const Request_charsets *charsets=0) const {
447: return cstr_to_string_body(lang, connection, charsets).cstr();
448: }
449: /// convert to Modifiable C string. if 'lang' known, forcing 'lang' to it
450: char *cstrm(Language lang=L_AS_IS,
451: SQL_Connection* connection=0,
452: const Request_charsets *charsets=0) const {
453: return cstr_to_string_body(lang, connection, charsets).cstrm();
1.50 paf 454: }
1.108 parser 455: /// puts pieces to buf
1.145 paf 456: Cm serialize(size_t prolog_size) const;
1.108 parser 457: /// appends pieces from buf to self
1.145 paf 458: bool deserialize(size_t prolog_size, void *buf, size_t buf_size);
1.146 paf 459: /// @see Body::append_know_length
1.145 paf 460: String& append_know_length(const char* str, size_t known_length, Language lang);
1.146 paf 461: /// @see Body::append_help_length
1.145 paf 462: String& append_help_length(const char* str, size_t helper_length, Language lang);
463: String& append_strdup(const char* str, size_t helper_length, Language lang);
464:
1.146 paf 465: bool operator == (const char* y) const { return body==Body(y); }
466: bool operator != (const char* y) const { return body!=Body(y); }
1.145 paf 467:
468: /// this starts with y
469: bool starts_with(const char* y) const {
1.146 paf 470: return body.ncmp(0/*x_begin*/, Body(y), 0/*y_begin*/, strlen(y))==0;
1.145 paf 471: }
472: /// x starts with this
473: bool this_starts(const char* x) const {
1.146 paf 474: return Body(x).ncmp(0/*x_begin*/, body, 0/*y_begin*/, length())==0;
1.26 paf 475: }
476:
1.145 paf 477: String& append_to(String& dest, Language lang, bool forced) const;
478: String& append(const String& src, Language lang, bool forced=false) {
479: return src.append_to(*this, lang, forced);
480: }
481: String& operator << (const String& src) { return append(src, L_PASS_APPENDED); }
482: String& operator << (const char* src) { return append_help_length(src, 0, L_AS_IS); }
1.147 paf 483: String& operator << (const Body src);
1.100 parser 484:
1.142 paf 485: /// extracts first char of a string, if any
486: char first_char() const {
1.145 paf 487: return is_empty()?0:body.fetch(0);
1.142 paf 488: }
1.54 paf 489:
1.145 paf 490: bool operator < (const String& src) const { return body<src.body; }
491: bool operator > (const String& src) const { return body>src.body; }
492: bool operator <= (const String& src) const { return body<=src.body; }
493: bool operator >= (const String& src) const { return body>=src.body; }
494: bool operator != (const String& src) const { return body!=src.body; }
495: bool operator == (const String& src) const { return body==src.body; }
496:
1.54 paf 497: /// extracts [start, finish) piece of string
1.145 paf 498: String& mid(size_t substr_begin, size_t substr_end) const;
1.172 misha 499: String& mid(Charset& charset, size_t from, size_t to, size_t helper_length=0) const;
1.145 paf 500:
501: /**
502: ignore lang if it's L_UNSPECIFIED
503: but when specified: look for substring that lies in ONE fragment in THAT lang
504: @return position of substr in string, -1 means "not found" [const char* version]
505: */
1.146 paf 506: size_t pos(const Body substr,
1.145 paf 507: size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
508: /// String version of @see pos(const char*, int, Language)
509: size_t pos(const String& substr,
510: size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
511: size_t pos(char c,
512: size_t this_offset=0) const {
513: return body.pos(c, this_offset);
514: }
1.173 misha 515: size_t pos(Charset& charset,
1.171 misha 516: const String& substr,
517: size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
1.55 paf 518:
1.145 paf 519: void split(ArrayString& result,
520: size_t& pos_after,
521: const char* delim,
522: Language lang=L_UNSPECIFIED, int limit=-1) const;
523: void split(ArrayString& result,
524: size_t& pos_after,
1.62 paf 525: const String& delim,
1.145 paf 526: Language lang=L_UNSPECIFIED, int limit=-1) const;
1.62 paf 527:
1.145 paf 528: typedef void (*Row_action)(Table& table, ArrayString* row,
1.136 paf 529: int prestart, int prefinish,
530: int poststart, int postfinish,
1.68 paf 531: void *info);
1.87 parser 532: /**
1.145 paf 533: @return table of found items, if any.
1.87 parser 534: table format is defined and fixed[can be used by others]:
535: @verbatim
536: prematch/match/postmatch/1/2/3/...
537: @endverbatim
538: */
1.145 paf 539: Table* match(Charset& source_charset,
1.64 paf 540: const String& regexp,
1.145 paf 541: const String* options,
1.99 parser 542: Row_action row_action, void *info,
1.168 misha 543: int& matches_count) const;
1.87 parser 544: enum Change_case_kind {
545: CC_UPPER,
546: CC_LOWER
547: };
1.145 paf 548: String& change_case(Charset& source_charset,
1.87 parser 549: Change_case_kind kind) const;
1.145 paf 550: const String& replace(const Dictionary& dict) const;
1.157 paf 551: const String& trim(Trim_kind kind=TRIM_BOTH, const char* chars=0) const;
1.155 paf 552: double as_double() const { return pa_atod(cstr(), this); }
553: int as_int() const { return pa_atoi(cstr(), this); }
1.167 misha 554: bool as_bool() const { return as_int()!=0; }
1.174 misha 555: const String& escape(Charset& source_charset) const;
1.137 paf 556:
1.7 paf 557: private: //disabled
558:
1.12 paf 559: String& operator = (const String&) { return *this; }
1.7 paf 560:
1.1 paf 561: };
1.119 paf 562:
1.146 paf 563: template<>
564: inline size_t get_length<String::Body>(String::Body body) {
565: return body.length();
566: }
567:
1.145 paf 568: /// simple hash code of string. used by Hash
1.146 paf 569: inline uint hash_code(const String::Body self) {
1.145 paf 570: return self.hash_code();
1.119 paf 571: }
1.147 paf 572:
573:
574: /// now that we've declared specialization we can use it
575: inline String& String::operator << (const String::Body src) {
576: langs.append(body, L_AS_IS, src.length());
577: body<<src;
578: return *this;
579: }
580:
1.1 paf 581:
582: #endif
E-mail: