parser3/src/include/pa_string.h - diff

Return to pa_string.h CVS log

Up to [parser3project] / parser3 / src / include

Diff for /parser3/src/include/pa_string.h between versions 1.64 and 1.135

version 1.64, 2001/04/03 09:58:09	version 1.135, 2002/04/10 08:53:54
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, 2002 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$	$Id$
*/	*/
Line 11	Line 10
#ifndef PA_STRING_H	#ifndef PA_STRING_H
#define PA_STRING_H	#define PA_STRING_H

#include "pa_config_includes.h"

#include <stddef.h>

#include "pa_pool.h"	#include "pa_pool.h"
#include "pa_types.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	#ifndef NO_STRING_ORIGIN
# define STRING_APPEND_PARAMS \	# define STRING_APPEND_PARAMS \
const char *src, size_t size, \	const char *src, size_t size, \
String::Untaint_lang lang, \	uchar lang, \
const char *file, uint line	const char *file, uint line
/// appends piece to String @see String::real_append	/// appends piece to String @see String::real_append
# define APPEND(src, size, lang, file, line) \	# define APPEND(src, size, lang, file, line) \
Line 40 class Table;	Line 25 class Table;
# define STRING_APPEND_PARAMS \	# define STRING_APPEND_PARAMS \
const char *src, \	const char *src, \
size_t size, \	size_t size, \
String::Untaint_lang lang	uchar lang
/// appends piece to String @see String::real_append	/// appends piece to String @see String::real_append
# define APPEND(src, size, lang, file, line) \	# define APPEND(src, size, lang, file, line) \
real_append(src, size, lang)	real_append(src, size, lang)
#endif	#endif
/// appends clean piece to String @see String::real_append	/// appends clean piece to String @see String::real_append
#define APPEND_CLEAN(src, size, file, line) \	#define APPEND_CLEAN(src, size, file, line) \
APPEND(src, size, String::UL_CLEAN, 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	/// appends tainted piece to String @see String::real_append
#define APPEND_TAINTED(src, size, file, line) \	#define APPEND_TAINTED(src, size, file, line) \
APPEND(src, size, String::UL_TAINTED, 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_CLEAN(src, 0, 0, 0)	#define APPEND_CONST(src) APPEND_AS_IS(src, 0, 0, 0)

	class Table;
class Array;	class Array;
	class SQL_Connection;
	class Dictionary;

/**	/**
Pooled string.	Pooled string.
Line 76 class Array;	Line 67 class Array;
- 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
*/	*/
	#include "pa_pragma_pack_begin.h"
class String : public Pooled {	class String : public Pooled {
public:	public:

enum {	enum {
CR_PREALLOCATED_COUNT=5, ///< default preallocated item count	CR_PREALLOCATED_COUNT=2, ///< default preallocated item count
CR_GROW_PERCENT=60 ///< each time the Array chunk_is_full() array expanded()	CR_GROW_COUNT=1 ///< each time the String chunk_is_full() string expanded()
};	};

/// 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, ///< zero value handy for hash lookup @see untaint_lang_name2enum	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_CLEAN, ///< clean
UL_TAINTED, ///< tainted, untaint language as assigned later	UL_AS_IS, ///< leave all characters intact
// untaint languages. assigned by ^untaint[lang]{...}
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);	String(Pool& apool, const char *src=0, size_t src_size=0, bool tainted=false);
String(const String& src);	String(const String& src);
size_t size() const { return fsize; }	bool is_empty() const { return append_here==head.chunk.rows; }
/// convert to C string	size_t size() const;
char *cstr() const {	/// convert to C string. if 'lang' known, forcing 'lang' to it
char result=(char )malloc(size()*UNTAINT_TIMES_BIGGER+1);	char *cstr(Untaint_lang lang=UL_AS_IS,
char *eol=store_to(result);	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;	*eol=0;
return result;	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_CLEAN, 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 (int& partial, const String& src,	int cmp (int& partial, const String& src,
size_t this_offset=0, Untaint_lang lang=UL_UNKNOWN) const;	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 { int p; return cmp(p, src)<=0; }	bool operator <= (const String& src) const { int p; return cmp(p, src)<=0; }
Line 145 public:	Line 152 public:
- 2: means @src starts @this	- 2: means @src starts @this
*/	*/
int cmp(int& partial, const char* src_ptr, size_t src_size=0,	int cmp(int& partial, const char* src_ptr, size_t src_size=0,
size_t this_offset=0, Untaint_lang lang=UL_UNKNOWN) const;	size_t this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
bool operator == (const char* src_ptr) const {	bool operator == (const char* src_ptr) const {
size_t src_size=src_ptr?strlen(src_ptr):0;	size_t src_size=src_ptr?strlen(src_ptr):0;
if(size() != src_size)	if(size() != src_size)
Line 153 public:	Line 160 public:
int partial; // unused	int partial; // unused
return cmp(partial, src_ptr, src_size)==0;	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);
appends other String.	String& operator << (const String& src) { return append(src, UL_PASS_APPENDED); }
	String& operator << (const char *src) { return APPEND_CONST(src); }
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);

/// simple hash code of string. used by Hash	/// simple hash code of string. used by Hash
uint hash_code() const;	uint hash_code() const;

	/// extracts first char of a string
	char first_char() const;

/// extracts [start, finish) piece of string	/// extracts [start, finish) piece of string
String& piece(size_t start, size_t finish) const;	String& mid(size_t start, size_t finish) const;

/// @return position of substr in string, -1 means "not found" [String version]	/// @return position of substr in string, -1 means "not found" [String version]
int pos(const String& substr,	int pos(const String& substr,
size_t this_offset=0, Untaint_lang lang=UL_UNKNOWN) const;	int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;
/// @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,	int pos(const char *substr, size_t substr_size=0,
size_t this_offset=0, Untaint_lang lang=UL_UNKNOWN) const;	int this_offset=0, Untaint_lang lang=UL_UNSPECIFIED) const;

void split(Array& result,	void split(Array& result,
size_t *pos_after_ref,	size_t *pos_after_ref,
const char *delim, size_t delim_size,	const char *delim, size_t delim_size,
Untaint_lang lang, int limit=-1) const;	Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;
void split(Array& result,	void split(Array& result,
size_t *pos_after_ref,	size_t *pos_after_ref,
const String& delim,	const String& delim,
Untaint_lang lang, int limit=-1) const;	Untaint_lang lang=UL_UNSPECIFIED, int limit=-1) const;

bool match(const String *aorigin,	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 String *aorigin,
const String& regexp,	const String& regexp,
const String& options,	const String *options,
Table **table) const;	Table **table,
	Row_action row_action, void *info,
	bool *was_global=0) const;
	enum Change_case_kind {
	CC_UPPER,
	CC_LOWER
	};
	String& change_case(Pool& pool,
	Change_case_kind kind) const;
	String& replace(Pool& pool, Dictionary& dict) const;
	double as_double() const;
	int as_int() const;

#ifndef NO_STRING_ORIGIN	#ifndef NO_STRING_ORIGIN
/// origin of string. calculated by first row	/// origin of string. calculated by first row
Line 196 public:	Line 227 public:

private:	private:

	/** several String fragments
	*/
struct Chunk {	struct Chunk {
// the number of rows in chunk	typedef uchar count_type;
size_t count;	count_type count; ///< the number of rows in chunk
union Row {	// here could be some padding bytes
// fragment	/// string fragment or a link to next chunk union
	typedef union Row {
	typedef uchar item_size_type;
	/// fragment
struct {	struct {
const char *ptr; // pointer to the start	const char *ptr; ///< pointer to the start
size_t size; // length	item_size_type size; ///< length
Untaint_lang lang; // untaint flag, later untaint language	uchar/Untaint_lang/ lang; ///< untaint flag, later untaint language
#ifndef NO_STRING_ORIGIN	#ifndef NO_STRING_ORIGIN
Origin origin; // origin	Origin origin; ///< origin
#endif	#endif
} item;	} item;
Chunk *link; // link to the next chunk in chain	// we are using the fact that there's no padding before this field!
} rows[CR_PREALLOCATED_COUNT];	Chunk *link; ///< link to the next chunk in chain
// next rows are here	} rows_type[CR_PREALLOCATED_COUNT];
Chunk *preallocated_link;	rows_type rows;
}	};
head; // the head chunk of the chunk chain	/**
	'mutable' because can write after it's end, after it was appended to somebody
	@see String::append
	*/
	mutable struct {
	Chunk chunk;
	Chunk *link_storage;
	} 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;	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:	private:
// last chunk	/// last chunk
Chunk *last_chunk;	mutable Chunk *last_chunk;

// string size
size_t fsize;

// used rows in all chunks
int fused_rows;

private:	private:

bool chunk_is_full() {	bool chunk_is_full() {
return append_here == link_row;	return append_here == last_chunk->rows+last_chunk->count;
}	}
	uint used_rows() const;
void expand();	void expand();
char String::store_to(char dest) const;
	Untaint_lang lang_of(size_t offset) const;

	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(Pool& pool,
	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; }

};	};
	#include "pa_pragma_pack_end.h"

	#define STRING_PREPARED_FOREACH_ROW(self, body) \
	while(row!=(self).append_here) { \
	if(countdown==0) { \
	chunk=row->link; \
	row=chunk->rows; \
	countdown=chunk->count; \
	}; \
	{ body } \
	row++; countdown--; \
	}

	#define STRING_PREFIX_FOREACH_ROW(self, body) { \
	const Chunk *chunk=&(self).head.chunk; \
	const Chunk::Row *row=chunk->rows; \
	uint countdown=chunk->count; \
	STRING_PREPARED_FOREACH_ROW(self, body) \
	}

	#define STRING_FOREACH_ROW(body) STRING_PREFIX_FOREACH_ROW(*this, body)
	#define STRING_SRC_FOREACH_ROW(body) STRING_PREFIX_FOREACH_ROW(src, body)

#endif	#endif

E-mail:

Removed from v.1.64
changed lines
	Added in v.1.135