YiStringView.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2020. All rights reserved.
#ifndef _YI_STRING_VIEW_H_
#define _YI_STRING_VIEW_H_

#include "framework/YiPredef.h"
#include "utility/YiSmallVector.h"

#include <assert.h>
#include <memory>
#include <string>

class CYIString;

#if YI_FULLY_SUPPORTS_CPP14_CONSTEXPR
#    define YI_CONSTEXPR constexpr
#else
#    include <cstddef>
#    define YI_CONSTEXPR
#endif

class CYIStringView
{
public:
    class ConstIterator;
    typedef std::reverse_iterator<ConstIterator> ConstReverseIterator;

    class ConstIterator
    {
    public:
        friend class CYIStringView;
        friend class CYIString;

        typedef std::bidirectional_iterator_tag iterator_category;
        typedef char32_t value_type;
        typedef ptrdiff_t difference_type;
        typedef const char32_t *pointer;
        typedef char32_t reference;

        ConstIterator();
        ConstIterator(CYIStringView string, size_t charactersOffset);
        ConstIterator(const ConstIterator &other);
        ~ConstIterator();

        ConstIterator &operator=(const ConstIterator &other);

        value_type operator*() const;

        bool operator==(const ConstIterator &other) const;
        bool operator!=(const ConstIterator &other) const;

        ConstIterator &operator++();
        ConstIterator operator++(int);
        ConstIterator &operator--();
        ConstIterator operator--(int);

        const char *GetRawData() const;

        ConstReverseIterator Reverse() const;

    private:
        static const size_t YI_STRING_ITERATOR_SIZE = sizeof(char *) * 3;

        ConstIterator(CYIStringView string, const char *pPosition);

        char m_storage[YI_STRING_ITERATOR_SIZE];
    };

    typedef ConstIterator Iterator;
    typedef std::reverse_iterator<Iterator> ReverseIterator;

    enum class CaseMode
    {
        CaseSensitive,

        CaseInsensitiveASCII
    };

    static constexpr size_t NPos = std::numeric_limits<size_t>::max();

    YI_CONSTEXPR CYIStringView() noexcept;

    YI_CONSTEXPR CYIStringView(const CYIStringView &other) noexcept;

    YI_CONSTEXPR CYIStringView(const char *pUTF8) noexcept;

    YI_CONSTEXPR CYIStringView(const char *pUTF8, size_t sizeBytes) noexcept;

    CYIStringView(const ConstIterator &begin, const ConstIterator &end);

    CYIStringView(const std::string &other) noexcept;

#if __cplusplus >= 201703L

    YI_CONSTEXPR CYIStringView(const std::string_view &other) noexcept;
#endif

#if defined(__OBJC__) || defined(DOXY)

    CYIStringView(const NSString *pString);
#endif

    CYIStringView(const std::vector<char> &vector) noexcept;

    CYIStringView(const std::vector<uint8_t> &vector) noexcept;

    YI_CONSTEXPR CYIStringView &operator=(const CYIStringView &view) noexcept = default;

    YI_CONSTEXPR bool IsEmpty() const;

    YI_CONSTEXPR bool IsNotEmpty() const;

    YI_CONSTEXPR const char *GetRawData() const noexcept;

    YI_CONSTEXPR size_t GetSizeInBytes() const noexcept;

    size_t GetLength() const;

    YI_CONSTEXPR char ByteAt(size_t byteOffset) const noexcept;

    char32_t At(size_t pos) const;

    char32_t operator[](size_t pos) const;

    bool ContainsNonASCII() const;

    bool IsNumeric() const;

    ConstIterator begin() const;

    ConstIterator end() const;

    ConstReverseIterator rbegin() const;

    ConstReverseIterator rend() const;

    bool Contains(CYIStringView s, CaseMode caseSensitivity = CaseMode::CaseSensitive) const;

    bool StartsWith(CYIStringView s, CaseMode caseSensitivity = CaseMode::CaseSensitive) const;

