StringView.h

#pragma once
 
#ifndef PL_INCLUDING_BASICS_H
#  error "Please don't include StringView.h directly, but instead include Foundation/Basics.h"
#endif
 
#include <Foundation/Strings/StringUtils.h>
 
#include <Foundation/Strings/Implementation/StringIterator.h>
 
#include <type_traits>
 
#if PL_ENABLED(PL_INTEROP_STL_STRINGS)
#  include <string_view>
#endif
 
struct plThisIsAString
{
};
 
class plStringBuilder;
 
class PL_FOUNDATION_DLL plStringView : public plThisIsAString
{
public:
  PL_DECLARE_POD_TYPE();
 
  using iterator = plStringIterator;
  using const_iterator = plStringIterator;
  using reverse_iterator = plStringReverseIterator;
  using const_reverse_iterator = plStringReverseIterator;
 
  constexpr plStringView();
 
  plStringView(char* pStart);
 
  template <typename T>                                                                                           // T is always const char*
  constexpr plStringView(T pStart, typename std::enable_if<std::is_same<T, const char*>::value, int>::type* = 0); // [tested]
 
  template <typename T>
  constexpr PL_ALWAYS_INLINE plStringView(const T&& str, typename std::enable_if<std::is_same<T, const char*>::value == false && std::is_convertible<T, const char*>::value, int>::type* = 0); // [tested]
 
  constexpr plStringView(const char* pStart, const char* pEnd); // [tested]
 
  constexpr plStringView(const char* pStart, plUInt32 uiLength);
 
  template <size_t N>
  constexpr plStringView(const char (&str)[N]);
 
  template <size_t N>
  constexpr plStringView(char (&str)[N]);
 
  void operator++(); // [tested]
 
  void operator+=(plUInt32 d); // [tested]
 
  plUInt32 GetCharacter() const; // [tested]
 
  bool IsValid() const; // [tested]
 
  const char* GetData(plStringBuilder& ref_sTempStorage) const; // [tested]
 
  plUInt32 GetElementCount() const { return m_uiElementCount; } // [tested]
 
  void SetStartPosition(const char* szCurPos); // [tested]
 
  const char* GetStartPointer() const { return m_pStart; } // [tested]
 
  const char* GetEndPointer() const { return m_pStart + m_uiElementCount; } // [tested]
 
  bool IsEmpty() const; // [tested]
 
  bool IsEqual(plStringView sOther) const;
 
  bool IsEqual_NoCase(plStringView sOther) const;
 
  bool IsEqualN(plStringView sOther, plUInt32 uiCharsToCompare) const; // [tested]
 
  bool IsEqualN_NoCase(plStringView sOther, plUInt32 uiCharsToCompare) const; // [tested]
 
  plInt32 Compare(plStringView sOther) const; // [tested]
 
  plInt32 CompareN(plStringView sOther, plUInt32 uiCharsToCompare) const; // [tested]
 
  plInt32 Compare_NoCase(plStringView sOther) const; // [tested]
 
  plInt32 CompareN_NoCase(plStringView sOther, plUInt32 uiCharsToCompare) const; // [tested]
 
  bool StartsWith(plStringView sStartsWith) const; // [tested]
 
  bool StartsWith_NoCase(plStringView sStartsWith) const; // [tested]
 
  bool EndsWith(plStringView sEndsWith) const; // [tested]
 
  bool EndsWith_NoCase(plStringView sEndsWith) const; // [tested]
 
  const char* ComputeCharacterPosition(plUInt32 uiCharacterIndex) const;
 
  const char* FindSubString(plStringView sStringToFind, const char* szStartSearchAt = nullptr) const; // [tested]
 
  const char* FindSubString_NoCase(plStringView sStringToFind, const char* szStartSearchAt = nullptr) const; // [tested]
 
  const char* FindLastSubString(plStringView sStringToFind, const char* szStartSearchAt = nullptr) const; // [tested]
 
  const char* FindLastSubString_NoCase(plStringView sStringToFind, const char* szStartSearchAt = nullptr) const; // [tested]
 
  const char* FindWholeWord(const char* szSearchFor, plStringUtils::PL_CHARACTER_FILTER isDelimiterCB, const char* szStartSearchAt = nullptr) const; // [tested]
 
