xref: /netbsd-src/external/gpl3/gcc/dist/libstdc++-v3/include/ext/rc_string_base.h (revision b1e838363e3c6fc78a55519254d99869742dd33c)
14fee23f9Smrg // Reference-counted versatile string base -*- C++ -*-
24fee23f9Smrg 
3*b1e83836Smrg // Copyright (C) 2005-2022 Free Software Foundation, Inc.
44fee23f9Smrg //
54fee23f9Smrg // This file is part of the GNU ISO C++ Library.  This library is free
64fee23f9Smrg // software; you can redistribute it and/or modify it under the
74fee23f9Smrg // terms of the GNU General Public License as published by the
84fee23f9Smrg // Free Software Foundation; either version 3, or (at your option)
94fee23f9Smrg // any later version.
104fee23f9Smrg 
114fee23f9Smrg // This library is distributed in the hope that it will be useful,
124fee23f9Smrg // but WITHOUT ANY WARRANTY; without even the implied warranty of
134fee23f9Smrg // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
144fee23f9Smrg // GNU General Public License for more details.
154fee23f9Smrg 
164fee23f9Smrg // Under Section 7 of GPL version 3, you are granted additional
174fee23f9Smrg // permissions described in the GCC Runtime Library Exception, version
184fee23f9Smrg // 3.1, as published by the Free Software Foundation.
194fee23f9Smrg 
204fee23f9Smrg // You should have received a copy of the GNU General Public License and
214fee23f9Smrg // a copy of the GCC Runtime Library Exception along with this program;
224fee23f9Smrg // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
234fee23f9Smrg // <http://www.gnu.org/licenses/>.
244fee23f9Smrg 
254fee23f9Smrg /** @file ext/rc_string_base.h
264fee23f9Smrg  *  This is an internal header file, included by other library headers.
2748fb7bfaSmrg  *  Do not attempt to use it directly. @headername{ext/vstring.h}
284fee23f9Smrg  */
294fee23f9Smrg 
304fee23f9Smrg #ifndef _RC_STRING_BASE_H
314fee23f9Smrg #define _RC_STRING_BASE_H 1
324fee23f9Smrg 
334fee23f9Smrg #include <ext/atomicity.h>
34fb8a8121Smrg #include <ext/alloc_traits.h>
354fee23f9Smrg #include <bits/stl_iterator_base_funcs.h>
364fee23f9Smrg 
_GLIBCXX_VISIBILITY(default)3748fb7bfaSmrg namespace __gnu_cxx _GLIBCXX_VISIBILITY(default)
3848fb7bfaSmrg {
3948fb7bfaSmrg _GLIBCXX_BEGIN_NAMESPACE_VERSION
404fee23f9Smrg 
414fee23f9Smrg   /**
424fee23f9Smrg    *  Documentation?  What's that?
434fee23f9Smrg    *  Nathan Myers <ncm@cantrip.org>.
444fee23f9Smrg    *
454fee23f9Smrg    *  A string looks like this:
464fee23f9Smrg    *
474fee23f9Smrg    *  @code
484fee23f9Smrg    *                                        [_Rep]
494fee23f9Smrg    *                                        _M_length
504fee23f9Smrg    *   [__rc_string_base<char_type>]        _M_capacity
514fee23f9Smrg    *   _M_dataplus                          _M_refcount
524fee23f9Smrg    *   _M_p ---------------->               unnamed array of char_type
534fee23f9Smrg    *  @endcode
544fee23f9Smrg    *
554fee23f9Smrg    *  Where the _M_p points to the first character in the string, and
564fee23f9Smrg    *  you cast it to a pointer-to-_Rep and subtract 1 to get a
574fee23f9Smrg    *  pointer to the header.
584fee23f9Smrg    *
594fee23f9Smrg    *  This approach has the enormous advantage that a string object
604fee23f9Smrg    *  requires only one allocation.  All the ugliness is confined
614fee23f9Smrg    *  within a single pair of inline functions, which each compile to
624fee23f9Smrg    *  a single @a add instruction: _Rep::_M_refdata(), and
634fee23f9Smrg    *  __rc_string_base::_M_rep(); and the allocation function which gets a
644fee23f9Smrg    *  block of raw bytes and with room enough and constructs a _Rep
654fee23f9Smrg    *  object at the front.
664fee23f9Smrg    *
674fee23f9Smrg    *  The reason you want _M_data pointing to the character array and
684fee23f9Smrg    *  not the _Rep is so that the debugger can see the string
694fee23f9Smrg    *  contents. (Probably we should add a non-inline member to get
704fee23f9Smrg    *  the _Rep for the debugger to use, so users can check the actual
714fee23f9Smrg    *  string length.)
724fee23f9Smrg    *
734fee23f9Smrg    *  Note that the _Rep object is a POD so that you can have a
744fee23f9Smrg    *  static <em>empty string</em> _Rep object already @a constructed before
754fee23f9Smrg    *  static constructors have run.  The reference-count encoding is
764fee23f9Smrg    *  chosen so that a 0 indicates one reference, so you never try to
774fee23f9Smrg    *  destroy the empty-string _Rep object.
784fee23f9Smrg    *
794fee23f9Smrg    *  All but the last paragraph is considered pretty conventional
804fee23f9Smrg    *  for a C++ string implementation.
814fee23f9Smrg   */
824fee23f9Smrg  template<typename _CharT, typename _Traits, typename _Alloc>
834fee23f9Smrg     class __rc_string_base
844fee23f9Smrg     : protected __vstring_utility<_CharT, _Traits, _Alloc>
854fee23f9Smrg     {
864fee23f9Smrg     public:
874fee23f9Smrg       typedef _Traits					    traits_type;
884fee23f9Smrg       typedef typename _Traits::char_type		    value_type;
894fee23f9Smrg       typedef _Alloc					    allocator_type;
904fee23f9Smrg 
914fee23f9Smrg       typedef __vstring_utility<_CharT, _Traits, _Alloc>    _Util_Base;
924fee23f9Smrg       typedef typename _Util_Base::_CharT_alloc_type        _CharT_alloc_type;
934fee23f9Smrg       typedef typename _CharT_alloc_type::size_type	    size_type;
944fee23f9Smrg 
954fee23f9Smrg     private:
964fee23f9Smrg       // _Rep: string representation
974fee23f9Smrg       //   Invariants:
984fee23f9Smrg       //   1. String really contains _M_length + 1 characters: due to 21.3.4
994fee23f9Smrg       //      must be kept null-terminated.
1004fee23f9Smrg       //   2. _M_capacity >= _M_length
1014fee23f9Smrg       //      Allocated memory is always (_M_capacity + 1) * sizeof(_CharT).
1024fee23f9Smrg       //   3. _M_refcount has three states:
1034fee23f9Smrg       //      -1: leaked, one reference, no ref-copies allowed, non-const.
1044fee23f9Smrg       //       0: one reference, non-const.
1054fee23f9Smrg       //     n>0: n + 1 references, operations require a lock, const.
1064fee23f9Smrg       //   4. All fields == 0 is an empty string, given the extra storage
1074fee23f9Smrg       //      beyond-the-end for a null terminator; thus, the shared
1084fee23f9Smrg       //      empty string representation needs no constructor.
1094fee23f9Smrg       struct _Rep
1104fee23f9Smrg       {
1114fee23f9Smrg 	union
1124fee23f9Smrg 	{
1134fee23f9Smrg 	  struct
1144fee23f9Smrg 	  {
1154fee23f9Smrg 	    size_type	    _M_length;
1164fee23f9Smrg 	    size_type	    _M_capacity;
1174fee23f9Smrg 	    _Atomic_word    _M_refcount;
1184fee23f9Smrg 	  }                 _M_info;
1194fee23f9Smrg 
1204fee23f9Smrg 	  // Only for alignment purposes.
1214fee23f9Smrg 	  _CharT            _M_align;
1224fee23f9Smrg 	};
1234fee23f9Smrg 
124fb8a8121Smrg 	typedef typename __alloc_traits<_Alloc>::template rebind<_Rep>::other
125fb8a8121Smrg 	  _Rep_alloc_type;
1264fee23f9Smrg 
1274fee23f9Smrg  	_CharT*
1284fee23f9Smrg 	_M_refdata() throw()
1294fee23f9Smrg 	{ return reinterpret_cast<_CharT*>(this + 1); }
1304fee23f9Smrg 
1314fee23f9Smrg 	_CharT*
1324fee23f9Smrg 	_M_refcopy() throw()
1334fee23f9Smrg 	{
1344fee23f9Smrg 	  __atomic_add_dispatch(&_M_info._M_refcount, 1);
1354fee23f9Smrg 	  return _M_refdata();
1364fee23f9Smrg 	}  // XXX MT
1374fee23f9Smrg 
1384fee23f9Smrg 	void
1394fee23f9Smrg 	_M_set_length(size_type __n)
1404fee23f9Smrg 	{
1414fee23f9Smrg 	  _M_info._M_refcount = 0;  // One reference.
1424fee23f9Smrg 	  _M_info._M_length = __n;
1434fee23f9Smrg 	  // grrr. (per 21.3.4)
1444fee23f9Smrg 	  // You cannot leave those LWG people alone for a second.
1454fee23f9Smrg 	  traits_type::assign(_M_refdata()[__n], _CharT());
1464fee23f9Smrg 	}
1474fee23f9Smrg 
1484fee23f9Smrg 	// Create & Destroy
1494fee23f9Smrg 	static _Rep*
1504fee23f9Smrg 	_S_create(size_type, size_type, const _Alloc&);
1514fee23f9Smrg 
1524fee23f9Smrg 	void
1534fee23f9Smrg 	_M_destroy(const _Alloc&) throw();
1544fee23f9Smrg 
1554fee23f9Smrg 	_CharT*
1564fee23f9Smrg 	_M_clone(const _Alloc&, size_type __res = 0);
1574fee23f9Smrg       };
1584fee23f9Smrg 
1594fee23f9Smrg       struct _Rep_empty
1604fee23f9Smrg       : public _Rep
1614fee23f9Smrg       {
1624fee23f9Smrg 	_CharT              _M_terminal;
1634fee23f9Smrg       };
1644fee23f9Smrg 
1654fee23f9Smrg       static _Rep_empty     _S_empty_rep;
1664fee23f9Smrg 
1674fee23f9Smrg       // The maximum number of individual char_type elements of an
1684fee23f9Smrg       // individual string is determined by _S_max_size. This is the
1694fee23f9Smrg       // value that will be returned by max_size().  (Whereas npos
1704fee23f9Smrg       // is the maximum number of bytes the allocator can allocate.)
1714fee23f9Smrg       // If one was to divvy up the theoretical largest size string,
1724fee23f9Smrg       // with a terminating character and m _CharT elements, it'd
1734fee23f9Smrg       // look like this:
1744fee23f9Smrg       // npos = sizeof(_Rep) + (m * sizeof(_CharT)) + sizeof(_CharT)
1754fee23f9Smrg       //        + sizeof(_Rep) - 1
1764fee23f9Smrg       // (NB: last two terms for rounding reasons, see _M_create below)
1774fee23f9Smrg       // Solving for m:
1784fee23f9Smrg       // m = ((npos - 2 * sizeof(_Rep) + 1) / sizeof(_CharT)) - 1
1794fee23f9Smrg       // In addition, this implementation halves this amount.
1804fee23f9Smrg       enum { _S_max_size = (((static_cast<size_type>(-1) - 2 * sizeof(_Rep)
1814fee23f9Smrg 			      + 1) / sizeof(_CharT)) - 1) / 2 };
1824fee23f9Smrg 
1834fee23f9Smrg       // Data Member (private):
1844fee23f9Smrg       mutable typename _Util_Base::template _Alloc_hider<_Alloc>  _M_dataplus;
1854fee23f9Smrg 
1864fee23f9Smrg       void
1874fee23f9Smrg       _M_data(_CharT* __p)
1884fee23f9Smrg       { _M_dataplus._M_p = __p; }
1894fee23f9Smrg 
1904fee23f9Smrg       _Rep*
1914fee23f9Smrg       _M_rep() const
1924fee23f9Smrg       { return &((reinterpret_cast<_Rep*>(_M_data()))[-1]); }
1934fee23f9Smrg 
1944fee23f9Smrg       _CharT*
1954fee23f9Smrg       _M_grab(const _Alloc& __alloc) const
1964fee23f9Smrg       {
1974fee23f9Smrg 	return (!_M_is_leaked() && _M_get_allocator() == __alloc)
1984fee23f9Smrg 		? _M_rep()->_M_refcopy() : _M_rep()->_M_clone(__alloc);
1994fee23f9Smrg       }
2004fee23f9Smrg 
2014fee23f9Smrg       void
2024fee23f9Smrg       _M_dispose()
2034fee23f9Smrg       {
20448fb7bfaSmrg 	// Be race-detector-friendly.  For more info see bits/c++config.
20548fb7bfaSmrg 	_GLIBCXX_SYNCHRONIZATION_HAPPENS_BEFORE(&_M_rep()->_M_info.
20648fb7bfaSmrg 						_M_refcount);
2074fee23f9Smrg 	if (__exchange_and_add_dispatch(&_M_rep()->_M_info._M_refcount,
2084fee23f9Smrg 					-1) <= 0)
20948fb7bfaSmrg 	  {
21048fb7bfaSmrg 	    _GLIBCXX_SYNCHRONIZATION_HAPPENS_AFTER(&_M_rep()->_M_info.
21148fb7bfaSmrg 						   _M_refcount);
2124fee23f9Smrg 	    _M_rep()->_M_destroy(_M_get_allocator());
21348fb7bfaSmrg 	  }
2144fee23f9Smrg       }  // XXX MT
2154fee23f9Smrg 
2164fee23f9Smrg       bool
2174fee23f9Smrg       _M_is_leaked() const
2184fee23f9Smrg       { return _M_rep()->_M_info._M_refcount < 0; }
2194fee23f9Smrg 
2204fee23f9Smrg       void
2214fee23f9Smrg       _M_set_sharable()
2224fee23f9Smrg       { _M_rep()->_M_info._M_refcount = 0; }
2234fee23f9Smrg 
2244fee23f9Smrg       void
2254fee23f9Smrg       _M_leak_hard();
2264fee23f9Smrg 
2274fee23f9Smrg       // _S_construct_aux is used to implement the 21.3.1 para 15 which
2284fee23f9Smrg       // requires special behaviour if _InIterator is an integral type
2294fee23f9Smrg       template<typename _InIterator>
2304fee23f9Smrg 	static _CharT*
2314fee23f9Smrg 	_S_construct_aux(_InIterator __beg, _InIterator __end,
2324fee23f9Smrg 			 const _Alloc& __a, std::__false_type)
2334fee23f9Smrg 	{
234fb8a8121Smrg 	  typedef typename std::iterator_traits<_InIterator>::iterator_category
235fb8a8121Smrg 	    _Tag;
2364fee23f9Smrg 	  return _S_construct(__beg, __end, __a, _Tag());
2374fee23f9Smrg 	}
2384fee23f9Smrg 
2394fee23f9Smrg       // _GLIBCXX_RESOLVE_LIB_DEFECTS
2404fee23f9Smrg       // 438. Ambiguity in the "do the right thing" clause
2414fee23f9Smrg       template<typename _Integer>
2424fee23f9Smrg 	static _CharT*
2434fee23f9Smrg 	_S_construct_aux(_Integer __beg, _Integer __end,
2444fee23f9Smrg 			 const _Alloc& __a, std::__true_type)
2454fee23f9Smrg 	{ return _S_construct_aux_2(static_cast<size_type>(__beg),
2464fee23f9Smrg 				    __end, __a); }
2474fee23f9Smrg 
2484fee23f9Smrg       static _CharT*
2494fee23f9Smrg       _S_construct_aux_2(size_type __req, _CharT __c, const _Alloc& __a)
2504fee23f9Smrg       { return _S_construct(__req, __c, __a); }
2514fee23f9Smrg 
2524fee23f9Smrg       template<typename _InIterator>
2534fee23f9Smrg 	static _CharT*
2544fee23f9Smrg 	_S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a)
2554fee23f9Smrg 	{
2564fee23f9Smrg 	  typedef typename std::__is_integer<_InIterator>::__type _Integral;
2574fee23f9Smrg 	  return _S_construct_aux(__beg, __end, __a, _Integral());
2584fee23f9Smrg 	}
2594fee23f9Smrg 
2604fee23f9Smrg       // For Input Iterators, used in istreambuf_iterators, etc.
2614fee23f9Smrg       template<typename _InIterator>
2624fee23f9Smrg 	static _CharT*
2634fee23f9Smrg 	 _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
2644fee23f9Smrg 		      std::input_iterator_tag);
2654fee23f9Smrg 
2664fee23f9Smrg       // For forward_iterators up to random_access_iterators, used for
2674fee23f9Smrg       // string::iterator, _CharT*, etc.
2684fee23f9Smrg       template<typename _FwdIterator>
2694fee23f9Smrg 	static _CharT*
2704fee23f9Smrg 	_S_construct(_FwdIterator __beg, _FwdIterator __end, const _Alloc& __a,
2714fee23f9Smrg 		     std::forward_iterator_tag);
2724fee23f9Smrg 
2734fee23f9Smrg       static _CharT*
2744fee23f9Smrg       _S_construct(size_type __req, _CharT __c, const _Alloc& __a);
2754fee23f9Smrg 
2764fee23f9Smrg     public:
2774fee23f9Smrg       size_type
2784fee23f9Smrg       _M_max_size() const
2794fee23f9Smrg       { return size_type(_S_max_size); }
2804fee23f9Smrg 
2814fee23f9Smrg       _CharT*
2824fee23f9Smrg       _M_data() const
2834fee23f9Smrg       { return _M_dataplus._M_p; }
2844fee23f9Smrg 
2854fee23f9Smrg       size_type
2864fee23f9Smrg       _M_length() const
2874fee23f9Smrg       { return _M_rep()->_M_info._M_length; }
2884fee23f9Smrg 
2894fee23f9Smrg       size_type
2904fee23f9Smrg       _M_capacity() const
2914fee23f9Smrg       { return _M_rep()->_M_info._M_capacity; }
2924fee23f9Smrg 
2934fee23f9Smrg       bool
2944fee23f9Smrg       _M_is_shared() const
2954fee23f9Smrg       { return _M_rep()->_M_info._M_refcount > 0; }
2964fee23f9Smrg 
2974fee23f9Smrg       void
2984fee23f9Smrg       _M_set_leaked()
2994fee23f9Smrg       { _M_rep()->_M_info._M_refcount = -1; }
3004fee23f9Smrg 
3014fee23f9Smrg       void
3024fee23f9Smrg       _M_leak()    // for use in begin() & non-const op[]
3034fee23f9Smrg       {
3044fee23f9Smrg 	if (!_M_is_leaked())
3054fee23f9Smrg 	  _M_leak_hard();
3064fee23f9Smrg       }
3074fee23f9Smrg 
3084fee23f9Smrg       void
3094fee23f9Smrg       _M_set_length(size_type __n)
3104fee23f9Smrg       { _M_rep()->_M_set_length(__n); }
3114fee23f9Smrg 
3124fee23f9Smrg       __rc_string_base()
3134fee23f9Smrg       : _M_dataplus(_S_empty_rep._M_refcopy()) { }
3144fee23f9Smrg 
3154fee23f9Smrg       __rc_string_base(const _Alloc& __a);
3164fee23f9Smrg 
3174fee23f9Smrg       __rc_string_base(const __rc_string_base& __rcs);
3184fee23f9Smrg 
31948fb7bfaSmrg #if __cplusplus >= 201103L
3204fee23f9Smrg       __rc_string_base(__rc_string_base&& __rcs)
3214fee23f9Smrg       : _M_dataplus(__rcs._M_dataplus)
3224fee23f9Smrg       { __rcs._M_data(_S_empty_rep._M_refcopy()); }
3234fee23f9Smrg #endif
3244fee23f9Smrg 
3254fee23f9Smrg       __rc_string_base(size_type __n, _CharT __c, const _Alloc& __a);
3264fee23f9Smrg 
3274fee23f9Smrg       template<typename _InputIterator>
3284fee23f9Smrg 	__rc_string_base(_InputIterator __beg, _InputIterator __end,
3294fee23f9Smrg 			 const _Alloc& __a);
3304fee23f9Smrg 
3314fee23f9Smrg       ~__rc_string_base()
3324fee23f9Smrg       { _M_dispose(); }
3334fee23f9Smrg 
3344fee23f9Smrg       allocator_type&
3354fee23f9Smrg       _M_get_allocator()
3364fee23f9Smrg       { return _M_dataplus; }
3374fee23f9Smrg 
3384fee23f9Smrg       const allocator_type&
3394fee23f9Smrg       _M_get_allocator() const
3404fee23f9Smrg       { return _M_dataplus; }
3414fee23f9Smrg 
3424fee23f9Smrg       void
3434fee23f9Smrg       _M_swap(__rc_string_base& __rcs);
3444fee23f9Smrg 
3454fee23f9Smrg       void
3464fee23f9Smrg       _M_assign(const __rc_string_base& __rcs);
3474fee23f9Smrg 
3484fee23f9Smrg       void
3494fee23f9Smrg       _M_reserve(size_type __res);
3504fee23f9Smrg 
3514fee23f9Smrg       void
3524fee23f9Smrg       _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
3534fee23f9Smrg 		size_type __len2);
3544fee23f9Smrg 
3554fee23f9Smrg       void
3564fee23f9Smrg       _M_erase(size_type __pos, size_type __n);
3574fee23f9Smrg 
3584fee23f9Smrg       void
3594fee23f9Smrg       _M_clear()
360b17d1066Smrg       {
361b17d1066Smrg 	_M_dispose();
362b17d1066Smrg 	_M_data(_S_empty_rep._M_refcopy());
363b17d1066Smrg       }
3644fee23f9Smrg 
3654fee23f9Smrg       bool
3664fee23f9Smrg       _M_compare(const __rc_string_base&) const
3674fee23f9Smrg       { return false; }
3684fee23f9Smrg     };
3694fee23f9Smrg 
3704fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
3714fee23f9Smrg     typename __rc_string_base<_CharT, _Traits, _Alloc>::_Rep_empty
3724fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::_S_empty_rep;
3734fee23f9Smrg 
3744fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
3754fee23f9Smrg     typename __rc_string_base<_CharT, _Traits, _Alloc>::_Rep*
3764fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::_Rep::
3774fee23f9Smrg     _S_create(size_type __capacity, size_type __old_capacity,
3784fee23f9Smrg 	      const _Alloc& __alloc)
3794fee23f9Smrg     {
3804fee23f9Smrg       // _GLIBCXX_RESOLVE_LIB_DEFECTS
3814fee23f9Smrg       // 83.  String::npos vs. string::max_size()
3824fee23f9Smrg       if (__capacity > size_type(_S_max_size))
3834fee23f9Smrg 	std::__throw_length_error(__N("__rc_string_base::_Rep::_S_create"));
3844fee23f9Smrg 
3854fee23f9Smrg       // The standard places no restriction on allocating more memory
3864fee23f9Smrg       // than is strictly needed within this layer at the moment or as
3874fee23f9Smrg       // requested by an explicit application call to reserve().
3884fee23f9Smrg 
3894fee23f9Smrg       // Many malloc implementations perform quite poorly when an
3904fee23f9Smrg       // application attempts to allocate memory in a stepwise fashion
3914fee23f9Smrg       // growing each allocation size by only 1 char.  Additionally,
3924fee23f9Smrg       // it makes little sense to allocate less linear memory than the
3934fee23f9Smrg       // natural blocking size of the malloc implementation.
3944fee23f9Smrg       // Unfortunately, we would need a somewhat low-level calculation
3954fee23f9Smrg       // with tuned parameters to get this perfect for any particular
3964fee23f9Smrg       // malloc implementation.  Fortunately, generalizations about
3974fee23f9Smrg       // common features seen among implementations seems to suffice.
3984fee23f9Smrg 
3994fee23f9Smrg       // __pagesize need not match the actual VM page size for good
4004fee23f9Smrg       // results in practice, thus we pick a common value on the low
4014fee23f9Smrg       // side.  __malloc_header_size is an estimate of the amount of
4024fee23f9Smrg       // overhead per memory allocation (in practice seen N * sizeof
4034fee23f9Smrg       // (void*) where N is 0, 2 or 4).  According to folklore,
4044fee23f9Smrg       // picking this value on the high side is better than
4054fee23f9Smrg       // low-balling it (especially when this algorithm is used with
4064fee23f9Smrg       // malloc implementations that allocate memory blocks rounded up
4074fee23f9Smrg       // to a size which is a power of 2).
4084fee23f9Smrg       const size_type __pagesize = 4096;
4094fee23f9Smrg       const size_type __malloc_header_size = 4 * sizeof(void*);
4104fee23f9Smrg 
4114fee23f9Smrg       // The below implements an exponential growth policy, necessary to
4124fee23f9Smrg       // meet amortized linear time requirements of the library: see
4134fee23f9Smrg       // http://gcc.gnu.org/ml/libstdc++/2001-07/msg00085.html.
4144fee23f9Smrg       if (__capacity > __old_capacity && __capacity < 2 * __old_capacity)
4154fee23f9Smrg 	{
4164fee23f9Smrg 	  __capacity = 2 * __old_capacity;
4174fee23f9Smrg 	  // Never allocate a string bigger than _S_max_size.
4184fee23f9Smrg 	  if (__capacity > size_type(_S_max_size))
4194fee23f9Smrg 	    __capacity = size_type(_S_max_size);
4204fee23f9Smrg 	}
4214fee23f9Smrg 
4224fee23f9Smrg       // NB: Need an array of char_type[__capacity], plus a terminating
4234fee23f9Smrg       // null char_type() element, plus enough for the _Rep data structure,
4244fee23f9Smrg       // plus sizeof(_Rep) - 1 to upper round to a size multiple of
4254fee23f9Smrg       // sizeof(_Rep).
4264fee23f9Smrg       // Whew. Seemingly so needy, yet so elemental.
4274fee23f9Smrg       size_type __size = ((__capacity + 1) * sizeof(_CharT)
4284fee23f9Smrg 			  + 2 * sizeof(_Rep) - 1);
4294fee23f9Smrg 
4304fee23f9Smrg       const size_type __adj_size = __size + __malloc_header_size;
4314fee23f9Smrg       if (__adj_size > __pagesize && __capacity > __old_capacity)
4324fee23f9Smrg 	{
4334fee23f9Smrg 	  const size_type __extra = __pagesize - __adj_size % __pagesize;
4344fee23f9Smrg 	  __capacity += __extra / sizeof(_CharT);
4354fee23f9Smrg 	  if (__capacity > size_type(_S_max_size))
4364fee23f9Smrg 	    __capacity = size_type(_S_max_size);
4374fee23f9Smrg 	  __size = (__capacity + 1) * sizeof(_CharT) + 2 * sizeof(_Rep) - 1;
4384fee23f9Smrg 	}
4394fee23f9Smrg 
4404fee23f9Smrg       // NB: Might throw, but no worries about a leak, mate: _Rep()
4414fee23f9Smrg       // does not throw.
4424fee23f9Smrg       _Rep* __place = _Rep_alloc_type(__alloc).allocate(__size / sizeof(_Rep));
4434fee23f9Smrg       _Rep* __p = new (__place) _Rep;
4444fee23f9Smrg       __p->_M_info._M_capacity = __capacity;
4454fee23f9Smrg       return __p;
4464fee23f9Smrg     }
4474fee23f9Smrg 
4484fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4494fee23f9Smrg     void
4504fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::_Rep::
4514fee23f9Smrg     _M_destroy(const _Alloc& __a) throw ()
4524fee23f9Smrg     {
4534fee23f9Smrg       const size_type __size = ((_M_info._M_capacity + 1) * sizeof(_CharT)
4544fee23f9Smrg 				+ 2 * sizeof(_Rep) - 1);
4554fee23f9Smrg       _Rep_alloc_type(__a).deallocate(this, __size / sizeof(_Rep));
4564fee23f9Smrg     }
4574fee23f9Smrg 
4584fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4594fee23f9Smrg     _CharT*
4604fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::_Rep::
4614fee23f9Smrg     _M_clone(const _Alloc& __alloc, size_type __res)
4624fee23f9Smrg     {
4634fee23f9Smrg       // Requested capacity of the clone.
4644fee23f9Smrg       const size_type __requested_cap = _M_info._M_length + __res;
4654fee23f9Smrg       _Rep* __r = _Rep::_S_create(__requested_cap, _M_info._M_capacity,
4664fee23f9Smrg 				  __alloc);
4674fee23f9Smrg 
4684fee23f9Smrg       if (_M_info._M_length)
46948fb7bfaSmrg 	__rc_string_base::_S_copy(__r->_M_refdata(), _M_refdata(), _M_info._M_length);
4704fee23f9Smrg 
4714fee23f9Smrg       __r->_M_set_length(_M_info._M_length);
4724fee23f9Smrg       return __r->_M_refdata();
4734fee23f9Smrg     }
4744fee23f9Smrg 
4754fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4764fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
4774fee23f9Smrg     __rc_string_base(const _Alloc& __a)
4784fee23f9Smrg     : _M_dataplus(__a, _S_construct(size_type(), _CharT(), __a)) { }
4794fee23f9Smrg 
4804fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4814fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
4824fee23f9Smrg     __rc_string_base(const __rc_string_base& __rcs)
4834fee23f9Smrg     : _M_dataplus(__rcs._M_get_allocator(),
4844fee23f9Smrg 		  __rcs._M_grab(__rcs._M_get_allocator())) { }
4854fee23f9Smrg 
4864fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4874fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
4884fee23f9Smrg     __rc_string_base(size_type __n, _CharT __c, const _Alloc& __a)
4894fee23f9Smrg     : _M_dataplus(__a, _S_construct(__n, __c, __a)) { }
4904fee23f9Smrg 
4914fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4924fee23f9Smrg     template<typename _InputIterator>
4934fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
4944fee23f9Smrg     __rc_string_base(_InputIterator __beg, _InputIterator __end,
4954fee23f9Smrg 		     const _Alloc& __a)
4964fee23f9Smrg     : _M_dataplus(__a, _S_construct(__beg, __end, __a)) { }
4974fee23f9Smrg 
4984fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
4994fee23f9Smrg     void
5004fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
5014fee23f9Smrg     _M_leak_hard()
5024fee23f9Smrg     {
5034fee23f9Smrg       if (_M_is_shared())
5044fee23f9Smrg 	_M_erase(0, 0);
5054fee23f9Smrg       _M_set_leaked();
5064fee23f9Smrg     }
5074fee23f9Smrg 
5084fee23f9Smrg   // NB: This is the special case for Input Iterators, used in
5094fee23f9Smrg   // istreambuf_iterators, etc.
5104fee23f9Smrg   // Input Iterators have a cost structure very different from
5114fee23f9Smrg   // pointers, calling for a different coding style.
5124fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
5134fee23f9Smrg     template<typename _InIterator>
5144fee23f9Smrg       _CharT*
5154fee23f9Smrg       __rc_string_base<_CharT, _Traits, _Alloc>::
5164fee23f9Smrg       _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
5174fee23f9Smrg 		   std::input_iterator_tag)
5184fee23f9Smrg       {
5194fee23f9Smrg 	if (__beg == __end && __a == _Alloc())
5204fee23f9Smrg 	  return _S_empty_rep._M_refcopy();
5214fee23f9Smrg 
5224fee23f9Smrg 	// Avoid reallocation for common case.
5234fee23f9Smrg 	_CharT __buf[128];
5244fee23f9Smrg 	size_type __len = 0;
5254fee23f9Smrg 	while (__beg != __end && __len < sizeof(__buf) / sizeof(_CharT))
5264fee23f9Smrg 	  {
5274fee23f9Smrg 	    __buf[__len++] = *__beg;
5284fee23f9Smrg 	    ++__beg;
5294fee23f9Smrg 	  }
5304fee23f9Smrg 	_Rep* __r = _Rep::_S_create(__len, size_type(0), __a);
5314fee23f9Smrg 	_S_copy(__r->_M_refdata(), __buf, __len);
5324fee23f9Smrg 	__try
5334fee23f9Smrg 	  {
5344fee23f9Smrg 	    while (__beg != __end)
5354fee23f9Smrg 	      {
5364fee23f9Smrg 		if (__len == __r->_M_info._M_capacity)
5374fee23f9Smrg 		  {
5384fee23f9Smrg 		    // Allocate more space.
5394fee23f9Smrg 		    _Rep* __another = _Rep::_S_create(__len + 1, __len, __a);
5404fee23f9Smrg 		    _S_copy(__another->_M_refdata(), __r->_M_refdata(), __len);
5414fee23f9Smrg 		    __r->_M_destroy(__a);
5424fee23f9Smrg 		    __r = __another;
5434fee23f9Smrg 		  }
5444fee23f9Smrg 		__r->_M_refdata()[__len++] = *__beg;
5454fee23f9Smrg 		++__beg;
5464fee23f9Smrg 	      }
5474fee23f9Smrg 	  }
5484fee23f9Smrg 	__catch(...)
5494fee23f9Smrg 	  {
5504fee23f9Smrg 	    __r->_M_destroy(__a);
5514fee23f9Smrg 	    __throw_exception_again;
5524fee23f9Smrg 	  }
5534fee23f9Smrg 	__r->_M_set_length(__len);
5544fee23f9Smrg 	return __r->_M_refdata();
5554fee23f9Smrg       }
5564fee23f9Smrg 
5574fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
5584fee23f9Smrg     template<typename _InIterator>
5594fee23f9Smrg       _CharT*
5604fee23f9Smrg       __rc_string_base<_CharT, _Traits, _Alloc>::
5614fee23f9Smrg       _S_construct(_InIterator __beg, _InIterator __end, const _Alloc& __a,
5624fee23f9Smrg 		   std::forward_iterator_tag)
5634fee23f9Smrg       {
5644fee23f9Smrg 	if (__beg == __end && __a == _Alloc())
5654fee23f9Smrg 	  return _S_empty_rep._M_refcopy();
5664fee23f9Smrg 
5674fee23f9Smrg 	// NB: Not required, but considered best practice.
5684fee23f9Smrg 	if (__is_null_pointer(__beg) && __beg != __end)
5694fee23f9Smrg 	  std::__throw_logic_error(__N("__rc_string_base::"
57048fb7bfaSmrg 				       "_S_construct null not valid"));
5714fee23f9Smrg 
5724fee23f9Smrg 	const size_type __dnew = static_cast<size_type>(std::distance(__beg,
5734fee23f9Smrg 								      __end));
5744fee23f9Smrg 	// Check for out_of_range and length_error exceptions.
5754fee23f9Smrg 	_Rep* __r = _Rep::_S_create(__dnew, size_type(0), __a);
5764fee23f9Smrg 	__try
57748fb7bfaSmrg 	  { __rc_string_base::_S_copy_chars(__r->_M_refdata(), __beg, __end); }
5784fee23f9Smrg 	__catch(...)
5794fee23f9Smrg 	  {
5804fee23f9Smrg 	    __r->_M_destroy(__a);
5814fee23f9Smrg 	    __throw_exception_again;
5824fee23f9Smrg 	  }
5834fee23f9Smrg 	__r->_M_set_length(__dnew);
5844fee23f9Smrg 	return __r->_M_refdata();
5854fee23f9Smrg       }
5864fee23f9Smrg 
5874fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
5884fee23f9Smrg     _CharT*
5894fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
5904fee23f9Smrg     _S_construct(size_type __n, _CharT __c, const _Alloc& __a)
5914fee23f9Smrg     {
5924fee23f9Smrg       if (__n == 0 && __a == _Alloc())
5934fee23f9Smrg 	return _S_empty_rep._M_refcopy();
5944fee23f9Smrg 
5954fee23f9Smrg       // Check for out_of_range and length_error exceptions.
5964fee23f9Smrg       _Rep* __r = _Rep::_S_create(__n, size_type(0), __a);
5974fee23f9Smrg       if (__n)
59848fb7bfaSmrg 	__rc_string_base::_S_assign(__r->_M_refdata(), __n, __c);
5994fee23f9Smrg 
6004fee23f9Smrg       __r->_M_set_length(__n);
6014fee23f9Smrg       return __r->_M_refdata();
6024fee23f9Smrg     }
6034fee23f9Smrg 
6044fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
6054fee23f9Smrg     void
6064fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
6074fee23f9Smrg     _M_swap(__rc_string_base& __rcs)
6084fee23f9Smrg     {
6094fee23f9Smrg       if (_M_is_leaked())
6104fee23f9Smrg 	_M_set_sharable();
6114fee23f9Smrg       if (__rcs._M_is_leaked())
6124fee23f9Smrg 	__rcs._M_set_sharable();
6134fee23f9Smrg 
6144fee23f9Smrg       _CharT* __tmp = _M_data();
6154fee23f9Smrg       _M_data(__rcs._M_data());
6164fee23f9Smrg       __rcs._M_data(__tmp);
6174fee23f9Smrg 
6184fee23f9Smrg       // _GLIBCXX_RESOLVE_LIB_DEFECTS
6194fee23f9Smrg       // 431. Swapping containers with unequal allocators.
6204fee23f9Smrg       std::__alloc_swap<allocator_type>::_S_do_it(_M_get_allocator(),
6214fee23f9Smrg 						  __rcs._M_get_allocator());
6224fee23f9Smrg     }
6234fee23f9Smrg 
6244fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
6254fee23f9Smrg     void
6264fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
6274fee23f9Smrg     _M_assign(const __rc_string_base& __rcs)
6284fee23f9Smrg     {
6294fee23f9Smrg       if (_M_rep() != __rcs._M_rep())
6304fee23f9Smrg 	{
6314fee23f9Smrg 	  _CharT* __tmp = __rcs._M_grab(_M_get_allocator());
6324fee23f9Smrg 	  _M_dispose();
6334fee23f9Smrg 	  _M_data(__tmp);
6344fee23f9Smrg 	}
6354fee23f9Smrg     }
6364fee23f9Smrg 
6374fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
6384fee23f9Smrg     void
6394fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
6404fee23f9Smrg     _M_reserve(size_type __res)
6414fee23f9Smrg     {
6424fee23f9Smrg       // Make sure we don't shrink below the current size.
6434fee23f9Smrg       if (__res < _M_length())
6444fee23f9Smrg 	__res = _M_length();
6454fee23f9Smrg 
6464fee23f9Smrg       if (__res != _M_capacity() || _M_is_shared())
6474fee23f9Smrg 	{
6484fee23f9Smrg 	  _CharT* __tmp = _M_rep()->_M_clone(_M_get_allocator(),
6494fee23f9Smrg 					     __res - _M_length());
6504fee23f9Smrg 	  _M_dispose();
6514fee23f9Smrg 	  _M_data(__tmp);
6524fee23f9Smrg 	}
6534fee23f9Smrg     }
6544fee23f9Smrg 
6554fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
6564fee23f9Smrg     void
6574fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
6584fee23f9Smrg     _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
6594fee23f9Smrg 	      size_type __len2)
6604fee23f9Smrg     {
6614fee23f9Smrg       const size_type __how_much = _M_length() - __pos - __len1;
6624fee23f9Smrg 
6634fee23f9Smrg       _Rep* __r = _Rep::_S_create(_M_length() + __len2 - __len1,
6644fee23f9Smrg 				  _M_capacity(), _M_get_allocator());
6654fee23f9Smrg 
6664fee23f9Smrg       if (__pos)
66748fb7bfaSmrg 	this->_S_copy(__r->_M_refdata(), _M_data(), __pos);
6684fee23f9Smrg       if (__s && __len2)
66948fb7bfaSmrg 	this->_S_copy(__r->_M_refdata() + __pos, __s, __len2);
6704fee23f9Smrg       if (__how_much)
67148fb7bfaSmrg 	this->_S_copy(__r->_M_refdata() + __pos + __len2,
6724fee23f9Smrg 		_M_data() + __pos + __len1, __how_much);
6734fee23f9Smrg 
6744fee23f9Smrg       _M_dispose();
6754fee23f9Smrg       _M_data(__r->_M_refdata());
6764fee23f9Smrg     }
6774fee23f9Smrg 
6784fee23f9Smrg   template<typename _CharT, typename _Traits, typename _Alloc>
6794fee23f9Smrg     void
6804fee23f9Smrg     __rc_string_base<_CharT, _Traits, _Alloc>::
6814fee23f9Smrg     _M_erase(size_type __pos, size_type __n)
6824fee23f9Smrg     {
6834fee23f9Smrg       const size_type __new_size = _M_length() - __n;
6844fee23f9Smrg       const size_type __how_much = _M_length() - __pos - __n;
6854fee23f9Smrg 
6864fee23f9Smrg       if (_M_is_shared())
6874fee23f9Smrg 	{
6884fee23f9Smrg 	  // Must reallocate.
6894fee23f9Smrg 	  _Rep* __r = _Rep::_S_create(__new_size, _M_capacity(),
6904fee23f9Smrg 				      _M_get_allocator());
6914fee23f9Smrg 
6924fee23f9Smrg 	  if (__pos)
69348fb7bfaSmrg 	    this->_S_copy(__r->_M_refdata(), _M_data(), __pos);
6944fee23f9Smrg 	  if (__how_much)
69548fb7bfaSmrg 	    this->_S_copy(__r->_M_refdata() + __pos,
6964fee23f9Smrg 		    _M_data() + __pos + __n, __how_much);
6974fee23f9Smrg 
6984fee23f9Smrg 	  _M_dispose();
6994fee23f9Smrg 	  _M_data(__r->_M_refdata());
7004fee23f9Smrg 	}
7014fee23f9Smrg       else if (__how_much && __n)
7024fee23f9Smrg 	{
7034fee23f9Smrg 	  // Work in-place.
70448fb7bfaSmrg 	  this->_S_move(_M_data() + __pos,
7054fee23f9Smrg 		  _M_data() + __pos + __n, __how_much);
7064fee23f9Smrg 	}
7074fee23f9Smrg 
7084fee23f9Smrg       _M_rep()->_M_set_length(__new_size);
7094fee23f9Smrg     }
7104fee23f9Smrg 
7114fee23f9Smrg   template<>
7124fee23f9Smrg     inline bool
7134fee23f9Smrg     __rc_string_base<char, std::char_traits<char>,
7144fee23f9Smrg 		     std::allocator<char> >::
7154fee23f9Smrg     _M_compare(const __rc_string_base& __rcs) const
7164fee23f9Smrg     {
7174fee23f9Smrg       if (_M_rep() == __rcs._M_rep())
7184fee23f9Smrg 	return true;
7194fee23f9Smrg       return false;
7204fee23f9Smrg     }
7214fee23f9Smrg 
7224fee23f9Smrg   template<>
7234fee23f9Smrg     inline bool
7244fee23f9Smrg     __rc_string_base<wchar_t, std::char_traits<wchar_t>,
7254fee23f9Smrg 		     std::allocator<wchar_t> >::
7264fee23f9Smrg     _M_compare(const __rc_string_base& __rcs) const
7274fee23f9Smrg     {
7284fee23f9Smrg       if (_M_rep() == __rcs._M_rep())
7294fee23f9Smrg 	return true;
7304fee23f9Smrg       return false;
7314fee23f9Smrg     }
7324fee23f9Smrg 
73348fb7bfaSmrg _GLIBCXX_END_NAMESPACE_VERSION
73448fb7bfaSmrg } // namespace
7354fee23f9Smrg 
7364fee23f9Smrg #endif /* _RC_STRING_BASE_H */
737