LLVM  14.0.0git
llvm::StringRef Class Reference

StringRef - Represent a constant reference to a string, i.e. More...

#include "llvm/ADT/StringRef.h"

Inheritance diagram for llvm::StringRef:
[legend]
Collaboration diagram for llvm::StringRef:
[legend]

## Public Types

using iterator = const char *

using const_iterator = const char *

using size_type = size_t

## Public Member Functions

Constructors
StringRef ()=default
Construct an empty string ref. More...

StringRef (std::nullptr_t)=delete
Disable conversion from nullptr. More...

constexpr StringRef (const char *Str)
Construct a string ref from a cstring. More...

constexpr StringRef (const char *data, size_t length)
Construct a string ref from a pointer and length. More...

StringRef (const std::string &Str)
Construct a string ref from an std::string. More...

Iterators
iterator begin () const

iterator end () const

const unsigned char * bytes_begin () const

const unsigned char * bytes_end () const

iterator_range< const unsigned char * > bytes () const

String Operations
const LLVM_NODISCARD char * data () const
data - Get a pointer to the start of the string (which may not be null terminated). More...

constexpr LLVM_NODISCARD bool empty () const
empty - Check if the string is empty. More...

constexpr LLVM_NODISCARD size_t size () const
size - Get the string size. More...

front - Get the first character in the string. More...

back - Get the last character in the string. More...

template<typename Allocator >
LLVM_NODISCARD StringRef copy (Allocator &A) const

LLVM_NODISCARD bool equals (StringRef RHS) const
equals - Check for string equality, this is more efficient than compare() when the relative ordering of inequal strings isn't needed. More...

LLVM_NODISCARD bool equals_insensitive (StringRef RHS) const
Check for string equality, ignoring case. More...

LLVM_NODISCARD int compare (StringRef RHS) const
compare - Compare two strings; the result is -1, 0, or 1 if this string is lexicographically less than, equal to, or greater than the RHS. More...

LLVM_NODISCARD int compare_insensitive (StringRef RHS) const
Compare two strings, ignoring case. More...

LLVM_NODISCARD int compare_numeric (StringRef RHS) const
compare_numeric - Compare two strings, treating sequences of digits as numbers. More...

LLVM_NODISCARD unsigned edit_distance (StringRef Other, bool AllowReplacements=true, unsigned MaxEditDistance=0) const
Determine the edit distance between this string and another string. More...

str - Get the contents as an std::string. More...

Convert the given ASCII string to uppercase. More...

LLVM_NODISCARD char operator[] (size_t Index) const

template<typename T >
std::enable_if_t< std::is_same< T, std::string >::value, StringRef > & operator= (T &&Str)=delete
Disallow accidental assignment from a temporary std::string. More...

Type Conversions
operator std::string () const

String Predicates
LLVM_NODISCARD bool startswith (StringRef Prefix) const
Check if this string starts with the given Prefix. More...

LLVM_NODISCARD bool startswith_insensitive (StringRef Prefix) const
Check if this string starts with the given Prefix, ignoring case. More...

LLVM_NODISCARD bool endswith (StringRef Suffix) const
Check if this string ends with the given Suffix. More...

LLVM_NODISCARD bool endswith_insensitive (StringRef Suffix) const
Check if this string ends with the given Suffix, ignoring case. More...

String Searching
LLVM_NODISCARD size_t find (char C, size_t From=0) const
Search for the first character C in the string. More...

LLVM_NODISCARD size_t find_insensitive (char C, size_t From=0) const
Search for the first character C in the string, ignoring case. More...

LLVM_NODISCARD size_t find_if (function_ref< bool(char)> F, size_t From=0) const
Search for the first character satisfying the predicate F. More...

LLVM_NODISCARD size_t find_if_not (function_ref< bool(char)> F, size_t From=0) const
Search for the first character not satisfying the predicate F. More...

LLVM_NODISCARD size_t find (StringRef Str, size_t From=0) const
Search for the first string Str in the string. More...

LLVM_NODISCARD size_t find_insensitive (StringRef Str, size_t From=0) const
Search for the first string Str in the string, ignoring case. More...

LLVM_NODISCARD size_t rfind (char C, size_t From=npos) const
Search for the last character C in the string. More...

LLVM_NODISCARD size_t rfind_insensitive (char C, size_t From=npos) const
Search for the last character C in the string, ignoring case. More...

LLVM_NODISCARD size_t rfind (StringRef Str) const
Search for the last string Str in the string. More...

LLVM_NODISCARD size_t rfind_insensitive (StringRef Str) const
Search for the last string Str in the string, ignoring case. More...

LLVM_NODISCARD size_t find_first_of (char C, size_t From=0) const
Find the first character in the string that is C, or npos if not found. More...

LLVM_NODISCARD size_t find_first_of (StringRef Chars, size_t From=0) const
Find the first character in the string that is in Chars, or npos if not found. More...

LLVM_NODISCARD size_t find_first_not_of (char C, size_t From=0) const
Find the first character in the string that is not C or npos if not found. More...