  const char* FindWholeWord_NoCase(const char* szSearchFor, plStringUtils::PL_CHARACTER_FILTER isDelimiterCB, const char* szStartSearchAt = nullptr) const; // [tested]
 
 
  void Shrink(plUInt32 uiShrinkCharsFront, plUInt32 uiShrinkCharsBack); // [tested]
 
  plStringView GetShrunk(plUInt32 uiShrinkCharsFront, plUInt32 uiShrinkCharsBack = 0) const; // [tested]
 
  plStringView GetSubString(plUInt32 uiFirstCharacter, plUInt32 uiNumCharacters) const; // [tested]
 
  void ChopAwayFirstCharacterUtf8(); // [tested]
 
  void ChopAwayFirstCharacterAscii(); // [tested]
 
  void Trim(const char* szTrimChars); // [tested]
 
  void Trim(const char* szTrimCharsStart, const char* szTrimCharsEnd); // [tested]
 
  bool TrimWordStart(plStringView sWord); // [tested]
 
  bool TrimWordEnd(plStringView sWord); // [tested]
 
  template <typename Container>
  void Split(bool bReturnEmptyStrings, Container& ref_output, const char* szSeparator1, const char* szSeparator2 = nullptr, const char* szSeparator3 = nullptr, const char* szSeparator4 = nullptr, const char* szSeparator5 = nullptr, const char* szSeparator6 = nullptr) const; // [tested]
 
  iterator GetIteratorFront() const;
 
  reverse_iterator GetIteratorBack() const;
 
  // ******* Path Functions ********
 
  bool HasAnyExtension() const; // [tested]
 
  bool HasExtension(plStringView sExtension) const; // [tested]
 
  plStringView GetFileExtension(bool bFullExtension = false) const; // [tested]
 
  plStringView GetFileName() const; // [tested]
 
  plStringView GetFileNameAndExtension() const; // [tested]
 
  plStringView GetFileDirectory() const; // [tested]
 
  bool IsAbsolutePath() const; // [tested]
 
  bool IsRelativePath() const; // [tested]
 
  bool IsRootedPath() const; // [tested]
 
  plStringView GetRootedPathRootName() const; // [tested]
 
#if PL_ENABLED(PL_INTEROP_STL_STRINGS)
  plStringView(const std::string_view& rhs);
 
  plStringView(const std::string& rhs);
 
  operator std::string_view() const;
 
  std::string_view GetAsStdView() const;
#endif
 
private:
  const char* m_pStart = nullptr;
  plUInt32 m_uiElementCount = 0;
};
 
constexpr plStringView operator"" _plsv(const char* pString, size_t uiLen);
 
PL_ALWAYS_INLINE typename plStringView::iterator begin(plStringView sContainer)
{
  return typename plStringView::iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), sContainer.GetStartPointer());
}
 
PL_ALWAYS_INLINE typename plStringView::const_iterator cbegin(plStringView sContainer)
{
  return typename plStringView::const_iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), sContainer.GetStartPointer());
}
 
PL_ALWAYS_INLINE typename plStringView::iterator end(plStringView sContainer)
{
  return typename plStringView::iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), sContainer.GetEndPointer());
}
 
PL_ALWAYS_INLINE typename plStringView::const_iterator cend(plStringView sContainer)
{
  return typename plStringView::const_iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), sContainer.GetEndPointer());
}
 
 
PL_ALWAYS_INLINE typename plStringView::reverse_iterator rbegin(plStringView sContainer)
{
  return typename plStringView::reverse_iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), sContainer.GetEndPointer());
}
 
PL_ALWAYS_INLINE typename plStringView::const_reverse_iterator crbegin(plStringView sContainer)
{
  return typename plStringView::const_reverse_iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), sContainer.GetEndPointer());
}
 
PL_ALWAYS_INLINE typename plStringView::reverse_iterator rend(plStringView sContainer)
{
  return typename plStringView::reverse_iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), nullptr);
}
 
PL_ALWAYS_INLINE typename plStringView::const_reverse_iterator crend(plStringView sContainer)
{
  return typename plStringView::const_reverse_iterator(sContainer.GetStartPointer(), sContainer.GetEndPointer(), nullptr);
}
 
#include <Foundation/Strings/Implementation/StringView_inl.h>