--- parser3/src/include/pa_string.h 2001/04/09 14:31:40 1.78 +++ parser3/src/include/pa_string.h 2003/03/20 14:39:08 1.144.2.28.2.12 @@ -1,147 +1,164 @@ /** @file Parser: string class decl. - Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com) - - Author: Alexander Petrosyan (http://design.ru/paf) - - $Id: pa_string.h,v 1.78 2001/04/09 14:31:40 paf Exp $ + Copyright (c) 2001-2003 ArtLebedev Group (http://www.artlebedev.com) + Author: Alexandr Petrosian (http://paf.design.ru) */ #ifndef PA_STRING_H #define PA_STRING_H -#include "pa_config_includes.h" +static const char* IDENT_STRING_H="$Date: 2003/03/20 14:39:08 $"; -#include -#include +// includes -#include "pa_pool.h" #include "pa_types.h" +#include "pa_array.h" -class Table; - -/** - $MAIN:html-typo table elements must enlarge string not more that that - that's a tradeoff - otherwise we'd have to scan string twice: - - first for buffer length - - second for replacements themselves -*/ -#define UNTAINT_TIMES_BIGGER 10 +extern "C" { // cord's author forgot to do that +#include "cord.h" +}; -#ifndef NO_STRING_ORIGIN -# define STRING_APPEND_PARAMS \ - const char *src, size_t size, \ - String::Untaint_lang 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 -# define STRING_APPEND_PARAMS \ - const char *src, \ - size_t size, \ - String::Untaint_lang 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 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_CLEAN(src, 0, 0, 0) +// forwards -class Array; +class Charset; +class Table; class SQL_Connection; +class Dictionary; +class Request_charsets; +class String; +typedef Array ArrayString; + +// helpers +/* +/// appends clean piece to String @see String::append +#define APPEND_CLEAN(src, length) append(src, length, String::UL_CLEAN) +/// appends piece to String as-is @see String::append +#define APPEND_AS_IS(src, length) append(src, length, String::UL_AS_IS) +/// appends tainted piece to String @see String::append +#define APPEND_TAINTED(src, length) append(src, length, String::UL_TAINTED) +/// handy: appends const char* piece to String @see String::append +#define APPEND_CONST(src) APPEND_AS_IS(src, 0) +*/ +/// this is result of pos functions which mean that substr were not found +#define STRING_NOT_FOUND ((size_t)-1) -/** - Pooled string. - Internal structure: - @verbatim - String Chunk0 - ====== ======== - head--------------->[ptr, size, ...] - append_here-------->[ptr, size, ...] - . - . - [ptr, size, ...] - link_row----------->[link to the next chunk] - @endverbatim +/** + 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 { -public: +class String: public PA_Object { - enum { - CR_PREALLOCATED_COUNT=5, ///< default preallocated item count - CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded() - }; +public: - /// 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 { UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum + // these two must go before others, there are checks for >UL_AS_IS UL_CLEAN, ///< clean - UL_TAINTED, ///< tainted, untaint language as assigned later - // untaint languages. assigned by ^untaint[lang]{...} + 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_AS_IS, ///< leave all characters intact - UL_FILE_NAME, ///< filename + UL_TAINTED, ///< tainted, untaint language as assigned later + // untaint languages. assigned by ^untaint[lang]{...} + 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_TABLE, ///< ^table:set body UL_SQL, ///< ^table:sql body UL_JS, ///< JavaScript code + UL_XML, ///< ^dom:set xml 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 length; ///< length + Fragment(Untaint_lang alang, size_t asize): lang(alang), length(asize) {} + }; + + class ArrayFragment: public Array { + void simple_append(element_type src) { + *static_cast *>(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.length+=src.length; + return *this; + } + } + simple_append(src); + return *this; + } + ArrayFragment& append(const ArrayFragment& src, size_t substr_start, size_t substr_end); + }; + + struct C { + char *str; + size_t length; + operator char *() { return str; } + C(char *astr, size_t asize): str(astr), length(asize) {} }; +private: + + CORD body; ///< all characters of string + ArrayFragment fragments; ///< fragment language+length info + public: - String(Pool& apool, const char *src=0, size_t src_size=0, bool tainted=false); + /// @todo check all places for length to be only HELPER length, and never be !=strlen(cstr) + explicit String(const char* cstr=0, size_t helper_length=0, bool tainted=false); String(const String& src); - size_t size() const { return fsize; } - /// 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; - /// convert to C string. if 'lang' known, forcing 'lang' to it - char *cstr(Untaint_lang lang=UL_UNSPECIFIED, SQL_Connection *connection=0) const { - char *result=(char *)malloc(size()*UNTAINT_TIMES_BIGGER+1); - char *eol=store_to(result, lang, connection); - *eol=0; - return result; + operator bool() const { return body!=CORD_EMPTY; } + size_t length() const { return CORD_len(body); } + + /// convert to CORD. if 'lang' known, forcing 'lang' to it + CORD cstr_to_cord(Untaint_lang lang=UL_AS_IS, + SQL_Connection *connection=0, + const Request_charsets *charsets=0) const; + + /// convert to constant C string. if 'lang' known, forcing 'lang' to it + const char* cstr(Untaint_lang lang=UL_AS_IS, + SQL_Connection *connection=0, + const Request_charsets *charsets=0) const { + return CORD_to_const_char_star(cstr_to_cord(lang, connection, charsets)); } - /** append fragment - @see APPEND_CLEAN, APPEND_TAINTED, APPEND_CONST - */ - String& real_append(STRING_APPEND_PARAMS); - /// @return <0 ==0 or >0 depending on comparison result - int cmp (int& partial, const String& src, - size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const; - 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 { int p; return cmp(p, src)>=0; } - bool operator == (const String& src) const { - if(size()!=src.size()) // can speed up in trivial case - return false; - int p; return cmp(p, src)==0; + /// convert to Modifiable C string. if 'lang' known, forcing 'lang' to it + char *cstrm(Untaint_lang lang=UL_AS_IS, + SQL_Connection *connection=0, + const Request_charsets *charsets=0) const { + return CORD_to_char_star(cstr_to_cord(lang, connection, charsets)); } - bool operator != (const String& src) const { int p; return cmp(p, src)!=0; } - + /// 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, + @c heap_variable considered as cstr, that is zeroterminated + */ + String& append_cstr(const char* heap_variable, size_t helper_length, Untaint_lang lang); + /** append fragment, making heap copy of @c auto_variable + @c auto_variable considered MAY BE NOT zeroterminated + if @c length=0 @c auto_variable considered zeroterminated + */ + String& append_copy(const char* auto_variable, size_t helper_length, Untaint_lang lang); /** @param partial returns partial match status. @@ -150,106 +167,91 @@ public: - 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; - 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; + //int cmp(CORD substr, size_t this_offset=0) const; + /// String version of @see cmp(CORD, size_t) + //int cmp(const String& src, size_t this_offset=0) const; + + 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; } + 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; } + /// y starts with this + bool this_starts(CORD y) const { + return CORD_ncmp(body, 0/*x_start*/, y, 0/*y_start*/, CORD_len(body))==0; + } + bool operator == (CORD y) const { return CORD_cmp(body, y)==0; } + bool operator != (CORD y) const { return CORD_cmp(body, y)!=0; } - /** - appends other String. - - marking all tainted pieces of it with @a lang. - or marking ALL pieces of it with a @a lang when @a forced to. - */ - String& append(const String& src, Untaint_lang lang, bool forced=false); + String& append_to(String& dest, Untaint_lang lang, bool forced) const; + String& append(const String& src, Untaint_lang lang, bool forced=false) { + return src.append_to(*this, lang, forced); + } String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); } - String& operator << (const char *src) { return APPEND_CONST(src); } + String& operator << (const char* src) { return append_cstr(src, 0, UL_AS_IS); } - /// simple hash code of string. used by Hash + /// simple hash code of string uint hash_code() const; + /// extracts first char of a string, if any + char first_char() const { + return operator bool()?CORD_fetch(body, 0):0; + } + /// extracts [start, finish) piece of string - String& mid(size_t start, size_t finish) const; + const String& mid(size_t substr_start, size_t substr_end) const; - /// @return position of substr in string, -1 means "not found" [String version] - int pos(const String& substr, + /** + 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; - /// @return position of substr in string, -1 means "not found" [const char* version] - int pos(const char *substr, size_t substr_size, + /// 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(Array& result, - size_t *pos_after_ref, - const char *delim, size_t delim_size, - Untaint_lang lang, int limit=-1) const; - void split(Array& result, - size_t *pos_after_ref, + 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, int limit=-1) const; + Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const; - typedef void (*Row_action)(Table& table, Array *row, int start, int finish, + typedef void (*Row_action)(Table* table, ArrayString* row, + int prestart, int prefinish, + int poststart, int postfinish, void *info); - bool match(const String *aorigin, + /** + @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, - Table **table, - Row_action row_action, void *info) const; - -#ifndef NO_STRING_ORIGIN - /// origin of string. calculated by first row - const Origin& origin() const; -#endif - -private: - - struct Chunk { - // the number of rows in chunk - size_t 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(); + 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; private: //disabled @@ -257,4 +259,9 @@ private: //disabled }; +/// simple hash code of string. used by Hash +inline uint hash_code(const String& self) { + return self.hash_code(); +} + #endif