|
|
| version 1.50, 2001/03/24 19:12:18 | version 1.144.2.28.2.6, 2003/03/20 08:11:13 |
|---|---|
| Line 1 | Line 1 |
| /** @file | /** @file |
| Parser: string class decl. | Parser: string class decl. |
| Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) | Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf) | |
| $Id$ | |
| */ | */ |
| #ifndef PA_STRING_H | #ifndef PA_STRING_H |
| #define PA_STRING_H | #define PA_STRING_H |
| #include "pa_config_includes.h" | static const char* IDENT_STRING_H="$Date$"; |
| #include <stddef.h> | // includes |
| #include "pa_pool.h" | |
| #include "pa_types.h" | #include "pa_types.h" |
| #include "pa_array.h" | |
| /** | extern "C" { // cord's author forgot to do that |
| $MAIN:html-typo table elements must enlarge string not more that that | #include "cord.h" |
| that's a tradeoff - otherwise we'd have to scan string twice: | }; |
| - first for buffer length | |
| - second for replacements themselves | // forwards |
| */ | |
| #define UNTAINT_TIMES_BIGGER 10 | class Charset; |
| class Table; | |
| class SQL_Connection; | |
| class Dictionary; | |
| class Request_charsets; | |
| class String; | |
| typedef Array<const String* > ArrayString; | |
| // helpers | |
| #ifndef NO_STRING_ORIGIN | #ifndef NO_STRING_ORIGIN |
| # define STRING_APPEND_PARAMS \ | # define STRING_APPEND_PARAMS \ |
| const char *src, size_t size, \ | const char* src, size_t size, \ |
| bool tainted, \ | Untaint_lang lang, \ |
| const char *file, uint line | const char* file, uint line |
| /// appends clean piece to String @see String::real_append | /// appends piece to String @see String::real_append |
| # define APPEND(src, size, file, line) real_append(src, size, false, file, line) | # define APPEND(src, size, lang, file, line) \ |
| /// appends tainted piece to String @see String::real_append | real_append(src, size, lang, file, line) |
| # define APPEND_TAINTED(src, size, file, line) real_append(src, size, true, file, line) | |
| #else | #else |
| # define STRING_APPEND_PARAMS \ | # define STRING_APPEND_PARAMS \ |
| const char *src, \ | const char* src, \ |
| size_t size, \ | size_t size, \ |
| bool tainted | Untaint_lang lang |
| /// appends clean piece to String @see String::real_append | /// appends piece to String @see String::real_append |
| # define APPEND(src, size, file, line) real_append(src, size, false) | # define APPEND(src, size, lang, file, line) \ |
| /// appends tainted piece to String @see String::real_append | real_append(src, size, lang) |
| # define APPEND_TAINTED(src, size, file, line) real_append(src, size, true) | |
| #endif | #endif |
| /// appends clean piece to String @see String::real_append | |
| #define APPEND_CLEAN(src, size, file, line) \ | |
| APPEND(src, size, String::UL_CLEAN, file, line) | |
| /// appends piece to String as-is @see String::real_append | |
| #define APPEND_AS_IS(src, size, file, line) \ | |
| APPEND(src, size, String::UL_AS_IS, file, line) | |
| /// appends tainted piece to String @see String::real_append | |
| #define APPEND_TAINTED(src, size, file, line) \ | |
| APPEND(src, size, String::UL_TAINTED, file, line) | |
| /// handy: appends const char* piece to String @see String::real_append | /// handy: appends const char* piece to String @see String::real_append |
| #define APPEND_CONST(src) APPEND(src, 0, 0, 0) | #define APPEND_CONST(src) APPEND_AS_IS(src, 0, 0, 0) |
| /** | /// this is result of pos functions which mean that substr were not found |
| Pooled string. | #define STRING_NOT_FOUND ((size_t)-1) |
| Internal structure: | |
| @verbatim | /** |
| String Chunk0 | String which knows the language of all it's fragments. |
| ====== ======== | |
| head--------------->[ptr, size, ...] | |
| append_here-------->[ptr, size, ...] | |
| . | |
| . | |
| [ptr, size, ...] | |
| link_row----------->[link to the next chunk] | |
| @endverbatim | |
| All pieces remember | All pieces remember |
| - the file and its line they are from [can be turned off by NO_STRING_ORIGIN] | |
| - whether they are tainted or not, | - whether they are tainted or not, |
| and the language which should be used to detaint them | and the language which should be used to detaint them |
| */ | */ |
| class String : public Pooled { | class String: public PA_Object { |
| public: | |
| enum { | public: |
| CR_PREALLOCATED_COUNT=5, ///< default preallocated item count | |
| CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded() | |
| }; | |
| /// piece is tainted or not. the language to use when detaint | /** piece is tainted or not. the language to use when detaint |
| remember to change String_Untaint_lang_name @ untaint.C along | |
| */ | |
| enum Untaint_lang { | enum Untaint_lang { |
| UL_UNKNOWN=0, ///< when get by name fails | UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum |
| UL_NO, ///< clean | // these two must go before others, there are checks for >UL_AS_IS |
| UL_YES, ///< tainted, untaint language as assigned later | UL_CLEAN, ///< clean |
| // untaint languages. assigned by ^untaint[lang]{...} | UL_AS_IS, ///< leave all characters intact |
| UL_PASS_APPENDED, | UL_PASS_APPENDED, |
| /**< | /**< |
| leave language built into string being appended. | leave language built into string being appended. |
| just a flag, that value not stored | just a flag, that value not stored |
| */ | */ |
| UL_AS_IS, ///< leave all characters intact | UL_TAINTED, ///< tainted, untaint language as assigned later |
| UL_FILE_NAME, ///< filename | // untaint languages. assigned by ^untaint[lang]{...} |
| UL_HEADER, ///< text in response header | UL_FILE_SPEC, ///< file specification |
| UL_HTTP_HEADER, ///< text in HTTP response header | |
| UL_MAIL_HEADER, ///< text in mail header | |
| UL_URI, ///< text in uri | UL_URI, ///< text in uri |
| UL_TABLE, ///< ^table:set body | UL_TABLE, ///< ^table:set body |
| UL_SQL, ///< ^table:sql body | UL_SQL, ///< ^table:sql body |
| UL_JS, ///< JavaScript code | UL_JS, ///< JavaScript code |
| UL_XML, ///< ^dom:set xml | |
| UL_HTML, ///< HTML code (for editing) | UL_HTML, ///< HTML code (for editing) |
| UL_HTML_TYPO ///< HTML code with TYPOgraphic replacements (for showing) | UL_OPTIMIZE_BIT = 0x8000 ///< flag, requiring cstr whitespace optimization |
| }; | |
| struct Fragment { | |
| Untaint_lang lang; ///< untaint flag, later untaint language | |
| size_t size; ///< size | |
| Fragment(Untaint_lang alang, size_t asize): lang(alang), size(asize) {} | |
| }; | |
| class ArrayFragment: public Array<Fragment> { | |
| void simple_append(element_type src) { | |
| *static_cast<Array<Fragment> *>(this)+=src; | |
| } | |
| public: | |
| ArrayFragment& operator += (element_type src) { | |
| if(count()) { // not empty? | |
| // try to join with last | |
| Fragment& last=get(count()-1); | |
| if(last.lang==src.lang) { | |
| last.size+=src.size; | |
| return *this; | |
| } | |
| } | |
| simple_append(src); | |
| return *this; | |
| } | |
| ArrayFragment& append(const ArrayFragment& src, size_t substr_start, size_t substr_end); | |
| }; | }; |
| private: | |
| CORD body; ///< all characters of string | |
| ArrayFragment fragments; ///< fragment language+size info | |
| public: | public: |
| String(Pool& apool, const char *src=0, bool tainted=false); | explicit String(const char* src=0, size_t src_size=0, bool tainted=false); |
| String(const String& src); | String(const String& src); |
| size_t size() const { return fsize; } | operator bool() const { return body!=CORD_EMPTY; } |
| /// convert to C string | size_t size() const { return CORD_len(body); } |
| char *cstr() const { | |
| char *result=(char *)malloc(size()*UNTAINT_TIMES_BIGGER+1); | struct C { |
| char *eol=store_to(result); | char *str; |
| size_t size; | |
| operator char *() { return str; } | |
| C(char *astr, size_t asize): str(astr), size(asize) {} | |
| }; | |
| /// convert to C string. if 'lang' known, forcing 'lang' to it | |
| C cstr(Untaint_lang lang=UL_AS_IS, | |
| SQL_Connection *connection=0, | |
| const Request_charsets *charsets=0) const { | |
| char* cstr=new(PointerFreeGC) char[cstr_bufsize(lang, connection, charsets)]; | |
| char* eol=store_to(cstr, lang, connection, charsets); | |
| *eol=0; | *eol=0; |
| return result; | return C(cstr, eol-cstr); |
| } | } |
| /// puts pieces to buf | |
| C serialize(size_t prolog_size) const; | |
| /// appends pieces from buf to self | |
| bool deserialize(size_t prolog_size, void *buf, size_t buf_size, const char* file); | |
| /** append fragment | /** append fragment |
| @see APPEND, APPEND_TAINTED, APPEND_CONST | @see APPEND_AS_IS, APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST |
| */ | */ |
| String& real_append(STRING_APPEND_PARAMS); | String& real_append(STRING_APPEND_PARAMS); |
| /// @return <0 ==0 or >0 depending on comparison result | |
| int cmp (const String& src) const; | |
| bool operator < (const String& src) const { return cmp(src)<0; } | |
| bool operator > (const String& src) const { return cmp(src)>0; } | |
| bool operator <= (const String& src) const { return cmp(src)<=0; } | |
| bool operator >= (const String& src) const { return cmp(src)>=0; } | |
| bool operator == (const String& src) const { | |
| if(size()!=src.size()) // can speed up in trivial case | |
| return false; | |
| return cmp(src)==0; | |
| } | |
| bool operator != (const String& src) const { return cmp(src)!=0; } | |
| /** | /** |
| @param partial | @param partial |
| returns partial match status. | returns partial match status. |
| -1 means @c this starts @c src | - -1: strings too different |
| +2 means @src starts @this | - 0: full match |
| - 1: means @c this starts @c src | |
| - 2: means @src starts @this | |
| */ | */ |
| int cmp(const char* src_ptr, int& partial, size_t src_size=0) const; | //int cmp(CORD substr, size_t this_offset=0) const; |
| bool operator == (const char* src_ptr) const { | /// String version of @see cmp(CORD, size_t) |
| size_t src_size=src_ptr?strlen(src_ptr):0; | //int cmp(const String& src, size_t this_offset=0) const; |
| if(size() != src_size) | |
| return false; | bool operator < (const String& src) const { return CORD_cmp(body, src.body)<0; } |
| int partial; // unused | bool operator > (const String& src) const { return CORD_cmp(body, src.body)>0; } |
| return cmp(src_ptr, partial, src_size)==0; | bool operator <= (const String& src) const { return CORD_cmp(body, src.body)<=0; } |
| bool operator >= (const String& src) const { return CORD_cmp(body, src.body)>=0; } | |
| bool operator == (const String& src) const { return CORD_cmp(body, src.body)==0; } | |
| bool operator != (const String& src) const { return CORD_cmp(body, src.body)!=0; } | |
| /// this starts with y | |
| bool starts_with(CORD y) const { | |
| return CORD_ncmp(body, 0/*x_start*/, y, 0/*y_start*/, CORD_len(y))==0; | |
| } | } |
| bool operator == (CORD y) const { return CORD_cmp(body, y)==0; } | |
| bool operator != (CORD y) const { return CORD_cmp(body, y)!=0; } | |
| /** | String& append_to(String& dest, Untaint_lang lang, bool forced) const; |
| appends other String. | String& append(const String& src, Untaint_lang lang, bool forced=false) { |
| return src.append_to(*this, lang, forced); | |
| marking all tainted pieces of it with @a lang. | } |
| or marking ALL pieces of it with a @a lang when @a forced to. | String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); } |
| */ | //String& operator << (const String* src) { return append(*src, UL_PASS_APPENDED); } |
| String& append(const String& src, Untaint_lang lang, bool forced=false); | String& operator << (const char* src) { return APPEND_CONST(src); } |
| /// simple hash code of string. used by Hash | /// simple hash code of string |
| uint hash_code() const; | uint hash_code() const; |
| #ifndef NO_STRING_ORIGIN | /// extracts first char of a string, if any |
| /// origin of string. calculated by first row | char first_char() const { |
| const Origin& origin() const; | return operator bool()?CORD_fetch(body, 0):0; |
| #endif | |
| private: | |
| struct Chunk { | |
| // the number of rows in chunk | |
| int count; | |
| union Row { | |
| // fragment | |
| struct { | |
| const char *ptr; // pointer to the start | |
| size_t size; // length | |
| Untaint_lang lang; // untaint flag, later untaint language | |
| #ifndef NO_STRING_ORIGIN | |
| Origin origin; // origin | |
| #endif | |
| } item; | |
| Chunk *link; // link to the next chunk in chain | |
| } rows[CR_PREALLOCATED_COUNT]; | |
| // next rows are here | |
| Chunk *preallocated_link; | |
| } | |
| head; // the head chunk of the chunk chain | |
| // next append would write to this record | |
| Chunk::Row *append_here; | |
| // the address of place where lies address | |
| // of the link to the next chunk to allocate | |
| Chunk::Row *link_row; | |
| private: | |
| // last chunk | |
| Chunk *last_chunk; | |
| // string size | |
| size_t fsize; | |
| // used rows in all chunks | |
| int fused_rows; | |
| private: | |
| bool chunk_is_full() { | |
| return append_here == link_row; | |
| } | } |
| void expand(); | |
| void set_lang(Chunk::Row *row, Untaint_lang lang, bool forced, size_t size); | |
| char *String::store_to(char *dest) const; | |
| /// extracts [start, finish) piece of string | |
| const String& mid(size_t substr_start, size_t substr_end) const; | |
| /** | |
| ignore lang if it's UL_UNSPECIFIED | |
| but when specified: look for substring that lies in ONE fragment in THAT lang | |
| @return position of substr in string, -1 means "not found" [const char* version] | |
| */ | |
| size_t pos(CORD substr, | |
| size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; | |
| /// String version of @see pos(const char*, int, Untaint_lang) | |
| size_t pos(const String& substr, | |
| size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; | |
| void split(ArrayString& result, | |
| size_t& pos_after_ref, | |
| const char* delim, | |
| Untaint_lang lang=UL_UNSPECIFIED, int limit=-1); | |
| void split(ArrayString& result, | |
| size_t& pos_after_ref, | |
| const String& delim, | |
| Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const; | |
| typedef void (*Row_action)(Table* table, ArrayString* row, | |
| int prestart, int prefinish, | |
| int poststart, int postfinish, | |
| void *info); | |
| /** | |
| @return table of found items, if any. | |
| table format is defined and fixed[can be used by others]: | |
| @verbatim | |
| prematch/match/postmatch/1/2/3/... | |
| @endverbatim | |
| */ | |
| Table* match(Charset& source_charset, | |
| const String& regexp, | |
| const String& options, | |
| Row_action row_action, void *info, | |
| bool& just_matched) const; | |
| enum Change_case_kind { | |
| CC_UPPER, | |
| CC_LOWER | |
| }; | |
| String& change_case(Charset& source_charset, | |
| Change_case_kind kind); | |
| const String& replace(const Dictionary& dict) const; | |
| double as_double() const; | |
| int as_int() const; | |
| size_t cstr_bufsize(Untaint_lang lang=UL_UNSPECIFIED, | |
| SQL_Connection *connection=0, | |
| const Request_charsets *charsets=0) const; | |
| /// convert to C string, store to 'dest' which must be big enough for proper untaint | |
| char *store_to(char *dest, Untaint_lang lang=UL_UNSPECIFIED, | |
| SQL_Connection *connection=0, | |
| const Request_charsets *charsets=0) const; | |
| /* | |
| void join_chain( | |
| const Chunk*& achunk, const Chunk::Row*& arow, uint& acountdown, | |
| Untaint_lang& joined_lang, const char* & joined_ptr, size_t& joined_size) const; | |
| */ | |
| private: //disabled | private: //disabled |
| String& operator = (const String&) { return *this; } | String& operator = (const String&) { return *this; } |
| }; | }; |
| /// simple hash code of string. used by Hash | |
| inline uint hash_code(const String& self) { | |
| return self.hash_code(); | |
| } | |
| // helpers | |
| /* | |
| #define STRING_PREPARED_FOREACH_FRAGMENT(code) \ | |
| for(; fragment<last; fragment++) { \ | |
| code; \ | |
| } | |
| #define STRING_FOREACH_FRAGMENT(code) \ | |
| { \ | |
| element_type *last = felements+fused; \ | |
| element_type *fragment = felements; \ | |
| STRING_PREPARED_FOREACH_FRAGMENT(code) \ | |
| } | |
| */ | |
| #endif | #endif |