YiString.h

Go to the documentation of this file.

// © You i Labs Inc. 2000-2017. All rights reserved.
#ifndef _YI_STRING_H_
#define _YI_STRING_H_

#include "framework/YiPredef.h"

#include <limits>
#include <memory>
#include <ostream>

#include <unicode/unistr.h>

#if defined(__OBJC__)
@class NSString;
#endif

class CYIString
{
    class ConstIteratorPriv;

public:

    static const CYIString EMPTY_STRING;
    
    class ConstIterator;
    typedef std::reverse_iterator<ConstIterator> ConstReverseIterator;

    class ConstIterator
    {
    public:
        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(const CYIString &string, uint32_t uCharactersOffset);
        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 *GetData() const;

        ConstReverseIterator Reverse() const;

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

        ConstIterator(const CYIString &string, const char *pPosition);
        char m_storage[YI_STRING_ITERATOR_SIZE];
    };
    
    typedef ConstIterator Iterator;
    typedef std::reverse_iterator<Iterator> ReverseIterator;
    
    enum CASE_MODE
    {
        CASE_SENSITIVE,
        CASE_INSENSITIVE
    };

    static const CYIString &EmptyString();
    
    CYIString();
    
    CYIString(const CYIString &s);
    
    CYIString(CYIString &&s);

    CYIString(std::string &&string);
    
    CYIString(const std::string &s);
    
    explicit CYIString(char32_t character);

    CYIString(const ConstIterator &begin, const ConstIterator &end);
    
    CYIString(const std::wstring &s);
    
    CYIString(const U_NAMESPACE_QUALIFIER UnicodeString &s, uint32_t uSizeHintBytes = 0);

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

    CYIString(const NSString *string);
    
    CYIString(const CFStringRef string);
#endif

    CYIString(const char *pUTF8);

    CYIString(const char *pUTF8, uint32_t uSizeBytes);

    CYIString(const char16_t *pUTF16, uint32_t uSize = std::numeric_limits<uint32_t>::max());

    CYIString(const char32_t *pUTF32, uint32_t uSize = std::numeric_limits<uint32_t>::max());

    CYIString(const wchar_t *pWideChars, uint32_t uSize = std::numeric_limits<uint32_t>::max());

    operator const char *() const;
    
    CYIString &operator=(const CYIString &s);

    CYIString &operator=(const char *pUTF8);

    CYIString &operator=(CYIString &&s);

    bool operator==(const CYIString &s) const;

    bool operator==(const char *pUTF8) const;

    bool operator!=(const CYIString &s) const;
    
    bool operator!=(const char *pUTF8) const;

    bool operator<(const CYIString &s1) const;

    bool operator>(const CYIString &s1) const;
    
    bool operator<=(const CYIString &s1) const;
    
    bool operator>=(const CYIString &s1) const;

    char32_t operator[](int32_t nPos) const;

    CYIString &operator+=(const CYIString &s);

    CYIString &operator+=(const char *pUTF8);

    template <class T>
    CYIString operator+(T arg) const;
    
    
    
    template<class T>
    static CYIString FromValue(const T &arg, bool *pbError = nullptr);

    static CYIString FromFloat(float fValue, uint32_t uDecimalPlaces = 6, bool bTrailingZeroes = false, bool bUseSignificantDigits = false);

    static CYIString FromDouble(double fValue, uint32_t uDecimalPlaces = 6, bool bTrailingZeroes = false, bool bUseSignificantDigits = false);

    static const CYIString &FromBool(bool bValue);

    
    
    friend std::istream &operator>>(std::istream &stream, CYIString &val);

    

    bool IsEmpty() const;

    bool IsNotEmpty() const;

    uint32_t GetLength() const;

    uint32_t GetSizeInBytes() const;

    bool ContainsNonASCII() const;
    
    char32_t At(uint32_t uPos) const;

    char ByteAt(uint32_t uByteOffset) const;

    bool Contains(const CYIString &s, CASE_MODE eCaseSensitivity = CASE_SENSITIVE) const;
    
    bool StartsWith(const CYIString &s, CASE_MODE eCaseSensitivity = CASE_SENSITIVE) const;
    
