OSDN Git Service

2004-01-22 Paolo Carlini <pcarlini@suse.de>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / include / bits / basic_string.h
1 // Components for manipulating sequences of characters -*- C++ -*-
2
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
4 // Free Software Foundation, Inc.
5 //
6 // This file is part of the GNU ISO C++ Library.  This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
10 // any later version.
11
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING.  If not, write to the Free
19 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
20 // USA.
21
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction.  Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License.  This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
30
31 //
32 // ISO C++ 14882: 21 Strings library
33 //
34
35 /** @file basic_string.h
36  *  This is an internal header file, included by other library headers.
37  *  You should not attempt to use it directly.
38  */
39
40 #ifndef _BASIC_STRING_H
41 #define _BASIC_STRING_H 1
42
43 #pragma GCC system_header
44
45 #include <bits/atomicity.h>
46 #include <debug/debug.h>
47
48 namespace std
49 {
50   /**
51    *  @class basic_string basic_string.h <string>
52    *  @brief  Managing sequences of characters and character-like objects.
53    *
54    *  @ingroup Containers
55    *  @ingroup Sequences
56    *
57    *  Meets the requirements of a <a href="tables.html#65">container</a>, a
58    *  <a href="tables.html#66">reversible container</a>, and a
59    *  <a href="tables.html#67">sequence</a>.  Of the
60    *  <a href="tables.html#68">optional sequence requirements</a>, only
61    *  @c push_back, @c at, and array access are supported.
62    *
63    *  @doctodo
64    *
65    *
66    *  @if maint
67    *  Documentation?  What's that?
68    *  Nathan Myers <ncm@cantrip.org>.
69    *
70    *  A string looks like this:
71    *
72    *  @code
73    *                                        [_Rep]
74    *                                        _M_length
75    *   [basic_string<char_type>]            _M_capacity
76    *   _M_dataplus                          _M_state
77    *   _M_p ---------------->               unnamed array of char_type
78    *  @endcode
79    *
80    *  Where the _M_p points to the first character in the string, and
81    *  you cast it to a pointer-to-_Rep and subtract 1 to get a
82    *  pointer to the header.
83    *
84    *  This approach has the enormous advantage that a string object
85    *  requires only one allocation.  All the ugliness is confined
86    *  within a single pair of inline functions, which each compile to
87    *  a single "add" instruction: _Rep::_M_data(), and
88    *  string::_M_rep(); and the allocation function which gets a
89    *  block of raw bytes and with room enough and constructs a _Rep
90    *  object at the front.
91    *
92    *  The reason you want _M_data pointing to the character array and
93    *  not the _Rep is so that the debugger can see the string
94    *  contents. (Probably we should add a non-inline member to get
95    *  the _Rep for the debugger to use, so users can check the actual
96    *  string length.)
97    *
98    *  Note that the _Rep object is a POD so that you can have a
99    *  static "empty string" _Rep object already "constructed" before
100    *  static constructors have run.  The reference-count encoding is
101    *  chosen so that a 0 indicates one reference, so you never try to
102    *  destroy the empty-string _Rep object.
103    *
104    *  All but the last paragraph is considered pretty conventional
105    *  for a C++ string implementation.
106    *  @endif
107   */
108   // 21.3  Template class basic_string
109   template<typename _CharT, typename _Traits, typename _Alloc>
110     class basic_string
111     {
112       // Types:
113     public:
114       typedef _Traits                                       traits_type;
115       typedef typename _Traits::char_type                   value_type;
116       typedef _Alloc                                        allocator_type;
117       typedef typename _Alloc::size_type                    size_type;
118       typedef typename _Alloc::difference_type              difference_type;
119       typedef typename _Alloc::reference                    reference;
120       typedef typename _Alloc::const_reference              const_reference;
121       typedef typename _Alloc::pointer                      pointer;
122       typedef typename _Alloc::const_pointer                const_pointer;
123       typedef __gnu_cxx::__normal_iterator<pointer, basic_string>  iterator;
124       typedef __gnu_cxx::__normal_iterator<const_pointer, basic_string>
125                                                             const_iterator;
126       typedef std::reverse_iterator<const_iterator>     const_reverse_iterator;
127       typedef std::reverse_iterator<iterator>               reverse_iterator;
128
129     private:
130       // _Rep: string representation
131       //   Invariants:
132       //   1. String really contains _M_length + 1 characters: due to 21.3.4
133       //      must be kept null-terminated.
134       //   2. _M_capacity >= _M_length
135       //      Allocated memory is always _M_capacity + (1 * sizeof(_CharT)).
136       //   3. _M_refcount has three states:
137       //      -1: leaked, one reference, no ref-copies allowed, non-const.
138       //       0: one reference, non-const.
139       //     n>0: n + 1 references, operations require a lock, const.
140       //   4. All fields==0 is an empty string, given the extra storage
141       //      beyond-the-end for a null terminator; thus, the shared
142       //      empty string representation needs no constructor.
143
144       struct _Rep_base
145       {
146         size_type               _M_length;
147         size_type               _M_capacity;
148         _Atomic_word            _M_refcount;
149       };
150
151       struct _Rep : _Rep_base
152       {
153         // Types:
154         typedef typename _Alloc::template rebind<char>::other _Raw_bytes_alloc;
155
156         // (Public) Data members:
157
158         // The maximum number of individual char_type elements of an
159         // individual string is determined by _S_max_size. This is the
160         // value that will be returned by max_size().  (Whereas npos
161         // is the maximum number of bytes the allocator can allocate.)
162         // If one was to divvy up the theoretical largest size string,
163         // with a terminating character and m _CharT elements, it'd
164         // look like this:
165         // npos = sizeof(_Rep) + (m * sizeof(_CharT)) + sizeof(_CharT)
166         // Solving for m:
167         // m = ((npos - sizeof(_Rep))/sizeof(CharT)) - 1
168         // In addition, this implementation quarters this amount.
169         static const size_type  _S_max_size;
170         static const _CharT     _S_terminal;
171
172         // The following storage is init'd to 0 by the linker, resulting
173         // (carefully) in an empty string with one reference.
174         static size_type _S_empty_rep_storage[];
175
176         static _Rep& 
177         _S_empty_rep()
178         { return *reinterpret_cast<_Rep*>(&_S_empty_rep_storage); }
179  
180         bool
181         _M_is_leaked() const
182         { return this->_M_refcount < 0; }
183
184         bool
185         _M_is_shared() const
186         { return this->_M_refcount > 0; }
187
188         void
189         _M_set_leaked()
190         { this->_M_refcount = -1; }
191
192         void
193         _M_set_sharable()
194         { this->_M_refcount = 0; }
195
196         _CharT*
197         _M_refdata() throw()
198         { return reinterpret_cast<_CharT*>(this + 1); }
199
200         _CharT&
201         operator[](size_t __s) throw()
202         { return _M_refdata() [__s]; }
203
204         _CharT*
205         _M_grab(const _Alloc& __alloc1, const _Alloc& __alloc2)
206         {
207           return (!_M_is_leaked() && __alloc1 == __alloc2)
208                   ? _M_refcopy() : _M_clone(__alloc1);
209         }
210
211         // Create & Destroy
212         static _Rep*
213         _S_create(size_t, const _Alloc&);
214
215         void
216         _M_dispose(const _Alloc& __a)
217         {
218           if (__builtin_expect(this != &_S_empty_rep(), false))
219             if (__exchange_and_add(&this->_M_refcount, -1) <= 0)
220               _M_destroy(__a);
221         }  // XXX MT
222
223         void
224         _M_destroy(const _Alloc&) throw();
225
226         _CharT*
227         _M_refcopy() throw()
228         {
229           if (__builtin_expect(this != &_S_empty_rep(), false))
230             __atomic_add(&this->_M_refcount, 1);
231           return _M_refdata();
232         }  // XXX MT
233
234         _CharT*
235         _M_clone(const _Alloc&, size_type __res = 0);
236       };
237
238       // Use empty-base optimization: http://www.cantrip.org/emptyopt.html
239       struct _Alloc_hider : _Alloc
240       {
241         _Alloc_hider(_CharT* __dat, const _Alloc& __a)
242         : _Alloc(__a), _M_p(__dat) { }
243
244         _CharT* _M_p; // The actual data.
245       };
246
247     public:
248       // Data Members (public):
249       // NB: This is an unsigned type, and thus represents the maximum
250       // size that the allocator can hold.
251       /// @var
252       /// Value returned by various member functions when they fail.
253       static const size_type    npos = static_cast<size_type>(-1);
254
255     private:
256       // Data Members (private):
257       mutable _Alloc_hider      _M_dataplus;
258
259       _CharT*
260       _M_data() const
261       { return  _M_dataplus._M_p; }
262
263       _CharT*
264       _M_data(_CharT* __p)
265       { return (_M_dataplus._M_p = __p); }
266
267       _Rep*
268       _M_rep() const
269       { return &((reinterpret_cast<_Rep*> (_M_data()))[-1]); }
270
271       // For the internal use we have functions similar to `begin'/`end'
272       // but they do not call _M_leak.
273       iterator
274       _M_ibegin() const { return iterator(_M_data()); }
275
276       iterator
277       _M_iend() const { return iterator(_M_data() + this->size()); }
278
279       void
280       _M_leak()    // for use in begin() & non-const op[]
281       {
282         if (!_M_rep()->_M_is_leaked())
283           _M_leak_hard();
284       }
285
286       size_type
287       _M_check(size_type __pos, const char* __s) const
288       {
289         if (__pos > this->size())
290           __throw_out_of_range(__N(__s));
291         return __pos;
292       }
293
294       // NB: _M_limit doesn't check for a bad __pos value.
295       size_type
296       _M_limit(size_type __pos, size_type __off) const
297       {
298         const bool __testoff =  __off < this->size() - __pos;
299         return __testoff ? __off : this->size() - __pos;
300       }
301
302       // _S_copy_chars is a separate template to permit specialization
303       // to optimize for the common case of pointers as iterators.
304       template<class _Iterator>
305         static void
306         _S_copy_chars(_CharT* __p, _Iterator __k1, _Iterator __k2)
307         {
308           for (; __k1 != __k2; ++__k1, ++__p)
309             traits_type::assign(*__p, *__k1); // These types are off.
310         }
311
312       static void
313       _S_copy_chars(_CharT* __p, iterator __k1, iterator __k2)
314       { _S_copy_chars(__p, __k1.base(), __k2.base()); }
315
316       static void
317       _S_copy_chars(_CharT* __p, const_iterator __k1, const_iterator __k2)
318       { _S_copy_chars(__p, __k1.base(), __k2.base()); }
319
320       static void
321       _S_copy_chars(_CharT* __p, _CharT* __k1, _CharT* __k2)
322       { traits_type::copy(__p, __k1, __k2 - __k1); }
323
324       static void
325       _S_copy_chars(_CharT* __p, const _CharT* __k1, const _CharT* __k2)
326       { traits_type::copy(__p, __k1, __k2 - __k1); }
327
328       void
329       _M_mutate(size_type __pos, size_type __len1, size_type __len2);
330
331       void
332       _M_leak_hard();
333
334       static _Rep&
335       _S_empty_rep()
336       { return _Rep::_S_empty_rep(); }
337
338     public:
339       // Construct/copy/destroy:
340       // NB: We overload ctors in some cases instead of using default
341       // arguments, per 17.4.4.4 para. 2 item 2.
342
343       /**
344        *  @brief  Default constructor creates an empty string.
345        */
346       inline
347       basic_string();
348
349       /**
350        *  @brief  Construct an empty string using allocator a.
351        */
352       explicit
353       basic_string(const _Alloc& __a);
354
355       // NB: per LWG issue 42, semantics different from IS:
356       /**
357        *  @brief  Construct string with copy of value of @a str.
358        *  @param  str  Source string.
359        */
360       basic_string(const basic_string& __str);
361       /**
362        *  @brief  Construct string as copy of a substring.
363        *  @param  str  Source string.
364        *  @param  pos  Index of first character to copy from.
365        *  @param  n  Number of characters to copy (default remainder).
366        */
367       basic_string(const basic_string& __str, size_type __pos,
368                    size_type __n = npos);
369       /**
370        *  @brief  Construct string as copy of a substring.
371        *  @param  str  Source string.
372        *  @param  pos  Index of first character to copy from.
373        *  @param  n  Number of characters to copy.
374        *  @param  a  Allocator to use.
375        */
376       basic_string(const basic_string& __str, size_type __pos,
377                    size_type __n, const _Alloc& __a);
378
379       /**
380        *  @brief  Construct string initialized by a character array.
381        *  @param  s  Source character array.
382        *  @param  n  Number of characters to copy.
383        *  @param  a  Allocator to use (default is default allocator).
384        *  
385        *  NB: s must have at least n characters, '\0' has no special
386        *  meaning.
387        */
388       basic_string(const _CharT* __s, size_type __n,
389                    const _Alloc& __a = _Alloc());
390       /**
391        *  @brief  Construct string as copy of a C string.
392        *  @param  s  Source C string.
393        *  @param  a  Allocator to use (default is default allocator).
394        */
395       basic_string(const _CharT* __s, const _Alloc& __a = _Alloc());
396       /**
397        *  @brief  Construct string as multiple characters.
398        *  @param  n  Number of characters.
399        *  @param  c  Character to use.
400        *  @param  a  Allocator to use (default is default allocator).
401        */
402       basic_string(size_type __n, _CharT __c, const _Alloc& __a = _Alloc());
403
404       /**
405        *  @brief  Construct string as copy of a range.
406        *  @param  beg  Start of range.
407        *  @param  end  End of range.
408        *  @param  a  Allocator to use (default is default allocator).
409        */
410       template<class _InputIterator>
411         basic_string(_InputIterator __beg, _InputIterator __end,
412                      const _Alloc& __a = _Alloc());
413
414       /**
415        *  @brief  Destroy the string instance.
416        */
417       ~basic_string()
418       { _M_rep()->_M_dispose(this->get_allocator()); }
419
420       /**
421        *  @brief  Assign the value of @a str to this string.
422        *  @param  str  Source string.
423        */
424       basic_string&
425       operator=(const basic_string& __str) { return this->assign(__str); }
426
427       /**
428        *  @brief  Copy contents of @a s into this string.
429        *  @param  s  Source null-terminated string.
430        */
431       basic_string&
432       operator=(const _CharT* __s) { return this->assign(__s); }
433
434       /**
435        *  @brief  Set value to string of length 1.
436        *  @param  c  Source character.
437        *
438        *  Assigning to a character makes this string length 1 and
439        *  (*this)[0] == @a c.
440        */
441       basic_string&
442       operator=(_CharT __c) { return this->assign(1, __c); }
443
444       // Iterators:
445       /**
446        *  Returns a read/write iterator that points to the first character in
447        *  the %string.  Unshares the string.
448        */
449       iterator
450       begin()
451       {
452         _M_leak();
453         return iterator(_M_data());
454       }
455
456       /**
457        *  Returns a read-only (constant) iterator that points to the first
458        *  character in the %string.
459        */
460       const_iterator
461       begin() const
462       { return const_iterator(_M_data()); }
463
464       /**
465        *  Returns a read/write iterator that points one past the last
466        *  character in the %string.  Unshares the string.
467        */
468       iterator
469       end()
470       {
471         _M_leak();
472         return iterator(_M_data() + this->size());
473       }
474
475       /**
476        *  Returns a read-only (constant) iterator that points one past the
477        *  last character in the %string.
478        */
479       const_iterator
480       end() const
481       { return const_iterator(_M_data() + this->size()); }
482
483       /**
484        *  Returns a read/write reverse iterator that points to the last
485        *  character in the %string.  Iteration is done in reverse element
486        *  order.  Unshares the string.
487        */
488       reverse_iterator
489       rbegin()
490       { return reverse_iterator(this->end()); }
491
492       /**
493        *  Returns a read-only (constant) reverse iterator that points
494        *  to the last character in the %string.  Iteration is done in
495        *  reverse element order.
496        */
497       const_reverse_iterator
498       rbegin() const
499       { return const_reverse_iterator(this->end()); }
500
501       /**
502        *  Returns a read/write reverse iterator that points to one before the
503        *  first character in the %string.  Iteration is done in reverse
504        *  element order.  Unshares the string.
505        */
506       reverse_iterator
507       rend()
508       { return reverse_iterator(this->begin()); }
509
510       /**
511        *  Returns a read-only (constant) reverse iterator that points
512        *  to one before the first character in the %string.  Iteration
513        *  is done in reverse element order.
514        */
515       const_reverse_iterator
516       rend() const
517       { return const_reverse_iterator(this->begin()); }
518
519     public:
520       // Capacity:
521       ///  Returns the number of characters in the string, not including any
522       ///  null-termination.
523       size_type
524       size() const { return _M_rep()->_M_length; }
525
526       ///  Returns the number of characters in the string, not including any
527       ///  null-termination.
528       size_type
529       length() const { return _M_rep()->_M_length; }
530
531       /// Returns the size() of the largest possible %string.
532       size_type
533       max_size() const { return _Rep::_S_max_size; }
534
535       /**
536        *  @brief  Resizes the %string to the specified number of characters.
537        *  @param  n  Number of characters the %string should contain.
538        *  @param  c  Character to fill any new elements.
539        *
540        *  This function will %resize the %string to the specified
541        *  number of characters.  If the number is smaller than the
542        *  %string's current size the %string is truncated, otherwise
543        *  the %string is extended and new elements are set to @a c.
544        */
545       void
546       resize(size_type __n, _CharT __c);
547
548       /**
549        *  @brief  Resizes the %string to the specified number of characters.
550        *  @param  n  Number of characters the %string should contain.
551        *
552        *  This function will resize the %string to the specified length.  If
553        *  the new size is smaller than the %string's current size the %string
554        *  is truncated, otherwise the %string is extended and new characters
555        *  are default-constructed.  For basic types such as char, this means
556        *  setting them to 0.
557        */
558       void
559       resize(size_type __n) { this->resize(__n, _CharT()); }
560
561       /**
562        *  Returns the total number of characters that the %string can hold
563        *  before needing to allocate more memory.
564        */
565       size_type
566       capacity() const { return _M_rep()->_M_capacity; }
567
568       /**
569        *  @brief  Attempt to preallocate enough memory for specified number of
570        *          characters.
571        *  @param  n  Number of characters required.
572        *  @throw  std::length_error  If @a n exceeds @c max_size().
573        *
574        *  This function attempts to reserve enough memory for the
575        *  %string to hold the specified number of characters.  If the
576        *  number requested is more than max_size(), length_error is
577        *  thrown.
578        *
579        *  The advantage of this function is that if optimal code is a
580        *  necessity and the user can determine the string length that will be
581        *  required, the user can reserve the memory in %advance, and thus
582        *  prevent a possible reallocation of memory and copying of %string
583        *  data.
584        */
585       void
586       reserve(size_type __res_arg = 0);
587
588       /**
589        *  Erases the string, making it empty.
590        */
591       void
592       clear() { _M_mutate(0, this->size(), 0); }
593
594       /**
595        *  Returns true if the %string is empty.  Equivalent to *this == "".
596        */
597       bool
598       empty() const { return this->size() == 0; }
599
600       // Element access:
601       /**
602        *  @brief  Subscript access to the data contained in the %string.
603        *  @param  n  The index of the character to access.
604        *  @return  Read-only (constant) reference to the character.
605        *
606        *  This operator allows for easy, array-style, data access.
607        *  Note that data access with this operator is unchecked and
608        *  out_of_range lookups are not defined. (For checked lookups
609        *  see at().)
610        */
611       const_reference
612       operator[] (size_type __pos) const
613       { 
614         _GLIBCXX_DEBUG_ASSERT(__pos <= size());
615         return _M_data()[__pos]; 
616       }
617
618       /**
619        *  @brief  Subscript access to the data contained in the %string.
620        *  @param  n  The index of the character to access.
621        *  @return  Read/write reference to the character.
622        *
623        *  This operator allows for easy, array-style, data access.
624        *  Note that data access with this operator is unchecked and
625        *  out_of_range lookups are not defined. (For checked lookups
626        *  see at().)  Unshares the string.
627        */
628       reference
629       operator[](size_type __pos)
630       {
631         _GLIBCXX_DEBUG_ASSERT(__pos < size());
632         _M_leak();
633         return _M_data()[__pos];
634       }
635
636       /**
637        *  @brief  Provides access to the data contained in the %string.
638        *  @param n The index of the character to access.
639        *  @return  Read-only (const) reference to the character.
640        *  @throw  std::out_of_range  If @a n is an invalid index.
641        *
642        *  This function provides for safer data access.  The parameter is
643        *  first checked that it is in the range of the string.  The function
644        *  throws out_of_range if the check fails.
645        */
646       const_reference
647       at(size_type __n) const
648       {
649         if (__n >= this->size())
650           __throw_out_of_range(__N("basic_string::at"));
651         return _M_data()[__n];
652       }
653
654       /**
655        *  @brief  Provides access to the data contained in the %string.
656        *  @param n The index of the character to access.
657        *  @return  Read/write reference to the character.
658        *  @throw  std::out_of_range  If @a n is an invalid index.
659        *
660        *  This function provides for safer data access.  The parameter is
661        *  first checked that it is in the range of the string.  The function
662        *  throws out_of_range if the check fails.  Success results in
663        *  unsharing the string.
664        */
665       reference
666       at(size_type __n)
667       {
668         if (__n >= size())
669           __throw_out_of_range(__N("basic_string::at"));
670         _M_leak();
671         return _M_data()[__n];
672       }
673
674       // Modifiers:
675       /**
676        *  @brief  Append a string to this string.
677        *  @param str  The string to append.
678        *  @return  Reference to this string.
679        */
680       basic_string&
681       operator+=(const basic_string& __str) { return this->append(__str); }
682
683       /**
684        *  @brief  Append a C string.
685        *  @param s  The C string to append.
686        *  @return  Reference to this string.
687        */
688       basic_string&
689       operator+=(const _CharT* __s) { return this->append(__s); }
690
691       /**
692        *  @brief  Append a character.
693        *  @param s  The character to append.
694        *  @return  Reference to this string.
695        */
696       basic_string&
697       operator+=(_CharT __c) { return this->append(size_type(1), __c); }
698
699       /**
700        *  @brief  Append a string to this string.
701        *  @param str  The string to append.
702        *  @return  Reference to this string.
703        */
704       basic_string&
705       append(const basic_string& __str);
706
707       /**
708        *  @brief  Append a substring.
709        *  @param str  The string to append.
710        *  @param pos  Index of the first character of str to append.
711        *  @param n  The number of characters to append.
712        *  @return  Reference to this string.
713        *  @throw  std::out_of_range if @a pos is not a valid index.
714        *
715        *  This function appends @a n characters from @a str starting at @a pos
716        *  to this string.  If @a n is is larger than the number of available
717        *  characters in @a str, the remainder of @a str is appended.
718        */
719       basic_string&
720       append(const basic_string& __str, size_type __pos, size_type __n);
721
722       /**
723        *  @brief  Append a C substring.
724        *  @param s  The C string to append.
725        *  @param n  The number of characters to append.
726        *  @return  Reference to this string.
727        */
728       basic_string&
729       append(const _CharT* __s, size_type __n);
730
731       /**
732        *  @brief  Append a C string.
733        *  @param s  The C string to append.
734        *  @return  Reference to this string.
735        */
736       basic_string&
737       append(const _CharT* __s)
738       { 
739         __glibcxx_requires_string(__s);
740         return this->append(__s, traits_type::length(__s)); 
741       }
742
743       /**
744        *  @brief  Append multiple characters.
745        *  @param n  The number of characters to append.
746        *  @param c  The character to use.
747        *  @return  Reference to this string.
748        *
749        *  Appends n copies of c to this string.
750        */
751       basic_string&
752       append(size_type __n, _CharT __c)
753       { return _M_replace_aux(this->size(), size_type(0), __n, __c); }
754
755       /**
756        *  @brief  Append a range of characters.
757        *  @param first  Iterator referencing the first character to append.
758        *  @param last  Iterator marking the end of the range.
759        *  @return  Reference to this string.
760        *
761        *  Appends characters in the range [first,last) to this string.
762        */
763       template<class _InputIterator>
764         basic_string&
765         append(_InputIterator __first, _InputIterator __last)
766         { return this->replace(_M_iend(), _M_iend(), __first, __last); }
767
768       /**
769        *  @brief  Append a single character.
770        *  @param c  Character to append.
771        */
772       void
773       push_back(_CharT __c)
774       { this->replace(_M_iend(), _M_iend(), 1, __c); }
775
776       /**
777        *  @brief  Set value to contents of another string.
778        *  @param  str  Source string to use.
779        *  @return  Reference to this string.
780        */
781       basic_string&
782       assign(const basic_string& __str);
783
784       /**
785        *  @brief  Set value to a substring of a string.
786        *  @param str  The string to use.
787        *  @param pos  Index of the first character of str.
788        *  @param n  Number of characters to use.
789        *  @return  Reference to this string.
790        *  @throw  std::out_of_range if @a pos is not a valid index.
791        *
792        *  This function sets this string to the substring of @a str consisting
793        *  of @a n characters at @a pos.  If @a n is is larger than the number
794        *  of available characters in @a str, the remainder of @a str is used.
795        */
796       basic_string&
797       assign(const basic_string& __str, size_type __pos, size_type __n);
798
799       /**
800        *  @brief  Set value to a C substring.
801        *  @param s  The C string to use.
802        *  @param n  Number of characters to use.
803        *  @return  Reference to this string.
804        *
805        *  This function sets the value of this string to the first @a n
806        *  characters of @a s.  If @a n is is larger than the number of
807        *  available characters in @a s, the remainder of @a s is used.
808        */
809       basic_string&
810       assign(const _CharT* __s, size_type __n);
811
812       /**
813        *  @brief  Set value to contents of a C string.
814        *  @param s  The C string to use.
815        *  @return  Reference to this string.
816        *
817        *  This function sets the value of this string to the value of @a s.
818        *  The data is copied, so there is no dependence on @a s once the
819        *  function returns.
820        */
821       basic_string&
822       assign(const _CharT* __s)
823       { 
824         __glibcxx_requires_string(__s);
825         return this->assign(__s, traits_type::length(__s)); 
826       }
827
828       /**
829        *  @brief  Set value to multiple characters.
830        *  @param n  Length of the resulting string.
831        *  @param c  The character to use.
832        *  @return  Reference to this string.
833        *
834        *  This function sets the value of this string to @a n copies of
835        *  character @a c.
836        */
837       basic_string&
838       assign(size_type __n, _CharT __c)
839       { return _M_replace_aux(size_type(0), this->size(), __n, __c); }
840
841       /**
842        *  @brief  Set value to a range of characters.
843        *  @param first  Iterator referencing the first character to append.
844        *  @param last  Iterator marking the end of the range.
845        *  @return  Reference to this string.
846        *
847        *  Sets value of string to characters in the range [first,last).
848       */
849       template<class _InputIterator>
850         basic_string&
851         assign(_InputIterator __first, _InputIterator __last)
852         { return this->replace(_M_ibegin(), _M_iend(), __first, __last); }
853
854       /**
855        *  @brief  Insert multiple characters.
856        *  @param p  Iterator referencing location in string to insert at.
857        *  @param n  Number of characters to insert
858        *  @param c  The character to insert.
859        *  @throw  std::length_error  If new length exceeds @c max_size().
860        *
861        *  Inserts @a n copies of character @a c starting at the position
862        *  referenced by iterator @a p.  If adding characters causes the length
863        *  to exceed max_size(), length_error is thrown.  The value of the
864        *  string doesn't change if an error is thrown.
865       */
866       void
867       insert(iterator __p, size_type __n, _CharT __c)
868       { this->replace(__p, __p, __n, __c);  }
869
870       /**
871        *  @brief  Insert a range of characters.
872        *  @param p  Iterator referencing location in string to insert at.
873        *  @param beg  Start of range.
874        *  @param end  End of range. 
875        *  @throw  std::length_error  If new length exceeds @c max_size().
876        *
877        *  Inserts characters in range [beg,end).  If adding characters causes
878        *  the length to exceed max_size(), length_error is thrown.  The value
879        *  of the string doesn't change if an error is thrown.
880       */
881       template<class _InputIterator>
882         void insert(iterator __p, _InputIterator __beg, _InputIterator __end)
883         { this->replace(__p, __p, __beg, __end); }
884
885       /**
886        *  @brief  Insert value of a string.
887        *  @param pos1  Iterator referencing location in string to insert at.
888        *  @param str  The string to insert.
889        *  @return  Reference to this string.
890        *  @throw  std::length_error  If new length exceeds @c max_size().
891        *
892        *  Inserts value of @a str starting at @a pos1.  If adding characters
893        *  causes the length to exceed max_size(), length_error is thrown.  The
894        *  value of the string doesn't change if an error is thrown.
895       */
896       basic_string&
897       insert(size_type __pos1, const basic_string& __str)
898       { return this->insert(__pos1, __str, 0, __str.size()); }
899
900       /**
901        *  @brief  Insert a substring.
902        *  @param pos1  Iterator referencing location in string to insert at.
903        *  @param str  The string to insert.
904        *  @param pos2  Start of characters in str to insert.
905        *  @param n  Number of characters to insert.
906        *  @return  Reference to this string.
907        *  @throw  std::length_error  If new length exceeds @c max_size().
908        *  @throw  std::out_of_range  If @a pos1 > size() or
909        *  @a pos2 > @a str.size().
910        *
911        *  Starting at @a pos1, insert @a n character of @a str beginning with
912        *  @a pos2.  If adding characters causes the length to exceed
913        *  max_size(), length_error is thrown.  If @a pos1 is beyond the end of
914        *  this string or @a pos2 is beyond the end of @a str, out_of_range is
915        *  thrown.  The value of the string doesn't change if an error is
916        *  thrown.
917       */
918       basic_string&
919       insert(size_type __pos1, const basic_string& __str,
920              size_type __pos2, size_type __n);
921
922       /**
923        *  @brief  Insert a C substring.
924        *  @param pos  Iterator referencing location in string to insert at.
925        *  @param s  The C string to insert.
926        *  @param n  The number of characters to insert.
927        *  @return  Reference to this string.
928        *  @throw  std::length_error  If new length exceeds @c max_size().
929        *  @throw  std::out_of_range  If @a pos is beyond the end of this
930        *  string. 
931        *
932        *  Inserts the first @a n characters of @a s starting at @a pos.  If
933        *  adding characters causes the length to exceed max_size(),
934        *  length_error is thrown.  If @a pos is beyond end(), out_of_range is
935        *  thrown.  The value of the string doesn't change if an error is
936        *  thrown.
937       */
938       basic_string&
939       insert(size_type __pos, const _CharT* __s, size_type __n);
940
941       /**
942        *  @brief  Insert a C string.
943        *  @param pos  Iterator referencing location in string to insert at.
944        *  @param s  The C string to insert.
945        *  @return  Reference to this string.
946        *  @throw  std::length_error  If new length exceeds @c max_size().
947        *  @throw  std::out_of_range  If @a pos is beyond the end of this
948        *  string.
949        *
950        *  Inserts the first @a n characters of @a s starting at @a pos.  If
951        *  adding characters causes the length to exceed max_size(),
952        *  length_error is thrown.  If @a pos is beyond end(), out_of_range is
953        *  thrown.  The value of the string doesn't change if an error is
954        *  thrown.
955       */
956       basic_string&
957       insert(size_type __pos, const _CharT* __s)
958       { 
959         __glibcxx_requires_string(__s);
960         return this->insert(__pos, __s, traits_type::length(__s)); 
961       }
962
963       /**
964        *  @brief  Insert multiple characters.
965        *  @param pos  Index in string to insert at.
966        *  @param n  Number of characters to insert
967        *  @param c  The character to insert.
968        *  @return  Reference to this string.
969        *  @throw  std::length_error  If new length exceeds @c max_size().
970        *  @throw  std::out_of_range  If @a pos is beyond the end of this
971        *  string.
972        *
973        *  Inserts @a n copies of character @a c starting at index @a pos.  If
974        *  adding characters causes the length to exceed max_size(),
975        *  length_error is thrown.  If @a pos > length(), out_of_range is
976        *  thrown.  The value of the string doesn't change if an error is
977        *  thrown.
978       */
979       basic_string&
980       insert(size_type __pos, size_type __n, _CharT __c)
981       { 
982         const iterator __iterator = this->_M_ibegin()
983                                     + _M_check(__pos, "basic_string::insert");
984         return this->replace(__iterator, __iterator, __n, __c);
985       }
986
987       /**
988        *  @brief  Insert one character.
989        *  @param p  Iterator referencing position in string to insert at.
990        *  @param c  The character to insert.
991        *  @return  Iterator referencing newly inserted char.
992        *  @throw  std::length_error  If new length exceeds @c max_size().
993        *  @throw  std::out_of_range  If @a p is beyond the end of this string.
994        *
995        *  Inserts character @a c at position referenced by @a p.  If adding
996        *  character causes the length to exceed max_size(), length_error is
997        *  thrown.  If @a p is beyond end of string, out_of_range is thrown.
998        *  The value of the string doesn't change if an error is thrown.
999       */
1000       iterator
1001       insert(iterator __p, _CharT __c)
1002       {
1003         _GLIBCXX_DEBUG_PEDASSERT(__p >= _M_ibegin() && __p <= _M_iend());
1004         const size_type __pos = __p - _M_ibegin();
1005         this->replace(__p, __p, size_type(1), __c);
1006         _M_rep()->_M_set_leaked();
1007         return this->_M_ibegin() + __pos;
1008       }
1009
1010 #ifdef _GLIBCXX_DEPRECATED
1011       /**
1012        *  @brief  Insert one default-constructed character.
1013        *  @param p  Iterator referencing position in string to insert at.
1014        *  @return  Iterator referencing newly inserted char.
1015        *  @throw  std::length_error  If new length exceeds @c max_size().
1016        *  @throw  std::out_of_range  If @a p is beyond the end of this string.
1017        *
1018        *  Inserts a default-constructed character at position
1019        *  referenced by @a p.  If adding character causes the length
1020        *  to exceed max_size(), length_error is thrown.  If @a p is
1021        *  beyond end of string, out_of_range is thrown.  The value of
1022        *  the string doesn't change if an error is thrown.
1023       */
1024       iterator
1025       insert(iterator __p)
1026       { return this->insert(__p, _CharT()); }
1027 #endif /* _GLIBCXX_DEPRECATED */
1028
1029       /**
1030        *  @brief  Remove characters.
1031        *  @param pos  Index of first character to remove (default 0).
1032        *  @param n  Number of characters to remove (default remainder).
1033        *  @return  Reference to this string.
1034        *  @throw  std::out_of_range  If @a pos is beyond the end of this
1035        *  string.
1036        *
1037        *  Removes @a n characters from this string starting at @a pos.  The
1038        *  length of the string is reduced by @a n.  If there are < @a n
1039        *  characters to remove, the remainder of the string is truncated.  If
1040        *  @a p is beyond end of string, out_of_range is thrown.  The value of
1041        *  the string doesn't change if an error is thrown.
1042       */
1043       basic_string&
1044       erase(size_type __pos = 0, size_type __n = npos)
1045       {
1046         return this->replace(_M_ibegin() + _M_check(__pos, "basic_string::erase"),
1047                              _M_ibegin() + __pos + _M_limit(__pos, __n),
1048                              _M_data(), _M_data());
1049       }
1050
1051       /**
1052        *  @brief  Remove one character.
1053        *  @param position  Iterator referencing the character to remove.
1054        *  @return  iterator referencing same location after removal.
1055        *  @throw  std::out_of_range  If @a position is beyond the end of this
1056        *  string. 
1057        *
1058        *  Removes the character at @a position from this string.  If @a
1059        *  position is beyond end of string, out_of_range is thrown.  The value
1060        *  of the string doesn't change if an error is thrown.
1061       */
1062       iterator
1063       erase(iterator __position)
1064       {
1065         _GLIBCXX_DEBUG_PEDASSERT(__position >= _M_ibegin() 
1066                                  && __position < _M_iend());
1067         const size_type __i = __position - _M_ibegin();
1068         this->replace(__position, __position + 1, _M_data(), _M_data());
1069         _M_rep()->_M_set_leaked();
1070         return _M_ibegin() + __i;
1071       }
1072
1073       /**
1074        *  @brief  Remove a range of characters.
1075        *  @param first  Iterator referencing the first character to remove.
1076        *  @param last  Iterator referencing the end of the range.
1077        *  @return  Iterator referencing location of first after removal.
1078        *  @throw  std::out_of_range  If @a first is beyond the end of this
1079        *  string. 
1080        *
1081        *  Removes the characters in the range [first,last) from this string.
1082        *  If @a first is beyond end of string, out_of_range is thrown.  The
1083        *  value of the string doesn't change if an error is thrown.
1084       */
1085       iterator
1086       erase(iterator __first, iterator __last)
1087       {
1088         _GLIBCXX_DEBUG_PEDASSERT(__first >= _M_ibegin() && __first <= __last
1089                                  && __last <= _M_iend());
1090         const size_type __i = __first - _M_ibegin();
1091         this->replace(__first, __last, _M_data(), _M_data());
1092         _M_rep()->_M_set_leaked();
1093         return _M_ibegin() + __i;
1094       }
1095
1096       /**
1097        *  @brief  Replace characters with value from another string.
1098        *  @param pos  Index of first character to replace.
1099        *  @param n  Number of characters to be replaced.
1100        *  @param str  String to insert.
1101        *  @return  Reference to this string.
1102        *  @throw  std::out_of_range  If @a pos is beyond the end of this
1103        *  string. 
1104        *  @throw  std::length_error  If new length exceeds @c max_size().
1105        *
1106        *  Removes the characters in the range [pos,pos+n) from this string.
1107        *  In place, the value of @a str is inserted.  If @a pos is beyond end
1108        *  of string, out_of_range is thrown.  If the length of the result
1109        *  exceeds max_size(), length_error is thrown.  The value of the string
1110        *  doesn't change if an error is thrown.
1111       */
1112       basic_string&
1113       replace(size_type __pos, size_type __n, const basic_string& __str)
1114       { return this->replace(__pos, __n, __str._M_data(), __str.size()); }
1115
1116       /**
1117        *  @brief  Replace characters with value from another string.
1118        *  @param pos1  Index of first character to replace.
1119        *  @param n1  Number of characters to be replaced.
1120        *  @param str  String to insert.
1121        *  @param pos2  Index of first character of str to use.
1122        *  @param n2  Number of characters from str to use.
1123        *  @return  Reference to this string.
1124        *  @throw  std::out_of_range  If @a pos1 > size() or @a pos2 >
1125        *  str.size(). 
1126        *  @throw  std::length_error  If new length exceeds @c max_size().
1127        *
1128        *  Removes the characters in the range [pos1,pos1 + n) from this
1129        *  string.  In place, the value of @a str is inserted.  If @a pos is
1130        *  beyond end of string, out_of_range is thrown.  If the length of the
1131        *  result exceeds max_size(), length_error is thrown.  The value of the
1132        *  string doesn't change if an error is thrown.
1133       */
1134       basic_string&
1135       replace(size_type __pos1, size_type __n1, const basic_string& __str,
1136               size_type __pos2, size_type __n2);
1137
1138       /**
1139        *  @brief  Replace characters with value of a C substring.
1140        *  @param pos  Index of first character to replace.
1141        *  @param n1  Number of characters to be replaced.
1142        *  @param str  C string to insert.
1143        *  @param n2  Number of characters from str to use.
1144        *  @return  Reference to this string.
1145        *  @throw  std::out_of_range  If @a pos1 > size().
1146        *  @throw  std::length_error  If new length exceeds @c max_size().
1147        *
1148        *  Removes the characters in the range [pos,pos + n1) from this string.
1149        *  In place, the first @a n2 characters of @a str are inserted, or all
1150        *  of @a str if @a n2 is too large.  If @a pos is beyond end of string,
1151        *  out_of_range is thrown.  If the length of result exceeds max_size(),
1152        *  length_error is thrown.  The value of the string doesn't change if
1153        *  an error is thrown.
1154       */
1155       basic_string&
1156       replace(size_type __pos, size_type __n1, const _CharT* __s,
1157               size_type __n2);
1158
1159       /**
1160        *  @brief  Replace characters with value of a C string.
1161        *  @param pos  Index of first character to replace.
1162        *  @param n1  Number of characters to be replaced.
1163        *  @param str  C string to insert.
1164        *  @return  Reference to this string.
1165        *  @throw  std::out_of_range  If @a pos > size().
1166        *  @throw  std::length_error  If new length exceeds @c max_size().
1167        *
1168        *  Removes the characters in the range [pos,pos + n1) from this string.
1169        *  In place, the first @a n characters of @a str are inserted.  If @a
1170        *  pos is beyond end of string, out_of_range is thrown.  If the length
1171        *  of result exceeds max_size(), length_error is thrown.  The value of
1172        *  the string doesn't change if an error is thrown.
1173       */
1174       basic_string&
1175       replace(size_type __pos, size_type __n1, const _CharT* __s)
1176       { 
1177         __glibcxx_requires_string(__s);
1178         return this->replace(__pos, __n1, __s, traits_type::length(__s)); 
1179       }
1180
1181       /**
1182        *  @brief  Replace characters with multiple characters.
1183        *  @param pos  Index of first character to replace.
1184        *  @param n1  Number of characters to be replaced.
1185        *  @param n2  Number of characters to insert.
1186        *  @param c  Character to insert.
1187        *  @return  Reference to this string.
1188        *  @throw  std::out_of_range  If @a pos > size().
1189        *  @throw  std::length_error  If new length exceeds @c max_size().
1190        *
1191        *  Removes the characters in the range [pos,pos + n1) from this string.
1192        *  In place, @a n2 copies of @a c are inserted.  If @a pos is beyond
1193        *  end of string, out_of_range is thrown.  If the length of result
1194        *  exceeds max_size(), length_error is thrown.  The value of the string
1195        *  doesn't change if an error is thrown.
1196       */
1197       basic_string&
1198       replace(size_type __pos, size_type __n1, size_type __n2, _CharT __c)
1199       { return this->replace(_M_ibegin() + _M_check(__pos, "basic_string::replace"),
1200                              _M_ibegin() + __pos + _M_limit(__pos, __n1),
1201                              __n2, __c); }
1202
1203       /**
1204        *  @brief  Replace range of characters with string.
1205        *  @param i1  Iterator referencing start of range to replace.
1206        *  @param i2  Iterator referencing end of range to replace.
1207        *  @param str  String value to insert.
1208        *  @return  Reference to this string.
1209        *  @throw  std::length_error  If new length exceeds @c max_size().
1210        *
1211        *  Removes the characters in the range [i1,i2).  In place, the value of
1212        *  @a str is inserted.  If the length of result exceeds max_size(),
1213        *  length_error is thrown.  The value of the string doesn't change if
1214        *  an error is thrown.
1215       */
1216       basic_string&
1217       replace(iterator __i1, iterator __i2, const basic_string& __str)
1218       { 
1219         _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1220                                  && __i2 <= _M_iend());
1221         return this->replace(__i1, __i2, __str._M_data(), __str.size()); 
1222       }
1223
1224       /**
1225        *  @brief  Replace range of characters with C substring.
1226        *  @param i1  Iterator referencing start of range to replace.
1227        *  @param i2  Iterator referencing end of range to replace.
1228        *  @param s  C string value to insert.
1229        *  @param n  Number of characters from s to insert.
1230        *  @return  Reference to this string.
1231        *  @throw  std::length_error  If new length exceeds @c max_size().
1232        *
1233        *  Removes the characters in the range [i1,i2).  In place, the first @a
1234        *  n characters of @a s are inserted.  If the length of result exceeds
1235        *  max_size(), length_error is thrown.  The value of the string doesn't
1236        *  change if an error is thrown.
1237       */
1238       basic_string&
1239       replace(iterator __i1, iterator __i2,
1240               const _CharT* __s, size_type __n)
1241       { return this->replace(__i1 - _M_ibegin(), __i2 - __i1, __s, __n); }
1242
1243       /**
1244        *  @brief  Replace range of characters with C string.
1245        *  @param i1  Iterator referencing start of range to replace.
1246        *  @param i2  Iterator referencing end of range to replace.
1247        *  @param s  C string value to insert.
1248        *  @return  Reference to this string.
1249        *  @throw  std::length_error  If new length exceeds @c max_size().
1250        *
1251        *  Removes the characters in the range [i1,i2).  In place, the
1252        *  characters of @a s are inserted.  If the length of result exceeds
1253        *  max_size(), length_error is thrown.  The value of the string doesn't
1254        *  change if an error is thrown.
1255       */
1256       basic_string&
1257       replace(iterator __i1, iterator __i2, const _CharT* __s)
1258       { 
1259         _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1260                                  && __i2 <= _M_iend());
1261         __glibcxx_requires_string(__s);
1262         return this->replace(__i1, __i2, __s, traits_type::length(__s)); 
1263       }
1264
1265       /**
1266        *  @brief  Replace range of characters with multiple characters
1267        *  @param i1  Iterator referencing start of range to replace.
1268        *  @param i2  Iterator referencing end of range to replace.
1269        *  @param n  Number of characters to insert.
1270        *  @param c  Character to insert.
1271        *  @return  Reference to this string.
1272        *  @throw  std::length_error  If new length exceeds @c max_size().
1273        *
1274        *  Removes the characters in the range [i1,i2).  In place, @a n copies
1275        *  of @a c are inserted.  If the length of result exceeds max_size(),
1276        *  length_error is thrown.  The value of the string doesn't change if
1277        *  an error is thrown.
1278       */
1279       basic_string&
1280       replace(iterator __i1, iterator __i2, size_type __n, _CharT __c)
1281       { 
1282         _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1283                                  && __i2 <= _M_iend());
1284         return _M_replace_aux(__i1 - _M_ibegin(), __i2 - __i1, __n, __c); 
1285       }
1286
1287       /**
1288        *  @brief  Replace range of characters with range.
1289        *  @param i1  Iterator referencing start of range to replace.
1290        *  @param i2  Iterator referencing end of range to replace.
1291        *  @param k1  Iterator referencing start of range to insert.
1292        *  @param k2  Iterator referencing end of range to insert.
1293        *  @return  Reference to this string.
1294        *  @throw  std::length_error  If new length exceeds @c max_size().
1295        *
1296        *  Removes the characters in the range [i1,i2).  In place, characters
1297        *  in the range [k1,k2) are inserted.  If the length of result exceeds
1298        *  max_size(), length_error is thrown.  The value of the string doesn't
1299        *  change if an error is thrown.
1300       */
1301       template<class _InputIterator>
1302         basic_string&
1303         replace(iterator __i1, iterator __i2,
1304                 _InputIterator __k1, _InputIterator __k2)
1305         { 
1306           _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1307                                    && __i2 <= _M_iend());
1308           __glibcxx_requires_valid_range(__k1, __k2);
1309           typedef typename _Is_integer<_InputIterator>::_Integral _Integral;
1310           return _M_replace_dispatch(__i1, __i2, __k1, __k2, _Integral()); 
1311         }
1312
1313       // Specializations for the common case of pointer and iterator:
1314       // useful to avoid the overhead of temporary buffering in _M_replace.
1315       basic_string&
1316         replace(iterator __i1, iterator __i2, _CharT* __k1, _CharT* __k2)
1317         { 
1318           _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1319                                    && __i2 <= _M_iend());
1320           __glibcxx_requires_valid_range(__k1, __k2);
1321           return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1322                                __k1, __k2 - __k1); 
1323         }
1324
1325       basic_string&
1326         replace(iterator __i1, iterator __i2, 
1327                 const _CharT* __k1, const _CharT* __k2)
1328         { 
1329           _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1330                                    && __i2 <= _M_iend());
1331           __glibcxx_requires_valid_range(__k1, __k2);
1332           return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1333                                __k1, __k2 - __k1); 
1334         }
1335
1336       basic_string&
1337         replace(iterator __i1, iterator __i2, iterator __k1, iterator __k2)
1338         { 
1339           _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1340                                    && __i2 <= _M_iend());
1341           __glibcxx_requires_valid_range(__k1, __k2);
1342           return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1343                                __k1.base(), __k2 - __k1);
1344         }
1345
1346       basic_string&
1347         replace(iterator __i1, iterator __i2, 
1348                 const_iterator __k1, const_iterator __k2)
1349         { 
1350           _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1351                                    && __i2 <= _M_iend());
1352           __glibcxx_requires_valid_range(__k1, __k2);
1353           return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1354                                __k1.base(), __k2 - __k1);
1355         }
1356
1357     private:
1358       template<class _Integer>
1359         basic_string&
1360         _M_replace_dispatch(iterator __i1, iterator __i2, _Integer __n, 
1361                             _Integer __val, __true_type)
1362         { return _M_replace_aux(__i1 - _M_ibegin(), __i2 - __i1, __n, __val); }
1363
1364       template<class _InputIterator>
1365         basic_string&
1366         _M_replace_dispatch(iterator __i1, iterator __i2, _InputIterator __k1,
1367                             _InputIterator __k2, __false_type)
1368         { return _M_replace(__i1, __i2, __k1, __k2); }
1369
1370       basic_string&
1371       _M_replace_aux(size_type __pos1, size_type __n1, size_type __n2, _CharT __c);
1372
1373       template<class _InputIterator>
1374         basic_string&
1375         _M_replace(iterator __i1, iterator __i2, _InputIterator __k1,
1376                    _InputIterator __k2);
1377
1378       basic_string&
1379       _M_replace_safe(size_type __pos1, size_type __n1, const _CharT* __s,
1380                       size_type __n2);
1381
1382       // _S_construct_aux is used to implement the 21.3.1 para 15 which
1383       // requires special behaviour if _InIter is an integral type
1384       template<class _InIterator>
1385         static _CharT*
1386         _S_construct_aux(_InIterator __beg, _InIterator __end, const _Alloc& __a,
1387                          __false_type)
1388         {
1389           typedef typename iterator_traits<_InIterator>::iterator_category _Tag;
1390           return _S_construct(__beg, __end, __a, _Tag());
1391         }
1392
1393       template<class _InIterator>
1394         static _CharT*
1395         _S_construct_aux(_InIterator __beg, _InIterator __end, const _Alloc& __a,
1396                          __true_type)
1397         {
1398           return _S_construct(static_cast<size_type>(__beg),
1399                               static_cast<value_type>(__end), __a);
1400         }
1401
1402       template<class _InIterator>
1403         static _CharT*
1404         _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a)
1405         {
1406           typedef typename _Is_integer<_InIterator>::_Integral _Integral;
1407           return _S_construct_aux(__beg, __end, __a, _Integral());
1408         }
1409
1410       // For Input Iterators, used in istreambuf_iterators, etc.
1411       template<class _InIterator>
1412         static _CharT*
1413          _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
1414                       input_iterator_tag);
1415
1416       // For forward_iterators up to random_access_iterators, used for
1417       // string::iterator, _CharT*, etc.
1418       template<class _FwdIterator>
1419         static _CharT*
1420         _S_construct(_FwdIterator __beg, _FwdIterator __end, const _Alloc& __a,
1421                      forward_iterator_tag);
1422
1423       static _CharT*
1424       _S_construct(size_type __req, _CharT __c, const _Alloc& __a);
1425
1426     public:
1427
1428       /**
1429        *  @brief  Copy substring into C string.
1430        *  @param s  C string to copy value into.
1431        *  @param n  Number of characters to copy.
1432        *  @param pos  Index of first character to copy.
1433        *  @return  Number of characters actually copied
1434        *  @throw  std::out_of_range  If pos > size().
1435        *
1436        *  Copies up to @a n characters starting at @a pos into the C string @a
1437        *  s.  If @a pos is greater than size(), out_of_range is thrown.
1438       */
1439       size_type
1440       copy(_CharT* __s, size_type __n, size_type __pos = 0) const;
1441
1442       /**
1443        *  @brief  Swap contents with another string.
1444        *  @param s  String to swap with.
1445        *
1446        *  Exchanges the contents of this string with that of @a s in constant
1447        *  time.
1448       */
1449       void
1450       swap(basic_string& __s);
1451
1452       // String operations:
1453       /**
1454        *  @brief  Return const pointer to null-terminated contents.
1455        *
1456        *  This is a handle to internal data.  Do not modify or dire things may
1457        *  happen.
1458       */
1459       const _CharT*
1460       c_str() const
1461       { return _M_data(); }
1462
1463       /**
1464        *  @brief  Return const pointer to contents.
1465        *
1466        *  This is a handle to internal data.  It may not be null-terminated.
1467        *  Do not modify or dire things may happen.
1468       */
1469       const _CharT*
1470       data() const { return _M_data(); }
1471
1472       /**
1473        *  @brief  Return copy of allocator used to construct this string.
1474       */
1475       allocator_type
1476       get_allocator() const { return _M_dataplus; }
1477
1478       /**
1479        *  @brief  Find position of a C substring.
1480        *  @param s  C string to locate.
1481        *  @param pos  Index of character to search from.
1482        *  @param n  Number of characters from @a s to search for.
1483        *  @return  Index of start of first occurrence.
1484        *
1485        *  Starting from @a pos, searches forward for the first @a n characters
1486        *  in @a s within this string.  If found, returns the index where it
1487        *  begins.  If not found, returns npos.
1488       */
1489       size_type
1490       find(const _CharT* __s, size_type __pos, size_type __n) const;
1491
1492       /**
1493        *  @brief  Find position of a string.
1494        *  @param str  String to locate.
1495        *  @param pos  Index of character to search from (default 0).
1496        *  @return  Index of start of first occurrence.
1497        *
1498        *  Starting from @a pos, searches forward for value of @a str within
1499        *  this string.  If found, returns the index where it begins.  If not
1500        *  found, returns npos.
1501       */
1502       size_type
1503       find(const basic_string& __str, size_type __pos = 0) const
1504       { return this->find(__str.data(), __pos, __str.size()); }
1505
1506       /**
1507        *  @brief  Find position of a C string.
1508        *  @param s  C string to locate.
1509        *  @param pos  Index of character to search from (default 0).
1510        *  @return  Index of start of first occurrence.
1511        *
1512        *  Starting from @a pos, searches forward for the value of @a s within
1513        *  this string.  If found, returns the index where it begins.  If not
1514        *  found, returns npos.
1515       */
1516       size_type
1517       find(const _CharT* __s, size_type __pos = 0) const
1518       { 
1519         __glibcxx_requires_string(__s);
1520         return this->find(__s, __pos, traits_type::length(__s)); 
1521       }
1522
1523       /**
1524        *  @brief  Find position of a character.
1525        *  @param c  Character to locate.
1526        *  @param pos  Index of character to search from (default 0).
1527        *  @return  Index of first occurrence.
1528        *
1529        *  Starting from @a pos, searches forward for @a c within this string.
1530        *  If found, returns the index where it was found.  If not found,
1531        *  returns npos.
1532       */
1533       size_type
1534       find(_CharT __c, size_type __pos = 0) const;
1535
1536       /**
1537        *  @brief  Find last position of a string.
1538        *  @param str  String to locate.
1539        *  @param pos  Index of character to search back from (default end).
1540        *  @return  Index of start of last occurrence.
1541        *
1542        *  Starting from @a pos, searches backward for value of @a str within
1543        *  this string.  If found, returns the index where it begins.  If not
1544        *  found, returns npos.
1545       */
1546       size_type
1547       rfind(const basic_string& __str, size_type __pos = npos) const
1548       { return this->rfind(__str.data(), __pos, __str.size()); }
1549
1550       /**
1551        *  @brief  Find last position of a C substring.
1552        *  @param s  C string to locate.
1553        *  @param pos  Index of character to search back from.
1554        *  @param n  Number of characters from s to search for.
1555        *  @return  Index of start of last occurrence.
1556        *
1557        *  Starting from @a pos, searches backward for the first @a n
1558        *  characters in @a s within this string.  If found, returns the index
1559        *  where it begins.  If not found, returns npos.
1560       */
1561       size_type
1562       rfind(const _CharT* __s, size_type __pos, size_type __n) const;
1563
1564       /**
1565        *  @brief  Find last position of a C string.
1566        *  @param s  C string to locate.
1567        *  @param pos  Index of character to start search at (default 0).
1568        *  @return  Index of start of  last occurrence.
1569        *
1570        *  Starting from @a pos, searches backward for the value of @a s within
1571        *  this string.  If found, returns the index where it begins.  If not
1572        *  found, returns npos.
1573       */
1574       size_type
1575       rfind(const _CharT* __s, size_type __pos = npos) const
1576       { 
1577         __glibcxx_requires_string(__s);
1578         return this->rfind(__s, __pos, traits_type::length(__s)); 
1579       }
1580
1581       /**
1582        *  @brief  Find last position of a character.
1583        *  @param c  Character to locate.
1584        *  @param pos  Index of character to search back from (default 0).
1585        *  @return  Index of last occurrence.
1586        *
1587        *  Starting from @a pos, searches backward for @a c within this string.
1588        *  If found, returns the index where it was found.  If not found,
1589        *  returns npos.
1590       */
1591       size_type
1592       rfind(_CharT __c, size_type __pos = npos) const;
1593
1594       /**
1595        *  @brief  Find position of a character of string.
1596        *  @param str  String containing characters to locate.
1597        *  @param pos  Index of character to search from (default 0).
1598        *  @return  Index of first occurrence.
1599        *
1600        *  Starting from @a pos, searches forward for one of the characters of
1601        *  @a str within this string.  If found, returns the index where it was
1602        *  found.  If not found, returns npos.
1603       */
1604       size_type
1605       find_first_of(const basic_string& __str, size_type __pos = 0) const
1606       { return this->find_first_of(__str.data(), __pos, __str.size()); }
1607
1608       /**
1609        *  @brief  Find position of a character of C substring.
1610        *  @param s  String containing characters to locate.
1611        *  @param pos  Index of character to search from (default 0).
1612        *  @param n  Number of characters from s to search for.
1613        *  @return  Index of first occurrence.
1614        *
1615        *  Starting from @a pos, searches forward for one of the first @a n
1616        *  characters of @a s within this string.  If found, returns the index
1617        *  where it was found.  If not found, returns npos.
1618       */
1619       size_type
1620       find_first_of(const _CharT* __s, size_type __pos, size_type __n) const;
1621
1622       /**
1623        *  @brief  Find position of a character of C string.
1624        *  @param s  String containing characters to locate.
1625        *  @param pos  Index of character to search from (default 0).
1626        *  @return  Index of first occurrence.
1627        *
1628        *  Starting from @a pos, searches forward for one of the characters of
1629        *  @a s within this string.  If found, returns the index where it was
1630        *  found.  If not found, returns npos.
1631       */
1632       size_type
1633       find_first_of(const _CharT* __s, size_type __pos = 0) const
1634       { 
1635         __glibcxx_requires_string(__s);
1636         return this->find_first_of(__s, __pos, traits_type::length(__s)); 
1637       }
1638
1639       /**
1640        *  @brief  Find position of a character.
1641        *  @param c  Character to locate.
1642        *  @param pos  Index of character to search from (default 0).
1643        *  @return  Index of first occurrence.
1644        *
1645        *  Starting from @a pos, searches forward for the character @a c within
1646        *  this string.  If found, returns the index where it was found.  If
1647        *  not found, returns npos.
1648        *
1649        *  Note: equivalent to find(c, pos).
1650       */
1651       size_type
1652       find_first_of(_CharT __c, size_type __pos = 0) const
1653       { return this->find(__c, __pos); }
1654
1655       /**
1656        *  @brief  Find last position of a character of string.
1657        *  @param str  String containing characters to locate.
1658        *  @param pos  Index of character to search back from (default end).
1659        *  @return  Index of last occurrence.
1660        *
1661        *  Starting from @a pos, searches backward for one of the characters of
1662        *  @a str within this string.  If found, returns the index where it was
1663        *  found.  If not found, returns npos.
1664       */
1665       size_type
1666       find_last_of(const basic_string& __str, size_type __pos = npos) const
1667       { return this->find_last_of(__str.data(), __pos, __str.size()); }
1668
1669       /**
1670        *  @brief  Find last position of a character of C substring.
1671        *  @param s  C string containing characters to locate.
1672        *  @param pos  Index of character to search back from (default end).
1673        *  @param n  Number of characters from s to search for.
1674        *  @return  Index of last occurrence.
1675        *
1676        *  Starting from @a pos, searches backward for one of the first @a n
1677        *  characters of @a s within this string.  If found, returns the index
1678        *  where it was found.  If not found, returns npos.
1679       */
1680       size_type
1681       find_last_of(const _CharT* __s, size_type __pos, size_type __n) const;
1682
1683       /**
1684        *  @brief  Find last position of a character of C string.
1685        *  @param s  C string containing characters to locate.
1686        *  @param pos  Index of character to search back from (default end).
1687        *  @return  Index of last occurrence.
1688        *
1689        *  Starting from @a pos, searches backward for one of the characters of
1690        *  @a s within this string.  If found, returns the index where it was
1691        *  found.  If not found, returns npos.
1692       */
1693       size_type
1694       find_last_of(const _CharT* __s, size_type __pos = npos) const
1695       { 
1696         __glibcxx_requires_string(__s);
1697         return this->find_last_of(__s, __pos, traits_type::length(__s)); 
1698       }
1699
1700       /**
1701        *  @brief  Find last position of a character.
1702        *  @param c  Character to locate.
1703        *  @param pos  Index of character to search back from (default 0).
1704        *  @return  Index of last occurrence.
1705        *
1706        *  Starting from @a pos, searches backward for @a c within this string.
1707        *  If found, returns the index where it was found.  If not found,
1708        *  returns npos.
1709        *
1710        *  Note: equivalent to rfind(c, pos).
1711       */
1712       size_type
1713       find_last_of(_CharT __c, size_type __pos = npos) const
1714       { return this->rfind(__c, __pos); }
1715
1716       /**
1717        *  @brief  Find position of a character not in string.
1718        *  @param str  String containing characters to avoid.
1719        *  @param pos  Index of character to search from (default 0).
1720        *  @return  Index of first occurrence.
1721        *
1722        *  Starting from @a pos, searches forward for a character not contained
1723        *  in @a str within this string.  If found, returns the index where it
1724        *  was found.  If not found, returns npos.
1725       */
1726       size_type
1727       find_first_not_of(const basic_string& __str, size_type __pos = 0) const
1728       { return this->find_first_not_of(__str.data(), __pos, __str.size()); }
1729
1730       /**
1731        *  @brief  Find position of a character not in C substring.
1732        *  @param s  C string containing characters to avoid.
1733        *  @param pos  Index of character to search from (default 0).
1734        *  @param n  Number of characters from s to consider.
1735        *  @return  Index of first occurrence.
1736        *
1737        *  Starting from @a pos, searches forward for a character not contained
1738        *  in the first @a n characters of @a s within this string.  If found,
1739        *  returns the index where it was found.  If not found, returns npos.
1740       */
1741       size_type
1742       find_first_not_of(const _CharT* __s, size_type __pos,
1743                         size_type __n) const;
1744
1745       /**
1746        *  @brief  Find position of a character not in C string.
1747        *  @param s  C string containing characters to avoid.
1748        *  @param pos  Index of character to search from (default 0).
1749        *  @return  Index of first occurrence.
1750        *
1751        *  Starting from @a pos, searches forward for a character not contained
1752        *  in @a s within this string.  If found, returns the index where it
1753        *  was found.  If not found, returns npos.
1754       */
1755       size_type
1756       find_first_not_of(const _CharT* __s, size_type __pos = 0) const
1757       { 
1758         __glibcxx_requires_string(__s);
1759         return this->find_first_not_of(__s, __pos, traits_type::length(__s)); 
1760       }
1761
1762       /**
1763        *  @brief  Find position of a different character.
1764        *  @param c  Character to avoid.
1765        *  @param pos  Index of character to search from (default 0).
1766        *  @return  Index of first occurrence.
1767        *
1768        *  Starting from @a pos, searches forward for a character other than @a c
1769        *  within this string.  If found, returns the index where it was found.
1770        *  If not found, returns npos.
1771       */
1772       size_type
1773       find_first_not_of(_CharT __c, size_type __pos = 0) const;
1774
1775       /**
1776        *  @brief  Find last position of a character not in string.
1777        *  @param str  String containing characters to avoid.
1778        *  @param pos  Index of character to search from (default 0).
1779        *  @return  Index of first occurrence.
1780        *
1781        *  Starting from @a pos, searches backward for a character not
1782        *  contained in @a str within this string.  If found, returns the index
1783        *  where it was found.  If not found, returns npos.
1784       */
1785       size_type
1786       find_last_not_of(const basic_string& __str, size_type __pos = npos) const
1787       { return this->find_last_not_of(__str.data(), __pos, __str.size()); }
1788
1789       /**
1790        *  @brief  Find last position of a character not in C substring.
1791        *  @param s  C string containing characters to avoid.
1792        *  @param pos  Index of character to search from (default 0).
1793        *  @param n  Number of characters from s to consider.
1794        *  @return  Index of first occurrence.
1795        *
1796        *  Starting from @a pos, searches backward for a character not
1797        *  contained in the first @a n characters of @a s within this string.
1798        *  If found, returns the index where it was found.  If not found,
1799        *  returns npos.
1800       */
1801       size_type
1802       find_last_not_of(const _CharT* __s, size_type __pos,
1803                        size_type __n) const;
1804       /**
1805        *  @brief  Find position of a character not in C string.
1806        *  @param s  C string containing characters to avoid.
1807        *  @param pos  Index of character to search from (default 0).
1808        *  @return  Index of first occurrence.
1809        *
1810        *  Starting from @a pos, searches backward for a character not
1811        *  contained in @a s within this string.  If found, returns the index
1812        *  where it was found.  If not found, returns npos.
1813       */
1814       size_type
1815       find_last_not_of(const _CharT* __s, size_type __pos = npos) const
1816       { 
1817         __glibcxx_requires_string(__s);
1818         return this->find_last_not_of(__s, __pos, traits_type::length(__s)); 
1819       }
1820
1821       /**
1822        *  @brief  Find last position of a different character.
1823        *  @param c  Character to avoid.
1824        *  @param pos  Index of character to search from (default 0).
1825        *  @return  Index of first occurrence.
1826        *
1827        *  Starting from @a pos, searches backward for a character other than
1828        *  @a c within this string.  If found, returns the index where it was
1829        *  found.  If not found, returns npos.
1830       */
1831       size_type
1832       find_last_not_of(_CharT __c, size_type __pos = npos) const;
1833
1834       /**
1835        *  @brief  Get a substring.
1836        *  @param pos  Index of first character (default 0).
1837        *  @param n  Number of characters in substring (default remainder).
1838        *  @return  The new string.
1839        *  @throw  std::out_of_range  If pos > size().
1840        *
1841        *  Construct and return a new string using the @a n characters starting
1842        *  at @a pos.  If the string is too short, use the remainder of the
1843        *  characters.  If @a pos is beyond the end of the string, out_of_range
1844        *  is thrown.
1845       */
1846       basic_string
1847       substr(size_type __pos = 0, size_type __n = npos) const
1848       { return basic_string(*this, _M_check(__pos, "basic_string::substr"), __n); }
1849
1850       /**
1851        *  @brief  Compare to a string.
1852        *  @param str  String to compare against.
1853        *  @return  Integer < 0, 0, or > 0.
1854        *
1855        *  Returns an integer < 0 if this string is ordered before @a str, 0 if
1856        *  their values are equivalent, or > 0 if this string is ordered after
1857        *  @a str.  If the lengths of @a str and this string are different, the
1858        *  shorter one is ordered first.  If they are the same, returns the
1859        *  result of traits::compare(data(),str.data(),size());
1860       */
1861       int
1862       compare(const basic_string& __str) const
1863       {
1864         const size_type __size = this->size();
1865         const size_type __osize = __str.size();
1866         const size_type __len = std::min(__size, __osize);
1867
1868         int __r = traits_type::compare(_M_data(), __str.data(), __len);
1869         if (!__r)
1870           __r =  __size - __osize;
1871         return __r;
1872       }
1873
1874       /**
1875        *  @brief  Compare substring to a string.
1876        *  @param pos  Index of first character of substring.
1877        *  @param n  Number of characters in substring.
1878        *  @param str  String to compare against.
1879        *  @return  Integer < 0, 0, or > 0.
1880        *
1881        *  Form the substring of this string from the @a n characters starting
1882        *  at @a pos.  Returns an integer < 0 if the substring is ordered
1883        *  before @a str, 0 if their values are equivalent, or > 0 if the
1884        *  substring is ordered after @a str.  If the lengths @a of str and the
1885        *  substring are different, the shorter one is ordered first.  If they
1886        *  are the same, returns the result of
1887        *  traits::compare(substring.data(),str.data(),size());
1888       */
1889       int
1890       compare(size_type __pos, size_type __n, const basic_string& __str) const;
1891
1892       /**
1893        *  @brief  Compare substring to a substring.
1894        *  @param pos1  Index of first character of substring.
1895        *  @param n1  Number of characters in substring.
1896        *  @param str  String to compare against.
1897        *  @param pos2  Index of first character of substring of str.
1898        *  @param n2  Number of characters in substring of str.
1899        *  @return  Integer < 0, 0, or > 0.
1900        *
1901        *  Form the substring of this string from the @a n1 characters starting
1902        *  at @a pos1.  Form the substring of @a str from the @a n2 characters
1903        *  starting at @a pos2.  Returns an integer < 0 if this substring is
1904        *  ordered before the substring of @a str, 0 if their values are
1905        *  equivalent, or > 0 if this substring is ordered after the substring
1906        *  of @a str.  If the lengths of the substring of @a str and this
1907        *  substring are different, the shorter one is ordered first.  If they
1908        *  are the same, returns the result of
1909        *  traits::compare(substring.data(),str.substr(pos2,n2).data(),size());
1910       */
1911       int
1912       compare(size_type __pos1, size_type __n1, const basic_string& __str,
1913               size_type __pos2, size_type __n2) const;
1914
1915       /**
1916        *  @brief  Compare to a C string.
1917        *  @param s  C string to compare against.
1918        *  @return  Integer < 0, 0, or > 0.
1919        *
1920        *  Returns an integer < 0 if this string is ordered before @a s, 0 if
1921        *  their values are equivalent, or > 0 if this string is ordered after
1922        *  @a s.  If the lengths of @a s and this string are different, the
1923        *  shorter one is ordered first.  If they are the same, returns the
1924        *  result of traits::compare(data(),s,size());
1925       */
1926       int
1927       compare(const _CharT* __s) const;
1928
1929       // _GLIBCXX_RESOLVE_LIB_DEFECTS
1930       // 5 String::compare specification questionable
1931       /**
1932        *  @brief  Compare substring to a C string.
1933        *  @param pos  Index of first character of substring.
1934        *  @param n1  Number of characters in substring.
1935        *  @param s  C string to compare against.
1936        *  @return  Integer < 0, 0, or > 0.
1937        *
1938        *  Form the substring of this string from the @a n1 characters starting
1939        *  at @a pos.  Returns an integer < 0 if the substring is ordered
1940        *  before @a s, 0 if their values are equivalent, or > 0 if the
1941        *  substring is ordered after @a s.  If the lengths of @a s and the
1942        *  substring are different, the shorter one is ordered first.  If they
1943        *  are the same, returns the result of
1944        *  traits::compare(substring.data(),s,size());
1945       */
1946       int
1947       compare(size_type __pos, size_type __n1, const _CharT* __s) const;
1948
1949       /**
1950        *  @brief  Compare substring against a character array.
1951        *  @param pos1  Index of first character of substring.
1952        *  @param n1  Number of characters in substring.
1953        *  @param s  character array to compare against.
1954        *  @param n2  Number of characters of s.
1955        *  @return  Integer < 0, 0, or > 0.
1956        *
1957        *  Form the substring of this string from the @a n1 characters starting
1958        *  at @a pos1.  Form a string from the first @a n2 characters of @a s.
1959        *  Returns an integer < 0 if this substring is ordered before the string
1960        *  from @a s, 0 if their values are equivalent, or > 0 if this substring
1961        *  is ordered after the string from @a s. If the lengths of this substring
1962        *  and @a n2 are different, the shorter one is ordered first.  If they are
1963        *  the same, returns the result of traits::compare(substring.data(),s,size());
1964        *
1965        *  NB: s must have at least n2 characters, '\0' has no special
1966        *  meaning.
1967       */
1968       int
1969       compare(size_type __pos, size_type __n1, const _CharT* __s,
1970               size_type __n2) const;
1971   };
1972
1973
1974   template<typename _CharT, typename _Traits, typename _Alloc>
1975     inline basic_string<_CharT, _Traits, _Alloc>::
1976     basic_string()
1977     : _M_dataplus(_S_empty_rep()._M_refdata(), _Alloc()) { }
1978
1979   // operator+
1980   /**
1981    *  @brief  Concatenate two strings.
1982    *  @param lhs  First string.
1983    *  @param rhs  Last string.
1984    *  @return  New string with value of @a lhs followed by @a rhs.
1985    */ 
1986  template<typename _CharT, typename _Traits, typename _Alloc>
1987     basic_string<_CharT, _Traits, _Alloc>
1988     operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
1989               const basic_string<_CharT, _Traits, _Alloc>& __rhs)
1990     {
1991       basic_string<_CharT, _Traits, _Alloc> __str(__lhs);
1992       __str.append(__rhs);
1993       return __str;
1994     }
1995
1996   /**
1997    *  @brief  Concatenate C string and string.
1998    *  @param lhs  First string.
1999    *  @param rhs  Last string.
2000    *  @return  New string with value of @a lhs followed by @a rhs.
2001    */ 
2002   template<typename _CharT, typename _Traits, typename _Alloc>
2003     basic_string<_CharT,_Traits,_Alloc>
2004     operator+(const _CharT* __lhs,
2005               const basic_string<_CharT,_Traits,_Alloc>& __rhs);
2006
2007   /**
2008    *  @brief  Concatenate character and string.
2009    *  @param lhs  First string.
2010    *  @param rhs  Last string.
2011    *  @return  New string with @a lhs followed by @a rhs.
2012    */ 
2013   template<typename _CharT, typename _Traits, typename _Alloc>
2014     basic_string<_CharT,_Traits,_Alloc>
2015     operator+(_CharT __lhs, const basic_string<_CharT,_Traits,_Alloc>& __rhs);
2016
2017   /**
2018    *  @brief  Concatenate string and C string.
2019    *  @param lhs  First string.
2020    *  @param rhs  Last string.
2021    *  @return  New string with @a lhs followed by @a rhs.
2022    */ 
2023   template<typename _CharT, typename _Traits, typename _Alloc>
2024     inline basic_string<_CharT, _Traits, _Alloc>
2025     operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2026              const _CharT* __rhs)
2027     {
2028       basic_string<_CharT, _Traits, _Alloc> __str(__lhs);
2029       __str.append(__rhs);
2030       return __str;
2031     }
2032
2033   /**
2034    *  @brief  Concatenate string and character.
2035    *  @param lhs  First string.
2036    *  @param rhs  Last string.
2037    *  @return  New string with @a lhs followed by @a rhs.
2038    */ 
2039   template<typename _CharT, typename _Traits, typename _Alloc>
2040     inline basic_string<_CharT, _Traits, _Alloc>
2041     operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, _CharT __rhs)
2042     {
2043       typedef basic_string<_CharT, _Traits, _Alloc>     __string_type;
2044       typedef typename __string_type::size_type         __size_type;
2045       __string_type __str(__lhs);
2046       __str.append(__size_type(1), __rhs);
2047       return __str;
2048     }
2049
2050   // operator ==
2051   /**
2052    *  @brief  Test equivalence of two strings.
2053    *  @param lhs  First string.
2054    *  @param rhs  Second string.
2055    *  @return  True if @a lhs.compare(@a rhs) == 0.  False otherwise.
2056    */ 
2057   template<typename _CharT, typename _Traits, typename _Alloc>
2058     inline bool
2059     operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2060                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2061     { return __lhs.compare(__rhs) == 0; }
2062
2063   /**
2064    *  @brief  Test equivalence of C string and string.
2065    *  @param lhs  C string.
2066    *  @param rhs  String.
2067    *  @return  True if @a rhs.compare(@a lhs) == 0.  False otherwise.
2068    */ 
2069   template<typename _CharT, typename _Traits, typename _Alloc>
2070     inline bool
2071     operator==(const _CharT* __lhs,
2072                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2073     { return __rhs.compare(__lhs) == 0; }
2074
2075   /**
2076    *  @brief  Test equivalence of string and C string.
2077    *  @param lhs  String.
2078    *  @param rhs  C string.
2079    *  @return  True if @a lhs.compare(@a rhs) == 0.  False otherwise.
2080    */ 
2081   template<typename _CharT, typename _Traits, typename _Alloc>
2082     inline bool
2083     operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2084                const _CharT* __rhs)
2085     { return __lhs.compare(__rhs) == 0; }
2086
2087   // operator !=
2088   /**
2089    *  @brief  Test difference of two strings.
2090    *  @param lhs  First string.
2091    *  @param rhs  Second string.
2092    *  @return  True if @a lhs.compare(@a rhs) != 0.  False otherwise.
2093    */ 
2094   template<typename _CharT, typename _Traits, typename _Alloc>
2095     inline bool
2096     operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2097                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2098     { return __rhs.compare(__lhs) != 0; }
2099
2100   /**
2101    *  @brief  Test difference of C string and string.
2102    *  @param lhs  C string.
2103    *  @param rhs  String.
2104    *  @return  True if @a rhs.compare(@a lhs) != 0.  False otherwise.
2105    */ 
2106   template<typename _CharT, typename _Traits, typename _Alloc>
2107     inline bool
2108     operator!=(const _CharT* __lhs,
2109                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2110     { return __rhs.compare(__lhs) != 0; }
2111
2112   /**
2113    *  @brief  Test difference of string and C string.
2114    *  @param lhs  String.
2115    *  @param rhs  C string.
2116    *  @return  True if @a lhs.compare(@a rhs) != 0.  False otherwise.
2117    */ 
2118   template<typename _CharT, typename _Traits, typename _Alloc>
2119     inline bool
2120     operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2121                const _CharT* __rhs)
2122     { return __lhs.compare(__rhs) != 0; }
2123
2124   // operator <
2125   /**
2126    *  @brief  Test if string precedes string.
2127    *  @param lhs  First string.
2128    *  @param rhs  Second string.
2129    *  @return  True if @a lhs precedes @a rhs.  False otherwise.
2130    */ 
2131   template<typename _CharT, typename _Traits, typename _Alloc>
2132     inline bool
2133     operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2134               const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2135     { return __lhs.compare(__rhs) < 0; }
2136
2137   /**
2138    *  @brief  Test if string precedes C string.
2139    *  @param lhs  String.
2140    *  @param rhs  C string.
2141    *  @return  True if @a lhs precedes @a rhs.  False otherwise.
2142    */ 
2143   template<typename _CharT, typename _Traits, typename _Alloc>
2144     inline bool
2145     operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2146               const _CharT* __rhs)
2147     { return __lhs.compare(__rhs) < 0; }
2148
2149   /**
2150    *  @brief  Test if C string precedes string.
2151    *  @param lhs  C string.
2152    *  @param rhs  String.
2153    *  @return  True if @a lhs precedes @a rhs.  False otherwise.
2154    */ 
2155   template<typename _CharT, typename _Traits, typename _Alloc>
2156     inline bool
2157     operator<(const _CharT* __lhs,
2158               const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2159     { return __rhs.compare(__lhs) > 0; }
2160
2161   // operator >
2162   /**
2163    *  @brief  Test if string follows string.
2164    *  @param lhs  First string.
2165    *  @param rhs  Second string.
2166    *  @return  True if @a lhs follows @a rhs.  False otherwise.
2167    */ 
2168   template<typename _CharT, typename _Traits, typename _Alloc>
2169     inline bool
2170     operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2171               const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2172     { return __lhs.compare(__rhs) > 0; }
2173
2174   /**
2175    *  @brief  Test if string follows C string.
2176    *  @param lhs  String.
2177    *  @param rhs  C string.
2178    *  @return  True if @a lhs follows @a rhs.  False otherwise.
2179    */ 
2180   template<typename _CharT, typename _Traits, typename _Alloc>
2181     inline bool
2182     operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2183               const _CharT* __rhs)
2184     { return __lhs.compare(__rhs) > 0; }
2185
2186   /**
2187    *  @brief  Test if C string follows string.
2188    *  @param lhs  C string.
2189    *  @param rhs  String.
2190    *  @return  True if @a lhs follows @a rhs.  False otherwise.
2191    */ 
2192   template<typename _CharT, typename _Traits, typename _Alloc>
2193     inline bool
2194     operator>(const _CharT* __lhs,
2195               const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2196     { return __rhs.compare(__lhs) < 0; }
2197
2198   // operator <=
2199   /**
2200    *  @brief  Test if string doesn't follow string.
2201    *  @param lhs  First string.
2202    *  @param rhs  Second string.
2203    *  @return  True if @a lhs doesn't follow @a rhs.  False otherwise.
2204    */ 
2205   template<typename _CharT, typename _Traits, typename _Alloc>
2206     inline bool
2207     operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2208                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2209     { return __lhs.compare(__rhs) <= 0; }
2210
2211   /**
2212    *  @brief  Test if string doesn't follow C string.
2213    *  @param lhs  String.
2214    *  @param rhs  C string.
2215    *  @return  True if @a lhs doesn't follow @a rhs.  False otherwise.
2216    */ 
2217   template<typename _CharT, typename _Traits, typename _Alloc>
2218     inline bool
2219     operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2220                const _CharT* __rhs)
2221     { return __lhs.compare(__rhs) <= 0; }
2222
2223   /**
2224    *  @brief  Test if C string doesn't follow string.
2225    *  @param lhs  C string.
2226    *  @param rhs  String.
2227    *  @return  True if @a lhs doesn't follow @a rhs.  False otherwise.
2228    */ 
2229   template<typename _CharT, typename _Traits, typename _Alloc>
2230     inline bool
2231     operator<=(const _CharT* __lhs,
2232                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2233   { return __rhs.compare(__lhs) >= 0; }
2234
2235   // operator >=
2236   /**
2237    *  @brief  Test if string doesn't precede string.
2238    *  @param lhs  First string.
2239    *  @param rhs  Second string.
2240    *  @return  True if @a lhs doesn't precede @a rhs.  False otherwise.
2241    */ 
2242   template<typename _CharT, typename _Traits, typename _Alloc>
2243     inline bool
2244     operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2245                const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2246     { return __lhs.compare(__rhs) >= 0; }
2247
2248   /**
2249    *  @brief  Test if string doesn't precede C string.
2250    *  @param lhs  String.
2251    *  @param rhs  C string.
2252    *  @return  True if @a lhs doesn't precede @a rhs.  False otherwise.
2253    */ 
2254   template<typename _CharT, typename _Traits, typename _Alloc>
2255     inline bool
2256     operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2257                const _CharT* __rhs)
2258     { return __lhs.compare(__rhs) >= 0; }
2259
2260   /**
2261    *  @brief  Test if C string doesn't precede string.
2262    *  @param lhs  C string.
2263    *  @param rhs  String.
2264    *  @return  True if @a lhs doesn't precede @a rhs.  False otherwise.
2265    */ 
2266   template<typename _CharT, typename _Traits, typename _Alloc>
2267     inline bool
2268     operator>=(const _CharT* __lhs,
2269              const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2270     { return __rhs.compare(__lhs) <= 0; }
2271
2272   /**
2273    *  @brief  Swap contents of two strings.
2274    *  @param lhs  First string.
2275    *  @param rhs  Second string.
2276    *
2277    *  Exchanges the contents of @a lhs and @a rhs in constant time. 
2278    */
2279   template<typename _CharT, typename _Traits, typename _Alloc>
2280     inline void
2281     swap(basic_string<_CharT, _Traits, _Alloc>& __lhs,
2282          basic_string<_CharT, _Traits, _Alloc>& __rhs)
2283     { __lhs.swap(__rhs); }
2284
2285   /**
2286    *  @brief  Read stream into a string.
2287    *  @param is  Input stream.
2288    *  @param str  Buffer to store into.
2289    *  @return  Reference to the input stream.
2290    *
2291    *  Stores characters from @a is into @a str until whitespace is found, the
2292    *  end of the stream is encountered, or str.max_size() is reached.  If
2293    *  is.width() is non-zero, that is the limit on the number of characters
2294    *  stored into @a str.  Any previous contents of @a str are erased.
2295    */
2296   template<typename _CharT, typename _Traits, typename _Alloc>
2297     basic_istream<_CharT, _Traits>&
2298     operator>>(basic_istream<_CharT, _Traits>& __is,
2299                basic_string<_CharT, _Traits, _Alloc>& __str);
2300
2301   /**
2302    *  @brief  Write string to a stream.
2303    *  @param os  Output stream.
2304    *  @param str  String to write out.
2305    *  @return  Reference to the output stream.
2306    *
2307    *  Output characters of @a str into os following the same rules as for
2308    *  writing a C string.
2309    */
2310   template<typename _CharT, typename _Traits, typename _Alloc>
2311     basic_ostream<_CharT, _Traits>&
2312     operator<<(basic_ostream<_CharT, _Traits>& __os,
2313                const basic_string<_CharT, _Traits, _Alloc>& __str);
2314
2315   /**
2316    *  @brief  Read a line from stream into a string.
2317    *  @param is  Input stream.
2318    *  @param str  Buffer to store into.
2319    *  @param delim  Character marking end of line.
2320    *  @return  Reference to the input stream.
2321    *
2322    *  Stores characters from @a is into @a str until @a delim is found, the
2323    *  end of the stream is encountered, or str.max_size() is reached.  If
2324    *  is.width() is non-zero, that is the limit on the number of characters
2325    *  stored into @a str.  Any previous contents of @a str are erased.  If @a
2326    *  delim was encountered, it is extracted but not stored into @a str.
2327    */
2328   template<typename _CharT, typename _Traits, typename _Alloc>
2329     basic_istream<_CharT,_Traits>&
2330     getline(basic_istream<_CharT, _Traits>& __is,
2331             basic_string<_CharT, _Traits, _Alloc>& __str, _CharT __delim);
2332
2333   /**
2334    *  @brief  Read a line from stream into a string.
2335    *  @param is  Input stream.
2336    *  @param str  Buffer to store into.
2337    *  @return  Reference to the input stream.
2338    *
2339    *  Stores characters from is into @a str until '\n' is found, the end of
2340    *  the stream is encountered, or str.max_size() is reached.  If is.width()
2341    *  is non-zero, that is the limit on the number of characters stored into
2342    *  @a str.  Any previous contents of @a str are erased.  If end of line was
2343    *  encountered, it is extracted but not stored into @a str.
2344    */
2345   template<typename _CharT, typename _Traits, typename _Alloc>
2346     inline basic_istream<_CharT,_Traits>&
2347     getline(basic_istream<_CharT, _Traits>& __is,
2348             basic_string<_CharT, _Traits, _Alloc>& __str);
2349 } // namespace std
2350
2351 #endif /* _BASIC_STRING_H */