Annotation of parser3/src/include/pa_string.h, revision 1.135
1.41 paf 1: /** @file
1.43 paf 2: Parser: string class decl.
3:
1.123 paf 4: Copyright (c) 2001, 2002 ArtLebedev Group (http://www.artlebedev.com)
1.124 paf 5: Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru)
1.29 paf 6:
1.135 ! paf 7: $Id: pa_string.h,v 1.134 2002/04/04 13:42:50 paf Exp $
1.1 paf 8: */
9:
10: #ifndef PA_STRING_H
11: #define PA_STRING_H
12:
1.15 paf 13: #include "pa_pool.h"
1.4 paf 14: #include "pa_types.h"
15:
1.9 paf 16: #ifndef NO_STRING_ORIGIN
1.33 paf 17: # define STRING_APPEND_PARAMS \
18: const char *src, size_t size, \
1.119 paf 19: uchar lang, \
1.33 paf 20: const char *file, uint line
1.54 paf 21: /// appends piece to String @see String::real_append
22: # define APPEND(src, size, lang, file, line) \
23: real_append(src, size, lang, file, line)
1.9 paf 24: #else
1.33 paf 25: # define STRING_APPEND_PARAMS \
26: const char *src, \
27: size_t size, \
1.119 paf 28: uchar lang
1.54 paf 29: /// appends piece to String @see String::real_append
30: # define APPEND(src, size, lang, file, line) \
31: real_append(src, size, lang)
32: #endif
1.83 paf 33: /// appends clean piece to String @see String::real_append
1.54 paf 34: #define APPEND_CLEAN(src, size, file, line) \
1.62 paf 35: APPEND(src, size, String::UL_CLEAN, file, line)
1.83 paf 36: /// appends piece to String as-is @see String::real_append
37: #define APPEND_AS_IS(src, size, file, line) \
38: APPEND(src, size, String::UL_AS_IS, file, line)
1.48 paf 39: /// appends tainted piece to String @see String::real_append
1.54 paf 40: #define APPEND_TAINTED(src, size, file, line) \
1.62 paf 41: APPEND(src, size, String::UL_TAINTED, file, line)
1.48 paf 42: /// handy: appends const char* piece to String @see String::real_append
1.83 paf 43: #define APPEND_CONST(src) APPEND_AS_IS(src, 0, 0, 0)
1.9 paf 44:
1.135 ! paf 45: class Table;
1.62 paf 46: class Array;
1.71 paf 47: class SQL_Connection;
1.101 parser 48: class Dictionary;
1.62 paf 49:
1.42 paf 50: /**
1.41 paf 51: Pooled string.
52:
1.47 paf 53: Internal structure:
54: @verbatim
55: String Chunk0
56: ====== ========
57: head--------------->[ptr, size, ...]
58: append_here-------->[ptr, size, ...]
59: .
60: .
61: [ptr, size, ...]
62: link_row----------->[link to the next chunk]
1.41 paf 63: @endverbatim
64:
65: All pieces remember
66: - the file and its line they are from [can be turned off by NO_STRING_ORIGIN]
67: - whether they are tainted or not,
68: and the language which should be used to detaint them
69: */
1.114 paf 70: #include "pa_pragma_pack_begin.h"
1.15 paf 71: class String : public Pooled {
1.1 paf 72: public:
1.48 paf 73:
1.1 paf 74: enum {
1.89 parser 75: CR_PREALLOCATED_COUNT=2, ///< default preallocated item count
1.125 paf 76: CR_GROW_COUNT=1 ///< each time the String chunk_is_full() string expanded()
1.1 paf 77: };
78:
1.106 parser 79: /** piece is tainted or not. the language to use when detaint
80: remember to change String_Untaint_lang_name @ untaint.C along
81: */
1.27 paf 82: enum Untaint_lang {
1.72 paf 83: UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
1.122 paf 84: // these two must go before others, there are checks for >UL_AS_IS
1.62 paf 85: UL_CLEAN, ///< clean
1.122 paf 86: UL_AS_IS, ///< leave all characters intact
87:
1.48 paf 88: UL_PASS_APPENDED,
1.41 paf 89: /**<
90: leave language built into string being appended.
91: just a flag, that value not stored
92: */
1.122 paf 93: UL_TAINTED, ///< tainted, untaint language as assigned later
94: // untaint languages. assigned by ^untaint[lang]{...}
1.103 parser 95: UL_FILE_SPEC, ///< file specification
1.74 paf 96: UL_HTTP_HEADER, ///< text in HTTP response header
97: UL_MAIL_HEADER, ///< text in mail header
1.48 paf 98: UL_URI, ///< text in uri
99: UL_TABLE, ///< ^table:set body
100: UL_SQL, ///< ^table:sql body
101: UL_JS, ///< JavaScript code
1.102 parser 102: UL_XML, ///< ^dom:set xml
1.48 paf 103: UL_HTML, ///< HTML code (for editing)
1.119 paf 104: UL_OPTIMIZE_BIT = 0x80 ///< flag, requiring cstr whitespace optimization
1.27 paf 105: };
106:
1.8 paf 107: public:
108:
1.77 paf 109: String(Pool& apool, const char *src=0, size_t src_size=0, bool tainted=false);
1.14 paf 110: String(const String& src);
1.135 ! paf 111: bool is_empty() const { return append_here==head.chunk.rows; }
1.117 paf 112: size_t size() const;
1.69 paf 113: /// convert to C string. if 'lang' known, forcing 'lang' to it
1.109 paf 114: char *cstr(Untaint_lang lang=UL_AS_IS,
1.82 paf 115: SQL_Connection *connection=0,
1.133 paf 116: Charset *cstr_charset=0, const char *cstr_charset_name=0) const {
1.88 parser 117:
1.121 paf 118: char *result=(char *)malloc(cstr_bufsize(lang, connection, cstr_charset));
1.133 paf 119: char *eol=store_to(result, lang, connection, cstr_charset, cstr_charset_name);
1.50 paf 120: *eol=0;
121: return result;
122: }
1.117 paf 123: char *cstr_debug_origins() const;
1.108 parser 124: /// puts pieces to buf
125: void serialize(size_t prolog_size, void *& buf, size_t& buf_size) const;
126: /// appends pieces from buf to self
1.132 paf 127: bool deserialize(size_t prolog_size, void *buf, size_t buf_size, const char *file);
1.46 paf 128: /** append fragment
1.83 paf 129: @see APPEND_AS_IS, APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST
1.46 paf 130: */
1.9 paf 131: String& real_append(STRING_APPEND_PARAMS);
1.44 paf 132: /// @return <0 ==0 or >0 depending on comparison result
1.62 paf 133: int cmp (int& partial, const String& src,
1.72 paf 134: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.56 paf 135: bool operator < (const String& src) const { int p; return cmp(p, src)<0; }
136: bool operator > (const String& src) const { int p; return cmp(p, src)>0; }
137: bool operator <= (const String& src) const { int p; return cmp(p, src)<=0; }
138: bool operator >= (const String& src) const { int p; return cmp(p, src)>=0; }
1.26 paf 139: bool operator == (const String& src) const {
140: if(size()!=src.size()) // can speed up in trivial case
141: return false;
1.56 paf 142: int p; return cmp(p, src)==0;
1.26 paf 143: }
1.56 paf 144: bool operator != (const String& src) const { int p; return cmp(p, src)!=0; }
1.26 paf 145:
1.50 paf 146: /**
147: @param partial
148: returns partial match status.
1.51 paf 149: - -1: strings too different
150: - 0: full match
151: - 1: means @c this starts @c src
152: - 2: means @src starts @this
1.50 paf 153: */
1.61 paf 154: int cmp(int& partial, const char* src_ptr, size_t src_size=0,
1.72 paf 155: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.50 paf 156: bool operator == (const char* src_ptr) const {
157: size_t src_size=src_ptr?strlen(src_ptr):0;
158: if(size() != src_size)
159: return false;
160: int partial; // unused
1.56 paf 161: return cmp(partial, src_ptr, src_size)==0;
1.50 paf 162: }
1.80 paf 163: bool operator != (const char* src_ptr) const {
164: int partial; // unused
165: return cmp(partial, src_ptr, 0)!=0;
166: }
167:
1.119 paf 168: String& append(const String& src, uchar lang, bool forced=false);
1.76 paf 169: String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
170: String& operator << (const char *src) { return APPEND_CONST(src); }
1.8 paf 171:
1.41 paf 172: /// simple hash code of string. used by Hash
1.14 paf 173: uint hash_code() const;
1.100 parser 174:
175: /// extracts first char of a string
176: char first_char() const;
1.54 paf 177:
178: /// extracts [start, finish) piece of string
1.70 paf 179: String& mid(size_t start, size_t finish) const;
1.55 paf 180:
1.59 paf 181: /// @return position of substr in string, -1 means "not found" [String version]
1.62 paf 182: int pos(const String& substr,
1.112 paf 183: int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.59 paf 184: /// @return position of substr in string, -1 means "not found" [const char* version]
1.97 parser 185: int pos(const char *substr, size_t substr_size=0,
1.112 paf 186: int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.62 paf 187:
188: void split(Array& result,
189: size_t *pos_after_ref,
190: const char *delim, size_t delim_size,
1.86 paf 191: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.62 paf 192: void split(Array& result,
193: size_t *pos_after_ref,
194: const String& delim,
1.86 paf 195: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.62 paf 196:
1.68 paf 197: typedef void (*Row_action)(Table& table, Array *row, int start, int finish,
198: void *info);
1.87 parser 199: /**
200: @return true if fills table.
201: table format is defined and fixed[can be used by others]:
202: @verbatim
203: prematch/match/postmatch/1/2/3/...
204: @endverbatim
205: */
1.120 paf 206: bool match(
1.81 paf 207: const String *aorigin,
1.64 paf 208: const String& regexp,
1.65 paf 209: const String *options,
1.66 paf 210: Table **table,
1.99 parser 211: Row_action row_action, void *info,
212: bool *was_global=0) const;
1.87 parser 213: enum Change_case_kind {
214: CC_UPPER,
215: CC_LOWER
216: };
1.120 paf 217: String& change_case(Pool& pool,
1.87 parser 218: Change_case_kind kind) const;
1.101 parser 219: String& replace(Pool& pool, Dictionary& dict) const;
1.96 parser 220: double as_double() const;
221: int as_int() const;
1.13 paf 222:
1.41 paf 223: #ifndef NO_STRING_ORIGIN
224: /// origin of string. calculated by first row
1.43 paf 225: const Origin& origin() const;
1.41 paf 226: #endif
1.8 paf 227:
1.129 paf 228: private:
1.10 paf 229:
1.128 paf 230: /** several String fragments
231: */
1.135 ! paf 232: struct Chunk {
1.125 paf 233: typedef uchar count_type;
234: count_type count; ///< the number of rows in chunk
1.135 ! paf 235: // here could be some padding bytes
1.84 paf 236: /// string fragment or a link to next chunk union
1.135 ! paf 237: typedef union Row {
1.125 paf 238: typedef uchar item_size_type;
1.84 paf 239: /// fragment
1.27 paf 240: struct {
1.84 paf 241: const char *ptr; ///< pointer to the start
1.125 paf 242: item_size_type size; ///< length
243: uchar/*Untaint_lang*/ lang; ///< untaint flag, later untaint language
1.27 paf 244: #ifndef NO_STRING_ORIGIN
1.84 paf 245: Origin origin; ///< origin
1.27 paf 246: #endif
1.1 paf 247: } item;
1.135 ! paf 248: // we are using the fact that there's no padding before this field!
1.84 paf 249: Chunk *link; ///< link to the next chunk in chain
1.135 ! paf 250: } rows_type[CR_PREALLOCATED_COUNT];
! 251: rows_type rows;
! 252: };
! 253: /**
! 254: 'mutable' because can write after it's end, after it was appended to somebody
! 255: @see String::append
! 256: */
! 257: mutable struct {
! 258: Chunk chunk;
! 259: Chunk *link_storage;
! 260: } head; ///< the head chunk of the chunk chain
1.1 paf 261:
1.84 paf 262: /// next append would write to this record
1.1 paf 263: Chunk::Row *append_here;
264:
1.5 paf 265: private:
1.110 paf 266: /// last chunk
1.125 paf 267: mutable Chunk *last_chunk;
1.5 paf 268:
269: private:
1.1 paf 270:
271: bool chunk_is_full() {
1.127 paf 272: return append_here == last_chunk->rows+last_chunk->count;
1.1 paf 273: }
1.129 paf 274: uint used_rows() const;
1.1 paf 275: void expand();
1.125 paf 276:
277: Untaint_lang lang_of(size_t offset) const;
1.79 paf 278:
1.116 paf 279: size_t cstr_bufsize(Untaint_lang lang,
280: SQL_Connection *connection,
1.121 paf 281: Charset *buf_charset) const;
1.79 paf 282: /// convert to C string, store to 'dest' which must be big enough for proper untaint
1.82 paf 283: char *store_to(char *dest, Untaint_lang lang=UL_UNSPECIFIED,
284: SQL_Connection *connection=0,
1.133 paf 285: Charset *store_to_charset=0,
286: const char *store_to_charset_name=0) const;
1.107 parser 287:
288: void join_chain(Pool& pool,
1.130 paf 289: const Chunk*& achunk, const Chunk::Row*& arow, uint& acountdown,
1.119 paf 290: uchar& joined_lang, const char *& joined_ptr, size_t& joined_size) const;
1.7 paf 291:
292: private: //disabled
293:
1.12 paf 294: String& operator = (const String&) { return *this; }
1.7 paf 295:
1.1 paf 296: };
1.114 paf 297: #include "pa_pragma_pack_end.h"
1.119 paf 298:
1.130 paf 299: #define STRING_PREPARED_FOREACH_ROW(self, body) \
300: while(row!=(self).append_here) { \
301: if(countdown==0) { \
302: chunk=row->link; \
303: row=chunk->rows; \
304: countdown=chunk->count; \
305: }; \
306: { body } \
1.131 paf 307: row++; countdown--; \
1.130 paf 308: }
309:
310: #define STRING_PREFIX_FOREACH_ROW(self, body) { \
1.135 ! paf 311: const Chunk *chunk=&(self).head.chunk; \
1.130 paf 312: const Chunk::Row *row=chunk->rows; \
313: uint countdown=chunk->count; \
314: STRING_PREPARED_FOREACH_ROW(self, body) \
1.119 paf 315: }
316:
317: #define STRING_FOREACH_ROW(body) STRING_PREFIX_FOREACH_ROW(*this, body)
318: #define STRING_SRC_FOREACH_ROW(body) STRING_PREFIX_FOREACH_ROW(src, body)
1.1 paf 319:
320: #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