Annotation of parser3/src/include/pa_string.h, revision 1.144.2.28.2.14
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. 4(paf 11:3): static const char* IDENT_STRING_H="$Date: 2003/03/20 14:45:16 $";
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;
30:): 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
0(paf 35:3): #define APPEND_CLEAN(src, length) append(src, length, String::UL_CLEAN)
(paf 36:): /// appends piece to String as-is @see String::append
0(paf 37:3): #define APPEND_AS_IS(src, length) append(src, length, String::UL_AS_IS)
(paf 38:): /// appends tainted piece to String @see String::append
0(paf 39:3): #define APPEND_TAINTED(src, length) append(src, length, String::UL_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:):
46:):
1.144.2.2 paf 47: /**
48: String which knows the language of all it's fragments.
1.41 paf 49:
50: All pieces remember
51: - whether they are tainted or not,
52: and the language which should be used to detaint them
1.144.2.28.2. 3(paf 53:3):
54:3): GENERAL ASSUMPTION: they append only cstr's to body, not PART of cstr's
55:3):
56:3): HENCE WARNING: DO NOT PASS HELPER_LENGTH TO REDUCE SIZE OF CONSTRUCTURED STRING
57:3): USE append_copy INSTEAD
1.41 paf 58: */
1.144.2.28.2. (paf 59:): class String: public PA_Object {
60:):
1.144.2.2 paf 61: public:
1.1 paf 62:
1.106 parser 63: /** piece is tainted or not. the language to use when detaint
64: remember to change String_Untaint_lang_name @ untaint.C along
65: */
1.27 paf 66: enum Untaint_lang {
1.72 paf 67: UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
1.122 paf 68: // these two must go before others, there are checks for >UL_AS_IS
1.62 paf 69: UL_CLEAN, ///< clean
1.122 paf 70: UL_AS_IS, ///< leave all characters intact
71:
1.48 paf 72: UL_PASS_APPENDED,
1.41 paf 73: /**<
74: leave language built into string being appended.
75: just a flag, that value not stored
76: */
1.122 paf 77: UL_TAINTED, ///< tainted, untaint language as assigned later
78: // untaint languages. assigned by ^untaint[lang]{...}
1.103 parser 79: UL_FILE_SPEC, ///< file specification
1.74 paf 80: UL_HTTP_HEADER, ///< text in HTTP response header
81: UL_MAIL_HEADER, ///< text in mail header
1.48 paf 82: UL_URI, ///< text in uri
83: UL_TABLE, ///< ^table:set body
84: UL_SQL, ///< ^table:sql body
85: UL_JS, ///< JavaScript code
1.102 parser 86: UL_XML, ///< ^dom:set xml
1.48 paf 87: UL_HTML, ///< HTML code (for editing)
1.144.2.7 paf 88: UL_OPTIMIZE_BIT = 0x8000 ///< flag, requiring cstr whitespace optimization
1.27 paf 89: };
90:
1.144.2.28.2. (paf 91:): struct Fragment {
92:): Untaint_lang lang; ///< untaint flag, later untaint language
0(paf 93:3): size_t length; ///< length
94:3): Fragment(Untaint_lang alang, size_t asize): lang(alang), length(asize) {}
(paf 95:): };
96:):
97:): class ArrayFragment: public Array<Fragment> {
98:): void simple_append(element_type src) {
99:): *static_cast<Array<Fragment> *>(this)+=src;
100:): }
101:): public:
102:): ArrayFragment& operator += (element_type src) {
103:): if(count()) { // not empty?
104:): // try to join with last
105:): Fragment& last=get(count()-1);
106:): if(last.lang==src.lang) {
0(paf 107:3): last.length+=src.length;
(paf 108:): return *this;
109:): }
110:): }
111:): simple_append(src);
112:): return *this;
113:): }
4(paf 114:3): ArrayFragment& append(const ArrayFragment& src, size_t substr_begin, size_t substr_end);
(paf 115:): };
116:):
117:): struct C {
118:): char *str;
0(paf 119:3): size_t length;
(paf 120:): operator char *() { return str; }
0(paf 121:3): C(char *astr, size_t asize): str(astr), length(asize) {}
(paf 122:): };
123:):
124:): private:
125:):
126:): CORD body; ///< all characters of string
0(paf 127:3): ArrayFragment fragments; ///< fragment language+length info
(paf 128:):
1.8 paf 129: public:
130:
1.144.2.28.2. 1(paf 131:3): /// @todo check all places for length to be only HELPER length, and never be !=strlen(cstr)
0(paf 132:3): explicit String(const char* cstr=0, size_t helper_length=0, bool tainted=false);
1.14 paf 133: String(const String& src);
1.144.2.28.2. (paf 134:): operator bool() const { return body!=CORD_EMPTY; }
0(paf 135:3): size_t length() const { return CORD_len(body); }
(paf 136:):
2(paf 137:3): /// convert to CORD. if 'lang' known, forcing 'lang' to it
(paf 138:): CORD cstr_to_cord(Untaint_lang lang=UL_AS_IS,
139:): SQL_Connection *connection=0,
140:): const Request_charsets *charsets=0) const;
141:):
2(paf 142:3): /// convert to constant C string. if 'lang' known, forcing 'lang' to it
(paf 143:): const char* cstr(Untaint_lang lang=UL_AS_IS,
1.82 paf 144: SQL_Connection *connection=0,
1.144.2.14 paf 145: const Request_charsets *charsets=0) const {
1.144.2.28.2. (paf 146:): return CORD_to_const_char_star(cstr_to_cord(lang, connection, charsets));
147:): }
2(paf 148:3): /// convert to Modifiable C string. if 'lang' known, forcing 'lang' to it
(paf 149:): char *cstrm(Untaint_lang lang=UL_AS_IS,
150:): SQL_Connection *connection=0,
151:): const Request_charsets *charsets=0) const {
152:): return CORD_to_char_star(cstr_to_cord(lang, connection, charsets));
1.144.2.9 paf 153: }
1.108 parser 154: /// puts pieces to buf
1.144.2.28.2. (paf 155:): C serialize(size_t prolog_size) const;
1.108 parser 156: /// appends pieces from buf to self
1.144.2.18 paf 157: bool deserialize(size_t prolog_size, void *buf, size_t buf_size, const char* file);
1.144.2.28.2. 0(paf 158:3): /** append fragment,
159:3): @c heap_variable considered as cstr, that is zeroterminated
160:3): */
161:3): String& append_cstr(const char* heap_variable, size_t helper_length, Untaint_lang lang);
162:3): /** append fragment, making heap copy of @c auto_variable
163:3): @c auto_variable considered MAY BE NOT zeroterminated
164:3): if @c length=0 @c auto_variable considered zeroterminated
1.46 paf 165: */
1.144.2.28.2. 0(paf 166:3): String& append_copy(const char* auto_variable, size_t helper_length, Untaint_lang lang);
(paf 167:):
168:): bool operator < (const String& src) const { return CORD_cmp(body, src.body)<0; }
169:): bool operator > (const String& src) const { return CORD_cmp(body, src.body)>0; }
170:): bool operator <= (const String& src) const { return CORD_cmp(body, src.body)<=0; }
171:): bool operator >= (const String& src) const { return CORD_cmp(body, src.body)>=0; }
172:): bool operator == (const String& src) const { return CORD_cmp(body, src.body)==0; }
173:): bool operator != (const String& src) const { return CORD_cmp(body, src.body)!=0; }
174:):
175:): /// this starts with y
176:): bool starts_with(CORD y) const {
4(paf 177:3): return CORD_ncmp(body, 0/*x_begin*/, y, 0/*y_begin*/, CORD_len(y))==0;
1.80 paf 178: }
1.144.2.28.2. (paf 179:): /// y starts with this
180:): bool this_starts(CORD y) const {
4(paf 181:3): return CORD_ncmp(body, 0/*x_begin*/, y, 0/*y_begin*/, CORD_len(body))==0;
(paf 182:): }
183:): bool operator == (CORD y) const { return CORD_cmp(body, y)==0; }
184:): bool operator != (CORD y) const { return CORD_cmp(body, y)!=0; }
1.80 paf 185:
1.144.2.28.2. (paf 186:): String& append_to(String& dest, Untaint_lang lang, bool forced) const;
187:): String& append(const String& src, Untaint_lang lang, bool forced=false) {
1.144.2.11 paf 188: return src.append_to(*this, lang, forced);
189: }
1.76 paf 190: String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
1.144.2.28.2. 0(paf 191:3): String& operator << (const char* src) { return append_cstr(src, 0, UL_AS_IS); }
1.8 paf 192:
1.144.2.7 paf 193: /// simple hash code of string
1.14 paf 194: uint hash_code() const;
1.100 parser 195:
1.142 paf 196: /// extracts first char of a string, if any
197: char first_char() const {
1.144.2.28.2. (paf 198:): return operator bool()?CORD_fetch(body, 0):0;
1.142 paf 199: }
1.54 paf 200:
201: /// extracts [start, finish) piece of string
1.144.2.28.2. 4(paf 202:3): const String& mid(size_t substr_begin, size_t substr_end) const;
(paf 203:):
204:): /**
205:): ignore lang if it's UL_UNSPECIFIED
206:): but when specified: look for substring that lies in ONE fragment in THAT lang
207:): @return position of substr in string, -1 means "not found" [const char* version]
208:): */
209:): size_t pos(CORD substr,
210:): size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
211:): /// String version of @see pos(const char*, int, Untaint_lang)
212:): size_t pos(const String& substr,
213:): size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.62 paf 214:
1.144.2.22 paf 215: void split(ArrayString& result,
1.144.2.28.2. (paf 216:): size_t& pos_after_ref,
217:): const char* delim,
1.144.2.17 paf 218: Untaint_lang lang=UL_UNSPECIFIED, int limit=-1);
1.144.2.22 paf 219: void split(ArrayString& result,
1.144.2.28.2. (paf 220:): size_t& pos_after_ref,
1.62 paf 221: const String& delim,
1.144.2.28.2. (paf 222:): Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
1.62 paf 223:
1.144.2.28.2. (paf 224:): typedef void (*Row_action)(Table* table, ArrayString* row,
1.136 paf 225: int prestart, int prefinish,
226: int poststart, int postfinish,
1.144.2.9 paf 227: void *info);
1.87 parser 228: /**
1.144.2.5 paf 229: @return table of found items, if any.
1.87 parser 230: table format is defined and fixed[can be used by others]:
231: @verbatim
232: prematch/match/postmatch/1/2/3/...
233: @endverbatim
234: */
1.144.2.28.2. (paf 235:): Table* match(Charset& source_charset,
1.64 paf 236: const String& regexp,
1.144.2.28.2. (paf 237:): const String& options,
1.99 parser 238: Row_action row_action, void *info,
1.144.2.27 paf 239: bool& just_matched) const;
1.87 parser 240: enum Change_case_kind {
241: CC_UPPER,
242: CC_LOWER
243: };
1.144.2.28.2. (paf 244:): String& change_case(Charset& source_charset,
1.144.2.17 paf 245: Change_case_kind kind);
1.144.2.28.2. (paf 246:): const String& replace(const Dictionary& dict) const;
247:): double as_double() const;
248:): int as_int() const;
1.137 paf 249:
1.7 paf 250: private: //disabled
251:
1.12 paf 252: String& operator = (const String&) { return *this; }
1.7 paf 253:
1.1 paf 254: };
1.144.2.7 paf 255:
256: /// simple hash code of string. used by Hash
257: inline uint hash_code(const String& self) {
258: return self.hash_code();
259: }
1.1 paf 260:
261: #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