Diff for /parser3/src/include/pa_string.h between versions 1.92 and 1.144.2.28.2.28

version 1.92, 2001/05/16 16:48:56 version 1.144.2.28.2.28, 2003/03/24 14:53:56
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 <string.h>  // includes
 #include <stddef.h>  
   
 #include "pa_pool.h"  
 #include "pa_types.h"  #include "pa_types.h"
   #include "pa_array.h"
   
 class Table;  extern "C" { // cord's author forgot to do that
   #include "cord.h"
   };
   
 /**  // forwards
         $MAIN:html-typo table elements must enlarge string not more that that.  
   
         that's a tradeoff - otherwise we'd have to scan string twice:  class Charset;
         - first for buffer length  class Table;
         - second for replacements themselves  class SQL_Connection;
   class Dictionary;
   class Request_charsets;
   class String;
   typedef Array<const String*> ArrayString;
   
   // helpers
   /*
   /// appends clean piece to String @see String::append
   #define APPEND_CLEAN(src, length) append(src, length, String::L_CLEAN)
   /// appends piece to String as-is @see String::append
   #define APPEND_AS_IS(src, length) append(src, length, String::L_AS_IS)
   /// appends tainted piece to String  @see String::append
   #define APPEND_TAINTED(src, length) append(src, length, String::L_TAINTED)
   /// handy: appends const char* piece to String  @see String::append
   #define APPEND_CONST(src) APPEND_AS_IS(src, 0)
 */  */
 #define UNTAINT_TIMES_BIGGER 10  /// this is result of pos functions which mean that substr were not found
   #define STRING_NOT_FOUND ((size_t)-1)
   
 #ifndef NO_STRING_ORIGIN  class StringBody {
 #       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 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)  
   
 class Array;          CORD body;
 class SQL_Connection;  
   
 /**   public:
         Pooled string.  
           StringBody(): body(CORD_EMPTY) {}
           StringBody(CORD abody): body(abody) {}
           explicit StringBody(const char* str, size_t length): body(CORD_EMPTY) {
                   append(str, length);
           }
   
           void clear() { body=CORD_EMPTY; }
   
           bool operator! () const { return is_empty(); }
   
           uint hash_code() const;
   
           const char* cstr() const { return CORD_to_const_char_star(body); }
           char* cstrm() const { return CORD_to_char_star(body); }
   
           size_t length() const { return CORD_len(body); }
   
           bool is_empty() const { return body==CORD_EMPTY; }
   
           void append(const char *str, size_t length) {
                   body=CORD_cat_char_star(body, str, length);
           }
           void append(char c) { body=CORD_cat_char(body, c); }
           void append(StringBody src) { body=CORD_cat(body, src.body); }
   
         Internal structure:          // could not figure out why this operator is needed [should do this chain: string->simple->==]
         @verbatim          bool operator < (const StringBody src) const { return CORD_cmp(body, src.body)<0; }
                 String                          Chunk0          bool operator > (const StringBody src) const { return CORD_cmp(body, src.body)>0; }
                 ======                          ========          bool operator <= (const StringBody src) const { return CORD_cmp(body, src.body)<=0; }
                 head--------------->[ptr, size, ...]          bool operator >= (const StringBody src) const { return CORD_cmp(body, src.body)>=0; }
                 append_here-------->[ptr, size, ...]          bool operator != (const StringBody src) const { return CORD_cmp(body, src.body)!=0; }
                                                         .          bool operator == (const StringBody src) const { return CORD_cmp(body, src.body)==0; }
                                                         .  
                                                         [ptr, size, ...]          int ncmp(size_t x_begin, const StringBody y, size_t y_begin, size_t size) const {
                 link_row----------->[link to the next chunk]                  return CORD_ncmp(body, x_begin, y.body, y_begin, size);
         @endverbatim          }
   
           char fetch(size_t index) const { return CORD_fetch(body, index); }
           StringBody mid(size_t index, size_t length) const { return CORD_substr(body, index, length); }
           size_t pos(const char* substr, size_t offset=0) const { return CORD_str(body, offset, substr); }
           size_t pos(const StringBody substr, size_t offset=0) const { return CORD_str(body, offset, substr.body); }
   
           template<typename I> void for_each(int (*callback)(const char* s, I), I info) const {
                   CORD_iter5(body, 0, 0, (CORD_batched_iter_fn)callback, info);
           }
   
           void set_pos(CORD_pos& pos, size_t index) const { CORD_set_pos(pos, body, index); }
   
   };
   
   /** 
           String which knows the language of all it's fragments.
   
         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 {
   
   //      friend class StringBody;
   
 public:  public:
   
         enum {          /** piece is tainted or not. the language to use when detaint
                 CR_PREALLOCATED_COUNT=2, ///< default preallocated item count                  remember to change String_Untaint_lang_name @ untaint.C along
                 CR_GROW_COUNT=2 ///< each time the String chunk_is_full() string expanded()          */
         };          enum Language {
                   L_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum
                   // these two must go before others, there are checks for >L_AS_IS
                   L_CLEAN, ///< clean
                   L_AS_IS,     ///< leave all characters intact
   
         /// piece is tainted or not. the language to use when detaint                   L_PASS_APPENDED,
         enum Untaint_lang {  
                 UL_UNSPECIFIED=0, ///< zero value handy for hash lookup @see untaint_lang_name2enum  
                 UL_CLEAN, ///< clean  
                 UL_TAINTED,  ///< tainted, untaint language as assigned later   
                 // untaint languages. assigned by ^untaint[lang]{...}  
                 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                  L_TAINTED,  ///< tainted, untaint language as assigned later 
                 UL_FILE_NAME, ///< filename                  // untaint languages. assigned by ^untaint[lang]{...}
                 UL_HTTP_HEADER,    ///< text in HTTP response header                  L_FILE_SPEC, ///< file specification
                 UL_MAIL_HEADER,    ///< text in mail header                  L_HTTP_HEADER,    ///< text in HTTP response header
                 UL_URI,       ///< text in uri                  L_MAIL_HEADER,    ///< text in mail header
                 UL_TABLE,     ///< ^table:set body                  L_URI,       ///< text in uri
                 UL_SQL,       ///< ^table:sql body                  L_TABLE,     ///< ^table:set body
                 UL_JS,        ///< JavaScript code                  L_SQL,       ///< ^table:sql body
                 UL_HTML,      ///< HTML code (for editing)                  L_JS,        ///< JavaScript code
                 UL_USER_HTML  ///< HTML code with USER chars                  L_XML,          ///< ^dom:set xml
                   L_HTML,      ///< HTML code (for editing)
                   L_OPTIMIZE_BIT = 0x8000  ///< flag, requiring cstr whitespace optimization
           };
   
           struct Fragment { 
                   Language lang; ///< untaint flag, later untaint language
                   size_t length;  ///< length
                   Fragment(Language alang, size_t asize): lang(alang), length(asize) {}
           };
   
           class ArrayFragment: public Array<Fragment> {
                   void append(element_type src) {
                           *static_cast<Array<Fragment> *>(this)+=src;
                   }
                   /// hiding from accidental USE, use append_positions
                   void append(const ArrayFragment& src, int offset, int limit) { 
                           static_cast<Array<Fragment> *>(this)->append(src, offset, limit);
                   }
           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;
                                   }
                           }
                           append(src);
                           return *this;
                   }
                   void append(const ArrayFragment& src) { append(src, 0, 0); }
                   void append_positions(const ArrayFragment& src, size_t substr_begin, 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:
   
           StringBody body; ///< all characters of string
           ArrayFragment fragments; ///< fragment language+length info
   
 public:  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);          String(const String& src);
         size_t size() const { return fsize; }          String(StringBody abody, Language alang): body(abody) {
         /// convert to C string. if 'lang' known, forcing 'lang' to it                  fragments+=Fragment(alang, abody.length());
         char *cstr(Untaint_lang lang=UL_UNSPECIFIED,   
                 SQL_Connection *connection=0,  
                 const char *charset=0) const {  
   
                 char *result=(char *)malloc(size()*UNTAINT_TIMES_BIGGER+1);  
                 char *eol=store_to(result, lang, connection, charset);  
                 *eol=0;  
                 return result;  
         }          }
         /** append fragment  
                 @see APPEND_AS_IS, 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;  
         }  
         bool operator != (const String& src) const { int p; return cmp(p, src)!=0; }  
   
         /**          /// for convinient hash lookup
                  @param partial           operator const StringBody() const { return body; }
                         returns partial match status.   
                         - -1: strings too different          bool is_empty() const { return body.is_empty(); }
                         -  0: full match          size_t length() const { return body.length(); }
                         -  1: means @c this starts @c src  
                         -  2: means @src starts @this          /// convert to CORD. if 'lang' known, forcing 'lang' to it
         */          StringBody cstr_to_string_body(Language lang=L_AS_IS, 
         int cmp(int& partial, const char* src_ptr, size_t src_size=0,                   SQL_Connection* connection=0,
                 size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;                  const Request_charsets *charsets=0) const;
         bool operator == (const char* src_ptr) const {   
                 size_t src_size=src_ptr?strlen(src_ptr):0;          /// convert to constant C string. if 'lang' known, forcing 'lang' to it
                 if(size() != src_size)          const char* cstr(Language lang=L_AS_IS, 
                         return false;                  SQL_Connection* connection=0,
                 int partial; // unused                  const Request_charsets *charsets=0) const {
                 return cmp(partial, src_ptr, src_size)==0;                   return cstr_to_string_body(lang, connection, charsets).cstr();
         }  
         bool operator != (const char* src_ptr) const {   
                 int partial; // unused  
                 return cmp(partial, src_ptr, 0)!=0;   
         }          }
           /// convert to Modifiable C string. if 'lang' known, forcing 'lang' to it
           char *cstrm(Language lang=L_AS_IS, 
                   SQL_Connection* connection=0,
                   const Request_charsets *charsets=0) const {
                   return cstr_to_string_body(lang, connection, charsets).cstrm();
           }
           /// 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);
           /** append fragment, 
                   @c length can be zero, it will be autocalced
                   when length<strlen(str) makes heap copy of @c str piece
           */
           String& append(const char* str, size_t length, Language lang);
   
           bool operator == (const char* y) const { return body==StringBody(y); }
           bool operator != (const char* y) const { return body!=StringBody(y); }
   
         /**           /// this starts with y
                 appends other String.          bool starts_with(const char* y) const {
                   return body.ncmp(0/*x_begin*/, StringBody(y), 0/*y_begin*/, strlen(y))==0;
           }
           /// y starts with this
           bool this_starts(const char* y) const {
                   return body.ncmp(0/*x_begin*/, StringBody(y), 0/*y_begin*/, strlen(y))==0;
           }
   
                 marking all tainted pieces of it with @a lang.          String& append_to(String& dest, Language lang, bool forced) const;
                 or marking ALL pieces of it with a @a lang when @a forced to.          String& append(const String& src, Language lang, bool forced=false) { 
         */                  return src.append_to(*this, lang, forced);
         String& append(const String& src, Untaint_lang lang, bool forced=false);          }
         String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }          String& operator << (const String& src) { return append(src, L_PASS_APPENDED); }
         String& operator << (const char *src) { return APPEND_CONST(src); }          String& operator << (const char* src) { return append(src, 0, L_AS_IS); }
           String& operator << (const StringBody src) { 
                   body.append(src);
                   fragments+=Fragment(L_AS_IS, src.length());
                   return *this;
           }
   
         /// simple hash code of string. used by Hash          /// extracts first char of a string, if any
         uint hash_code() const;          char first_char() const {
                   return is_empty()?0:body.fetch(0);
           }
   
           bool operator < (const String& src) const { return body<src.body; }
           bool operator > (const String& src) const { return body>src.body; }
           bool operator <= (const String& src) const { return body<=src.body; }
           bool operator >= (const String& src) const { return body>=src.body; }
           bool operator != (const String& src) const { return body!=src.body; }
           bool operator == (const String& src) const { return body==src.body; }
   
         /// extracts [start, finish) piece of string          /// extracts [start, finish) piece of string
         String& mid(size_t start, size_t finish) const;          String& mid(size_t substr_begin, 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 L_UNSPECIFIED
                 size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;                  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]                  @return position of substr in string, -1 means "not found" [const char* version]
         int pos(const char *substr, size_t substr_size,           */
                 size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;          size_t pos(const StringBody substr, 
                   size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
         void split(Array& result,           /// String version of @see pos(const char*, int, Language)
                 size_t *pos_after_ref,           size_t pos(const String& substr, 
                 const char *delim, size_t delim_size,                   size_t this_offset=0, Language lang=L_UNSPECIFIED) const;
                 Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;  
         void split(Array& result,           void split(ArrayString& result, 
                 size_t *pos_after_ref,                   size_t& pos_after,
                   const char* delim, 
                   Language lang=L_UNSPECIFIED, int limit=-1) const;
           void split(ArrayString& result, 
                   size_t& pos_after, 
                 const String& delim,                   const String& delim, 
                 Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;                  Language lang=L_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);                  void *info);
         /**          /**
                 @return true if fills table.                  @return table of found items, if any.
                 table format is defined and fixed[can be used by others]:                   table format is defined and fixed[can be used by others]: 
                 @verbatim                  @verbatim
                         prematch/match/postmatch/1/2/3/...                          prematch/match/postmatch/1/2/3/...
                 @endverbatim                  @endverbatim
         */          */
         bool match(const unsigned char *pcre_tables,          Table* match(Charset& source_charset,
                 const String *aorigin,            
                 const String& regexp,                   const String& regexp, 
                 const String *options,                  const String* options,
                 Table **table,                  Row_action row_action, void *info,
                 Row_action row_action, void *info) const;                  bool& just_matched) const;
         enum Change_case_kind {          enum Change_case_kind {
                 CC_UPPER,                  CC_UPPER,
                 CC_LOWER                  CC_LOWER
         };          };
         String& change_case(Pool& pool, const unsigned char *pcre_tables,           String& change_case(Charset& source_charset,
                 Change_case_kind kind) const;                  Change_case_kind kind) const;
           const String& replace(const Dictionary& dict) const;
 #ifndef NO_STRING_ORIGIN          double as_double() const;
         /// origin of string. calculated by first row          int as_int() const;
         const Origin& origin() const;  
 #endif  
   
 private:  
   
         /// several String fragments  
         struct Chunk {  
                 size_t count; ///< the number of rows in chunk  
                 /// string fragment or a link to next chunk union  
                 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];  
                 Chunk *preallocated_link; ///< next rows are here  
         }  
                 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();  
   
         /// 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 char *charset=0) const;  
   
 private: //disabled  private: //disabled
   
Line 286  private: //disabled Line 316  private: //disabled
   
 };  };
   
   /// simple hash code of string. used by Hash
   inline uint hash_code(const StringBody self) {
           return self.hash_code();
   }
   
 #endif  #endif

Removed from v.1.92  
changed lines
  Added in v.1.144.2.28.2.28


E-mail: