[BACK]Return to pa_string.h CVS log [TXT] [DIR] Up to [parser3project] / parser3 / src / include

Diff for /parser3/src/include/pa_string.h between versions 1.48 and 1.144.2.4

version 1.48, 2001/03/21 14:06:44 version 1.144.2.4, 2003/01/24 08:19:09
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
   
 #ifdef HAVE_CONFIG_H  static const char* IDENT_STRING_H="$Date$";
 #       include "pa_config.h"  
 #endif  
   
 #include <stddef.h>  
   
 #include "pa_pool.h"  #include "pa_pool.h"
 #include "pa_types.h"  #include "pa_types.h"
   #include "pa_array.h"
 #define UNTAINT_TIMES_BIGGER 10  
   
 #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, \                  uchar 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                  uchar 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)
   
 /**   class String;
         Pooled string.  
   typedef object_ptr<String> StringPtr;
   typedef object_ptr<const String> ConstStringPtr;
   
         Internal structure:  class Table;
         @verbatim  class SQL_Connection;
                 String                          Chunk0  class Dictionary;
                 ======                          ========  
                 head--------------->[ptr, size, ...]  struct String_fragment { 
                 append_here-------->[ptr, size, ...]          const char *ptr;  ///< pointer to the start
                                                         .          size_t size;  ///< length
                                                         .          int/*Untaint_lang*/ lang; ///< untaint flag, later untaint language
                                                         [ptr, size, ...]  
                 link_row----------->[link to the next chunk]  #ifndef NO_STRING_ORIGIN
         @endverbatim          /// 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
   };
   
   /** 
           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]          - 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 {  
 public:  
   
         enum {  class String: public Array<String_fragment> {
                 CR_PREALLOCATED_COUNT=5, ///< default preallocated item count          size_t fsize;
                 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 {          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 = 0x80  ///< flag, requiring cstr whitespace optimization
         };          };
   
 public:  public:
   
         String(Pool& apool, const char *src=0, bool tainted=false);          //static String& OnPool(Pool& apool, const char *local_src=0, size_t src_size=0, bool tainted=false);
           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; }
         /// convert to C string          /// convert to C string. if 'lang' known, forcing 'lang' to it
         char *cstr() const;          char *cstr(Untaint_lang lang=UL_AS_IS, 
                   SQL_Connection *connection=0,
                   Charset *cstr_charset=0, const char *cstr_charset_name=0) const {
   
                   char *result=(char *)malloc(cstr_bufsize(lang, connection, cstr_charset));
                   char *eol=store_to(result, lang, connection, cstr_charset, cstr_charset_name);
                   *eol=0;
                   return result;
           }
           char *cstr_debug_origins() const;
           /// puts pieces to buf
           void serialize(size_t prolog_size,  void *& 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          /** 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          /// @return <0 ==0 or >0 depending on comparison result
         int cmp (const String& src) const;          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 { 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 {          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 == (const char* b_ptr) const;          /**
         /**                    @param partial 
                 appends other String.                          returns partial match status. 
                           - -1: strings too different
                 marking all tainted pieces of it with @a lang.                          -  0: full match
                 or marking ALL pieces of it with a @a lang when @a forced to.                          -  1: means @c this starts @c src
                           -  2: means @src starts @this
         */          */
         String& append(const String& src, Untaint_lang lang, bool forced=false);          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; 
           }
   
           String& append(const String& src, uchar lang, bool forced=false);
           String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
           String& operator << (const char *src) { return APPEND_CONST(src); }
   
         /// simple hash code of string. used by Hash          /// simple hash code of string. used by Hash
         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 is_empty()?0:*felements[0].ptr;
 #endif          }
   
 private:  
   
         struct Chunk {          /// extracts [start, finish) piece of string
                 // the number of rows in chunk          StringPtr mid(size_t start, size_t finish) const;
                 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:          /// @return position of substr in string, -1 means "not found" [String version]
         // last chunk          int pos(const String& substr, 
         Chunk *last_chunk;                  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(Array& result, 
                   size_t *pos_after_ref, 
                   const char *delim, size_t delim_size, 
                   Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
           void split(Array& result, 
                   size_t *pos_after_ref, 
                   const String& delim, 
                   Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
   
           typedef void (*Row_action)(Table& table, Array *row, 
                   int prestart, int prefinish, 
                   int poststart, int postfinish,
                   void *info);
           /**
                   @return true if fills table.
                   table format is defined and fixed[can be used by others]: 
                   @verbatim
                           prematch/match/postmatch/1/2/3/...
                   @endverbatim
           */
           bool match(Charset& source_charset,
                   const String *aorigin,          
                   const String& regexp, 
                   const String *options,
                   Table **table,
                   Row_action row_action, void *info,
                   bool *was_global=0) const;
           enum Change_case_kind {
                   CC_UPPER,
                   CC_LOWER
           };
           String& change_case(Charset& source_charset,
                   Change_case_kind kind) const;
           String& replace(Dictionary& dict) const;
           double as_double() const;
           int as_int() const;
   
         // string size          String& join_chains(char** cstr) const;
         size_t fsize;  
   
         // used rows in all chunks  #ifndef NO_STRING_ORIGIN
         int fused_rows;          /// origin of string. calculated by first row
           const String_fragment::Origin& origin() const;
   #endif
   
 private:  private:
   
         bool chunk_is_full() {          Untaint_lang lang_of(size_t offset) const;
                 return append_here == link_row;  
         }  
         void expand();  
         void set_lang(Chunk::Row *row, Untaint_lang lang, bool forced, size_t size);  
   
           size_t cstr_bufsize(Untaint_lang lang,
                   SQL_Connection *connection,
                   Charset *buf_charset) 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,
                   Charset *store_to_charset=0,
                   const char *store_to_charset_name=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; }
Removed from v.1.48  
changed lines
  Added in v.1.144.2.4

E-mail: