libstdc++-v3/include/ext/sso_string_base.h

   1 // Short-string-optimized versatile string base -*- C++ -*-
   2
   3 // Copyright (C) 2005 Free Software Foundation, Inc.
   4 //
   5 // This file is part of the GNU ISO C++ Library.  This library is free
   6 // software; you can redistribute it and/or modify it under the
   7 // terms of the GNU General Public License as published by the
   8 // Free Software Foundation; either version 2, or (at your option)
   9 // any later version.
  10
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 // GNU General Public License for more details.
  15
  16 // You should have received a copy of the GNU General Public License along
  17 // with this library; see the file COPYING.  If not, write to the Free
  18 // Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
  19 // USA.
  20
  21 // As a special exception, you may use this file as part of a free software
  22 // library without restriction.  Specifically, if other files instantiate
  23 // templates or use macros or inline functions from this file, or you compile
  24 // this file and link it with other files to produce an executable, this
  25 // file does not by itself cause the resulting executable to be covered by
  26 // the GNU General Public License.  This exception does not however
  27 // invalidate any other reasons why the executable file might be covered by
  28 // the GNU General Public License.
  29
  30 /** @file ext/sso_string_base.h
  31  *  This file is a GNU extension to the Standard C++ Library.
  32  *  This is an internal header file, included by other library headers.
  33  *  You should not attempt to use it directly.
  34  */
  35
  36 #ifndef _SSO_STRING_BASE_H
  37 #define _SSO_STRING_BASE_H 1
  38
  39 namespace __gnu_cxx
  40 {
  41   template<typename _CharT, typename _Traits, typename _Alloc>
  42     class __sso_string_base
  43     : protected __vstring_utility<_CharT, _Traits, _Alloc>
  44     {
  45     public:
  46       typedef _Traits                                       traits_type;
  47       typedef typename _Traits::char_type                   value_type;
  48       typedef _Alloc                                        allocator_type;
  49
  50       typedef __vstring_utility<_CharT, _Traits, _Alloc>    _Util_Base;
  51       typedef typename _Util_Base::_CharT_alloc_type        _CharT_alloc_type;
  52       typedef typename _CharT_alloc_type::size_type         size_type;
  53
  54     private:
  55       // The maximum number of individual char_type elements of an
  56       // individual string is determined by _S_max_size. This is the
  57       // value that will be returned by max_size().  (Whereas npos
  58       // is the maximum number of bytes the allocator can allocate.)
  59       // If one was to divvy up the theoretical largest size string,
  60       // with a terminating character and m _CharT elements, it'd
  61       // look like this:
  62       // npos = m * sizeof(_CharT) + sizeof(_CharT)
  63       // Solving for m:
  64       // m = npos / sizeof(_CharT) - 1
  65       // In addition, this implementation quarters this amount.
  66       enum { _S_max_size = (((static_cast<size_type>(-1)
  67                               / sizeof(_CharT)) - 1) / 4) };
  68
  69       // Data Members (private):
  70       typename _Util_Base::template _Alloc_hider<_Alloc>    _M_dataplus;
  71       size_type                                             _M_string_length;
  72
  73       enum { _S_local_capacity = 15 };
  74
  75       union
  76       {
  77         _CharT           _M_local_data[_S_local_capacity + 1];
  78         size_type        _M_allocated_capacity;
  79       };
  80
  81       void
  82       _M_data(_CharT* __p)
  83       { _M_dataplus._M_p = __p; }
  84
  85       void
  86       _M_length(size_type __length)
  87       { _M_string_length = __length; }
  88
  89       void
  90       _M_capacity(size_type __capacity)
  91       { _M_allocated_capacity = __capacity; }
  92
  93       bool
  94       _M_is_local() const
  95       { return _M_data() == _M_local_data; }
  96
  97       // Create & Destroy
  98       _CharT*
  99       _M_create(size_type&, size_type);
 100
 101       void
 102       _M_dispose()
 103       {
 104         if (!_M_is_local())
 105           _M_destroy(_M_allocated_capacity + 1);
 106       }
 107
 108       void
 109       _M_destroy(size_type) throw();
 110
 111       // _M_construct_aux is used to implement the 21.3.1 para 15 which
 112       // requires special behaviour if _InIterator is an integral type
 113       template<typename _InIterator>
 114         void
 115         _M_construct_aux(_InIterator __beg, _InIterator __end, __false_type)
 116         {
 117           typedef typename iterator_traits<_InIterator>::iterator_category _Tag;
 118           _M_construct(__beg, __end, _Tag());
 119         }
 120
 121       template<typename _InIterator>
 122         void
 123         _M_construct_aux(_InIterator __beg, _InIterator __end, __true_type)
 124         { _M_construct(static_cast<size_type>(__beg),
 125                        static_cast<value_type>(__end)); }
 126
 127       template<typename _InIterator>
 128         void
 129         _M_construct(_InIterator __beg, _InIterator __end)
 130         {
 131           typedef typename std::__is_integer<_InIterator>::__type _Integral;
 132           _M_construct_aux(__beg, __end, _Integral());
 133         }
 134
 135       // For Input Iterators, used in istreambuf_iterators, etc.
 136       template<typename _InIterator>
 137         void
 138         _M_construct(_InIterator __beg, _InIterator __end,
 139                      std::input_iterator_tag);
 140
 141       // For forward_iterators up to random_access_iterators, used for
 142       // string::iterator, _CharT*, etc.
 143       template<typename _FwdIterator>
 144         void
 145         _M_construct(_FwdIterator __beg, _FwdIterator __end,
 146                      std::forward_iterator_tag);
 147
 148       void
 149       _M_construct(size_type __req, _CharT __c);
 150
 151     public:
 152       size_type
 153       _M_max_size() const
 154       { return size_type(_S_max_size); }
 155
 156       _CharT*
 157       _M_data() const
 158       { return _M_dataplus._M_p; }
 159
 160       size_type
 161       _M_length() const
 162       { return _M_string_length; }
 163
 164       size_type
 165       _M_capacity() const
 166       {
 167         return _M_is_local() ? size_type(_S_local_capacity)
 168                              : _M_allocated_capacity;
 169       }
 170
 171       bool
 172       _M_is_shared() const
 173       { return false; }
 174
 175       void
 176       _M_set_leaked() { }
 177
 178       void
 179       _M_leak() { }
 180
 181       void
 182       _M_set_length(size_type __n)
 183       {
 184         _M_length(__n);
 185         traits_type::assign(_M_data()[__n], _CharT());
 186       }
 187
 188       __sso_string_base()
 189       : _M_dataplus(_Alloc(), _M_local_data)
 190       { _M_set_length(0); }
 191
 192       __sso_string_base(const _Alloc& __a);
 193
 194       __sso_string_base(const __sso_string_base& __rcs);
 195
 196       __sso_string_base(size_type __n, _CharT __c, const _Alloc& __a);
 197
 198       template<typename _InputIterator>
 199         __sso_string_base(_InputIterator __beg, _InputIterator __end,
 200                           const _Alloc& __a);
 201
 202       ~__sso_string_base()
 203       { _M_dispose(); }
 204
 205       allocator_type&
 206       _M_get_allocator()
 207       { return _M_dataplus; }
 208
 209       const allocator_type&
 210       _M_get_allocator() const
 211       { return _M_dataplus; }
 212
 213       void
 214       _M_swap(__sso_string_base& __rcs);
 215
 216       void
 217       _M_assign(const __sso_string_base& __rcs);
 218
 219       void
 220       _M_reserve(size_type __res);
 221
 222       void
 223       _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
 224                 size_type __len2);
 225
 226       void
 227       _M_erase(size_type __pos, size_type __n);
 228     };
 229
 230   template<typename _CharT, typename _Traits, typename _Alloc>
 231     void
 232     __sso_string_base<_CharT, _Traits, _Alloc>::
 233     _M_destroy(size_type __size) throw()
 234     { _CharT_alloc_type(_M_get_allocator()).deallocate(_M_data(), __size); }
 235
 236   template<typename _CharT, typename _Traits, typename _Alloc>
 237     void
 238     __sso_string_base<_CharT, _Traits, _Alloc>::
 239     _M_swap(__sso_string_base& __rcs)
 240     {
 241       // NB: Implement Option 3 of DR 431 (see N1599).
 242       _M_dataplus._M_alloc_swap(__rcs._M_dataplus);
 243
 244       if (_M_is_local())
 245         if (__rcs._M_is_local())
 246           {
 247             if (_M_length() && __rcs._M_length())
 248               {
 249                 _CharT __tmp_data[_S_local_capacity + 1];
 250                 traits_type::copy(__tmp_data, __rcs._M_local_data,
 251                                   _S_local_capacity + 1);
 252                 traits_type::copy(__rcs._M_local_data, _M_local_data,
 253                                   _S_local_capacity + 1);
 254                 traits_type::copy(_M_local_data, __tmp_data,
 255                                   _S_local_capacity + 1);
 256               }
 257             else if (__rcs._M_length())
 258               {
 259                 traits_type::copy(_M_local_data, __rcs._M_local_data,
 260                                   _S_local_capacity + 1);
 261                 _M_length(__rcs._M_length());
 262                 __rcs._M_set_length(0);
 263                 return;
 264               }
 265             else if (_M_length())
 266               {
 267                 traits_type::copy(__rcs._M_local_data, _M_local_data,
 268                                   _S_local_capacity + 1);
 269                 __rcs._M_length(_M_length());
 270                 _M_set_length(0);
 271                 return;
 272               }
 273           }
 274         else
 275           {
 276             const size_type __tmp_capacity = __rcs._M_allocated_capacity;
 277             traits_type::copy(__rcs._M_local_data, _M_local_data,
 278                               _S_local_capacity + 1);
 279             _M_data(__rcs._M_data());
 280             __rcs._M_data(__rcs._M_local_data);
 281             _M_capacity(__tmp_capacity);
 282           }
 283       else
 284         {
 285           const size_type __tmp_capacity = _M_allocated_capacity;
 286           if (__rcs._M_is_local())
 287             {
 288               traits_type::copy(_M_local_data, __rcs._M_local_data,
 289                                 _S_local_capacity + 1);
 290               __rcs._M_data(_M_data());
 291               _M_data(_M_local_data);
 292             }
 293           else
 294             {
 295               _CharT* __tmp_ptr = _M_data();
 296               _M_data(__rcs._M_data());
 297               __rcs._M_data(__tmp_ptr);
 298               _M_capacity(__rcs._M_allocated_capacity);
 299             }
 300           __rcs._M_capacity(__tmp_capacity);
 301         }
 302
 303       const size_type __tmp_length = _M_length();
 304       _M_length(__rcs._M_length());
 305       __rcs._M_length(__tmp_length);
 306     }
 307
 308   template<typename _CharT, typename _Traits, typename _Alloc>
 309     _CharT*
 310     __sso_string_base<_CharT, _Traits, _Alloc>::
 311     _M_create(size_type& __capacity, size_type __old_capacity)
 312     {
 313       // _GLIBCXX_RESOLVE_LIB_DEFECTS
 314       // 83.  String::npos vs. string::max_size()
 315       if (__capacity > size_type(_S_max_size))
 316         std::__throw_length_error(__N("__sso_string_base::_M_create"));
 317
 318       // The below implements an exponential growth policy, necessary to
 319       // meet amortized linear time requirements of the library: see
 320       // http://gcc.gnu.org/ml/libstdc++/2001-07/msg00085.html.
 321       if (__capacity > __old_capacity && __capacity < 2 * __old_capacity)
 322         __capacity = 2 * __old_capacity;
 323
 324       // NB: Need an array of char_type[__capacity], plus a terminating
 325       // null char_type() element.
 326       return _CharT_alloc_type(_M_get_allocator()).allocate(__capacity + 1);
 327     }
 328
 329   template<typename _CharT, typename _Traits, typename _Alloc>
 330     __sso_string_base<_CharT, _Traits, _Alloc>::
 331     __sso_string_base(const _Alloc& __a)
 332     : _M_dataplus(__a, _M_local_data)
 333     { _M_set_length(0); }
 334
 335   template<typename _CharT, typename _Traits, typename _Alloc>
 336     __sso_string_base<_CharT, _Traits, _Alloc>::
 337     __sso_string_base(const __sso_string_base& __rcs)
 338     : _M_dataplus(__rcs._M_get_allocator(), _M_local_data)
 339     { _M_construct(__rcs._M_data(), __rcs._M_data() + __rcs._M_length()); }
 340
 341   template<typename _CharT, typename _Traits, typename _Alloc>
 342     __sso_string_base<_CharT, _Traits, _Alloc>::
 343     __sso_string_base(size_type __n, _CharT __c, const _Alloc& __a)
 344     : _M_dataplus(__a, _M_local_data)
 345     { _M_construct(__n, __c); }
 346
 347   template<typename _CharT, typename _Traits, typename _Alloc>
 348     template<typename _InputIterator>
 349     __sso_string_base<_CharT, _Traits, _Alloc>::
 350     __sso_string_base(_InputIterator __beg, _InputIterator __end,
 351                       const _Alloc& __a)
 352     : _M_dataplus(__a, _M_local_data)
 353     { _M_construct(__beg, __end); }
 354
 355   // NB: This is the special case for Input Iterators, used in
 356   // istreambuf_iterators, etc.
 357   // Input Iterators have a cost structure very different from
 358   // pointers, calling for a different coding style.
 359   template<typename _CharT, typename _Traits, typename _Alloc>
 360     template<typename _InIterator>
 361       void
 362       __sso_string_base<_CharT, _Traits, _Alloc>::
 363       _M_construct(_InIterator __beg, _InIterator __end,
 364                    std::input_iterator_tag)
 365       {
 366         size_type __len = 0;
 367         size_type __capacity = size_type(_S_local_capacity);
 368
 369         while (__beg != __end && __len < __capacity)
 370           {
 371             _M_data()[__len++] = *__beg;
 372             ++__beg;
 373           }
 374
 375         try
 376           {
 377             while (__beg != __end)
 378               {
 379                 if (__len == __capacity)
 380                   {
 381                     // Allocate more space.
 382                     __capacity = __len + 1;
 383                     _CharT* __another = _M_create(__capacity, __len);
 384                     _S_copy(__another, _M_data(), __len);
 385                     _M_dispose();
 386                     _M_data(__another);
 387                     _M_capacity(__capacity);
 388                   }
 389                 _M_data()[__len++] = *__beg;
 390                 ++__beg;
 391               }
 392           }
 393         catch(...)
 394           {
 395             _M_dispose();
 396             __throw_exception_again;
 397           }
 398
 399         _M_set_length(__len);
 400       }
 401
 402   template<typename _CharT, typename _Traits, typename _Alloc>
 403     template<typename _InIterator>
 404       void
 405       __sso_string_base<_CharT, _Traits, _Alloc>::
 406       _M_construct(_InIterator __beg, _InIterator __end,
 407                    std::forward_iterator_tag)
 408       {
 409         // NB: Not required, but considered best practice.
 410         if (__builtin_expect(_S_is_null_pointer(__beg) && __beg != __end, 0))
 411           std::__throw_logic_error(__N("__sso_string_base::"
 412                                        "_M_construct NULL not valid"));
 413
 414         size_type __dnew = static_cast<size_type>(std::distance(__beg, __end));
 415
 416         if (__dnew > size_type(_S_local_capacity))
 417           {
 418             _M_data(_M_create(__dnew, size_type(0)));
 419             _M_capacity(__dnew);
 420           }
 421
 422         // Check for out_of_range and length_error exceptions.
 423         try
 424           { _S_copy_chars(_M_data(), __beg, __end); }
 425         catch(...)
 426           {
 427             _M_dispose();
 428             __throw_exception_again;
 429           }
 430
 431         _M_set_length(__dnew);
 432       }
 433
 434   template<typename _CharT, typename _Traits, typename _Alloc>
 435     void
 436     __sso_string_base<_CharT, _Traits, _Alloc>::
 437     _M_construct(size_type __n, _CharT __c)
 438     {
 439       if (__n > size_type(_S_local_capacity))
 440         {
 441           _M_data(_M_create(__n, size_type(0)));
 442           _M_capacity(__n);
 443         }
 444
 445       if (__n)
 446         _S_assign(_M_data(), __n, __c);
 447
 448       _M_set_length(__n);
 449     }
 450
 451   template<typename _CharT, typename _Traits, typename _Alloc>
 452     void
 453     __sso_string_base<_CharT, _Traits, _Alloc>::
 454     _M_assign(const __sso_string_base& __rcs)
 455     {
 456       if (this != &__rcs)
 457         {
 458           size_type __size = __rcs._M_length();
 459
 460           _CharT* __tmp = _M_local_data;
 461           if (__size > size_type(_S_local_capacity))
 462             __tmp = _M_create(__size, size_type(0));
 463
 464           _M_dispose();
 465           _M_data(__tmp);
 466
 467           if (__size)
 468             _S_copy(_M_data(), __rcs._M_data(), __size);
 469
 470           if (!_M_is_local())
 471             _M_capacity(__size);
 472
 473           _M_set_length(__size);
 474         }
 475     }
 476
 477   template<typename _CharT, typename _Traits, typename _Alloc>
 478     void
 479     __sso_string_base<_CharT, _Traits, _Alloc>::
 480     _M_reserve(size_type __res)
 481     {
 482       // Make sure we don't shrink below the current size.
 483       if (__res < _M_length())
 484         __res = _M_length();
 485
 486       const size_type __capacity = _M_capacity();
 487       if (__res != __capacity)
 488         {
 489           if (__res > __capacity
 490               || __res > size_type(_S_local_capacity))
 491             {
 492               _CharT* __tmp = _M_create(__res, __capacity);
 493               _S_copy(__tmp, _M_data(), _M_length() + 1);
 494               _M_dispose();
 495               _M_data(__tmp);
 496               _M_capacity(__res);
 497             }
 498           else if (!_M_is_local())
 499             {
 500               const size_type __tmp_capacity = _M_allocated_capacity;
 501               _S_copy(_M_local_data, _M_data(), _M_length() + 1);
 502               _M_destroy(__tmp_capacity + 1);
 503               _M_data(_M_local_data);
 504             }
 505         }
 506     }
 507
 508   template<typename _CharT, typename _Traits, typename _Alloc>
 509     void
 510     __sso_string_base<_CharT, _Traits, _Alloc>::
 511     _M_mutate(size_type __pos, size_type __len1, const _CharT* __s,
 512               const size_type __len2)
 513     {
 514       const size_type __how_much = _M_length() - __pos - __len1;
 515
 516       size_type __new_capacity = _M_length() + __len2 - __len1;
 517       _CharT* __r = _M_create(__new_capacity, _M_capacity());
 518
 519       if (__pos)
 520         _S_copy(__r, _M_data(), __pos);
 521       if (__s && __len2)
 522         _S_copy(__r + __pos, __s, __len2);
 523       if (__how_much)
 524         _S_copy(__r + __pos + __len2,
 525                 _M_data() + __pos + __len1, __how_much);
 526
 527       _M_dispose();
 528       _M_data(__r);
 529       _M_capacity(__new_capacity);
 530     }
 531
 532   template<typename _CharT, typename _Traits, typename _Alloc>
 533     void
 534     __sso_string_base<_CharT, _Traits, _Alloc>::
 535     _M_erase(size_type __pos, size_type __n)
 536     {
 537       const size_type __how_much = _M_length() - __pos - __n;
 538
 539       if (__how_much && __n)
 540         _S_move(_M_data() + __pos, _M_data() + __pos + __n,
 541                 __how_much);
 542
 543       _M_set_length(_M_length() - __n);
 544     }
 545 } // namespace __gnu_cxx
 546
 547 #endif /* _SSO_STRING_BASE_H */