make Range::size() constexpr
[folly.git] / folly / FBString.h
1 /*
2  * Copyright 2016 Facebook, Inc.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16
17 // @author: Andrei Alexandrescu (aalexandre)
18 // String type.
19
20 #pragma once
21
22 #include <atomic>
23 #include <limits>
24 #include <type_traits>
25
26 // This file appears in two locations: inside fbcode and in the
27 // libstdc++ source code (when embedding fbstring as std::string).
28 // To aid in this schizophrenic use, _LIBSTDCXX_FBSTRING is defined in
29 // libstdc++'s c++config.h, to gate use inside fbcode v. libstdc++.
30 #ifdef _LIBSTDCXX_FBSTRING
31
32 #pragma GCC system_header
33
34 // When used as std::string replacement always disable assertions.
35 #ifndef NDEBUG
36 #define NDEBUG
37 #define FOLLY_DEFINED_NDEBUG_FOR_FBSTRING
38 #endif // NDEBUG
39
40 // Handle the cases where the fbcode version (folly/Malloc.h) is included
41 // either before or after this inclusion.
42 #ifdef FOLLY_MALLOC_H_
43 #undef FOLLY_MALLOC_H_
44 #include "basic_fbstring_malloc.h" // nolint
45 #else
46 #include "basic_fbstring_malloc.h" // nolint
47 #undef FOLLY_MALLOC_H_
48 #endif
49
50 #else // !_LIBSTDCXX_FBSTRING
51
52 #include <folly/Portability.h>
53
54 // libc++ doesn't provide this header, nor does msvc
55 #ifdef FOLLY_HAVE_BITS_CXXCONFIG_H
56 #include <bits/c++config.h>
57 #endif
58
59 #include <string>
60 #include <cstring>
61 #include <cassert>
62 #include <algorithm>
63
64 #include <folly/Traits.h>
65 #include <folly/Malloc.h>
66 #include <folly/Hash.h>
67 #include <folly/ScopeGuard.h>
68
69 #if FOLLY_HAVE_DEPRECATED_ASSOC
70 #ifdef _GLIBCXX_SYMVER
71 #include <ext/hash_set>
72 #include <ext/hash_map>
73 #endif
74 #endif
75
76 #endif
77
78 // We defined these here rather than including Likely.h to avoid
79 // redefinition errors when fbstring is imported into libstdc++.
80 #if defined(__GNUC__) && __GNUC__ >= 4
81 #define FBSTRING_LIKELY(x)   (__builtin_expect((x), 1))
82 #define FBSTRING_UNLIKELY(x) (__builtin_expect((x), 0))
83 #else
84 #define FBSTRING_LIKELY(x)   (x)
85 #define FBSTRING_UNLIKELY(x) (x)
86 #endif
87
88 #pragma GCC diagnostic push
89 // Ignore shadowing warnings within this file, so includers can use -Wshadow.
90 #pragma GCC diagnostic ignored "-Wshadow"
91 // GCC 4.9 has a false positive in setSmallSize (probably
92 // https://gcc.gnu.org/bugzilla/show_bug.cgi?id=59124), disable
93 // compile-time array bound checking.
94 #pragma GCC diagnostic ignored "-Warray-bounds"
95
96 // FBString cannot use throw when replacing std::string, though it may still
97 // use std::__throw_*
98 // nolint
99 #define throw FOLLY_FBSTRING_MAY_NOT_USE_THROW
100
101 #ifdef _LIBSTDCXX_FBSTRING
102 namespace std _GLIBCXX_VISIBILITY(default) {
103 _GLIBCXX_BEGIN_NAMESPACE_VERSION
104 #else
105 namespace folly {
106 #endif
107
108 #if defined(__clang__)
109 # if __has_feature(address_sanitizer)
110 #  define FBSTRING_SANITIZE_ADDRESS
111 # endif
112 #elif defined (__GNUC__) && \
113       (((__GNUC__ == 4) && (__GNUC_MINOR__ >= 8)) || (__GNUC__ >= 5)) && \
114       __SANITIZE_ADDRESS__
115 # define FBSTRING_SANITIZE_ADDRESS
116 #endif
117
118 // When compiling with ASan, always heap-allocate the string even if
119 // it would fit in-situ, so that ASan can detect access to the string
120 // buffer after it has been invalidated (destroyed, resized, etc.).
121 // Note that this flag doesn't remove support for in-situ strings, as
122 // that would break ABI-compatibility and wouldn't allow linking code
123 // compiled with this flag with code compiled without.
124 #ifdef FBSTRING_SANITIZE_ADDRESS
125 # define FBSTRING_DISABLE_SSO true
126 #else
127 # define FBSTRING_DISABLE_SSO false
128 #endif
129
130 namespace fbstring_detail {
131
132 template <class InIt, class OutIt>
133 inline
134 OutIt copy_n(InIt b,
135              typename std::iterator_traits<InIt>::difference_type n,
136              OutIt d) {
137   for (; n != 0; --n, ++b, ++d) {
138     *d = *b;
139   }
140   return d;
141 }
142
143 template <class Pod, class T>
144 inline void pod_fill(Pod* b, Pod* e, T c) {
145   assert(b && e && b <= e);
146   /*static*/ if (sizeof(T) == 1) {
147     memset(b, c, e - b);
148   } else {
149     auto const ee = b + ((e - b) & ~7u);
150     for (; b != ee; b += 8) {
151       b[0] = c;
152       b[1] = c;
153       b[2] = c;
154       b[3] = c;
155       b[4] = c;
156       b[5] = c;
157       b[6] = c;
158       b[7] = c;
159     }
160     // Leftovers
161     for (; b != e; ++b) {
162       *b = c;
163     }
164   }
165 }
166
167 /*
168  * Lightly structured memcpy, simplifies copying PODs and introduces
169  * some asserts. Unfortunately using this function may cause
170  * measurable overhead (presumably because it adjusts from a begin/end
171  * convention to a pointer/size convention, so it does some extra
172  * arithmetic even though the caller might have done the inverse
173  * adaptation outside).
174  */
175 template <class Pod>
176 inline void pod_copy(const Pod* b, const Pod* e, Pod* d) {
177   assert(e >= b);
178   assert(d >= e || d + (e - b) <= b);
179   memcpy(d, b, (e - b) * sizeof(Pod));
180 }
181
182 /*
183  * Lightly structured memmove, simplifies copying PODs and introduces
184  * some asserts
185  */
186 template <class Pod>
187 inline void pod_move(const Pod* b, const Pod* e, Pod* d) {
188   assert(e >= b);
189   memmove(d, b, (e - b) * sizeof(*b));
190 }
191
192 } // namespace fbstring_detail
193
194 /**
195  * Defines a special acquisition method for constructing fbstring
196  * objects. AcquireMallocatedString means that the user passes a
197  * pointer to a malloc-allocated string that the fbstring object will
198  * take into custody.
199  */
200 enum class AcquireMallocatedString {};
201
202 /*
203  * fbstring_core_model is a mock-up type that defines all required
204  * signatures of a fbstring core. The fbstring class itself uses such
205  * a core object to implement all of the numerous member functions
206  * required by the standard.
207  *
208  * If you want to define a new core, copy the definition below and
209  * implement the primitives. Then plug the core into basic_fbstring as
210  * a template argument.
211
212 template <class Char>
213 class fbstring_core_model {
214 public:
215   fbstring_core_model();
216   fbstring_core_model(const fbstring_core_model &);
217   ~fbstring_core_model();
218   // Returns a pointer to string's buffer (currently only contiguous
219   // strings are supported). The pointer is guaranteed to be valid
220   // until the next call to a non-const member function.
221   const Char * data() const;
222   // Much like data(), except the string is prepared to support
223   // character-level changes. This call is a signal for
224   // e.g. reference-counted implementation to fork the data. The
225   // pointer is guaranteed to be valid until the next call to a
226   // non-const member function.
227   Char * mutable_data();
228   // Returns a pointer to string's buffer and guarantees that a
229   // readable '\0' lies right after the buffer. The pointer is
230   // guaranteed to be valid until the next call to a non-const member
231   // function.
232   const Char * c_str() const;
233   // Shrinks the string by delta characters. Asserts that delta <=
234   // size().
235   void shrink(size_t delta);
236   // Expands the string by delta characters (i.e. after this call
237   // size() will report the old size() plus delta) but without
238   // initializing the expanded region. The expanded region is
239   // zero-terminated. Returns a pointer to the memory to be
240   // initialized (the beginning of the expanded portion). The caller
241   // is expected to fill the expanded area appropriately.
242   // If expGrowth is true, exponential growth is guaranteed.
243   // It is not guaranteed not to reallocate even if size() + delta <
244   // capacity(), so all references to the buffer are invalidated.
245   Char* expand_noinit(size_t delta, bool expGrowth);
246   // Expands the string by one character and sets the last character
247   // to c.
248   void push_back(Char c);
249   // Returns the string's size.
250   size_t size() const;
251   // Returns the string's capacity, i.e. maximum size that the string
252   // can grow to without reallocation. Note that for reference counted
253   // strings that's technically a lie - even assigning characters
254   // within the existing size would cause a reallocation.
255   size_t capacity() const;
256   // Returns true if the data underlying the string is actually shared
257   // across multiple strings (in a refcounted fashion).
258   bool isShared() const;
259   // Makes sure that at least minCapacity characters are available for
260   // the string without reallocation. For reference-counted strings,
261   // it should fork the data even if minCapacity < size().
262   void reserve(size_t minCapacity);
263 private:
264   // Do not implement
265   fbstring_core_model& operator=(const fbstring_core_model &);
266 };
267 */
268
269 /**
270  * This is the core of the string. The code should work on 32- and
271  * 64-bit and both big- and little-endianan architectures with any
272  * Char size.
273  *
274  * The storage is selected as follows (assuming we store one-byte
275  * characters on a 64-bit machine): (a) "small" strings between 0 and
276  * 23 chars are stored in-situ without allocation (the rightmost byte
277  * stores the size); (b) "medium" strings from 24 through 254 chars
278  * are stored in malloc-allocated memory that is copied eagerly; (c)
279  * "large" strings of 255 chars and above are stored in a similar
280  * structure as medium arrays, except that the string is
281  * reference-counted and copied lazily. the reference count is
282  * allocated right before the character array.
283  *
284  * The discriminator between these three strategies sits in two
285  * bits of the rightmost char of the storage. If neither is set, then the
286  * string is small (and its length sits in the lower-order bits on
287  * little-endian or the high-order bits on big-endian of that
288  * rightmost character). If the MSb is set, the string is medium width.
289  * If the second MSb is set, then the string is large. On little-endian,
290  * these 2 bits are the 2 MSbs of MediumLarge::capacity_, while on
291  * big-endian, these 2 bits are the 2 LSbs. This keeps both little-endian
292  * and big-endian fbstring_core equivalent with merely different ops used
293  * to extract capacity/category.
294  */
295 template <class Char> class fbstring_core {
296 protected:
297 // It's MSVC, so we just have to guess ... and allow an override
298 #ifdef _MSC_VER
299 # ifdef FOLLY_ENDIAN_BE
300   static constexpr auto kIsLittleEndian = false;
301 # else
302   static constexpr auto kIsLittleEndian = true;
303 # endif
304 #else
305   static constexpr auto kIsLittleEndian =
306       __BYTE_ORDER__ == __ORDER_LITTLE_ENDIAN__;
307 #endif
308 public:
309   fbstring_core() noexcept { reset(); }
310
311   fbstring_core(const fbstring_core & rhs) {
312     assert(&rhs != this);
313     // Simplest case first: small strings are bitblitted
314     if (rhs.category() == Category::isSmall) {
315       static_assert(offsetof(MediumLarge, data_) == 0,
316           "fbstring layout failure");
317       static_assert(offsetof(MediumLarge, size_) == sizeof(ml_.data_),
318           "fbstring layout failure");
319       static_assert(offsetof(MediumLarge, capacity_) == 2 * sizeof(ml_.data_),
320           "fbstring layout failure");
321       // Just write the whole thing, don't look at details. In
322       // particular we need to copy capacity anyway because we want
323       // to set the size (don't forget that the last character,
324       // which stores a short string's length, is shared with the
325       // ml_.capacity field).
326       ml_ = rhs.ml_;
327       assert(category() == Category::isSmall && this->size() == rhs.size());
328     } else if (rhs.category() == Category::isLarge) {
329       // Large strings are just refcounted
330       ml_ = rhs.ml_;
331       RefCounted::incrementRefs(ml_.data_);
332       assert(category() == Category::isLarge && size() == rhs.size());
333     } else {
334       // Medium strings are copied eagerly. Don't forget to allocate
335       // one extra Char for the null terminator.
336       auto const allocSize =
337            goodMallocSize((1 + rhs.ml_.size_) * sizeof(Char));
338       ml_.data_ = static_cast<Char*>(checkedMalloc(allocSize));
339       // Also copies terminator.
340       fbstring_detail::pod_copy(rhs.ml_.data_,
341                                 rhs.ml_.data_ + rhs.ml_.size_ + 1,
342                                 ml_.data_);
343       ml_.size_ = rhs.ml_.size_;
344       ml_.setCapacity(allocSize / sizeof(Char) - 1, Category::isMedium);
345       assert(category() == Category::isMedium);
346     }
347     assert(size() == rhs.size());
348     assert(memcmp(data(), rhs.data(), size() * sizeof(Char)) == 0);
349   }
350
351   fbstring_core(fbstring_core&& goner) noexcept {
352     // Take goner's guts
353     ml_ = goner.ml_;
354     // Clean goner's carcass
355     goner.reset();
356   }
357
358   fbstring_core(const Char *const data,
359                 const size_t size,
360                 bool disableSSO = FBSTRING_DISABLE_SSO) {
361 #ifndef NDEBUG
362 #ifndef _LIBSTDCXX_FBSTRING
363     SCOPE_EXIT {
364       assert(this->size() == size);
365       assert(size == 0 || memcmp(this->data(), data, size * sizeof(Char)) == 0);
366     };
367 #endif
368 #endif
369
370     // Simplest case first: small strings are bitblitted
371     if (!disableSSO && size <= maxSmallSize) {
372       // Layout is: Char* data_, size_t size_, size_t capacity_
373       static_assert(sizeof(*this) == sizeof(Char*) + 2 * sizeof(size_t),
374           "fbstring has unexpected size");
375       static_assert(sizeof(Char*) == sizeof(size_t),
376           "fbstring size assumption violation");
377       // sizeof(size_t) must be a power of 2
378       static_assert((sizeof(size_t) & (sizeof(size_t) - 1)) == 0,
379           "fbstring size assumption violation");
380
381       // If data is aligned, use fast word-wise copying. Otherwise,
382       // use conservative memcpy.
383       // The word-wise path reads bytes which are outside the range of
384       // the string, and makes ASan unhappy, so we disable it when
385       // compiling with ASan.
386 #ifndef FBSTRING_SANITIZE_ADDRESS
387       if ((reinterpret_cast<size_t>(data) & (sizeof(size_t) - 1)) == 0) {
388         const size_t byteSize = size * sizeof(Char);
389         constexpr size_t wordWidth = sizeof(size_t);
390         switch ((byteSize + wordWidth - 1) / wordWidth) { // Number of words.
391         case 3:
392           ml_.capacity_ = reinterpret_cast<const size_t*>(data)[2];
393         case 2:
394           ml_.size_ = reinterpret_cast<const size_t*>(data)[1];
395         case 1:
396           ml_.data_ = *reinterpret_cast<Char**>(const_cast<Char*>(data));
397         case 0:
398           break;
399         }
400       } else
401 #endif
402       {
403         if (size != 0) {
404           fbstring_detail::pod_copy(data, data + size, small_);
405         }
406       }
407       setSmallSize(size);
408     } else {
409       if (size <= maxMediumSize) {
410         // Medium strings are allocated normally. Don't forget to
411         // allocate one extra Char for the terminating null.
412         auto const allocSize = goodMallocSize((1 + size) * sizeof(Char));
413         ml_.data_ = static_cast<Char*>(checkedMalloc(allocSize));
414         fbstring_detail::pod_copy(data, data + size, ml_.data_);
415         ml_.size_ = size;
416         ml_.setCapacity(allocSize / sizeof(Char) - 1, Category::isMedium);
417       } else {
418         // Large strings are allocated differently
419         size_t effectiveCapacity = size;
420         auto const newRC = RefCounted::create(data, & effectiveCapacity);
421         ml_.data_ = newRC->data_;
422         ml_.size_ = size;
423         ml_.setCapacity(effectiveCapacity, Category::isLarge);
424       }
425       ml_.data_[size] = '\0';
426     }
427   }
428
429   ~fbstring_core() noexcept {
430     auto const c = category();
431     if (c == Category::isSmall) {
432       return;
433     }
434     if (c == Category::isMedium) {
435       free(ml_.data_);
436       return;
437     }
438     RefCounted::decrementRefs(ml_.data_);
439   }
440
441   // Snatches a previously mallocated string. The parameter "size"
442   // is the size of the string, and the parameter "allocatedSize"
443   // is the size of the mallocated block.  The string must be
444   // \0-terminated, so allocatedSize >= size + 1 and data[size] == '\0'.
445   //
446   // So if you want a 2-character string, pass malloc(3) as "data",
447   // pass 2 as "size", and pass 3 as "allocatedSize".
448   fbstring_core(Char * const data,
449                 const size_t size,
450                 const size_t allocatedSize,
451                 AcquireMallocatedString) {
452     if (size > 0) {
453       assert(allocatedSize >= size + 1);
454       assert(data[size] == '\0');
455       // Use the medium string storage
456       ml_.data_ = data;
457       ml_.size_ = size;
458       // Don't forget about null terminator
459       ml_.setCapacity(allocatedSize - 1, Category::isMedium);
460     } else {
461       // No need for the memory
462       free(data);
463       reset();
464     }
465   }
466
467   // swap below doesn't test whether &rhs == this (and instead
468   // potentially does extra work) on the premise that the rarity of
469   // that situation actually makes the check more expensive than is
470   // worth.
471   void swap(fbstring_core & rhs) {
472     auto const t = ml_;
473     ml_ = rhs.ml_;
474     rhs.ml_ = t;
475   }
476
477   // In C++11 data() and c_str() are 100% equivalent.
478   const Char * data() const {
479     return c_str();
480   }
481
482   Char * mutable_data() {
483     auto const c = category();
484     if (c == Category::isSmall) {
485       return small_;
486     }
487     assert(c == Category::isMedium || c == Category::isLarge);
488     if (c == Category::isLarge && RefCounted::refs(ml_.data_) > 1) {
489       // Ensure unique.
490       size_t effectiveCapacity = ml_.capacity();
491       auto const newRC = RefCounted::create(& effectiveCapacity);
492       // If this fails, someone placed the wrong capacity in an
493       // fbstring.
494       assert(effectiveCapacity >= ml_.capacity());
495       // Also copies terminator.
496       fbstring_detail::pod_copy(ml_.data_, ml_.data_ + ml_.size_ + 1,
497                                 newRC->data_);
498       RefCounted::decrementRefs(ml_.data_);
499       ml_.data_ = newRC->data_;
500     }
501     return ml_.data_;
502   }
503
504   const Char * c_str() const {
505     auto const c = category();
506     if (c == Category::isSmall) {
507       assert(small_[smallSize()] == '\0');
508       return small_;
509     }
510     assert(c == Category::isMedium || c == Category::isLarge);
511     assert(ml_.data_[ml_.size_] == '\0');
512     return ml_.data_;
513   }
514
515   void shrink(const size_t delta) {
516     if (category() == Category::isSmall) {
517       // Check for underflow
518       assert(delta <= smallSize());
519       setSmallSize(smallSize() - delta);
520     } else if (category() == Category::isMedium ||
521                RefCounted::refs(ml_.data_) == 1) {
522       // Medium strings and unique large strings need no special
523       // handling.
524       assert(ml_.size_ >= delta);
525       ml_.size_ -= delta;
526       ml_.data_[ml_.size_] = '\0';
527     } else {
528       assert(ml_.size_ >= delta);
529       // Shared large string, must make unique. This is because of the
530       // durn terminator must be written, which may trample the shared
531       // data.
532       if (delta) {
533         fbstring_core(ml_.data_, ml_.size_ - delta).swap(*this);
534       }
535       // No need to write the terminator.
536     }
537   }
538
539   void reserve(size_t minCapacity, bool disableSSO = FBSTRING_DISABLE_SSO) {
540     if (category() == Category::isLarge) {
541       // Ensure unique
542       if (RefCounted::refs(ml_.data_) > 1) {
543         // We must make it unique regardless; in-place reallocation is
544         // useless if the string is shared. In order to not surprise
545         // people, reserve the new block at current capacity or
546         // more. That way, a string's capacity never shrinks after a
547         // call to reserve.
548         minCapacity = std::max(minCapacity, ml_.capacity());
549         auto const newRC = RefCounted::create(& minCapacity);
550         // Also copies terminator.
551         fbstring_detail::pod_copy(ml_.data_, ml_.data_ + ml_.size_ + 1,
552                                    newRC->data_);
553         RefCounted::decrementRefs(ml_.data_);
554         ml_.data_ = newRC->data_;
555         ml_.setCapacity(minCapacity, Category::isLarge);
556         // size remains unchanged
557       } else {
558         // String is not shared, so let's try to realloc (if needed)
559         if (minCapacity > ml_.capacity()) {
560           // Asking for more memory
561           auto const newRC =
562                RefCounted::reallocate(ml_.data_, ml_.size_,
563                                       ml_.capacity(), minCapacity);
564           ml_.data_ = newRC->data_;
565           ml_.setCapacity(minCapacity, Category::isLarge);
566         }
567         assert(capacity() >= minCapacity);
568       }
569     } else if (category() == Category::isMedium) {
570       // String is not shared
571       if (minCapacity <= ml_.capacity()) {
572         return; // nothing to do, there's enough room
573       }
574       if (minCapacity <= maxMediumSize) {
575         // Keep the string at medium size. Don't forget to allocate
576         // one extra Char for the terminating null.
577         size_t capacityBytes = goodMallocSize((1 + minCapacity) * sizeof(Char));
578         // Also copies terminator.
579         ml_.data_ = static_cast<Char *>(
580           smartRealloc(
581             ml_.data_,
582             (ml_.size_ + 1) * sizeof(Char),
583             (ml_.capacity() + 1) * sizeof(Char),
584             capacityBytes));
585         ml_.setCapacity(capacityBytes / sizeof(Char) - 1, Category::isMedium);
586       } else {
587         // Conversion from medium to large string
588         fbstring_core nascent;
589         // Will recurse to another branch of this function
590         nascent.reserve(minCapacity);
591         nascent.ml_.size_ = ml_.size_;
592         // Also copies terminator.
593         fbstring_detail::pod_copy(ml_.data_, ml_.data_ + ml_.size_ + 1,
594                                   nascent.ml_.data_);
595         nascent.swap(*this);
596         assert(capacity() >= minCapacity);
597       }
598     } else {
599       assert(category() == Category::isSmall);
600       if (!disableSSO && minCapacity <= maxSmallSize) {
601         // small
602         // Nothing to do, everything stays put
603       } else if (minCapacity <= maxMediumSize) {
604         // medium
605         // Don't forget to allocate one extra Char for the terminating null
606         auto const allocSizeBytes =
607           goodMallocSize((1 + minCapacity) * sizeof(Char));
608         auto const pData = static_cast<Char*>(checkedMalloc(allocSizeBytes));
609         auto const size = smallSize();
610         // Also copies terminator.
611         fbstring_detail::pod_copy(small_, small_ + size + 1, pData);
612         ml_.data_ = pData;
613         ml_.size_ = size;
614         ml_.setCapacity(allocSizeBytes / sizeof(Char) - 1, Category::isMedium);
615       } else {
616         // large
617         auto const newRC = RefCounted::create(& minCapacity);
618         auto const size = smallSize();
619         // Also copies terminator.
620         fbstring_detail::pod_copy(small_, small_ + size + 1, newRC->data_);
621         ml_.data_ = newRC->data_;
622         ml_.size_ = size;
623         ml_.setCapacity(minCapacity, Category::isLarge);
624         assert(capacity() >= minCapacity);
625       }
626     }
627     assert(capacity() >= minCapacity);
628   }
629
630   Char * expand_noinit(const size_t delta,
631                        bool expGrowth = false,
632                        bool disableSSO = FBSTRING_DISABLE_SSO) {
633     // Strategy is simple: make room, then change size
634     assert(capacity() >= size());
635     size_t sz, newSz;
636     if (category() == Category::isSmall) {
637       sz = smallSize();
638       newSz = sz + delta;
639       if (!disableSSO && FBSTRING_LIKELY(newSz <= maxSmallSize)) {
640         setSmallSize(newSz);
641         return small_ + sz;
642       }
643       reserve(expGrowth ? std::max(newSz, 2 * maxSmallSize) : newSz);
644     } else {
645       sz = ml_.size_;
646       newSz = sz + delta;
647       if (FBSTRING_UNLIKELY(newSz > capacity())) {
648         // ensures not shared
649         reserve(expGrowth ? std::max(newSz, 1 + capacity() * 3 / 2) : newSz);
650       }
651     }
652     assert(capacity() >= newSz);
653     // Category can't be small - we took care of that above
654     assert(category() == Category::isMedium || category() == Category::isLarge);
655     ml_.size_ = newSz;
656     ml_.data_[newSz] = '\0';
657     assert(size() == newSz);
658     return ml_.data_ + sz;
659   }
660
661   void push_back(Char c) {
662     *expand_noinit(1, /* expGrowth = */ true) = c;
663   }
664
665   size_t size() const {
666     return category() == Category::isSmall ? smallSize() : ml_.size_;
667   }
668
669   size_t capacity() const {
670     switch (category()) {
671       case Category::isSmall:
672         return maxSmallSize;
673       case Category::isLarge:
674         // For large-sized strings, a multi-referenced chunk has no
675         // available capacity. This is because any attempt to append
676         // data would trigger a new allocation.
677         if (RefCounted::refs(ml_.data_) > 1) return ml_.size_;
678       default: {}
679     }
680     return ml_.capacity();
681   }
682
683   bool isShared() const {
684     return category() == Category::isLarge && RefCounted::refs(ml_.data_) > 1;
685   }
686
687 private:
688   // Disabled
689   fbstring_core & operator=(const fbstring_core & rhs);
690
691   // Equivalent to setSmallSize(0) but a few ns faster in
692   // microbenchmarks.
693   void reset() {
694     ml_.capacity_ = kIsLittleEndian
695       ? maxSmallSize << (8 * (sizeof(size_t) - sizeof(Char)))
696       : maxSmallSize << 2;
697     small_[0] = '\0';
698     assert(category() == Category::isSmall && size() == 0);
699   }
700
701   struct RefCounted {
702     std::atomic<size_t> refCount_;
703     Char data_[1];
704
705     static RefCounted * fromData(Char * p) {
706       return static_cast<RefCounted*>(
707         static_cast<void*>(
708           static_cast<unsigned char*>(static_cast<void*>(p))
709           - sizeof(refCount_)));
710     }
711
712     static size_t refs(Char * p) {
713       return fromData(p)->refCount_.load(std::memory_order_acquire);
714     }
715
716     static void incrementRefs(Char * p) {
717       fromData(p)->refCount_.fetch_add(1, std::memory_order_acq_rel);
718     }
719
720     static void decrementRefs(Char * p) {
721       auto const dis = fromData(p);
722       size_t oldcnt = dis->refCount_.fetch_sub(1, std::memory_order_acq_rel);
723       assert(oldcnt > 0);
724       if (oldcnt == 1) {
725         free(dis);
726       }
727     }
728
729     static RefCounted * create(size_t * size) {
730       // Don't forget to allocate one extra Char for the terminating
731       // null. In this case, however, one Char is already part of the
732       // struct.
733       const size_t allocSize = goodMallocSize(
734         sizeof(RefCounted) + *size * sizeof(Char));
735       auto result = static_cast<RefCounted*>(checkedMalloc(allocSize));
736       result->refCount_.store(1, std::memory_order_release);
737       *size = (allocSize - sizeof(RefCounted)) / sizeof(Char);
738       return result;
739     }
740
741     static RefCounted * create(const Char * data, size_t * size) {
742       const size_t effectiveSize = *size;
743       auto result = create(size);
744       fbstring_detail::pod_copy(data, data + effectiveSize, result->data_);
745       return result;
746     }
747
748     static RefCounted * reallocate(Char *const data,
749                                    const size_t currentSize,
750                                    const size_t currentCapacity,
751                                    const size_t newCapacity) {
752       assert(newCapacity > 0 && newCapacity > currentSize);
753       auto const dis = fromData(data);
754       assert(dis->refCount_.load(std::memory_order_acquire) == 1);
755       // Don't forget to allocate one extra Char for the terminating
756       // null. In this case, however, one Char is already part of the
757       // struct.
758       auto result = static_cast<RefCounted*>(
759              smartRealloc(dis,
760                           sizeof(RefCounted) + currentSize * sizeof(Char),
761                           sizeof(RefCounted) + currentCapacity * sizeof(Char),
762                           sizeof(RefCounted) + newCapacity * sizeof(Char)));
763       assert(result->refCount_.load(std::memory_order_acquire) == 1);
764       return result;
765     }
766   };
767
768   typedef std::conditional<sizeof(size_t) == 4, uint32_t, uint64_t>::type
769           category_type;
770
771   enum class Category : category_type {
772     isSmall = 0,
773     isMedium = kIsLittleEndian
774       ? sizeof(size_t) == 4 ? 0x80000000 : 0x8000000000000000
775       : 0x2,
776     isLarge =  kIsLittleEndian
777       ? sizeof(size_t) == 4 ? 0x40000000 : 0x4000000000000000
778       : 0x1,
779   };
780
781   Category category() const {
782     // works for both big-endian and little-endian
783     return static_cast<Category>(ml_.capacity_ & categoryExtractMask);
784   }
785
786   struct MediumLarge {
787     Char * data_;
788     size_t size_;
789     size_t capacity_;
790
791     size_t capacity() const {
792       return kIsLittleEndian
793         ? capacity_ & capacityExtractMask
794         : capacity_ >> 2;
795     }
796
797     void setCapacity(size_t cap, Category cat) {
798         capacity_ = kIsLittleEndian
799           ? cap | static_cast<category_type>(cat)
800           : (cap << 2) | static_cast<category_type>(cat);
801     }
802   };
803
804   union {
805     Char small_[sizeof(MediumLarge) / sizeof(Char)];
806     MediumLarge ml_;
807   };
808
809   enum : size_t {
810     lastChar = sizeof(MediumLarge) - 1,
811     maxSmallSize = lastChar / sizeof(Char),
812     maxMediumSize = 254 / sizeof(Char),            // coincides with the small
813                                                    // bin size in dlmalloc
814     categoryExtractMask = kIsLittleEndian
815       ? sizeof(size_t) == 4 ? 0xC0000000 : 0xC000000000000000
816       : 0x3,
817     capacityExtractMask = kIsLittleEndian
818       ? ~categoryExtractMask
819       : 0x0 /*unused*/,
820   };
821   static_assert(!(sizeof(MediumLarge) % sizeof(Char)),
822                 "Corrupt memory layout for fbstring.");
823
824   size_t smallSize() const {
825     assert(category() == Category::isSmall);
826     constexpr auto shift = kIsLittleEndian ? 0 : 2;
827     auto smallShifted = static_cast<size_t>(small_[maxSmallSize]) >> shift;
828     assert(static_cast<size_t>(maxSmallSize) >= smallShifted);
829     return static_cast<size_t>(maxSmallSize) - smallShifted;
830   }
831
832   void setSmallSize(size_t s) {
833     // Warning: this should work with uninitialized strings too,
834     // so don't assume anything about the previous value of
835     // small_[maxSmallSize].
836     assert(s <= maxSmallSize);
837     constexpr auto shift = kIsLittleEndian ? 0 : 2;
838     small_[maxSmallSize] = (maxSmallSize - s) << shift;
839     small_[s] = '\0';
840     assert(category() == Category::isSmall && size() == s);
841   }
842 };
843
844 #ifndef _LIBSTDCXX_FBSTRING
845 /**
846  * Dummy fbstring core that uses an actual std::string. This doesn't
847  * make any sense - it's just for testing purposes.
848  */
849 template <class Char>
850 class dummy_fbstring_core {
851 public:
852   dummy_fbstring_core() {
853   }
854   dummy_fbstring_core(const dummy_fbstring_core& another)
855       : backend_(another.backend_) {
856   }
857   dummy_fbstring_core(const Char * s, size_t n)
858       : backend_(s, n) {
859   }
860   void swap(dummy_fbstring_core & rhs) {
861     backend_.swap(rhs.backend_);
862   }
863   const Char * data() const {
864     return backend_.data();
865   }
866   Char * mutable_data() {
867     //assert(!backend_.empty());
868     return &*backend_.begin();
869   }
870   void shrink(size_t delta) {
871     assert(delta <= size());
872     backend_.resize(size() - delta);
873   }
874   Char * expand_noinit(size_t delta) {
875     auto const sz = size();
876     backend_.resize(size() + delta);
877     return backend_.data() + sz;
878   }
879   void push_back(Char c) {
880     backend_.push_back(c);
881   }
882   size_t size() const {
883     return backend_.size();
884   }
885   size_t capacity() const {
886     return backend_.capacity();
887   }
888   bool isShared() const {
889     return false;
890   }
891   void reserve(size_t minCapacity) {
892     backend_.reserve(minCapacity);
893   }
894
895 private:
896   std::basic_string<Char> backend_;
897 };
898 #endif // !_LIBSTDCXX_FBSTRING
899
900 /**
901  * This is the basic_string replacement. For conformity,
902  * basic_fbstring takes the same template parameters, plus the last
903  * one which is the core.
904  */
905 #ifdef _LIBSTDCXX_FBSTRING
906 template <typename E, class T, class A, class Storage>
907 #else
908 template <typename E,
909           class T = std::char_traits<E>,
910           class A = std::allocator<E>,
911           class Storage = fbstring_core<E> >
912 #endif
913 class basic_fbstring {
914
915   static void enforce(
916       bool condition,
917       void (*throw_exc)(const char*),
918       const char* msg) {
919     if (!condition) throw_exc(msg);
920   }
921
922   bool isSane() const {
923     return
924       begin() <= end() &&
925       empty() == (size() == 0) &&
926       empty() == (begin() == end()) &&
927       size() <= max_size() &&
928       capacity() <= max_size() &&
929       size() <= capacity() &&
930       begin()[size()] == '\0';
931   }
932
933   struct Invariant;
934   friend struct Invariant;
935   struct Invariant {
936 #ifndef NDEBUG
937     explicit Invariant(const basic_fbstring& s) : s_(s) {
938       assert(s_.isSane());
939     }
940     ~Invariant() {
941       assert(s_.isSane());
942     }
943   private:
944     const basic_fbstring& s_;
945 #else
946     explicit Invariant(const basic_fbstring&) {}
947 #endif
948     Invariant& operator=(const Invariant&);
949   };
950
951 public:
952   // types
953   typedef T traits_type;
954   typedef typename traits_type::char_type value_type;
955   typedef A allocator_type;
956   typedef typename A::size_type size_type;
957   typedef typename A::difference_type difference_type;
958
959   typedef typename A::reference reference;
960   typedef typename A::const_reference const_reference;
961   typedef typename A::pointer pointer;
962   typedef typename A::const_pointer const_pointer;
963
964   typedef E* iterator;
965   typedef const E* const_iterator;
966   typedef std::reverse_iterator<iterator
967 #ifdef NO_ITERATOR_TRAITS
968                                 , value_type
969 #endif
970                                 > reverse_iterator;
971   typedef std::reverse_iterator<const_iterator
972 #ifdef NO_ITERATOR_TRAITS
973                                 , const value_type
974 #endif
975                                 > const_reverse_iterator;
976
977   static const size_type npos;                     // = size_type(-1)
978   typedef std::true_type IsRelocatable;
979
980 private:
981   static void procrustes(size_type& n, size_type nmax) {
982     if (n > nmax) n = nmax;
983   }
984
985 public:
986   // C++11 21.4.2 construct/copy/destroy
987
988   // Note: while the following two constructors can be (and previously were)
989   // collapsed into one constructor written this way:
990   //
991   //   explicit basic_fbstring(const A& a = A()) noexcept { }
992   //
993   // This can cause Clang (at least version 3.7) to fail with the error:
994   //   "chosen constructor is explicit in copy-initialization ...
995   //   in implicit initialization of field '(x)' with omitted initializer"
996   //
997   // if used in a struct which is default-initialized.  Hence the split into
998   // these two separate constructors.
999
1000   basic_fbstring() noexcept : basic_fbstring(A()) {
1001   }
1002
1003   explicit basic_fbstring(const A&) noexcept {
1004   }
1005
1006   basic_fbstring(const basic_fbstring& str)
1007       : store_(str.store_) {
1008   }
1009
1010   // Move constructor
1011   basic_fbstring(basic_fbstring&& goner) noexcept
1012       : store_(std::move(goner.store_)) {
1013   }
1014
1015 #ifndef _LIBSTDCXX_FBSTRING
1016   // This is defined for compatibility with std::string
1017   /* implicit */ basic_fbstring(const std::string& str)
1018       : store_(str.data(), str.size()) {
1019   }
1020 #endif
1021
1022   basic_fbstring(const basic_fbstring& str,
1023                  size_type pos,
1024                  size_type n = npos,
1025                  const A& /* a */ = A()) {
1026     assign(str, pos, n);
1027   }
1028
1029   /* implicit */ basic_fbstring(const value_type* s, const A& /*a*/ = A())
1030       : store_(s, s
1031           ? traits_type::length(s)
1032           : (std::__throw_logic_error(
1033                 "basic_fbstring: null pointer initializer not valid"),
1034              0)) {
1035   }
1036
1037   basic_fbstring(const value_type* s, size_type n, const A& /*a*/ = A())
1038       : store_(s, n) {
1039   }
1040
1041   basic_fbstring(size_type n, value_type c, const A& /*a*/ = A()) {
1042     auto const pData = store_.expand_noinit(n);
1043     fbstring_detail::pod_fill(pData, pData + n, c);
1044   }
1045
1046   template <class InIt>
1047   basic_fbstring(InIt begin, InIt end,
1048                  typename std::enable_if<
1049                  !std::is_same<typename std::remove_const<InIt>::type,
1050                  value_type*>::value, const A>::type & /*a*/ = A()) {
1051     assign(begin, end);
1052   }
1053
1054   // Specialization for const char*, const char*
1055   basic_fbstring(const value_type* b, const value_type* e)
1056       : store_(b, e - b) {
1057   }
1058
1059   // Nonstandard constructor
1060   basic_fbstring(value_type *s, size_type n, size_type c,
1061                  AcquireMallocatedString a)
1062       : store_(s, n, c, a) {
1063   }
1064
1065   // Construction from initialization list
1066   basic_fbstring(std::initializer_list<value_type> il) {
1067     assign(il.begin(), il.end());
1068   }
1069
1070   ~basic_fbstring() noexcept {
1071   }
1072
1073   basic_fbstring& operator=(const basic_fbstring& lhs) {
1074     Invariant checker(*this);
1075
1076     if (FBSTRING_UNLIKELY(&lhs == this)) {
1077       return *this;
1078     }
1079     auto const oldSize = size();
1080     auto const srcSize = lhs.size();
1081     if (capacity() >= srcSize && !store_.isShared()) {
1082       // great, just copy the contents
1083       if (oldSize < srcSize) {
1084         store_.expand_noinit(srcSize - oldSize);
1085       } else {
1086         store_.shrink(oldSize - srcSize);
1087       }
1088       assert(size() == srcSize);
1089       auto srcData = lhs.data();
1090       fbstring_detail::pod_copy(
1091           srcData, srcData + srcSize, store_.mutable_data());
1092     } else {
1093       // need to reallocate, so we may as well create a brand new string
1094       basic_fbstring(lhs).swap(*this);
1095     }
1096     return *this;
1097   }
1098
1099   // Move assignment
1100   basic_fbstring& operator=(basic_fbstring&& goner) noexcept {
1101     if (FBSTRING_UNLIKELY(&goner == this)) {
1102       // Compatibility with std::basic_string<>,
1103       // C++11 21.4.2 [string.cons] / 23 requires self-move-assignment support.
1104       return *this;
1105     }
1106     // No need of this anymore
1107     this->~basic_fbstring();
1108     // Move the goner into this
1109     new(&store_) fbstring_core<E>(std::move(goner.store_));
1110     return *this;
1111   }
1112
1113 #ifndef _LIBSTDCXX_FBSTRING
1114   // Compatibility with std::string
1115   basic_fbstring & operator=(const std::string & rhs) {
1116     return assign(rhs.data(), rhs.size());
1117   }
1118
1119   // Compatibility with std::string
1120   std::string toStdString() const {
1121     return std::string(data(), size());
1122   }
1123 #else
1124   // A lot of code in fbcode still uses this method, so keep it here for now.
1125   const basic_fbstring& toStdString() const {
1126     return *this;
1127   }
1128 #endif
1129
1130   basic_fbstring& operator=(const value_type* s) {
1131     return assign(s);
1132   }
1133
1134   basic_fbstring& operator=(value_type c) {
1135     Invariant checker(*this);
1136
1137     if (empty()) {
1138       store_.expand_noinit(1);
1139     } else if (store_.isShared()) {
1140       basic_fbstring(1, c).swap(*this);
1141       return *this;
1142     } else {
1143       store_.shrink(size() - 1);
1144     }
1145     front() = c;
1146     return *this;
1147   }
1148
1149   basic_fbstring& operator=(std::initializer_list<value_type> il) {
1150     return assign(il.begin(), il.end());
1151   }
1152
1153   // C++11 21.4.3 iterators:
1154   iterator begin() { return store_.mutable_data(); }
1155
1156   const_iterator begin() const { return store_.data(); }
1157
1158   const_iterator cbegin() const { return begin(); }
1159
1160   iterator end() {
1161     return store_.mutable_data() + store_.size();
1162   }
1163
1164   const_iterator end() const {
1165     return store_.data() + store_.size();
1166   }
1167
1168   const_iterator cend() const { return end(); }
1169
1170   reverse_iterator rbegin() {
1171     return reverse_iterator(end());
1172   }
1173
1174   const_reverse_iterator rbegin() const {
1175     return const_reverse_iterator(end());
1176   }
1177
1178   const_reverse_iterator crbegin() const { return rbegin(); }
1179
1180   reverse_iterator rend() {
1181     return reverse_iterator(begin());
1182   }
1183
1184   const_reverse_iterator rend() const {
1185     return const_reverse_iterator(begin());
1186   }
1187
1188   const_reverse_iterator crend() const { return rend(); }
1189
1190   // Added by C++11
1191   // C++11 21.4.5, element access:
1192   const value_type& front() const { return *begin(); }
1193   const value_type& back() const {
1194     assert(!empty());
1195     // Should be begin()[size() - 1], but that branches twice
1196     return *(end() - 1);
1197   }
1198   value_type& front() { return *begin(); }
1199   value_type& back() {
1200     assert(!empty());
1201     // Should be begin()[size() - 1], but that branches twice
1202     return *(end() - 1);
1203   }
1204   void pop_back() {
1205     assert(!empty());
1206     store_.shrink(1);
1207   }
1208
1209   // C++11 21.4.4 capacity:
1210   size_type size() const { return store_.size(); }
1211
1212   size_type length() const { return size(); }
1213
1214   size_type max_size() const {
1215     return std::numeric_limits<size_type>::max();
1216   }
1217
1218   void resize(const size_type n, const value_type c = value_type()) {
1219     Invariant checker(*this);
1220
1221     auto size = this->size();
1222     if (n <= size) {
1223       store_.shrink(size - n);
1224     } else {
1225       auto const delta = n - size;
1226       auto pData = store_.expand_noinit(delta);
1227       fbstring_detail::pod_fill(pData, pData + delta, c);
1228     }
1229     assert(this->size() == n);
1230   }
1231
1232   size_type capacity() const { return store_.capacity(); }
1233
1234   void reserve(size_type res_arg = 0) {
1235     enforce(res_arg <= max_size(), std::__throw_length_error, "");
1236     store_.reserve(res_arg);
1237   }
1238
1239   void shrink_to_fit() {
1240     // Shrink only if slack memory is sufficiently large
1241     if (capacity() < size() * 3 / 2) {
1242       return;
1243     }
1244     basic_fbstring(cbegin(), cend()).swap(*this);
1245   }
1246
1247   void clear() { resize(0); }
1248
1249   bool empty() const { return size() == 0; }
1250
1251   // C++11 21.4.5 element access:
1252   const_reference operator[](size_type pos) const {
1253     return *(begin() + pos);
1254   }
1255
1256   reference operator[](size_type pos) {
1257     return *(begin() + pos);
1258   }
1259
1260   const_reference at(size_type n) const {
1261     enforce(n <= size(), std::__throw_out_of_range, "");
1262     return (*this)[n];
1263   }
1264
1265   reference at(size_type n) {
1266     enforce(n < size(), std::__throw_out_of_range, "");
1267     return (*this)[n];
1268   }
1269
1270   // C++11 21.4.6 modifiers:
1271   basic_fbstring& operator+=(const basic_fbstring& str) {
1272     return append(str);
1273   }
1274
1275   basic_fbstring& operator+=(const value_type* s) {
1276     return append(s);
1277   }
1278
1279   basic_fbstring& operator+=(const value_type c) {
1280     push_back(c);
1281     return *this;
1282   }
1283
1284   basic_fbstring& operator+=(std::initializer_list<value_type> il) {
1285     append(il);
1286     return *this;
1287   }
1288
1289   basic_fbstring& append(const basic_fbstring& str) {
1290 #ifndef NDEBUG
1291     auto desiredSize = size() + str.size();
1292 #endif
1293     append(str.data(), str.size());
1294     assert(size() == desiredSize);
1295     return *this;
1296   }
1297
1298   basic_fbstring& append(const basic_fbstring& str, const size_type pos,
1299                          size_type n) {
1300     const size_type sz = str.size();
1301     enforce(pos <= sz, std::__throw_out_of_range, "");
1302     procrustes(n, sz - pos);
1303     return append(str.data() + pos, n);
1304   }
1305
1306   basic_fbstring& append(const value_type* s, size_type n) {
1307     Invariant checker(*this);
1308
1309     if (FBSTRING_UNLIKELY(!n)) {
1310       // Unlikely but must be done
1311       return *this;
1312     }
1313     auto const oldSize = size();
1314     auto const oldData = data();
1315     // Check for aliasing (rare). We could use "<=" here but in theory
1316     // those do not work for pointers unless the pointers point to
1317     // elements in the same array. For that reason we use
1318     // std::less_equal, which is guaranteed to offer a total order
1319     // over pointers. See discussion at http://goo.gl/Cy2ya for more
1320     // info.
1321     std::less_equal<const value_type*> le;
1322     if (FBSTRING_UNLIKELY(le(oldData, s) && !le(oldData + oldSize, s))) {
1323       assert(le(s + n, oldData + oldSize));
1324       const size_type offset = s - oldData;
1325       store_.reserve(oldSize + n);
1326       // Restore the source
1327       s = data() + offset;
1328     }
1329
1330     fbstring_detail::pod_copy(
1331         s, s + n, store_.expand_noinit(n, /* expGrowth = */ true));
1332     assert(size() == oldSize + n);
1333     return *this;
1334   }
1335
1336   basic_fbstring& append(const value_type* s) {
1337     return append(s, traits_type::length(s));
1338   }
1339
1340   basic_fbstring& append(size_type n, value_type c) {
1341     Invariant checker(*this);
1342     auto pData = store_.expand_noinit(n, /* expGrowth = */ true);
1343     fbstring_detail::pod_fill(pData, pData + n, c);
1344     return *this;
1345   }
1346
1347   template<class InputIterator>
1348   basic_fbstring& append(InputIterator first, InputIterator last) {
1349     insert(end(), first, last);
1350     return *this;
1351   }
1352
1353   basic_fbstring& append(std::initializer_list<value_type> il) {
1354     return append(il.begin(), il.end());
1355   }
1356
1357   void push_back(const value_type c) {             // primitive
1358     store_.push_back(c);
1359   }
1360
1361   basic_fbstring& assign(const basic_fbstring& str) {
1362     if (&str == this) return *this;
1363     return assign(str.data(), str.size());
1364   }
1365
1366   basic_fbstring& assign(basic_fbstring&& str) {
1367     return *this = std::move(str);
1368   }
1369
1370   basic_fbstring& assign(const basic_fbstring& str, const size_type pos,
1371                          size_type n) {
1372     const size_type sz = str.size();
1373     enforce(pos <= sz, std::__throw_out_of_range, "");
1374     procrustes(n, sz - pos);
1375     return assign(str.data() + pos, n);
1376   }
1377
1378   basic_fbstring& assign(const value_type* s, const size_type n) {
1379     Invariant checker(*this);
1380
1381     // s can alias this, we need to use pod_move.
1382     if (n == 0) {
1383       resize(0);
1384     } else if (size() >= n) {
1385       fbstring_detail::pod_move(s, s + n, store_.mutable_data());
1386       resize(n);
1387       assert(size() == n);
1388     } else {
1389       const value_type *const s2 = s + size();
1390       fbstring_detail::pod_move(s, s2, store_.mutable_data());
1391       append(s2, n - size());
1392       assert(size() == n);
1393     }
1394     assert(size() == n);
1395     return *this;
1396   }
1397
1398   basic_fbstring& assign(const value_type* s) {
1399     return assign(s, traits_type::length(s));
1400   }
1401
1402   basic_fbstring& assign(std::initializer_list<value_type> il) {
1403     return assign(il.begin(), il.end());
1404   }
1405
1406   template <class ItOrLength, class ItOrChar>
1407   basic_fbstring& assign(ItOrLength first_or_n, ItOrChar last_or_c) {
1408     return replace(begin(), end(), first_or_n, last_or_c);
1409   }
1410
1411   basic_fbstring& insert(size_type pos1, const basic_fbstring& str) {
1412     return insert(pos1, str.data(), str.size());
1413   }
1414
1415   basic_fbstring& insert(size_type pos1, const basic_fbstring& str,
1416                          size_type pos2, size_type n) {
1417     enforce(pos2 <= str.length(), std::__throw_out_of_range, "");
1418     procrustes(n, str.length() - pos2);
1419     return insert(pos1, str.data() + pos2, n);
1420   }
1421
1422   basic_fbstring& insert(size_type pos, const value_type* s, size_type n) {
1423     enforce(pos <= length(), std::__throw_out_of_range, "");
1424     insert(begin() + pos, s, s + n);
1425     return *this;
1426   }
1427
1428   basic_fbstring& insert(size_type pos, const value_type* s) {
1429     return insert(pos, s, traits_type::length(s));
1430   }
1431
1432   basic_fbstring& insert(size_type pos, size_type n, value_type c) {
1433     enforce(pos <= length(), std::__throw_out_of_range, "");
1434     insert(begin() + pos, n, c);
1435     return *this;
1436   }
1437
1438   iterator insert(const_iterator p, const value_type c) {
1439     const size_type pos = p - begin();
1440     insert(p, 1, c);
1441     return begin() + pos;
1442   }
1443
1444 #ifndef _LIBSTDCXX_FBSTRING
1445  private:
1446   typedef std::basic_istream<value_type, traits_type> istream_type;
1447
1448  public:
1449   friend inline istream_type& getline(istream_type& is,
1450                                       basic_fbstring& str,
1451                                       value_type delim) {
1452     Invariant checker(str);
1453
1454     str.clear();
1455     size_t size = 0;
1456     while (true) {
1457       size_t avail = str.capacity() - size;
1458       // fbstring has 1 byte extra capacity for the null terminator,
1459       // and getline null-terminates the read string.
1460       is.getline(str.store_.expand_noinit(avail), avail + 1, delim);
1461       size += is.gcount();
1462
1463       if (is.bad() || is.eof() || !is.fail()) {
1464         // Done by either failure, end of file, or normal read.
1465         if (!is.bad() && !is.eof()) {
1466           --size; // gcount() also accounts for the delimiter.
1467         }
1468         str.resize(size);
1469         break;
1470       }
1471
1472       assert(size == str.size());
1473       assert(size == str.capacity());
1474       // Start at minimum allocation 63 + terminator = 64.
1475       str.reserve(std::max<size_t>(63, 3 * size / 2));
1476       // Clear the error so we can continue reading.
1477       is.clear();
1478     }
1479     return is;
1480   }
1481
1482   friend inline istream_type& getline(istream_type& is, basic_fbstring& str) {
1483     return getline(is, str, '\n');
1484   }
1485 #endif
1486
1487 private:
1488   template <int i> class Selector {};
1489
1490   iterator insertImplDiscr(const_iterator i,
1491                            size_type n, value_type c, Selector<1>) {
1492     Invariant checker(*this);
1493
1494     assert(i >= begin() && i <= end());
1495     const size_type pos = i - begin();
1496
1497     auto oldSize = size();
1498     store_.expand_noinit(n, /* expGrowth = */ true);
1499     auto b = begin();
1500     fbstring_detail::pod_move(b + pos, b + oldSize, b + pos + n);
1501     fbstring_detail::pod_fill(b + pos, b + pos + n, c);
1502
1503     return b + pos;
1504   }
1505
1506   template<class InputIter>
1507   iterator insertImplDiscr(const_iterator i,
1508                            InputIter b, InputIter e, Selector<0>) {
1509     return insertImpl(i, b, e,
1510                typename std::iterator_traits<InputIter>::iterator_category());
1511   }
1512
1513   template <class FwdIterator>
1514   iterator insertImpl(const_iterator i,
1515                       FwdIterator s1,
1516                       FwdIterator s2,
1517                       std::forward_iterator_tag) {
1518     Invariant checker(*this);
1519
1520     assert(i >= begin() && i <= end());
1521     const size_type pos = i - begin();
1522     auto n = std::distance(s1, s2);
1523     assert(n >= 0);
1524
1525     auto oldSize = size();
1526     store_.expand_noinit(n, /* expGrowth = */ true);
1527     auto b = begin();
1528     fbstring_detail::pod_move(b + pos, b + oldSize, b + pos + n);
1529     std::copy(s1, s2, b + pos);
1530
1531     return b + pos;
1532   }
1533
1534   template <class InputIterator>
1535   iterator insertImpl(const_iterator i,
1536                       InputIterator b, InputIterator e,
1537                       std::input_iterator_tag) {
1538     const auto pos = i - begin();
1539     basic_fbstring temp(begin(), i);
1540     for (; b != e; ++b) {
1541       temp.push_back(*b);
1542     }
1543     temp.append(i, cend());
1544     swap(temp);
1545     return begin() + pos;
1546   }
1547
1548 public:
1549   template <class ItOrLength, class ItOrChar>
1550   iterator insert(const_iterator p, ItOrLength first_or_n, ItOrChar last_or_c) {
1551     Selector<std::numeric_limits<ItOrLength>::is_specialized> sel;
1552     return insertImplDiscr(p, first_or_n, last_or_c, sel);
1553   }
1554
1555   iterator insert(const_iterator p, std::initializer_list<value_type> il) {
1556     return insert(p, il.begin(), il.end());
1557   }
1558
1559   basic_fbstring& erase(size_type pos = 0, size_type n = npos) {
1560     Invariant checker(*this);
1561
1562     enforce(pos <= length(), std::__throw_out_of_range, "");
1563     procrustes(n, length() - pos);
1564     std::copy(begin() + pos + n, end(), begin() + pos);
1565     resize(length() - n);
1566     return *this;
1567   }
1568
1569   iterator erase(iterator position) {
1570     const size_type pos(position - begin());
1571     enforce(pos <= size(), std::__throw_out_of_range, "");
1572     erase(pos, 1);
1573     return begin() + pos;
1574   }
1575
1576   iterator erase(iterator first, iterator last) {
1577     const size_type pos(first - begin());
1578     erase(pos, last - first);
1579     return begin() + pos;
1580   }
1581
1582   // Replaces at most n1 chars of *this, starting with pos1 with the
1583   // content of str
1584   basic_fbstring& replace(size_type pos1, size_type n1,
1585                           const basic_fbstring& str) {
1586     return replace(pos1, n1, str.data(), str.size());
1587   }
1588
1589   // Replaces at most n1 chars of *this, starting with pos1,
1590   // with at most n2 chars of str starting with pos2
1591   basic_fbstring& replace(size_type pos1, size_type n1,
1592                           const basic_fbstring& str,
1593                           size_type pos2, size_type n2) {
1594     enforce(pos2 <= str.length(), std::__throw_out_of_range, "");
1595     return replace(pos1, n1, str.data() + pos2,
1596                    std::min(n2, str.size() - pos2));
1597   }
1598
1599   // Replaces at most n1 chars of *this, starting with pos, with chars from s
1600   basic_fbstring& replace(size_type pos, size_type n1, const value_type* s) {
1601     return replace(pos, n1, s, traits_type::length(s));
1602   }
1603
1604   // Replaces at most n1 chars of *this, starting with pos, with n2
1605   // occurrences of c
1606   //
1607   // consolidated with
1608   //
1609   // Replaces at most n1 chars of *this, starting with pos, with at
1610   // most n2 chars of str.  str must have at least n2 chars.
1611   template <class StrOrLength, class NumOrChar>
1612   basic_fbstring& replace(size_type pos, size_type n1,
1613                           StrOrLength s_or_n2, NumOrChar n_or_c) {
1614     Invariant checker(*this);
1615
1616     enforce(pos <= size(), std::__throw_out_of_range, "");
1617     procrustes(n1, length() - pos);
1618     const iterator b = begin() + pos;
1619     return replace(b, b + n1, s_or_n2, n_or_c);
1620   }
1621
1622   basic_fbstring& replace(iterator i1, iterator i2, const basic_fbstring& str) {
1623     return replace(i1, i2, str.data(), str.length());
1624   }
1625
1626   basic_fbstring& replace(iterator i1, iterator i2, const value_type* s) {
1627     return replace(i1, i2, s, traits_type::length(s));
1628   }
1629
1630 private:
1631   basic_fbstring& replaceImplDiscr(iterator i1, iterator i2,
1632                                    const value_type* s, size_type n,
1633                                    Selector<2>) {
1634     assert(i1 <= i2);
1635     assert(begin() <= i1 && i1 <= end());
1636     assert(begin() <= i2 && i2 <= end());
1637     return replace(i1, i2, s, s + n);
1638   }
1639
1640   basic_fbstring& replaceImplDiscr(iterator i1, iterator i2,
1641                                    size_type n2, value_type c, Selector<1>) {
1642     const size_type n1 = i2 - i1;
1643     if (n1 > n2) {
1644       std::fill(i1, i1 + n2, c);
1645       erase(i1 + n2, i2);
1646     } else {
1647       std::fill(i1, i2, c);
1648       insert(i2, n2 - n1, c);
1649     }
1650     assert(isSane());
1651     return *this;
1652   }
1653
1654   template <class InputIter>
1655   basic_fbstring& replaceImplDiscr(iterator i1, iterator i2,
1656                                    InputIter b, InputIter e,
1657                                    Selector<0>) {
1658     replaceImpl(i1, i2, b, e,
1659                 typename std::iterator_traits<InputIter>::iterator_category());
1660     return *this;
1661   }
1662
1663 private:
1664  template <class FwdIterator>
1665  bool replaceAliased(iterator /* i1 */,
1666                      iterator /* i2 */,
1667                      FwdIterator /* s1 */,
1668                      FwdIterator /* s2 */,
1669                      std::false_type) {
1670     return false;
1671   }
1672
1673   template <class FwdIterator>
1674   bool replaceAliased(iterator i1, iterator i2,
1675                       FwdIterator s1, FwdIterator s2, std::true_type) {
1676     static const std::less_equal<const value_type*> le =
1677       std::less_equal<const value_type*>();
1678     const bool aliased = le(&*begin(), &*s1) && le(&*s1, &*end());
1679     if (!aliased) {
1680       return false;
1681     }
1682     // Aliased replace, copy to new string
1683     basic_fbstring temp;
1684     temp.reserve(size() - (i2 - i1) + std::distance(s1, s2));
1685     temp.append(begin(), i1).append(s1, s2).append(i2, end());
1686     swap(temp);
1687     return true;
1688   }
1689
1690   template <class FwdIterator>
1691   void replaceImpl(iterator i1, iterator i2,
1692                    FwdIterator s1, FwdIterator s2, std::forward_iterator_tag) {
1693     Invariant checker(*this);
1694
1695     // Handle aliased replace
1696     if (replaceAliased(i1, i2, s1, s2,
1697           std::integral_constant<bool,
1698             std::is_same<FwdIterator, iterator>::value ||
1699             std::is_same<FwdIterator, const_iterator>::value>())) {
1700       return;
1701     }
1702
1703     auto const n1 = i2 - i1;
1704     assert(n1 >= 0);
1705     auto const n2 = std::distance(s1, s2);
1706     assert(n2 >= 0);
1707
1708     if (n1 > n2) {
1709       // shrinks
1710       std::copy(s1, s2, i1);
1711       erase(i1 + n2, i2);
1712     } else {
1713       // grows
1714       fbstring_detail::copy_n(s1, n1, i1);
1715       std::advance(s1, n1);
1716       insert(i2, s1, s2);
1717     }
1718     assert(isSane());
1719   }
1720
1721   template <class InputIterator>
1722   void replaceImpl(iterator i1, iterator i2,
1723                    InputIterator b, InputIterator e, std::input_iterator_tag) {
1724     basic_fbstring temp(begin(), i1);
1725     temp.append(b, e).append(i2, end());
1726     swap(temp);
1727   }
1728
1729 public:
1730   template <class T1, class T2>
1731   basic_fbstring& replace(iterator i1, iterator i2,
1732                           T1 first_or_n_or_s, T2 last_or_c_or_n) {
1733     const bool
1734       num1 = std::numeric_limits<T1>::is_specialized,
1735       num2 = std::numeric_limits<T2>::is_specialized;
1736     return replaceImplDiscr(
1737       i1, i2, first_or_n_or_s, last_or_c_or_n,
1738       Selector<num1 ? (num2 ? 1 : -1) : (num2 ? 2 : 0)>());
1739   }
1740
1741   size_type copy(value_type* s, size_type n, size_type pos = 0) const {
1742     enforce(pos <= size(), std::__throw_out_of_range, "");
1743     procrustes(n, size() - pos);
1744
1745     if (n != 0) {
1746       fbstring_detail::pod_copy(data() + pos, data() + pos + n, s);
1747     }
1748     return n;
1749   }
1750
1751   void swap(basic_fbstring& rhs) {
1752     store_.swap(rhs.store_);
1753   }
1754
1755   const value_type* c_str() const {
1756     return store_.c_str();
1757   }
1758
1759   const value_type* data() const { return c_str(); }
1760
1761   allocator_type get_allocator() const {
1762     return allocator_type();
1763   }
1764
1765   size_type find(const basic_fbstring& str, size_type pos = 0) const {
1766     return find(str.data(), pos, str.length());
1767   }
1768
1769   size_type find(const value_type* needle, const size_type pos,
1770                  const size_type nsize) const {
1771     if (!nsize) return pos;
1772     auto const size = this->size();
1773     // nsize + pos can overflow (eg pos == npos), guard against that by checking
1774     // that nsize + pos does not wrap around.
1775     if (nsize + pos > size || nsize + pos < pos) return npos;
1776     // Don't use std::search, use a Boyer-Moore-like trick by comparing
1777     // the last characters first
1778     auto const haystack = data();
1779     auto const nsize_1 = nsize - 1;
1780     auto const lastNeedle = needle[nsize_1];
1781
1782     // Boyer-Moore skip value for the last char in the needle. Zero is
1783     // not a valid value; skip will be computed the first time it's
1784     // needed.
1785     size_type skip = 0;
1786
1787     const E * i = haystack + pos;
1788     auto iEnd = haystack + size - nsize_1;
1789
1790     while (i < iEnd) {
1791       // Boyer-Moore: match the last element in the needle
1792       while (i[nsize_1] != lastNeedle) {
1793         if (++i == iEnd) {
1794           // not found
1795           return npos;
1796         }
1797       }
1798       // Here we know that the last char matches
1799       // Continue in pedestrian mode
1800       for (size_t j = 0; ; ) {
1801         assert(j < nsize);
1802         if (i[j] != needle[j]) {
1803           // Not found, we can skip
1804           // Compute the skip value lazily
1805           if (skip == 0) {
1806             skip = 1;
1807             while (skip <= nsize_1 && needle[nsize_1 - skip] != lastNeedle) {
1808               ++skip;
1809             }
1810           }
1811           i += skip;
1812           break;
1813         }
1814         // Check if done searching
1815         if (++j == nsize) {
1816           // Yay
1817           return i - haystack;
1818         }
1819       }
1820     }
1821     return npos;
1822   }
1823
1824   size_type find(const value_type* s, size_type pos = 0) const {
1825     return find(s, pos, traits_type::length(s));
1826   }
1827
1828   size_type find (value_type c, size_type pos = 0) const {
1829     return find(&c, pos, 1);
1830   }
1831
1832   size_type rfind(const basic_fbstring& str, size_type pos = npos) const {
1833     return rfind(str.data(), pos, str.length());
1834   }
1835
1836   size_type rfind(const value_type* s, size_type pos, size_type n) const {
1837     if (n > length()) return npos;
1838     pos = std::min(pos, length() - n);
1839     if (n == 0) return pos;
1840
1841     const_iterator i(begin() + pos);
1842     for (; ; --i) {
1843       if (traits_type::eq(*i, *s)
1844           && traits_type::compare(&*i, s, n) == 0) {
1845         return i - begin();
1846       }
1847       if (i == begin()) break;
1848     }
1849     return npos;
1850   }
1851
1852   size_type rfind(const value_type* s, size_type pos = npos) const {
1853     return rfind(s, pos, traits_type::length(s));
1854   }
1855
1856   size_type rfind(value_type c, size_type pos = npos) const {
1857     return rfind(&c, pos, 1);
1858   }
1859
1860   size_type find_first_of(const basic_fbstring& str, size_type pos = 0) const {
1861     return find_first_of(str.data(), pos, str.length());
1862   }
1863
1864   size_type find_first_of(const value_type* s,
1865                           size_type pos, size_type n) const {
1866     if (pos > length() || n == 0) return npos;
1867     const_iterator i(begin() + pos),
1868       finish(end());
1869     for (; i != finish; ++i) {
1870       if (traits_type::find(s, n, *i) != 0) {
1871         return i - begin();
1872       }
1873     }
1874     return npos;
1875   }
1876
1877   size_type find_first_of(const value_type* s, size_type pos = 0) const {
1878     return find_first_of(s, pos, traits_type::length(s));
1879   }
1880
1881   size_type find_first_of(value_type c, size_type pos = 0) const {
1882     return find_first_of(&c, pos, 1);
1883   }
1884
1885   size_type find_last_of (const basic_fbstring& str,
1886                           size_type pos = npos) const {
1887     return find_last_of(str.data(), pos, str.length());
1888   }
1889
1890   size_type find_last_of (const value_type* s, size_type pos,
1891                           size_type n) const {
1892     if (!empty() && n > 0) {
1893       pos = std::min(pos, length() - 1);
1894       const_iterator i(begin() + pos);
1895       for (;; --i) {
1896         if (traits_type::find(s, n, *i) != 0) {
1897           return i - begin();
1898         }
1899         if (i == begin()) break;
1900       }
1901     }
1902     return npos;
1903   }
1904
1905   size_type find_last_of (const value_type* s,
1906                           size_type pos = npos) const {
1907     return find_last_of(s, pos, traits_type::length(s));
1908   }
1909
1910   size_type find_last_of (value_type c, size_type pos = npos) const {
1911     return find_last_of(&c, pos, 1);
1912   }
1913
1914   size_type find_first_not_of(const basic_fbstring& str,
1915                               size_type pos = 0) const {
1916     return find_first_not_of(str.data(), pos, str.size());
1917   }
1918
1919   size_type find_first_not_of(const value_type* s, size_type pos,
1920                               size_type n) const {
1921     if (pos < length()) {
1922       const_iterator
1923         i(begin() + pos),
1924         finish(end());
1925       for (; i != finish; ++i) {
1926         if (traits_type::find(s, n, *i) == 0) {
1927           return i - begin();
1928         }
1929       }
1930     }
1931     return npos;
1932   }
1933
1934   size_type find_first_not_of(const value_type* s,
1935                               size_type pos = 0) const {
1936     return find_first_not_of(s, pos, traits_type::length(s));
1937   }
1938
1939   size_type find_first_not_of(value_type c, size_type pos = 0) const {
1940     return find_first_not_of(&c, pos, 1);
1941   }
1942
1943   size_type find_last_not_of(const basic_fbstring& str,
1944                              size_type pos = npos) const {
1945     return find_last_not_of(str.data(), pos, str.length());
1946   }
1947
1948   size_type find_last_not_of(const value_type* s, size_type pos,
1949                              size_type n) const {
1950     if (!this->empty()) {
1951       pos = std::min(pos, size() - 1);
1952       const_iterator i(begin() + pos);
1953       for (;; --i) {
1954         if (traits_type::find(s, n, *i) == 0) {
1955           return i - begin();
1956         }
1957         if (i == begin()) break;
1958       }
1959     }
1960     return npos;
1961   }
1962
1963   size_type find_last_not_of(const value_type* s,
1964                              size_type pos = npos) const {
1965     return find_last_not_of(s, pos, traits_type::length(s));
1966   }
1967
1968   size_type find_last_not_of (value_type c, size_type pos = npos) const {
1969     return find_last_not_of(&c, pos, 1);
1970   }
1971
1972   basic_fbstring substr(size_type pos = 0, size_type n = npos) const& {
1973     enforce(pos <= size(), std::__throw_out_of_range, "");
1974     return basic_fbstring(data() + pos, std::min(n, size() - pos));
1975   }
1976
1977   basic_fbstring substr(size_type pos = 0, size_type n = npos) && {
1978     enforce(pos <= size(), std::__throw_out_of_range, "");
1979     erase(0, pos);
1980     if (n < size()) resize(n);
1981     return std::move(*this);
1982   }
1983
1984   int compare(const basic_fbstring& str) const {
1985     // FIX due to Goncalo N M de Carvalho July 18, 2005
1986     return compare(0, size(), str);
1987   }
1988
1989   int compare(size_type pos1, size_type n1,
1990               const basic_fbstring& str) const {
1991     return compare(pos1, n1, str.data(), str.size());
1992   }
1993
1994   int compare(size_type pos1, size_type n1,
1995               const value_type* s) const {
1996     return compare(pos1, n1, s, traits_type::length(s));
1997   }
1998
1999   int compare(size_type pos1, size_type n1,
2000               const value_type* s, size_type n2) const {
2001     enforce(pos1 <= size(), std::__throw_out_of_range, "");
2002     procrustes(n1, size() - pos1);
2003     // The line below fixed by Jean-Francois Bastien, 04-23-2007. Thanks!
2004     const int r = traits_type::compare(pos1 + data(), s, std::min(n1, n2));
2005     return r != 0 ? r : n1 > n2 ? 1 : n1 < n2 ? -1 : 0;
2006   }
2007
2008   int compare(size_type pos1, size_type n1,
2009               const basic_fbstring& str,
2010               size_type pos2, size_type n2) const {
2011     enforce(pos2 <= str.size(), std::__throw_out_of_range, "");
2012     return compare(pos1, n1, str.data() + pos2,
2013                    std::min(n2, str.size() - pos2));
2014   }
2015
2016   // Code from Jean-Francois Bastien (03/26/2007)
2017   int compare(const value_type* s) const {
2018     // Could forward to compare(0, size(), s, traits_type::length(s))
2019     // but that does two extra checks
2020     const size_type n1(size()), n2(traits_type::length(s));
2021     const int r = traits_type::compare(data(), s, std::min(n1, n2));
2022     return r != 0 ? r : n1 > n2 ? 1 : n1 < n2 ? -1 : 0;
2023   }
2024
2025 private:
2026   // Data
2027   Storage store_;
2028 };
2029
2030 // non-member functions
2031 // C++11 21.4.8.1/1
2032 template <typename E, class T, class A, class S>
2033 inline
2034 basic_fbstring<E, T, A, S> operator+(const basic_fbstring<E, T, A, S>& lhs,
2035                                      const basic_fbstring<E, T, A, S>& rhs) {
2036
2037   basic_fbstring<E, T, A, S> result;
2038   result.reserve(lhs.size() + rhs.size());
2039   result.append(lhs).append(rhs);
2040   return std::move(result);
2041 }
2042
2043 // C++11 21.4.8.1/2
2044 template <typename E, class T, class A, class S>
2045 inline
2046 basic_fbstring<E, T, A, S> operator+(basic_fbstring<E, T, A, S>&& lhs,
2047                                      const basic_fbstring<E, T, A, S>& rhs) {
2048   return std::move(lhs.append(rhs));
2049 }
2050
2051 // C++11 21.4.8.1/3
2052 template <typename E, class T, class A, class S>
2053 inline
2054 basic_fbstring<E, T, A, S> operator+(const basic_fbstring<E, T, A, S>& lhs,
2055                                      basic_fbstring<E, T, A, S>&& rhs) {
2056   if (rhs.capacity() >= lhs.size() + rhs.size()) {
2057     // Good, at least we don't need to reallocate
2058     return std::move(rhs.insert(0, lhs));
2059   }
2060   // Meh, no go. Forward to operator+(const&, const&).
2061   auto const& rhsC = rhs;
2062   return lhs + rhsC;
2063 }
2064
2065 // C++11 21.4.8.1/4
2066 template <typename E, class T, class A, class S>
2067 inline
2068 basic_fbstring<E, T, A, S> operator+(basic_fbstring<E, T, A, S>&& lhs,
2069                                      basic_fbstring<E, T, A, S>&& rhs) {
2070   return std::move(lhs.append(rhs));
2071 }
2072
2073 // C++11 21.4.8.1/5
2074 template <typename E, class T, class A, class S>
2075 inline
2076 basic_fbstring<E, T, A, S> operator+(
2077   const E* lhs,
2078   const basic_fbstring<E, T, A, S>& rhs) {
2079   //
2080   basic_fbstring<E, T, A, S> result;
2081   const auto len = basic_fbstring<E, T, A, S>::traits_type::length(lhs);
2082   result.reserve(len + rhs.size());
2083   result.append(lhs, len).append(rhs);
2084   return result;
2085 }
2086
2087 // C++11 21.4.8.1/6
2088 template <typename E, class T, class A, class S>
2089 inline
2090 basic_fbstring<E, T, A, S> operator+(
2091   const E* lhs,
2092   basic_fbstring<E, T, A, S>&& rhs) {
2093   //
2094   const auto len = basic_fbstring<E, T, A, S>::traits_type::length(lhs);
2095   if (rhs.capacity() >= len + rhs.size()) {
2096     // Good, at least we don't need to reallocate
2097     rhs.insert(rhs.begin(), lhs, lhs + len);
2098     return rhs;
2099   }
2100   // Meh, no go. Do it by hand since we have len already.
2101   basic_fbstring<E, T, A, S> result;
2102   result.reserve(len + rhs.size());
2103   result.append(lhs, len).append(rhs);
2104   return result;
2105 }
2106
2107 // C++11 21.4.8.1/7
2108 template <typename E, class T, class A, class S>
2109 inline
2110 basic_fbstring<E, T, A, S> operator+(
2111   E lhs,
2112   const basic_fbstring<E, T, A, S>& rhs) {
2113
2114   basic_fbstring<E, T, A, S> result;
2115   result.reserve(1 + rhs.size());
2116   result.push_back(lhs);
2117   result.append(rhs);
2118   return result;
2119 }
2120
2121 // C++11 21.4.8.1/8
2122 template <typename E, class T, class A, class S>
2123 inline
2124 basic_fbstring<E, T, A, S> operator+(
2125   E lhs,
2126   basic_fbstring<E, T, A, S>&& rhs) {
2127   //
2128   if (rhs.capacity() > rhs.size()) {
2129     // Good, at least we don't need to reallocate
2130     rhs.insert(rhs.begin(), lhs);
2131     return rhs;
2132   }
2133   // Meh, no go. Forward to operator+(E, const&).
2134   auto const& rhsC = rhs;
2135   return lhs + rhsC;
2136 }
2137
2138 // C++11 21.4.8.1/9
2139 template <typename E, class T, class A, class S>
2140 inline
2141 basic_fbstring<E, T, A, S> operator+(
2142   const basic_fbstring<E, T, A, S>& lhs,
2143   const E* rhs) {
2144
2145   typedef typename basic_fbstring<E, T, A, S>::size_type size_type;
2146   typedef typename basic_fbstring<E, T, A, S>::traits_type traits_type;
2147
2148   basic_fbstring<E, T, A, S> result;
2149   const size_type len = traits_type::length(rhs);
2150   result.reserve(lhs.size() + len);
2151   result.append(lhs).append(rhs, len);
2152   return result;
2153 }
2154
2155 // C++11 21.4.8.1/10
2156 template <typename E, class T, class A, class S>
2157 inline
2158 basic_fbstring<E, T, A, S> operator+(
2159   basic_fbstring<E, T, A, S>&& lhs,
2160   const E* rhs) {
2161   //
2162   return std::move(lhs += rhs);
2163 }
2164
2165 // C++11 21.4.8.1/11
2166 template <typename E, class T, class A, class S>
2167 inline
2168 basic_fbstring<E, T, A, S> operator+(
2169   const basic_fbstring<E, T, A, S>& lhs,
2170   E rhs) {
2171
2172   basic_fbstring<E, T, A, S> result;
2173   result.reserve(lhs.size() + 1);
2174   result.append(lhs);
2175   result.push_back(rhs);
2176   return result;
2177 }
2178
2179 // C++11 21.4.8.1/12
2180 template <typename E, class T, class A, class S>
2181 inline
2182 basic_fbstring<E, T, A, S> operator+(
2183   basic_fbstring<E, T, A, S>&& lhs,
2184   E rhs) {
2185   //
2186   return std::move(lhs += rhs);
2187 }
2188
2189 template <typename E, class T, class A, class S>
2190 inline
2191 bool operator==(const basic_fbstring<E, T, A, S>& lhs,
2192                 const basic_fbstring<E, T, A, S>& rhs) {
2193   return lhs.size() == rhs.size() && lhs.compare(rhs) == 0; }
2194
2195 template <typename E, class T, class A, class S>
2196 inline
2197 bool operator==(const typename basic_fbstring<E, T, A, S>::value_type* lhs,
2198                 const basic_fbstring<E, T, A, S>& rhs) {
2199   return rhs == lhs; }
2200
2201 template <typename E, class T, class A, class S>
2202 inline
2203 bool operator==(const basic_fbstring<E, T, A, S>& lhs,
2204                 const typename basic_fbstring<E, T, A, S>::value_type* rhs) {
2205   return lhs.compare(rhs) == 0; }
2206
2207 template <typename E, class T, class A, class S>
2208 inline
2209 bool operator!=(const basic_fbstring<E, T, A, S>& lhs,
2210                 const basic_fbstring<E, T, A, S>& rhs) {
2211   return !(lhs == rhs); }
2212
2213 template <typename E, class T, class A, class S>
2214 inline
2215 bool operator!=(const typename basic_fbstring<E, T, A, S>::value_type* lhs,
2216                 const basic_fbstring<E, T, A, S>& rhs) {
2217   return !(lhs == rhs); }
2218
2219 template <typename E, class T, class A, class S>
2220 inline
2221 bool operator!=(const basic_fbstring<E, T, A, S>& lhs,
2222                 const typename basic_fbstring<E, T, A, S>::value_type* rhs) {
2223   return !(lhs == rhs); }
2224
2225 template <typename E, class T, class A, class S>
2226 inline
2227 bool operator<(const basic_fbstring<E, T, A, S>& lhs,
2228                const basic_fbstring<E, T, A, S>& rhs) {
2229   return lhs.compare(rhs) < 0; }
2230
2231 template <typename E, class T, class A, class S>
2232 inline
2233 bool operator<(const basic_fbstring<E, T, A, S>& lhs,
2234                const typename basic_fbstring<E, T, A, S>::value_type* rhs) {
2235   return lhs.compare(rhs) < 0; }
2236
2237 template <typename E, class T, class A, class S>
2238 inline
2239 bool operator<(const typename basic_fbstring<E, T, A, S>::value_type* lhs,
2240                const basic_fbstring<E, T, A, S>& rhs) {
2241   return rhs.compare(lhs) > 0; }
2242
2243 template <typename E, class T, class A, class S>
2244 inline
2245 bool operator>(const basic_fbstring<E, T, A, S>& lhs,
2246                const basic_fbstring<E, T, A, S>& rhs) {
2247   return rhs < lhs; }
2248
2249 template <typename E, class T, class A, class S>
2250 inline
2251 bool operator>(const basic_fbstring<E, T, A, S>& lhs,
2252                const typename basic_fbstring<E, T, A, S>::value_type* rhs) {
2253   return rhs < lhs; }
2254
2255 template <typename E, class T, class A, class S>
2256 inline
2257 bool operator>(const typename basic_fbstring<E, T, A, S>::value_type* lhs,
2258                const basic_fbstring<E, T, A, S>& rhs) {
2259   return rhs < lhs; }
2260
2261 template <typename E, class T, class A, class S>
2262 inline
2263 bool operator<=(const basic_fbstring<E, T, A, S>& lhs,
2264                 const basic_fbstring<E, T, A, S>& rhs) {
2265   return !(rhs < lhs); }
2266
2267 template <typename E, class T, class A, class S>
2268 inline
2269 bool operator<=(const basic_fbstring<E, T, A, S>& lhs,
2270                 const typename basic_fbstring<E, T, A, S>::value_type* rhs) {
2271   return !(rhs < lhs); }
2272
2273 template <typename E, class T, class A, class S>
2274 inline
2275 bool operator<=(const typename basic_fbstring<E, T, A, S>::value_type* lhs,
2276                 const basic_fbstring<E, T, A, S>& rhs) {
2277   return !(rhs < lhs); }
2278
2279 template <typename E, class T, class A, class S>
2280 inline
2281 bool operator>=(const basic_fbstring<E, T, A, S>& lhs,
2282                 const basic_fbstring<E, T, A, S>& rhs) {
2283   return !(lhs < rhs); }
2284
2285 template <typename E, class T, class A, class S>
2286 inline
2287 bool operator>=(const basic_fbstring<E, T, A, S>& lhs,
2288                 const typename basic_fbstring<E, T, A, S>::value_type* rhs) {
2289   return !(lhs < rhs); }
2290
2291 template <typename E, class T, class A, class S>
2292 inline
2293 bool operator>=(const typename basic_fbstring<E, T, A, S>::value_type* lhs,
2294                 const basic_fbstring<E, T, A, S>& rhs) {
2295  return !(lhs < rhs);
2296 }
2297
2298 // C++11 21.4.8.8
2299 template <typename E, class T, class A, class S>
2300 void swap(basic_fbstring<E, T, A, S>& lhs, basic_fbstring<E, T, A, S>& rhs) {
2301   lhs.swap(rhs);
2302 }
2303
2304 // TODO: make this faster.
2305 template <typename E, class T, class A, class S>
2306 inline
2307 std::basic_istream<
2308   typename basic_fbstring<E, T, A, S>::value_type,
2309   typename basic_fbstring<E, T, A, S>::traits_type>&
2310   operator>>(
2311     std::basic_istream<typename basic_fbstring<E, T, A, S>::value_type,
2312     typename basic_fbstring<E, T, A, S>::traits_type>& is,
2313     basic_fbstring<E, T, A, S>& str) {
2314   typename std::basic_istream<E, T>::sentry sentry(is);
2315   typedef std::basic_istream<typename basic_fbstring<E, T, A, S>::value_type,
2316                              typename basic_fbstring<E, T, A, S>::traits_type>
2317                         __istream_type;
2318   typedef typename __istream_type::ios_base __ios_base;
2319   size_t extracted = 0;
2320   auto err = __ios_base::goodbit;
2321   if (sentry) {
2322     auto n = is.width();
2323     if (n <= 0) {
2324       n = str.max_size();
2325     }
2326     str.erase();
2327     for (auto got = is.rdbuf()->sgetc(); extracted != size_t(n); ++extracted) {
2328       if (got == T::eof()) {
2329         err |= __ios_base::eofbit;
2330         is.width(0);
2331         break;
2332       }
2333       if (isspace(got)) break;
2334       str.push_back(got);
2335       got = is.rdbuf()->snextc();
2336     }
2337   }
2338   if (!extracted) {
2339     err |= __ios_base::failbit;
2340   }
2341   if (err) {
2342     is.setstate(err);
2343   }
2344   return is;
2345 }
2346
2347 template <typename E, class T, class A, class S>
2348 inline
2349 std::basic_ostream<typename basic_fbstring<E, T, A, S>::value_type,
2350                    typename basic_fbstring<E, T, A, S>::traits_type>&
2351 operator<<(
2352   std::basic_ostream<typename basic_fbstring<E, T, A, S>::value_type,
2353   typename basic_fbstring<E, T, A, S>::traits_type>& os,
2354     const basic_fbstring<E, T, A, S>& str) {
2355 #if _LIBCPP_VERSION
2356   typename std::basic_ostream<
2357     typename basic_fbstring<E, T, A, S>::value_type,
2358     typename basic_fbstring<E, T, A, S>::traits_type>::sentry __s(os);
2359   if (__s) {
2360     typedef std::ostreambuf_iterator<
2361       typename basic_fbstring<E, T, A, S>::value_type,
2362       typename basic_fbstring<E, T, A, S>::traits_type> _Ip;
2363     size_t __len = str.size();
2364     bool __left =
2365       (os.flags() & std::ios_base::adjustfield) == std::ios_base::left;
2366     if (__pad_and_output(_Ip(os),
2367                          str.data(),
2368                          __left ? str.data() + __len : str.data(),
2369                          str.data() + __len,
2370                          os,
2371                          os.fill()).failed()) {
2372       os.setstate(std::ios_base::badbit | std::ios_base::failbit);
2373     }
2374   }
2375 #elif defined(_MSC_VER)
2376   // MSVC doesn't define __ostream_insert
2377   os.write(str.data(), str.size());
2378 #else
2379   std::__ostream_insert(os, str.data(), str.size());
2380 #endif
2381   return os;
2382 }
2383
2384 template <typename E1, class T, class A, class S>
2385 const typename basic_fbstring<E1, T, A, S>::size_type
2386 basic_fbstring<E1, T, A, S>::npos =
2387               static_cast<typename basic_fbstring<E1, T, A, S>::size_type>(-1);
2388
2389 #ifndef _LIBSTDCXX_FBSTRING
2390 // basic_string compatibility routines
2391
2392 template <typename E, class T, class A, class S>
2393 inline
2394 bool operator==(const basic_fbstring<E, T, A, S>& lhs,
2395                 const std::string& rhs) {
2396   return lhs.compare(0, lhs.size(), rhs.data(), rhs.size()) == 0;
2397 }
2398
2399 template <typename E, class T, class A, class S>
2400 inline
2401 bool operator==(const std::string& lhs,
2402                 const basic_fbstring<E, T, A, S>& rhs) {
2403   return rhs == lhs;
2404 }
2405
2406 template <typename E, class T, class A, class S>
2407 inline
2408 bool operator!=(const basic_fbstring<E, T, A, S>& lhs,
2409                 const std::string& rhs) {
2410   return !(lhs == rhs);
2411 }
2412
2413 template <typename E, class T, class A, class S>
2414 inline
2415 bool operator!=(const std::string& lhs,
2416                 const basic_fbstring<E, T, A, S>& rhs) {
2417   return !(lhs == rhs);
2418 }
2419
2420 #if !defined(_LIBSTDCXX_FBSTRING)
2421 typedef basic_fbstring<char> fbstring;
2422 #endif
2423
2424 // fbstring is relocatable
2425 template <class T, class R, class A, class S>
2426 FOLLY_ASSUME_RELOCATABLE(basic_fbstring<T, R, A, S>);
2427
2428 #else
2429 _GLIBCXX_END_NAMESPACE_VERSION
2430 #endif
2431
2432 } // namespace folly
2433
2434 #ifndef _LIBSTDCXX_FBSTRING
2435
2436 // Hash functions to make fbstring usable with e.g. hash_map
2437 //
2438 // Handle interaction with different C++ standard libraries, which
2439 // expect these types to be in different namespaces.
2440
2441 #define FOLLY_FBSTRING_HASH1(T) \
2442   template <> \
2443   struct hash< ::folly::basic_fbstring<T> > { \
2444     size_t operator()(const ::folly::fbstring& s) const { \
2445       return ::folly::hash::fnv32_buf(s.data(), s.size()); \
2446     } \
2447   };
2448
2449 // The C++11 standard says that these four are defined
2450 #define FOLLY_FBSTRING_HASH \
2451   FOLLY_FBSTRING_HASH1(char) \
2452   FOLLY_FBSTRING_HASH1(char16_t) \
2453   FOLLY_FBSTRING_HASH1(char32_t) \
2454   FOLLY_FBSTRING_HASH1(wchar_t)
2455
2456 namespace std {
2457
2458 FOLLY_FBSTRING_HASH
2459
2460 }  // namespace std
2461
2462 #if FOLLY_HAVE_DEPRECATED_ASSOC
2463 #if defined(_GLIBCXX_SYMVER) && !defined(__BIONIC__)
2464 namespace __gnu_cxx {
2465
2466 FOLLY_FBSTRING_HASH
2467
2468 }  // namespace __gnu_cxx
2469 #endif // _GLIBCXX_SYMVER && !__BIONIC__
2470 #endif // FOLLY_HAVE_DEPRECATED_ASSOC
2471
2472 #undef FOLLY_FBSTRING_HASH
2473 #undef FOLLY_FBSTRING_HASH1
2474
2475 #endif // _LIBSTDCXX_FBSTRING
2476
2477 #pragma GCC diagnostic pop
2478
2479 #undef FBSTRING_DISABLE_SSO
2480 #undef FBSTRING_SANITIZE_ADDRESS
2481 #undef throw
2482 #undef FBSTRING_LIKELY
2483 #undef FBSTRING_UNLIKELY
2484
2485 #ifdef FOLLY_DEFINED_NDEBUG_FOR_FBSTRING
2486 #undef NDEBUG
2487 #undef FOLLY_DEFINED_NDEBUG_FOR_FBSTRING
2488 #endif // FOLLY_DEFINED_NDEBUG_FOR_FBSTRING