SmallString.h

Go to the documentation of this file.

//===- llvm/ADT/SmallString.h - 'Normally small' strings --------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
///
/// \file
/// This file defines the SmallString class.
///
//===----------------------------------------------------------------------===//
 
#ifndef LLVM_ADT_SMALLSTRING_H
#define LLVM_ADT_SMALLSTRING_H
 
#include "llvm/ADT/SmallVector.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/Support/Compiler.h"
#include <cstddef>
 
namespace llvm {
 
/// SmallString - A SmallString is just a SmallVector with methods and accessors
/// that make it work better as a string (e.g. operator+ etc).
template <unsigned InternalLen>
class LLVM_ATTRIBUTE_WARN_UNUSED SmallString
    : public SmallVector<char, InternalLen> {
public:
  /// Default ctor - Initialize to empty.
  SmallString() = default;
 
  /// Initialize from a StringRef.
  SmallString(StringRef S) : SmallVector<char, InternalLen>(S.begin(), S.end()) {}
 
  /// Initialize by concatenating a list of StringRefs.
  SmallString(std::initializer_list<StringRef> Refs)
      : SmallVector<char, InternalLen>() {
    this->append(Refs);
  }
 
  /// Initialize with a range.
  template<typename ItTy>
  SmallString(ItTy S, ItTy E) : SmallVector<char, InternalLen>(S, E) {}
 
  /// @}
  /// @name String Assignment
  /// @{
 
  using SmallVector<char, InternalLen>::assign;
 
  /// Assign from a StringRef.
  void assign(StringRef RHS) {
    SmallVectorImpl<char>::assign(RHS.begin(), RHS.end());
  }
 
  /// Assign from a list of StringRefs.
  void assign(std::initializer_list<StringRef> Refs) {
    this->clear();
    append(Refs);
  }
 
  /// @}
  /// @name String Concatenation
  /// @{
 
  using SmallVector<char, InternalLen>::append;
 
  /// Append from a StringRef.
  void append(StringRef RHS) {
    SmallVectorImpl<char>::append(RHS.begin(), RHS.end());
  }
 
  /// Append from a list of StringRefs.
  void append(std::initializer_list<StringRef> Refs) {
    size_t CurrentSize = this->size();
    size_t SizeNeeded = CurrentSize;
    for (const StringRef &Ref : Refs)
      SizeNeeded += Ref.size();
    this->resize_for_overwrite(SizeNeeded);
    for (const StringRef &Ref : Refs) {
      std::copy(Ref.begin(), Ref.end(), this->begin() + CurrentSize);
      CurrentSize += Ref.size();
    }
    assert(CurrentSize == this->size());
  }
 
  /// @}
  /// @name String Comparison
  /// @{
 
  /// Check for string equality.  This is more efficient than compare() when
  /// the relative ordering of inequal strings isn't needed.
  [[nodiscard]] bool equals(StringRef RHS) const { return str() == RHS; }
 
  /// Check for string equality, ignoring case.
  [[nodiscard]] bool equals_insensitive(StringRef RHS) const {
    return str().equals_insensitive(RHS);
  }
 
  /// compare - Compare two strings; the result is negative, zero, or positive
  /// if this string is lexicographically less than, equal to, or greater than
  /// the \p RHS.
  [[nodiscard]] int compare(StringRef RHS) const { return str().compare(RHS); }
 
  /// compare_insensitive - Compare two strings, ignoring case.
  [[nodiscard]] int compare_insensitive(StringRef RHS) const {
    return str().compare_insensitive(RHS);
  }
 
  /// compare_numeric - Compare two strings, treating sequences of digits as
  /// numbers.
  [[nodiscard]] int compare_numeric(StringRef RHS) const {
    return str().compare_numeric(RHS);
  }
 
  /// @}
  /// @name String Predicates
  /// @{
 
  /// starts_with - Check if this string starts with the given \p Prefix.
  [[nodiscard]] bool starts_with(StringRef Prefix) const {
    return str().starts_with(Prefix);
  }
 
  /// starts_with - Check if this string starts with the given character \p C.
  [[nodiscard]] bool starts_with(char C) const { return str().starts_with(C); }
 
  /// ends_with - Check if this string ends with the given \p Suffix.
  [[nodiscard]] bool ends_with(StringRef Suffix) const {
    return str().ends_with(Suffix);
  }
 
  /// ends_with - Check if this string ends with the given character \p C.
  [[nodiscard]] bool ends_with(char C) const { return str().ends_with(C); }
 
  /// contains - Check if \p Other is a substring of this string.
  [[nodiscard]] bool contains(StringRef Other) const {
    return str().contains(Other);
  }
 
  /// contains - Check if this string contains the character \p C.
  [[nodiscard]] bool contains(char C) const { return str().contains(C); }
 
  /// @}
  /// @name String Searching
  /// @{
 
  /// find - Search for the first character \p C in the string.
  ///
  /// \return - The index of the first occurrence of \p C, or npos if not
  /// found.
  [[nodiscard]] size_t find(char C, size_t From = 0) const {
    return str().find(C, From);
  }
 
  /// Search for the first string \p Str in the string.
  ///
  /// \returns The index of the first occurrence of \p Str, or npos if not
  /// found.
  [[nodiscard]] size_t find(StringRef Str, size_t From = 0) const {
    return str().find(Str, From);
  }
 
  /// Search for the last character \p C in the string.
  ///
  /// \returns The index of the last occurrence of \p C, or npos if not
  /// found.
  [[nodiscard]] size_t rfind(char C, size_t From = StringRef::npos) const {
    return str().rfind(C, From);
  }
 
  /// Search for the last string \p Str in the string.
  ///
  /// \returns The index of the last occurrence of \p Str, or npos if not
  /// found.
  [[nodiscard]] size_t rfind(StringRef Str) const { return str().rfind(Str); }
 
  /// Find the first character in the string that is \p C, or npos if not
  /// found. Same as find.
  [[nodiscard]] size_t find_first_of(char C, size_t From = 0) const {
    return str().find_first_of(C, From);
  }
 
  /// Find the first character in the string that is in \p Chars, or npos if
  /// not found.
  ///
  /// Complexity: O(size() + Chars.size())
  [[nodiscard]] size_t find_first_of(StringRef Chars, size_t From = 0) const {
    return str().find_first_of(Chars, From);
  }
 
  /// Find the first character in the string that is not \p C or npos if not
  /// found.
  [[nodiscard]] size_t find_first_not_of(char C, size_t From = 0) const {
    return str().find_first_not_of(C, From);
  }
 
  /// Find the first character in the string that is not in the string
  /// \p Chars, or npos if not found.
  ///
  /// Complexity: O(size() + Chars.size())
  [[nodiscard]] size_t find_first_not_of(StringRef Chars,
                                         size_t From = 0) const {
    return str().find_first_not_of(Chars, From);
  }
 
  /// Find the last character in the string that is \p C, or npos if not
  /// found.
  [[nodiscard]] size_t find_last_of(char C,
                                    size_t From = StringRef::npos) const {
    return str().find_last_of(C, From);
  }
 
  /// Find the last character in the string that is in \p C, or npos if not
  /// found.
  ///
  /// Complexity: O(size() + Chars.size())
  [[nodiscard]] size_t find_last_of(StringRef Chars,
                                    size_t From = StringRef::npos) const {
    return str().find_last_of(Chars, From);
  }
 
  /// @}
  /// @name Helpful Algorithms
  /// @{
 
  /// Return the number of occurrences of \p C in the string.
  [[nodiscard]] size_t count(char C) const { return str().count(C); }
 
  /// Return the number of non-overlapped occurrences of \p Str in the
  /// string.
  [[nodiscard]] size_t count(StringRef Str) const { return str().count(Str); }
 
  /// @}
  /// @name Substring Operations
  /// @{
 
  /// Return a reference to the substring from [Start, Start + N).
  ///
  /// \param 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.
  ///
  /// \param N The number of characters to included in the substring. If \p N
  /// exceeds the number of characters remaining in the string, the string
  /// suffix (starting with \p Start) will be returned.
  [[nodiscard]] StringRef substr(size_t Start,
                                 size_t N = StringRef::npos) const {
    return str().substr(Start, N);
  }
 
  /// Return a reference to the substring from [Start, End).
  ///
  /// \param 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.
  ///
  /// \param End The index following the last character to include in the
  /// substring. If this is npos, or less than \p Start, or exceeds the
  /// number of characters remaining in the string, the string suffix
  /// (starting with \p Start) will be returned.
  [[nodiscard]] StringRef slice(size_t Start, size_t End) const {
    return str().slice(Start, End);
  }
 
  // Extra methods.
 
  /// Explicit conversion to StringRef.
  [[nodiscard]] StringRef str() const {
    return StringRef(this->data(), this->size());
  }
 
  // TODO: Make this const, if it's safe...
  const char* c_str() {
    this->push_back(0);
    this->pop_back();
    return this->data();
  }
 
  /// Implicit conversion to StringRef.
  operator StringRef() const { return str(); }
 
  explicit operator std::string() const {
    return std::string(this->data(), this->size());
  }
 
  // Extra operators.
  SmallString &operator=(StringRef RHS) {
    this->assign(RHS);
    return *this;
  }
 
  SmallString &operator+=(StringRef RHS) {
    this->append(RHS.begin(), RHS.end());
    return *this;
  }
  SmallString &operator+=(char C) {
    this->push_back(C);
    return *this;
  }
};
 
} // end namespace llvm
 
#endif // LLVM_ADT_SMALLSTRING_H