|
|
| version 1.29, 2001/03/10 16:34:35 | version 1.144.2.22, 2003/02/04 15:59:05 |
|---|---|
| Line 1 | Line 1 |
| /* | /** @file |
| Parser | Parser: string class decl. |
| Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) | |
| Author: Alexander Petrosyan <paf@design.ru> | |
| $Id$ | |
| */ | |
| /* | |
| String Chunk0 | |
| ====== ======== | |
| head--------------->[ptr, size, ...] | |
| append_here-------->[ptr, size, ...] | |
| . | |
| . | |
| [ptr, size, ...] | |
| link_row----------->[link to the next chunk] | |
| Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) | |
| Author: Alexandr Petrosian <paf@design.ru> (http://paf.design.ru) | |
| */ | */ |
| #ifndef PA_STRING_H | #ifndef PA_STRING_H |
| #define PA_STRING_H | #define PA_STRING_H |
| #ifdef HAVE_CONFIG_H | static const char* IDENT_STRING_H="$Date$"; |
| #include "pa_config.h" | |
| #endif | |
| #include <stddef.h> | // includes |
| #include "pa_pool.h" | #include "pa_pool.h" |
| #include "pa_types.h" | #include "pa_types.h" |
| #include "pa_array.h" | |
| // forwards | |
| class Table; DECLARE_OBJECT_PTR(Table); | |
| class SQL_Connection; | |
| class Dictionary; | |
| class Request_charsets; | |
| typedef Array<StringPtr> ArrayString; DECLARE_OBJECT_PTR(ArrayString); | |
| // helpers | |
| #ifndef NO_STRING_ORIGIN | #ifndef NO_STRING_ORIGIN |
| # define STRING_APPEND_PARAMS const char *src, size_t size, bool tainted, char *file, uint line | # define STRING_APPEND_PARAMS \ |
| # define APPEND(src, size, file, line) real_append(src, size, false, file, line) | const char* src, size_t size, \ |
| # define APPEND_TAINTED(src, size, file, line) real_append(src, size, true, file, line) | String_UL lang, \ |
| const char* file, uint line | |
| /// appends piece to String @see String::real_append | |
| # define APPEND(src, size, lang, file, line) \ | |
| real_append(src, size, lang, file, line) | |
| #else | #else |
| # define STRING_APPEND_PARAMS const char *src, size_t size, bool tainted | # define STRING_APPEND_PARAMS \ |
| # define APPEND(src, size, file, line) real_append(src, size, false) | const char* src, \ |
| # define APPEND_TAINTED(src, size, file, line) real_append(src, size, true) | size_t size, \ |
| String_UL lang | |
| /// appends piece to String @see String::real_append | |
| # define APPEND(src, size, lang, file, line) \ | |
| real_append(src, size, lang) | |
| #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 | |
| #define APPEND_CONST(src) APPEND_AS_IS(src, 0, 0, 0) | |
| typedef uint String_UL; | |
| struct String_fragment { | |
| String_UL/*Untaint_lang*/ lang; ///< untaint flag, later untaint language | |
| const char* ptr; ///< pointer to the start | |
| size_t size; ///< length | |
| #ifndef NO_STRING_ORIGIN | |
| /// all String pieces hold information of where they come from | |
| struct Origin { | |
| const char* file; ///< macros file name | load file name | sql query text | |
| uint line; ///< file line no | record no | |
| } origin; ///< origin | |
| #endif | #endif |
| #define APPEND_CONST(src) APPEND(src, 0, 0, 0) | }; |
| /** | |
| String which knows the language of all it's fragments. | |
| 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, | |
| and the language which should be used to detaint them | |
| */ | |
| class String : public Pooled { | class String: public Array<String_fragment> { |
| size_t fsize; | |
| int count() const; // hiding fro accidental use instead of size() | |
| public: | public: |
| enum { | |
| CR_PREALLOCATED_COUNT=5, | |
| CR_GROW_PERCENT=60 | |
| }; | |
| /** 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 { |
| NO, // clean | UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum |
| YES, // tainted, untaint language as assigned later | // these two must go before others, there are checks for >UL_AS_IS |
| UL_CLEAN, ///< clean | |
| UL_AS_IS, ///< leave all characters intact | |
| UL_PASS_APPENDED, | |
| /**< | |
| leave language built into string being appended. | |
| just a flag, that value not stored | |
| */ | |
| UL_TAINTED, ///< tainted, untaint language as assigned later | |
| // untaint languages. assigned by ^untaint[lang]{...} | // untaint languages. assigned by ^untaint[lang]{...} |
| PASS_APPENDED, | UL_FILE_SPEC, ///< file specification |
| // leave language built into string being appended | UL_HTTP_HEADER, ///< text in HTTP response header |
| // just a flag, that value not stored | UL_MAIL_HEADER, ///< text in mail header |
| AS_IS, | UL_URI, ///< text in uri |
| SQL, | UL_TABLE, ///< ^table:set body |
| JS, | UL_SQL, ///< ^table:sql body |
| TABLE, | UL_JS, ///< JavaScript code |
| HTML, | UL_XML, ///< ^dom:set xml |
| HTML_TYPO | UL_HTML, ///< HTML code (for editing) |
| UL_OPTIMIZE_BIT = 0x8000 ///< flag, requiring cstr whitespace optimization | |
| }; | }; |
| public: | public: |
| String(Pool& apool); | explicit String(const char* src=0, size_t src_size=0, bool tainted=false); |
| String(const String& src); | String(const String& src); |
| bool is_empty() const { return !size(); } | |
| size_t size() const { return fsize; } | size_t size() const { return fsize; } |
| int used_rows() const { return fused_rows; } | /// convert to C string. if 'lang' known, forcing 'lang' to it |
| char *cstr() const; | CharPtr cstr(Untaint_lang lang=UL_AS_IS, |
| SQL_Connection *connection=0, | |
| const Request_charsets *charsets=0) const { | |
| CharPtr result(new char[cstr_bufsize(lang, connection, charsets)]); | |
| char *eol=store_to(result.get(), lang, connection, charsets); | |
| *eol=0; | |
| return result; | |
| } | |
| char *cstr(Pool& pool, Untaint_lang lang=UL_AS_IS, | |
| SQL_Connection *connection=0, | |
| const Request_charsets *charsets=0) const { | |
| char *result=new(pool) char[cstr_bufsize(lang, connection, charsets)]; | |
| char *eol=store_to(result, lang, connection, charsets); | |
| *eol=0; | |
| return result; | |
| } | |
| char *cstr_debug_origins(Pool& pool) const; | |
| /// puts pieces to buf | |
| void serialize(Pool& pool, size_t prolog_size, char *& buf, size_t& buf_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 | |
| @see APPEND_AS_IS, APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST | |
| */ | |
| String& real_append(STRING_APPEND_PARAMS); | String& real_append(STRING_APPEND_PARAMS); |
| int cmp (const String& src) const; | /// @return <0 ==0 or >0 depending on comparison result |
| bool operator < (const String& src) const { return cmp(src)<0; } | int cmp (int& partial, const String& src, |
| bool operator > (const String& src) const { return cmp(src)>0; } | size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; |
| bool operator <= (const String& src) const { return cmp(src)<=0; } | bool operator < (const String& src) const { int p; return cmp(p, src)<0; } |
| bool operator >= (const String& src) const { return cmp(src)>=0; } | bool operator > (const String& src) const { int p; return cmp(p, src)>0; } |
| bool operator <= (const String& src) const { int p; return cmp(p, src)<=0; } | |
| bool operator >= (const String& src) const { int p; return cmp(p, src)>=0; } | |
| bool operator == (const String& src) const { | bool operator == (const String& src) const { |
| if(size()!=src.size()) // can speed up in trivial case | if(size()!=src.size()) // can speed up in trivial case |
| return false; | return false; |
| return cmp(src)==0; | int p; return cmp(p, src)==0; |
| } | } |
| bool operator != (const String& src) const { return cmp(src)!=0; } | bool operator != (const String& src) const { int p; return cmp(p, src)!=0; } |
| bool operator == (char* src) const; | |
| String& append(const String& src, Untaint_lang lang); | |
| uint hash_code() const; | /** |
| @param partial | |
| returns partial match status. | |
| - -1: strings too different | |
| - 0: full match | |
| - 1: means @c this starts @c src | |
| - 2: means @src starts @this | |
| */ | |
| int cmp(int& partial, const char* src_ptr, size_t src_size=0, | |
| size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; | |
| /// this starts with src | |
| bool starts_with(const char* src_ptr, size_t src_size=0) const { | |
| int p; cmp(p, src_ptr, src_size); | |
| return p==0 || p==2; | |
| } | |
| bool operator == (const char* src_ptr) const { | |
| size_t src_size=src_ptr?strlen(src_ptr):0; | |
| if(size() != src_size) | |
| return false; | |
| int partial; // unused | |
| return cmp(partial, src_ptr, src_size)==0; | |
| } | |
| bool operator != (const char* src_ptr) const { | |
| int partial; // unused | |
| return cmp(partial, src_ptr, 0)!=0; | |
| } | |
| const Origin& origin() const { return head.rows[0].item.origin; } | String& append_to(String& dest, uchar lang, bool forced) const; |
| String& append(const String& src, uchar lang, bool forced=false) { | |
| return src.append_to(*this, lang, forced); | |
| } | |
| String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); } | |
| String& operator << (StringPtr src) { return append(*src, UL_PASS_APPENDED); } | |
| String& operator << (const char* src) { return APPEND_CONST(src); } | |
| private: | /// simple hash code of string |
| uint hash_code() const; | |
| struct Chunk { | /// extracts first char of a string, if any |
| // the number of rows in chunk | char first_char() const { |
| int count; | return is_empty()?0:*felements[0].ptr; |
| 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 | /// extracts [start, finish) piece of string |
| size_t fsize; | StringPtr mid(size_t start, size_t finish) const; |
| // used rows in all chunks | /// @return position of substr in string, -1 means "not found" [String version] |
| int fused_rows; | int pos(const String& substr, |
| int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; | |
| /// @return position of substr in string, -1 means "not found" [const char* version] | |
| int pos(const char* substr, size_t substr_size=0, | |
| int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; | |
| void split(ArrayString& result, | |
| size_t *pos_after_ref, | |
| const char* delim, size_t delim_size, | |
| 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); | |
| 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 | |
| */ | |
| TablePtr match(Charset& source_charset, | |
| StringPtr aorigin, | |
| const String& regexp, | |
| StringPtr options, | |
| Row_action row_action, void *info, | |
| bool *was_global=0) const; | |
| enum Change_case_kind { | |
| CC_UPPER, | |
| CC_LOWER | |
| }; | |
| StringPtr change_case(Pool& pool, Charset& source_charset, | |
| Change_case_kind kind); | |
| StringPtr replace(Pool& pool, Dictionary& dict) const; | |
| double as_double(); | |
| int as_int(); | |
| private: | StringPtr join_chains(Pool& pool) const; |
| bool chunk_is_full() { | #ifndef NO_STRING_ORIGIN |
| return append_here == link_row; | /// origin of string. calculated by first row |
| } | const String_fragment::Origin& origin() const; |
| void expand(); | #endif |
| void set_lang(Chunk::Row *row, Untaint_lang lang, size_t size); | |
| 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, | |
| uchar& 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(); | |
| } | |
| /// simple hash code of string. used by Hash | |
| inline uint hash_code(StringPtr 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 |