string_view.h 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  1. //
  2. // Copyright 2017 The Abseil Authors.
  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. // https://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. // File: string_view.h
  18. // -----------------------------------------------------------------------------
  19. //
  20. // This file contains the definition of the `absl::string_view` class. A
  21. // `string_view` points to a contiguous span of characters, often part or all of
  22. // another `std::string`, double-quoted string literal, character array, or even
  23. // another `string_view`.
  24. //
  25. // This `absl::string_view` abstraction is designed to be a drop-in
  26. // replacement for the C++17 `std::string_view` abstraction.
  27. #ifndef ABSL_STRINGS_STRING_VIEW_H_
  28. #define ABSL_STRINGS_STRING_VIEW_H_
  29. #include <algorithm>
  30. #include <cassert>
  31. #include <cstddef>
  32. #include <cstring>
  33. #include <iosfwd>
  34. #include <iterator>
  35. #include <limits>
  36. #include <string>
  37. #include "absl/base/attributes.h"
  38. #include "absl/base/nullability.h"
  39. #include "absl/base/config.h"
  40. #include "absl/base/internal/throw_delegate.h"
  41. #include "absl/base/macros.h"
  42. #include "absl/base/optimization.h"
  43. #include "absl/base/port.h"
  44. #ifdef ABSL_USES_STD_STRING_VIEW
  45. #include <string_view> // IWYU pragma: export
  46. namespace absl {
  47. ABSL_NAMESPACE_BEGIN
  48. using string_view = std::string_view;
  49. ABSL_NAMESPACE_END
  50. } // namespace absl
  51. #else // ABSL_USES_STD_STRING_VIEW
  52. #if ABSL_HAVE_BUILTIN(__builtin_memcmp) || \
  53. (defined(__GNUC__) && !defined(__clang__)) || \
  54. (defined(_MSC_VER) && _MSC_VER >= 1928)
  55. #define ABSL_INTERNAL_STRING_VIEW_MEMCMP __builtin_memcmp
  56. #else // ABSL_HAVE_BUILTIN(__builtin_memcmp)
  57. #define ABSL_INTERNAL_STRING_VIEW_MEMCMP memcmp
  58. #endif // ABSL_HAVE_BUILTIN(__builtin_memcmp)
  59. namespace absl {
  60. ABSL_NAMESPACE_BEGIN
  61. // absl::string_view
  62. //
  63. // A `string_view` provides a lightweight view into the string data provided by
  64. // a `std::string`, double-quoted string literal, character array, or even
  65. // another `string_view`. A `string_view` does *not* own the string to which it
  66. // points, and that data cannot be modified through the view.
  67. //
  68. // You can use `string_view` as a function or method parameter anywhere a
  69. // parameter can receive a double-quoted string literal, `const char*`,
  70. // `std::string`, or another `absl::string_view` argument with no need to copy
  71. // the string data. Systematic use of `string_view` within function arguments
  72. // reduces data copies and `strlen()` calls.
  73. //
  74. // Because of its small size, prefer passing `string_view` by value:
  75. //
  76. // void MyFunction(absl::string_view arg);
  77. //
  78. // If circumstances require, you may also pass one by const reference:
  79. //
  80. // void MyFunction(const absl::string_view& arg); // not preferred
  81. //
  82. // Passing by value generates slightly smaller code for many architectures.
  83. //
  84. // In either case, the source data of the `string_view` must outlive the
  85. // `string_view` itself.
  86. //
  87. // A `string_view` is also suitable for local variables if you know that the
  88. // lifetime of the underlying object is longer than the lifetime of your
  89. // `string_view` variable. However, beware of binding a `string_view` to a
  90. // temporary value:
  91. //
  92. // // BAD use of string_view: lifetime problem
  93. // absl::string_view sv = obj.ReturnAString();
  94. //
  95. // // GOOD use of string_view: str outlives sv
  96. // std::string str = obj.ReturnAString();
  97. // absl::string_view sv = str;
  98. //
  99. // Due to lifetime issues, a `string_view` is sometimes a poor choice for a
  100. // return value and usually a poor choice for a data member. If you do use a
  101. // `string_view` this way, it is your responsibility to ensure that the object
  102. // pointed to by the `string_view` outlives the `string_view`.
  103. //
  104. // A `string_view` may represent a whole string or just part of a string. For
  105. // example, when splitting a string, `std::vector<absl::string_view>` is a
  106. // natural data type for the output.
  107. //
  108. // For another example, a Cord is a non-contiguous, potentially very
  109. // long string-like object. The Cord class has an interface that iteratively
  110. // provides string_view objects that point to the successive pieces of a Cord
  111. // object.
  112. //
  113. // When constructed from a source which is NUL-terminated, the `string_view`
  114. // itself will not include the NUL-terminator unless a specific size (including
  115. // the NUL) is passed to the constructor. As a result, common idioms that work
  116. // on NUL-terminated strings do not work on `string_view` objects. If you write
  117. // code that scans a `string_view`, you must check its length rather than test
  118. // for nul, for example. Note, however, that nuls may still be embedded within
  119. // a `string_view` explicitly.
  120. //
  121. // You may create a null `string_view` in two ways:
  122. //
  123. // absl::string_view sv;
  124. // absl::string_view sv(nullptr, 0);
  125. //
  126. // For the above, `sv.data() == nullptr`, `sv.length() == 0`, and
  127. // `sv.empty() == true`. Also, if you create a `string_view` with a non-null
  128. // pointer then `sv.data() != nullptr`. Thus, you can use `string_view()` to
  129. // signal an undefined value that is different from other `string_view` values
  130. // in a similar fashion to how `const char* p1 = nullptr;` is different from
  131. // `const char* p2 = "";`. However, in practice, it is not recommended to rely
  132. // on this behavior.
  133. //
  134. // Be careful not to confuse a null `string_view` with an empty one. A null
  135. // `string_view` is an empty `string_view`, but some empty `string_view`s are
  136. // not null. Prefer checking for emptiness over checking for null.
  137. //
  138. // There are many ways to create an empty string_view:
  139. //
  140. // const char* nullcp = nullptr;
  141. // // string_view.size() will return 0 in all cases.
  142. // absl::string_view();
  143. // absl::string_view(nullcp, 0);
  144. // absl::string_view("");
  145. // absl::string_view("", 0);
  146. // absl::string_view("abcdef", 0);
  147. // absl::string_view("abcdef" + 6, 0);
  148. //
  149. // All empty `string_view` objects whether null or not, are equal:
  150. //
  151. // absl::string_view() == absl::string_view("", 0)
  152. // absl::string_view(nullptr, 0) == absl::string_view("abcdef"+6, 0)
  153. class ABSL_INTERNAL_ATTRIBUTE_VIEW string_view {
  154. public:
  155. using traits_type = std::char_traits<char>;
  156. using value_type = char;
  157. using pointer = absl::Nullable<char*>;
  158. using const_pointer = absl::Nullable<const char*>;
  159. using reference = char&;
  160. using const_reference = const char&;
  161. using const_iterator = absl::Nullable<const char*>;
  162. using iterator = const_iterator;
  163. using const_reverse_iterator = std::reverse_iterator<const_iterator>;
  164. using reverse_iterator = const_reverse_iterator;
  165. using size_type = size_t;
  166. using difference_type = std::ptrdiff_t;
  167. using absl_internal_is_view = std::true_type;
  168. static constexpr size_type npos = static_cast<size_type>(-1);
  169. // Null `string_view` constructor
  170. constexpr string_view() noexcept : ptr_(nullptr), length_(0) {}
  171. // Implicit constructors
  172. template <typename Allocator>
  173. string_view( // NOLINT(runtime/explicit)
  174. const std::basic_string<char, std::char_traits<char>, Allocator>& str
  175. ABSL_ATTRIBUTE_LIFETIME_BOUND) noexcept
  176. // This is implemented in terms of `string_view(p, n)` so `str.size()`
  177. // doesn't need to be reevaluated after `ptr_` is set.
  178. // The length check is also skipped since it is unnecessary and causes
  179. // code bloat.
  180. : string_view(str.data(), str.size(), SkipCheckLengthTag{}) {}
  181. // Implicit constructor of a `string_view` from NUL-terminated `str`. When
  182. // accepting possibly null strings, use `absl::NullSafeStringView(str)`
  183. // instead (see below).
  184. // The length check is skipped since it is unnecessary and causes code bloat.
  185. constexpr string_view( // NOLINT(runtime/explicit)
  186. absl::Nonnull<const char*> str)
  187. : ptr_(str), length_(str ? StrlenInternal(str) : 0) {}
  188. // Implicit constructor of a `string_view` from a `const char*` and length.
  189. constexpr string_view(absl::Nullable<const char*> data, size_type len)
  190. : ptr_(data), length_(CheckLengthInternal(len)) {}
  191. // NOTE: Harmlessly omitted to work around gdb bug.
  192. // constexpr string_view(const string_view&) noexcept = default;
  193. // string_view& operator=(const string_view&) noexcept = default;
  194. // Iterators
  195. // string_view::begin()
  196. //
  197. // Returns an iterator pointing to the first character at the beginning of the
  198. // `string_view`, or `end()` if the `string_view` is empty.
  199. constexpr const_iterator begin() const noexcept { return ptr_; }
  200. // string_view::end()
  201. //
  202. // Returns an iterator pointing just beyond the last character at the end of
  203. // the `string_view`. This iterator acts as a placeholder; attempting to
  204. // access it results in undefined behavior.
  205. constexpr const_iterator end() const noexcept { return ptr_ + length_; }
  206. // string_view::cbegin()
  207. //
  208. // Returns a const iterator pointing to the first character at the beginning
  209. // of the `string_view`, or `end()` if the `string_view` is empty.
  210. constexpr const_iterator cbegin() const noexcept { return begin(); }
  211. // string_view::cend()
  212. //
  213. // Returns a const iterator pointing just beyond the last character at the end
  214. // of the `string_view`. This pointer acts as a placeholder; attempting to
  215. // access its element results in undefined behavior.
  216. constexpr const_iterator cend() const noexcept { return end(); }
  217. // string_view::rbegin()
  218. //
  219. // Returns a reverse iterator pointing to the last character at the end of the
  220. // `string_view`, or `rend()` if the `string_view` is empty.
  221. const_reverse_iterator rbegin() const noexcept {
  222. return const_reverse_iterator(end());
  223. }
  224. // string_view::rend()
  225. //
  226. // Returns a reverse iterator pointing just before the first character at the
  227. // beginning of the `string_view`. This pointer acts as a placeholder;
  228. // attempting to access its element results in undefined behavior.
  229. const_reverse_iterator rend() const noexcept {
  230. return const_reverse_iterator(begin());
  231. }
  232. // string_view::crbegin()
  233. //
  234. // Returns a const reverse iterator pointing to the last character at the end
  235. // of the `string_view`, or `crend()` if the `string_view` is empty.
  236. const_reverse_iterator crbegin() const noexcept { return rbegin(); }
  237. // string_view::crend()
  238. //
  239. // Returns a const reverse iterator pointing just before the first character
  240. // at the beginning of the `string_view`. This pointer acts as a placeholder;
  241. // attempting to access its element results in undefined behavior.
  242. const_reverse_iterator crend() const noexcept { return rend(); }
  243. // Capacity Utilities
  244. // string_view::size()
  245. //
  246. // Returns the number of characters in the `string_view`.
  247. constexpr size_type size() const noexcept { return length_; }
  248. // string_view::length()
  249. //
  250. // Returns the number of characters in the `string_view`. Alias for `size()`.
  251. constexpr size_type length() const noexcept { return size(); }
  252. // string_view::max_size()
  253. //
  254. // Returns the maximum number of characters the `string_view` can hold.
  255. constexpr size_type max_size() const noexcept { return kMaxSize; }
  256. // string_view::empty()
  257. //
  258. // Checks if the `string_view` is empty (refers to no characters).
  259. constexpr bool empty() const noexcept { return length_ == 0; }
  260. // string_view::operator[]
  261. //
  262. // Returns the ith element of the `string_view` using the array operator.
  263. // Note that this operator does not perform any bounds checking.
  264. constexpr const_reference operator[](size_type i) const {
  265. return ABSL_HARDENING_ASSERT(i < size()), ptr_[i];
  266. }
  267. // string_view::at()
  268. //
  269. // Returns the ith element of the `string_view`. Bounds checking is performed,
  270. // and an exception of type `std::out_of_range` will be thrown on invalid
  271. // access.
  272. constexpr const_reference at(size_type i) const {
  273. return ABSL_PREDICT_TRUE(i < size())
  274. ? ptr_[i]
  275. : ((void)base_internal::ThrowStdOutOfRange(
  276. "absl::string_view::at"),
  277. ptr_[i]);
  278. }
  279. // string_view::front()
  280. //
  281. // Returns the first element of a `string_view`.
  282. constexpr const_reference front() const {
  283. return ABSL_HARDENING_ASSERT(!empty()), ptr_[0];
  284. }
  285. // string_view::back()
  286. //
  287. // Returns the last element of a `string_view`.
  288. constexpr const_reference back() const {
  289. return ABSL_HARDENING_ASSERT(!empty()), ptr_[size() - 1];
  290. }
  291. // string_view::data()
  292. //
  293. // Returns a pointer to the underlying character array (which is of course
  294. // stored elsewhere). Note that `string_view::data()` may contain embedded nul
  295. // characters, but the returned buffer may or may not be NUL-terminated;
  296. // therefore, do not pass `data()` to a routine that expects a NUL-terminated
  297. // string.
  298. constexpr const_pointer data() const noexcept { return ptr_; }
  299. // Modifiers
  300. // string_view::remove_prefix()
  301. //
  302. // Removes the first `n` characters from the `string_view`. Note that the
  303. // underlying string is not changed, only the view.
  304. constexpr void remove_prefix(size_type n) {
  305. ABSL_HARDENING_ASSERT(n <= length_);
  306. ptr_ += n;
  307. length_ -= n;
  308. }
  309. // string_view::remove_suffix()
  310. //
  311. // Removes the last `n` characters from the `string_view`. Note that the
  312. // underlying string is not changed, only the view.
  313. constexpr void remove_suffix(size_type n) {
  314. ABSL_HARDENING_ASSERT(n <= length_);
  315. length_ -= n;
  316. }
  317. // string_view::swap()
  318. //
  319. // Swaps this `string_view` with another `string_view`.
  320. constexpr void swap(string_view& s) noexcept {
  321. auto t = *this;
  322. *this = s;
  323. s = t;
  324. }
  325. // Explicit conversion operators
  326. // Converts to `std::basic_string`.
  327. template <typename A>
  328. explicit operator std::basic_string<char, traits_type, A>() const {
  329. if (!data()) return {};
  330. return std::basic_string<char, traits_type, A>(data(), size());
  331. }
  332. // string_view::copy()
  333. //
  334. // Copies the contents of the `string_view` at offset `pos` and length `n`
  335. // into `buf`.
  336. size_type copy(char* buf, size_type n, size_type pos = 0) const {
  337. if (ABSL_PREDICT_FALSE(pos > length_)) {
  338. base_internal::ThrowStdOutOfRange("absl::string_view::copy");
  339. }
  340. size_type rlen = (std::min)(length_ - pos, n);
  341. if (rlen > 0) {
  342. const char* start = ptr_ + pos;
  343. traits_type::copy(buf, start, rlen);
  344. }
  345. return rlen;
  346. }
  347. // string_view::substr()
  348. //
  349. // Returns a "substring" of the `string_view` (at offset `pos` and length
  350. // `n`) as another string_view. This function throws `std::out_of_bounds` if
  351. // `pos > size`.
  352. // Use absl::ClippedSubstr if you need a truncating substr operation.
  353. constexpr string_view substr(size_type pos = 0, size_type n = npos) const {
  354. return ABSL_PREDICT_FALSE(pos > length_)
  355. ? (base_internal::ThrowStdOutOfRange(
  356. "absl::string_view::substr"),
  357. string_view())
  358. : string_view(ptr_ + pos, Min(n, length_ - pos));
  359. }
  360. // string_view::compare()
  361. //
  362. // Performs a lexicographical comparison between this `string_view` and
  363. // another `string_view` `x`, returning a negative value if `*this` is less
  364. // than `x`, 0 if `*this` is equal to `x`, and a positive value if `*this`
  365. // is greater than `x`.
  366. constexpr int compare(string_view x) const noexcept {
  367. return CompareImpl(length_, x.length_,
  368. Min(length_, x.length_) == 0
  369. ? 0
  370. : ABSL_INTERNAL_STRING_VIEW_MEMCMP(
  371. ptr_, x.ptr_, Min(length_, x.length_)));
  372. }
  373. // Overload of `string_view::compare()` for comparing a substring of the
  374. // 'string_view` and another `absl::string_view`.
  375. constexpr int compare(size_type pos1, size_type count1, string_view v) const {
  376. return substr(pos1, count1).compare(v);
  377. }
  378. // Overload of `string_view::compare()` for comparing a substring of the
  379. // `string_view` and a substring of another `absl::string_view`.
  380. constexpr int compare(size_type pos1, size_type count1, string_view v,
  381. size_type pos2, size_type count2) const {
  382. return substr(pos1, count1).compare(v.substr(pos2, count2));
  383. }
  384. // Overload of `string_view::compare()` for comparing a `string_view` and a
  385. // a different C-style string `s`.
  386. constexpr int compare(absl::Nonnull<const char*> s) const {
  387. return compare(string_view(s));
  388. }
  389. // Overload of `string_view::compare()` for comparing a substring of the
  390. // `string_view` and a different string C-style string `s`.
  391. constexpr int compare(size_type pos1, size_type count1,
  392. absl::Nonnull<const char*> s) const {
  393. return substr(pos1, count1).compare(string_view(s));
  394. }
  395. // Overload of `string_view::compare()` for comparing a substring of the
  396. // `string_view` and a substring of a different C-style string `s`.
  397. constexpr int compare(size_type pos1, size_type count1,
  398. absl::Nonnull<const char*> s, size_type count2) const {
  399. return substr(pos1, count1).compare(string_view(s, count2));
  400. }
  401. // Find Utilities
  402. // string_view::find()
  403. //
  404. // Finds the first occurrence of the substring `s` within the `string_view`,
  405. // returning the position of the first character's match, or `npos` if no
  406. // match was found.
  407. size_type find(string_view s, size_type pos = 0) const noexcept;
  408. // Overload of `string_view::find()` for finding the given character `c`
  409. // within the `string_view`.
  410. size_type find(char c, size_type pos = 0) const noexcept;
  411. // Overload of `string_view::find()` for finding a substring of a different
  412. // C-style string `s` within the `string_view`.
  413. size_type find(absl::Nonnull<const char*> s, size_type pos,
  414. size_type count) const {
  415. return find(string_view(s, count), pos);
  416. }
  417. // Overload of `string_view::find()` for finding a different C-style string
  418. // `s` within the `string_view`.
  419. size_type find(absl::Nonnull<const char *> s, size_type pos = 0) const {
  420. return find(string_view(s), pos);
  421. }
  422. // string_view::rfind()
  423. //
  424. // Finds the last occurrence of a substring `s` within the `string_view`,
  425. // returning the position of the first character's match, or `npos` if no
  426. // match was found.
  427. size_type rfind(string_view s, size_type pos = npos) const noexcept;
  428. // Overload of `string_view::rfind()` for finding the last given character `c`
  429. // within the `string_view`.
  430. size_type rfind(char c, size_type pos = npos) const noexcept;
  431. // Overload of `string_view::rfind()` for finding a substring of a different
  432. // C-style string `s` within the `string_view`.
  433. size_type rfind(absl::Nonnull<const char*> s, size_type pos,
  434. size_type count) const {
  435. return rfind(string_view(s, count), pos);
  436. }
  437. // Overload of `string_view::rfind()` for finding a different C-style string
  438. // `s` within the `string_view`.
  439. size_type rfind(absl::Nonnull<const char*> s, size_type pos = npos) const {
  440. return rfind(string_view(s), pos);
  441. }
  442. // string_view::find_first_of()
  443. //
  444. // Finds the first occurrence of any of the characters in `s` within the
  445. // `string_view`, returning the start position of the match, or `npos` if no
  446. // match was found.
  447. size_type find_first_of(string_view s, size_type pos = 0) const noexcept;
  448. // Overload of `string_view::find_first_of()` for finding a character `c`
  449. // within the `string_view`.
  450. size_type find_first_of(char c, size_type pos = 0) const noexcept {
  451. return find(c, pos);
  452. }
  453. // Overload of `string_view::find_first_of()` for finding a substring of a
  454. // different C-style string `s` within the `string_view`.
  455. size_type find_first_of(absl::Nonnull<const char*> s, size_type pos,
  456. size_type count) const {
  457. return find_first_of(string_view(s, count), pos);
  458. }
  459. // Overload of `string_view::find_first_of()` for finding a different C-style
  460. // string `s` within the `string_view`.
  461. size_type find_first_of(absl::Nonnull<const char*> s,
  462. size_type pos = 0) const {
  463. return find_first_of(string_view(s), pos);
  464. }
  465. // string_view::find_last_of()
  466. //
  467. // Finds the last occurrence of any of the characters in `s` within the
  468. // `string_view`, returning the start position of the match, or `npos` if no
  469. // match was found.
  470. size_type find_last_of(string_view s, size_type pos = npos) const noexcept;
  471. // Overload of `string_view::find_last_of()` for finding a character `c`
  472. // within the `string_view`.
  473. size_type find_last_of(char c, size_type pos = npos) const noexcept {
  474. return rfind(c, pos);
  475. }
  476. // Overload of `string_view::find_last_of()` for finding a substring of a
  477. // different C-style string `s` within the `string_view`.
  478. size_type find_last_of(absl::Nonnull<const char*> s, size_type pos,
  479. size_type count) const {
  480. return find_last_of(string_view(s, count), pos);
  481. }
  482. // Overload of `string_view::find_last_of()` for finding a different C-style
  483. // string `s` within the `string_view`.
  484. size_type find_last_of(absl::Nonnull<const char*> s,
  485. size_type pos = npos) const {
  486. return find_last_of(string_view(s), pos);
  487. }
  488. // string_view::find_first_not_of()
  489. //
  490. // Finds the first occurrence of any of the characters not in `s` within the
  491. // `string_view`, returning the start position of the first non-match, or
  492. // `npos` if no non-match was found.
  493. size_type find_first_not_of(string_view s, size_type pos = 0) const noexcept;
  494. // Overload of `string_view::find_first_not_of()` for finding a character
  495. // that is not `c` within the `string_view`.
  496. size_type find_first_not_of(char c, size_type pos = 0) const noexcept;
  497. // Overload of `string_view::find_first_not_of()` for finding a substring of a
  498. // different C-style string `s` within the `string_view`.
  499. size_type find_first_not_of(absl::Nonnull<const char*> s, size_type pos,
  500. size_type count) const {
  501. return find_first_not_of(string_view(s, count), pos);
  502. }
  503. // Overload of `string_view::find_first_not_of()` for finding a different
  504. // C-style string `s` within the `string_view`.
  505. size_type find_first_not_of(absl::Nonnull<const char*> s,
  506. size_type pos = 0) const {
  507. return find_first_not_of(string_view(s), pos);
  508. }
  509. // string_view::find_last_not_of()
  510. //
  511. // Finds the last occurrence of any of the characters not in `s` within the
  512. // `string_view`, returning the start position of the last non-match, or
  513. // `npos` if no non-match was found.
  514. size_type find_last_not_of(string_view s,
  515. size_type pos = npos) const noexcept;
  516. // Overload of `string_view::find_last_not_of()` for finding a character
  517. // that is not `c` within the `string_view`.
  518. size_type find_last_not_of(char c, size_type pos = npos) const noexcept;
  519. // Overload of `string_view::find_last_not_of()` for finding a substring of a
  520. // different C-style string `s` within the `string_view`.
  521. size_type find_last_not_of(absl::Nonnull<const char*> s, size_type pos,
  522. size_type count) const {
  523. return find_last_not_of(string_view(s, count), pos);
  524. }
  525. // Overload of `string_view::find_last_not_of()` for finding a different
  526. // C-style string `s` within the `string_view`.
  527. size_type find_last_not_of(absl::Nonnull<const char*> s,
  528. size_type pos = npos) const {
  529. return find_last_not_of(string_view(s), pos);
  530. }
  531. #if ABSL_INTERNAL_CPLUSPLUS_LANG >= 202002L
  532. // string_view::starts_with()
  533. //
  534. // Returns true if the `string_view` starts with the prefix `s`.
  535. //
  536. // This method only exists when targeting at least C++20.
  537. // If support for C++ prior to C++20 is required, use `absl::StartsWith()`
  538. // from `//absl/strings/match.h` for compatibility.
  539. constexpr bool starts_with(string_view s) const noexcept {
  540. return s.empty() ||
  541. (size() >= s.size() &&
  542. ABSL_INTERNAL_STRING_VIEW_MEMCMP(data(), s.data(), s.size()) == 0);
  543. }
  544. // Overload of `string_view::starts_with()` that returns true if `c` is the
  545. // first character of the `string_view`.
  546. constexpr bool starts_with(char c) const noexcept {
  547. return !empty() && front() == c;
  548. }
  549. // Overload of `string_view::starts_with()` that returns true if the
  550. // `string_view` starts with the C-style prefix `s`.
  551. constexpr bool starts_with(const char* s) const {
  552. return starts_with(string_view(s));
  553. }
  554. // string_view::ends_with()
  555. //
  556. // Returns true if the `string_view` ends with the suffix `s`.
  557. //
  558. // This method only exists when targeting at least C++20.
  559. // If support for C++ prior to C++20 is required, use `absl::EndsWith()`
  560. // from `//absl/strings/match.h` for compatibility.
  561. constexpr bool ends_with(string_view s) const noexcept {
  562. return s.empty() || (size() >= s.size() && ABSL_INTERNAL_STRING_VIEW_MEMCMP(
  563. data() + (size() - s.size()),
  564. s.data(), s.size()) == 0);
  565. }
  566. // Overload of `string_view::ends_with()` that returns true if `c` is the
  567. // last character of the `string_view`.
  568. constexpr bool ends_with(char c) const noexcept {
  569. return !empty() && back() == c;
  570. }
  571. // Overload of `string_view::ends_with()` that returns true if the
  572. // `string_view` ends with the C-style suffix `s`.
  573. constexpr bool ends_with(const char* s) const {
  574. return ends_with(string_view(s));
  575. }
  576. #endif // ABSL_INTERNAL_CPLUSPLUS_LANG >= 202002L
  577. private:
  578. // The constructor from std::string delegates to this constructor.
  579. // See the comment on that constructor for the rationale.
  580. struct SkipCheckLengthTag {};
  581. string_view(absl::Nullable<const char*> data, size_type len,
  582. SkipCheckLengthTag) noexcept
  583. : ptr_(data), length_(len) {}
  584. static constexpr size_type kMaxSize =
  585. (std::numeric_limits<difference_type>::max)();
  586. static constexpr size_type CheckLengthInternal(size_type len) {
  587. return ABSL_HARDENING_ASSERT(len <= kMaxSize), len;
  588. }
  589. static constexpr size_type StrlenInternal(absl::Nonnull<const char*> str) {
  590. #if defined(_MSC_VER) && !defined(__clang__)
  591. // MSVC 2017+ can evaluate this at compile-time.
  592. const char* begin = str;
  593. while (*str != '\0') ++str;
  594. return str - begin;
  595. #elif ABSL_HAVE_BUILTIN(__builtin_strlen) || \
  596. (defined(__GNUC__) && !defined(__clang__))
  597. // GCC has __builtin_strlen according to
  598. // https://gcc.gnu.org/onlinedocs/gcc-4.7.0/gcc/Other-Builtins.html, but
  599. // ABSL_HAVE_BUILTIN doesn't detect that, so we use the extra checks above.
  600. // __builtin_strlen is constexpr.
  601. return __builtin_strlen(str);
  602. #else
  603. return str ? strlen(str) : 0;
  604. #endif
  605. }
  606. static constexpr size_t Min(size_type length_a, size_type length_b) {
  607. return length_a < length_b ? length_a : length_b;
  608. }
  609. static constexpr int CompareImpl(size_type length_a, size_type length_b,
  610. int compare_result) {
  611. return compare_result == 0 ? static_cast<int>(length_a > length_b) -
  612. static_cast<int>(length_a < length_b)
  613. : (compare_result < 0 ? -1 : 1);
  614. }
  615. absl::Nullable<const char*> ptr_;
  616. size_type length_;
  617. };
  618. // This large function is defined inline so that in a fairly common case where
  619. // one of the arguments is a literal, the compiler can elide a lot of the
  620. // following comparisons.
  621. constexpr bool operator==(string_view x, string_view y) noexcept {
  622. return x.size() == y.size() &&
  623. (x.empty() ||
  624. ABSL_INTERNAL_STRING_VIEW_MEMCMP(x.data(), y.data(), x.size()) == 0);
  625. }
  626. constexpr bool operator!=(string_view x, string_view y) noexcept {
  627. return !(x == y);
  628. }
  629. constexpr bool operator<(string_view x, string_view y) noexcept {
  630. return x.compare(y) < 0;
  631. }
  632. constexpr bool operator>(string_view x, string_view y) noexcept {
  633. return y < x;
  634. }
  635. constexpr bool operator<=(string_view x, string_view y) noexcept {
  636. return !(y < x);
  637. }
  638. constexpr bool operator>=(string_view x, string_view y) noexcept {
  639. return !(x < y);
  640. }
  641. // IO Insertion Operator
  642. std::ostream& operator<<(std::ostream& o, string_view piece);
  643. ABSL_NAMESPACE_END
  644. } // namespace absl
  645. #undef ABSL_INTERNAL_STRING_VIEW_MEMCMP
  646. #endif // ABSL_USES_STD_STRING_VIEW
  647. namespace absl {
  648. ABSL_NAMESPACE_BEGIN
  649. // ClippedSubstr()
  650. //
  651. // Like `s.substr(pos, n)`, but clips `pos` to an upper bound of `s.size()`.
  652. // Provided because std::string_view::substr throws if `pos > size()`
  653. inline string_view ClippedSubstr(string_view s, size_t pos,
  654. size_t n = string_view::npos) {
  655. pos = (std::min)(pos, static_cast<size_t>(s.size()));
  656. return s.substr(pos, n);
  657. }
  658. // NullSafeStringView()
  659. //
  660. // Creates an `absl::string_view` from a pointer `p` even if it's null-valued.
  661. // This function should be used where an `absl::string_view` can be created from
  662. // a possibly-null pointer.
  663. constexpr string_view NullSafeStringView(absl::Nullable<const char*> p) {
  664. return p ? string_view(p) : string_view();
  665. }
  666. ABSL_NAMESPACE_END
  667. } // namespace absl
  668. #endif // ABSL_STRINGS_STRING_VIEW_H_