Annotation of parser3/src/include/pa_string.h, revision 1.144.2.12
1.41 paf 1: /** @file
1.43 paf 2: Parser: string class decl.
3:
1.144 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.12! paf 11: static const char* IDENT_STRING_H="$Date: 2003/01/28 13:15:18 $";
1.144.2.10 paf 12:
13: // includes
1.1 paf 14:
1.15 paf 15: #include "pa_pool.h"
1.144.2.12! paf 16: #include "pa_types.h"
! 17: #include "pa_array.h"
1.4 paf 18:
1.144.2.5 paf 19:
1.144.2.12! paf 20: // forwards
1.144.2.10 paf 21:
1.144.2.12! paf 22: class String; DECLARE_OBJECT_PTR(String);
! 23: typedef object_ptr<const String> ConstStringPtr; const ConstStringPtr ConstStringPtrZero(0);
1.144.2.10 paf 24:
25: // forwards
26:
1.144.2.9 paf 27: class Table;
28: typedef object_ptr<Table> TablePtr;
1.144.2.5 paf 29: class SQL_Connection;
30: class Dictionary;
1.144.2.12! paf 31: struct Request_charset_info;
1.144.2.5 paf 32:
33: // helpers
34:
1.9 paf 35: #ifndef NO_STRING_ORIGIN
1.33 paf 36: # define STRING_APPEND_PARAMS \
37: const char *src, size_t size, \
1.144.2.7 paf 38: String_UL lang, \
1.33 paf 39: const char *file, uint line
1.54 paf 40: /// appends piece to String @see String::real_append
41: # define APPEND(src, size, lang, file, line) \
42: real_append(src, size, lang, file, line)
1.9 paf 43: #else
1.33 paf 44: # define STRING_APPEND_PARAMS \
45: const char *src, \
46: size_t size, \
1.144.2.7 paf 47: String_UL lang
1.54 paf 48: /// appends piece to String @see String::real_append
49: # define APPEND(src, size, lang, file, line) \
50: real_append(src, size, lang)
51: #endif
1.83 paf 52: /// appends clean piece to String @see String::real_append
1.54 paf 53: #define APPEND_CLEAN(src, size, file, line) \
1.62 paf 54: APPEND(src, size, String::UL_CLEAN, file, line)
1.83 paf 55: /// appends piece to String as-is @see String::real_append
56: #define APPEND_AS_IS(src, size, file, line) \
57: APPEND(src, size, String::UL_AS_IS, file, line)
1.48 paf 58: /// appends tainted piece to String @see String::real_append
1.54 paf 59: #define APPEND_TAINTED(src, size, file, line) \
1.62 paf 60: APPEND(src, size, String::UL_TAINTED, file, line)
1.48 paf 61: /// handy: appends const char* piece to String @see String::real_append
1.83 paf 62: #define APPEND_CONST(src) APPEND_AS_IS(src, 0, 0, 0)
1.9 paf 63:
1.144.2.7 paf 64: typedef uint String_UL;
65:
1.144.2.2 paf 66: struct String_fragment {
1.144.2.7 paf 67: String_UL/*Untaint_lang*/ lang; ///< untaint flag, later untaint language
1.144.2.2 paf 68: const char *ptr; ///< pointer to the start
69: size_t size; ///< length
1.41 paf 70:
1.144.2.2 paf 71: #ifndef NO_STRING_ORIGIN
72: /// all String pieces hold information of where they come from
73: struct Origin {
74: const char *file; ///< macros file name | load file name | sql query text
75: uint line; ///< file line no | record no
76: } origin; ///< origin
77: #endif
78: };
79:
80: /**
81: String which knows the language of all it's fragments.
1.41 paf 82:
83: All pieces remember
84: - the file and its line they are from [can be turned off by NO_STRING_ORIGIN]
85: - whether they are tainted or not,
86: and the language which should be used to detaint them
87: */
1.48 paf 88:
1.144.2.2 paf 89: class String: public Array<String_fragment> {
90: size_t fsize;
1.144.2.5 paf 91: int count() const; // hiding fro accidental use instead of size()
1.144.2.2 paf 92: public:
1.1 paf 93:
1.106 parser 94: /** piece is tainted or not. the language to use when detaint
95: remember to change String_Untaint_lang_name @ untaint.C along
96: */
1.27 paf 97: enum Untaint_lang {
1.72 paf 98: UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
1.122 paf 99: // these two must go before others, there are checks for >UL_AS_IS
1.62 paf 100: UL_CLEAN, ///< clean
1.122 paf 101: UL_AS_IS, ///< leave all characters intact
102:
1.48 paf 103: UL_PASS_APPENDED,
1.41 paf 104: /**<
105: leave language built into string being appended.
106: just a flag, that value not stored
107: */
1.122 paf 108: UL_TAINTED, ///< tainted, untaint language as assigned later
109: // untaint languages. assigned by ^untaint[lang]{...}
1.103 parser 110: UL_FILE_SPEC, ///< file specification
1.74 paf 111: UL_HTTP_HEADER, ///< text in HTTP response header
112: UL_MAIL_HEADER, ///< text in mail header
1.48 paf 113: UL_URI, ///< text in uri
114: UL_TABLE, ///< ^table:set body
115: UL_SQL, ///< ^table:sql body
116: UL_JS, ///< JavaScript code
1.102 parser 117: UL_XML, ///< ^dom:set xml
1.48 paf 118: UL_HTML, ///< HTML code (for editing)
1.144.2.7 paf 119: UL_OPTIMIZE_BIT = 0x8000 ///< flag, requiring cstr whitespace optimization
1.27 paf 120: };
121:
1.8 paf 122: public:
123:
1.144.2.1 paf 124: //static String& OnPool(Pool& apool, const char *local_src=0, size_t src_size=0, bool tainted=false);
1.144.2.6 paf 125: explicit String(const char *src=0, size_t src_size=0, bool tainted=false);
1.14 paf 126: String(const String& src);
1.144.2.2 paf 127: bool is_empty() const { return !size(); }
128: size_t size() const { return fsize; }
1.69 paf 129: /// convert to C string. if 'lang' known, forcing 'lang' to it
1.144.2.5 paf 130: CharPtr cstr(Untaint_lang lang=UL_AS_IS,
1.82 paf 131: SQL_Connection *connection=0,
1.144.2.12! paf 132: const Request_charset_info *charsets=0) const {
1.88 parser 133:
1.144.2.12! paf 134: CharPtr result(new char[cstr_bufsize(lang, connection, charsets)]);
! 135: char *eol=store_to(result.get(), lang, connection, charsets);
1.50 paf 136: *eol=0;
137: return result;
138: }
1.144.2.9 paf 139: char *cstr(Pool& pool, Untaint_lang lang=UL_AS_IS,
140: SQL_Connection *connection=0,
1.144.2.12! paf 141: const Request_charset_info *charsets=0) const {
1.144.2.9 paf 142:
1.144.2.12! paf 143: char *result=new(pool) char[cstr_bufsize(lang, connection, charsets)];
! 144: char *eol=store_to(result, lang, connection, charsets);
1.144.2.9 paf 145: *eol=0;
146: return result;
147: }
1.144.2.12! paf 148: char *cstr_debug_origins(Pool& pool) const;
1.108 parser 149: /// puts pieces to buf
1.144.2.5 paf 150: void serialize(Pool& pool, size_t prolog_size, char *& buf, size_t& buf_size) const;
1.108 parser 151: /// appends pieces from buf to self
1.132 paf 152: bool deserialize(size_t prolog_size, void *buf, size_t buf_size, const char *file);
1.46 paf 153: /** append fragment
1.83 paf 154: @see APPEND_AS_IS, APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST
1.46 paf 155: */
1.9 paf 156: String& real_append(STRING_APPEND_PARAMS);
1.44 paf 157: /// @return <0 ==0 or >0 depending on comparison result
1.62 paf 158: int cmp (int& partial, const String& src,
1.72 paf 159: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.56 paf 160: bool operator < (const String& src) const { int p; return cmp(p, src)<0; }
161: bool operator > (const String& src) const { int p; return cmp(p, src)>0; }
162: bool operator <= (const String& src) const { int p; return cmp(p, src)<=0; }
163: bool operator >= (const String& src) const { int p; return cmp(p, src)>=0; }
1.26 paf 164: bool operator == (const String& src) const {
165: if(size()!=src.size()) // can speed up in trivial case
166: return false;
1.56 paf 167: int p; return cmp(p, src)==0;
1.26 paf 168: }
1.56 paf 169: bool operator != (const String& src) const { int p; return cmp(p, src)!=0; }
1.26 paf 170:
1.50 paf 171: /**
172: @param partial
173: returns partial match status.
1.51 paf 174: - -1: strings too different
175: - 0: full match
176: - 1: means @c this starts @c src
177: - 2: means @src starts @this
1.50 paf 178: */
1.61 paf 179: int cmp(int& partial, const char* src_ptr, size_t src_size=0,
1.72 paf 180: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.139 paf 181: /// this starts with src
182: bool starts_with(const char* src_ptr, size_t src_size=0) const {
183: int p; cmp(p, src_ptr, src_size);
184: return p==0 || p==2;
185: }
1.50 paf 186: bool operator == (const char* src_ptr) const {
187: size_t src_size=src_ptr?strlen(src_ptr):0;
188: if(size() != src_size)
189: return false;
190: int partial; // unused
1.56 paf 191: return cmp(partial, src_ptr, src_size)==0;
1.50 paf 192: }
1.80 paf 193: bool operator != (const char* src_ptr) const {
194: int partial; // unused
195: return cmp(partial, src_ptr, 0)!=0;
196: }
197:
1.144.2.11 paf 198: String& append_to(String& dest, uchar lang, bool forced) const;
199: String& append(const String& src, uchar lang, bool forced=false) {
200: return src.append_to(*this, lang, forced);
201: }
1.76 paf 202: String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
1.144.2.8 paf 203: String& operator << (const StringPtr src) { return append(*src, UL_PASS_APPENDED); }
1.76 paf 204: String& operator << (const char *src) { return APPEND_CONST(src); }
1.8 paf 205:
1.144.2.7 paf 206: /// simple hash code of string
1.14 paf 207: uint hash_code() const;
1.100 parser 208:
1.142 paf 209: /// extracts first char of a string, if any
210: char first_char() const {
1.144.2.2 paf 211: return is_empty()?0:*felements[0].ptr;
1.142 paf 212: }
1.54 paf 213:
214: /// extracts [start, finish) piece of string
1.144.2.4 paf 215: StringPtr mid(size_t start, size_t finish) const;
1.55 paf 216:
1.59 paf 217: /// @return position of substr in string, -1 means "not found" [String version]
1.62 paf 218: int pos(const String& substr,
1.112 paf 219: int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.59 paf 220: /// @return position of substr in string, -1 means "not found" [const char* version]
1.97 parser 221: int pos(const char *substr, size_t substr_size=0,
1.112 paf 222: int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.62 paf 223:
1.144.2.5 paf 224: void split(Array<ConstStringPtr>& result,
1.62 paf 225: size_t *pos_after_ref,
226: const char *delim, size_t delim_size,
1.86 paf 227: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.144.2.5 paf 228: void split(Array<ConstStringPtr>& result,
1.62 paf 229: size_t *pos_after_ref,
230: const String& delim,
1.86 paf 231: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.62 paf 232:
1.144.2.9 paf 233: typedef void (*Row_action)(Table& table, Array<ConstStringPtr> *row,
1.136 paf 234: int prestart, int prefinish,
235: int poststart, int postfinish,
1.144.2.9 paf 236: void *info);
1.87 parser 237: /**
1.144.2.5 paf 238: @return table of found items, if any.
1.87 parser 239: table format is defined and fixed[can be used by others]:
240: @verbatim
241: prematch/match/postmatch/1/2/3/...
242: @endverbatim
243: */
1.144.2.9 paf 244: TablePtr match(Charset& source_charset,
1.144.2.5 paf 245: ConstStringPtr aorigin,
1.64 paf 246: const String& regexp,
1.144.2.5 paf 247: ConstStringPtr options,
1.99 parser 248: Row_action row_action, void *info,
1.144.2.9 paf 249: bool *was_global=0) const;
1.87 parser 250: enum Change_case_kind {
251: CC_UPPER,
252: CC_LOWER
253: };
1.144.2.5 paf 254: StringPtr change_case(Pool& pool, Charset& source_charset,
1.87 parser 255: Change_case_kind kind) const;
1.144.2.5 paf 256: StringPtr replace(Pool& pool, Dictionary& dict) const;
1.96 parser 257: double as_double() const;
258: int as_int() const;
1.137 paf 259:
1.144.2.5 paf 260: StringPtr join_chains(Pool& pool) const;
1.13 paf 261:
1.41 paf 262: #ifndef NO_STRING_ORIGIN
263: /// origin of string. calculated by first row
1.144.2.2 paf 264: const String_fragment::Origin& origin() const;
1.41 paf 265: #endif
1.8 paf 266:
1.144.2.5 paf 267: size_t cstr_bufsize(Untaint_lang lang=UL_UNSPECIFIED,
268: SQL_Connection *connection=0,
1.144.2.12! paf 269: const Request_charset_info *charsets=0) const;
1.79 paf 270: /// convert to C string, store to 'dest' which must be big enough for proper untaint
1.82 paf 271: char *store_to(char *dest, Untaint_lang lang=UL_UNSPECIFIED,
272: SQL_Connection *connection=0,
1.144.2.12! paf 273: const Request_charset_info *charsets=0) const;
1.144.2.2 paf 274: /*
1.144.2.1 paf 275: void join_chain(
1.130 paf 276: const Chunk*& achunk, const Chunk::Row*& arow, uint& acountdown,
1.119 paf 277: uchar& joined_lang, const char *& joined_ptr, size_t& joined_size) const;
1.144.2.2 paf 278: */
1.7 paf 279: private: //disabled
280:
1.12 paf 281: String& operator = (const String&) { return *this; }
1.7 paf 282:
1.1 paf 283: };
1.144.2.7 paf 284:
285: /// simple hash code of string. used by Hash
286: inline uint hash_code(const String& self) {
287: return self.hash_code();
288: }
289: /// simple hash code of string. used by Hash
290: inline uint hash_code(ConstStringPtr self) {
291: return self->hash_code();
292: }
1.144.2.5 paf 293:
294: // helpers
295:
296: #define STRING_PREPARED_FOREACH_FRAGMENT(code) \
297: for(; fragment<last; fragment++) { \
298: code; \
299: }
300:
301: #define STRING_FOREACH_FRAGMENT(code) \
302: { \
303: element_type *last = felements+fused; \
304: element_type *fragment = felements; \
305: STRING_PREPARED_FOREACH_FRAGMENT(code) \
306: }
1.1 paf 307:
308: #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