--- parser3/src/include/pa_string.h 2001/03/19 15:29:38 1.41 +++ parser3/src/include/pa_string.h 2001/03/20 06:45:18 1.47 @@ -1,9 +1,11 @@ /** @file - Parser + 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.41 2001/03/19 15:29:38 paf Exp $ + $Id: pa_string.h,v 1.47 2001/03/20 06:45:18 paf Exp $ */ #ifndef PA_STRING_H @@ -25,37 +27,36 @@ const char *src, size_t size, \ bool tainted, \ const char *file, uint line -/// appends clean piece to String +/// appends clean piece to String @see String::real_append # define APPEND(src, size, file, line) real_append(src, size, false, file, line) -/// appends tainted piece to String +/// appends tainted piece to String @see String::real_append # define APPEND_TAINTED(src, size, file, line) real_append(src, size, true, file, line) #else # define STRING_APPEND_PARAMS \ const char *src, \ size_t size, \ bool tainted -/// appends clean piece to String +/// appends clean piece to String @see String::real_append # define APPEND(src, size, file, line) real_append(src, size, false) -/// appends tainted piece to String +/// appends tainted piece to String @see String::real_append # define APPEND_TAINTED(src, size, file, line) real_append(src, size, true) #endif -/// handy: appends const char* piece to String +/// handy: appends const char* piece to String @see String::real_append #define APPEND_CONST(src) APPEND(src, 0, 0, 0) -/** @brief +/** Pooled string. - Internal structure: @verbatim - - String Chunk0 - ====== ======== - head--------------->[ptr, size, ...] - append_here-------->[ptr, size, ...] - . - . - [ptr, size, ...] - link_row----------->[link to the next chunk] - + 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 @@ -81,14 +82,15 @@ public: leave language built into string being appended. just a flag, that value not stored */ - AS_IS, ///< leave all characters intact - HEADER, ///< text in response header - URI, ///< text in uri - TABLE, ///< ^table:set body - SQL, ///< ^table:sql body - JS, ///< JavaScript code - HTML, ///< HTML code (for editing) - HTML_TYPO ///< HTML code with TYPOgraphic replacements (for showing) + AS_IS, ///< leave all characters intact + FILE_NAME, ///< filename + HEADER, ///< text in response header + URI, ///< text in uri + TABLE, ///< ^table:set body + SQL, ///< ^table:sql body + JS, ///< JavaScript code + HTML, ///< HTML code (for editing) + HTML_TYPO ///< HTML code with TYPOgraphic replacements (for showing) }; public: @@ -98,8 +100,11 @@ public: size_t size() const { return fsize; } /// convert to C string char *cstr() const; + /** append fragment + @see APPEND, APPEND_TAINTED, APPEND_CONST + */ 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; bool operator < (const String& src) const { return cmp(src)<0; } bool operator > (const String& src) const { return cmp(src)>0; } @@ -113,11 +118,11 @@ public: bool operator != (const String& src) const { return cmp(src)!=0; } bool operator == (const char* b_ptr) const; - /** @brief - appends other String + /** + 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. + 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); @@ -126,14 +131,7 @@ public: #ifndef NO_STRING_ORIGIN /// origin of string. calculated by first row - const Origin& origin() const { - if(!fused_rows) - THROW(0, 0, - 0, - "String::origin() of empty string called"); - - return head.rows[0].item.origin; - } + const Origin& origin() const; #endif private: