xref: /netbsd-src/external/gpl3/gcc.old/dist/libstdc++-v3/include/ext/rc_string_base.h (revision 8feb0f0b7eaff0608f8350bbfa3098827b4bb91b)
136ac495dSmrg // Reference-counted versatile string base -*- C++ -*-
236ac495dSmrg 
3*8feb0f0bSmrg // Copyright (C) 2005-2020 Free Software Foundation, Inc.
436ac495dSmrg //
536ac495dSmrg // This file is part of the GNU ISO C++ Library.  This library is free
636ac495dSmrg // software; you can redistribute it and/or modify it under the
736ac495dSmrg // terms of the GNU General Public License as published by the
836ac495dSmrg // Free Software Foundation; either version 3, or (at your option)
936ac495dSmrg // any later version.
1036ac495dSmrg 
1136ac495dSmrg // This library is distributed in the hope that it will be useful,
1236ac495dSmrg // but WITHOUT ANY WARRANTY; without even the implied warranty of
1336ac495dSmrg // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
1436ac495dSmrg // GNU General Public License for more details.
1536ac495dSmrg 
1636ac495dSmrg // Under Section 7 of GPL version 3, you are granted additional
1736ac495dSmrg // permissions described in the GCC Runtime Library Exception, version
1836ac495dSmrg // 3.1, as published by the Free Software Foundation.
1936ac495dSmrg 
2036ac495dSmrg // You should have received a copy of the GNU General Public License and
2136ac495dSmrg // a copy of the GCC Runtime Library Exception along with this program;
2236ac495dSmrg // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
2336ac495dSmrg // <http://www.gnu.org/licenses/>.
2436ac495dSmrg 
2536ac495dSmrg /** @file ext/rc_string_base.h
2636ac495dSmrg  *  This is an internal header file, included by other library headers.
2736ac495dSmrg  *  Do not attempt to use it directly. @headername{ext/vstring.h}
2836ac495dSmrg  */
2936ac495dSmrg 
3036ac495dSmrg #ifndef _RC_STRING_BASE_H
3136ac495dSmrg #define _RC_STRING_BASE_H 1
3236ac495dSmrg 
3336ac495dSmrg #include <ext/atomicity.h>
34*8feb0f0bSmrg #include <ext/alloc_traits.h>
3536ac495dSmrg #include <bits/stl_iterator_base_funcs.h>
3636ac495dSmrg 
_GLIBCXX_VISIBILITY(default)3736ac495dSmrg namespace __gnu_cxx _GLIBCXX_VISIBILITY(default)
3836ac495dSmrg {
3936ac495dSmrg _GLIBCXX_BEGIN_NAMESPACE_VERSION
4036ac495dSmrg 
4136ac495dSmrg   /**
4236ac495dSmrg    *  Documentation?  What's that?
4336ac495dSmrg    *  Nathan Myers <ncm@cantrip.org>.
4436ac495dSmrg    *
4536ac495dSmrg    *  A string looks like this:
4636ac495dSmrg    *
4736ac495dSmrg    *  @code
4836ac495dSmrg    *                                        [_Rep]
4936ac495dSmrg    *                                        _M_length
5036ac495dSmrg    *   [__rc_string_base<char_type>]        _M_capacity
5136ac495dSmrg    *   _M_dataplus                          _M_refcount
5236ac495dSmrg    *   _M_p ---------------->               unnamed array of char_type
5336ac495dSmrg    *  @endcode
5436ac495dSmrg    *
5536ac495dSmrg    *  Where the _M_p points to the first character in the string, and
5636ac495dSmrg    *  you cast it to a pointer-to-_Rep and subtract 1 to get a
5736ac495dSmrg    *  pointer to the header.
5836ac495dSmrg    *
5936ac495dSmrg    *  This approach has the enormous advantage that a string object
6036ac495dSmrg    *  requires only one allocation.  All the ugliness is confined
6136ac495dSmrg    *  within a single pair of inline functions, which each compile to
6236ac495dSmrg    *  a single @a add instruction: _Rep::_M_refdata(), and
6336ac495dSmrg    *  __rc_string_base::_M_rep(); and the allocation function which gets a
6436ac495dSmrg    *  block of raw bytes and with room enough and constructs a _Rep
6536ac495dSmrg    *  object at the front.
6636ac495dSmrg    *
6736ac495dSmrg    *  The reason you want _M_data pointing to the character array and
6836ac495dSmrg    *  not the _Rep is so that the debugger can see the string
6936ac495dSmrg    *  contents. (Probably we should add a non-inline member to get
7036ac495dSmrg    *  the _Rep for the debugger to use, so users can check the actual
7136ac495dSmrg    *  string length.)
7236ac495dSmrg    *
7336ac495dSmrg    *  Note that the _Rep object is a POD so that you can have a
7436ac495dSmrg    *  static <em>empty string</em> _Rep object already @a constructed before
7536ac495dSmrg    *  static constructors have run.  The reference-count encoding is
7636ac495dSmrg    *  chosen so that a 0 indicates one reference, so you never try to
7736ac495dSmrg    *  destroy the empty-string _Rep object.
7836ac495dSmrg    *
7936ac495dSmrg    *  All but the last paragraph is considered pretty conventional
8036ac495dSmrg    *  for a C++ string implementation.
8136ac495dSmrg   */
8236ac495dSmrg  template<typename _CharT, typename _Traits, typename _Alloc>
8336ac495dSmrg     class __rc_string_base
8436ac495dSmrg     : protected __vstring_utility<_CharT, _Traits, _Alloc>
8536ac495dSmrg     {
8636ac495dSmrg     public:
8736ac495dSmrg       typedef _Traits					    traits_type;
8836ac495dSmrg       typedef typename _Traits::char_type		    value_type;
8936ac495dSmrg       typedef _Alloc					    allocator_type;
9036ac495dSmrg 
9136ac495dSmrg       typedef __vstring_utility<_CharT, _Traits, _Alloc>    _Util_Base;
9236ac495dSmrg       typedef typename _Util_Base::_CharT_alloc_type        _CharT_alloc_type;
9336ac495dSmrg       typedef typename _CharT_alloc_type::size_type	    size_type;
9436ac495dSmrg 
9536ac495dSmrg     private:
9636ac495dSmrg       // _Rep: string representation
9736ac495dSmrg       //   Invariants:
9836ac495dSmrg       //   1. String really contains _M_length + 1 characters: due to 21.3.4
9936ac495dSmrg       //      must be kept null-terminated.
10036ac495dSmrg       //   2. _M_capacity >= _M_length
10136ac495dSmrg       //      Allocated memory is always (_M_capacity + 1) * sizeof(_CharT).
10236ac495dSmrg       //   3. _M_refcount has three states:
10336ac495dSmrg       //      -1: leaked, one reference, no ref-copies allowed, non-const.
10436ac495dSmrg       //       0: one reference, non-const.
10536ac495dSmrg       //     n>0: n + 1 references, operations require a lock, const.
10636ac495dSmrg       //   4. All fields == 0 is an empty string, given the extra storage
10736ac495dSmrg       //      beyond-the-end for a null terminator; thus, the shared
10836ac495dSmrg       //      empty string representation needs no constructor.
10936ac495dSmrg       struct _Rep
11036ac495dSmrg       {
11136ac495dSmrg 	union
11236ac495dSmrg 	{
11336ac495dSmrg 	  struct
11436ac495dSmrg 	  {
11536ac495dSmrg 	    size_type	    _M_length;
11636ac495dSmrg 	    size_type	    _M_capacity;
11736ac495dSmrg 	    _Atomic_word    _M_refcount;
11836ac495dSmrg 	  }                 _M_info;
11936ac495dSmrg 
12036ac495dSmrg 	  // Only for alignment purposes.
12136ac495dSmrg 	  _CharT            _M_align;
12236ac495dSmrg 	};
12336ac495dSmrg 
124*8feb0f0bSmrg 	typedef typename __alloc_traits<_Alloc>::template rebind<_Rep>::other
125*8feb0f0bSmrg 	  _Rep_alloc_type;
12636ac495dSmrg 
12736ac495dSmrg  	_CharT*
12836ac495dSmrg 	_M_refdata() throw()
12936ac495dSmrg 	{ return reinterpret_cast<_CharT*>(this + 1); }
13036ac495dSmrg 
13136ac495dSmrg 	_CharT*
13236ac495dSmrg 	_M_refcopy() throw()
13336ac495dSmrg 	{
13436ac495dSmrg 	  __atomic_add_dispatch(&_M_info._M_refcount, 1);
13536ac495dSmrg 	  return _M_refdata();
13636ac495dSmrg 	}  // XXX MT
13736ac495dSmrg 
13836ac495dSmrg 	void
13936ac495dSmrg 	_M_set_length(size_type __n)
14036ac495dSmrg 	{
14136ac495dSmrg 	  _M_info._M_refcount = 0;  // One reference.
14236ac495dSmrg 	  _M_info._M_length = __n;
14336ac495dSmrg 	  // grrr. (per 21.3.4)
14436ac495dSmrg 	  // You cannot leave those LWG people alone for a second.
14536ac495dSmrg 	  traits_type::assign(_M_refdata()[__n], _CharT());
14636ac495dSmrg 	}
14736ac495dSmrg 
14836ac495dSmrg 	// Create & Destroy
14936ac495dSmrg 	static _Rep*
15036ac495dSmrg 	_S_create(size_type, size_type, const _Alloc&);
15136ac495dSmrg 
15236ac495dSmrg 	void
15336ac495dSmrg 	_M_destroy(const _Alloc&) throw();
15436ac495dSmrg 
15536ac495dSmrg 	_CharT*
15636ac495dSmrg 	_M_clone(const _Alloc&, size_type __res = 0);
15736ac495dSmrg       };
15836ac495dSmrg 
15936ac495dSmrg       struct _Rep_empty
16036ac495dSmrg       : public _Rep
16136ac495dSmrg       {
16236ac495dSmrg 	_CharT              _M_terminal;
16336ac495dSmrg       };
16436ac495dSmrg 
16536ac495dSmrg       static _Rep_empty     _S_empty_rep;
16636ac495dSmrg 
16736ac495dSmrg       // The maximum number of individual char_type elements of an
16836ac495dSmrg       // individual string is determined by _S_max_size. This is the
16936ac495dSmrg       // value that will be returned by max_size().  (Whereas npos
17036ac495dSmrg       // is the maximum number of bytes the allocator can allocate.)
17136ac495dSmrg       // If one was to divvy up the theoretical largest size string,
17236ac495dSmrg       // with a terminating character and m _CharT elements, it'd
17336ac495dSmrg       // look like this:
17436ac495dSmrg       // npos = sizeof(_Rep) + (m * sizeof(_CharT)) + sizeof(_CharT)
17536ac495dSmrg       //        + sizeof(_Rep) - 1
17636ac495dSmrg       // (NB: last two terms for rounding reasons, see _M_create below)
17736ac495dSmrg       // Solving for m:
17836ac495dSmrg       // m = ((npos - 2 * sizeof(_Rep) + 1) / sizeof(_CharT)) - 1
17936ac495dSmrg       // In addition, this implementation halves this amount.
18036ac495dSmrg       enum { _S_max_size = (((static_cast<size_type>(-1) - 2 * sizeof(_Rep)
18136ac495dSmrg 			      + 1) / sizeof(_CharT)) - 1) / 2 };
18236ac495dSmrg 
18336ac495dSmrg       // Data Member (private):
18436ac495dSmrg       mutable typename _Util_Base::template _Alloc_hider<_Alloc>  _M_dataplus;
18536ac495dSmrg 
18636ac495dSmrg       void
18736ac495dSmrg       _M_data(_CharT* __p)
18836ac495dSmrg       { _M_dataplus._M_p = __p; }
18936ac495dSmrg 
19036ac495dSmrg       _Rep*
19136ac495dSmrg       _M_rep() const
19236ac495dSmrg       { return &((reinterpret_cast<_Rep*>(_M_data()))[-1]); }
19336ac495dSmrg 
19436ac495dSmrg       _CharT*
19536ac495dSmrg       _M_grab(const _Alloc& __alloc) const
19636ac495dSmrg       {
19736ac495dSmrg 	return (!_M_is_leaked() && _M_get_allocator() == __alloc)
19836ac495dSmrg 		? _M_rep()->_M_refcopy() : _M_rep()->_M_clone(__alloc);
19936ac495dSmrg       }
20036ac495dSmrg 
20136ac495dSmrg       void
20236ac495dSmrg       _M_dispose()
20336ac495dSmrg       {
20436ac495dSmrg 	// Be race-detector-friendly.  For more info see bits/c++config.
20536ac495dSmrg 	_GLIBCXX_SYNCHRONIZATION_HAPPENS_BEFORE(&_M_rep()->_M_info.
20636ac495dSmrg 						_M_refcount);
20736ac495dSmrg 	if (__exchange_and_add_dispatch(&_M_rep()->_M_info._M_refcount,
20836ac495dSmrg 					-1) <= 0)
20936ac495dSmrg 	  {
21036ac495dSmrg 	    _GLIBCXX_SYNCHRONIZATION_HAPPENS_AFTER(&_M_rep()->_M_info.
21136ac495dSmrg 						   _M_refcount);
21236ac495dSmrg 	    _M_rep()->_M_destroy(_M_get_allocator());
21336ac495dSmrg 	  }
21436ac495dSmrg       }  // XXX MT
21536ac495dSmrg 
21636ac495dSmrg       bool
21736ac495dSmrg       _M_is_leaked() const
21836ac495dSmrg       { return _M_rep()->_M_info._M_refcount < 0; }
21936ac495dSmrg 
22036ac495dSmrg       void
22136ac495dSmrg       _M_set_sharable()
22236ac495dSmrg       { _M_rep()->_M_info._M_refcount = 0; }
22336ac495dSmrg 
22436ac495dSmrg       void
22536ac495dSmrg       _M_leak_hard();
22636ac495dSmrg 
22736ac495dSmrg       // _S_construct_aux is used to implement the 21.3.1 para 15 which
22836ac495dSmrg       // requires special behaviour if _InIterator is an integral type
22936ac495dSmrg       template<typename _InIterator>
23036ac495dSmrg 	static _CharT*
23136ac495dSmrg 	_S_construct_aux(_InIterator __beg, _InIterator __end,
23236ac495dSmrg 			 const _Alloc& __a, std::__false_type)
23336ac495dSmrg 	{
234*8feb0f0bSmrg 	  typedef typename std::iterator_traits<_InIterator>::iterator_category
235*8feb0f0bSmrg 	    _Tag;
23636ac495dSmrg 	  return _S_construct(__beg, __end, __a, _Tag());
23736ac495dSmrg 	}
23836ac495dSmrg 
23936ac495dSmrg       // _GLIBCXX_RESOLVE_LIB_DEFECTS
24036ac495dSmrg       // 438. Ambiguity in the "do the right thing" clause
24136ac495dSmrg       template<typename _Integer>
24236ac495dSmrg 	static _CharT*
24336ac495dSmrg 	_S_construct_aux(_Integer __beg, _Integer __end,
24436ac495dSmrg 			 const _Alloc& __a, std::__true_type)
24536ac495dSmrg 	{ return _S_construct_aux_2(static_cast<size_type>(__beg),
24636ac495dSmrg 				    __end, __a); }
24736ac495dSmrg 
24836ac495dSmrg       static _CharT*
24936ac495dSmrg       _S_construct_aux_2(size_type __req, _CharT __c, const _Alloc& __a)
25036ac495dSmrg       { return _S_construct(__req, __c, __a); }
25136ac495dSmrg 
25236ac495dSmrg       template<typename _InIterator>
25336ac495dSmrg 	static _CharT*
25436ac495dSmrg 	_S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a)
25536ac495dSmrg 	{
25636ac495dSmrg 	  typedef typename std::__is_integer<_InIterator>::__type _Integral;
25736ac495dSmrg 	  return _S_construct_aux(__beg, __end, __a, _Integral());
25836ac495dSmrg 	}
25936ac495dSmrg 
26036ac495dSmrg       // For Input Iterators, used in istreambuf_iterators, etc.
26136ac495dSmrg       template<typename _InIterator>
26236ac495dSmrg 	static _CharT*
26336ac495dSmrg 	 _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
26436ac495dSmrg 		      std::input_iterator_tag);
26536ac495dSmrg 
26636ac495dSmrg       // For forward_iterators up to random_access_iterators, used for
26736ac495dSmrg       // string::iterator, _CharT*, etc.
26836ac495dSmrg       template<typename _FwdIterator>
26936ac495dSmrg 	static _CharT*
27036ac495dSmrg 	_S_construct(_FwdIterator __beg, _FwdIterator __end, const _Alloc& __a,
27136ac495dSmrg 		     std::forward_iterator_tag);
27236ac495dSmrg 
27336ac495dSmrg       static _CharT*
27436ac495dSmrg       _S_construct(size_type __req, _CharT __c, const _Alloc& __a);
27536ac495dSmrg 
27636ac495dSmrg     public:
27736ac495dSmrg       size_type
27836ac495dSmrg       _M_max_size() const
27936ac495dSmrg       { return size_type(_S_max_size); }
28036ac495dSmrg 
28136ac495dSmrg       _CharT*
28236ac495dSmrg       _M_data() const
28336ac495dSmrg       { return _M_dataplus._M_p; }
28436ac495dSmrg 
28536ac495dSmrg       size_type
28636ac495dSmrg       _M_length() const
28736ac495dSmrg       { return _M_rep()->_M_info._M_length; }
28836ac495dSmrg 
28936ac495dSmrg       size_type
29036ac495dSmrg       _M_capacity() const
29136ac495dSmrg       { return _M_rep()->_M_info._M_capacity; }
29236ac495dSmrg 
29336ac495dSmrg       bool
29436ac495dSmrg       _M_is_shared() const
29536ac495dSmrg       { return _M_rep()->_M_info._M_refcount > 0; }
29636ac495dSmrg 
29736ac495dSmrg       void
29836ac495dSmrg       _M_set_leaked()
29936ac495dSmrg       { _M_rep()->_M_info._M_refcount = -1; }
30036ac495dSmrg 
30136ac495dSmrg       void
30236ac495dSmrg       _M_leak()    // for use in begin() & non-const op[]
30336ac495dSmrg       {
30436ac495dSmrg 	if (!_M_is_leaked())
30536ac495dSmrg 	  _M_leak_hard();
30636ac495dSmrg       }
30736ac495dSmrg 
30836ac495dSmrg       void
30936ac495dSmrg       _M_set_length(size_type __n)
31036ac495dSmrg       { _M_rep()->_M_set_length(__n); }
31136ac495dSmrg 
31236ac495dSmrg       __rc_string_base()
31336ac495dSmrg       : _M_dataplus(_S_empty_rep._M_refcopy()) { }
31436ac495dSmrg 
31536ac495dSmrg       __rc_string_base(const _Alloc& __a);
31636ac495dSmrg 
31736ac495dSmrg       __rc_string_base(const __rc_string_base& __rcs);
31836ac495dSmrg 
31936ac495dSmrg #if __cplusplus >= 201103L
32036ac495dSmrg       __rc_string_base(__rc_string_base&& __rcs)
32136ac495dSmrg       : _M_dataplus(__rcs._M_dataplus)
32236ac495dSmrg       { __rcs._M_data(_S_empty_rep._M_refcopy()); }
32336ac495dSmrg #endif
32436ac495dSmrg 
32536ac495dSmrg       __rc_string_base(size_type __n, _CharT __c, const _Alloc& __a);
32636ac495dSmrg 
32736ac495dSmrg       template<typename _InputIterator>
32836ac495dSmrg 	__rc_string_base(_InputIterator __beg, _InputIterator __end,
32936ac495dSmrg 			 const _Alloc& __a);
33036ac495dSmrg 
33136ac495dSmrg       ~__rc_string_base()
33236ac495dSmrg       { _M_dispose(); }
33336ac495dSmrg 
33436ac495dSmrg       allocator_type&
33536ac495dSmrg       _M_get_allocator()
33636ac495dSmrg       { return _M_dataplus; }
33736ac495dSmrg 
33836ac495dSmrg       const allocator_type&
33936ac495dSmrg       _M_get_allocator() const
34036ac495dSmrg       { return _M_dataplus; }
34136ac495dSmrg 
34236ac495dSmrg       void
34336ac495dSmrg       _M_swap(__rc_string_base& __rcs);
34436ac495dSmrg 
34536ac495dSmrg       void
34636ac495dSmrg       _M_assign(const __rc_string_base& __rcs);
34736ac495dSmrg 
34836ac495dSmrg       void
34936ac495dSmrg       _M_reserve(size_type __res);
35036ac495dSmrg 
35136ac495dSmrg       void
35236ac495dSmrg       _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
35336ac495dSmrg 		size_type __len2);
35436ac495dSmrg 
35536ac495dSmrg       void
35636ac495dSmrg       _M_erase(size_type __pos, size_type __n);
35736ac495dSmrg 
35836ac495dSmrg       void
35936ac495dSmrg       _M_clear()
36036ac495dSmrg       {
36136ac495dSmrg 	_M_dispose();
36236ac495dSmrg 	_M_data(_S_empty_rep._M_refcopy());
36336ac495dSmrg       }
36436ac495dSmrg 
36536ac495dSmrg       bool
36636ac495dSmrg       _M_compare(const __rc_string_base&) const
36736ac495dSmrg       { return false; }
36836ac495dSmrg     };
36936ac495dSmrg 
37036ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
37136ac495dSmrg     typename __rc_string_base<_CharT, _Traits, _Alloc>::_Rep_empty
37236ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::_S_empty_rep;
37336ac495dSmrg 
37436ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
37536ac495dSmrg     typename __rc_string_base<_CharT, _Traits, _Alloc>::_Rep*
37636ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::_Rep::
37736ac495dSmrg     _S_create(size_type __capacity, size_type __old_capacity,
37836ac495dSmrg 	      const _Alloc& __alloc)
37936ac495dSmrg     {
38036ac495dSmrg       // _GLIBCXX_RESOLVE_LIB_DEFECTS
38136ac495dSmrg       // 83.  String::npos vs. string::max_size()
38236ac495dSmrg       if (__capacity > size_type(_S_max_size))
38336ac495dSmrg 	std::__throw_length_error(__N("__rc_string_base::_Rep::_S_create"));
38436ac495dSmrg 
38536ac495dSmrg       // The standard places no restriction on allocating more memory
38636ac495dSmrg       // than is strictly needed within this layer at the moment or as
38736ac495dSmrg       // requested by an explicit application call to reserve().
38836ac495dSmrg 
38936ac495dSmrg       // Many malloc implementations perform quite poorly when an
39036ac495dSmrg       // application attempts to allocate memory in a stepwise fashion
39136ac495dSmrg       // growing each allocation size by only 1 char.  Additionally,
39236ac495dSmrg       // it makes little sense to allocate less linear memory than the
39336ac495dSmrg       // natural blocking size of the malloc implementation.
39436ac495dSmrg       // Unfortunately, we would need a somewhat low-level calculation
39536ac495dSmrg       // with tuned parameters to get this perfect for any particular
39636ac495dSmrg       // malloc implementation.  Fortunately, generalizations about
39736ac495dSmrg       // common features seen among implementations seems to suffice.
39836ac495dSmrg 
39936ac495dSmrg       // __pagesize need not match the actual VM page size for good
40036ac495dSmrg       // results in practice, thus we pick a common value on the low
40136ac495dSmrg       // side.  __malloc_header_size is an estimate of the amount of
40236ac495dSmrg       // overhead per memory allocation (in practice seen N * sizeof
40336ac495dSmrg       // (void*) where N is 0, 2 or 4).  According to folklore,
40436ac495dSmrg       // picking this value on the high side is better than
40536ac495dSmrg       // low-balling it (especially when this algorithm is used with
40636ac495dSmrg       // malloc implementations that allocate memory blocks rounded up
40736ac495dSmrg       // to a size which is a power of 2).
40836ac495dSmrg       const size_type __pagesize = 4096;
40936ac495dSmrg       const size_type __malloc_header_size = 4 * sizeof(void*);
41036ac495dSmrg 
41136ac495dSmrg       // The below implements an exponential growth policy, necessary to
41236ac495dSmrg       // meet amortized linear time requirements of the library: see
41336ac495dSmrg       // http://gcc.gnu.org/ml/libstdc++/2001-07/msg00085.html.
41436ac495dSmrg       if (__capacity > __old_capacity && __capacity < 2 * __old_capacity)
41536ac495dSmrg 	{
41636ac495dSmrg 	  __capacity = 2 * __old_capacity;
41736ac495dSmrg 	  // Never allocate a string bigger than _S_max_size.
41836ac495dSmrg 	  if (__capacity > size_type(_S_max_size))
41936ac495dSmrg 	    __capacity = size_type(_S_max_size);
42036ac495dSmrg 	}
42136ac495dSmrg 
42236ac495dSmrg       // NB: Need an array of char_type[__capacity], plus a terminating
42336ac495dSmrg       // null char_type() element, plus enough for the _Rep data structure,
42436ac495dSmrg       // plus sizeof(_Rep) - 1 to upper round to a size multiple of
42536ac495dSmrg       // sizeof(_Rep).
42636ac495dSmrg       // Whew. Seemingly so needy, yet so elemental.
42736ac495dSmrg       size_type __size = ((__capacity + 1) * sizeof(_CharT)
42836ac495dSmrg 			  + 2 * sizeof(_Rep) - 1);
42936ac495dSmrg 
43036ac495dSmrg       const size_type __adj_size = __size + __malloc_header_size;
43136ac495dSmrg       if (__adj_size > __pagesize && __capacity > __old_capacity)
43236ac495dSmrg 	{
43336ac495dSmrg 	  const size_type __extra = __pagesize - __adj_size % __pagesize;
43436ac495dSmrg 	  __capacity += __extra / sizeof(_CharT);
43536ac495dSmrg 	  if (__capacity > size_type(_S_max_size))
43636ac495dSmrg 	    __capacity = size_type(_S_max_size);
43736ac495dSmrg 	  __size = (__capacity + 1) * sizeof(_CharT) + 2 * sizeof(_Rep) - 1;
43836ac495dSmrg 	}
43936ac495dSmrg 
44036ac495dSmrg       // NB: Might throw, but no worries about a leak, mate: _Rep()
44136ac495dSmrg       // does not throw.
44236ac495dSmrg       _Rep* __place = _Rep_alloc_type(__alloc).allocate(__size / sizeof(_Rep));
44336ac495dSmrg       _Rep* __p = new (__place) _Rep;
44436ac495dSmrg       __p->_M_info._M_capacity = __capacity;
44536ac495dSmrg       return __p;
44636ac495dSmrg     }
44736ac495dSmrg 
44836ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
44936ac495dSmrg     void
45036ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::_Rep::
45136ac495dSmrg     _M_destroy(const _Alloc& __a) throw ()
45236ac495dSmrg     {
45336ac495dSmrg       const size_type __size = ((_M_info._M_capacity + 1) * sizeof(_CharT)
45436ac495dSmrg 				+ 2 * sizeof(_Rep) - 1);
45536ac495dSmrg       _Rep_alloc_type(__a).deallocate(this, __size / sizeof(_Rep));
45636ac495dSmrg     }
45736ac495dSmrg 
45836ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
45936ac495dSmrg     _CharT*
46036ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::_Rep::
46136ac495dSmrg     _M_clone(const _Alloc& __alloc, size_type __res)
46236ac495dSmrg     {
46336ac495dSmrg       // Requested capacity of the clone.
46436ac495dSmrg       const size_type __requested_cap = _M_info._M_length + __res;
46536ac495dSmrg       _Rep* __r = _Rep::_S_create(__requested_cap, _M_info._M_capacity,
46636ac495dSmrg 				  __alloc);
46736ac495dSmrg 
46836ac495dSmrg       if (_M_info._M_length)
46936ac495dSmrg 	__rc_string_base::_S_copy(__r->_M_refdata(), _M_refdata(), _M_info._M_length);
47036ac495dSmrg 
47136ac495dSmrg       __r->_M_set_length(_M_info._M_length);
47236ac495dSmrg       return __r->_M_refdata();
47336ac495dSmrg     }
47436ac495dSmrg 
47536ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
47636ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
47736ac495dSmrg     __rc_string_base(const _Alloc& __a)
47836ac495dSmrg     : _M_dataplus(__a, _S_construct(size_type(), _CharT(), __a)) { }
47936ac495dSmrg 
48036ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
48136ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
48236ac495dSmrg     __rc_string_base(const __rc_string_base& __rcs)
48336ac495dSmrg     : _M_dataplus(__rcs._M_get_allocator(),
48436ac495dSmrg 		  __rcs._M_grab(__rcs._M_get_allocator())) { }
48536ac495dSmrg 
48636ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
48736ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
48836ac495dSmrg     __rc_string_base(size_type __n, _CharT __c, const _Alloc& __a)
48936ac495dSmrg     : _M_dataplus(__a, _S_construct(__n, __c, __a)) { }
49036ac495dSmrg 
49136ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
49236ac495dSmrg     template<typename _InputIterator>
49336ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
49436ac495dSmrg     __rc_string_base(_InputIterator __beg, _InputIterator __end,
49536ac495dSmrg 		     const _Alloc& __a)
49636ac495dSmrg     : _M_dataplus(__a, _S_construct(__beg, __end, __a)) { }
49736ac495dSmrg 
49836ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
49936ac495dSmrg     void
50036ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
50136ac495dSmrg     _M_leak_hard()
50236ac495dSmrg     {
50336ac495dSmrg       if (_M_is_shared())
50436ac495dSmrg 	_M_erase(0, 0);
50536ac495dSmrg       _M_set_leaked();
50636ac495dSmrg     }
50736ac495dSmrg 
50836ac495dSmrg   // NB: This is the special case for Input Iterators, used in
50936ac495dSmrg   // istreambuf_iterators, etc.
51036ac495dSmrg   // Input Iterators have a cost structure very different from
51136ac495dSmrg   // pointers, calling for a different coding style.
51236ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
51336ac495dSmrg     template<typename _InIterator>
51436ac495dSmrg       _CharT*
51536ac495dSmrg       __rc_string_base<_CharT, _Traits, _Alloc>::
51636ac495dSmrg       _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
51736ac495dSmrg 		   std::input_iterator_tag)
51836ac495dSmrg       {
51936ac495dSmrg 	if (__beg == __end && __a == _Alloc())
52036ac495dSmrg 	  return _S_empty_rep._M_refcopy();
52136ac495dSmrg 
52236ac495dSmrg 	// Avoid reallocation for common case.
52336ac495dSmrg 	_CharT __buf[128];
52436ac495dSmrg 	size_type __len = 0;
52536ac495dSmrg 	while (__beg != __end && __len < sizeof(__buf) / sizeof(_CharT))
52636ac495dSmrg 	  {
52736ac495dSmrg 	    __buf[__len++] = *__beg;
52836ac495dSmrg 	    ++__beg;
52936ac495dSmrg 	  }
53036ac495dSmrg 	_Rep* __r = _Rep::_S_create(__len, size_type(0), __a);
53136ac495dSmrg 	_S_copy(__r->_M_refdata(), __buf, __len);
53236ac495dSmrg 	__try
53336ac495dSmrg 	  {
53436ac495dSmrg 	    while (__beg != __end)
53536ac495dSmrg 	      {
53636ac495dSmrg 		if (__len == __r->_M_info._M_capacity)
53736ac495dSmrg 		  {
53836ac495dSmrg 		    // Allocate more space.
53936ac495dSmrg 		    _Rep* __another = _Rep::_S_create(__len + 1, __len, __a);
54036ac495dSmrg 		    _S_copy(__another->_M_refdata(), __r->_M_refdata(), __len);
54136ac495dSmrg 		    __r->_M_destroy(__a);
54236ac495dSmrg 		    __r = __another;
54336ac495dSmrg 		  }
54436ac495dSmrg 		__r->_M_refdata()[__len++] = *__beg;
54536ac495dSmrg 		++__beg;
54636ac495dSmrg 	      }
54736ac495dSmrg 	  }
54836ac495dSmrg 	__catch(...)
54936ac495dSmrg 	  {
55036ac495dSmrg 	    __r->_M_destroy(__a);
55136ac495dSmrg 	    __throw_exception_again;
55236ac495dSmrg 	  }
55336ac495dSmrg 	__r->_M_set_length(__len);
55436ac495dSmrg 	return __r->_M_refdata();
55536ac495dSmrg       }
55636ac495dSmrg 
55736ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
55836ac495dSmrg     template<typename _InIterator>
55936ac495dSmrg       _CharT*
56036ac495dSmrg       __rc_string_base<_CharT, _Traits, _Alloc>::
56136ac495dSmrg       _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
56236ac495dSmrg 		   std::forward_iterator_tag)
56336ac495dSmrg       {
56436ac495dSmrg 	if (__beg == __end && __a == _Alloc())
56536ac495dSmrg 	  return _S_empty_rep._M_refcopy();
56636ac495dSmrg 
56736ac495dSmrg 	// NB: Not required, but considered best practice.
56836ac495dSmrg 	if (__is_null_pointer(__beg) && __beg != __end)
56936ac495dSmrg 	  std::__throw_logic_error(__N("__rc_string_base::"
57036ac495dSmrg 				       "_S_construct null not valid"));
57136ac495dSmrg 
57236ac495dSmrg 	const size_type __dnew = static_cast<size_type>(std::distance(__beg,
57336ac495dSmrg 								      __end));
57436ac495dSmrg 	// Check for out_of_range and length_error exceptions.
57536ac495dSmrg 	_Rep* __r = _Rep::_S_create(__dnew, size_type(0), __a);
57636ac495dSmrg 	__try
57736ac495dSmrg 	  { __rc_string_base::_S_copy_chars(__r->_M_refdata(), __beg, __end); }
57836ac495dSmrg 	__catch(...)
57936ac495dSmrg 	  {
58036ac495dSmrg 	    __r->_M_destroy(__a);
58136ac495dSmrg 	    __throw_exception_again;
58236ac495dSmrg 	  }
58336ac495dSmrg 	__r->_M_set_length(__dnew);
58436ac495dSmrg 	return __r->_M_refdata();
58536ac495dSmrg       }
58636ac495dSmrg 
58736ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
58836ac495dSmrg     _CharT*
58936ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
59036ac495dSmrg     _S_construct(size_type __n, _CharT __c, const _Alloc& __a)
59136ac495dSmrg     {
59236ac495dSmrg       if (__n == 0 && __a == _Alloc())
59336ac495dSmrg 	return _S_empty_rep._M_refcopy();
59436ac495dSmrg 
59536ac495dSmrg       // Check for out_of_range and length_error exceptions.
59636ac495dSmrg       _Rep* __r = _Rep::_S_create(__n, size_type(0), __a);
59736ac495dSmrg       if (__n)
59836ac495dSmrg 	__rc_string_base::_S_assign(__r->_M_refdata(), __n, __c);
59936ac495dSmrg 
60036ac495dSmrg       __r->_M_set_length(__n);
60136ac495dSmrg       return __r->_M_refdata();
60236ac495dSmrg     }
60336ac495dSmrg 
60436ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
60536ac495dSmrg     void
60636ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
60736ac495dSmrg     _M_swap(__rc_string_base& __rcs)
60836ac495dSmrg     {
60936ac495dSmrg       if (_M_is_leaked())
61036ac495dSmrg 	_M_set_sharable();
61136ac495dSmrg       if (__rcs._M_is_leaked())
61236ac495dSmrg 	__rcs._M_set_sharable();
61336ac495dSmrg 
61436ac495dSmrg       _CharT* __tmp = _M_data();
61536ac495dSmrg       _M_data(__rcs._M_data());
61636ac495dSmrg       __rcs._M_data(__tmp);
61736ac495dSmrg 
61836ac495dSmrg       // _GLIBCXX_RESOLVE_LIB_DEFECTS
61936ac495dSmrg       // 431. Swapping containers with unequal allocators.
62036ac495dSmrg       std::__alloc_swap<allocator_type>::_S_do_it(_M_get_allocator(),
62136ac495dSmrg 						  __rcs._M_get_allocator());
62236ac495dSmrg     }
62336ac495dSmrg 
62436ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
62536ac495dSmrg     void
62636ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
62736ac495dSmrg     _M_assign(const __rc_string_base& __rcs)
62836ac495dSmrg     {
62936ac495dSmrg       if (_M_rep() != __rcs._M_rep())
63036ac495dSmrg 	{
63136ac495dSmrg 	  _CharT* __tmp = __rcs._M_grab(_M_get_allocator());
63236ac495dSmrg 	  _M_dispose();
63336ac495dSmrg 	  _M_data(__tmp);
63436ac495dSmrg 	}
63536ac495dSmrg     }
63636ac495dSmrg 
63736ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
63836ac495dSmrg     void
63936ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
64036ac495dSmrg     _M_reserve(size_type __res)
64136ac495dSmrg     {
64236ac495dSmrg       // Make sure we don't shrink below the current size.
64336ac495dSmrg       if (__res < _M_length())
64436ac495dSmrg 	__res = _M_length();
64536ac495dSmrg 
64636ac495dSmrg       if (__res != _M_capacity() || _M_is_shared())
64736ac495dSmrg 	{
64836ac495dSmrg 	  _CharT* __tmp = _M_rep()->_M_clone(_M_get_allocator(),
64936ac495dSmrg 					     __res - _M_length());
65036ac495dSmrg 	  _M_dispose();
65136ac495dSmrg 	  _M_data(__tmp);
65236ac495dSmrg 	}
65336ac495dSmrg     }
65436ac495dSmrg 
65536ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
65636ac495dSmrg     void
65736ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
65836ac495dSmrg     _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
65936ac495dSmrg 	      size_type __len2)
66036ac495dSmrg     {
66136ac495dSmrg       const size_type __how_much = _M_length() - __pos - __len1;
66236ac495dSmrg 
66336ac495dSmrg       _Rep* __r = _Rep::_S_create(_M_length() + __len2 - __len1,
66436ac495dSmrg 				  _M_capacity(), _M_get_allocator());
66536ac495dSmrg 
66636ac495dSmrg       if (__pos)
66736ac495dSmrg 	this->_S_copy(__r->_M_refdata(), _M_data(), __pos);
66836ac495dSmrg       if (__s && __len2)
66936ac495dSmrg 	this->_S_copy(__r->_M_refdata() + __pos, __s, __len2);
67036ac495dSmrg       if (__how_much)
67136ac495dSmrg 	this->_S_copy(__r->_M_refdata() + __pos + __len2,
67236ac495dSmrg 		_M_data() + __pos + __len1, __how_much);
67336ac495dSmrg 
67436ac495dSmrg       _M_dispose();
67536ac495dSmrg       _M_data(__r->_M_refdata());
67636ac495dSmrg     }
67736ac495dSmrg 
67836ac495dSmrg   template<typename _CharT, typename _Traits, typename _Alloc>
67936ac495dSmrg     void
68036ac495dSmrg     __rc_string_base<_CharT, _Traits, _Alloc>::
68136ac495dSmrg     _M_erase(size_type __pos, size_type __n)
68236ac495dSmrg     {
68336ac495dSmrg       const size_type __new_size = _M_length() - __n;
68436ac495dSmrg       const size_type __how_much = _M_length() - __pos - __n;
68536ac495dSmrg 
68636ac495dSmrg       if (_M_is_shared())
68736ac495dSmrg 	{
68836ac495dSmrg 	  // Must reallocate.
68936ac495dSmrg 	  _Rep* __r = _Rep::_S_create(__new_size, _M_capacity(),
69036ac495dSmrg 				      _M_get_allocator());
69136ac495dSmrg 
69236ac495dSmrg 	  if (__pos)
69336ac495dSmrg 	    this->_S_copy(__r->_M_refdata(), _M_data(), __pos);
69436ac495dSmrg 	  if (__how_much)
69536ac495dSmrg 	    this->_S_copy(__r->_M_refdata() + __pos,
69636ac495dSmrg 		    _M_data() + __pos + __n, __how_much);
69736ac495dSmrg 
69836ac495dSmrg 	  _M_dispose();
69936ac495dSmrg 	  _M_data(__r->_M_refdata());
70036ac495dSmrg 	}
70136ac495dSmrg       else if (__how_much && __n)
70236ac495dSmrg 	{
70336ac495dSmrg 	  // Work in-place.
70436ac495dSmrg 	  this->_S_move(_M_data() + __pos,
70536ac495dSmrg 		  _M_data() + __pos + __n, __how_much);
70636ac495dSmrg 	}
70736ac495dSmrg 
70836ac495dSmrg       _M_rep()->_M_set_length(__new_size);
70936ac495dSmrg     }
71036ac495dSmrg 
71136ac495dSmrg   template<>
71236ac495dSmrg     inline bool
71336ac495dSmrg     __rc_string_base<char, std::char_traits<char>,
71436ac495dSmrg 		     std::allocator<char> >::
71536ac495dSmrg     _M_compare(const __rc_string_base& __rcs) const
71636ac495dSmrg     {
71736ac495dSmrg       if (_M_rep() == __rcs._M_rep())
71836ac495dSmrg 	return true;
71936ac495dSmrg       return false;
72036ac495dSmrg     }
72136ac495dSmrg 
72236ac495dSmrg #ifdef _GLIBCXX_USE_WCHAR_T
72336ac495dSmrg   template<>
72436ac495dSmrg     inline bool
72536ac495dSmrg     __rc_string_base<wchar_t, std::char_traits<wchar_t>,
72636ac495dSmrg 		     std::allocator<wchar_t> >::
72736ac495dSmrg     _M_compare(const __rc_string_base& __rcs) const
72836ac495dSmrg     {
72936ac495dSmrg       if (_M_rep() == __rcs._M_rep())
73036ac495dSmrg 	return true;
73136ac495dSmrg       return false;
73236ac495dSmrg     }
73336ac495dSmrg #endif
73436ac495dSmrg 
73536ac495dSmrg _GLIBCXX_END_NAMESPACE_VERSION
73636ac495dSmrg } // namespace
73736ac495dSmrg 
73836ac495dSmrg #endif /* _RC_STRING_BASE_H */
739