folly/Range.h

   1 /*
   2  * Copyright 2014 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 Mark Rabkin (mrabkin@fb.com)
  18 // @author Andrei Alexandrescu (andrei.alexandrescu@fb.com)
  19
  20 #ifndef FOLLY_RANGE_H_
  21 #define FOLLY_RANGE_H_
  22
  23 #include <folly/Portability.h>
  24 #include <folly/FBString.h>
  25 #include <algorithm>
  26 #include <boost/operators.hpp>
  27 #include <climits>
  28 #include <cstring>
  29 #include <glog/logging.h>
  30 #include <iosfwd>
  31 #include <stdexcept>
  32 #include <string>
  33 #include <type_traits>
  34
  35 // libc++ doesn't provide this header, nor does msvc
  36 #ifdef FOLLY_HAVE_BITS_CXXCONFIG_H
  37 // This file appears in two locations: inside fbcode and in the
  38 // libstdc++ source code (when embedding fbstring as std::string).
  39 // To aid in this schizophrenic use, two macros are defined in
  40 // c++config.h:
  41 //   _LIBSTDCXX_FBSTRING - Set inside libstdc++.  This is useful to
  42 //      gate use inside fbcode v. libstdc++
  43 #include <bits/c++config.h>
  44 #endif
  45
  46 #include <folly/CpuId.h>
  47 #include <folly/Traits.h>
  48 #include <folly/Likely.h>
  49
  50 // Ignore shadowing warnings within this file, so includers can use -Wshadow.
  51 #pragma GCC diagnostic push
  52 #pragma GCC diagnostic ignored "-Wshadow"
  53
  54 namespace folly {
  55
  56 template <class T> class Range;
  57
  58 /**
  59  * Finds the first occurrence of needle in haystack. The algorithm is on
  60  * average faster than O(haystack.size() * needle.size()) but not as fast
  61  * as Boyer-Moore. On the upside, it does not do any upfront
  62  * preprocessing and does not allocate memory.
  63  */
  64 template <class T, class Comp = std::equal_to<typename Range<T>::value_type>>
  65 inline size_t qfind(const Range<T> & haystack,
  66                     const Range<T> & needle,
  67                     Comp eq = Comp());
  68
  69 /**
  70  * Finds the first occurrence of needle in haystack. The result is the
  71  * offset reported to the beginning of haystack, or string::npos if
  72  * needle wasn't found.
  73  */
  74 template <class T>
  75 size_t qfind(const Range<T> & haystack,
  76              const typename Range<T>::value_type& needle);
  77
  78 /**
  79  * Finds the last occurrence of needle in haystack. The result is the
  80  * offset reported to the beginning of haystack, or string::npos if
  81  * needle wasn't found.
  82  */
  83 template <class T>
  84 size_t rfind(const Range<T> & haystack,
  85              const typename Range<T>::value_type& needle);
  86
  87
  88 /**
  89  * Finds the first occurrence of any element of needle in
  90  * haystack. The algorithm is O(haystack.size() * needle.size()).
  91  */
  92 template <class T>
  93 inline size_t qfind_first_of(const Range<T> & haystack,
  94                              const Range<T> & needle);
  95
  96 /**
  97  * Small internal helper - returns the value just before an iterator.
  98  */
  99 namespace detail {
 100
 101 /**
 102  * For random-access iterators, the value before is simply i[-1].
 103  */
 104 template <class Iter>
 105 typename std::enable_if<
 106   std::is_same<typename std::iterator_traits<Iter>::iterator_category,
 107                std::random_access_iterator_tag>::value,
 108   typename std::iterator_traits<Iter>::reference>::type
 109 value_before(Iter i) {
 110   return i[-1];
 111 }
 112
 113 /**
 114  * For all other iterators, we need to use the decrement operator.
 115  */
 116 template <class Iter>
 117 typename std::enable_if<
 118   !std::is_same<typename std::iterator_traits<Iter>::iterator_category,
 119                 std::random_access_iterator_tag>::value,
 120   typename std::iterator_traits<Iter>::reference>::type
 121 value_before(Iter i) {
 122   return *--i;
 123 }
 124
 125 /*
 126  * Use IsCharPointer<T>::type to enable const char* or char*.
 127  * Use IsCharPointer<T>::const_type to enable only const char*.
 128  */
 129 template <class T> struct IsCharPointer {};
 130
 131 template <>
 132 struct IsCharPointer<char*> {
 133   typedef int type;
 134 };
 135
 136 template <>
 137 struct IsCharPointer<const char*> {
 138   typedef int const_type;
 139   typedef int type;
 140 };
 141
 142 } // namespace detail
 143
 144 /**
 145  * Range abstraction keeping a pair of iterators. We couldn't use
 146  * boost's similar range abstraction because we need an API identical
 147  * with the former StringPiece class, which is used by a lot of other
 148  * code. This abstraction does fulfill the needs of boost's
 149  * range-oriented algorithms though.
 150  *
 151  * (Keep memory lifetime in mind when using this class, since it
 152  * doesn't manage the data it refers to - just like an iterator
 153  * wouldn't.)
 154  */
 155 template <class Iter>
 156 class Range : private boost::totally_ordered<Range<Iter> > {
 157 public:
 158   typedef std::size_t size_type;
 159   typedef Iter iterator;
 160   typedef Iter const_iterator;
 161   typedef typename std::remove_reference<
 162     typename std::iterator_traits<Iter>::reference>::type
 163   value_type;
 164   typedef typename std::iterator_traits<Iter>::reference reference;
 165
 166   /**
 167    * For MutableStringPiece and MutableByteRange we define StringPiece
 168    * and ByteRange as const_range_type (for everything else its just
 169    * identity). We do that to enable operations such as find with
 170    * args which are const.
 171    */
 172   typedef typename std::conditional<
 173     std::is_same<Iter, char*>::value
 174       || std::is_same<Iter, unsigned char*>::value,
 175     Range<const value_type*>,
 176     Range<Iter>>::type const_range_type;
 177
 178   typedef std::char_traits<typename std::remove_const<value_type>::type>
 179     traits_type;
 180
 181   static const size_type npos;
 182
 183   // Works for all iterators
 184   constexpr Range() : b_(), e_() {
 185   }
 186
 187 public:
 188   // Works for all iterators
 189   constexpr Range(Iter start, Iter end) : b_(start), e_(end) {
 190   }
 191
 192   // Works only for random-access iterators
 193   constexpr Range(Iter start, size_t size)
 194       : b_(start), e_(start + size) { }
 195
 196 #if FOLLY_HAVE_CONSTEXPR_STRLEN
 197   template <class T = Iter, typename detail::IsCharPointer<T>::type = 0>
 198   constexpr /* implicit */ Range(Iter str)
 199       : b_(str), e_(str + strlen(str)) {}
 200 #else
 201   template <class T = Iter, typename detail::IsCharPointer<T>::type = 0>
 202   /* implicit */ Range(Iter str)
 203       : b_(str), e_(str + strlen(str)) {}
 204 #endif
 205   template <class T = Iter, typename detail::IsCharPointer<T>::const_type = 0>
 206   /* implicit */ Range(const std::string& str)
 207       : b_(str.data()), e_(b_ + str.size()) {}
 208
 209   template <class T = Iter, typename detail::IsCharPointer<T>::const_type = 0>
 210   Range(const std::string& str, std::string::size_type startFrom) {
 211     if (UNLIKELY(startFrom > str.size())) {
 212       throw std::out_of_range("index out of range");
 213     }
 214     b_ = str.data() + startFrom;
 215     e_ = str.data() + str.size();
 216   }
 217
 218   template <class T = Iter, typename detail::IsCharPointer<T>::const_type = 0>
 219   Range(const std::string& str,
 220         std::string::size_type startFrom,
 221         std::string::size_type size) {
 222     if (UNLIKELY(startFrom > str.size())) {
 223       throw std::out_of_range("index out of range");
 224     }
 225     b_ = str.data() + startFrom;
 226     if (str.size() - startFrom < size) {
 227       e_ = str.data() + str.size();
 228     } else {
 229       e_ = b_ + size;
 230     }
 231   }
 232
 233   Range(const Range& other,
 234         size_type first,
 235         size_type length = npos)
 236       : Range(other.subpiece(first, length))
 237     { }
 238
 239   template <class T = Iter, typename detail::IsCharPointer<T>::const_type = 0>
 240   /* implicit */ Range(const fbstring& str)
 241     : b_(str.data()), e_(b_ + str.size()) { }
 242
 243   template <class T = Iter, typename detail::IsCharPointer<T>::const_type = 0>
 244   Range(const fbstring& str, fbstring::size_type startFrom) {
 245     if (UNLIKELY(startFrom > str.size())) {
 246       throw std::out_of_range("index out of range");
 247     }
 248     b_ = str.data() + startFrom;
 249     e_ = str.data() + str.size();
 250   }
 251
 252   template <class T = Iter, typename detail::IsCharPointer<T>::const_type = 0>
 253   Range(const fbstring& str, fbstring::size_type startFrom,
 254         fbstring::size_type size) {
 255     if (UNLIKELY(startFrom > str.size())) {
 256       throw std::out_of_range("index out of range");
 257     }
 258     b_ = str.data() + startFrom;
 259     if (str.size() - startFrom < size) {
 260       e_ = str.data() + str.size();
 261     } else {
 262       e_ = b_ + size;
 263     }
 264   }
 265
 266   // Allow implicit conversion from Range<const char*> (aka StringPiece) to
 267   // Range<const unsigned char*> (aka ByteRange), as they're both frequently
 268   // used to represent ranges of bytes.  Allow explicit conversion in the other
 269   // direction.
 270   template <class OtherIter, typename std::enable_if<
 271       (std::is_same<Iter, const unsigned char*>::value &&
 272        (std::is_same<OtherIter, const char*>::value ||
 273         std::is_same<OtherIter, char*>::value)), int>::type = 0>
 274   /* implicit */ Range(const Range<OtherIter>& other)
 275     : b_(reinterpret_cast<const unsigned char*>(other.begin())),
 276       e_(reinterpret_cast<const unsigned char*>(other.end())) {
 277   }
 278
 279   template <class OtherIter, typename std::enable_if<
 280       (std::is_same<Iter, unsigned char*>::value &&
 281        std::is_same<OtherIter, char*>::value), int>::type = 0>
 282   /* implicit */ Range(const Range<OtherIter>& other)
 283     : b_(reinterpret_cast<unsigned char*>(other.begin())),
 284       e_(reinterpret_cast<unsigned char*>(other.end())) {
 285   }
 286
 287   template <class OtherIter, typename std::enable_if<
 288       (std::is_same<Iter, const char*>::value &&
 289        (std::is_same<OtherIter, const unsigned char*>::value ||
 290         std::is_same<OtherIter, unsigned char*>::value)), int>::type = 0>
 291   explicit Range(const Range<OtherIter>& other)
 292     : b_(reinterpret_cast<const char*>(other.begin())),
 293       e_(reinterpret_cast<const char*>(other.end())) {
 294   }
 295
 296   template <class OtherIter, typename std::enable_if<
 297       (std::is_same<Iter, char*>::value &&
 298        std::is_same<OtherIter, unsigned char*>::value), int>::type = 0>
 299   explicit Range(const Range<OtherIter>& other)
 300     : b_(reinterpret_cast<char*>(other.begin())),
 301       e_(reinterpret_cast<char*>(other.end())) {
 302   }
 303
 304   // Allow implicit conversion from Range<From> to Range<To> if From is
 305   // implicitly convertible to To.
 306   template <class OtherIter, typename std::enable_if<
 307      (!std::is_same<Iter, OtherIter>::value &&
 308       std::is_convertible<OtherIter, Iter>::value), int>::type = 0>
 309   constexpr /* implicit */ Range(const Range<OtherIter>& other)
 310     : b_(other.begin()),
 311       e_(other.end()) {
 312   }
 313
 314   // Allow explicit conversion from Range<From> to Range<To> if From is
 315   // explicitly convertible to To.
 316   template <class OtherIter, typename std::enable_if<
 317     (!std::is_same<Iter, OtherIter>::value &&
 318      !std::is_convertible<OtherIter, Iter>::value &&
 319      std::is_constructible<Iter, const OtherIter&>::value), int>::type = 0>
 320   constexpr explicit Range(const Range<OtherIter>& other)
 321     : b_(other.begin()),
 322       e_(other.end()) {
 323   }
 324
 325   void clear() {
 326     b_ = Iter();
 327     e_ = Iter();
 328   }
 329
 330   void assign(Iter start, Iter end) {
 331     b_ = start;
 332     e_ = end;
 333   }
 334
 335   void reset(Iter start, size_type size) {
 336     b_ = start;
 337     e_ = start + size;
 338   }
 339
 340   // Works only for Range<const char*>
 341   void reset(const std::string& str) {
 342     reset(str.data(), str.size());
 343   }
 344
 345   size_type size() const {
 346     assert(b_ <= e_);
 347     return e_ - b_;
 348   }
 349   size_type walk_size() const {
 350     assert(b_ <= e_);
 351     return std::distance(b_, e_);
 352   }
 353   bool empty() const { return b_ == e_; }
 354   Iter data() const { return b_; }
 355   Iter start() const { return b_; }
 356   Iter begin() const { return b_; }
 357   Iter end() const { return e_; }
 358   Iter cbegin() const { return b_; }
 359   Iter cend() const { return e_; }
 360   value_type& front() {
 361     assert(b_ < e_);
 362     return *b_;
 363   }
 364   value_type& back() {
 365     assert(b_ < e_);
 366     return detail::value_before(e_);
 367   }
 368   const value_type& front() const {
 369     assert(b_ < e_);
 370     return *b_;
 371   }
 372   const value_type& back() const {
 373     assert(b_ < e_);
 374     return detail::value_before(e_);
 375   }
 376   // Works only for Range<const char*> and Range<char*>
 377   std::string str() const { return std::string(b_, size()); }
 378   std::string toString() const { return str(); }
 379   // Works only for Range<const char*> and Range<char*>
 380   fbstring fbstr() const { return fbstring(b_, size()); }
 381   fbstring toFbstring() const { return fbstr(); }
 382
 383   const_range_type castToConst() const {
 384     return const_range_type(*this);
 385   };
 386
 387   // Works only for Range<const char*> and Range<char*>
 388   int compare(const const_range_type& o) const {
 389     const size_type tsize = this->size();
 390     const size_type osize = o.size();
 391     const size_type msize = std::min(tsize, osize);
 392     int r = traits_type::compare(data(), o.data(), msize);
 393     if (r == 0 && tsize != osize) {
 394       // We check the signed bit of the subtraction and bit shift it
 395       // to produce either 0 or 2. The subtraction yields the
 396       // comparison values of either -1 or 1.
 397       r = (static_cast<int>(
 398              (osize - tsize) >> (CHAR_BIT * sizeof(size_t) - 1)) << 1) - 1;
 399     }
 400     return r;
 401   }
 402
 403   value_type& operator[](size_t i) {
 404     DCHECK_GT(size(), i);
 405     return b_[i];
 406   }
 407
 408   const value_type& operator[](size_t i) const {
 409     DCHECK_GT(size(), i);
 410     return b_[i];
 411   }
 412
 413   value_type& at(size_t i) {
 414     if (i >= size()) throw std::out_of_range("index out of range");
 415     return b_[i];
 416   }
 417
 418   const value_type& at(size_t i) const {
 419     if (i >= size()) throw std::out_of_range("index out of range");
 420     return b_[i];
 421   }
 422
 423   // Works only for Range<const char*> and Range<char*>
 424   uint32_t hash() const {
 425     // Taken from fbi/nstring.h:
 426     //    Quick and dirty bernstein hash...fine for short ascii strings
 427     uint32_t hash = 5381;
 428     for (size_t ix = 0; ix < size(); ix++) {
 429       hash = ((hash << 5) + hash) + b_[ix];
 430     }
 431     return hash;
 432   }
 433
 434   void advance(size_type n) {
 435     if (UNLIKELY(n > size())) {
 436       throw std::out_of_range("index out of range");
 437     }
 438     b_ += n;
 439   }
 440
 441   void subtract(size_type n) {
 442     if (UNLIKELY(n > size())) {
 443       throw std::out_of_range("index out of range");
 444     }
 445     e_ -= n;
 446   }
 447
 448   void pop_front() {
 449     assert(b_ < e_);
 450     ++b_;
 451   }
 452
 453   void pop_back() {
 454     assert(b_ < e_);
 455     --e_;
 456   }
 457
 458   Range subpiece(size_type first, size_type length = npos) const {
 459     if (UNLIKELY(first > size())) {
 460       throw std::out_of_range("index out of range");
 461     }
 462
 463     return Range(b_ + first, std::min(length, size() - first));
 464   }
 465
 466   // string work-alike functions
 467   size_type find(const_range_type str) const {
 468     return qfind(castToConst(), str);
 469   }
 470
 471   size_type find(const_range_type str, size_t pos) const {
 472     if (pos > size()) return std::string::npos;
 473     size_t ret = qfind(castToConst().subpiece(pos), str);
 474     return ret == npos ? ret : ret + pos;
 475   }
 476
 477   size_type find(Iter s, size_t pos, size_t n) const {
 478     if (pos > size()) return std::string::npos;
 479     auto forFinding = castToConst();
 480     size_t ret = qfind(
 481         pos ? forFinding.subpiece(pos) : forFinding, const_range_type(s, n));
 482     return ret == npos ? ret : ret + pos;
 483   }
 484
 485   // Works only for Range<(const) (unsigned) char*> which have Range(Iter) ctor
 486   size_type find(const Iter s) const {
 487     return qfind(castToConst(), const_range_type(s));
 488   }
 489
 490   // Works only for Range<(const) (unsigned) char*> which have Range(Iter) ctor
 491   size_type find(const Iter s, size_t pos) const {
 492     if (pos > size()) return std::string::npos;
 493     size_type ret = qfind(castToConst().subpiece(pos), const_range_type(s));
 494     return ret == npos ? ret : ret + pos;
 495   }
 496
 497   size_type find(value_type c) const {
 498     return qfind(castToConst(), c);
 499   }
 500
 501   size_type rfind(value_type c) const {
 502     return folly::rfind(castToConst(), c);
 503   }
 504
 505   size_type find(value_type c, size_t pos) const {
 506     if (pos > size()) return std::string::npos;
 507     size_type ret = qfind(castToConst().subpiece(pos), c);
 508     return ret == npos ? ret : ret + pos;
 509   }
 510
 511   size_type find_first_of(const_range_type needles) const {
 512     return qfind_first_of(castToConst(), needles);
 513   }
 514
 515   size_type find_first_of(const_range_type needles, size_t pos) const {
 516     if (pos > size()) return std::string::npos;
 517     size_type ret = qfind_first_of(castToConst().subpiece(pos), needles);
 518     return ret == npos ? ret : ret + pos;
 519   }
 520
 521   // Works only for Range<(const) (unsigned) char*> which have Range(Iter) ctor
 522   size_type find_first_of(Iter needles) const {
 523     return find_first_of(const_range_type(needles));
 524   }
 525
 526   // Works only for Range<(const) (unsigned) char*> which have Range(Iter) ctor
 527   size_type find_first_of(Iter needles, size_t pos) const {
 528     return find_first_of(const_range_type(needles), pos);
 529   }
 530
 531   size_type find_first_of(Iter needles, size_t pos, size_t n) const {
 532     return find_first_of(const_range_type(needles, n), pos);
 533   }
 534
 535   size_type find_first_of(value_type c) const {
 536     return find(c);
 537   }
 538
 539   size_type find_first_of(value_type c, size_t pos) const {
 540     return find(c, pos);
 541   }
 542
 543   /**
 544    * Determine whether the range contains the given subrange or item.
 545    *
 546    * Note: Call find() directly if the index is needed.
 547    */
 548   bool contains(const const_range_type& other) const {
 549     return find(other) != std::string::npos;
 550   }
 551
 552   bool contains(const value_type& other) const {
 553     return find(other) != std::string::npos;
 554   }
 555
 556   void swap(Range& rhs) {
 557     std::swap(b_, rhs.b_);
 558     std::swap(e_, rhs.e_);
 559   }
 560
 561   /**
 562    * Does this Range start with another range?
 563    */
 564   bool startsWith(const const_range_type& other) const {
 565     return size() >= other.size()
 566       && castToConst().subpiece(0, other.size()) == other;
 567   }
 568   bool startsWith(value_type c) const {
 569     return !empty() && front() == c;
 570   }
 571
 572   /**
 573    * Does this Range end with another range?
 574    */
 575   bool endsWith(const const_range_type& other) const {
 576     return size() >= other.size()
 577       && castToConst().subpiece(size() - other.size()) == other;
 578   }
 579   bool endsWith(value_type c) const {
 580     return !empty() && back() == c;
 581   }
 582
 583   /**
 584    * Remove the given prefix and return true if the range starts with the given
 585    * prefix; return false otherwise.
 586    */
 587   bool removePrefix(const const_range_type& prefix) {
 588     return startsWith(prefix) && (b_ += prefix.size(), true);
 589   }
 590   bool removePrefix(value_type prefix) {
 591     return startsWith(prefix) && (++b_, true);
 592   }
 593
 594   /**
 595    * Remove the given suffix and return true if the range ends with the given
 596    * suffix; return false otherwise.
 597    */
 598   bool removeSuffix(const const_range_type& suffix) {
 599     return endsWith(suffix) && (e_ -= suffix.size(), true);
 600   }
 601   bool removeSuffix(value_type suffix) {
 602     return endsWith(suffix) && (--e_, true);
 603   }
 604
 605   /**
 606    * Replaces the content of the range, starting at position 'pos', with
 607    * contents of 'replacement'. Entire 'replacement' must fit into the
 608    * range. Returns false if 'replacements' does not fit. Example use:
 609    *
 610    * char in[] = "buffer";
 611    * auto msp = MutablesStringPiece(input);
 612    * EXPECT_TRUE(msp.replaceAt(2, "tt"));
 613    * EXPECT_EQ(msp, "butter");
 614    *
 615    * // not enough space
 616    * EXPECT_FALSE(msp.replace(msp.size() - 1, "rr"));
 617    * EXPECT_EQ(msp, "butter"); // unchanged
 618    */
 619   bool replaceAt(size_t pos, const_range_type replacement) {
 620     if (size() < pos + replacement.size()) {
 621       return false;
 622     }
 623
 624     std::copy(replacement.begin(), replacement.end(), begin() + pos);
 625
 626     return true;
 627   }
 628
 629   /**
 630    * Replaces all occurences of 'source' with 'dest'. Returns number
 631    * of replacements made. Source and dest have to have the same
 632    * length. Throws if the lengths are different. If 'source' is a
 633    * pattern that is overlapping with itself, we perform sequential
 634    * replacement: "aaaaaaa".replaceAll("aa", "ba") --> "bababaa"
 635    *
 636    * Example use:
 637    *
 638    * char in[] = "buffer";
 639    * auto msp = MutablesStringPiece(input);
 640    * EXPECT_EQ(msp.replaceAll("ff","tt"), 1);
 641    * EXPECT_EQ(msp, "butter");
 642    */
 643   size_t replaceAll(const_range_type source, const_range_type dest) {
 644     if (source.size() != dest.size()) {
 645       throw std::invalid_argument(
 646           "replacement must have the same size as source");
 647     }
 648
 649     if (dest.empty()) {
 650       return 0;
 651     }
 652
 653     size_t pos = 0;
 654     size_t num_replaced = 0;
 655     size_type found = std::string::npos;
 656     while ((found = find(source, pos)) != std::string::npos) {
 657       replaceAt(found, dest);
 658       pos += source.size();
 659       ++num_replaced;
 660     }
 661
 662     return num_replaced;
 663   }
 664
 665   /**
 666    * Splits this `Range` `[b, e)` in the position `i` dictated by the next
 667    * occurence of `delimiter`.
 668    *
 669    * Returns a new `Range` `[b, i)` and adjusts this range to start right after
 670    * the delimiter's position. This range will be empty if the delimiter is not
 671    * found. If called on an empty `Range`, both this and the returned `Range`
 672    * will be empty.
 673    *
 674    * Example:
 675    *
 676    *  folly::StringPiece s("sample string for split_next");
 677    *  auto p = s.split_step(' ');
 678    *
 679    *  // prints "string for split_next"
 680    *  cout << s << endl;
 681    *
 682    *  // prints "sample"
 683    *  cout << p << endl;
 684    *
 685    * Example 2:
 686    *
 687    *  void tokenize(StringPiece s, char delimiter) {
 688    *    while (!s.empty()) {
 689    *      cout << s.split_step(delimiter);
 690    *    }
 691    *  }
 692    *
 693    * @author: Marcelo Juchem <marcelo@fb.com>
 694    */
 695   Range split_step(value_type delimiter) {
 696     auto i = std::find(b_, e_, delimiter);
 697     Range result(b_, i);
 698
 699     b_ = i == e_ ? e_ : std::next(i);
 700
 701     return result;
 702   }
 703
 704   Range split_step(Range delimiter) {
 705     auto i = find(delimiter);
 706     Range result(b_, i == std::string::npos ? size() : i);
 707
 708     b_ = result.end() == e_ ? e_ : std::next(result.end(), delimiter.size());
 709
 710     return result;
 711   }
 712
 713   /**
 714    * Convenience method that calls `split_step()` and passes the result to a
 715    * functor, returning whatever the functor does. Any additional arguments
 716    * `args` passed to this function are perfectly forwarded to the functor.
 717    *
 718    * Say you have a functor with this signature:
 719    *
 720    *  Foo fn(Range r) { }
 721    *
 722    * `split_step()`'s return type will be `Foo`. It works just like:
 723    *
 724    *  auto result = fn(myRange.split_step(' '));
 725    *
 726    * A functor returning `void` is also supported.
 727    *
 728    * Example:
 729    *
 730    *  void do_some_parsing(folly::StringPiece s) {
 731    *    auto version = s.split_step(' ', [&](folly::StringPiece x) {
 732    *      if (x.empty()) {
 733    *        throw std::invalid_argument("empty string");
 734    *      }
 735    *      return std::strtoull(x.begin(), x.end(), 16);
 736    *    });
 737    *
 738    *    // ...
 739    *  }
 740    *
 741    *  struct Foo {
 742    *    void parse(folly::StringPiece s) {
 743    *      s.split_step(' ', parse_field, bar, 10);
 744    *      s.split_step('\t', parse_field, baz, 20);
 745    *
 746    *      auto const kludge = [](folly::StringPiece x, int &out, int def) {
 747    *        if (x == "null") {
 748    *          out = 0;
 749    *        } else {
 750    *          parse_field(x, out, def);
 751    *        }
 752    *      };
 753    *
 754    *      s.split_step('\t', kludge, gaz);
 755    *      s.split_step(' ', kludge, foo);
 756    *    }
 757    *
 758    *  private:
 759    *    int bar;
 760    *    int baz;
 761    *    int gaz;
 762    *    int foo;
 763    *
 764    *    static parse_field(folly::StringPiece s, int &out, int def) {
 765    *      try {
 766    *        out = folly::to<int>(s);
 767    *      } catch (std::exception const &) {
 768    *        value = def;
 769    *      }
 770    *    }
 771    *  };
 772    *
 773    * @author: Marcelo Juchem <marcelo@fb.com>
 774    */
 775   template <typename TProcess, typename... Args>
 776   auto split_step(value_type delimiter, TProcess &&process, Args &&...args)
 777     -> decltype(process(std::declval<Range>(), std::forward<Args>(args)...))
 778   { return process(split_step(delimiter), std::forward<Args>(args)...); }
 779
 780   template <typename TProcess, typename... Args>
 781   auto split_step(Range delimiter, TProcess &&process, Args &&...args)
 782     -> decltype(process(std::declval<Range>(), std::forward<Args>(args)...))
 783   { return process(split_step(delimiter), std::forward<Args>(args)...); }
 784
 785 private:
 786   Iter b_, e_;
 787 };
 788
 789 template <class Iter>
 790 const typename Range<Iter>::size_type Range<Iter>::npos = std::string::npos;
 791
 792 template <class T>
 793 void swap(Range<T>& lhs, Range<T>& rhs) {
 794   lhs.swap(rhs);
 795 }
 796
 797 /**
 798  * Create a range from two iterators, with type deduction.
 799  */
 800 template <class Iter>
 801 Range<Iter> range(Iter first, Iter last) {
 802   return Range<Iter>(first, last);
 803 }
 804
 805 /*
 806  * Creates a range to reference the contents of a contiguous-storage container.
 807  */
 808 // Use pointers for types with '.data()' member
 809 template <class Collection,
 810           class T = typename std::remove_pointer<
 811               decltype(std::declval<Collection>().data())>::type>
 812 Range<T*> range(Collection&& v) {
 813   return Range<T*>(v.data(), v.data() + v.size());
 814 }
 815
 816 template <class T, size_t n>
 817 Range<T*> range(T (&array)[n]) {
 818   return Range<T*>(array, array + n);
 819 }
 820
 821 typedef Range<const char*> StringPiece;
 822 typedef Range<char*> MutableStringPiece;
 823 typedef Range<const unsigned char*> ByteRange;
 824 typedef Range<unsigned char*> MutableByteRange;
 825
 826 std::ostream& operator<<(std::ostream& os, const StringPiece piece);
 827 std::ostream& operator<<(std::ostream& os, const MutableStringPiece piece);
 828
 829 /**
 830  * Templated comparison operators
 831  */
 832
 833 template <class T>
 834 inline bool operator==(const Range<T>& lhs, const Range<T>& rhs) {
 835   return lhs.size() == rhs.size() && lhs.compare(rhs) == 0;
 836 }
 837
 838 template <class T>
 839 inline bool operator<(const Range<T>& lhs, const Range<T>& rhs) {
 840   return lhs.compare(rhs) < 0;
 841 }
 842
 843 /**
 844  * Specializations of comparison operators for StringPiece
 845  */
 846
 847 namespace detail {
 848
 849 template <class A, class B>
 850 struct ComparableAsStringPiece {
 851   enum {
 852     value =
 853     (std::is_convertible<A, StringPiece>::value
 854      && std::is_same<B, StringPiece>::value)
 855     ||
 856     (std::is_convertible<B, StringPiece>::value
 857      && std::is_same<A, StringPiece>::value)
 858   };
 859 };
 860
 861 } // namespace detail
 862
 863 /**
 864  * operator== through conversion for Range<const char*>
 865  */
 866 template <class T, class U>
 867 typename
 868 std::enable_if<detail::ComparableAsStringPiece<T, U>::value, bool>::type
 869 operator==(const T& lhs, const U& rhs) {
 870   return StringPiece(lhs) == StringPiece(rhs);
 871 }
 872
 873 /**
 874  * operator< through conversion for Range<const char*>
 875  */
 876 template <class T, class U>
 877 typename
 878 std::enable_if<detail::ComparableAsStringPiece<T, U>::value, bool>::type
 879 operator<(const T& lhs, const U& rhs) {
 880   return StringPiece(lhs) < StringPiece(rhs);
 881 }
 882
 883 /**
 884  * operator> through conversion for Range<const char*>
 885  */
 886 template <class T, class U>
 887 typename
 888 std::enable_if<detail::ComparableAsStringPiece<T, U>::value, bool>::type
 889 operator>(const T& lhs, const U& rhs) {
 890   return StringPiece(lhs) > StringPiece(rhs);
 891 }
 892
 893 /**
 894  * operator< through conversion for Range<const char*>
 895  */
 896 template <class T, class U>
 897 typename
 898 std::enable_if<detail::ComparableAsStringPiece<T, U>::value, bool>::type
 899 operator<=(const T& lhs, const U& rhs) {
 900   return StringPiece(lhs) <= StringPiece(rhs);
 901 }
 902
 903 /**
 904  * operator> through conversion for Range<const char*>
 905  */
 906 template <class T, class U>
 907 typename
 908 std::enable_if<detail::ComparableAsStringPiece<T, U>::value, bool>::type
 909 operator>=(const T& lhs, const U& rhs) {
 910   return StringPiece(lhs) >= StringPiece(rhs);
 911 }
 912
 913 struct StringPieceHash {
 914   std::size_t operator()(const StringPiece str) const {
 915     return static_cast<std::size_t>(str.hash());
 916   }
 917 };
 918
 919 /**
 920  * Finds substrings faster than brute force by borrowing from Boyer-Moore
 921  */
 922 template <class T, class Comp>
 923 size_t qfind(const Range<T>& haystack,
 924              const Range<T>& needle,
 925              Comp eq) {
 926   // Don't use std::search, use a Boyer-Moore-like trick by comparing
 927   // the last characters first
 928   auto const nsize = needle.size();
 929   if (haystack.size() < nsize) {
 930     return std::string::npos;
 931   }
 932   if (!nsize) return 0;
 933   auto const nsize_1 = nsize - 1;
 934   auto const lastNeedle = needle[nsize_1];
 935
 936   // Boyer-Moore skip value for the last char in the needle. Zero is
 937   // not a valid value; skip will be computed the first time it's
 938   // needed.
 939   std::string::size_type skip = 0;
 940
 941   auto i = haystack.begin();
 942   auto iEnd = haystack.end() - nsize_1;
 943
 944   while (i < iEnd) {
 945     // Boyer-Moore: match the last element in the needle
 946     while (!eq(i[nsize_1], lastNeedle)) {
 947       if (++i == iEnd) {
 948         // not found
 949         return std::string::npos;
 950       }
 951     }
 952     // Here we know that the last char matches
 953     // Continue in pedestrian mode
 954     for (size_t j = 0; ; ) {
 955       assert(j < nsize);
 956       if (!eq(i[j], needle[j])) {
 957         // Not found, we can skip
 958         // Compute the skip value lazily
 959         if (skip == 0) {
 960           skip = 1;
 961           while (skip <= nsize_1 && !eq(needle[nsize_1 - skip], lastNeedle)) {
 962             ++skip;
 963           }
 964         }
 965         i += skip;
 966         break;
 967       }
 968       // Check if done searching
 969       if (++j == nsize) {
 970         // Yay
 971         return i - haystack.begin();
 972       }
 973     }
 974   }
 975   return std::string::npos;
 976 }
 977
 978 namespace detail {
 979
 980 size_t qfind_first_byte_of_nosse(const StringPiece haystack,
 981                                  const StringPiece needles);
 982
 983 #if FOLLY_HAVE_EMMINTRIN_H && __GNUC_PREREQ(4, 6)
 984 size_t qfind_first_byte_of_sse42(const StringPiece haystack,
 985                                  const StringPiece needles);
 986
 987 inline size_t qfind_first_byte_of(const StringPiece haystack,
 988                                   const StringPiece needles) {
 989   static auto const qfind_first_byte_of_fn =
 990     folly::CpuId().sse42() ? qfind_first_byte_of_sse42
 991                            : qfind_first_byte_of_nosse;
 992   return qfind_first_byte_of_fn(haystack, needles);
 993 }
 994
 995 #else
 996 inline size_t qfind_first_byte_of(const StringPiece haystack,
 997                                   const StringPiece needles) {
 998   return qfind_first_byte_of_nosse(haystack, needles);
 999 }
1000 #endif // FOLLY_HAVE_EMMINTRIN_H
1001
1002 } // namespace detail
1003
1004 template <class T, class Comp>
1005 size_t qfind_first_of(const Range<T> & haystack,
1006                       const Range<T> & needles,
1007                       Comp eq) {
1008   auto ret = std::find_first_of(haystack.begin(), haystack.end(),
1009                                 needles.begin(), needles.end(),
1010                                 eq);
1011   return ret == haystack.end() ? std::string::npos : ret - haystack.begin();
1012 }
1013
1014 struct AsciiCaseSensitive {
1015   bool operator()(char lhs, char rhs) const {
1016     return lhs == rhs;
1017   }
1018 };
1019
1020 /**
1021  * Check if two ascii characters are case insensitive equal.
1022  * The difference between the lower/upper case characters are the 6-th bit.
1023  * We also check they are alpha chars, in case of xor = 32.
1024  */
1025 struct AsciiCaseInsensitive {
1026   bool operator()(char lhs, char rhs) const {
1027     char k = lhs ^ rhs;
1028     if (k == 0) return true;
1029     if (k != 32) return false;
1030     k = lhs | rhs;
1031     return (k >= 'a' && k <= 'z');
1032   }
1033 };
1034
1035 extern const AsciiCaseSensitive asciiCaseSensitive;
1036 extern const AsciiCaseInsensitive asciiCaseInsensitive;
1037
1038 template <class T>
1039 size_t qfind(const Range<T>& haystack,
1040              const typename Range<T>::value_type& needle) {
1041   auto pos = std::find(haystack.begin(), haystack.end(), needle);
1042   return pos == haystack.end() ? std::string::npos : pos - haystack.data();
1043 }
1044
1045 template <class T>
1046 size_t rfind(const Range<T>& haystack,
1047              const typename Range<T>::value_type& needle) {
1048   for (auto i = haystack.size(); i-- > 0; ) {
1049     if (haystack[i] == needle) {
1050       return i;
1051     }
1052   }
1053   return std::string::npos;
1054 }
1055
1056 // specialization for StringPiece
1057 template <>
1058 inline size_t qfind(const Range<const char*>& haystack, const char& needle) {
1059   auto pos = static_cast<const char*>(
1060     ::memchr(haystack.data(), needle, haystack.size()));
1061   return pos == nullptr ? std::string::npos : pos - haystack.data();
1062 }
1063
1064 #if FOLLY_HAVE_MEMRCHR
1065 template <>
1066 inline size_t rfind(const Range<const char*>& haystack, const char& needle) {
1067   auto pos = static_cast<const char*>(
1068     ::memrchr(haystack.data(), needle, haystack.size()));
1069   return pos == nullptr ? std::string::npos : pos - haystack.data();
1070 }
1071 #endif
1072
1073 // specialization for ByteRange
1074 template <>
1075 inline size_t qfind(const Range<const unsigned char*>& haystack,
1076                     const unsigned char& needle) {
1077   auto pos = static_cast<const unsigned char*>(
1078     ::memchr(haystack.data(), needle, haystack.size()));
1079   return pos == nullptr ? std::string::npos : pos - haystack.data();
1080 }
1081
1082 #if FOLLY_HAVE_MEMRCHR
1083 template <>
1084 inline size_t rfind(const Range<const unsigned char*>& haystack,
1085                     const unsigned char& needle) {
1086   auto pos = static_cast<const unsigned char*>(
1087     ::memrchr(haystack.data(), needle, haystack.size()));
1088   return pos == nullptr ? std::string::npos : pos - haystack.data();
1089 }
1090 #endif
1091
1092 template <class T>
1093 size_t qfind_first_of(const Range<T>& haystack,
1094                       const Range<T>& needles) {
1095   return qfind_first_of(haystack, needles, asciiCaseSensitive);
1096 }
1097
1098 // specialization for StringPiece
1099 template <>
1100 inline size_t qfind_first_of(const Range<const char*>& haystack,
1101                              const Range<const char*>& needles) {
1102   return detail::qfind_first_byte_of(haystack, needles);
1103 }
1104
1105 // specialization for ByteRange
1106 template <>
1107 inline size_t qfind_first_of(const Range<const unsigned char*>& haystack,
1108                              const Range<const unsigned char*>& needles) {
1109   return detail::qfind_first_byte_of(StringPiece(haystack),
1110                                      StringPiece(needles));
1111 }
1112 }  // !namespace folly
1113
1114 #pragma GCC diagnostic pop
1115
1116 FOLLY_ASSUME_FBVECTOR_COMPATIBLE_1(folly::Range);
1117
1118 #endif // FOLLY_RANGE_H_