1 // Components for manipulating sequences of characters -*- C++ -*-
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
4 // 2006, 2007, 2008, 2009, 2010
5 // Free Software Foundation, Inc.
7 // This file is part of the GNU ISO C++ Library. This library is free
8 // software; you can redistribute it and/or modify it under the
9 // terms of the GNU General Public License as published by the
10 // Free Software Foundation; either version 3, or (at your option)
13 // This library is distributed in the hope that it will be useful,
14 // but WITHOUT ANY WARRANTY; without even the implied warranty of
15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 // GNU General Public License for more details.
18 // Under Section 7 of GPL version 3, you are granted additional
19 // permissions described in the GCC Runtime Library Exception, version
20 // 3.1, as published by the Free Software Foundation.
22 // You should have received a copy of the GNU General Public License and
23 // a copy of the GCC Runtime Library Exception along with this program;
24 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
25 // <http://www.gnu.org/licenses/>.
27 /** @file basic_string.h
28 * This is an internal header file, included by other library headers.
29 * You should not attempt to use it directly.
33 // ISO C++ 14882: 21 Strings library
36 #ifndef _BASIC_STRING_H
37 #define _BASIC_STRING_H 1
39 #pragma GCC system_header
41 #include <ext/atomicity.h>
42 #include <debug/debug.h>
43 #include <initializer_list>
45 _GLIBCXX_BEGIN_NAMESPACE(std
)
48 * @class basic_string basic_string.h <string>
49 * @brief Managing sequences of characters and character-like objects.
54 * Meets the requirements of a <a href="tables.html#65">container</a>, a
55 * <a href="tables.html#66">reversible container</a>, and a
56 * <a href="tables.html#67">sequence</a>. Of the
57 * <a href="tables.html#68">optional sequence requirements</a>, only
58 * @c push_back, @c at, and @c %array access are supported.
63 * Documentation? What's that?
64 * Nathan Myers <ncm@cantrip.org>.
66 * A string looks like this:
71 * [basic_string<char_type>] _M_capacity
72 * _M_dataplus _M_refcount
73 * _M_p ----------------> unnamed array of char_type
76 * Where the _M_p points to the first character in the string, and
77 * you cast it to a pointer-to-_Rep and subtract 1 to get a
78 * pointer to the header.
80 * This approach has the enormous advantage that a string object
81 * requires only one allocation. All the ugliness is confined
82 * within a single %pair of inline functions, which each compile to
83 * a single @a add instruction: _Rep::_M_data(), and
84 * string::_M_rep(); and the allocation function which gets a
85 * block of raw bytes and with room enough and constructs a _Rep
86 * object at the front.
88 * The reason you want _M_data pointing to the character %array and
89 * not the _Rep is so that the debugger can see the string
90 * contents. (Probably we should add a non-inline member to get
91 * the _Rep for the debugger to use, so users can check the actual
94 * Note that the _Rep object is a POD so that you can have a
95 * static <em>empty string</em> _Rep object already @a constructed before
96 * static constructors have run. The reference-count encoding is
97 * chosen so that a 0 indicates one reference, so you never try to
98 * destroy the empty-string _Rep object.
100 * All but the last paragraph is considered pretty conventional
101 * for a C++ string implementation.
103 // 21.3 Template class basic_string
104 template<typename _CharT
, typename _Traits
, typename _Alloc
>
107 typedef typename
_Alloc::template rebind
<_CharT
>::other _CharT_alloc_type
;
111 typedef _Traits traits_type
;
112 typedef typename
_Traits::char_type value_type
;
113 typedef _Alloc allocator_type
;
114 typedef typename
_CharT_alloc_type::size_type size_type
;
115 typedef typename
_CharT_alloc_type::difference_type difference_type
;
116 typedef typename
_CharT_alloc_type::reference reference
;
117 typedef typename
_CharT_alloc_type::const_reference const_reference
;
118 typedef typename
_CharT_alloc_type::pointer pointer
;
119 typedef typename
_CharT_alloc_type::const_pointer const_pointer
;
120 typedef __gnu_cxx::__normal_iterator
<pointer
, basic_string
> iterator
;
121 typedef __gnu_cxx::__normal_iterator
<const_pointer
, basic_string
>
123 typedef std::reverse_iterator
<const_iterator
> const_reverse_iterator
;
124 typedef std::reverse_iterator
<iterator
> reverse_iterator
;
127 // _Rep: string representation
129 // 1. String really contains _M_length + 1 characters: due to 21.3.4
130 // must be kept null-terminated.
131 // 2. _M_capacity >= _M_length
132 // Allocated memory is always (_M_capacity + 1) * sizeof(_CharT).
133 // 3. _M_refcount has three states:
134 // -1: leaked, one reference, no ref-copies allowed, non-const.
135 // 0: one reference, non-const.
136 // n>0: n + 1 references, operations require a lock, const.
137 // 4. All fields==0 is an empty string, given the extra storage
138 // beyond-the-end for a null terminator; thus, the shared
139 // empty string representation needs no constructor.
144 size_type _M_capacity
;
145 _Atomic_word _M_refcount
;
148 struct _Rep
: _Rep_base
151 typedef typename
_Alloc::template rebind
<char>::other _Raw_bytes_alloc
;
153 // (Public) Data members:
155 // The maximum number of individual char_type elements of an
156 // individual string is determined by _S_max_size. This is the
157 // value that will be returned by max_size(). (Whereas npos
158 // is the maximum number of bytes the allocator can allocate.)
159 // If one was to divvy up the theoretical largest size string,
160 // with a terminating character and m _CharT elements, it'd
162 // npos = sizeof(_Rep) + (m * sizeof(_CharT)) + sizeof(_CharT)
164 // m = ((npos - sizeof(_Rep))/sizeof(CharT)) - 1
165 // In addition, this implementation quarters this amount.
166 static const size_type _S_max_size
;
167 static const _CharT _S_terminal
;
169 // The following storage is init'd to 0 by the linker, resulting
170 // (carefully) in an empty string with one reference.
171 static size_type _S_empty_rep_storage
[];
176 // NB: Mild hack to avoid strict-aliasing warnings. Note that
177 // _S_empty_rep_storage is never modified and the punning should
178 // be reasonably safe in this case.
179 void* __p
= reinterpret_cast<void*>(&_S_empty_rep_storage
);
180 return *reinterpret_cast<_Rep
*>(__p
);
185 { return this->_M_refcount
< 0; }
189 { return this->_M_refcount
> 0; }
193 { this->_M_refcount
= -1; }
197 { this->_M_refcount
= 0; }
200 _M_set_length_and_sharable(size_type __n
)
202 #ifndef _GLIBCXX_FULLY_DYNAMIC_STRING
203 if (__builtin_expect(this != &_S_empty_rep(), false))
206 this->_M_set_sharable(); // One reference.
207 this->_M_length
= __n
;
208 traits_type::assign(this->_M_refdata()[__n
], _S_terminal
);
209 // grrr. (per 21.3.4)
210 // You cannot leave those LWG people alone for a second.
216 { return reinterpret_cast<_CharT
*>(this + 1); }
219 _M_grab(const _Alloc
& __alloc1
, const _Alloc
& __alloc2
)
221 return (!_M_is_leaked() && __alloc1
== __alloc2
)
222 ? _M_refcopy() : _M_clone(__alloc1
);
227 _S_create(size_type
, size_type
, const _Alloc
&);
230 _M_dispose(const _Alloc
& __a
)
232 #ifndef _GLIBCXX_FULLY_DYNAMIC_STRING
233 if (__builtin_expect(this != &_S_empty_rep(), false))
235 if (__gnu_cxx::__exchange_and_add_dispatch(&this->_M_refcount
,
241 _M_destroy(const _Alloc
&) throw();
246 #ifndef _GLIBCXX_FULLY_DYNAMIC_STRING
247 if (__builtin_expect(this != &_S_empty_rep(), false))
249 __gnu_cxx::__atomic_add_dispatch(&this->_M_refcount
, 1);
254 _M_clone(const _Alloc
&, size_type __res
= 0);
257 // Use empty-base optimization: http://www.cantrip.org/emptyopt.html
258 struct _Alloc_hider
: _Alloc
260 _Alloc_hider(_CharT
* __dat
, const _Alloc
& __a
)
261 : _Alloc(__a
), _M_p(__dat
) { }
263 _CharT
* _M_p
; // The actual data.
267 // Data Members (public):
268 // NB: This is an unsigned type, and thus represents the maximum
269 // size that the allocator can hold.
270 /// Value returned by various member functions when they fail.
271 static const size_type npos
= static_cast<size_type
>(-1);
274 // Data Members (private):
275 mutable _Alloc_hider _M_dataplus
;
279 { return _M_dataplus
._M_p
; }
283 { return (_M_dataplus
._M_p
= __p
); }
287 { return &((reinterpret_cast<_Rep
*> (_M_data()))[-1]); }
289 // For the internal use we have functions similar to `begin'/`end'
290 // but they do not call _M_leak.
293 { return iterator(_M_data()); }
297 { return iterator(_M_data() + this->size()); }
300 _M_leak() // for use in begin() & non-const op[]
302 if (!_M_rep()->_M_is_leaked())
307 _M_check(size_type __pos
, const char* __s
) const
309 if (__pos
> this->size())
310 __throw_out_of_range(__N(__s
));
315 _M_check_length(size_type __n1
, size_type __n2
, const char* __s
) const
317 if (this->max_size() - (this->size() - __n1
) < __n2
)
318 __throw_length_error(__N(__s
));
321 // NB: _M_limit doesn't check for a bad __pos value.
323 _M_limit(size_type __pos
, size_type __off
) const
325 const bool __testoff
= __off
< this->size() - __pos
;
326 return __testoff
? __off
: this->size() - __pos
;
329 // True if _Rep and source do not overlap.
331 _M_disjunct(const _CharT
* __s
) const
333 return (less
<const _CharT
*>()(__s
, _M_data())
334 || less
<const _CharT
*>()(_M_data() + this->size(), __s
));
337 // When __n = 1 way faster than the general multichar
338 // traits_type::copy/move/assign.
340 _M_copy(_CharT
* __d
, const _CharT
* __s
, size_type __n
)
343 traits_type::assign(*__d
, *__s
);
345 traits_type::copy(__d
, __s
, __n
);
349 _M_move(_CharT
* __d
, const _CharT
* __s
, size_type __n
)
352 traits_type::assign(*__d
, *__s
);
354 traits_type::move(__d
, __s
, __n
);
358 _M_assign(_CharT
* __d
, size_type __n
, _CharT __c
)
361 traits_type::assign(*__d
, __c
);
363 traits_type::assign(__d
, __n
, __c
);
366 // _S_copy_chars is a separate template to permit specialization
367 // to optimize for the common case of pointers as iterators.
368 template<class _Iterator
>
370 _S_copy_chars(_CharT
* __p
, _Iterator __k1
, _Iterator __k2
)
372 for (; __k1
!= __k2
; ++__k1
, ++__p
)
373 traits_type::assign(*__p
, *__k1
); // These types are off.
377 _S_copy_chars(_CharT
* __p
, iterator __k1
, iterator __k2
)
378 { _S_copy_chars(__p
, __k1
.base(), __k2
.base()); }
381 _S_copy_chars(_CharT
* __p
, const_iterator __k1
, const_iterator __k2
)
382 { _S_copy_chars(__p
, __k1
.base(), __k2
.base()); }
385 _S_copy_chars(_CharT
* __p
, _CharT
* __k1
, _CharT
* __k2
)
386 { _M_copy(__p
, __k1
, __k2
- __k1
); }
389 _S_copy_chars(_CharT
* __p
, const _CharT
* __k1
, const _CharT
* __k2
)
390 { _M_copy(__p
, __k1
, __k2
- __k1
); }
393 _S_compare(size_type __n1
, size_type __n2
)
395 const difference_type __d
= difference_type(__n1
- __n2
);
397 if (__d
> __gnu_cxx::__numeric_traits
<int>::__max
)
398 return __gnu_cxx::__numeric_traits
<int>::__max
;
399 else if (__d
< __gnu_cxx::__numeric_traits
<int>::__min
)
400 return __gnu_cxx::__numeric_traits
<int>::__min
;
406 _M_mutate(size_type __pos
, size_type __len1
, size_type __len2
);
413 { return _Rep::_S_empty_rep(); }
416 // Construct/copy/destroy:
417 // NB: We overload ctors in some cases instead of using default
418 // arguments, per 17.4.4.4 para. 2 item 2.
421 * @brief Default constructor creates an empty string.
424 #ifndef _GLIBCXX_FULLY_DYNAMIC_STRING
425 : _M_dataplus(_S_empty_rep()._M_refdata(), _Alloc()) { }
427 : _M_dataplus(_S_construct(size_type(), _CharT(), _Alloc()), _Alloc()){ }
431 * @brief Construct an empty string using allocator @a a.
434 basic_string(const _Alloc
& __a
);
436 // NB: per LWG issue 42, semantics different from IS:
438 * @brief Construct string with copy of value of @a str.
439 * @param str Source string.
441 basic_string(const basic_string
& __str
);
443 * @brief Construct string as copy of a substring.
444 * @param str Source string.
445 * @param pos Index of first character to copy from.
446 * @param n Number of characters to copy (default remainder).
448 basic_string(const basic_string
& __str
, size_type __pos
,
449 size_type __n
= npos
);
451 * @brief Construct string as copy of a substring.
452 * @param str Source string.
453 * @param pos Index of first character to copy from.
454 * @param n Number of characters to copy.
455 * @param a Allocator to use.
457 basic_string(const basic_string
& __str
, size_type __pos
,
458 size_type __n
, const _Alloc
& __a
);
461 * @brief Construct string initialized by a character %array.
462 * @param s Source character %array.
463 * @param n Number of characters to copy.
464 * @param a Allocator to use (default is default allocator).
466 * NB: @a s must have at least @a n characters, '\\0'
467 * has no special meaning.
469 basic_string(const _CharT
* __s
, size_type __n
,
470 const _Alloc
& __a
= _Alloc());
472 * @brief Construct string as copy of a C string.
473 * @param s Source C string.
474 * @param a Allocator to use (default is default allocator).
476 basic_string(const _CharT
* __s
, const _Alloc
& __a
= _Alloc());
478 * @brief Construct string as multiple characters.
479 * @param n Number of characters.
480 * @param c Character to use.
481 * @param a Allocator to use (default is default allocator).
483 basic_string(size_type __n
, _CharT __c
, const _Alloc
& __a
= _Alloc());
485 #ifdef __GXX_EXPERIMENTAL_CXX0X__
487 * @brief Move construct string.
488 * @param str Source string.
490 * The newly-created string contains the exact contents of @a str.
491 * @a str is a valid, but unspecified string.
493 basic_string(basic_string
&& __str
)
494 : _M_dataplus(__str
._M_dataplus
)
496 #ifndef _GLIBCXX_FULLY_DYNAMIC_STRING
497 __str
._M_data(_S_empty_rep()._M_refdata());
499 __str
._M_data(_S_construct(size_type(), _CharT(), get_allocator()));
504 * @brief Construct string from an initializer %list.
505 * @param l std::initializer_list of characters.
506 * @param a Allocator to use (default is default allocator).
508 basic_string(initializer_list
<_CharT
> __l
, const _Alloc
& __a
= _Alloc());
509 #endif // __GXX_EXPERIMENTAL_CXX0X__
512 * @brief Construct string as copy of a range.
513 * @param beg Start of range.
514 * @param end End of range.
515 * @param a Allocator to use (default is default allocator).
517 template<class _InputIterator
>
518 basic_string(_InputIterator __beg
, _InputIterator __end
,
519 const _Alloc
& __a
= _Alloc());
522 * @brief Destroy the string instance.
525 { _M_rep()->_M_dispose(this->get_allocator()); }
528 * @brief Assign the value of @a str to this string.
529 * @param str Source string.
532 operator=(const basic_string
& __str
)
533 { return this->assign(__str
); }
536 * @brief Copy contents of @a s into this string.
537 * @param s Source null-terminated string.
540 operator=(const _CharT
* __s
)
541 { return this->assign(__s
); }
544 * @brief Set value to string of length 1.
545 * @param c Source character.
547 * Assigning to a character makes this string length 1 and
548 * (*this)[0] == @a c.
551 operator=(_CharT __c
)
553 this->assign(1, __c
);
557 #ifdef __GXX_EXPERIMENTAL_CXX0X__
559 * @brief Move assign the value of @a str to this string.
560 * @param str Source string.
562 * The contents of @a str are moved into this string (without copying).
563 * @a str is a valid, but unspecified string.
566 operator=(basic_string
&& __str
)
574 * @brief Set value to string constructed from initializer %list.
575 * @param l std::initializer_list.
578 operator=(initializer_list
<_CharT
> __l
)
580 this->assign(__l
.begin(), __l
.size());
583 #endif // __GXX_EXPERIMENTAL_CXX0X__
587 * Returns a read/write iterator that points to the first character in
588 * the %string. Unshares the string.
594 return iterator(_M_data());
598 * Returns a read-only (constant) iterator that points to the first
599 * character in the %string.
603 { return const_iterator(_M_data()); }
606 * Returns a read/write iterator that points one past the last
607 * character in the %string. Unshares the string.
613 return iterator(_M_data() + this->size());
617 * Returns a read-only (constant) iterator that points one past the
618 * last character in the %string.
622 { return const_iterator(_M_data() + this->size()); }
625 * Returns a read/write reverse iterator that points to the last
626 * character in the %string. Iteration is done in reverse element
627 * order. Unshares the string.
631 { return reverse_iterator(this->end()); }
634 * Returns a read-only (constant) reverse iterator that points
635 * to the last character in the %string. Iteration is done in
636 * reverse element order.
638 const_reverse_iterator
640 { return const_reverse_iterator(this->end()); }
643 * Returns a read/write reverse iterator that points to one before the
644 * first character in the %string. Iteration is done in reverse
645 * element order. Unshares the string.
649 { return reverse_iterator(this->begin()); }
652 * Returns a read-only (constant) reverse iterator that points
653 * to one before the first character in the %string. Iteration
654 * is done in reverse element order.
656 const_reverse_iterator
658 { return const_reverse_iterator(this->begin()); }
660 #ifdef __GXX_EXPERIMENTAL_CXX0X__
662 * Returns a read-only (constant) iterator that points to the first
663 * character in the %string.
667 { return const_iterator(this->_M_data()); }
670 * Returns a read-only (constant) iterator that points one past the
671 * last character in the %string.
675 { return const_iterator(this->_M_data() + this->size()); }
678 * Returns a read-only (constant) reverse iterator that points
679 * to the last character in the %string. Iteration is done in
680 * reverse element order.
682 const_reverse_iterator
684 { return const_reverse_iterator(this->end()); }
687 * Returns a read-only (constant) reverse iterator that points
688 * to one before the first character in the %string. Iteration
689 * is done in reverse element order.
691 const_reverse_iterator
693 { return const_reverse_iterator(this->begin()); }
698 /// Returns the number of characters in the string, not including any
699 /// null-termination.
702 { return _M_rep()->_M_length
; }
704 /// Returns the number of characters in the string, not including any
705 /// null-termination.
708 { return _M_rep()->_M_length
; }
710 /// Returns the size() of the largest possible %string.
713 { return _Rep::_S_max_size
; }
716 * @brief Resizes the %string to the specified number of characters.
717 * @param n Number of characters the %string should contain.
718 * @param c Character to fill any new elements.
720 * This function will %resize the %string to the specified
721 * number of characters. If the number is smaller than the
722 * %string's current size the %string is truncated, otherwise
723 * the %string is extended and new elements are %set to @a c.
726 resize(size_type __n
, _CharT __c
);
729 * @brief Resizes the %string to the specified number of characters.
730 * @param n Number of characters the %string should contain.
732 * This function will resize the %string to the specified length. If
733 * the new size is smaller than the %string's current size the %string
734 * is truncated, otherwise the %string is extended and new characters
735 * are default-constructed. For basic types such as char, this means
739 resize(size_type __n
)
740 { this->resize(__n
, _CharT()); }
742 #ifdef __GXX_EXPERIMENTAL_CXX0X__
743 /// A non-binding request to reduce capacity() to size().
755 * Returns the total number of characters that the %string can hold
756 * before needing to allocate more memory.
760 { return _M_rep()->_M_capacity
; }
763 * @brief Attempt to preallocate enough memory for specified number of
765 * @param res_arg Number of characters required.
766 * @throw std::length_error If @a res_arg exceeds @c max_size().
768 * This function attempts to reserve enough memory for the
769 * %string to hold the specified number of characters. If the
770 * number requested is more than max_size(), length_error is
773 * The advantage of this function is that if optimal code is a
774 * necessity and the user can determine the string length that will be
775 * required, the user can reserve the memory in %advance, and thus
776 * prevent a possible reallocation of memory and copying of %string
780 reserve(size_type __res_arg
= 0);
783 * Erases the string, making it empty.
787 { _M_mutate(0, this->size(), 0); }
790 * Returns true if the %string is empty. Equivalent to
791 * <code>*this == ""</code>.
795 { return this->size() == 0; }
799 * @brief Subscript access to the data contained in the %string.
800 * @param pos The index of the character to access.
801 * @return Read-only (constant) reference to the character.
803 * This operator allows for easy, array-style, data access.
804 * Note that data access with this operator is unchecked and
805 * out_of_range lookups are not defined. (For checked lookups
809 operator[] (size_type __pos
) const
811 _GLIBCXX_DEBUG_ASSERT(__pos
<= size());
812 return _M_data()[__pos
];
816 * @brief Subscript access to the data contained in the %string.
817 * @param pos The index of the character to access.
818 * @return Read/write reference to the character.
820 * This operator allows for easy, array-style, data access.
821 * Note that data access with this operator is unchecked and
822 * out_of_range lookups are not defined. (For checked lookups
823 * see at().) Unshares the string.
826 operator[](size_type __pos
)
828 // allow pos == size() as v3 extension:
829 _GLIBCXX_DEBUG_ASSERT(__pos
<= size());
830 // but be strict in pedantic mode:
831 _GLIBCXX_DEBUG_PEDASSERT(__pos
< size());
833 return _M_data()[__pos
];
837 * @brief Provides access to the data contained in the %string.
838 * @param n The index of the character to access.
839 * @return Read-only (const) reference to the character.
840 * @throw std::out_of_range If @a n is an invalid index.
842 * This function provides for safer data access. The parameter is
843 * first checked that it is in the range of the string. The function
844 * throws out_of_range if the check fails.
847 at(size_type __n
) const
849 if (__n
>= this->size())
850 __throw_out_of_range(__N("basic_string::at"));
851 return _M_data()[__n
];
855 * @brief Provides access to the data contained in the %string.
856 * @param n The index of the character to access.
857 * @return Read/write reference to the character.
858 * @throw std::out_of_range If @a n is an invalid index.
860 * This function provides for safer data access. The parameter is
861 * first checked that it is in the range of the string. The function
862 * throws out_of_range if the check fails. Success results in
863 * unsharing the string.
869 __throw_out_of_range(__N("basic_string::at"));
871 return _M_data()[__n
];
876 * @brief Append a string to this string.
877 * @param str The string to append.
878 * @return Reference to this string.
881 operator+=(const basic_string
& __str
)
882 { return this->append(__str
); }
885 * @brief Append a C string.
886 * @param s The C string to append.
887 * @return Reference to this string.
890 operator+=(const _CharT
* __s
)
891 { return this->append(__s
); }
894 * @brief Append a character.
895 * @param c The character to append.
896 * @return Reference to this string.
899 operator+=(_CharT __c
)
901 this->push_back(__c
);
905 #ifdef __GXX_EXPERIMENTAL_CXX0X__
907 * @brief Append an initializer_list of characters.
908 * @param l The initializer_list of characters to be appended.
909 * @return Reference to this string.
912 operator+=(initializer_list
<_CharT
> __l
)
913 { return this->append(__l
.begin(), __l
.size()); }
914 #endif // __GXX_EXPERIMENTAL_CXX0X__
917 * @brief Append a string to this string.
918 * @param str The string to append.
919 * @return Reference to this string.
922 append(const basic_string
& __str
);
925 * @brief Append a substring.
926 * @param str The string to append.
927 * @param pos Index of the first character of str to append.
928 * @param n The number of characters to append.
929 * @return Reference to this string.
930 * @throw std::out_of_range if @a pos is not a valid index.
932 * This function appends @a n characters from @a str starting at @a pos
933 * to this string. If @a n is is larger than the number of available
934 * characters in @a str, the remainder of @a str is appended.
937 append(const basic_string
& __str
, size_type __pos
, size_type __n
);
940 * @brief Append a C substring.
941 * @param s The C string to append.
942 * @param n The number of characters to append.
943 * @return Reference to this string.
946 append(const _CharT
* __s
, size_type __n
);
949 * @brief Append a C string.
950 * @param s The C string to append.
951 * @return Reference to this string.
954 append(const _CharT
* __s
)
956 __glibcxx_requires_string(__s
);
957 return this->append(__s
, traits_type::length(__s
));
961 * @brief Append multiple characters.
962 * @param n The number of characters to append.
963 * @param c The character to use.
964 * @return Reference to this string.
966 * Appends n copies of c to this string.
969 append(size_type __n
, _CharT __c
);
971 #ifdef __GXX_EXPERIMENTAL_CXX0X__
973 * @brief Append an initializer_list of characters.
974 * @param l The initializer_list of characters to append.
975 * @return Reference to this string.
978 append(initializer_list
<_CharT
> __l
)
979 { return this->append(__l
.begin(), __l
.size()); }
980 #endif // __GXX_EXPERIMENTAL_CXX0X__
983 * @brief Append a range of characters.
984 * @param first Iterator referencing the first character to append.
985 * @param last Iterator marking the end of the range.
986 * @return Reference to this string.
988 * Appends characters in the range [first,last) to this string.
990 template<class _InputIterator
>
992 append(_InputIterator __first
, _InputIterator __last
)
993 { return this->replace(_M_iend(), _M_iend(), __first
, __last
); }
996 * @brief Append a single character.
997 * @param c Character to append.
1000 push_back(_CharT __c
)
1002 const size_type __len
= 1 + this->size();
1003 if (__len
> this->capacity() || _M_rep()->_M_is_shared())
1004 this->reserve(__len
);
1005 traits_type::assign(_M_data()[this->size()], __c
);
1006 _M_rep()->_M_set_length_and_sharable(__len
);
1010 * @brief Set value to contents of another string.
1011 * @param str Source string to use.
1012 * @return Reference to this string.
1015 assign(const basic_string
& __str
);
1017 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1019 * @brief Set value to contents of another string.
1020 * @param str Source string to use.
1021 * @return Reference to this string.
1023 * This function sets this string to the exact contents of @a str.
1024 * @a str is a valid, but unspecified string.
1027 assign(basic_string
&& __str
)
1032 #endif // __GXX_EXPERIMENTAL_CXX0X__
1035 * @brief Set value to a substring of a string.
1036 * @param str The string to use.
1037 * @param pos Index of the first character of str.
1038 * @param n Number of characters to use.
1039 * @return Reference to this string.
1040 * @throw std::out_of_range if @a pos is not a valid index.
1042 * This function sets this string to the substring of @a str consisting
1043 * of @a n characters at @a pos. If @a n is is larger than the number
1044 * of available characters in @a str, the remainder of @a str is used.
1047 assign(const basic_string
& __str
, size_type __pos
, size_type __n
)
1048 { return this->assign(__str
._M_data()
1049 + __str
._M_check(__pos
, "basic_string::assign"),
1050 __str
._M_limit(__pos
, __n
)); }
1053 * @brief Set value to a C substring.
1054 * @param s The C string to use.
1055 * @param n Number of characters to use.
1056 * @return Reference to this string.
1058 * This function sets the value of this string to the first @a n
1059 * characters of @a s. If @a n is is larger than the number of
1060 * available characters in @a s, the remainder of @a s is used.
1063 assign(const _CharT
* __s
, size_type __n
);
1066 * @brief Set value to contents of a C string.
1067 * @param s The C string to use.
1068 * @return Reference to this string.
1070 * This function sets the value of this string to the value of @a s.
1071 * The data is copied, so there is no dependence on @a s once the
1075 assign(const _CharT
* __s
)
1077 __glibcxx_requires_string(__s
);
1078 return this->assign(__s
, traits_type::length(__s
));
1082 * @brief Set value to multiple characters.
1083 * @param n Length of the resulting string.
1084 * @param c The character to use.
1085 * @return Reference to this string.
1087 * This function sets the value of this string to @a n copies of
1091 assign(size_type __n
, _CharT __c
)
1092 { return _M_replace_aux(size_type(0), this->size(), __n
, __c
); }
1095 * @brief Set value to a range of characters.
1096 * @param first Iterator referencing the first character to append.
1097 * @param last Iterator marking the end of the range.
1098 * @return Reference to this string.
1100 * Sets value of string to characters in the range [first,last).
1102 template<class _InputIterator
>
1104 assign(_InputIterator __first
, _InputIterator __last
)
1105 { return this->replace(_M_ibegin(), _M_iend(), __first
, __last
); }
1107 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1109 * @brief Set value to an initializer_list of characters.
1110 * @param l The initializer_list of characters to assign.
1111 * @return Reference to this string.
1114 assign(initializer_list
<_CharT
> __l
)
1115 { return this->assign(__l
.begin(), __l
.size()); }
1116 #endif // __GXX_EXPERIMENTAL_CXX0X__
1119 * @brief Insert multiple characters.
1120 * @param p Iterator referencing location in string to insert at.
1121 * @param n Number of characters to insert
1122 * @param c The character to insert.
1123 * @throw std::length_error If new length exceeds @c max_size().
1125 * Inserts @a n copies of character @a c starting at the position
1126 * referenced by iterator @a p. If adding characters causes the length
1127 * to exceed max_size(), length_error is thrown. The value of the
1128 * string doesn't change if an error is thrown.
1131 insert(iterator __p
, size_type __n
, _CharT __c
)
1132 { this->replace(__p
, __p
, __n
, __c
); }
1135 * @brief Insert a range of characters.
1136 * @param p Iterator referencing location in string to insert at.
1137 * @param beg Start of range.
1138 * @param end End of range.
1139 * @throw std::length_error If new length exceeds @c max_size().
1141 * Inserts characters in range [beg,end). If adding characters causes
1142 * the length to exceed max_size(), length_error is thrown. The value
1143 * of the string doesn't change if an error is thrown.
1145 template<class _InputIterator
>
1147 insert(iterator __p
, _InputIterator __beg
, _InputIterator __end
)
1148 { this->replace(__p
, __p
, __beg
, __end
); }
1150 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1152 * @brief Insert an initializer_list of characters.
1153 * @param p Iterator referencing location in string to insert at.
1154 * @param l The initializer_list of characters to insert.
1155 * @throw std::length_error If new length exceeds @c max_size().
1158 insert(iterator __p
, initializer_list
<_CharT
> __l
)
1160 _GLIBCXX_DEBUG_PEDASSERT(__p
>= _M_ibegin() && __p
<= _M_iend());
1161 this->insert(__p
- _M_ibegin(), __l
.begin(), __l
.size());
1163 #endif // __GXX_EXPERIMENTAL_CXX0X__
1166 * @brief Insert value of a string.
1167 * @param pos1 Iterator referencing location in string to insert at.
1168 * @param str The string to insert.
1169 * @return Reference to this string.
1170 * @throw std::length_error If new length exceeds @c max_size().
1172 * Inserts value of @a str starting at @a pos1. If adding characters
1173 * causes the length to exceed max_size(), length_error is thrown. The
1174 * value of the string doesn't change if an error is thrown.
1177 insert(size_type __pos1
, const basic_string
& __str
)
1178 { return this->insert(__pos1
, __str
, size_type(0), __str
.size()); }
1181 * @brief Insert a substring.
1182 * @param pos1 Iterator referencing location in string to insert at.
1183 * @param str The string to insert.
1184 * @param pos2 Start of characters in str to insert.
1185 * @param n Number of characters to insert.
1186 * @return Reference to this string.
1187 * @throw std::length_error If new length exceeds @c max_size().
1188 * @throw std::out_of_range If @a pos1 > size() or
1189 * @a pos2 > @a str.size().
1191 * Starting at @a pos1, insert @a n character of @a str beginning with
1192 * @a pos2. If adding characters causes the length to exceed
1193 * max_size(), length_error is thrown. If @a pos1 is beyond the end of
1194 * this string or @a pos2 is beyond the end of @a str, out_of_range is
1195 * thrown. The value of the string doesn't change if an error is
1199 insert(size_type __pos1
, const basic_string
& __str
,
1200 size_type __pos2
, size_type __n
)
1201 { return this->insert(__pos1
, __str
._M_data()
1202 + __str
._M_check(__pos2
, "basic_string::insert"),
1203 __str
._M_limit(__pos2
, __n
)); }
1206 * @brief Insert a C substring.
1207 * @param pos Iterator referencing location in string to insert at.
1208 * @param s The C string to insert.
1209 * @param n The number of characters to insert.
1210 * @return Reference to this string.
1211 * @throw std::length_error If new length exceeds @c max_size().
1212 * @throw std::out_of_range If @a pos is beyond the end of this
1215 * Inserts the first @a n characters of @a s starting at @a pos. If
1216 * adding characters causes the length to exceed max_size(),
1217 * length_error is thrown. If @a pos is beyond end(), out_of_range is
1218 * thrown. The value of the string doesn't change if an error is
1222 insert(size_type __pos
, const _CharT
* __s
, size_type __n
);
1225 * @brief Insert a C string.
1226 * @param pos Iterator referencing location in string to insert at.
1227 * @param s The C string to insert.
1228 * @return Reference to this string.
1229 * @throw std::length_error If new length exceeds @c max_size().
1230 * @throw std::out_of_range If @a pos is beyond the end of this
1233 * Inserts the first @a n characters of @a s starting at @a pos. If
1234 * adding characters causes the length to exceed max_size(),
1235 * length_error is thrown. If @a pos is beyond end(), out_of_range is
1236 * thrown. The value of the string doesn't change if an error is
1240 insert(size_type __pos
, const _CharT
* __s
)
1242 __glibcxx_requires_string(__s
);
1243 return this->insert(__pos
, __s
, traits_type::length(__s
));
1247 * @brief Insert multiple characters.
1248 * @param pos Index in string to insert at.
1249 * @param n Number of characters to insert
1250 * @param c The character to insert.
1251 * @return Reference to this string.
1252 * @throw std::length_error If new length exceeds @c max_size().
1253 * @throw std::out_of_range If @a pos is beyond the end of this
1256 * Inserts @a n copies of character @a c starting at index @a pos. If
1257 * adding characters causes the length to exceed max_size(),
1258 * length_error is thrown. If @a pos > length(), out_of_range is
1259 * thrown. The value of the string doesn't change if an error is
1263 insert(size_type __pos
, size_type __n
, _CharT __c
)
1264 { return _M_replace_aux(_M_check(__pos
, "basic_string::insert"),
1265 size_type(0), __n
, __c
); }
1268 * @brief Insert one character.
1269 * @param p Iterator referencing position in string to insert at.
1270 * @param c The character to insert.
1271 * @return Iterator referencing newly inserted char.
1272 * @throw std::length_error If new length exceeds @c max_size().
1274 * Inserts character @a c at position referenced by @a p. If adding
1275 * character causes the length to exceed max_size(), length_error is
1276 * thrown. If @a p is beyond end of string, out_of_range is thrown.
1277 * The value of the string doesn't change if an error is thrown.
1280 insert(iterator __p
, _CharT __c
)
1282 _GLIBCXX_DEBUG_PEDASSERT(__p
>= _M_ibegin() && __p
<= _M_iend());
1283 const size_type __pos
= __p
- _M_ibegin();
1284 _M_replace_aux(__pos
, size_type(0), size_type(1), __c
);
1285 _M_rep()->_M_set_leaked();
1286 return iterator(_M_data() + __pos
);
1290 * @brief Remove characters.
1291 * @param pos Index of first character to remove (default 0).
1292 * @param n Number of characters to remove (default remainder).
1293 * @return Reference to this string.
1294 * @throw std::out_of_range If @a pos is beyond the end of this
1297 * Removes @a n characters from this string starting at @a pos. The
1298 * length of the string is reduced by @a n. If there are < @a n
1299 * characters to remove, the remainder of the string is truncated. If
1300 * @a p is beyond end of string, out_of_range is thrown. The value of
1301 * the string doesn't change if an error is thrown.
1304 erase(size_type __pos
= 0, size_type __n
= npos
)
1306 _M_mutate(_M_check(__pos
, "basic_string::erase"),
1307 _M_limit(__pos
, __n
), size_type(0));
1312 * @brief Remove one character.
1313 * @param position Iterator referencing the character to remove.
1314 * @return iterator referencing same location after removal.
1316 * Removes the character at @a position from this string. The value
1317 * of the string doesn't change if an error is thrown.
1320 erase(iterator __position
)
1322 _GLIBCXX_DEBUG_PEDASSERT(__position
>= _M_ibegin()
1323 && __position
< _M_iend());
1324 const size_type __pos
= __position
- _M_ibegin();
1325 _M_mutate(__pos
, size_type(1), size_type(0));
1326 _M_rep()->_M_set_leaked();
1327 return iterator(_M_data() + __pos
);
1331 * @brief Remove a range of characters.
1332 * @param first Iterator referencing the first character to remove.
1333 * @param last Iterator referencing the end of the range.
1334 * @return Iterator referencing location of first after removal.
1336 * Removes the characters in the range [first,last) from this string.
1337 * The value of the string doesn't change if an error is thrown.
1340 erase(iterator __first
, iterator __last
);
1343 * @brief Replace characters with value from another string.
1344 * @param pos Index of first character to replace.
1345 * @param n Number of characters to be replaced.
1346 * @param str String to insert.
1347 * @return Reference to this string.
1348 * @throw std::out_of_range If @a pos is beyond the end of this
1350 * @throw std::length_error If new length exceeds @c max_size().
1352 * Removes the characters in the range [pos,pos+n) from this string.
1353 * In place, the value of @a str is inserted. If @a pos is beyond end
1354 * of string, out_of_range is thrown. If the length of the result
1355 * exceeds max_size(), length_error is thrown. The value of the string
1356 * doesn't change if an error is thrown.
1359 replace(size_type __pos
, size_type __n
, const basic_string
& __str
)
1360 { return this->replace(__pos
, __n
, __str
._M_data(), __str
.size()); }
1363 * @brief Replace characters with value from another string.
1364 * @param pos1 Index of first character to replace.
1365 * @param n1 Number of characters to be replaced.
1366 * @param str String to insert.
1367 * @param pos2 Index of first character of str to use.
1368 * @param n2 Number of characters from str to use.
1369 * @return Reference to this string.
1370 * @throw std::out_of_range If @a pos1 > size() or @a pos2 >
1372 * @throw std::length_error If new length exceeds @c max_size().
1374 * Removes the characters in the range [pos1,pos1 + n) from this
1375 * string. In place, the value of @a str is inserted. If @a pos is
1376 * beyond end of string, out_of_range is thrown. If the length of the
1377 * result exceeds max_size(), length_error is thrown. The value of the
1378 * string doesn't change if an error is thrown.
1381 replace(size_type __pos1
, size_type __n1
, const basic_string
& __str
,
1382 size_type __pos2
, size_type __n2
)
1383 { return this->replace(__pos1
, __n1
, __str
._M_data()
1384 + __str
._M_check(__pos2
, "basic_string::replace"),
1385 __str
._M_limit(__pos2
, __n2
)); }
1388 * @brief Replace characters with value of a C substring.
1389 * @param pos Index of first character to replace.
1390 * @param n1 Number of characters to be replaced.
1391 * @param s C string to insert.
1392 * @param n2 Number of characters from @a s to use.
1393 * @return Reference to this string.
1394 * @throw std::out_of_range If @a pos1 > size().
1395 * @throw std::length_error If new length exceeds @c max_size().
1397 * Removes the characters in the range [pos,pos + n1) from this string.
1398 * In place, the first @a n2 characters of @a s are inserted, or all
1399 * of @a s if @a n2 is too large. If @a pos is beyond end of string,
1400 * out_of_range is thrown. If the length of result exceeds max_size(),
1401 * length_error is thrown. The value of the string doesn't change if
1402 * an error is thrown.
1405 replace(size_type __pos
, size_type __n1
, const _CharT
* __s
,
1409 * @brief Replace characters with value of a C string.
1410 * @param pos Index of first character to replace.
1411 * @param n1 Number of characters to be replaced.
1412 * @param s C string to insert.
1413 * @return Reference to this string.
1414 * @throw std::out_of_range If @a pos > size().
1415 * @throw std::length_error If new length exceeds @c max_size().
1417 * Removes the characters in the range [pos,pos + n1) from this string.
1418 * In place, the characters of @a s are inserted. If @a pos is beyond
1419 * end of string, out_of_range is thrown. If the length of result
1420 * exceeds max_size(), length_error is thrown. The value of the string
1421 * doesn't change if an error is thrown.
1424 replace(size_type __pos
, size_type __n1
, const _CharT
* __s
)
1426 __glibcxx_requires_string(__s
);
1427 return this->replace(__pos
, __n1
, __s
, traits_type::length(__s
));
1431 * @brief Replace characters with multiple characters.
1432 * @param pos Index of first character to replace.
1433 * @param n1 Number of characters to be replaced.
1434 * @param n2 Number of characters to insert.
1435 * @param c Character to insert.
1436 * @return Reference to this string.
1437 * @throw std::out_of_range If @a pos > size().
1438 * @throw std::length_error If new length exceeds @c max_size().
1440 * Removes the characters in the range [pos,pos + n1) from this string.
1441 * In place, @a n2 copies of @a c are inserted. If @a pos is beyond
1442 * end of string, out_of_range is thrown. If the length of result
1443 * exceeds max_size(), length_error is thrown. The value of the string
1444 * doesn't change if an error is thrown.
1447 replace(size_type __pos
, size_type __n1
, size_type __n2
, _CharT __c
)
1448 { return _M_replace_aux(_M_check(__pos
, "basic_string::replace"),
1449 _M_limit(__pos
, __n1
), __n2
, __c
); }
1452 * @brief Replace range of characters with string.
1453 * @param i1 Iterator referencing start of range to replace.
1454 * @param i2 Iterator referencing end of range to replace.
1455 * @param str String value to insert.
1456 * @return Reference to this string.
1457 * @throw std::length_error If new length exceeds @c max_size().
1459 * Removes the characters in the range [i1,i2). In place, the value of
1460 * @a str is inserted. If the length of result exceeds max_size(),
1461 * length_error is thrown. The value of the string doesn't change if
1462 * an error is thrown.
1465 replace(iterator __i1
, iterator __i2
, const basic_string
& __str
)
1466 { return this->replace(__i1
, __i2
, __str
._M_data(), __str
.size()); }
1469 * @brief Replace range of characters with C substring.
1470 * @param i1 Iterator referencing start of range to replace.
1471 * @param i2 Iterator referencing end of range to replace.
1472 * @param s C string value to insert.
1473 * @param n Number of characters from s to insert.
1474 * @return Reference to this string.
1475 * @throw std::length_error If new length exceeds @c max_size().
1477 * Removes the characters in the range [i1,i2). In place, the first @a
1478 * n characters of @a s are inserted. If the length of result exceeds
1479 * max_size(), length_error is thrown. The value of the string doesn't
1480 * change if an error is thrown.
1483 replace(iterator __i1
, iterator __i2
, const _CharT
* __s
, size_type __n
)
1485 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1486 && __i2
<= _M_iend());
1487 return this->replace(__i1
- _M_ibegin(), __i2
- __i1
, __s
, __n
);
1491 * @brief Replace range of characters with C string.
1492 * @param i1 Iterator referencing start of range to replace.
1493 * @param i2 Iterator referencing end of range to replace.
1494 * @param s C string value to insert.
1495 * @return Reference to this string.
1496 * @throw std::length_error If new length exceeds @c max_size().
1498 * Removes the characters in the range [i1,i2). In place, the
1499 * characters of @a s are inserted. If the length of result exceeds
1500 * max_size(), length_error is thrown. The value of the string doesn't
1501 * change if an error is thrown.
1504 replace(iterator __i1
, iterator __i2
, const _CharT
* __s
)
1506 __glibcxx_requires_string(__s
);
1507 return this->replace(__i1
, __i2
, __s
, traits_type::length(__s
));
1511 * @brief Replace range of characters with multiple characters
1512 * @param i1 Iterator referencing start of range to replace.
1513 * @param i2 Iterator referencing end of range to replace.
1514 * @param n Number of characters to insert.
1515 * @param c Character to insert.
1516 * @return Reference to this string.
1517 * @throw std::length_error If new length exceeds @c max_size().
1519 * Removes the characters in the range [i1,i2). In place, @a n copies
1520 * of @a c are inserted. If the length of result exceeds max_size(),
1521 * length_error is thrown. The value of the string doesn't change if
1522 * an error is thrown.
1525 replace(iterator __i1
, iterator __i2
, size_type __n
, _CharT __c
)
1527 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1528 && __i2
<= _M_iend());
1529 return _M_replace_aux(__i1
- _M_ibegin(), __i2
- __i1
, __n
, __c
);
1533 * @brief Replace range of characters with range.
1534 * @param i1 Iterator referencing start of range to replace.
1535 * @param i2 Iterator referencing end of range to replace.
1536 * @param k1 Iterator referencing start of range to insert.
1537 * @param k2 Iterator referencing end of range to insert.
1538 * @return Reference to this string.
1539 * @throw std::length_error If new length exceeds @c max_size().
1541 * Removes the characters in the range [i1,i2). In place, characters
1542 * in the range [k1,k2) are inserted. If the length of result exceeds
1543 * max_size(), length_error is thrown. The value of the string doesn't
1544 * change if an error is thrown.
1546 template<class _InputIterator
>
1548 replace(iterator __i1
, iterator __i2
,
1549 _InputIterator __k1
, _InputIterator __k2
)
1551 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1552 && __i2
<= _M_iend());
1553 __glibcxx_requires_valid_range(__k1
, __k2
);
1554 typedef typename
std::__is_integer
<_InputIterator
>::__type _Integral
;
1555 return _M_replace_dispatch(__i1
, __i2
, __k1
, __k2
, _Integral());
1558 // Specializations for the common case of pointer and iterator:
1559 // useful to avoid the overhead of temporary buffering in _M_replace.
1561 replace(iterator __i1
, iterator __i2
, _CharT
* __k1
, _CharT
* __k2
)
1563 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1564 && __i2
<= _M_iend());
1565 __glibcxx_requires_valid_range(__k1
, __k2
);
1566 return this->replace(__i1
- _M_ibegin(), __i2
- __i1
,
1571 replace(iterator __i1
, iterator __i2
,
1572 const _CharT
* __k1
, const _CharT
* __k2
)
1574 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1575 && __i2
<= _M_iend());
1576 __glibcxx_requires_valid_range(__k1
, __k2
);
1577 return this->replace(__i1
- _M_ibegin(), __i2
- __i1
,
1582 replace(iterator __i1
, iterator __i2
, iterator __k1
, iterator __k2
)
1584 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1585 && __i2
<= _M_iend());
1586 __glibcxx_requires_valid_range(__k1
, __k2
);
1587 return this->replace(__i1
- _M_ibegin(), __i2
- __i1
,
1588 __k1
.base(), __k2
- __k1
);
1592 replace(iterator __i1
, iterator __i2
,
1593 const_iterator __k1
, const_iterator __k2
)
1595 _GLIBCXX_DEBUG_PEDASSERT(_M_ibegin() <= __i1
&& __i1
<= __i2
1596 && __i2
<= _M_iend());
1597 __glibcxx_requires_valid_range(__k1
, __k2
);
1598 return this->replace(__i1
- _M_ibegin(), __i2
- __i1
,
1599 __k1
.base(), __k2
- __k1
);
1602 #ifdef __GXX_EXPERIMENTAL_CXX0X__
1604 * @brief Replace range of characters with initializer_list.
1605 * @param i1 Iterator referencing start of range to replace.
1606 * @param i2 Iterator referencing end of range to replace.
1607 * @param l The initializer_list of characters to insert.
1608 * @return Reference to this string.
1609 * @throw std::length_error If new length exceeds @c max_size().
1611 * Removes the characters in the range [i1,i2). In place, characters
1612 * in the range [k1,k2) are inserted. If the length of result exceeds
1613 * max_size(), length_error is thrown. The value of the string doesn't
1614 * change if an error is thrown.
1616 basic_string
& replace(iterator __i1
, iterator __i2
,
1617 initializer_list
<_CharT
> __l
)
1618 { return this->replace(__i1
, __i2
, __l
.begin(), __l
.end()); }
1619 #endif // __GXX_EXPERIMENTAL_CXX0X__
1622 template<class _Integer
>
1624 _M_replace_dispatch(iterator __i1
, iterator __i2
, _Integer __n
,
1625 _Integer __val
, __true_type
)
1626 { return _M_replace_aux(__i1
- _M_ibegin(), __i2
- __i1
, __n
, __val
); }
1628 template<class _InputIterator
>
1630 _M_replace_dispatch(iterator __i1
, iterator __i2
, _InputIterator __k1
,
1631 _InputIterator __k2
, __false_type
);
1634 _M_replace_aux(size_type __pos1
, size_type __n1
, size_type __n2
,
1638 _M_replace_safe(size_type __pos1
, size_type __n1
, const _CharT
* __s
,
1641 // _S_construct_aux is used to implement the 21.3.1 para 15 which
1642 // requires special behaviour if _InIter is an integral type
1643 template<class _InIterator
>
1645 _S_construct_aux(_InIterator __beg
, _InIterator __end
,
1646 const _Alloc
& __a
, __false_type
)
1648 typedef typename iterator_traits
<_InIterator
>::iterator_category _Tag
;
1649 return _S_construct(__beg
, __end
, __a
, _Tag());
1652 // _GLIBCXX_RESOLVE_LIB_DEFECTS
1653 // 438. Ambiguity in the "do the right thing" clause
1654 template<class _Integer
>
1656 _S_construct_aux(_Integer __beg
, _Integer __end
,
1657 const _Alloc
& __a
, __true_type
)
1658 { return _S_construct_aux_2(static_cast<size_type
>(__beg
),
1662 _S_construct_aux_2(size_type __req
, _CharT __c
, const _Alloc
& __a
)
1663 { return _S_construct(__req
, __c
, __a
); }
1665 template<class _InIterator
>
1667 _S_construct(_InIterator __beg
, _InIterator __end
, const _Alloc
& __a
)
1669 typedef typename
std::__is_integer
<_InIterator
>::__type _Integral
;
1670 return _S_construct_aux(__beg
, __end
, __a
, _Integral());
1673 // For Input Iterators, used in istreambuf_iterators, etc.
1674 template<class _InIterator
>
1676 _S_construct(_InIterator __beg
, _InIterator __end
, const _Alloc
& __a
,
1677 input_iterator_tag
);
1679 // For forward_iterators up to random_access_iterators, used for
1680 // string::iterator, _CharT*, etc.
1681 template<class _FwdIterator
>
1683 _S_construct(_FwdIterator __beg
, _FwdIterator __end
, const _Alloc
& __a
,
1684 forward_iterator_tag
);
1687 _S_construct(size_type __req
, _CharT __c
, const _Alloc
& __a
);
1692 * @brief Copy substring into C string.
1693 * @param s C string to copy value into.
1694 * @param n Number of characters to copy.
1695 * @param pos Index of first character to copy.
1696 * @return Number of characters actually copied
1697 * @throw std::out_of_range If pos > size().
1699 * Copies up to @a n characters starting at @a pos into the C string @a
1700 * s. If @a pos is %greater than size(), out_of_range is thrown.
1703 copy(_CharT
* __s
, size_type __n
, size_type __pos
= 0) const;
1706 * @brief Swap contents with another string.
1707 * @param s String to swap with.
1709 * Exchanges the contents of this string with that of @a s in constant
1713 swap(basic_string
& __s
);
1715 // String operations:
1717 * @brief Return const pointer to null-terminated contents.
1719 * This is a handle to internal data. Do not modify or dire things may
1724 { return _M_data(); }
1727 * @brief Return const pointer to contents.
1729 * This is a handle to internal data. Do not modify or dire things may
1734 { return _M_data(); }
1737 * @brief Return copy of allocator used to construct this string.
1740 get_allocator() const
1741 { return _M_dataplus
; }
1744 * @brief Find position of a C substring.
1745 * @param s C string to locate.
1746 * @param pos Index of character to search from.
1747 * @param n Number of characters from @a s to search for.
1748 * @return Index of start of first occurrence.
1750 * Starting from @a pos, searches forward for the first @a n characters
1751 * in @a s within this string. If found, returns the index where it
1752 * begins. If not found, returns npos.
1755 find(const _CharT
* __s
, size_type __pos
, size_type __n
) const;
1758 * @brief Find position of a string.
1759 * @param str String to locate.
1760 * @param pos Index of character to search from (default 0).
1761 * @return Index of start of first occurrence.
1763 * Starting from @a pos, searches forward for value of @a str within
1764 * this string. If found, returns the index where it begins. If not
1765 * found, returns npos.
1768 find(const basic_string
& __str
, size_type __pos
= 0) const
1769 { return this->find(__str
.data(), __pos
, __str
.size()); }
1772 * @brief Find position of a C string.
1773 * @param s C string to locate.
1774 * @param pos Index of character to search from (default 0).
1775 * @return Index of start of first occurrence.
1777 * Starting from @a pos, searches forward for the value of @a s within
1778 * this string. If found, returns the index where it begins. If not
1779 * found, returns npos.
1782 find(const _CharT
* __s
, size_type __pos
= 0) const
1784 __glibcxx_requires_string(__s
);
1785 return this->find(__s
, __pos
, traits_type::length(__s
));
1789 * @brief Find position of a character.
1790 * @param c Character to locate.
1791 * @param pos Index of character to search from (default 0).
1792 * @return Index of first occurrence.
1794 * Starting from @a pos, searches forward for @a c within this string.
1795 * If found, returns the index where it was found. If not found,
1799 find(_CharT __c
, size_type __pos
= 0) const;
1802 * @brief Find last position of a string.
1803 * @param str String to locate.
1804 * @param pos Index of character to search back from (default end).
1805 * @return Index of start of last occurrence.
1807 * Starting from @a pos, searches backward for value of @a str within
1808 * this string. If found, returns the index where it begins. If not
1809 * found, returns npos.
1812 rfind(const basic_string
& __str
, size_type __pos
= npos
) const
1813 { return this->rfind(__str
.data(), __pos
, __str
.size()); }
1816 * @brief Find last position of a C substring.
1817 * @param s C string to locate.
1818 * @param pos Index of character to search back from.
1819 * @param n Number of characters from s to search for.
1820 * @return Index of start of last occurrence.
1822 * Starting from @a pos, searches backward for the first @a n
1823 * characters in @a s within this string. If found, returns the index
1824 * where it begins. If not found, returns npos.
1827 rfind(const _CharT
* __s
, size_type __pos
, size_type __n
) const;
1830 * @brief Find last position of a C string.
1831 * @param s C string to locate.
1832 * @param pos Index of character to start search at (default end).
1833 * @return Index of start of last occurrence.
1835 * Starting from @a pos, searches backward for the value of @a s within
1836 * this string. If found, returns the index where it begins. If not
1837 * found, returns npos.
1840 rfind(const _CharT
* __s
, size_type __pos
= npos
) const
1842 __glibcxx_requires_string(__s
);
1843 return this->rfind(__s
, __pos
, traits_type::length(__s
));
1847 * @brief Find last position of a character.
1848 * @param c Character to locate.
1849 * @param pos Index of character to search back from (default end).
1850 * @return Index of last occurrence.
1852 * Starting from @a pos, searches backward for @a c within this string.
1853 * If found, returns the index where it was found. If not found,
1857 rfind(_CharT __c
, size_type __pos
= npos
) const;
1860 * @brief Find position of a character of string.
1861 * @param str String containing characters to locate.
1862 * @param pos Index of character to search from (default 0).
1863 * @return Index of first occurrence.
1865 * Starting from @a pos, searches forward for one of the characters of
1866 * @a str within this string. If found, returns the index where it was
1867 * found. If not found, returns npos.
1870 find_first_of(const basic_string
& __str
, size_type __pos
= 0) const
1871 { return this->find_first_of(__str
.data(), __pos
, __str
.size()); }
1874 * @brief Find position of a character of C substring.
1875 * @param s String containing characters to locate.
1876 * @param pos Index of character to search from.
1877 * @param n Number of characters from s to search for.
1878 * @return Index of first occurrence.
1880 * Starting from @a pos, searches forward for one of the first @a n
1881 * characters of @a s within this string. If found, returns the index
1882 * where it was found. If not found, returns npos.
1885 find_first_of(const _CharT
* __s
, size_type __pos
, size_type __n
) const;
1888 * @brief Find position of a character of C string.
1889 * @param s String containing characters to locate.
1890 * @param pos Index of character to search from (default 0).
1891 * @return Index of first occurrence.
1893 * Starting from @a pos, searches forward for one of the characters of
1894 * @a s within this string. If found, returns the index where it was
1895 * found. If not found, returns npos.
1898 find_first_of(const _CharT
* __s
, size_type __pos
= 0) const
1900 __glibcxx_requires_string(__s
);
1901 return this->find_first_of(__s
, __pos
, traits_type::length(__s
));
1905 * @brief Find position of a character.
1906 * @param c Character to locate.
1907 * @param pos Index of character to search from (default 0).
1908 * @return Index of first occurrence.
1910 * Starting from @a pos, searches forward for the character @a c within
1911 * this string. If found, returns the index where it was found. If
1912 * not found, returns npos.
1914 * Note: equivalent to find(c, pos).
1917 find_first_of(_CharT __c
, size_type __pos
= 0) const
1918 { return this->find(__c
, __pos
); }
1921 * @brief Find last position of a character of string.
1922 * @param str String containing characters to locate.
1923 * @param pos Index of character to search back from (default end).
1924 * @return Index of last occurrence.
1926 * Starting from @a pos, searches backward for one of the characters of
1927 * @a str within this string. If found, returns the index where it was
1928 * found. If not found, returns npos.
1931 find_last_of(const basic_string
& __str
, size_type __pos
= npos
) const
1932 { return this->find_last_of(__str
.data(), __pos
, __str
.size()); }
1935 * @brief Find last position of a character of C substring.
1936 * @param s C string containing characters to locate.
1937 * @param pos Index of character to search back from.
1938 * @param n Number of characters from s to search for.
1939 * @return Index of last occurrence.
1941 * Starting from @a pos, searches backward for one of the first @a n
1942 * characters of @a s within this string. If found, returns the index
1943 * where it was found. If not found, returns npos.
1946 find_last_of(const _CharT
* __s
, size_type __pos
, size_type __n
) const;
1949 * @brief Find last position of a character of C string.
1950 * @param s C string containing characters to locate.
1951 * @param pos Index of character to search back from (default end).
1952 * @return Index of last occurrence.
1954 * Starting from @a pos, searches backward for one of the characters of
1955 * @a s within this string. If found, returns the index where it was
1956 * found. If not found, returns npos.
1959 find_last_of(const _CharT
* __s
, size_type __pos
= npos
) const
1961 __glibcxx_requires_string(__s
);
1962 return this->find_last_of(__s
, __pos
, traits_type::length(__s
));
1966 * @brief Find last position of a character.
1967 * @param c Character to locate.
1968 * @param pos Index of character to search back from (default end).
1969 * @return Index of last occurrence.
1971 * Starting from @a pos, searches backward for @a c within this string.
1972 * If found, returns the index where it was found. If not found,
1975 * Note: equivalent to rfind(c, pos).
1978 find_last_of(_CharT __c
, size_type __pos
= npos
) const
1979 { return this->rfind(__c
, __pos
); }
1982 * @brief Find position of a character not in string.
1983 * @param str String containing characters to avoid.
1984 * @param pos Index of character to search from (default 0).
1985 * @return Index of first occurrence.
1987 * Starting from @a pos, searches forward for a character not contained
1988 * in @a str within this string. If found, returns the index where it
1989 * was found. If not found, returns npos.
1992 find_first_not_of(const basic_string
& __str
, size_type __pos
= 0) const
1993 { return this->find_first_not_of(__str
.data(), __pos
, __str
.size()); }
1996 * @brief Find position of a character not in C substring.
1997 * @param s C string containing characters to avoid.
1998 * @param pos Index of character to search from.
1999 * @param n Number of characters from s to consider.
2000 * @return Index of first occurrence.
2002 * Starting from @a pos, searches forward for a character not contained
2003 * in the first @a n characters of @a s within this string. If found,
2004 * returns the index where it was found. If not found, returns npos.
2007 find_first_not_of(const _CharT
* __s
, size_type __pos
,
2008 size_type __n
) const;
2011 * @brief Find position of a character not in C string.
2012 * @param s C string containing characters to avoid.
2013 * @param pos Index of character to search from (default 0).
2014 * @return Index of first occurrence.
2016 * Starting from @a pos, searches forward for a character not contained
2017 * in @a s within this string. If found, returns the index where it
2018 * was found. If not found, returns npos.
2021 find_first_not_of(const _CharT
* __s
, size_type __pos
= 0) const
2023 __glibcxx_requires_string(__s
);
2024 return this->find_first_not_of(__s
, __pos
, traits_type::length(__s
));
2028 * @brief Find position of a different character.
2029 * @param c Character to avoid.
2030 * @param pos Index of character to search from (default 0).
2031 * @return Index of first occurrence.
2033 * Starting from @a pos, searches forward for a character other than @a c
2034 * within this string. If found, returns the index where it was found.
2035 * If not found, returns npos.
2038 find_first_not_of(_CharT __c
, size_type __pos
= 0) const;
2041 * @brief Find last position of a character not in string.
2042 * @param str String containing characters to avoid.
2043 * @param pos Index of character to search back from (default end).
2044 * @return Index of last occurrence.
2046 * Starting from @a pos, searches backward for a character not
2047 * contained in @a str within this string. If found, returns the index
2048 * where it was found. If not found, returns npos.
2051 find_last_not_of(const basic_string
& __str
, size_type __pos
= npos
) const
2052 { return this->find_last_not_of(__str
.data(), __pos
, __str
.size()); }
2055 * @brief Find last position of a character not in C substring.
2056 * @param s C string containing characters to avoid.
2057 * @param pos Index of character to search back from.
2058 * @param n Number of characters from s to consider.
2059 * @return Index of last occurrence.
2061 * Starting from @a pos, searches backward for a character not
2062 * contained in the first @a n characters of @a s within this string.
2063 * If found, returns the index where it was found. If not found,
2067 find_last_not_of(const _CharT
* __s
, size_type __pos
,
2068 size_type __n
) const;
2070 * @brief Find last position of a character not in C string.
2071 * @param s C string containing characters to avoid.
2072 * @param pos Index of character to search back from (default end).
2073 * @return Index of last occurrence.
2075 * Starting from @a pos, searches backward for a character not
2076 * contained in @a s within this string. If found, returns the index
2077 * where it was found. If not found, returns npos.
2080 find_last_not_of(const _CharT
* __s
, size_type __pos
= npos
) const
2082 __glibcxx_requires_string(__s
);
2083 return this->find_last_not_of(__s
, __pos
, traits_type::length(__s
));
2087 * @brief Find last position of a different character.
2088 * @param c Character to avoid.
2089 * @param pos Index of character to search back from (default end).
2090 * @return Index of last occurrence.
2092 * Starting from @a pos, searches backward for a character other than
2093 * @a c within this string. If found, returns the index where it was
2094 * found. If not found, returns npos.
2097 find_last_not_of(_CharT __c
, size_type __pos
= npos
) const;
2100 * @brief Get a substring.
2101 * @param pos Index of first character (default 0).
2102 * @param n Number of characters in substring (default remainder).
2103 * @return The new string.
2104 * @throw std::out_of_range If pos > size().
2106 * Construct and return a new string using the @a n characters starting
2107 * at @a pos. If the string is too short, use the remainder of the
2108 * characters. If @a pos is beyond the end of the string, out_of_range
2112 substr(size_type __pos
= 0, size_type __n
= npos
) const
2113 { return basic_string(*this,
2114 _M_check(__pos
, "basic_string::substr"), __n
); }
2117 * @brief Compare to a string.
2118 * @param str String to compare against.
2119 * @return Integer < 0, 0, or > 0.
2121 * Returns an integer < 0 if this string is ordered before @a str, 0 if
2122 * their values are equivalent, or > 0 if this string is ordered after
2123 * @a str. Determines the effective length rlen of the strings to
2124 * compare as the smallest of size() and str.size(). The function
2125 * then compares the two strings by calling traits::compare(data(),
2126 * str.data(),rlen). If the result of the comparison is nonzero returns
2127 * it, otherwise the shorter one is ordered first.
2130 compare(const basic_string
& __str
) const
2132 const size_type __size
= this->size();
2133 const size_type __osize
= __str
.size();
2134 const size_type __len
= std::min(__size
, __osize
);
2136 int __r
= traits_type::compare(_M_data(), __str
.data(), __len
);
2138 __r
= _S_compare(__size
, __osize
);
2143 * @brief Compare substring to a string.
2144 * @param pos Index of first character of substring.
2145 * @param n Number of characters in substring.
2146 * @param str String to compare against.
2147 * @return Integer < 0, 0, or > 0.
2149 * Form the substring of this string from the @a n characters starting
2150 * at @a pos. Returns an integer < 0 if the substring is ordered
2151 * before @a str, 0 if their values are equivalent, or > 0 if the
2152 * substring is ordered after @a str. Determines the effective length
2153 * rlen of the strings to compare as the smallest of the length of the
2154 * substring and @a str.size(). The function then compares the two
2155 * strings by calling traits::compare(substring.data(),str.data(),rlen).
2156 * If the result of the comparison is nonzero returns it, otherwise the
2157 * shorter one is ordered first.
2160 compare(size_type __pos
, size_type __n
, const basic_string
& __str
) const;
2163 * @brief Compare substring to a substring.
2164 * @param pos1 Index of first character of substring.
2165 * @param n1 Number of characters in substring.
2166 * @param str String to compare against.
2167 * @param pos2 Index of first character of substring of str.
2168 * @param n2 Number of characters in substring of str.
2169 * @return Integer < 0, 0, or > 0.
2171 * Form the substring of this string from the @a n1 characters starting
2172 * at @a pos1. Form the substring of @a str from the @a n2 characters
2173 * starting at @a pos2. Returns an integer < 0 if this substring is
2174 * ordered before the substring of @a str, 0 if their values are
2175 * equivalent, or > 0 if this substring is ordered after the substring
2176 * of @a str. Determines the effective length rlen of the strings
2177 * to compare as the smallest of the lengths of the substrings. The
2178 * function then compares the two strings by calling
2179 * traits::compare(substring.data(),str.substr(pos2,n2).data(),rlen).
2180 * If the result of the comparison is nonzero returns it, otherwise the
2181 * shorter one is ordered first.
2184 compare(size_type __pos1
, size_type __n1
, const basic_string
& __str
,
2185 size_type __pos2
, size_type __n2
) const;
2188 * @brief Compare to a C string.
2189 * @param s C string to compare against.
2190 * @return Integer < 0, 0, or > 0.
2192 * Returns an integer < 0 if this string is ordered before @a s, 0 if
2193 * their values are equivalent, or > 0 if this string is ordered after
2194 * @a s. Determines the effective length rlen of the strings to
2195 * compare as the smallest of size() and the length of a string
2196 * constructed from @a s. The function then compares the two strings
2197 * by calling traits::compare(data(),s,rlen). If the result of the
2198 * comparison is nonzero returns it, otherwise the shorter one is
2202 compare(const _CharT
* __s
) const;
2204 // _GLIBCXX_RESOLVE_LIB_DEFECTS
2205 // 5 String::compare specification questionable
2207 * @brief Compare substring to a C string.
2208 * @param pos Index of first character of substring.
2209 * @param n1 Number of characters in substring.
2210 * @param s C string to compare against.
2211 * @return Integer < 0, 0, or > 0.
2213 * Form the substring of this string from the @a n1 characters starting
2214 * at @a pos. Returns an integer < 0 if the substring is ordered
2215 * before @a s, 0 if their values are equivalent, or > 0 if the
2216 * substring is ordered after @a s. Determines the effective length
2217 * rlen of the strings to compare as the smallest of the length of the
2218 * substring and the length of a string constructed from @a s. The
2219 * function then compares the two string by calling
2220 * traits::compare(substring.data(),s,rlen). If the result of the
2221 * comparison is nonzero returns it, otherwise the shorter one is
2225 compare(size_type __pos
, size_type __n1
, const _CharT
* __s
) const;
2228 * @brief Compare substring against a character %array.
2229 * @param pos1 Index of first character of substring.
2230 * @param n1 Number of characters in substring.
2231 * @param s character %array to compare against.
2232 * @param n2 Number of characters of s.
2233 * @return Integer < 0, 0, or > 0.
2235 * Form the substring of this string from the @a n1 characters starting
2236 * at @a pos1. Form a string from the first @a n2 characters of @a s.
2237 * Returns an integer < 0 if this substring is ordered before the string
2238 * from @a s, 0 if their values are equivalent, or > 0 if this substring
2239 * is ordered after the string from @a s. Determines the effective
2240 * length rlen of the strings to compare as the smallest of the length
2241 * of the substring and @a n2. The function then compares the two
2242 * strings by calling traits::compare(substring.data(),s,rlen). If the
2243 * result of the comparison is nonzero returns it, otherwise the shorter
2244 * one is ordered first.
2246 * NB: s must have at least n2 characters, '\\0' has
2247 * no special meaning.
2250 compare(size_type __pos
, size_type __n1
, const _CharT
* __s
,
2251 size_type __n2
) const;
2256 * @brief Concatenate two strings.
2257 * @param lhs First string.
2258 * @param rhs Last string.
2259 * @return New string with value of @a lhs followed by @a rhs.
2261 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2262 basic_string
<_CharT
, _Traits
, _Alloc
>
2263 operator+(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2264 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2266 basic_string
<_CharT
, _Traits
, _Alloc
> __str(__lhs
);
2267 __str
.append(__rhs
);
2272 * @brief Concatenate C string and string.
2273 * @param lhs First string.
2274 * @param rhs Last string.
2275 * @return New string with value of @a lhs followed by @a rhs.
2277 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2278 basic_string
<_CharT
,_Traits
,_Alloc
>
2279 operator+(const _CharT
* __lhs
,
2280 const basic_string
<_CharT
,_Traits
,_Alloc
>& __rhs
);
2283 * @brief Concatenate character and string.
2284 * @param lhs First string.
2285 * @param rhs Last string.
2286 * @return New string with @a lhs followed by @a rhs.
2288 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2289 basic_string
<_CharT
,_Traits
,_Alloc
>
2290 operator+(_CharT __lhs
, const basic_string
<_CharT
,_Traits
,_Alloc
>& __rhs
);
2293 * @brief Concatenate string and C string.
2294 * @param lhs First string.
2295 * @param rhs Last string.
2296 * @return New string with @a lhs followed by @a rhs.
2298 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2299 inline basic_string
<_CharT
, _Traits
, _Alloc
>
2300 operator+(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2301 const _CharT
* __rhs
)
2303 basic_string
<_CharT
, _Traits
, _Alloc
> __str(__lhs
);
2304 __str
.append(__rhs
);
2309 * @brief Concatenate string and character.
2310 * @param lhs First string.
2311 * @param rhs Last string.
2312 * @return New string with @a lhs followed by @a rhs.
2314 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2315 inline basic_string
<_CharT
, _Traits
, _Alloc
>
2316 operator+(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
, _CharT __rhs
)
2318 typedef basic_string
<_CharT
, _Traits
, _Alloc
> __string_type
;
2319 typedef typename
__string_type::size_type __size_type
;
2320 __string_type
__str(__lhs
);
2321 __str
.append(__size_type(1), __rhs
);
2327 * @brief Test equivalence of two strings.
2328 * @param lhs First string.
2329 * @param rhs Second string.
2330 * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
2332 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2334 operator==(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2335 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2336 { return __lhs
.compare(__rhs
) == 0; }
2338 template<typename _CharT
>
2340 typename
__gnu_cxx::__enable_if
<__is_char
<_CharT
>::__value
, bool>::__type
2341 operator==(const basic_string
<_CharT
>& __lhs
,
2342 const basic_string
<_CharT
>& __rhs
)
2343 { return (__lhs
.size() == __rhs
.size()
2344 && !std::char_traits
<_CharT
>::compare(__lhs
.data(), __rhs
.data(),
2348 * @brief Test equivalence of C string and string.
2349 * @param lhs C string.
2350 * @param rhs String.
2351 * @return True if @a rhs.compare(@a lhs) == 0. False otherwise.
2353 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2355 operator==(const _CharT
* __lhs
,
2356 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2357 { return __rhs
.compare(__lhs
) == 0; }
2360 * @brief Test equivalence of string and C string.
2361 * @param lhs String.
2362 * @param rhs C string.
2363 * @return True if @a lhs.compare(@a rhs) == 0. False otherwise.
2365 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2367 operator==(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2368 const _CharT
* __rhs
)
2369 { return __lhs
.compare(__rhs
) == 0; }
2373 * @brief Test difference of two strings.
2374 * @param lhs First string.
2375 * @param rhs Second string.
2376 * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
2378 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2380 operator!=(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2381 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2382 { return !(__lhs
== __rhs
); }
2385 * @brief Test difference of C string and string.
2386 * @param lhs C string.
2387 * @param rhs String.
2388 * @return True if @a rhs.compare(@a lhs) != 0. False otherwise.
2390 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2392 operator!=(const _CharT
* __lhs
,
2393 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2394 { return !(__lhs
== __rhs
); }
2397 * @brief Test difference of string and C string.
2398 * @param lhs String.
2399 * @param rhs C string.
2400 * @return True if @a lhs.compare(@a rhs) != 0. False otherwise.
2402 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2404 operator!=(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2405 const _CharT
* __rhs
)
2406 { return !(__lhs
== __rhs
); }
2410 * @brief Test if string precedes string.
2411 * @param lhs First string.
2412 * @param rhs Second string.
2413 * @return True if @a lhs precedes @a rhs. False otherwise.
2415 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2417 operator<(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2418 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2419 { return __lhs
.compare(__rhs
) < 0; }
2422 * @brief Test if string precedes C string.
2423 * @param lhs String.
2424 * @param rhs C string.
2425 * @return True if @a lhs precedes @a rhs. False otherwise.
2427 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2429 operator<(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2430 const _CharT
* __rhs
)
2431 { return __lhs
.compare(__rhs
) < 0; }
2434 * @brief Test if C string precedes string.
2435 * @param lhs C string.
2436 * @param rhs String.
2437 * @return True if @a lhs precedes @a rhs. False otherwise.
2439 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2441 operator<(const _CharT
* __lhs
,
2442 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2443 { return __rhs
.compare(__lhs
) > 0; }
2447 * @brief Test if string follows string.
2448 * @param lhs First string.
2449 * @param rhs Second string.
2450 * @return True if @a lhs follows @a rhs. False otherwise.
2452 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2454 operator>(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2455 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2456 { return __lhs
.compare(__rhs
) > 0; }
2459 * @brief Test if string follows C string.
2460 * @param lhs String.
2461 * @param rhs C string.
2462 * @return True if @a lhs follows @a rhs. False otherwise.
2464 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2466 operator>(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2467 const _CharT
* __rhs
)
2468 { return __lhs
.compare(__rhs
) > 0; }
2471 * @brief Test if C string follows string.
2472 * @param lhs C string.
2473 * @param rhs String.
2474 * @return True if @a lhs follows @a rhs. False otherwise.
2476 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2478 operator>(const _CharT
* __lhs
,
2479 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2480 { return __rhs
.compare(__lhs
) < 0; }
2484 * @brief Test if string doesn't follow string.
2485 * @param lhs First string.
2486 * @param rhs Second string.
2487 * @return True if @a lhs doesn't follow @a rhs. False otherwise.
2489 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2491 operator<=(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2492 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2493 { return __lhs
.compare(__rhs
) <= 0; }
2496 * @brief Test if string doesn't follow C string.
2497 * @param lhs String.
2498 * @param rhs C string.
2499 * @return True if @a lhs doesn't follow @a rhs. False otherwise.
2501 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2503 operator<=(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2504 const _CharT
* __rhs
)
2505 { return __lhs
.compare(__rhs
) <= 0; }
2508 * @brief Test if C string doesn't follow string.
2509 * @param lhs C string.
2510 * @param rhs String.
2511 * @return True if @a lhs doesn't follow @a rhs. False otherwise.
2513 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2515 operator<=(const _CharT
* __lhs
,
2516 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2517 { return __rhs
.compare(__lhs
) >= 0; }
2521 * @brief Test if string doesn't precede string.
2522 * @param lhs First string.
2523 * @param rhs Second string.
2524 * @return True if @a lhs doesn't precede @a rhs. False otherwise.
2526 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2528 operator>=(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2529 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2530 { return __lhs
.compare(__rhs
) >= 0; }
2533 * @brief Test if string doesn't precede C string.
2534 * @param lhs String.
2535 * @param rhs C string.
2536 * @return True if @a lhs doesn't precede @a rhs. False otherwise.
2538 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2540 operator>=(const basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2541 const _CharT
* __rhs
)
2542 { return __lhs
.compare(__rhs
) >= 0; }
2545 * @brief Test if C string doesn't precede string.
2546 * @param lhs C string.
2547 * @param rhs String.
2548 * @return True if @a lhs doesn't precede @a rhs. False otherwise.
2550 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2552 operator>=(const _CharT
* __lhs
,
2553 const basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2554 { return __rhs
.compare(__lhs
) <= 0; }
2557 * @brief Swap contents of two strings.
2558 * @param lhs First string.
2559 * @param rhs Second string.
2561 * Exchanges the contents of @a lhs and @a rhs in constant time.
2563 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2565 swap(basic_string
<_CharT
, _Traits
, _Alloc
>& __lhs
,
2566 basic_string
<_CharT
, _Traits
, _Alloc
>& __rhs
)
2567 { __lhs
.swap(__rhs
); }
2570 * @brief Read stream into a string.
2571 * @param is Input stream.
2572 * @param str Buffer to store into.
2573 * @return Reference to the input stream.
2575 * Stores characters from @a is into @a str until whitespace is found, the
2576 * end of the stream is encountered, or str.max_size() is reached. If
2577 * is.width() is non-zero, that is the limit on the number of characters
2578 * stored into @a str. Any previous contents of @a str are erased.
2580 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2581 basic_istream
<_CharT
, _Traits
>&
2582 operator>>(basic_istream
<_CharT
, _Traits
>& __is
,
2583 basic_string
<_CharT
, _Traits
, _Alloc
>& __str
);
2586 basic_istream
<char>&
2587 operator>>(basic_istream
<char>& __is
, basic_string
<char>& __str
);
2590 * @brief Write string to a stream.
2591 * @param os Output stream.
2592 * @param str String to write out.
2593 * @return Reference to the output stream.
2595 * Output characters of @a str into os following the same rules as for
2596 * writing a C string.
2598 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2599 inline basic_ostream
<_CharT
, _Traits
>&
2600 operator<<(basic_ostream
<_CharT
, _Traits
>& __os
,
2601 const basic_string
<_CharT
, _Traits
, _Alloc
>& __str
)
2603 // _GLIBCXX_RESOLVE_LIB_DEFECTS
2604 // 586. string inserter not a formatted function
2605 return __ostream_insert(__os
, __str
.data(), __str
.size());
2609 * @brief Read a line from stream into a string.
2610 * @param is Input stream.
2611 * @param str Buffer to store into.
2612 * @param delim Character marking end of line.
2613 * @return Reference to the input stream.
2615 * Stores characters from @a is into @a str until @a delim is found, the
2616 * end of the stream is encountered, or str.max_size() is reached. If
2617 * is.width() is non-zero, that is the limit on the number of characters
2618 * stored into @a str. Any previous contents of @a str are erased. If @a
2619 * delim was encountered, it is extracted but not stored into @a str.
2621 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2622 basic_istream
<_CharT
, _Traits
>&
2623 getline(basic_istream
<_CharT
, _Traits
>& __is
,
2624 basic_string
<_CharT
, _Traits
, _Alloc
>& __str
, _CharT __delim
);
2627 * @brief Read a line from stream into a string.
2628 * @param is Input stream.
2629 * @param str Buffer to store into.
2630 * @return Reference to the input stream.
2632 * Stores characters from is into @a str until '\n' is
2633 * found, the end of the stream is encountered, or str.max_size()
2634 * is reached. If is.width() is non-zero, that is the limit on the
2635 * number of characters stored into @a str. Any previous contents
2636 * of @a str are erased. If end of line was encountered, it is
2637 * extracted but not stored into @a str.
2639 template<typename _CharT
, typename _Traits
, typename _Alloc
>
2640 inline basic_istream
<_CharT
, _Traits
>&
2641 getline(basic_istream
<_CharT
, _Traits
>& __is
,
2642 basic_string
<_CharT
, _Traits
, _Alloc
>& __str
)
2643 { return getline(__is
, __str
, __is
.widen('\n')); }
2646 basic_istream
<char>&
2647 getline(basic_istream
<char>& __in
, basic_string
<char>& __str
,
2650 #ifdef _GLIBCXX_USE_WCHAR_T
2652 basic_istream
<wchar_t>&
2653 getline(basic_istream
<wchar_t>& __in
, basic_string
<wchar_t>& __str
,
2657 _GLIBCXX_END_NAMESPACE
2659 #if (defined(__GXX_EXPERIMENTAL_CXX0X__) && defined(_GLIBCXX_USE_C99) \
2660 && !defined(_GLIBCXX_HAVE_BROKEN_VSWPRINTF))
2662 #include <ext/string_conversions.h>
2664 _GLIBCXX_BEGIN_NAMESPACE(std
)
2666 // 21.4 Numeric Conversions [string.conversions].
2668 stoi(const string
& __str
, size_t* __idx
= 0, int __base
= 10)
2669 { return __gnu_cxx::__stoa
<long, int>(&std::strtol
, "stoi", __str
.c_str(),
2673 stol(const string
& __str
, size_t* __idx
= 0, int __base
= 10)
2674 { return __gnu_cxx::__stoa(&std::strtol
, "stol", __str
.c_str(),
2677 inline unsigned long
2678 stoul(const string
& __str
, size_t* __idx
= 0, int __base
= 10)
2679 { return __gnu_cxx::__stoa(&std::strtoul
, "stoul", __str
.c_str(),
2683 stoll(const string
& __str
, size_t* __idx
= 0, int __base
= 10)
2684 { return __gnu_cxx::__stoa(&std::strtoll
, "stoll", __str
.c_str(),
2687 inline unsigned long long
2688 stoull(const string
& __str
, size_t* __idx
= 0, int __base
= 10)
2689 { return __gnu_cxx::__stoa(&std::strtoull
, "stoull", __str
.c_str(),
2692 // NB: strtof vs strtod.
2694 stof(const string
& __str
, size_t* __idx
= 0)
2695 { return __gnu_cxx::__stoa(&std::strtof
, "stof", __str
.c_str(), __idx
); }
2698 stod(const string
& __str
, size_t* __idx
= 0)
2699 { return __gnu_cxx::__stoa(&std::strtod
, "stod", __str
.c_str(), __idx
); }
2702 stold(const string
& __str
, size_t* __idx
= 0)
2703 { return __gnu_cxx::__stoa(&std::strtold
, "stold", __str
.c_str(), __idx
); }
2705 // NB: (v)snprintf vs sprintf.
2709 to_string(int __val
)
2710 { return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
, 4 * sizeof(int),
2714 to_string(unsigned __val
)
2715 { return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
,
2716 4 * sizeof(unsigned),
2720 to_string(long __val
)
2721 { return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
, 4 * sizeof(long),
2725 to_string(unsigned long __val
)
2726 { return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
,
2727 4 * sizeof(unsigned long),
2731 to_string(long long __val
)
2732 { return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
,
2733 4 * sizeof(long long),
2737 to_string(unsigned long long __val
)
2738 { return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
,
2739 4 * sizeof(unsigned long long),
2743 to_string(float __val
)
2746 __gnu_cxx::__numeric_traits
<float>::__max_exponent10
+ 20;
2747 return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
, __n
,
2752 to_string(double __val
)
2755 __gnu_cxx::__numeric_traits
<double>::__max_exponent10
+ 20;
2756 return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
, __n
,
2761 to_string(long double __val
)
2764 __gnu_cxx::__numeric_traits
<long double>::__max_exponent10
+ 20;
2765 return __gnu_cxx::__to_xstring
<string
>(&std::vsnprintf
, __n
,
2769 #ifdef _GLIBCXX_USE_WCHAR_T
2771 stoi(const wstring
& __str
, size_t* __idx
= 0, int __base
= 10)
2772 { return __gnu_cxx::__stoa
<long, int>(&std::wcstol
, "stoi", __str
.c_str(),
2776 stol(const wstring
& __str
, size_t* __idx
= 0, int __base
= 10)
2777 { return __gnu_cxx::__stoa(&std::wcstol
, "stol", __str
.c_str(),
2780 inline unsigned long
2781 stoul(const wstring
& __str
, size_t* __idx
= 0, int __base
= 10)
2782 { return __gnu_cxx::__stoa(&std::wcstoul
, "stoul", __str
.c_str(),
2786 stoll(const wstring
& __str
, size_t* __idx
= 0, int __base
= 10)
2787 { return __gnu_cxx::__stoa(&std::wcstoll
, "stoll", __str
.c_str(),
2790 inline unsigned long long
2791 stoull(const wstring
& __str
, size_t* __idx
= 0, int __base
= 10)
2792 { return __gnu_cxx::__stoa(&std::wcstoull
, "stoull", __str
.c_str(),
2795 // NB: wcstof vs wcstod.
2797 stof(const wstring
& __str
, size_t* __idx
= 0)
2798 { return __gnu_cxx::__stoa(&std::wcstof
, "stof", __str
.c_str(), __idx
); }
2801 stod(const wstring
& __str
, size_t* __idx
= 0)
2802 { return __gnu_cxx::__stoa(&std::wcstod
, "stod", __str
.c_str(), __idx
); }
2805 stold(const wstring
& __str
, size_t* __idx
= 0)
2806 { return __gnu_cxx::__stoa(&std::wcstold
, "stold", __str
.c_str(), __idx
); }
2810 to_wstring(int __val
)
2811 { return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
, 4 * sizeof(int),
2815 to_wstring(unsigned __val
)
2816 { return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
,
2817 4 * sizeof(unsigned),
2821 to_wstring(long __val
)
2822 { return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
, 4 * sizeof(long),
2826 to_wstring(unsigned long __val
)
2827 { return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
,
2828 4 * sizeof(unsigned long),
2832 to_wstring(long long __val
)
2833 { return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
,
2834 4 * sizeof(long long),
2838 to_wstring(unsigned long long __val
)
2839 { return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
,
2840 4 * sizeof(unsigned long long),
2844 to_wstring(float __val
)
2847 __gnu_cxx::__numeric_traits
<float>::__max_exponent10
+ 20;
2848 return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
, __n
,
2853 to_wstring(double __val
)
2856 __gnu_cxx::__numeric_traits
<double>::__max_exponent10
+ 20;
2857 return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
, __n
,
2862 to_wstring(long double __val
)
2865 __gnu_cxx::__numeric_traits
<long double>::__max_exponent10
+ 20;
2866 return __gnu_cxx::__to_xstring
<wstring
>(&std::vswprintf
, __n
,
2871 _GLIBCXX_END_NAMESPACE
2873 #endif /* __GXX_EXPERIMENTAL_CXX0X__ && _GLIBCXX_USE_C99 ... */
2875 #ifdef __GXX_EXPERIMENTAL_CXX0X__
2877 #include <bits/functional_hash.h>
2879 _GLIBCXX_BEGIN_NAMESPACE(std
)
2883 #ifndef _GLIBCXX_COMPATIBILITY_CXX0X
2884 /// std::hash specialization for string.
2887 : public std::unary_function
<string
, size_t>
2890 operator()(const string
& __s
) const
2891 { return std::_Fnv_hash::hash(__s
.data(), __s
.length()); }
2894 #ifdef _GLIBCXX_USE_WCHAR_T
2895 /// std::hash specialization for wstring.
2897 struct hash
<wstring
>
2898 : public std::unary_function
<wstring
, size_t>
2901 operator()(const wstring
& __s
) const
2902 { return std::_Fnv_hash::hash(__s
.data(),
2903 __s
.length() * sizeof(wchar_t)); }
2906 #endif /* _GLIBCXX_COMPATIBILITY_CXX0X */
2908 #ifdef _GLIBCXX_USE_C99_STDINT_TR1
2909 /// std::hash specialization for u16string.
2911 struct hash
<u16string
>
2912 : public std::unary_function
<u16string
, size_t>
2915 operator()(const u16string
& __s
) const
2916 { return std::_Fnv_hash::hash(__s
.data(),
2917 __s
.length() * sizeof(char16_t
)); }
2920 /// std::hash specialization for u32string.
2922 struct hash
<u32string
>
2923 : public std::unary_function
<u32string
, size_t>
2926 operator()(const u32string
& __s
) const
2927 { return std::_Fnv_hash::hash(__s
.data(),
2928 __s
.length() * sizeof(char32_t
)); }
2932 _GLIBCXX_END_NAMESPACE
2934 #endif /* __GXX_EXPERIMENTAL_CXX0X__ */
2936 #endif /* _BASIC_STRING_H */