1 // Components for manipulating sequences of characters -*- C++ -*-
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
4 // Free Software Foundation, Inc.
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)
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.
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,
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.
32 // ISO C++ 14882: 21 Strings library
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.
40 #ifndef _BASIC_STRING_H
41 #define _BASIC_STRING_H 1
43 #pragma GCC system_header
45 #include <bits/atomicity.h>
46 #include <debug/debug.h>
51 * @class basic_string basic_string.h <string>
52 * @brief Managing sequences of characters and character-like objects.
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.
67 * Documentation? What's that?
68 * Nathan Myers <ncm@cantrip.org>.
70 * A string looks like this:
75 * [basic_string<char_type>] _M_capacity
76 * _M_dataplus _M_state
77 * _M_p ----------------> unnamed array of char_type
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.
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.
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
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.
104 * All but the last paragraph is considered pretty conventional
105 * for a C++ string implementation.
108 // 21.3 Template class basic_string
109 template<typename _CharT, typename _Traits, typename _Alloc>
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>
126 typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
127 typedef std::reverse_iterator<iterator> reverse_iterator;
130 // _Rep: string representation
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.
147 size_type _M_capacity;
148 _Atomic_word _M_refcount;
151 struct _Rep : _Rep_base
154 typedef typename _Alloc::template rebind<char>::other _Raw_bytes_alloc;
156 // (Public) Data members:
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
165 // npos = sizeof(_Rep) + (m * sizeof(_CharT)) + sizeof(_CharT)
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;
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[];
178 { return *reinterpret_cast<_Rep*>(&_S_empty_rep_storage); }
182 { return this->_M_refcount < 0; }
186 { return this->_M_refcount > 0; }
190 { this->_M_refcount = -1; }
194 { this->_M_refcount = 0; }
198 { return reinterpret_cast<_CharT*>(this + 1); }
201 operator[](size_t __s) throw()
202 { return _M_refdata() [__s]; }
205 _M_grab(const _Alloc& __alloc1, const _Alloc& __alloc2)
207 return (!_M_is_leaked() && __alloc1 == __alloc2)
208 ? _M_refcopy() : _M_clone(__alloc1);
213 _S_create(size_t, const _Alloc&);
216 _M_dispose(const _Alloc& __a)
218 if (__builtin_expect(this != &_S_empty_rep(), false))
219 if (__exchange_and_add(&this->_M_refcount, -1) <= 0)
224 _M_destroy(const _Alloc&) throw();
229 if (__builtin_expect(this != &_S_empty_rep(), false))
230 __atomic_add(&this->_M_refcount, 1);
235 _M_clone(const _Alloc&, size_type __res = 0);
238 // Use empty-base optimization: http://www.cantrip.org/emptyopt.html
239 struct _Alloc_hider : _Alloc
241 _Alloc_hider(_CharT* __dat, const _Alloc& __a)
242 : _Alloc(__a), _M_p(__dat) { }
244 _CharT* _M_p; // The actual data.
248 // Data Members (public):
249 // NB: This is an unsigned type, and thus represents the maximum
250 // size that the allocator can hold.
252 /// Value returned by various member functions when they fail.
253 static const size_type npos = static_cast<size_type>(-1);
256 // Data Members (private):
257 mutable _Alloc_hider _M_dataplus;
261 { return _M_dataplus._M_p; }
265 { return (_M_dataplus._M_p = __p); }
269 { return &((reinterpret_cast<_Rep*> (_M_data()))[-1]); }
271 // For the internal use we have functions similar to `begin'/`end'
272 // but they do not call _M_leak.
274 _M_ibegin() const { return iterator(_M_data()); }
277 _M_iend() const { return iterator(_M_data() + this->size()); }
280 _M_leak() // for use in begin() & non-const op[]
282 if (!_M_rep()->_M_is_leaked())
287 _M_check(size_type __pos, const char* __s) const
289 if (__pos > this->size())
290 __throw_out_of_range(__N(__s));
294 // NB: _M_limit doesn't check for a bad __pos value.
296 _M_limit(size_type __pos, size_type __off) const
298 const bool __testoff = __off < this->size() - __pos;
299 return __testoff ? __off : this->size() - __pos;
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>
306 _S_copy_chars(_CharT* __p, _Iterator __k1, _Iterator __k2)
308 for (; __k1 != __k2; ++__k1, ++__p)
309 traits_type::assign(*__p, *__k1); // These types are off.
313 _S_copy_chars(_CharT* __p, iterator __k1, iterator __k2)
314 { _S_copy_chars(__p, __k1.base(), __k2.base()); }
317 _S_copy_chars(_CharT* __p, const_iterator __k1, const_iterator __k2)
318 { _S_copy_chars(__p, __k1.base(), __k2.base()); }
321 _S_copy_chars(_CharT* __p, _CharT* __k1, _CharT* __k2)
322 { traits_type::copy(__p, __k1, __k2 - __k1); }
325 _S_copy_chars(_CharT* __p, const _CharT* __k1, const _CharT* __k2)
326 { traits_type::copy(__p, __k1, __k2 - __k1); }
329 _M_mutate(size_type __pos, size_type __len1, size_type __len2);
336 { return _Rep::_S_empty_rep(); }
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.
344 * @brief Default constructor creates an empty string.
350 * @brief Construct an empty string using allocator a.
353 basic_string(const _Alloc& __a);
355 // NB: per LWG issue 42, semantics different from IS:
357 * @brief Construct string with copy of value of @a str.
358 * @param str Source string.
360 basic_string(const basic_string& __str);
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).
367 basic_string(const basic_string& __str, size_type __pos,
368 size_type __n = npos);
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.
376 basic_string(const basic_string& __str, size_type __pos,
377 size_type __n, const _Alloc& __a);
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).
385 * NB: s must have at least n characters, '\0' has no special
388 basic_string(const _CharT* __s, size_type __n,
389 const _Alloc& __a = _Alloc());
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).
395 basic_string(const _CharT* __s, const _Alloc& __a = _Alloc());
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).
402 basic_string(size_type __n, _CharT __c, const _Alloc& __a = _Alloc());
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).
410 template<class _InputIterator>
411 basic_string(_InputIterator __beg, _InputIterator __end,
412 const _Alloc& __a = _Alloc());
415 * @brief Destroy the string instance.
418 { _M_rep()->_M_dispose(this->get_allocator()); }
421 * @brief Assign the value of @a str to this string.
422 * @param str Source string.
425 operator=(const basic_string& __str) { return this->assign(__str); }
428 * @brief Copy contents of @a s into this string.
429 * @param s Source null-terminated string.
432 operator=(const _CharT* __s) { return this->assign(__s); }
435 * @brief Set value to string of length 1.
436 * @param c Source character.
438 * Assigning to a character makes this string length 1 and
439 * (*this)[0] == @a c.
442 operator=(_CharT __c) { return this->assign(1, __c); }
446 * Returns a read/write iterator that points to the first character in
447 * the %string. Unshares the string.
453 return iterator(_M_data());
457 * Returns a read-only (constant) iterator that points to the first
458 * character in the %string.
462 { return const_iterator(_M_data()); }
465 * Returns a read/write iterator that points one past the last
466 * character in the %string. Unshares the string.
472 return iterator(_M_data() + this->size());
476 * Returns a read-only (constant) iterator that points one past the
477 * last character in the %string.
481 { return const_iterator(_M_data() + this->size()); }
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.
490 { return reverse_iterator(this->end()); }
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.
497 const_reverse_iterator
499 { return const_reverse_iterator(this->end()); }
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.
508 { return reverse_iterator(this->begin()); }
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.
515 const_reverse_iterator
517 { return const_reverse_iterator(this->begin()); }
521 /// Returns the number of characters in the string, not including any
522 /// null-termination.
524 size() const { return _M_rep()->_M_length; }
526 /// Returns the number of characters in the string, not including any
527 /// null-termination.
529 length() const { return _M_rep()->_M_length; }
531 /// Returns the size() of the largest possible %string.
533 max_size() const { return _Rep::_S_max_size; }
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.
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.
546 resize(size_type __n, _CharT __c);
549 * @brief Resizes the %string to the specified number of characters.
550 * @param n Number of characters the %string should contain.
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
559 resize(size_type __n) { this->resize(__n, _CharT()); }
562 * Returns the total number of characters that the %string can hold
563 * before needing to allocate more memory.
566 capacity() const { return _M_rep()->_M_capacity; }
569 * @brief Attempt to preallocate enough memory for specified number of
571 * @param n Number of characters required.
572 * @throw std::length_error If @a n exceeds @c max_size().
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
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
586 reserve(size_type __res_arg = 0);
589 * Erases the string, making it empty.
592 clear() { _M_mutate(0, this->size(), 0); }
595 * Returns true if the %string is empty. Equivalent to *this == "".
598 empty() const { return this->size() == 0; }
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.
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
612 operator[] (size_type __pos) const
614 _GLIBCXX_DEBUG_ASSERT(__pos <= size());
615 return _M_data()[__pos];
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.
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.
629 operator[](size_type __pos)
631 _GLIBCXX_DEBUG_ASSERT(__pos < size());
633 return _M_data()[__pos];
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.
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.
647 at(size_type __n) const
649 if (__n >= this->size())
650 __throw_out_of_range(__N("basic_string::at"));
651 return _M_data()[__n];
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.
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.
669 __throw_out_of_range(__N("basic_string::at"));
671 return _M_data()[__n];
676 * @brief Append a string to this string.
677 * @param str The string to append.
678 * @return Reference to this string.
681 operator+=(const basic_string& __str) { return this->append(__str); }
684 * @brief Append a C string.
685 * @param s The C string to append.
686 * @return Reference to this string.
689 operator+=(const _CharT* __s) { return this->append(__s); }
692 * @brief Append a character.
693 * @param s The character to append.
694 * @return Reference to this string.
697 operator+=(_CharT __c) { return this->append(size_type(1), __c); }
700 * @brief Append a string to this string.
701 * @param str The string to append.
702 * @return Reference to this string.
705 append(const basic_string& __str);
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.
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.
720 append(const basic_string& __str, size_type __pos, size_type __n);
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.
729 append(const _CharT* __s, size_type __n);
732 * @brief Append a C string.
733 * @param s The C string to append.
734 * @return Reference to this string.
737 append(const _CharT* __s)
739 __glibcxx_requires_string(__s);
740 return this->append(__s, traits_type::length(__s));
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.
749 * Appends n copies of c to this string.
752 append(size_type __n, _CharT __c)
753 { return _M_replace_aux(this->size(), size_type(0), __n, __c); }
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.
761 * Appends characters in the range [first,last) to this string.
763 template<class _InputIterator>
765 append(_InputIterator __first, _InputIterator __last)
766 { return this->replace(_M_iend(), _M_iend(), __first, __last); }
769 * @brief Append a single character.
770 * @param c Character to append.
773 push_back(_CharT __c)
774 { _M_replace_aux(this->size(), size_type(0), size_type(1), __c); }
777 * @brief Set value to contents of another string.
778 * @param str Source string to use.
779 * @return Reference to this string.
782 assign(const basic_string& __str);
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.
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.
797 assign(const basic_string& __str, size_type __pos, size_type __n)
798 { return this->assign(__str._M_data()
799 + __str._M_check(__pos, "basic_string::assign"),
800 __str._M_limit(__pos, __n)); }
803 * @brief Set value to a C substring.
804 * @param s The C string to use.
805 * @param n Number of characters to use.
806 * @return Reference to this string.
808 * This function sets the value of this string to the first @a n
809 * characters of @a s. If @a n is is larger than the number of
810 * available characters in @a s, the remainder of @a s is used.
813 assign(const _CharT* __s, size_type __n);
816 * @brief Set value to contents of a C string.
817 * @param s The C string to use.
818 * @return Reference to this string.
820 * This function sets the value of this string to the value of @a s.
821 * The data is copied, so there is no dependence on @a s once the
825 assign(const _CharT* __s)
827 __glibcxx_requires_string(__s);
828 return this->assign(__s, traits_type::length(__s));
832 * @brief Set value to multiple characters.
833 * @param n Length of the resulting string.
834 * @param c The character to use.
835 * @return Reference to this string.
837 * This function sets the value of this string to @a n copies of
841 assign(size_type __n, _CharT __c)
842 { return _M_replace_aux(size_type(0), this->size(), __n, __c); }
845 * @brief Set value to a range of characters.
846 * @param first Iterator referencing the first character to append.
847 * @param last Iterator marking the end of the range.
848 * @return Reference to this string.
850 * Sets value of string to characters in the range [first,last).
852 template<class _InputIterator>
854 assign(_InputIterator __first, _InputIterator __last)
855 { return this->replace(_M_ibegin(), _M_iend(), __first, __last); }
858 * @brief Insert multiple characters.
859 * @param p Iterator referencing location in string to insert at.
860 * @param n Number of characters to insert
861 * @param c The character to insert.
862 * @throw std::length_error If new length exceeds @c max_size().
864 * Inserts @a n copies of character @a c starting at the position
865 * referenced by iterator @a p. If adding characters causes the length
866 * to exceed max_size(), length_error is thrown. The value of the
867 * string doesn't change if an error is thrown.
870 insert(iterator __p, size_type __n, _CharT __c)
871 { this->replace(__p, __p, __n, __c); }
874 * @brief Insert a range of characters.
875 * @param p Iterator referencing location in string to insert at.
876 * @param beg Start of range.
877 * @param end End of range.
878 * @throw std::length_error If new length exceeds @c max_size().
880 * Inserts characters in range [beg,end). If adding characters causes
881 * the length to exceed max_size(), length_error is thrown. The value
882 * of the string doesn't change if an error is thrown.
884 template<class _InputIterator>
885 void insert(iterator __p, _InputIterator __beg, _InputIterator __end)
886 { this->replace(__p, __p, __beg, __end); }
889 * @brief Insert value of a string.
890 * @param pos1 Iterator referencing location in string to insert at.
891 * @param str The string to insert.
892 * @return Reference to this string.
893 * @throw std::length_error If new length exceeds @c max_size().
895 * Inserts value of @a str starting at @a pos1. If adding characters
896 * causes the length to exceed max_size(), length_error is thrown. The
897 * value of the string doesn't change if an error is thrown.
900 insert(size_type __pos1, const basic_string& __str)
901 { return this->insert(__pos1, __str, size_type(0), __str.size()); }
904 * @brief Insert a substring.
905 * @param pos1 Iterator referencing location in string to insert at.
906 * @param str The string to insert.
907 * @param pos2 Start of characters in str to insert.
908 * @param n Number of characters to insert.
909 * @return Reference to this string.
910 * @throw std::length_error If new length exceeds @c max_size().
911 * @throw std::out_of_range If @a pos1 > size() or
912 * @a pos2 > @a str.size().
914 * Starting at @a pos1, insert @a n character of @a str beginning with
915 * @a pos2. If adding characters causes the length to exceed
916 * max_size(), length_error is thrown. If @a pos1 is beyond the end of
917 * this string or @a pos2 is beyond the end of @a str, out_of_range is
918 * thrown. The value of the string doesn't change if an error is
922 insert(size_type __pos1, const basic_string& __str,
923 size_type __pos2, size_type __n)
924 { return this->insert(__pos1, __str._M_data()
925 + __str._M_check(__pos2, "basic_string::insert"),
926 __str._M_limit(__pos2, __n)); }
929 * @brief Insert a C substring.
930 * @param pos Iterator referencing location in string to insert at.
931 * @param s The C string to insert.
932 * @param n The number of characters to insert.
933 * @return Reference to this string.
934 * @throw std::length_error If new length exceeds @c max_size().
935 * @throw std::out_of_range If @a pos is beyond the end of this
938 * Inserts the first @a n characters of @a s starting at @a pos. If
939 * adding characters causes the length to exceed max_size(),
940 * length_error is thrown. If @a pos is beyond end(), out_of_range is
941 * thrown. The value of the string doesn't change if an error is
945 insert(size_type __pos, const _CharT* __s, size_type __n);
948 * @brief Insert a C string.
949 * @param pos Iterator referencing location in string to insert at.
950 * @param s The C string to insert.
951 * @return Reference to this string.
952 * @throw std::length_error If new length exceeds @c max_size().
953 * @throw std::out_of_range If @a pos is beyond the end of this
956 * Inserts the first @a n characters of @a s starting at @a pos. If
957 * adding characters causes the length to exceed max_size(),
958 * length_error is thrown. If @a pos is beyond end(), out_of_range is
959 * thrown. The value of the string doesn't change if an error is
963 insert(size_type __pos, const _CharT* __s)
965 __glibcxx_requires_string(__s);
966 return this->insert(__pos, __s, traits_type::length(__s));
970 * @brief Insert multiple characters.
971 * @param pos Index in string to insert at.
972 * @param n Number of characters to insert
973 * @param c The character to insert.
974 * @return Reference to this string.
975 * @throw std::length_error If new length exceeds @c max_size().
976 * @throw std::out_of_range If @a pos is beyond the end of this
979 * Inserts @a n copies of character @a c starting at index @a pos. If
980 * adding characters causes the length to exceed max_size(),
981 * length_error is thrown. If @a pos > length(), out_of_range is
982 * thrown. The value of the string doesn't change if an error is
986 insert(size_type __pos, size_type __n, _CharT __c)
987 { return _M_replace_aux(_M_check(__pos, "basic_string::insert"),
988 size_type(0), __n, __c); }
991 * @brief Insert one character.
992 * @param p Iterator referencing position in string to insert at.
993 * @param c The character to insert.
994 * @return Iterator referencing newly inserted char.
995 * @throw std::length_error If new length exceeds @c max_size().
997 * Inserts character @a c at position referenced by @a p. If adding
998 * character causes the length to exceed max_size(), length_error is
999 * thrown. If @a p is beyond end of string, out_of_range is thrown.
1000 * The value of the string doesn't change if an error is thrown.
1003 insert(iterator __p, _CharT __c)
1005 _GLIBCXX_DEBUG_PEDASSERT(__p >= _M_ibegin() && __p <= _M_iend());
1006 const size_type __pos = __p - _M_ibegin();
1007 _M_replace_aux(__pos, size_type(0), size_type(1), __c);
1008 _M_rep()->_M_set_leaked();
1009 return this->_M_ibegin() + __pos;
1012 #ifdef _GLIBCXX_DEPRECATED
1014 * @brief Insert one default-constructed character.
1015 * @param p Iterator referencing position in string to insert at.
1016 * @return Iterator referencing newly inserted char.
1017 * @throw std::length_error If new length exceeds @c max_size().
1019 * Inserts a default-constructed character at position
1020 * referenced by @a p. If adding character causes the length
1021 * to exceed max_size(), length_error is thrown. If @a p is
1022 * beyond end of string, out_of_range is thrown. The value of
1023 * the string doesn't change if an error is thrown.
1026 insert(iterator __p)
1027 { return this->insert(__p, _CharT()); }
1028 #endif /* _GLIBCXX_DEPRECATED */
1031 * @brief Remove characters.
1032 * @param pos Index of first character to remove (default 0).
1033 * @param n Number of characters to remove (default remainder).
1034 * @return Reference to this string.
1035 * @throw std::out_of_range If @a pos is beyond the end of this
1038 * Removes @a n characters from this string starting at @a pos. The
1039 * length of the string is reduced by @a n. If there are < @a n
1040 * characters to remove, the remainder of the string is truncated. If
1041 * @a p is beyond end of string, out_of_range is thrown. The value of
1042 * the string doesn't change if an error is thrown.
1045 erase(size_type __pos = 0, size_type __n = npos)
1046 { return _M_replace_safe(_M_check(__pos, "basic_string::erase"),
1047 _M_limit(__pos, __n), NULL, size_type(0)); }
1050 * @brief Remove one character.
1051 * @param position Iterator referencing the character to remove.
1052 * @return iterator referencing same location after removal.
1054 * Removes the character at @a position from this string. The value
1055 * of the string doesn't change if an error is thrown.
1058 erase(iterator __position)
1060 _GLIBCXX_DEBUG_PEDASSERT(__position >= _M_ibegin()
1061 && __position < _M_iend());
1062 const size_type __pos = __position - _M_ibegin();
1063 _M_replace_safe(__pos, size_type(1), NULL, size_type(0));
1064 _M_rep()->_M_set_leaked();
1065 return _M_ibegin() + __pos;
1069 * @brief Remove a range of characters.
1070 * @param first Iterator referencing the first character to remove.
1071 * @param last Iterator referencing the end of the range.
1072 * @return Iterator referencing location of first after removal.
1074 * Removes the characters in the range [first,last) from this string.
1075 * The value of the string doesn't change if an error is thrown.
1078 erase(iterator __first, iterator __last)
1080 _GLIBCXX_DEBUG_PEDASSERT(__first >= _M_ibegin() && __first <= __last
1081 && __last <= _M_iend());
1082 const size_type __pos = __first - _M_ibegin();
1083 _M_replace_safe(__pos, __last - __first, NULL, size_type(0));
1084 _M_rep()->_M_set_leaked();
1085 return _M_ibegin() + __pos;
1089 * @brief Replace characters with value from another string.
1090 * @param pos Index of first character to replace.
1091 * @param n Number of characters to be replaced.
1092 * @param str String to insert.
1093 * @return Reference to this string.
1094 * @throw std::out_of_range If @a pos is beyond the end of this
1096 * @throw std::length_error If new length exceeds @c max_size().
1098 * Removes the characters in the range [pos,pos+n) from this string.
1099 * In place, the value of @a str is inserted. If @a pos is beyond end
1100 * of string, out_of_range is thrown. If the length of the result
1101 * exceeds max_size(), length_error is thrown. The value of the string
1102 * doesn't change if an error is thrown.
1105 replace(size_type __pos, size_type __n, const basic_string& __str)
1106 { return this->replace(__pos, __n, __str._M_data(), __str.size()); }
1109 * @brief Replace characters with value from another string.
1110 * @param pos1 Index of first character to replace.
1111 * @param n1 Number of characters to be replaced.
1112 * @param str String to insert.
1113 * @param pos2 Index of first character of str to use.
1114 * @param n2 Number of characters from str to use.
1115 * @return Reference to this string.
1116 * @throw std::out_of_range If @a pos1 > size() or @a pos2 >
1118 * @throw std::length_error If new length exceeds @c max_size().
1120 * Removes the characters in the range [pos1,pos1 + n) from this
1121 * string. In place, the value of @a str is inserted. If @a pos is
1122 * beyond end of string, out_of_range is thrown. If the length of the
1123 * result exceeds max_size(), length_error is thrown. The value of the
1124 * string doesn't change if an error is thrown.
1127 replace(size_type __pos1, size_type __n1, const basic_string& __str,
1128 size_type __pos2, size_type __n2)
1129 { return this->replace(__pos1, __n1, __str._M_data()
1130 + __str._M_check(__pos2, "basic_string::replace"),
1131 __str._M_limit(__pos2, __n2)); }
1134 * @brief Replace characters with value of a C substring.
1135 * @param pos Index of first character to replace.
1136 * @param n1 Number of characters to be replaced.
1137 * @param str C string to insert.
1138 * @param n2 Number of characters from str to use.
1139 * @return Reference to this string.
1140 * @throw std::out_of_range If @a pos1 > size().
1141 * @throw std::length_error If new length exceeds @c max_size().
1143 * Removes the characters in the range [pos,pos + n1) from this string.
1144 * In place, the first @a n2 characters of @a str are inserted, or all
1145 * of @a str if @a n2 is too large. If @a pos is beyond end of string,
1146 * out_of_range is thrown. If the length of result exceeds max_size(),
1147 * length_error is thrown. The value of the string doesn't change if
1148 * an error is thrown.
1151 replace(size_type __pos, size_type __n1, const _CharT* __s,
1155 * @brief Replace characters with value of a C string.
1156 * @param pos Index of first character to replace.
1157 * @param n1 Number of characters to be replaced.
1158 * @param str C string to insert.
1159 * @return Reference to this string.
1160 * @throw std::out_of_range If @a pos > size().
1161 * @throw std::length_error If new length exceeds @c max_size().
1163 * Removes the characters in the range [pos,pos + n1) from this string.
1164 * In place, the first @a n characters of @a str are inserted. If @a
1165 * pos is beyond end of string, out_of_range is thrown. If the length
1166 * of result exceeds max_size(), length_error is thrown. The value of
1167 * the string doesn't change if an error is thrown.
1170 replace(size_type __pos, size_type __n1, const _CharT* __s)
1172 __glibcxx_requires_string(__s);
1173 return this->replace(__pos, __n1, __s, traits_type::length(__s));
1177 * @brief Replace characters with multiple characters.
1178 * @param pos Index of first character to replace.
1179 * @param n1 Number of characters to be replaced.
1180 * @param n2 Number of characters to insert.
1181 * @param c Character to insert.
1182 * @return Reference to this string.
1183 * @throw std::out_of_range If @a pos > size().
1184 * @throw std::length_error If new length exceeds @c max_size().
1186 * Removes the characters in the range [pos,pos + n1) from this string.
1187 * In place, @a n2 copies of @a c are inserted. If @a pos is beyond
1188 * end of string, out_of_range is thrown. If the length of result
1189 * exceeds max_size(), length_error is thrown. The value of the string
1190 * doesn't change if an error is thrown.
1193 replace(size_type __pos, size_type __n1, size_type __n2, _CharT __c)
1194 { return _M_replace_aux(_M_check(__pos, "basic_string::replace"),
1195 _M_limit(__pos, __n1), __n2, __c); }
1198 * @brief Replace range of characters with string.
1199 * @param i1 Iterator referencing start of range to replace.
1200 * @param i2 Iterator referencing end of range to replace.
1201 * @param str String value to insert.
1202 * @return Reference to this string.
1203 * @throw std::length_error If new length exceeds @c max_size().
1205 * Removes the characters in the range [i1,i2). In place, the value of
1206 * @a str is inserted. If the length of result exceeds max_size(),
1207 * length_error is thrown. The value of the string doesn't change if
1208 * an error is thrown.
1211 replace(iterator __i1, iterator __i2, const basic_string& __str)
1213 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1214 && __i2 <= _M_iend());
1215 return this->replace(__i1, __i2, __str._M_data(), __str.size());
1219 * @brief Replace range of characters with C substring.
1220 * @param i1 Iterator referencing start of range to replace.
1221 * @param i2 Iterator referencing end of range to replace.
1222 * @param s C string value to insert.
1223 * @param n Number of characters from s to insert.
1224 * @return Reference to this string.
1225 * @throw std::length_error If new length exceeds @c max_size().
1227 * Removes the characters in the range [i1,i2). In place, the first @a
1228 * n characters of @a s are inserted. If the length of result exceeds
1229 * max_size(), length_error is thrown. The value of the string doesn't
1230 * change if an error is thrown.
1233 replace(iterator __i1, iterator __i2,
1234 const _CharT* __s, size_type __n)
1235 { return this->replace(__i1 - _M_ibegin(), __i2 - __i1, __s, __n); }
1238 * @brief Replace range of characters with C string.
1239 * @param i1 Iterator referencing start of range to replace.
1240 * @param i2 Iterator referencing end of range to replace.
1241 * @param s C string value to insert.
1242 * @return Reference to this string.
1243 * @throw std::length_error If new length exceeds @c max_size().
1245 * Removes the characters in the range [i1,i2). In place, the
1246 * characters of @a s are inserted. If the length of result exceeds
1247 * max_size(), length_error is thrown. The value of the string doesn't
1248 * change if an error is thrown.
1251 replace(iterator __i1, iterator __i2, const _CharT* __s)
1253 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1254 && __i2 <= _M_iend());
1255 __glibcxx_requires_string(__s);
1256 return this->replace(__i1, __i2, __s, traits_type::length(__s));
1260 * @brief Replace range of characters with multiple characters
1261 * @param i1 Iterator referencing start of range to replace.
1262 * @param i2 Iterator referencing end of range to replace.
1263 * @param n Number of characters to insert.
1264 * @param c Character to insert.
1265 * @return Reference to this string.
1266 * @throw std::length_error If new length exceeds @c max_size().
1268 * Removes the characters in the range [i1,i2). In place, @a n copies
1269 * of @a c are inserted. If the length of result exceeds max_size(),
1270 * length_error is thrown. The value of the string doesn't change if
1271 * an error is thrown.
1274 replace(iterator __i1, iterator __i2, size_type __n, _CharT __c)
1276 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1277 && __i2 <= _M_iend());
1278 return _M_replace_aux(__i1 - _M_ibegin(), __i2 - __i1, __n, __c);
1282 * @brief Replace range of characters with range.
1283 * @param i1 Iterator referencing start of range to replace.
1284 * @param i2 Iterator referencing end of range to replace.
1285 * @param k1 Iterator referencing start of range to insert.
1286 * @param k2 Iterator referencing end of range to insert.
1287 * @return Reference to this string.
1288 * @throw std::length_error If new length exceeds @c max_size().
1290 * Removes the characters in the range [i1,i2). In place, characters
1291 * in the range [k1,k2) are inserted. If the length of result exceeds
1292 * max_size(), length_error is thrown. The value of the string doesn't
1293 * change if an error is thrown.
1295 template<class _InputIterator>
1297 replace(iterator __i1, iterator __i2,
1298 _InputIterator __k1, _InputIterator __k2)
1300 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1301 && __i2 <= _M_iend());
1302 __glibcxx_requires_valid_range(__k1, __k2);
1303 typedef typename _Is_integer<_InputIterator>::_Integral _Integral;
1304 return _M_replace_dispatch(__i1, __i2, __k1, __k2, _Integral());
1307 // Specializations for the common case of pointer and iterator:
1308 // useful to avoid the overhead of temporary buffering in _M_replace.
1310 replace(iterator __i1, iterator __i2, _CharT* __k1, _CharT* __k2)
1312 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1313 && __i2 <= _M_iend());
1314 __glibcxx_requires_valid_range(__k1, __k2);
1315 return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1320 replace(iterator __i1, iterator __i2,
1321 const _CharT* __k1, const _CharT* __k2)
1323 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1324 && __i2 <= _M_iend());
1325 __glibcxx_requires_valid_range(__k1, __k2);
1326 return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1331 replace(iterator __i1, iterator __i2, iterator __k1, iterator __k2)
1333 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1334 && __i2 <= _M_iend());
1335 __glibcxx_requires_valid_range(__k1, __k2);
1336 return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1337 __k1.base(), __k2 - __k1);
1341 replace(iterator __i1, iterator __i2,
1342 const_iterator __k1, const_iterator __k2)
1344 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1 && __i1 <= __i2
1345 && __i2 <= _M_iend());
1346 __glibcxx_requires_valid_range(__k1, __k2);
1347 return this->replace(__i1 - _M_ibegin(), __i2 - __i1,
1348 __k1.base(), __k2 - __k1);
1352 template<class _Integer>
1354 _M_replace_dispatch(iterator __i1, iterator __i2, _Integer __n,
1355 _Integer __val, __true_type)
1356 { return _M_replace_aux(__i1 - _M_ibegin(), __i2 - __i1, __n, __val); }
1358 template<class _InputIterator>
1360 _M_replace_dispatch(iterator __i1, iterator __i2, _InputIterator __k1,
1361 _InputIterator __k2, __false_type);
1364 _M_replace_aux(size_type __pos1, size_type __n1, size_type __n2,
1367 if (this->max_size() - (this->size() - __n1) < __n2)
1368 __throw_length_error("basic_string::_M_replace_aux");
1369 _M_mutate(__pos1, __n1, __n2);
1371 traits_type::assign(_M_data() + __pos1, __n2, __c);
1376 _M_replace_safe(size_type __pos1, size_type __n1, const _CharT* __s,
1379 _M_mutate(__pos1, __n1, __n2);
1381 traits_type::copy(_M_data() + __pos1, __s, __n2);
1385 // _S_construct_aux is used to implement the 21.3.1 para 15 which
1386 // requires special behaviour if _InIter is an integral type
1387 template<class _InIterator>
1389 _S_construct_aux(_InIterator __beg, _InIterator __end, const _Alloc& __a,
1392 typedef typename iterator_traits<_InIterator>::iterator_category _Tag;
1393 return _S_construct(__beg, __end, __a, _Tag());
1396 template<class _InIterator>
1398 _S_construct_aux(_InIterator __beg, _InIterator __end, const _Alloc& __a,
1401 return _S_construct(static_cast<size_type>(__beg),
1402 static_cast<value_type>(__end), __a);
1405 template<class _InIterator>
1407 _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a)
1409 typedef typename _Is_integer<_InIterator>::_Integral _Integral;
1410 return _S_construct_aux(__beg, __end, __a, _Integral());
1413 // For Input Iterators, used in istreambuf_iterators, etc.
1414 template<class _InIterator>
1416 _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
1417 input_iterator_tag);
1419 // For forward_iterators up to random_access_iterators, used for
1420 // string::iterator, _CharT*, etc.
1421 template<class _FwdIterator>
1423 _S_construct(_FwdIterator __beg, _FwdIterator __end, const _Alloc& __a,
1424 forward_iterator_tag);
1427 _S_construct(size_type __req, _CharT __c, const _Alloc& __a);
1432 * @brief Copy substring into C string.
1433 * @param s C string to copy value into.
1434 * @param n Number of characters to copy.
1435 * @param pos Index of first character to copy.
1436 * @return Number of characters actually copied
1437 * @throw std::out_of_range If pos > size().
1439 * Copies up to @a n characters starting at @a pos into the C string @a
1440 * s. If @a pos is greater than size(), out_of_range is thrown.
1443 copy(_CharT* __s, size_type __n, size_type __pos = 0) const;
1446 * @brief Swap contents with another string.
1447 * @param s String to swap with.
1449 * Exchanges the contents of this string with that of @a s in constant
1453 swap(basic_string& __s);
1455 // String operations:
1457 * @brief Return const pointer to null-terminated contents.
1459 * This is a handle to internal data. Do not modify or dire things may
1464 { return _M_data(); }
1467 * @brief Return const pointer to contents.
1469 * This is a handle to internal data. It may not be null-terminated.
1470 * Do not modify or dire things may happen.
1473 data() const { return _M_data(); }
1476 * @brief Return copy of allocator used to construct this string.
1479 get_allocator() const { return _M_dataplus; }
1482 * @brief Find position of a C substring.
1483 * @param s C string to locate.
1484 * @param pos Index of character to search from.
1485 * @param n Number of characters from @a s to search for.
1486 * @return Index of start of first occurrence.
1488 * Starting from @a pos, searches forward for the first @a n characters
1489 * in @a s within this string. If found, returns the index where it
1490 * begins. If not found, returns npos.
1493 find(const _CharT* __s, size_type __pos, size_type __n) const;
1496 * @brief Find position of a string.
1497 * @param str String to locate.
1498 * @param pos Index of character to search from (default 0).
1499 * @return Index of start of first occurrence.
1501 * Starting from @a pos, searches forward for value of @a str within
1502 * this string. If found, returns the index where it begins. If not
1503 * found, returns npos.
1506 find(const basic_string& __str, size_type __pos = 0) const
1507 { return this->find(__str.data(), __pos, __str.size()); }
1510 * @brief Find position of a C string.
1511 * @param s C string to locate.
1512 * @param pos Index of character to search from (default 0).
1513 * @return Index of start of first occurrence.
1515 * Starting from @a pos, searches forward for the value of @a s within
1516 * this string. If found, returns the index where it begins. If not
1517 * found, returns npos.
1520 find(const _CharT* __s, size_type __pos = 0) const
1522 __glibcxx_requires_string(__s);
1523 return this->find(__s, __pos, traits_type::length(__s));
1527 * @brief Find position of a character.
1528 * @param c Character to locate.
1529 * @param pos Index of character to search from (default 0).
1530 * @return Index of first occurrence.
1532 * Starting from @a pos, searches forward for @a c within this string.
1533 * If found, returns the index where it was found. If not found,
1537 find(_CharT __c, size_type __pos = 0) const;
1540 * @brief Find last position of a string.
1541 * @param str String to locate.
1542 * @param pos Index of character to search back from (default end).
1543 * @return Index of start of last occurrence.
1545 * Starting from @a pos, searches backward for value of @a str within
1546 * this string. If found, returns the index where it begins. If not
1547 * found, returns npos.
1550 rfind(const basic_string& __str, size_type __pos = npos) const
1551 { return this->rfind(__str.data(), __pos, __str.size()); }
1554 * @brief Find last position of a C substring.
1555 * @param s C string to locate.
1556 * @param pos Index of character to search back from.
1557 * @param n Number of characters from s to search for.
1558 * @return Index of start of last occurrence.
1560 * Starting from @a pos, searches backward for the first @a n
1561 * characters in @a s within this string. If found, returns the index
1562 * where it begins. If not found, returns npos.
1565 rfind(const _CharT* __s, size_type __pos, size_type __n) const;
1568 * @brief Find last position of a C string.
1569 * @param s C string to locate.
1570 * @param pos Index of character to start search at (default 0).
1571 * @return Index of start of last occurrence.
1573 * Starting from @a pos, searches backward for the value of @a s within
1574 * this string. If found, returns the index where it begins. If not
1575 * found, returns npos.
1578 rfind(const _CharT* __s, size_type __pos = npos) const
1580 __glibcxx_requires_string(__s);
1581 return this->rfind(__s, __pos, traits_type::length(__s));
1585 * @brief Find last position of a character.
1586 * @param c Character to locate.
1587 * @param pos Index of character to search back from (default 0).
1588 * @return Index of last occurrence.
1590 * Starting from @a pos, searches backward for @a c within this string.
1591 * If found, returns the index where it was found. If not found,
1595 rfind(_CharT __c, size_type __pos = npos) const;
1598 * @brief Find position of a character of string.
1599 * @param str String containing characters to locate.
1600 * @param pos Index of character to search from (default 0).
1601 * @return Index of first occurrence.
1603 * Starting from @a pos, searches forward for one of the characters of
1604 * @a str within this string. If found, returns the index where it was
1605 * found. If not found, returns npos.
1608 find_first_of(const basic_string& __str, size_type __pos = 0) const
1609 { return this->find_first_of(__str.data(), __pos, __str.size()); }
1612 * @brief Find position of a character of C substring.
1613 * @param s String containing characters to locate.
1614 * @param pos Index of character to search from (default 0).
1615 * @param n Number of characters from s to search for.
1616 * @return Index of first occurrence.
1618 * Starting from @a pos, searches forward for one of the first @a n
1619 * characters of @a s within this string. If found, returns the index
1620 * where it was found. If not found, returns npos.
1623 find_first_of(const _CharT* __s, size_type __pos, size_type __n) const;
1626 * @brief Find position of a character of C string.
1627 * @param s String containing characters to locate.
1628 * @param pos Index of character to search from (default 0).
1629 * @return Index of first occurrence.
1631 * Starting from @a pos, searches forward for one of the characters of
1632 * @a s within this string. If found, returns the index where it was
1633 * found. If not found, returns npos.
1636 find_first_of(const _CharT* __s, size_type __pos = 0) const
1638 __glibcxx_requires_string(__s);
1639 return this->find_first_of(__s, __pos, traits_type::length(__s));
1643 * @brief Find position of a character.
1644 * @param c Character to locate.
1645 * @param pos Index of character to search from (default 0).
1646 * @return Index of first occurrence.
1648 * Starting from @a pos, searches forward for the character @a c within
1649 * this string. If found, returns the index where it was found. If
1650 * not found, returns npos.
1652 * Note: equivalent to find(c, pos).
1655 find_first_of(_CharT __c, size_type __pos = 0) const
1656 { return this->find(__c, __pos); }
1659 * @brief Find last position of a character of string.
1660 * @param str String containing characters to locate.
1661 * @param pos Index of character to search back from (default end).
1662 * @return Index of last occurrence.
1664 * Starting from @a pos, searches backward for one of the characters of
1665 * @a str within this string. If found, returns the index where it was
1666 * found. If not found, returns npos.
1669 find_last_of(const basic_string& __str, size_type __pos = npos) const
1670 { return this->find_last_of(__str.data(), __pos, __str.size()); }
1673 * @brief Find last position of a character of C substring.
1674 * @param s C string containing characters to locate.
1675 * @param pos Index of character to search back from (default end).
1676 * @param n Number of characters from s to search for.
1677 * @return Index of last occurrence.
1679 * Starting from @a pos, searches backward for one of the first @a n
1680 * characters of @a s within this string. If found, returns the index
1681 * where it was found. If not found, returns npos.
1684 find_last_of(const _CharT* __s, size_type __pos, size_type __n) const;
1687 * @brief Find last position of a character of C string.
1688 * @param s C string containing characters to locate.
1689 * @param pos Index of character to search back from (default end).
1690 * @return Index of last occurrence.
1692 * Starting from @a pos, searches backward for one of the characters of
1693 * @a s within this string. If found, returns the index where it was
1694 * found. If not found, returns npos.
1697 find_last_of(const _CharT* __s, size_type __pos = npos) const
1699 __glibcxx_requires_string(__s);
1700 return this->find_last_of(__s, __pos, traits_type::length(__s));
1704 * @brief Find last position of a character.
1705 * @param c Character to locate.
1706 * @param pos Index of character to search back from (default 0).
1707 * @return Index of last occurrence.
1709 * Starting from @a pos, searches backward for @a c within this string.
1710 * If found, returns the index where it was found. If not found,
1713 * Note: equivalent to rfind(c, pos).
1716 find_last_of(_CharT __c, size_type __pos = npos) const
1717 { return this->rfind(__c, __pos); }
1720 * @brief Find position of a character not in string.
1721 * @param str String containing characters to avoid.
1722 * @param pos Index of character to search from (default 0).
1723 * @return Index of first occurrence.
1725 * Starting from @a pos, searches forward for a character not contained
1726 * in @a str within this string. If found, returns the index where it
1727 * was found. If not found, returns npos.
1730 find_first_not_of(const basic_string& __str, size_type __pos = 0) const
1731 { return this->find_first_not_of(__str.data(), __pos, __str.size()); }
1734 * @brief Find position of a character not in C substring.
1735 * @param s C string containing characters to avoid.
1736 * @param pos Index of character to search from (default 0).
1737 * @param n Number of characters from s to consider.
1738 * @return Index of first occurrence.
1740 * Starting from @a pos, searches forward for a character not contained
1741 * in the first @a n characters of @a s within this string. If found,
1742 * returns the index where it was found. If not found, returns npos.
1745 find_first_not_of(const _CharT* __s, size_type __pos,
1746 size_type __n) const;
1749 * @brief Find position of a character not in C string.
1750 * @param s C string containing characters to avoid.
1751 * @param pos Index of character to search from (default 0).
1752 * @return Index of first occurrence.
1754 * Starting from @a pos, searches forward for a character not contained
1755 * in @a s within this string. If found, returns the index where it
1756 * was found. If not found, returns npos.
1759 find_first_not_of(const _CharT* __s, size_type __pos = 0) const
1761 __glibcxx_requires_string(__s);
1762 return this->find_first_not_of(__s, __pos, traits_type::length(__s));
1766 * @brief Find position of a different character.
1767 * @param c Character to avoid.
1768 * @param pos Index of character to search from (default 0).
1769 * @return Index of first occurrence.
1771 * Starting from @a pos, searches forward for a character other than @a c
1772 * within this string. If found, returns the index where it was found.
1773 * If not found, returns npos.
1776 find_first_not_of(_CharT __c, size_type __pos = 0) const;
1779 * @brief Find last position of a character not in string.
1780 * @param str String containing characters to avoid.
1781 * @param pos Index of character to search from (default 0).
1782 * @return Index of first occurrence.
1784 * Starting from @a pos, searches backward for a character not
1785 * contained in @a str within this string. If found, returns the index
1786 * where it was found. If not found, returns npos.
1789 find_last_not_of(const basic_string& __str, size_type __pos = npos) const
1790 { return this->find_last_not_of(__str.data(), __pos, __str.size()); }
1793 * @brief Find last position of a character not in C substring.
1794 * @param s C string containing characters to avoid.
1795 * @param pos Index of character to search from (default 0).
1796 * @param n Number of characters from s to consider.
1797 * @return Index of first occurrence.
1799 * Starting from @a pos, searches backward for a character not
1800 * contained in the first @a n characters of @a s within this string.
1801 * If found, returns the index where it was found. If not found,
1805 find_last_not_of(const _CharT* __s, size_type __pos,
1806 size_type __n) const;
1808 * @brief Find position of a character not in C string.
1809 * @param s C string containing characters to avoid.
1810 * @param pos Index of character to search from (default 0).
1811 * @return Index of first occurrence.
1813 * Starting from @a pos, searches backward for a character not
1814 * contained in @a s within this string. If found, returns the index
1815 * where it was found. If not found, returns npos.
1818 find_last_not_of(const _CharT* __s, size_type __pos = npos) const
1820 __glibcxx_requires_string(__s);
1821 return this->find_last_not_of(__s, __pos, traits_type::length(__s));
1825 * @brief Find last position of a different character.
1826 * @param c Character to avoid.
1827 * @param pos Index of character to search from (default 0).
1828 * @return Index of first occurrence.
1830 * Starting from @a pos, searches backward for a character other than
1831 * @a c within this string. If found, returns the index where it was
1832 * found. If not found, returns npos.
1835 find_last_not_of(_CharT __c, size_type __pos = npos) const;
1838 * @brief Get a substring.
1839 * @param pos Index of first character (default 0).
1840 * @param n Number of characters in substring (default remainder).
1841 * @return The new string.
1842 * @throw std::out_of_range If pos > size().
1844 * Construct and return a new string using the @a n characters starting
1845 * at @a pos. If the string is too short, use the remainder of the
1846 * characters. If @a pos is beyond the end of the string, out_of_range
1850 substr(size_type __pos = 0, size_type __n = npos) const
1851 { return basic_string(*this, _M_check(__pos, "basic_string::substr"), __n); }
1854 * @brief Compare to a string.
1855 * @param str String to compare against.
1856 * @return Integer < 0, 0, or > 0.
1858 * Returns an integer < 0 if this string is ordered before @a str, 0 if
1859 * their values are equivalent, or > 0 if this string is ordered after
1860 * @a str. If the lengths of @a str and this string are different, the
1861 * shorter one is ordered first. If they are the same, returns the
1862 * result of traits::compare(data(),str.data(),size());
1865 compare(const basic_string& __str) const
1867 const size_type __size = this->size();
1868 const size_type __osize = __str.size();
1869 const size_type __len = std::min(__size, __osize);
1871 int __r = traits_type::compare(_M_data(), __str.data(), __len);
1873 __r = __size - __osize;
1878 * @brief Compare substring to a string.
1879 * @param pos Index of first character of substring.
1880 * @param n Number of characters in substring.
1881 * @param str String to compare against.
1882 * @return Integer < 0, 0, or > 0.
1884 * Form the substring of this string from the @a n characters starting
1885 * at @a pos. Returns an integer < 0 if the substring is ordered
1886 * before @a str, 0 if their values are equivalent, or > 0 if the
1887 * substring is ordered after @a str. If the lengths @a of str and the
1888 * substring are different, the shorter one is ordered first. If they
1889 * are the same, returns the result of
1890 * traits::compare(substring.data(),str.data(),size());
1893 compare(size_type __pos, size_type __n, const basic_string& __str) const;
1896 * @brief Compare substring to a substring.
1897 * @param pos1 Index of first character of substring.
1898 * @param n1 Number of characters in substring.
1899 * @param str String to compare against.
1900 * @param pos2 Index of first character of substring of str.
1901 * @param n2 Number of characters in substring of str.
1902 * @return Integer < 0, 0, or > 0.
1904 * Form the substring of this string from the @a n1 characters starting
1905 * at @a pos1. Form the substring of @a str from the @a n2 characters
1906 * starting at @a pos2. Returns an integer < 0 if this substring is
1907 * ordered before the substring of @a str, 0 if their values are
1908 * equivalent, or > 0 if this substring is ordered after the substring
1909 * of @a str. If the lengths of the substring of @a str and this
1910 * substring are different, the shorter one is ordered first. If they
1911 * are the same, returns the result of
1912 * traits::compare(substring.data(),str.substr(pos2,n2).data(),size());
1915 compare(size_type __pos1, size_type __n1, const basic_string& __str,
1916 size_type __pos2, size_type __n2) const;
1919 * @brief Compare to a C string.
1920 * @param s C string to compare against.
1921 * @return Integer < 0, 0, or > 0.
1923 * Returns an integer < 0 if this string is ordered before @a s, 0 if
1924 * their values are equivalent, or > 0 if this string is ordered after
1925 * @a s. If the lengths of @a s and this string are different, the
1926 * shorter one is ordered first. If they are the same, returns the
1927 * result of traits::compare(data(),s,size());
1930 compare(const _CharT* __s) const;
1932 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1933 // 5 String::compare specification questionable
1935 * @brief Compare substring to a C string.
1936 * @param pos Index of first character of substring.
1937 * @param n1 Number of characters in substring.
1938 * @param s C string to compare against.
1939 * @return Integer < 0, 0, or > 0.
1941 * Form the substring of this string from the @a n1 characters starting
1942 * at @a pos. Returns an integer < 0 if the substring is ordered
1943 * before @a s, 0 if their values are equivalent, or > 0 if the
1944 * substring is ordered after @a s. If the lengths of @a s and the
1945 * substring are different, the shorter one is ordered first. If they
1946 * are the same, returns the result of
1947 * traits::compare(substring.data(),s,size());
1950 compare(size_type __pos, size_type __n1, const _CharT* __s) const;
1953 * @brief Compare substring against a character array.
1954 * @param pos1 Index of first character of substring.
1955 * @param n1 Number of characters in substring.
1956 * @param s character array to compare against.
1957 * @param n2 Number of characters of s.
1958 * @return Integer < 0, 0, or > 0.
1960 * Form the substring of this string from the @a n1 characters starting
1961 * at @a pos1. Form a string from the first @a n2 characters of @a s.
1962 * Returns an integer < 0 if this substring is ordered before the string
1963 * from @a s, 0 if their values are equivalent, or > 0 if this substring
1964 * is ordered after the string from @a s. If the lengths of this substring
1965 * and @a n2 are different, the shorter one is ordered first. If they are
1966 * the same, returns the result of traits::compare(substring.data(),s,size());
1968 * NB: s must have at least n2 characters, '\0' has no special
1972 compare(size_type __pos, size_type __n1, const _CharT* __s,
1973 size_type __n2) const;
1977 template<typename _CharT, typename _Traits, typename _Alloc>
1978 inline basic_string<_CharT, _Traits, _Alloc>::
1980 : _M_dataplus(_S_empty_rep()._M_refdata(), _Alloc()) { }
1984 * @brief Concatenate two strings.
1985 * @param lhs First string.
1986 * @param rhs Last string.
1987 * @return New string with value of @a lhs followed by @a rhs.
1989 template<typename _CharT, typename _Traits, typename _Alloc>
1990 basic_string<_CharT, _Traits, _Alloc>
1991 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
1992 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
1994 basic_string<_CharT, _Traits, _Alloc> __str(__lhs);
1995 __str.append(__rhs);
2000 * @brief Concatenate C string and string.
2001 * @param lhs First string.
2002 * @param rhs Last string.
2003 * @return New string with value of @a lhs followed by @a rhs.
2005 template<typename _CharT, typename _Traits, typename _Alloc>
2006 basic_string<_CharT,_Traits,_Alloc>
2007 operator+(const _CharT* __lhs,
2008 const basic_string<_CharT,_Traits,_Alloc>& __rhs);
2011 * @brief Concatenate character and string.
2012 * @param lhs First string.
2013 * @param rhs Last string.
2014 * @return New string with @a lhs followed by @a rhs.
2016 template<typename _CharT, typename _Traits, typename _Alloc>
2017 basic_string<_CharT,_Traits,_Alloc>
2018 operator+(_CharT __lhs, const basic_string<_CharT,_Traits,_Alloc>& __rhs);
2021 * @brief Concatenate string and C string.
2022 * @param lhs First string.
2023 * @param rhs Last string.
2024 * @return New string with @a lhs followed by @a rhs.
2026 template<typename _CharT, typename _Traits, typename _Alloc>
2027 inline basic_string<_CharT, _Traits, _Alloc>
2028 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2029 const _CharT* __rhs)
2031 basic_string<_CharT, _Traits, _Alloc> __str(__lhs);
2032 __str.append(__rhs);
2037 * @brief Concatenate string and character.
2038 * @param lhs First string.
2039 * @param rhs Last string.
2040 * @return New string with @a lhs followed by @a rhs.
2042 template<typename _CharT, typename _Traits, typename _Alloc>
2043 inline basic_string<_CharT, _Traits, _Alloc>
2044 operator+(const basic_string<_CharT, _Traits, _Alloc>& __lhs, _CharT __rhs)
2046 typedef basic_string<_CharT, _Traits, _Alloc> __string_type;
2047 typedef typename __string_type::size_type __size_type;
2048 __string_type __str(__lhs);
2049 __str.append(__size_type(1), __rhs);
2055 * @brief Test equivalence of two strings.
2056 * @param lhs First string.
2057 * @param rhs Second string.
2058 * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
2060 template<typename _CharT, typename _Traits, typename _Alloc>
2062 operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2063 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2064 { return __lhs.compare(__rhs) == 0; }
2067 * @brief Test equivalence of C string and string.
2068 * @param lhs C string.
2069 * @param rhs String.
2070 * @return True if @a rhs.compare(@a lhs) == 0. False otherwise.
2072 template<typename _CharT, typename _Traits, typename _Alloc>
2074 operator==(const _CharT* __lhs,
2075 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2076 { return __rhs.compare(__lhs) == 0; }
2079 * @brief Test equivalence of string and C string.
2080 * @param lhs String.
2081 * @param rhs C string.
2082 * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
2084 template<typename _CharT, typename _Traits, typename _Alloc>
2086 operator==(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2087 const _CharT* __rhs)
2088 { return __lhs.compare(__rhs) == 0; }
2092 * @brief Test difference of two strings.
2093 * @param lhs First string.
2094 * @param rhs Second string.
2095 * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
2097 template<typename _CharT, typename _Traits, typename _Alloc>
2099 operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2100 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2101 { return __rhs.compare(__lhs) != 0; }
2104 * @brief Test difference of C string and string.
2105 * @param lhs C string.
2106 * @param rhs String.
2107 * @return True if @a rhs.compare(@a lhs) != 0. False otherwise.
2109 template<typename _CharT, typename _Traits, typename _Alloc>
2111 operator!=(const _CharT* __lhs,
2112 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2113 { return __rhs.compare(__lhs) != 0; }
2116 * @brief Test difference of string and C string.
2117 * @param lhs String.
2118 * @param rhs C string.
2119 * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
2121 template<typename _CharT, typename _Traits, typename _Alloc>
2123 operator!=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2124 const _CharT* __rhs)
2125 { return __lhs.compare(__rhs) != 0; }
2129 * @brief Test if string precedes string.
2130 * @param lhs First string.
2131 * @param rhs Second string.
2132 * @return True if @a lhs precedes @a rhs. False otherwise.
2134 template<typename _CharT, typename _Traits, typename _Alloc>
2136 operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2137 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2138 { return __lhs.compare(__rhs) < 0; }
2141 * @brief Test if string precedes C string.
2142 * @param lhs String.
2143 * @param rhs C string.
2144 * @return True if @a lhs precedes @a rhs. False otherwise.
2146 template<typename _CharT, typename _Traits, typename _Alloc>
2148 operator<(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2149 const _CharT* __rhs)
2150 { return __lhs.compare(__rhs) < 0; }
2153 * @brief Test if C string precedes string.
2154 * @param lhs C string.
2155 * @param rhs String.
2156 * @return True if @a lhs precedes @a rhs. False otherwise.
2158 template<typename _CharT, typename _Traits, typename _Alloc>
2160 operator<(const _CharT* __lhs,
2161 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2162 { return __rhs.compare(__lhs) > 0; }
2166 * @brief Test if string follows string.
2167 * @param lhs First string.
2168 * @param rhs Second string.
2169 * @return True if @a lhs follows @a rhs. False otherwise.
2171 template<typename _CharT, typename _Traits, typename _Alloc>
2173 operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2174 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2175 { return __lhs.compare(__rhs) > 0; }
2178 * @brief Test if string follows C string.
2179 * @param lhs String.
2180 * @param rhs C string.
2181 * @return True if @a lhs follows @a rhs. False otherwise.
2183 template<typename _CharT, typename _Traits, typename _Alloc>
2185 operator>(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2186 const _CharT* __rhs)
2187 { return __lhs.compare(__rhs) > 0; }
2190 * @brief Test if C string follows string.
2191 * @param lhs C string.
2192 * @param rhs String.
2193 * @return True if @a lhs follows @a rhs. False otherwise.
2195 template<typename _CharT, typename _Traits, typename _Alloc>
2197 operator>(const _CharT* __lhs,
2198 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2199 { return __rhs.compare(__lhs) < 0; }
2203 * @brief Test if string doesn't follow string.
2204 * @param lhs First string.
2205 * @param rhs Second string.
2206 * @return True if @a lhs doesn't follow @a rhs. False otherwise.
2208 template<typename _CharT, typename _Traits, typename _Alloc>
2210 operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2211 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2212 { return __lhs.compare(__rhs) <= 0; }
2215 * @brief Test if string doesn't follow C string.
2216 * @param lhs String.
2217 * @param rhs C string.
2218 * @return True if @a lhs doesn't follow @a rhs. False otherwise.
2220 template<typename _CharT, typename _Traits, typename _Alloc>
2222 operator<=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2223 const _CharT* __rhs)
2224 { return __lhs.compare(__rhs) <= 0; }
2227 * @brief Test if C string doesn't follow string.
2228 * @param lhs C string.
2229 * @param rhs String.
2230 * @return True if @a lhs doesn't follow @a rhs. False otherwise.
2232 template<typename _CharT, typename _Traits, typename _Alloc>
2234 operator<=(const _CharT* __lhs,
2235 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2236 { return __rhs.compare(__lhs) >= 0; }
2240 * @brief Test if string doesn't precede string.
2241 * @param lhs First string.
2242 * @param rhs Second string.
2243 * @return True if @a lhs doesn't precede @a rhs. False otherwise.
2245 template<typename _CharT, typename _Traits, typename _Alloc>
2247 operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2248 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2249 { return __lhs.compare(__rhs) >= 0; }
2252 * @brief Test if string doesn't precede C string.
2253 * @param lhs String.
2254 * @param rhs C string.
2255 * @return True if @a lhs doesn't precede @a rhs. False otherwise.
2257 template<typename _CharT, typename _Traits, typename _Alloc>
2259 operator>=(const basic_string<_CharT, _Traits, _Alloc>& __lhs,
2260 const _CharT* __rhs)
2261 { return __lhs.compare(__rhs) >= 0; }
2264 * @brief Test if C string doesn't precede string.
2265 * @param lhs C string.
2266 * @param rhs String.
2267 * @return True if @a lhs doesn't precede @a rhs. False otherwise.
2269 template<typename _CharT, typename _Traits, typename _Alloc>
2271 operator>=(const _CharT* __lhs,
2272 const basic_string<_CharT, _Traits, _Alloc>& __rhs)
2273 { return __rhs.compare(__lhs) <= 0; }
2276 * @brief Swap contents of two strings.
2277 * @param lhs First string.
2278 * @param rhs Second string.
2280 * Exchanges the contents of @a lhs and @a rhs in constant time.
2282 template<typename _CharT, typename _Traits, typename _Alloc>
2284 swap(basic_string<_CharT, _Traits, _Alloc>& __lhs,
2285 basic_string<_CharT, _Traits, _Alloc>& __rhs)
2286 { __lhs.swap(__rhs); }
2289 * @brief Read stream into a string.
2290 * @param is Input stream.
2291 * @param str Buffer to store into.
2292 * @return Reference to the input stream.
2294 * Stores characters from @a is into @a str until whitespace is found, the
2295 * end of the stream is encountered, or str.max_size() is reached. If
2296 * is.width() is non-zero, that is the limit on the number of characters
2297 * stored into @a str. Any previous contents of @a str are erased.
2299 template<typename _CharT, typename _Traits, typename _Alloc>
2300 basic_istream<_CharT, _Traits>&
2301 operator>>(basic_istream<_CharT, _Traits>& __is,
2302 basic_string<_CharT, _Traits, _Alloc>& __str);
2305 * @brief Write string to a stream.
2306 * @param os Output stream.
2307 * @param str String to write out.
2308 * @return Reference to the output stream.
2310 * Output characters of @a str into os following the same rules as for
2311 * writing a C string.
2313 template<typename _CharT, typename _Traits, typename _Alloc>
2314 basic_ostream<_CharT, _Traits>&
2315 operator<<(basic_ostream<_CharT, _Traits>& __os,
2316 const basic_string<_CharT, _Traits, _Alloc>& __str);
2319 * @brief Read a line from stream into a string.
2320 * @param is Input stream.
2321 * @param str Buffer to store into.
2322 * @param delim Character marking end of line.
2323 * @return Reference to the input stream.
2325 * Stores characters from @a is into @a str until @a delim is found, the
2326 * end of the stream is encountered, or str.max_size() is reached. If
2327 * is.width() is non-zero, that is the limit on the number of characters
2328 * stored into @a str. Any previous contents of @a str are erased. If @a
2329 * delim was encountered, it is extracted but not stored into @a str.
2331 template<typename _CharT, typename _Traits, typename _Alloc>
2332 basic_istream<_CharT,_Traits>&
2333 getline(basic_istream<_CharT, _Traits>& __is,
2334 basic_string<_CharT, _Traits, _Alloc>& __str, _CharT __delim);
2337 * @brief Read a line from stream into a string.
2338 * @param is Input stream.
2339 * @param str Buffer to store into.
2340 * @return Reference to the input stream.
2342 * Stores characters from is into @a str until '\n' is found, the end of
2343 * the stream is encountered, or str.max_size() is reached. If is.width()
2344 * is non-zero, that is the limit on the number of characters stored into
2345 * @a str. Any previous contents of @a str are erased. If end of line was
2346 * encountered, it is extracted but not stored into @a str.
2348 template<typename _CharT, typename _Traits, typename _Alloc>
2349 inline basic_istream<_CharT,_Traits>&
2350 getline(basic_istream<_CharT, _Traits>& __is,
2351 basic_string<_CharT, _Traits, _Alloc>& __str);
2354 #endif /* _BASIC_STRING_H */