    bool EndsWith(CYIStringView s, CaseMode caseSensitivity = CaseMode::CaseSensitive) const;

    int32_t Compare(CYIStringView other, CaseMode caseSensitivity = CaseMode::CaseSensitive) const noexcept;

    bool Equals(CYIStringView other, CaseMode caseSensitivity = CaseMode::CaseSensitive) const noexcept;

    bool EqualsCaseInsensitiveASCII(CYIStringView other) const noexcept;

    CYISmallVector<CYIStringView, 3> Split(CYIStringView delimiter, bool ignoreEmptySubstrings = true, size_t maximumParts = NPos) const;

    CYIStringView SubStr(size_t pos = 0, size_t len = NPos) const;

    CYIStringView SubStr(const ConstIterator &begin, const ConstIterator &end) const;

    CYIStringView Left(size_t len) const;

    CYIStringView Right(size_t len) const;

    CYIString ToUpperASCII() const;

    CYIString ToLowerASCII() const;

    size_t IndexOf(CYIStringView view, size_t pos = 0) const;

    size_t LastIndexOf(CYIStringView view, size_t pos = NPos) const;

    ConstIterator Find(CYIStringView view, const ConstIterator &begin) const;

    ConstReverseIterator ReverseFind(CYIStringView view, const ConstReverseIterator &begin) const;

    CYIString Arg(CYIStringView text) const;

    void Clear();

    void Swap(CYIStringView &view);

    void Trim();

    void TrimLeft(size_t len = NPos);

    void TrimRight(size_t len = NPos);

    void RemovePrefix(size_t len);

    bool RemovePrefix(CYIStringView prefix, CaseMode caseSensitivity = CaseMode::CaseSensitive);

    void RemoveSuffix(size_t len);

    bool RemoveSuffix(CYIStringView prefix, CaseMode caseSensitivity = CaseMode::CaseSensitive);

    std::unique_ptr<char[]> ToUTF8(size_t *pElementsCount = nullptr) const;

    std::unique_ptr<char16_t[]> ToUTF16(size_t *pElementsCount = nullptr) const;

    std::unique_ptr<char32_t[]> ToUTF32(size_t *pElementsCount = nullptr) const;

    std::unique_ptr<wchar_t[]> ToWideChars(size_t *pElementsCount = nullptr) const;

    CYIString ToCYIString() const;

    std::string ToStdString() const;

    std::wstring ToStdWString() const;

#if defined(__OBJC__) || defined(DOXY)

    NSString *ToNSString() const;

    CFStringRef ToCFStringRef() const;
#endif

    template<class T>
    T To(bool *pError = nullptr) const;

    template<class T>
    T ToValue(bool *pError = nullptr) const;

    float ToFloat(bool *pError = nullptr) const;

    double ToDouble(bool *pError = nullptr) const;

    bool ToBool(bool *pError = nullptr) const;

    CYIString ToHexadecimal() const;

private:
    size_t m_size;
    const char *m_pData;
};

// std::hash specialization for CYIStringView. Note that CYIStringView's and CYIString's that are equal do not hash to the same value.
namespace std
{
template<>
struct hash<CYIStringView>;
}

std::ostream &operator<<(std::ostream &stream, const CYIStringView &val);

YI_CONSTEXPR bool operator==(CYIStringView lhs, CYIStringView rhs) noexcept;
YI_CONSTEXPR bool operator!=(CYIStringView lhs, CYIStringView rhs) noexcept;

bool operator<(CYIStringView lhs, CYIStringView rhs) noexcept;
bool operator>(CYIStringView lhs, CYIStringView rhs) noexcept;
bool operator<=(CYIStringView lhs, CYIStringView rhs) noexcept;
bool operator>=(CYIStringView lhs, CYIStringView rhs) noexcept;

#include "utility/YiStringView.inl"

#undef YI_CONSTEXPR

#endif