--- parser3/src/include/pa_string.h	2001/03/14 08:50:01	1.35
+++ parser3/src/include/pa_string.h	2001/07/07 17:59:02	1.97
@@ -1,132 +1,259 @@
-/*
-	Parser
-	Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
-	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
-
-	$Id: pa_string.h,v 1.35 2001/03/14 08:50:01 paf Exp $
-*/
+/** @file
+	Parser: string class decl.
 
-/*
+	Copyright (c) 2001 ArtLebedev Group (http://www.artlebedev.com)
 
-	String				Chunk0
-	======				========
-	head--------------->[ptr, size, ...]
-	append_here-------->[ptr, size, ...]
-						.
-						.
-						[ptr, size, ...]
-	link_row----------->[link to the next chunk]
+	Author: Alexander Petrosyan <paf@design.ru> (http://design.ru/paf)
 
+	$Id: pa_string.h,v 1.97 2001/07/07 17:59:02 parser Exp $
 */
 
 #ifndef PA_STRING_H
 #define PA_STRING_H
 
-#ifdef HAVE_CONFIG_H
-#	include "pa_config.h"
-#endif
-
-#include <stddef.h>
-
+#include "pa_config_includes.h"
 #include "pa_pool.h"
 #include "pa_types.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
 
 #ifndef NO_STRING_ORIGIN
 #	define STRING_APPEND_PARAMS \
 		const char *src, size_t size,  \
-		bool tainted, \
+		String::Untaint_lang lang, \
 		const char *file, uint line
-#	define APPEND(src, size, file, line) real_append(src, size, false, file, line)
-#	define APPEND_TAINTED(src, size, file, line) real_append(src, size, true, file, 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, \
-		bool tainted
-#	define APPEND(src, size, file, line) real_append(src, size, false)
-#	define APPEND_TAINTED(src, size, file, line) real_append(src, size, true)
+		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
-#define	APPEND_CONST(src) APPEND(src, 0, 0, 0)
-
+/// 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;
+class SQL_Connection;
+
+/** 
+	Pooled string.
+
+	Internal structure:
+	@verbatim
+		String				Chunk0
+		======				========
+		head--------------->[ptr, size, ...]
+		append_here-------->[ptr, size, ...]
+							.
+							.
+							[ptr, size, ...]
+		link_row----------->[link to the next chunk]
+	@endverbatim
+
+	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:
+
 	enum {
-		CR_PREALLOCATED_COUNT=5,
-		CR_GROW_PERCENT=60
+		CR_PREALLOCATED_COUNT=2, ///< default preallocated item count
+		CR_GROW_COUNT=2 ///< each time the String chunk_is_full() string expanded()
 	};
 
+	/// piece is tainted or not. the language to use when detaint 
 	enum Untaint_lang {
-		UNKNOWN=0, // when get by name fails
-		NO, // clean
-		YES,  // tainted, untaint language as assigned later 
+		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]{...}
-		PASS_APPENDED,
-			// leave language built into string being appended
-			// just a flag, that value not stored
-		AS_IS,
-		TABLE,
-		SQL,
-		JS,
-		HTML,
-		HTML_TYPO
+		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_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_HTML,      ///< HTML code (for editing)
+		UL_USER_HTML  ///< HTML code with USER chars
 	};
 
 public:
 
-	String(Pool& apool);
+	String(Pool& apool, const char *src=0, size_t src_size=0, bool tainted=false);
 	String(const String& src);
 	size_t size() const { return fsize; }
-	int used_rows() const { return fused_rows; }
-	char *cstr() 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 *charset=0) const {
+
+		char *result=(char *)malloc(cstr_bufsize(lang));
+		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);
-	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; }
+	/// @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;
-		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; }
+
+	/**
+		 @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;
+	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; 
+	}
+
 
-	bool operator == (const char* b_ptr) const;
-	String& append(const String& src, Untaint_lang lang);
+	/** 
+		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& 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
 	uint hash_code() const;
 
-	const Origin& origin() const { return head.rows[0].item.origin; }
+	/// extracts [start, finish) piece of string
+	String& mid(size_t start, size_t finish) const;
+
+	/// @return position of substr in string, -1 means "not found" [String version]
+	int pos(const String& 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=0, 
+		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=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 start, int finish, 
+		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(const unsigned char *pcre_tables,
+		const String *aorigin,		
+		const String& regexp, 
+		const String *options,
+		Table **table,
+		Row_action row_action, void *info) const;
+	enum Change_case_kind {
+		CC_UPPER,
+		CC_LOWER
+	};
+	String& change_case(Pool& pool, const unsigned char *pcre_tables, 
+		Change_case_kind kind) const;
+	double as_double() const;
+	int as_int() const;
+
+#ifndef NO_STRING_ORIGIN
+	/// origin of string. calculated by first row
+	const Origin& origin() const;
+#endif
 
 private:
 
+	/// several String fragments
 	struct Chunk {
-		// the number of rows in chunk
-		int count;
+		size_t count; ///< the number of rows in chunk
+		/// string fragment or a link to next chunk union
 		union Row {
-			// fragment
+			/// fragment
 			struct { 
-				const char *ptr;  // pointer to the start
-				size_t size;  // length
-				Untaint_lang lang; // untaint flag, later untaint language
+				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
+				Origin origin;  ///< origin
 #endif
 			} item;
-			Chunk *link;  // link to the next chunk in chain
+			Chunk *link;  ///< link to the next chunk in chain
 		} rows[CR_PREALLOCATED_COUNT];
-		// next rows are here
-		Chunk *preallocated_link;
+		Chunk *preallocated_link; ///< next rows are here
 	}
-		head;  // the head chunk of the chunk chain
+		head;  ///< the head chunk of the chunk chain
 
-	// next append would write to this record
+	/// 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
+	/** the address of place where lies address 
+		of the link to the next chunk to allocate
+	*/
 	Chunk::Row *link_row;
 
 private:
@@ -145,7 +272,12 @@ private:
 		return append_here == link_row;
 	}
 	void expand();
-	void set_lang(Chunk::Row *row, Untaint_lang lang, size_t size);
+
+	size_t cstr_bufsize(Untaint_lang lang) 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 char *charset=0) const;
 
 private: //disabled