Annotation of parser3/src/include/pa_string.h, revision 1.78
1.41 paf 1: /** @file
1.43 paf 2: Parser: string class decl.
3:
1.29 paf 4: Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
1.43 paf 5:
1.30 paf 6: Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
1.29 paf 7:
1.78 ! paf 8: $Id: pa_string.h,v 1.77 2001/04/09 09:48:18 paf Exp $
1.1 paf 9: */
10:
11: #ifndef PA_STRING_H
12: #define PA_STRING_H
13:
1.49 paf 14: #include "pa_config_includes.h"
1.9 paf 15:
1.73 paf 16: #include <string.h>
1.1 paf 17: #include <stddef.h>
18:
1.15 paf 19: #include "pa_pool.h"
1.4 paf 20: #include "pa_types.h"
21:
1.63 paf 22: class Table;
23:
1.50 paf 24: /**
25: $MAIN:html-typo table elements must enlarge string not more that that
26: that's a tradeoff - otherwise we'd have to scan string twice:
27: - first for buffer length
28: - second for replacements themselves
29: */
1.31 paf 30: #define UNTAINT_TIMES_BIGGER 10
31:
1.9 paf 32: #ifndef NO_STRING_ORIGIN
1.33 paf 33: # define STRING_APPEND_PARAMS \
34: const char *src, size_t size, \
1.52 paf 35: String::Untaint_lang lang, \
1.33 paf 36: const char *file, uint line
1.54 paf 37: /// appends piece to String @see String::real_append
38: # define APPEND(src, size, lang, file, line) \
39: real_append(src, size, lang, file, line)
1.9 paf 40: #else
1.33 paf 41: # define STRING_APPEND_PARAMS \
42: const char *src, \
43: size_t size, \
1.52 paf 44: String::Untaint_lang lang
1.54 paf 45: /// appends piece to String @see String::real_append
46: # define APPEND(src, size, lang, file, line) \
47: real_append(src, size, lang)
48: #endif
1.48 paf 49: /// appends clean piece to String @see String::real_append
1.54 paf 50: #define APPEND_CLEAN(src, size, file, line) \
1.62 paf 51: APPEND(src, size, String::UL_CLEAN, file, line)
1.48 paf 52: /// appends tainted piece to String @see String::real_append
1.54 paf 53: #define APPEND_TAINTED(src, size, file, line) \
1.62 paf 54: APPEND(src, size, String::UL_TAINTED, file, line)
1.48 paf 55: /// handy: appends const char* piece to String @see String::real_append
1.54 paf 56: #define APPEND_CONST(src) APPEND_CLEAN(src, 0, 0, 0)
1.9 paf 57:
1.62 paf 58: class Array;
1.71 paf 59: class SQL_Connection;
1.62 paf 60:
1.42 paf 61: /**
1.41 paf 62: Pooled string.
63:
1.47 paf 64: Internal structure:
65: @verbatim
66: String Chunk0
67: ====== ========
68: head--------------->[ptr, size, ...]
69: append_here-------->[ptr, size, ...]
70: .
71: .
72: [ptr, size, ...]
73: link_row----------->[link to the next chunk]
1.41 paf 74: @endverbatim
75:
76: All pieces remember
77: - the file and its line they are from [can be turned off by NO_STRING_ORIGIN]
78: - whether they are tainted or not,
79: and the language which should be used to detaint them
80: */
1.15 paf 81: class String : public Pooled {
1.1 paf 82: public:
1.48 paf 83:
1.1 paf 84: enum {
1.41 paf 85: CR_PREALLOCATED_COUNT=5, ///< default preallocated item count
86: CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()
1.1 paf 87: };
88:
1.41 paf 89: /// piece is tainted or not. the language to use when detaint
1.27 paf 90: enum Untaint_lang {
1.72 paf 91: UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
1.62 paf 92: UL_CLEAN, ///< clean
93: UL_TAINTED, ///< tainted, untaint language as assigned later
1.27 paf 94: // untaint languages. assigned by ^untaint[lang]{...}
1.48 paf 95: UL_PASS_APPENDED,
1.41 paf 96: /**<
97: leave language built into string being appended.
98: just a flag, that value not stored
99: */
1.48 paf 100: UL_AS_IS, ///< leave all characters intact
101: UL_FILE_NAME, ///< filename
1.74 paf 102: UL_HTTP_HEADER, ///< text in HTTP response header
103: UL_MAIL_HEADER, ///< text in mail header
1.48 paf 104: UL_URI, ///< text in uri
105: UL_TABLE, ///< ^table:set body
106: UL_SQL, ///< ^table:sql body
107: UL_JS, ///< JavaScript code
108: UL_HTML, ///< HTML code (for editing)
109: UL_HTML_TYPO ///< HTML code with TYPOgraphic replacements (for showing)
1.27 paf 110: };
111:
1.8 paf 112: public:
113:
1.77 paf 114: String(Pool& apool, const char *src=0, size_t src_size=0, bool tainted=false);
1.14 paf 115: String(const String& src);
116: size_t size() const { return fsize; }
1.78 ! paf 117: /// convert to C string, store to 'dest' which must be big enough for proper untaint
! 118: char *store_to(char *dest,
! 119: Untaint_lang lang=UL_UNSPECIFIED, SQL_Connection *connection=0) const;
1.69 paf 120: /// convert to C string. if 'lang' known, forcing 'lang' to it
1.72 paf 121: char *cstr(Untaint_lang lang=UL_UNSPECIFIED, SQL_Connection *connection=0) const {
1.50 paf 122: char *result=(char *)malloc(size()*UNTAINT_TIMES_BIGGER+1);
1.71 paf 123: char *eol=store_to(result, lang, connection);
1.50 paf 124: *eol=0;
125: return result;
126: }
1.46 paf 127: /** append fragment
1.54 paf 128: @see APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST
1.46 paf 129: */
1.9 paf 130: String& real_append(STRING_APPEND_PARAMS);
1.44 paf 131: /// @return <0 ==0 or >0 depending on comparison result
1.62 paf 132: int cmp (int& partial, const String& src,
1.72 paf 133: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.56 paf 134: bool operator < (const String& src) const { int p; return cmp(p, src)<0; }
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; }
1.26 paf 138: bool operator == (const String& src) const {
139: if(size()!=src.size()) // can speed up in trivial case
140: return false;
1.56 paf 141: int p; return cmp(p, src)==0;
1.26 paf 142: }
1.56 paf 143: bool operator != (const String& src) const { int p; return cmp(p, src)!=0; }
1.26 paf 144:
1.50 paf 145: /**
146: @param partial
147: returns partial match status.
1.51 paf 148: - -1: strings too different
149: - 0: full match
150: - 1: means @c this starts @c src
151: - 2: means @src starts @this
1.50 paf 152: */
1.61 paf 153: int cmp(int& partial, const char* src_ptr, size_t src_size=0,
1.72 paf 154: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.50 paf 155: bool operator == (const char* src_ptr) const {
156: size_t src_size=src_ptr?strlen(src_ptr):0;
157: if(size() != src_size)
158: return false;
159: int partial; // unused
1.56 paf 160: return cmp(partial, src_ptr, src_size)==0;
1.50 paf 161: }
162:
1.42 paf 163: /**
164: appends other String.
1.41 paf 165:
1.47 paf 166: marking all tainted pieces of it with @a lang.
167: or marking ALL pieces of it with a @a lang when @a forced to.
1.41 paf 168: */
1.39 paf 169: String& append(const String& src, Untaint_lang lang, bool forced=false);
1.76 paf 170: String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
171: String& operator << (const char *src) { return APPEND_CONST(src); }
1.8 paf 172:
1.41 paf 173: /// simple hash code of string. used by Hash
1.14 paf 174: uint hash_code() const;
1.54 paf 175:
176: /// extracts [start, finish) piece of string
1.70 paf 177: String& mid(size_t start, size_t finish) const;
1.55 paf 178:
1.59 paf 179: /// @return position of substr in string, -1 means "not found" [String version]
1.62 paf 180: int pos(const String& substr,
1.72 paf 181: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.59 paf 182: /// @return position of substr in string, -1 means "not found" [const char* version]
1.62 paf 183: int pos(const char *substr, size_t substr_size,
1.72 paf 184: size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
1.62 paf 185:
186: void split(Array& result,
187: size_t *pos_after_ref,
188: const char *delim, size_t delim_size,
189: Untaint_lang lang, int limit=-1) const;
190: void split(Array& result,
191: size_t *pos_after_ref,
192: const String& delim,
193: Untaint_lang lang, int limit=-1) const;
194:
1.68 paf 195: typedef void (*Row_action)(Table& table, Array *row, int start, int finish,
196: void *info);
1.64 paf 197: bool match(const String *aorigin,
198: const String& regexp,
1.65 paf 199: const String *options,
1.66 paf 200: Table **table,
201: Row_action row_action, void *info) const;
1.13 paf 202:
1.41 paf 203: #ifndef NO_STRING_ORIGIN
204: /// origin of string. calculated by first row
1.43 paf 205: const Origin& origin() const;
1.41 paf 206: #endif
1.8 paf 207:
1.10 paf 208: private:
209:
1.1 paf 210: struct Chunk {
1.6 paf 211: // the number of rows in chunk
1.56 paf 212: size_t count;
1.1 paf 213: union Row {
1.27 paf 214: // fragment
215: struct {
216: const char *ptr; // pointer to the start
217: size_t size; // length
218: Untaint_lang lang; // untaint flag, later untaint language
219: #ifndef NO_STRING_ORIGIN
220: Origin origin; // origin
221: #endif
1.1 paf 222: } item;
223: Chunk *link; // link to the next chunk in chain
1.2 paf 224: } rows[CR_PREALLOCATED_COUNT];
1.1 paf 225: // next rows are here
226: Chunk *preallocated_link;
227: }
228: head; // the head chunk of the chunk chain
229:
230: // next append would write to this record
231: Chunk::Row *append_here;
232:
233: // the address of place where lies address
234: // of the link to the next chunk to allocate
235: Chunk::Row *link_row;
236:
1.5 paf 237: private:
1.25 paf 238: // last chunk
239: Chunk *last_chunk;
1.5 paf 240:
241: // string size
242: size_t fsize;
243:
244: // used rows in all chunks
245: int fused_rows;
246:
247: private:
1.1 paf 248:
249: bool chunk_is_full() {
250: return append_here == link_row;
251: }
252: void expand();
1.7 paf 253:
254: private: //disabled
255:
1.12 paf 256: String& operator = (const String&) { return *this; }
1.7 paf 257:
1.1 paf 258: };
259:
260: #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