    bool EndsWith(const CYIString &s, CASE_MODE eCaseSensitivity = CASE_SENSITIVE) const;
    
    int32_t Compare(const CYIString &s, CASE_MODE eCaseSensitivity = CASE_SENSITIVE) const;

    std::vector<CYIString> Split(const CYIString &delimiter, bool bIgnoreEmptySubstrings = true, uint32_t uMaximumParts = std::numeric_limits<uint32_t>::max()) const;

    CYIString SubStr(uint32_t uPos = 0, uint32_t uLen = std::numeric_limits<uint32_t>::max()) const;

    CYIString SubStr(const ConstIterator &begin, const ConstIterator &end) const;
    
    CYIString Left(uint32_t uLen) const;

    CYIString Right(uint32_t uLen) const;

    CYIString ToUpper() const;
    
    CYIString ToLower() const;

    CYIString ToNormalizedText(bool *pbError = nullptr) const;

    bool IsNumeric() const;
    
    int32_t IndexOf(const CYIString &s, uint32_t uPos = 0) const;

    int32_t LastIndexOf(const CYIString &s, uint32_t uPos = std::numeric_limits<uint32_t>::max()) const;

    ConstIterator Find(const CYIString &s, const ConstIterator &begin) const;
    
    ConstReverseIterator ReverseFind(const CYIString &s, const ConstReverseIterator &begin) const;
    
    CYIString Arg(const CYIString &rText) const;
    
    const char *GetData() const;

    ConstIterator begin() const;
    
    ConstIterator end() const;
    
    ConstReverseIterator rbegin() const;
    
    ConstReverseIterator rend() const;
    

    
    void Clear();
    
    CYIString &Append(const CYIString &s);

    CYIString &Append(const char *pUTF8, uint32_t uSizeBytes = std::numeric_limits<uint32_t>::max());

    ConstIterator Append(const ConstIterator &begin, const ConstIterator &end);
    
    CYIString &Prepend(const CYIString &s);

    CYIString &Prepend(const char *pUTF8, uint32_t uSizeBytes = std::numeric_limits<uint32_t>::max());

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

    CYIString &Insert(const CYIString &s, uint32_t uPos, uint32_t uLen = std::numeric_limits<uint32_t>::max());

    ConstIterator Insert(const CYIString &s, const ConstIterator &insertPosition);
    
    ConstIterator Insert(const ConstIterator &begin, const ConstIterator &end, const ConstIterator &insertPosition);

    CYIString &Erase(uint32_t uPos = 0, uint32_t uLen = std::numeric_limits<uint32_t>::max());

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

    CYIString &Replace(const CYIString &s, uint32_t uPos, uint32_t uLen);

    ConstIterator Replace(const CYIString &s, const ConstIterator &begin, const ConstIterator &end);
    
    CYIString &Replace(const CYIString &oldSubstring, const CYIString &newSubstring, uint32_t uMaximumReplacements = std::numeric_limits<uint32_t>::max());

    void Remove(const CYIString &text);

    void Swap(CYIString &s);

    void Trim();

    void TrimLeft(uint32_t uLen = std::numeric_limits<uint32_t>::max());

    void TrimRight(uint32_t uLen = std::numeric_limits<uint32_t>::max());

    const char *AsUTF8(uint32_t *pElementsCount = nullptr) const;

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

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

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

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

    const std::string &ToStdString() const;
    
    std::wstring ToStdWString() const;
    
    U_NAMESPACE_QUALIFIER UnicodeString ToUnicodeString() const;
    
#if defined(__OBJC__) || defined(DOXY)

    NSString *ToNSString() const;
    
    CFStringRef ToCFStringRef() const;
#endif

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

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

    float ToFloat(bool *pbError = nullptr) const;

    double ToDouble(bool *pbError = nullptr) const;

    bool ToBool(bool *pbError = nullptr) const;

private:
    std::string m_string;
    mutable uint32_t m_uLength; // 0 indicates that the length (in characters) is unknown
};


std::ostream &operator<<(std::ostream &stream, const CYIString &val);
std::istream &operator>>(std::istream &stream, CYIString &val);

CYIString operator+(const CYIString &lhs, const CYIString &rhs);


#include "utility/YiString.inl"

#endif