LLVM_NODISCARD size_t find_first_not_of (StringRef Chars, size_t From=0) const
Find the first character in the string that is not in the string Chars, or npos if not found. More...

LLVM_NODISCARD size_t find_last_of (char C, size_t From=npos) const
Find the last character in the string that is C, or npos if not found. More...

LLVM_NODISCARD size_t find_last_of (StringRef Chars, size_t From=npos) const
Find the last character in the string that is in C, or npos if not found. More...

LLVM_NODISCARD size_t find_last_not_of (char C, size_t From=npos) const
Find the last character in the string that is not C, or npos if not found. More...

LLVM_NODISCARD size_t find_last_not_of (StringRef Chars, size_t From=npos) const
Find the last character in the string that is not in Chars, or npos if not found. More...

LLVM_NODISCARD bool contains (StringRef Other) const
Return true if the given string is a substring of *this, and false otherwise. More...

LLVM_NODISCARD bool contains (char C) const
Return true if the given character is contained in *this, and false otherwise. More...

LLVM_NODISCARD bool contains_insensitive (StringRef Other) const
Return true if the given string is a substring of *this, and false otherwise. More...

LLVM_NODISCARD bool contains_insensitive (char C) const
Return true if the given character is contained in *this, and false otherwise. More...

LLVM_NODISCARD size_t count (char C) const
Return the number of occurrences of C in the string. More...

size_t count (StringRef Str) const
Return the number of non-overlapped occurrences of Str in the string. More...

template<typename T >
std::enable_if_t< std::numeric_limits< T >::is_signed, bool > getAsInteger (unsigned Radix, T &Result) const
Parse the current string as an integer of the specified radix. More...

template<typename T >
std::enable_if_t<!std::numeric_limits< T >::is_signed, bool > getAsInteger (unsigned Radix, T &Result) const

template<typename T >
std::enable_if_t< std::numeric_limits< T >::is_signed, bool > consumeInteger (unsigned Radix, T &Result)
Parse the current string as an integer of the specified radix. More...

template<typename T >
std::enable_if_t<!std::numeric_limits< T >::is_signed, bool > consumeInteger (unsigned Radix, T &Result)

bool getAsInteger (unsigned Radix, APInt &Result) const
Parse the current string as an integer of the specified Radix, or of an autosensed radix if the Radix given is 0. More...

bool getAsDouble (double &Result, bool AllowInexact=true) const
Parse the current string as an IEEE double-precision floating point value. More...

Substring Operations
LLVM_NODISCARD StringRef substr (size_t Start, size_t N=npos) const
Return a reference to the substring from [Start, Start + N). More...

LLVM_NODISCARD StringRef take_front (size_t N=1) const
Return a StringRef equal to 'this' but with only the first N elements remaining. More...

LLVM_NODISCARD StringRef take_back (size_t N=1) const
Return a StringRef equal to 'this' but with only the last N elements remaining. More...

LLVM_NODISCARD StringRef take_while (function_ref< bool(char)> F) const
Return the longest prefix of 'this' such that every character in the prefix satisfies the given predicate. More...

LLVM_NODISCARD StringRef take_until (function_ref< bool(char)> F) const
Return the longest prefix of 'this' such that no character in the prefix satisfies the given predicate. More...

LLVM_NODISCARD StringRef drop_front (size_t N=1) const
Return a StringRef equal to 'this' but with the first N elements dropped. More...

LLVM_NODISCARD StringRef drop_back (size_t N=1) const
Return a StringRef equal to 'this' but with the last N elements dropped. More...

LLVM_NODISCARD StringRef drop_while (function_ref< bool(char)> F) const
Return a StringRef equal to 'this', but with all characters satisfying the given predicate dropped from the beginning of the string. More...

LLVM_NODISCARD StringRef drop_until (function_ref< bool(char)> F) const
Return a StringRef equal to 'this', but with all characters not satisfying the given predicate dropped from the beginning of the string. More...

bool consume_front (StringRef Prefix)
Returns true if this StringRef has the given prefix and removes that prefix. More...

bool consume_front_insensitive (StringRef Prefix)
Returns true if this StringRef has the given prefix, ignoring case, and removes that prefix. More...

bool consume_back (StringRef Suffix)
Returns true if this StringRef has the given suffix and removes that suffix. More...

bool consume_back_insensitive (StringRef Suffix)
Returns true if this StringRef has the given suffix, ignoring case, and removes that suffix. More...

LLVM_NODISCARD StringRef slice (size_t Start, size_t End) const
Return a reference to the substring from [Start, End). More...

LLVM_NODISCARD std::pair< StringRef, StringRefsplit (char Separator) const
Split into two substrings around the first occurrence of a separator character. More...

LLVM_NODISCARD std::pair< StringRef, StringRefsplit (StringRef Separator) const
Split into two substrings around the first occurrence of a separator string. More...

LLVM_NODISCARD std::pair< StringRef, StringRefrsplit (StringRef Separator) const
Split into two substrings around the last occurrence of a separator string. More...

