StringBase.h

#pragma once
 
#include <Foundation/Strings/StringView.h>
 
namespace plInternal
{
  template <typename T, bool isString>
  struct HashHelperImpl;
}
 
template <typename Derived>
struct plStringBase : public plThisIsAString
{
public:
  using iterator = plStringIterator;
  using const_iterator = plStringIterator;
  using reverse_iterator = plStringReverseIterator;
  using const_reverse_iterator = plStringReverseIterator;
 
  bool IsEmpty() 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* 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]
 
  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 IsEqual(plStringView sOther) const; // [tested]
 
  bool IsEqualN(plStringView sOther, plUInt32 uiCharsToCompare) const; // [tested]
 
  bool IsEqual_NoCase(plStringView sOther) const; // [tested]
 
  bool IsEqualN_NoCase(plStringView sOther, plUInt32 uiCharsToCompare) const; // [tested]
 
  const char* ComputeCharacterPosition(plUInt32 uiCharacterIndex) const;
 
  iterator GetIteratorFront() const;
 
  reverse_iterator GetIteratorBack() const;
 
  operator plStringView() const; // [tested]
 
  plStringView GetView() const; // [tested]
 
  PL_ALWAYS_INLINE operator const char*() const { return InternalGetData(); }
 
  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]
 
  bool HasAnyExtension() const; // [tested]
 
  bool HasExtension(plStringView sExtension) const; // [tested]
 
  plStringView GetFileExtension() 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)
  PL_ALWAYS_INLINE std::string_view GetAsStdView() const
  {
    return std::string_view(InternalGetData(), static_cast<size_t>(InternalGetElementCount()));
  }
  PL_ALWAYS_INLINE std::string GetAsStdString() const
  {
    return std::string(GetAsStdView());
  }
 
  PL_ALWAYS_INLINE operator std::string_view() const
  {
    return GetAsStdView();
  }
 
  PL_ALWAYS_INLINE operator std::string() const
  {
    return std::string(GetAsStdView());
  }
#endif
 
private:
  const char* InternalGetData() const;
  const char* InternalGetDataEnd() const;
  plUInt32 InternalGetElementCount() const;
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::iterator begin(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::const_iterator cbegin(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::iterator end(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::const_iterator cend(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::reverse_iterator rbegin(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::const_reverse_iterator crbegin(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::reverse_iterator rend(const plStringBase<Derived2>& container);
 
  template <typename Derived2>
  friend typename plStringBase<Derived2>::const_reverse_iterator crend(const plStringBase<Derived2>& container);
};
 
 
template <typename Derived>
typename plStringBase<Derived>::iterator begin(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::iterator(container.InternalGetData(), container.InternalGetDataEnd(), container.InternalGetData());
}
 
template <typename Derived>
typename plStringBase<Derived>::const_iterator cbegin(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::const_iterator(container.InternalGetData(), container.InternalGetDataEnd(), container.InternalGetData());
}
 
template <typename Derived>
typename plStringBase<Derived>::iterator end(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::iterator(container.InternalGetData(), container.InternalGetDataEnd(), container.InternalGetDataEnd());
}
 
template <typename Derived>
typename plStringBase<Derived>::const_iterator cend(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::const_iterator(container.InternalGetData(), container.InternalGetDataEnd(), container.InternalGetDataEnd());
}
 
 
template <typename Derived>
typename plStringBase<Derived>::reverse_iterator rbegin(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::reverse_iterator(container.InternalGetData(), container.InternalGetDataEnd(), container.InternalGetDataEnd());
}
 
template <typename Derived>
typename plStringBase<Derived>::const_reverse_iterator crbegin(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::const_reverse_iterator(container.InternalGetData(), container.InternalGetDataEnd(), container.InternalGetDataEnd());
}
 
template <typename Derived>
typename plStringBase<Derived>::reverse_iterator rend(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::reverse_iterator(container.InternalGetData(), container.InternalGetDataEnd(), nullptr);
}
 
template <typename Derived>
typename plStringBase<Derived>::const_reverse_iterator crend(const plStringBase<Derived>& container)
{
  return typename plStringBase<Derived>::const_reverse_iterator(container.InternalGetData(), container.InternalGetDataEnd(), nullptr);
}
 
#include <Foundation/Strings/Implementation/StringBase_inl.h>