include/llvm/ADT/StringRef.h

   1 //===--- StringRef.h - Constant String Reference Wrapper --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file is distributed under the University of Illinois Open Source
   6 // License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9
  10 #ifndef LLVM_ADT_STRINGREF_H
  11 #define LLVM_ADT_STRINGREF_H
  12
  13 #include "llvm/Support/type_traits.h"
  14
  15 #include <cassert>
  16 #include <cstring>
  17 #include <limits>
  18 #include <string>
  19 #include <utility>
  20
  21 namespace llvm {
  22   template<typename T>
  23   class SmallVectorImpl;
  24   class APInt;
  25   class hash_code;
  26   class StringRef;
  27
  28   /// Helper functions for StringRef::getAsInteger.
  29   bool getAsUnsignedInteger(StringRef Str, unsigned Radix,
  30                             unsigned long long &Result);
  31
  32   bool getAsSignedInteger(StringRef Str, unsigned Radix, long long &Result);
  33
  34   /// StringRef - Represent a constant reference to a string, i.e. a character
  35   /// array and a length, which need not be null terminated.
  36   ///
  37   /// This class does not own the string data, it is expected to be used in
  38   /// situations where the character data resides in some other buffer, whose
  39   /// lifetime extends past that of the StringRef. For this reason, it is not in
  40   /// general safe to store a StringRef.
  41   class StringRef {
  42   public:
  43     typedef const char *iterator;
  44     typedef const char *const_iterator;
  45     static const size_t npos = ~size_t(0);
  46     typedef size_t size_type;
  47
  48   private:
  49     /// The start of the string, in an external buffer.
  50     const char *Data;
  51
  52     /// The length of the string.
  53     size_t Length;
  54
  55     // Workaround PR5482: nearly all gcc 4.x miscompile StringRef and std::min()
  56     // Changing the arg of min to be an integer, instead of a reference to an
  57     // integer works around this bug.
  58     static size_t min(size_t a, size_t b) { return a < b ? a : b; }
  59     static size_t max(size_t a, size_t b) { return a > b ? a : b; }
  60
  61     // Workaround memcmp issue with null pointers (undefined behavior)
  62     // by providing a specialized version
  63     static int compareMemory(const char *Lhs, const char *Rhs, size_t Length) {
  64       if (Length == 0) { return 0; }
  65       return ::memcmp(Lhs,Rhs,Length);
  66     }
  67
  68   public:
  69     /// @name Constructors
  70     /// @{
  71
  72     /// Construct an empty string ref.
  73     /*implicit*/ StringRef() : Data(0), Length(0) {}
  74
  75     /// Construct a string ref from a cstring.
  76     /*implicit*/ StringRef(const char *Str)
  77       : Data(Str) {
  78         assert(Str && "StringRef cannot be built from a NULL argument");
  79         Length = ::strlen(Str); // invoking strlen(NULL) is undefined behavior
  80       }
  81
  82     /// Construct a string ref from a pointer and length.
  83     /*implicit*/ StringRef(const char *data, size_t length)
  84       : Data(data), Length(length) {
  85         assert((data || length == 0) &&
  86         "StringRef cannot be built from a NULL argument with non-null length");
  87       }
  88
  89     /// Construct a string ref from an std::string.
  90     /*implicit*/ StringRef(const std::string &Str)
  91       : Data(Str.data()), Length(Str.length()) {}
  92
  93     /// @}
  94     /// @name Iterators
  95     /// @{
  96
  97     iterator begin() const { return Data; }
  98
  99     iterator end() const { return Data + Length; }
 100
 101     /// @}
 102     /// @name String Operations
 103     /// @{
 104
 105     /// data - Get a pointer to the start of the string (which may not be null
 106     /// terminated).
 107     const char *data() const { return Data; }
 108
 109     /// empty - Check if the string is empty.
 110     bool empty() const { return Length == 0; }
 111
 112     /// size - Get the string size.
 113     size_t size() const { return Length; }
 114
 115     /// front - Get the first character in the string.
 116     char front() const {
 117       assert(!empty());
 118       return Data[0];
 119     }
 120
 121     /// back - Get the last character in the string.
 122     char back() const {
 123       assert(!empty());
 124       return Data[Length-1];
 125     }
 126
 127     /// equals - Check for string equality, this is more efficient than
 128     /// compare() when the relative ordering of inequal strings isn't needed.
 129     bool equals(StringRef RHS) const {
 130       return (Length == RHS.Length &&
 131               compareMemory(Data, RHS.Data, RHS.Length) == 0);
 132     }
 133
 134     /// equals_lower - Check for string equality, ignoring case.
 135     bool equals_lower(StringRef RHS) const {
 136       return Length == RHS.Length && compare_lower(RHS) == 0;
 137     }
 138
 139     /// compare - Compare two strings; the result is -1, 0, or 1 if this string
 140     /// is lexicographically less than, equal to, or greater than the \arg RHS.
 141     int compare(StringRef RHS) const {
 142       // Check the prefix for a mismatch.
 143       if (int Res = compareMemory(Data, RHS.Data, min(Length, RHS.Length)))
 144         return Res < 0 ? -1 : 1;
 145
 146       // Otherwise the prefixes match, so we only need to check the lengths.
 147       if (Length == RHS.Length)
 148         return 0;
 149       return Length < RHS.Length ? -1 : 1;
 150     }
 151
 152     /// compare_lower - Compare two strings, ignoring case.
 153     int compare_lower(StringRef RHS) const;
 154
 155     /// compare_numeric - Compare two strings, treating sequences of digits as
 156     /// numbers.
 157     int compare_numeric(StringRef RHS) const;
 158
 159     /// \brief Determine the edit distance between this string and another
 160     /// string.
 161     ///
 162     /// \param Other the string to compare this string against.
 163     ///
 164     /// \param AllowReplacements whether to allow character
 165     /// replacements (change one character into another) as a single
 166     /// operation, rather than as two operations (an insertion and a
 167     /// removal).
 168     ///
 169     /// \param MaxEditDistance If non-zero, the maximum edit distance that
 170     /// this routine is allowed to compute. If the edit distance will exceed
 171     /// that maximum, returns \c MaxEditDistance+1.
 172     ///
 173     /// \returns the minimum number of character insertions, removals,
 174     /// or (if \p AllowReplacements is \c true) replacements needed to
 175     /// transform one of the given strings into the other. If zero,
 176     /// the strings are identical.
 177     unsigned edit_distance(StringRef Other, bool AllowReplacements = true,
 178                            unsigned MaxEditDistance = 0);
 179
 180     /// str - Get the contents as an std::string.
 181     std::string str() const {
 182       if (Data == 0) return std::string();
 183       return std::string(Data, Length);
 184     }
 185
 186     /// @}
 187     /// @name Operator Overloads
 188     /// @{
 189
 190     char operator[](size_t Index) const {
 191       assert(Index < Length && "Invalid index!");
 192       return Data[Index];
 193     }
 194
 195     /// @}
 196     /// @name Type Conversions
 197     /// @{
 198
 199     operator std::string() const {
 200       return str();
 201     }
 202
 203     /// @}
 204     /// @name String Predicates
 205     /// @{
 206
 207     /// startswith - Check if this string starts with the given \arg Prefix.
 208     bool startswith(StringRef Prefix) const {
 209       return Length >= Prefix.Length &&
 210              compareMemory(Data, Prefix.Data, Prefix.Length) == 0;
 211     }
 212
 213     /// endswith - Check if this string ends with the given \arg Suffix.
 214     bool endswith(StringRef Suffix) const {
 215       return Length >= Suffix.Length &&
 216         compareMemory(end() - Suffix.Length, Suffix.Data, Suffix.Length) == 0;
 217     }
 218
 219     /// @}
 220     /// @name String Searching
 221     /// @{
 222
 223     /// find - Search for the first character \arg C in the string.
 224     ///
 225     /// \return - The index of the first occurrence of \arg C, or npos if not
 226     /// found.
 227     size_t find(char C, size_t From = 0) const {
 228       for (size_t i = min(From, Length), e = Length; i != e; ++i)
 229         if (Data[i] == C)
 230           return i;
 231       return npos;
 232     }
 233
 234     /// find - Search for the first string \arg Str in the string.
 235     ///
 236     /// \return - The index of the first occurrence of \arg Str, or npos if not
 237     /// found.
 238     size_t find(StringRef Str, size_t From = 0) const;
 239
 240     /// rfind - Search for the last character \arg C in the string.
 241     ///
 242     /// \return - The index of the last occurrence of \arg C, or npos if not
 243     /// found.
 244     size_t rfind(char C, size_t From = npos) const {
 245       From = min(From, Length);
 246       size_t i = From;
 247       while (i != 0) {
 248         --i;
 249         if (Data[i] == C)
 250           return i;
 251       }
 252       return npos;
 253     }
 254
 255     /// rfind - Search for the last string \arg Str in the string.
 256     ///
 257     /// \return - The index of the last occurrence of \arg Str, or npos if not
 258     /// found.
 259     size_t rfind(StringRef Str) const;
 260
 261     /// find_first_of - Find the first character in the string that is \arg C,
 262     /// or npos if not found. Same as find.
 263     size_type find_first_of(char C, size_t From = 0) const {
 264       return find(C, From);
 265     }
 266
 267     /// find_first_of - Find the first character in the string that is in \arg
 268     /// Chars, or npos if not found.
 269     ///
 270     /// Note: O(size() + Chars.size())
 271     size_type find_first_of(StringRef Chars, size_t From = 0) const;
 272
 273     /// find_first_not_of - Find the first character in the string that is not
 274     /// \arg C or npos if not found.
 275     size_type find_first_not_of(char C, size_t From = 0) const;
 276
 277     /// find_first_not_of - Find the first character in the string that is not
 278     /// in the string \arg Chars, or npos if not found.
 279     ///
 280     /// Note: O(size() + Chars.size())
 281     size_type find_first_not_of(StringRef Chars, size_t From = 0) const;
 282
 283     /// find_last_of - Find the last character in the string that is \arg C, or
 284     /// npos if not found.
 285     size_type find_last_of(char C, size_t From = npos) const {
 286       return rfind(C, From);
 287     }
 288
 289     /// find_last_of - Find the last character in the string that is in \arg C,
 290     /// or npos if not found.
 291     ///
 292     /// Note: O(size() + Chars.size())
 293     size_type find_last_of(StringRef Chars, size_t From = npos) const;
 294
 295     /// @}
 296     /// @name Helpful Algorithms
 297     /// @{
 298
 299     /// count - Return the number of occurrences of \arg C in the string.
 300     size_t count(char C) const {
 301       size_t Count = 0;
 302       for (size_t i = 0, e = Length; i != e; ++i)
 303         if (Data[i] == C)
 304           ++Count;
 305       return Count;
 306     }
 307
 308     /// count - Return the number of non-overlapped occurrences of \arg Str in
 309     /// the string.
 310     size_t count(StringRef Str) const;
 311
 312     /// getAsInteger - Parse the current string as an integer of the specified
 313     /// radix.  If Radix is specified as zero, this does radix autosensing using
 314     /// extended C rules: 0 is octal, 0x is hex, 0b is binary.
 315     ///
 316     /// If the string is invalid or if only a subset of the string is valid,
 317     /// this returns true to signify the error.  The string is considered
 318     /// erroneous if empty or if it overflows T.
 319     ///
 320     template <typename T>
 321     typename enable_if_c<std::numeric_limits<T>::is_signed, bool>::type
 322     getAsInteger(unsigned Radix, T &Result) const {
 323       long long LLVal;
 324       if (getAsSignedInteger(*this, Radix, LLVal) ||
 325             static_cast<T>(LLVal) != LLVal)
 326         return true;
 327       Result = LLVal;
 328       return false;
 329     }
 330
 331     template <typename T>
 332     typename enable_if_c<!std::numeric_limits<T>::is_signed, bool>::type
 333     getAsInteger(unsigned Radix, T &Result) const {
 334       unsigned long long ULLVal;
 335       if (getAsUnsignedInteger(*this, Radix, ULLVal) ||
 336             static_cast<T>(ULLVal) != ULLVal)
 337         return true;
 338       Result = ULLVal;
 339       return false;
 340     }
 341
 342     /// getAsInteger - Parse the current string as an integer of the
 343     /// specified radix, or of an autosensed radix if the radix given
 344     /// is 0.  The current value in Result is discarded, and the
 345     /// storage is changed to be wide enough to store the parsed
 346     /// integer.
 347     ///
 348     /// Returns true if the string does not solely consist of a valid
 349     /// non-empty number in the appropriate base.
 350     ///
 351     /// APInt::fromString is superficially similar but assumes the
 352     /// string is well-formed in the given radix.
 353     bool getAsInteger(unsigned Radix, APInt &Result) const;
 354
 355     /// @}
 356     /// @name String Operations
 357     /// @{
 358
 359     // lower - Convert the given ASCII string to lowercase.
 360     std::string lower() const;
 361
 362     /// upper - Convert the given ASCII string to uppercase.
 363     std::string upper() const;
 364
 365     /// @}
 366     /// @name Substring Operations
 367     /// @{
 368
 369     /// substr - Return a reference to the substring from [Start, Start + N).
 370     ///
 371     /// \param Start - The index of the starting character in the substring; if
 372     /// the index is npos or greater than the length of the string then the
 373     /// empty substring will be returned.
 374     ///
 375     /// \param N - The number of characters to included in the substring. If N
 376     /// exceeds the number of characters remaining in the string, the string
 377     /// suffix (starting with \arg Start) will be returned.
 378     StringRef substr(size_t Start, size_t N = npos) const {
 379       Start = min(Start, Length);
 380       return StringRef(Data + Start, min(N, Length - Start));
 381     }
 382
 383     /// drop_front - Return a StringRef equal to 'this' but with the first
 384     /// elements dropped.
 385     StringRef drop_front(unsigned N = 1) const {
 386       assert(size() >= N && "Dropping more elements than exist");
 387       return substr(N);
 388     }
 389
 390     /// drop_back - Return a StringRef equal to 'this' but with the last
 391     /// elements dropped.
 392     StringRef drop_back(unsigned N = 1) const {
 393       assert(size() >= N && "Dropping more elements than exist");
 394       return substr(0, size()-N);
 395     }
 396
 397     /// slice - Return a reference to the substring from [Start, End).
 398     ///
 399     /// \param Start - The index of the starting character in the substring; if
 400     /// the index is npos or greater than the length of the string then the
 401     /// empty substring will be returned.
 402     ///
 403     /// \param End - The index following the last character to include in the
 404     /// substring. If this is npos, or less than \arg Start, or exceeds the
 405     /// number of characters remaining in the string, the string suffix
 406     /// (starting with \arg Start) will be returned.
 407     StringRef slice(size_t Start, size_t End) const {
 408       Start = min(Start, Length);
 409       End = min(max(Start, End), Length);
 410       return StringRef(Data + Start, End - Start);
 411     }
 412
 413     /// split - Split into two substrings around the first occurrence of a
 414     /// separator character.
 415     ///
 416     /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
 417     /// such that (*this == LHS + Separator + RHS) is true and RHS is
 418     /// maximal. If \arg Separator is not in the string, then the result is a
 419     /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
 420     ///
 421     /// \param Separator - The character to split on.
 422     /// \return - The split substrings.
 423     std::pair<StringRef, StringRef> split(char Separator) const {
 424       size_t Idx = find(Separator);
 425       if (Idx == npos)
 426         return std::make_pair(*this, StringRef());
 427       return std::make_pair(slice(0, Idx), slice(Idx+1, npos));
 428     }
 429
 430     /// split - Split into two substrings around the first occurrence of a
 431     /// separator string.
 432     ///
 433     /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
 434     /// such that (*this == LHS + Separator + RHS) is true and RHS is
 435     /// maximal. If \arg Separator is not in the string, then the result is a
 436     /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
 437     ///
 438     /// \param Separator - The string to split on.
 439     /// \return - The split substrings.
 440     std::pair<StringRef, StringRef> split(StringRef Separator) const {
 441       size_t Idx = find(Separator);
 442       if (Idx == npos)
 443         return std::make_pair(*this, StringRef());
 444       return std::make_pair(slice(0, Idx), slice(Idx + Separator.size(), npos));
 445     }
 446
 447     /// split - Split into substrings around the occurrences of a separator
 448     /// string.
 449     ///
 450     /// Each substring is stored in \arg A. If \arg MaxSplit is >= 0, at most
 451     /// \arg MaxSplit splits are done and consequently <= \arg MaxSplit
 452     /// elements are added to A.
 453     /// If \arg KeepEmpty is false, empty strings are not added to \arg A. They
 454     /// still count when considering \arg MaxSplit
 455     /// An useful invariant is that
 456     /// Separator.join(A) == *this if MaxSplit == -1 and KeepEmpty == true
 457     ///
 458     /// \param A - Where to put the substrings.
 459     /// \param Separator - The string to split on.
 460     /// \param MaxSplit - The maximum number of times the string is split.
 461     /// \param KeepEmpty - True if empty substring should be added.
 462     void split(SmallVectorImpl<StringRef> &A,
 463                StringRef Separator, int MaxSplit = -1,
 464                bool KeepEmpty = true) const;
 465
 466     /// rsplit - Split into two substrings around the last occurrence of a
 467     /// separator character.
 468     ///
 469     /// If \arg Separator is in the string, then the result is a pair (LHS, RHS)
 470     /// such that (*this == LHS + Separator + RHS) is true and RHS is
 471     /// minimal. If \arg Separator is not in the string, then the result is a
 472     /// pair (LHS, RHS) where (*this == LHS) and (RHS == "").
 473     ///
 474     /// \param Separator - The character to split on.
 475     /// \return - The split substrings.
 476     std::pair<StringRef, StringRef> rsplit(char Separator) const {
 477       size_t Idx = rfind(Separator);
 478       if (Idx == npos)
 479         return std::make_pair(*this, StringRef());
 480       return std::make_pair(slice(0, Idx), slice(Idx+1, npos));
 481     }
 482
 483     /// @}
 484   };
 485
 486   /// @name StringRef Comparison Operators
 487   /// @{
 488
 489   inline bool operator==(StringRef LHS, StringRef RHS) {
 490     return LHS.equals(RHS);
 491   }
 492
 493   inline bool operator!=(StringRef LHS, StringRef RHS) {
 494     return !(LHS == RHS);
 495   }
 496
 497   inline bool operator<(StringRef LHS, StringRef RHS) {
 498     return LHS.compare(RHS) == -1;
 499   }
 500
 501   inline bool operator<=(StringRef LHS, StringRef RHS) {
 502     return LHS.compare(RHS) != 1;
 503   }
 504
 505   inline bool operator>(StringRef LHS, StringRef RHS) {
 506     return LHS.compare(RHS) == 1;
 507   }
 508
 509   inline bool operator>=(StringRef LHS, StringRef RHS) {
 510     return LHS.compare(RHS) != -1;
 511   }
 512
 513   inline std::string &operator+=(std::string &buffer, llvm::StringRef string) {
 514     return buffer.append(string.data(), string.size());
 515   }
 516
 517   /// @}
 518
 519   /// \brief Compute a hash_code for a StringRef.
 520   hash_code hash_value(StringRef S);
 521
 522   // StringRefs can be treated like a POD type.
 523   template <typename T> struct isPodLike;
 524   template <> struct isPodLike<StringRef> { static const bool value = true; };
 525
 526 }
 527
 528 #endif