void split (SmallVectorImpl< StringRef > &A, StringRef Separator, int MaxSplit=-1, bool KeepEmpty=true) const
Split into substrings around the occurrences of a separator string. More...

void split (SmallVectorImpl< StringRef > &A, char Separator, int MaxSplit=-1, bool KeepEmpty=true) const
Split into substrings around the occurrences of a separator character. More...

LLVM_NODISCARD std::pair< StringRef, StringRefrsplit (char Separator) const
Split into two substrings around the last occurrence of a separator character. More...

LLVM_NODISCARD StringRef ltrim (char Char) const
Return string with consecutive Char characters starting from the the left removed. More...

LLVM_NODISCARD StringRef ltrim (StringRef Chars=" \t\n\v\f\r") const
Return string with consecutive characters in Chars starting from the left removed. More...

LLVM_NODISCARD StringRef rtrim (char Char) const
Return string with consecutive Char characters starting from the right removed. More...

LLVM_NODISCARD StringRef rtrim (StringRef Chars=" \t\n\v\f\r") const
Return string with consecutive characters in Chars starting from the right removed. More...

LLVM_NODISCARD StringRef trim (char Char) const
Return string with consecutive Char characters starting from the left and right removed. More...

LLVM_NODISCARD StringRef trim (StringRef Chars=" \t\n\v\f\r") const
Return string with consecutive characters in Chars starting from the left and right removed. More...

## Static Public Attributes

static constexpr size_t npos = ~size_t(0)

## Detailed Description

StringRef - Represent a constant reference to a string, i.e.

a character array and a length, which need not be null terminated.

This class does not own the string data, it is expected to be used in situations where the character data resides in some other buffer, whose lifetime extends past that of the StringRef. For this reason, it is not in general safe to store a StringRef.

Definition at line 57 of file StringRef.h.

## ◆ const_iterator

 using llvm::StringRef::const_iterator = const char *

Definition at line 62 of file StringRef.h.

## ◆ iterator

 using llvm::StringRef::iterator = const char *

Definition at line 61 of file StringRef.h.

## ◆ size_type

 using llvm::StringRef::size_type = size_t

Definition at line 63 of file StringRef.h.

## ◆ StringRef() [1/5]

 llvm::StringRef::StringRef ( )
default

Construct an empty string ref.

## ◆ StringRef() [2/5]

 llvm::StringRef::StringRef ( std::nullptr_t )
delete

Disable conversion from nullptr.

This prevents things like if (S == nullptr)

## ◆ StringRef() [3/5]

 constexpr llvm::StringRef::StringRef ( const char * Str )
inlineconstexpr

Construct a string ref from a cstring.

Definition at line 106 of file StringRef.h.

## ◆ StringRef() [4/5]

 constexpr llvm::StringRef::StringRef ( const char * data, size_t length )
inlineconstexpr

Construct a string ref from a pointer and length.

Definition at line 110 of file StringRef.h.

## ◆ StringRef() [5/5]

 llvm::StringRef::StringRef ( const std::string & Str )
inline

Construct a string ref from an std::string.

Definition at line 114 of file StringRef.h.

## ◆ back()

 LLVM_NODISCARD char llvm::StringRef::back ( ) const
inline

back - Get the last character in the string.

Definition at line 167 of file StringRef.h.

References assert(), llvm::Data, and llvm::empty().

## ◆ bytes()

 iterator_range llvm::StringRef::bytes ( ) const
inline

Definition at line 137 of file StringRef.h.

References llvm::make_range().

Referenced by llvm::djbHash().

## ◆ bytes_begin()

 const unsigned char* llvm::StringRef::bytes_begin ( ) const
inline

Definition at line 131 of file StringRef.h.

References llvm::sys::path::begin().

## ◆ bytes_end()

 const unsigned char* llvm::StringRef::bytes_end ( ) const
inline

Definition at line 134 of file StringRef.h.

References llvm::sys::path::end().

## ◆ compare()

 LLVM_NODISCARD int llvm::StringRef::compare ( StringRef RHS ) const
inline

compare - Compare two strings; the result is -1, 0, or 1 if this string is lexicographically less than, equal to, or greater than the RHS.

Definition at line 200 of file StringRef.h.

References llvm::Data, llvm::min(), and RHS.

## ◆ compare_insensitive()

 int StringRef::compare_insensitive ( StringRef RHS ) const

Compare two strings, ignoring case.

Definition at line 37 of file StringRef.cpp.

References ascii_strncasecmp(), llvm::min(), and RHS.

## ◆ compare_numeric()

 int StringRef::compare_numeric ( StringRef RHS ) const

compare_numeric - Compare two strings, treating sequences of digits as numbers.

compare_numeric - Compare strings, handle embedded numbers.

Definition at line 61 of file StringRef.cpp.

References E, I, isDigit(), llvm::min(), and RHS.

Referenced by llvm::SmallString< 256 >::compare_numeric(), and llvm::LessRecord::operator()().

## ◆ consume_back()

 bool llvm::StringRef::consume_back ( StringRef Suffix )
inline

Returns true if this StringRef has the given suffix and removes that suffix.

Definition at line 701 of file StringRef.h.

References size().

Referenced by llvm::VFABI::tryDemangleForVFABI().

## ◆ consume_back_insensitive()

 bool llvm::StringRef::consume_back_insensitive ( StringRef Suffix )
inline

Returns true if this StringRef has the given suffix, ignoring case, and removes that suffix.

Definition at line 711 of file StringRef.h.

References size().

## ◆ consume_front()

 bool llvm::StringRef::consume_front ( StringRef Prefix )
inline

Returns true if this StringRef has the given prefix and removes that prefix.

Definition at line 681 of file StringRef.h.

References llvm::cl::Prefix, and startswith().

## ◆ consume_front_insensitive()

 bool llvm::StringRef::consume_front_insensitive ( StringRef Prefix )
inline

Returns true if this StringRef has the given prefix, ignoring case, and removes that prefix.

Definition at line 691 of file StringRef.h.

References llvm::cl::Prefix.

## ◆ consumeInteger() [1/2]

template<typename T >
 std::enable_if_t::is_signed, bool> llvm::StringRef::consumeInteger ( unsigned Radix, T & Result )
inline

Parse the current string as an integer of the specified radix.

If Radix is specified as zero, this does radix autosensing using extended C rules: 0 is octal, 0x is hex, 0b is binary.

If the string does not begin with a number of the specified radix, this returns true to signify the error. The string is considered erroneous if empty or if it overflows T. The portion of the string representing the discovered numeric value is removed from the beginning of the string.

Definition at line 543 of file StringRef.h.

References llvm::consumeSignedInteger(), and T.

## ◆ consumeInteger() [2/2]

template<typename T >
 std::enable_if_t::is_signed, bool> llvm::StringRef::consumeInteger ( unsigned Radix, T & Result )
inline

Definition at line 554 of file StringRef.h.

References llvm::consumeUnsignedInteger(), and T.

## ◆ contains() [1/2]

 LLVM_NODISCARD bool llvm::StringRef::contains ( char C ) const
inline

Return true if the given character is contained in *this, and false otherwise.

Definition at line 466 of file StringRef.h.

## ◆ contains() [2/2]

 LLVM_NODISCARD bool llvm::StringRef::contains ( StringRef Other ) const
inline

Return true if the given string is a substring of *this, and false otherwise.

Definition at line 461 of file StringRef.h.

References llvm::find(), and Other.

## ◆ contains_insensitive() [1/2]

 LLVM_NODISCARD bool llvm::StringRef::contains_insensitive ( char C ) const
inline

Return true if the given character is contained in *this, and false otherwise.

Definition at line 478 of file StringRef.h.

## ◆ contains_insensitive() [2/2]

 LLVM_NODISCARD bool llvm::StringRef::contains_insensitive ( StringRef Other ) const
inline

Return true if the given string is a substring of *this, and false otherwise.

Definition at line 471 of file StringRef.h.

References Other.

## ◆ copy()

template<typename Allocator >
 LLVM_NODISCARD StringRef llvm::StringRef::copy ( Allocator & A ) const
inline

## ◆ count() [1/2]

 LLVM_NODISCARD size_t llvm::StringRef::count ( char C ) const
inline

Return the number of occurrences of C in the string.

Definition at line 488 of file StringRef.h.

References llvm::Data, llvm::numbers::e, and i.

## ◆ count() [2/2]

 size_t StringRef::count ( StringRef Str ) const

Return the number of non-overlapped occurrences of Str in the string.

count - Return the number of non-overlapped occurrences of

• Str in the string.

Definition at line 364 of file StringRef.cpp.

References llvm::numbers::e, equals(), i, N, and substr().

## ◆ drop_back()

 LLVM_NODISCARD StringRef llvm::StringRef::drop_back ( size_t N = 1 ) const
inline

Return a StringRef equal to 'this' but with the last N elements dropped.

Definition at line 660 of file StringRef.h.

References assert(), N, and llvm::size().

## ◆ drop_front()

 LLVM_NODISCARD StringRef llvm::StringRef::drop_front ( size_t N = 1 ) const
inline

## ◆ drop_until()

 LLVM_NODISCARD StringRef llvm::StringRef::drop_until ( function_ref< bool(char)> F ) const
inline

Return a StringRef equal to 'this', but with all characters not satisfying the given predicate dropped from the beginning of the string.

Definition at line 675 of file StringRef.h.

References F, and llvm::find_if().

## ◆ drop_while()

 LLVM_NODISCARD StringRef llvm::StringRef::drop_while ( function_ref< bool(char)> F ) const
inline

Return a StringRef equal to 'this', but with all characters satisfying the given predicate dropped from the beginning of the string.

Definition at line 668 of file StringRef.h.

References F, and llvm::find_if_not().

## ◆ edit_distance()

 unsigned StringRef::edit_distance ( llvm::StringRef Other, bool AllowReplacements = true, unsigned MaxEditDistance = 0 ) const

Determine the edit distance between this string and another string.

Parameters
 Other the string to compare this string against. AllowReplacements whether to allow character replacements (change one character into another) as a single operation, rather than as two operations (an insertion and a removal). MaxEditDistance If non-zero, the maximum edit distance that this routine is allowed to compute. If the edit distance will exceed that maximum, returns MaxEditDistance+1.
Returns
the minimum number of character insertions, removals, or (if AllowReplacements is true) replacements needed to transform one of the given strings into the other. If zero, the strings are identical.

Definition at line 92 of file StringRef.cpp.

References llvm::ComputeEditDistance(), data(), llvm::makeArrayRef(), Other, and size().

Referenced by llvm::opt::OptTable::findNearest(), and LookupNearestOption().

## ◆ endswith()

 LLVM_NODISCARD bool llvm::StringRef::endswith ( StringRef Suffix ) const
inline

Check if this string ends with the given Suffix.

Definition at line 296 of file StringRef.h.

References llvm::sys::path::end().

## ◆ endswith_insensitive()

 bool StringRef::endswith_insensitive ( StringRef Suffix ) const

Check if this string ends with the given Suffix, ignoring case.

Definition at line 50 of file StringRef.cpp.

References ascii_strncasecmp(), and end().

## ◆ equals()

 LLVM_NODISCARD bool llvm::StringRef::equals ( StringRef RHS ) const
inline

equals - Check for string equality, this is more efficient than compare() when the relative ordering of inequal strings isn't needed.

Definition at line 186 of file StringRef.h.

References llvm::Data, and RHS.

## ◆ equals_insensitive()

 LLVM_NODISCARD bool llvm::StringRef::equals_insensitive ( StringRef RHS ) const
inline

Check for string equality, ignoring case.

Definition at line 193 of file StringRef.h.

References RHS.

## ◆ find() [1/2]

 LLVM_NODISCARD size_t llvm::StringRef::find ( char C, size_t From = 0 ) const
inline

Search for the first character C in the string.

Returns
The index of the first occurrence of C, or npos if not found.

Definition at line 314 of file StringRef.h.

References llvm::Data, From, llvm::min(), and P.

## ◆ find() [2/2]

 size_t StringRef::find ( StringRef Str, size_t From = 0 ) const

Search for the first string Str in the string.

find - Search for the first string

Returns
The index of the first occurrence of Str, or npos if not found.
• Str in the string.
Returns
- The index of the first occurrence of

Definition at line 124 of file StringRef.cpp.

References From, and npos.

## ◆ find_first_not_of() [1/2]

 StringRef::size_type StringRef::find_first_not_of ( char C, size_t From = 0 ) const

Find the first character in the string that is not C or npos if not found.

find_first_not_of - Find the first character in the string that is not

Definition at line 241 of file StringRef.cpp.

References llvm::numbers::e, From, i, llvm::min(), and npos.

Referenced by llvm::SmallString< 256 >::find_first_not_of(), ParseLine(), and llvm::Regex::sub().

## ◆ find_first_not_of() [2/2]

 StringRef::size_type StringRef::find_first_not_of ( StringRef Chars, size_t From = 0 ) const

Find the first character in the string that is not in the string Chars, or npos if not found.

find_first_not_of - Find the first character in the string that is not in the string

Complexity: O(size() + Chars.size())

Note: O(size() + Chars.size())

Definition at line 252 of file StringRef.cpp.

References llvm::numbers::e, From, i, llvm::min(), and npos.

## ◆ find_first_of() [1/2]

 LLVM_NODISCARD size_t llvm::StringRef::find_first_of ( char C, size_t From = 0 ) const
inline

Find the first character in the string that is C, or npos if not found.

Same as find.

Definition at line 409 of file StringRef.h.

References llvm::find(), and From.

## ◆ find_first_of() [2/2]

 StringRef::size_type StringRef::find_first_of ( StringRef Chars, size_t From = 0 ) const

Find the first character in the string that is in Chars, or npos if not found.

find_first_of - Find the first character in the string that is in

Complexity: O(size() + Chars.size())

Note: O(size() + Chars.size())

Definition at line 227 of file StringRef.cpp.

References llvm::numbers::e, From, i, llvm::min(), and npos.

## ◆ find_if()

 LLVM_NODISCARD size_t llvm::StringRef::find_if ( function_ref< bool(char)> F, size_t From = 0 ) const
inline

Search for the first character satisfying the predicate F.

Returns
The index of the first character satisfying F starting from From, or npos if not found.

Definition at line 336 of file StringRef.h.

References F, From, S, and llvm::size().

Referenced by find_insensitive().

## ◆ find_if_not()

 LLVM_NODISCARD size_t llvm::StringRef::find_if_not ( function_ref< bool(char)> F, size_t From = 0 ) const
inline

Search for the first character not satisfying the predicate F.

Returns
The index of the first character not satisfying F starting from From, or npos if not found.

Definition at line 351 of file StringRef.h.

References c, F, llvm::find_if(), and From.

## ◆ find_insensitive() [1/2]

 size_t StringRef::find_insensitive ( char C, size_t From = 0 ) const

Search for the first character C in the string, ignoring case.

Returns
The index of the first occurrence of C, or npos if not found.

Definition at line 55 of file StringRef.cpp.

References D, find_if(), and From.

## ◆ find_insensitive() [2/2]

 size_t StringRef::find_insensitive ( StringRef Str, size_t From = 0 ) const

Search for the first string Str in the string, ignoring case.

Returns
The index of the first occurrence of Str, or npos if not found.

Definition at line 173 of file StringRef.cpp.

References From, npos, substr(), and This.

## ◆ find_last_not_of() [1/2]

 StringRef::size_type StringRef::find_last_not_of ( char C, size_t From = npos ) const

Find the last character in the string that is not C, or npos if not found.

find_last_not_of - Find the last character in the string that is not

Definition at line 282 of file StringRef.cpp.

References llvm::numbers::e, From, i, llvm::min(), and npos.

## ◆ find_last_not_of() [2/2]

 StringRef::size_type StringRef::find_last_not_of ( StringRef Chars, size_t From = npos ) const

Find the last character in the string that is not in Chars, or npos if not found.

find_last_not_of - Find the last character in the string that is not in

Complexity: O(size() + Chars.size())

Note: O(size() + Chars.size())

Definition at line 293 of file StringRef.cpp.

References llvm::numbers::e, From, i, llvm::min(), and npos.

## ◆ find_last_of() [1/2]

 LLVM_NODISCARD size_t llvm::StringRef::find_last_of ( char C, size_t From = npos ) const
inline

Find the last character in the string that is C, or npos if not found.

Definition at line 435 of file StringRef.h.

References From.

## ◆ find_last_of() [2/2]

 StringRef::size_type StringRef::find_last_of ( StringRef Chars, size_t From = npos ) const

Find the last character in the string that is in C, or npos if not found.

find_last_of - Find the last character in the string that is in

Complexity: O(size() + Chars.size())

Note: O(size() + Chars.size())

Definition at line 268 of file StringRef.cpp.

References llvm::numbers::e, From, i, llvm::min(), and npos.

## ◆ front()

 LLVM_NODISCARD char llvm::StringRef::front ( ) const
inline

front - Get the first character in the string.

Definition at line 160 of file StringRef.h.

References assert(), llvm::Data, and llvm::empty().

## ◆ getAsDouble()

 bool StringRef::getAsDouble ( double & Result, bool AllowInexact = true ) const

Parse the current string as an IEEE double-precision floating point value.

The string must be a well-formed double.

If AllowInexact is false, the function will fail if the string cannot be represented exactly. Otherwise, the function only fails in case of an overflow or underflow, or an invalid floating point representation.

Definition at line 580 of file StringRef.cpp.

## ◆ getAsInteger() [1/3]

 bool StringRef::getAsInteger ( unsigned Radix, APInt & Result ) const

Parse the current string as an integer of the specified Radix, or of an autosensed radix if the Radix given is 0.

The current value in Result is discarded, and the storage is changed to be wide enough to store the parsed integer.

Returns
true if the string does not solely consist of a valid non-empty number in the appropriate base.

APInt::fromString is superficially similar but assumes the string is well-formed in the given radix.

Definition at line 505 of file StringRef.cpp.

## ◆ getAsInteger() [2/3]

template<typename T >
 std::enable_if_t::is_signed, bool> llvm::StringRef::getAsInteger ( unsigned Radix, T & Result ) const
inline

Parse the current string as an integer of the specified radix.

If Radix is specified as zero, this does radix autosensing using extended C rules: 0 is octal, 0x is hex, 0b is binary.

If the string is invalid or if only a subset of the string is valid, this returns true to signify the error. The string is considered erroneous if empty or if it overflows T.

Definition at line 509 of file StringRef.h.

References llvm::getAsSignedInteger(), and T.

## ◆ getAsInteger() [3/3]

template<typename T >
 std::enable_if_t::is_signed, bool> llvm::StringRef::getAsInteger ( unsigned Radix, T & Result ) const
inline

Definition at line 520 of file StringRef.h.

References llvm::getAsUnsignedInteger(), and T.

## ◆ ltrim() [1/2]

 LLVM_NODISCARD StringRef llvm::StringRef::ltrim ( char Char ) const
inline

Return string with consecutive Char characters starting from the the left removed.

Definition at line 841 of file StringRef.h.

References llvm::min().

## ◆ ltrim() [2/2]

 LLVM_NODISCARD StringRef llvm::StringRef::ltrim ( StringRef Chars = " \t\n\v\f\r" ) const
inline

Return string with consecutive characters in Chars starting from the left removed.

Definition at line 848 of file StringRef.h.

References llvm::min().

## ◆ operator std::string()

 llvm::StringRef::operator std::string ( ) const
inlineexplicit

Definition at line 271 of file StringRef.h.

## ◆ operator=()

template<typename T >
 std::enable_if_t::value, StringRef>& llvm::StringRef::operator= ( T && Str )
delete

Disallow accidental assignment from a temporary std::string.

The declaration here is extra complicated so that stringRef = {} and stringRef = "abc" continue to select the move assignment operator.

## ◆ operator[]()

 LLVM_NODISCARD char llvm::StringRef::operator[] ( size_t Index ) const
inline

Definition at line 254 of file StringRef.h.

References assert(), llvm::Data, and Index.

## ◆ rfind() [1/2]

 LLVM_NODISCARD size_t llvm::StringRef::rfind ( char C, size_t From = npos ) const
inline

Search for the last character C in the string.

Returns
The index of the last occurrence of C, or npos if not found.

Definition at line 374 of file StringRef.h.

References llvm::Data, From, i, and llvm::min().

## ◆ rfind() [2/2]

 size_t StringRef::rfind ( StringRef Str ) const

Search for the last string Str in the string.

rfind - Search for the last string

Returns
The index of the last occurrence of Str, or npos if not found.
• Str in the string.
Returns
- The index of the last occurrence of

Definition at line 199 of file StringRef.cpp.

References llvm::numbers::e, equals(), i, N, npos, and substr().

## ◆ rfind_insensitive() [1/2]

 size_t StringRef::rfind_insensitive ( char C, size_t From = npos ) const

Search for the last character C in the string, ignoring case.

Returns
The index of the last occurrence of C, or npos if not found.

Definition at line 184 of file StringRef.cpp.

References From, i, llvm::min(), and npos.

## ◆ rfind_insensitive() [2/2]

 size_t StringRef::rfind_insensitive ( StringRef Str ) const

Search for the last string Str in the string, ignoring case.

Returns
The index of the last occurrence of Str, or npos if not found.

Definition at line 211 of file StringRef.cpp.

References llvm::numbers::e, equals_insensitive(), i, N, npos, and substr().

## ◆ rsplit() [1/2]

 LLVM_NODISCARD std::pair llvm::StringRef::rsplit ( char Separator ) const
inline

Split into two substrings around the last occurrence of a separator character.

If Separator is in the string, then the result is a pair (LHS, RHS) such that (*this == LHS + Separator + RHS) is true and RHS is minimal. If Separator is not in the string, then the result is a pair (LHS, RHS) where (*this == LHS) and (RHS == "").

Parameters
 Separator - The character to split on.
Returns
- The split substrings.

Definition at line 834 of file StringRef.h.

## ◆ rsplit() [2/2]

 LLVM_NODISCARD std::pair llvm::StringRef::rsplit ( StringRef Separator ) const
inline

Split into two substrings around the last occurrence of a separator string.

If Separator is in the string, then the result is a pair (LHS, RHS) such that (*this == LHS + Separator + RHS) is true and RHS is minimal. If Separator is not in the string, then the result is a pair (LHS, RHS) where (*this == LHS) and (RHS == "").

Parameters
 Separator - The string to split on.
Returns
- The split substrings.

Definition at line 781 of file StringRef.h.

References size().

## ◆ rtrim() [1/2]

 LLVM_NODISCARD StringRef llvm::StringRef::rtrim ( char Char ) const
inline

Return string with consecutive Char characters starting from the right removed.

Definition at line 855 of file StringRef.h.

References llvm::min().

## ◆ rtrim() [2/2]

 LLVM_NODISCARD StringRef llvm::StringRef::rtrim ( StringRef Chars = " \t\n\v\f\r" ) const
inline

Return string with consecutive characters in Chars starting from the right removed.

Definition at line 862 of file StringRef.h.

References llvm::min().

## ◆ slice()

 LLVM_NODISCARD StringRef llvm::StringRef::slice ( size_t Start, size_t End ) const
inline

Return a reference to the substring from [Start, End).

Parameters
 Start The index of the starting character in the substring; if the index is npos or greater than the length of the string then the empty substring will be returned. End The index following the last character to include in the substring. If this is npos or exceeds the number of characters remaining in the string, the string suffix (starting with Start) will be returned. If this is less than Start, an empty string will be returned.

Definition at line 731 of file StringRef.h.

## ◆ split() [1/4]

 LLVM_NODISCARD std::pair llvm::StringRef::split ( char Separator ) const
inline

Split into two substrings around the first occurrence of a separator character.

If Separator is in the string, then the result is a pair (LHS, RHS) such that (*this == LHS + Separator + RHS) is true and RHS is maximal. If Separator is not in the string, then the result is a pair (LHS, RHS) where (*this == LHS) and (RHS == "").

Parameters
 Separator The character to split on.
Returns
The split substrings.

Definition at line 748 of file StringRef.h.

References split.

## ◆ split() [2/4]

 void StringRef::split ( SmallVectorImpl< StringRef > & A, char Separator, int MaxSplit = -1, bool KeepEmpty = true ) const

Split into substrings around the occurrences of a separator character.

Each substring is stored in A. If MaxSplit is >= 0, at most MaxSplit splits are done and consequently <= MaxSplit + 1 elements are added to A. If KeepEmpty is false, empty strings are not added to A. They still count when considering MaxSplit An useful invariant is that Separator.join(A) == *this if MaxSplit == -1 and KeepEmpty == true

Parameters
 A - Where to put the substrings. Separator - The string to split on. MaxSplit - The maximum number of times the string is split. KeepEmpty - True if empty substring should be added.

Definition at line 332 of file StringRef.cpp.

References npos, and S.

## ◆ split() [3/4]

 void StringRef::split ( SmallVectorImpl< StringRef > & A, StringRef Separator, int MaxSplit = -1, bool KeepEmpty = true ) const

Split into substrings around the occurrences of a separator string.

Each substring is stored in A. If MaxSplit is >= 0, at most MaxSplit splits are done and consequently <= MaxSplit + 1 elements are added to A. If KeepEmpty is false, empty strings are not added to A. They still count when considering MaxSplit An useful invariant is that Separator.join(A) == *this if MaxSplit == -1 and KeepEmpty == true

Parameters
 A - Where to put the substrings. Separator - The string to split on. MaxSplit - The maximum number of times the string is split. KeepEmpty - True if empty substring should be added.

Definition at line 305 of file StringRef.cpp.

References npos, S, and size().

## ◆ split() [4/4]

 LLVM_NODISCARD std::pair llvm::StringRef::split ( StringRef Separator ) const
inline

Split into two substrings around the first occurrence of a separator string.

If Separator is in the string, then the result is a pair (LHS, RHS) such that (*this == LHS + Separator + RHS) is true and RHS is maximal. If Separator is not in the string, then the result is a pair (LHS, RHS) where (*this == LHS) and (RHS == "").

Parameters
 Separator - The string to split on.
Returns
- The split substrings.

Definition at line 763 of file StringRef.h.

References llvm::find(), and size().

## ◆ startswith_insensitive()

 bool StringRef::startswith_insensitive ( StringRef Prefix ) const

Check if this string starts with the given Prefix, ignoring case.

Definition at line 45 of file StringRef.cpp.

References ascii_strncasecmp(), and llvm::cl::Prefix.

Referenced by matchOption().

## ◆ substr()

 LLVM_NODISCARD StringRef llvm::StringRef::substr ( size_t Start, size_t N = npos ) const
inline

Return a reference to the substring from [Start, Start + N).

Parameters
 Start The index of the starting character in the substring; if the index is npos or greater than the length of the string then the empty substring will be returned. N The number of characters to included in the substring. If N exceeds the number of characters remaining in the string, the string suffix (starting with Start) will be returned.

Definition at line 610 of file StringRef.h.

## ◆ take_back()

 LLVM_NODISCARD StringRef llvm::StringRef::take_back ( size_t N = 1 ) const
inline

Return a StringRef equal to 'this' but with only the last N elements remaining.

If N is greater than the length of the string, the entire string is returned.

Definition at line 629 of file StringRef.h.

References N, and llvm::size().

## ◆ take_front()

 LLVM_NODISCARD StringRef llvm::StringRef::take_front ( size_t N = 1 ) const
inline

Return a StringRef equal to 'this' but with only the first N elements remaining.

If N is greater than the length of the string, the entire string is returned.

Definition at line 619 of file StringRef.h.

References N, and llvm::size().

## ◆ take_until()

 LLVM_NODISCARD StringRef llvm::StringRef::take_until ( function_ref< bool(char)> F ) const
inline

Return the longest prefix of 'this' such that no character in the prefix satisfies the given predicate.

Definition at line 645 of file StringRef.h.

References F, and llvm::find_if().

## ◆ take_while()

 LLVM_NODISCARD StringRef llvm::StringRef::take_while ( function_ref< bool(char)> F ) const
inline

Return the longest prefix of 'this' such that every character in the prefix satisfies the given predicate.

Definition at line 638 of file StringRef.h.

References F, and llvm::find_if_not().

## ◆ trim() [1/2]

 LLVM_NODISCARD StringRef llvm::StringRef::trim ( char Char ) const
inline

Return string with consecutive Char characters starting from the left and right removed.

Definition at line 869 of file StringRef.h.

References rtrim().

## ◆ trim() [2/2]

 LLVM_NODISCARD StringRef llvm::StringRef::trim ( StringRef Chars = " \t\n\v\f\r" ) const
inline

Return string with consecutive characters in Chars starting from the left and right removed.

Definition at line 876 of file StringRef.h.

References rtrim().

## ◆ upper()

 std::string StringRef::upper ( ) const

Convert the given ASCII string to uppercase.

Definition at line 110 of file StringRef.cpp.

References begin(), end(), and llvm::map_iterator().

Referenced by isCaseSensitivePath().

## ◆ npos

The documentation for this class was generated from the following files: