Home | History | Annotate | Download | only in tinyxml
      1 /*
      2 www.sourceforge.net/projects/tinyxml
      3 Original file by Yves Berquin.
      4 
      5 This software is provided 'as-is', without any express or implied
      6 warranty. In no event will the authors be held liable for any
      7 damages arising from the use of this software.
      8 
      9 Permission is granted to anyone to use this software for any
     10 purpose, including commercial applications, and to alter it and
     11 redistribute it freely, subject to the following restrictions:
     12 
     13 1. The origin of this software must not be misrepresented; you must
     14 not claim that you wrote the original software. If you use this
     15 software in a product, an acknowledgment in the product documentation
     16 would be appreciated but is not required.
     17 
     18 2. Altered source versions must be plainly marked as such, and
     19 must not be misrepresented as being the original software.
     20 
     21 3. This notice may not be removed or altered from any source
     22 distribution.
     23 */
     24 
     25 /*
     26  * THIS FILE WAS ALTERED BY Tyge Lovset, 7. April 2005.
     27  *
     28  * - completely rewritten. compact, clean, and fast implementation.
     29  * - sizeof(TiXmlString) = pointer size (4 bytes on 32-bit systems)
     30  * - fixed reserve() to work as per specification.
     31  * - fixed buggy compares operator==(), operator<(), and operator>()
     32  * - fixed operator+=() to take a const ref argument, following spec.
     33  * - added "copy" constructor with length, and most compare operators.
     34  * - added swap(), clear(), size(), capacity(), operator+().
     35  */
     36 
     37 #ifndef TIXML_USE_STL
     38 
     39 #ifndef TIXML_STRING_INCLUDED
     40 #define TIXML_STRING_INCLUDED
     41 
     42 #include <assert.h>
     43 #include <string.h>
     44 
     45 /*
     46    TiXmlString is an emulation of a subset of the std::string template.
     47    Its purpose is to allow compiling TinyXML on compilers with no or poor STL support.
     48    Only the member functions relevant to the TinyXML project have been implemented.
     49    The buffer allocation is made by a simplistic power of 2 like mechanism : if we increase
     50    a string and there's no more room, we allocate a buffer twice as big as we need.
     51 */
     52 class TiXmlString
     53 {
     54   public :
     55 	// The size type used
     56   	typedef unsigned int size_type;
     57 
     58 	// Error value for find primitive
     59 	static const size_type npos; // = -1;
     60 
     61 
     62 	// TiXmlString empty constructor
     63 	TiXmlString () : rep_(&nullrep_)
     64 	{
     65 	}
     66 
     67 	// TiXmlString copy constructor
     68 	TiXmlString (const TiXmlString & copy)
     69 	{
     70 		init(copy.length());
     71 		memcpy(start(), copy.data(), length());
     72 	}
     73 
     74 	// TiXmlString constructor, based on a string
     75 	TiXmlString (const char * copy)
     76 	{
     77 		init( static_cast<size_type>( strlen(copy) ));
     78 		memcpy(start(), copy, length());
     79 	}
     80 
     81 	// TiXmlString constructor, based on a string
     82 	TiXmlString (const char * str, size_type len)
     83 	{
     84 		init(len);
     85 		memcpy(start(), str, len);
     86 	}
     87 
     88 	// TiXmlString destructor
     89 	~TiXmlString ()
     90 	{
     91 		quit();
     92 	}
     93 
     94 	// = operator
     95 	TiXmlString& operator = (const char * copy)
     96 	{
     97 		return assign( copy, (size_type)strlen(copy));
     98 	}
     99 
    100 	// = operator
    101 	TiXmlString& operator = (const TiXmlString & copy)
    102 	{
    103 		return assign(copy.start(), copy.length());
    104 	}
    105 
    106 
    107 	// += operator. Maps to append
    108 	TiXmlString& operator += (const char * suffix)
    109 	{
    110 		return append(suffix, static_cast<size_type>( strlen(suffix) ));
    111 	}
    112 
    113 	// += operator. Maps to append
    114 	TiXmlString& operator += (char single)
    115 	{
    116 		return append(&single, 1);
    117 	}
    118 
    119 	// += operator. Maps to append
    120 	TiXmlString& operator += (const TiXmlString & suffix)
    121 	{
    122 		return append(suffix.data(), suffix.length());
    123 	}
    124 
    125 
    126 	// Convert a TiXmlString into a null-terminated char *
    127 	const char * c_str () const { return rep_->str; }
    128 
    129 	// Convert a TiXmlString into a char * (need not be null terminated).
    130 	const char * data () const { return rep_->str; }
    131 
    132 	// Return the length of a TiXmlString
    133 	size_type length () const { return rep_->size; }
    134 
    135 	// Alias for length()
    136 	size_type size () const { return rep_->size; }
    137 
    138 	// Checks if a TiXmlString is empty
    139 	bool empty () const { return rep_->size == 0; }
    140 
    141 	// Return capacity of string
    142 	size_type capacity () const { return rep_->capacity; }
    143 
    144 
    145 	// single char extraction
    146 	const char& at (size_type index) const
    147 	{
    148 		assert( index < length() );
    149 		return rep_->str[ index ];
    150 	}
    151 
    152 	// [] operator
    153 	char& operator [] (size_type index) const
    154 	{
    155 		assert( index < length() );
    156 		return rep_->str[ index ];
    157 	}
    158 
    159 	// find a char in a string. Return TiXmlString::npos if not found
    160 	size_type find (char lookup) const
    161 	{
    162 		return find(lookup, 0);
    163 	}
    164 
    165 	// find a char in a string from an offset. Return TiXmlString::npos if not found
    166 	size_type find (char tofind, size_type offset) const
    167 	{
    168 		if (offset >= length()) return npos;
    169 
    170 		for (const char* p = c_str() + offset; *p != '\0'; ++p)
    171 		{
    172 		   if (*p == tofind) return static_cast< size_type >( p - c_str() );
    173 		}
    174 		return npos;
    175 	}
    176 
    177 	void clear ()
    178 	{
    179 		//Lee:
    180 		//The original was just too strange, though correct:
    181 		//	TiXmlString().swap(*this);
    182 		//Instead use the quit & re-init:
    183 		quit();
    184 		init(0,0);
    185 	}
    186 
    187 	/*	Function to reserve a big amount of data when we know we'll need it. Be aware that this
    188 		function DOES NOT clear the content of the TiXmlString if any exists.
    189 	*/
    190 	void reserve (size_type cap);
    191 
    192 	TiXmlString& assign (const char* str, size_type len);
    193 
    194 	TiXmlString& append (const char* str, size_type len);
    195 
    196 	void swap (TiXmlString& other)
    197 	{
    198 		Rep* r = rep_;
    199 		rep_ = other.rep_;
    200 		other.rep_ = r;
    201 	}
    202 
    203   private:
    204 
    205 	void init(size_type sz) { init(sz, sz); }
    206 	void set_size(size_type sz) { rep_->str[ rep_->size = sz ] = '\0'; }
    207 	char* start() const { return rep_->str; }
    208 	char* finish() const { return rep_->str + rep_->size; }
    209 
    210 	struct Rep
    211 	{
    212 		size_type size, capacity;
    213 		char str[1];
    214 	};
    215 
    216 	void init(size_type sz, size_type cap)
    217 	{
    218 		if (cap)
    219 		{
    220 			rep_ = static_cast<Rep*>(operator new(sizeof(Rep) + cap));
    221 			rep_->str[ rep_->size = sz ] = '\0';
    222 			rep_->capacity = cap;
    223 		}
    224 		else
    225 		{
    226 			rep_ = &nullrep_;
    227 		}
    228 	}
    229 
    230 	void quit()
    231 	{
    232 		if (rep_ != &nullrep_)
    233 		{
    234 			operator delete(rep_);
    235 		}
    236 	}
    237 
    238 	Rep * rep_;
    239 	static Rep nullrep_;
    240 
    241 } ;
    242 
    243 
    244 inline bool operator == (const TiXmlString & a, const TiXmlString & b)
    245 {
    246 	return    ( a.length() == b.length() )				// optimization on some platforms
    247 	       && ( strcmp(a.c_str(), b.c_str()) == 0 );	// actual compare
    248 }
    249 inline bool operator < (const TiXmlString & a, const TiXmlString & b)
    250 {
    251 	return strcmp(a.c_str(), b.c_str()) < 0;
    252 }
    253 
    254 inline bool operator != (const TiXmlString & a, const TiXmlString & b) { return !(a == b); }
    255 inline bool operator >  (const TiXmlString & a, const TiXmlString & b) { return b < a; }
    256 inline bool operator <= (const TiXmlString & a, const TiXmlString & b) { return !(b < a); }
    257 inline bool operator >= (const TiXmlString & a, const TiXmlString & b) { return !(a < b); }
    258 
    259 inline bool operator == (const TiXmlString & a, const char* b) { return strcmp(a.c_str(), b) == 0; }
    260 inline bool operator == (const char* a, const TiXmlString & b) { return b == a; }
    261 inline bool operator != (const TiXmlString & a, const char* b) { return !(a == b); }
    262 inline bool operator != (const char* a, const TiXmlString & b) { return !(b == a); }
    263 
    264 TiXmlString operator + (const TiXmlString & a, const TiXmlString & b);
    265 TiXmlString operator + (const TiXmlString & a, const char* b);
    266 TiXmlString operator + (const char* a, const TiXmlString & b);
    267 
    268 
    269 /*
    270    TiXmlOutStream is an emulation of std::ostream. It is based on TiXmlString.
    271    Only the operators that we need for TinyXML have been developped.
    272 */
    273 class TiXmlOutStream : public TiXmlString
    274 {
    275 public :
    276 
    277 	// TiXmlOutStream << operator.
    278 	TiXmlOutStream & operator << (const TiXmlString & in)
    279 	{
    280 		*this += in;
    281 		return *this;
    282 	}
    283 
    284 	// TiXmlOutStream << operator.
    285 	TiXmlOutStream & operator << (const char * in)
    286 	{
    287 		*this += in;
    288 		return *this;
    289 	}
    290 
    291 } ;
    292 
    293 #endif	// TIXML_STRING_INCLUDED
    294 #endif	// TIXML_USE_STL
    295