juce_CharPointer_UTF32.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the juce_core module of the JUCE library.
   Copyright (c) 2015 - ROLI Ltd.
 
   Permission to use, copy, modify, and/or distribute this software for any purpose with
   or without fee is hereby granted, provided that the above copyright notice and this
   permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN
   NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
   DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER
   IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
   CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 
   ------------------------------------------------------------------------------
 
   NOTE! This permissive ISC license applies ONLY to files within the juce_core module!
   All other JUCE modules are covered by a dual GPL/commercial license, so if you are
   using any other modules, be sure to check that you also comply with their license.
 
   For more details, visit www.juce.com
 
  ==============================================================================
*/
 
#ifndef JUCE_CHARPOINTER_UTF32_H_INCLUDED
#define JUCE_CHARPOINTER_UTF32_H_INCLUDED
 
 
//==============================================================================
class CharPointer_UTF32
{
public:
    typedef juce_wchar CharType;
 
    inline explicit CharPointer_UTF32 (const CharType* const rawPointer) noexcept
        : data (const_cast <CharType*> (rawPointer))
    {
    }
 
    inline CharPointer_UTF32 (const CharPointer_UTF32& other) noexcept
        : data (other.data)
    {
    }
 
    inline CharPointer_UTF32 operator= (CharPointer_UTF32 other) noexcept
    {
        data = other.data;
        return *this;
    }
 
    inline CharPointer_UTF32 operator= (const CharType* text) noexcept
    {
        data = const_cast <CharType*> (text);
        return *this;
    }
 
    inline bool operator== (CharPointer_UTF32 other) const noexcept     { return data == other.data; }
    inline bool operator!= (CharPointer_UTF32 other) const noexcept     { return data != other.data; }
    inline bool operator<= (CharPointer_UTF32 other) const noexcept     { return data <= other.data; }
    inline bool operator<  (CharPointer_UTF32 other) const noexcept     { return data <  other.data; }
    inline bool operator>= (CharPointer_UTF32 other) const noexcept     { return data >= other.data; }
    inline bool operator>  (CharPointer_UTF32 other) const noexcept     { return data >  other.data; }
 
    inline CharType* getAddress() const noexcept        { return data; }
 
    inline operator const CharType*() const noexcept    { return data; }
 
    inline bool isEmpty() const noexcept                { return *data == 0; }
 
    inline juce_wchar operator*() const noexcept        { return *data; }
 
    inline CharPointer_UTF32 operator++() noexcept
    {
        ++data;
        return *this;
    }
 
    inline CharPointer_UTF32 operator--() noexcept
    {
        --data;
        return *this;
    }
 
    inline juce_wchar getAndAdvance() noexcept  { return *data++; }
 
    CharPointer_UTF32 operator++ (int) noexcept
    {
        CharPointer_UTF32 temp (*this);
        ++data;
        return temp;
    }
 
    inline void operator+= (const int numToSkip) noexcept
    {
        data += numToSkip;
    }
 
    inline void operator-= (const int numToSkip) noexcept
    {
        data -= numToSkip;
    }
 
    inline juce_wchar& operator[] (const int characterIndex) const noexcept
    {
        return data [characterIndex];
    }
 
    CharPointer_UTF32 operator+ (const int numToSkip) const noexcept
    {
        return CharPointer_UTF32 (data + numToSkip);
    }
 
    CharPointer_UTF32 operator- (const int numToSkip) const noexcept
    {
        return CharPointer_UTF32 (data - numToSkip);
    }
 
    inline void write (const juce_wchar charToWrite) noexcept
    {
        *data++ = charToWrite;
    }
 
    inline void replaceChar (const juce_wchar newChar) noexcept
    {
        *data = newChar;
    }
 
    inline void writeNull() const noexcept
    {
        *data = 0;
    }
 
    size_t length() const noexcept
    {
       #if JUCE_NATIVE_WCHAR_IS_UTF32 && ! JUCE_ANDROID
        return wcslen (data);
       #else
        size_t n = 0;
        while (data[n] != 0)
            ++n;
        return n;
       #endif
    }
 
    size_t lengthUpTo (const size_t maxCharsToCount) const noexcept
    {
        return CharacterFunctions::lengthUpTo (*this, maxCharsToCount);
    }
 
    size_t lengthUpTo (const CharPointer_UTF32 end) const noexcept
    {
        return CharacterFunctions::lengthUpTo (*this, end);
    }
 
    size_t sizeInBytes() const noexcept
    {
        return sizeof (CharType) * (length() + 1);
    }
 
    static inline size_t getBytesRequiredFor (const juce_wchar) noexcept
    {
        return sizeof (CharType);
    }
 
    template <class CharPointer>
    static size_t getBytesRequiredFor (const CharPointer text) noexcept
    {
        return sizeof (CharType) * text.length();
    }
 
    CharPointer_UTF32 findTerminatingNull() const noexcept
    {
        return CharPointer_UTF32 (data + length());
    }
 
    template <typename CharPointer>
    void writeAll (const CharPointer src) noexcept
    {
        CharacterFunctions::copyAll (*this, src);
    }
 
    void writeAll (const CharPointer_UTF32 src) noexcept
    {
        const CharType* s = src.data;
 
        while ((*data = *s) != 0)
        {
            ++data;
            ++s;
        }
    }
 
    template <typename CharPointer>
    size_t writeWithDestByteLimit (const CharPointer src, const size_t maxDestBytes) noexcept
    {
        return CharacterFunctions::copyWithDestByteLimit (*this, src, maxDestBytes);
    }
 
    template <typename CharPointer>
    void writeWithCharLimit (const CharPointer src, const int maxChars) noexcept
    {
        CharacterFunctions::copyWithCharLimit (*this, src, maxChars);
    }
 
    template <typename CharPointer>
    int compare (const CharPointer other) const noexcept
    {
        return CharacterFunctions::compare (*this, other);
    }
 
   #if JUCE_NATIVE_WCHAR_IS_UTF32 && ! JUCE_ANDROID
 
    int compare (const CharPointer_UTF32 other) const noexcept
    {
        return wcscmp (data, other.data);
    }
   #endif
 
    template <typename CharPointer>
    int compareUpTo (const CharPointer other, const int maxChars) const noexcept
    {
        return CharacterFunctions::compareUpTo (*this, other, maxChars);
    }
 
    template <typename CharPointer>
    int compareIgnoreCase (const CharPointer other) const
    {
        return CharacterFunctions::compareIgnoreCase (*this, other);
    }
 
    template <typename CharPointer>
    int compareIgnoreCaseUpTo (const CharPointer other, const int maxChars) const noexcept
    {
        return CharacterFunctions::compareIgnoreCaseUpTo (*this, other, maxChars);
    }
 
    template <typename CharPointer>
    int indexOf (const CharPointer stringToFind) const noexcept
    {
        return CharacterFunctions::indexOf (*this, stringToFind);
    }
 
    int indexOf (const juce_wchar charToFind) const noexcept
    {
        int i = 0;
 
        while (data[i] != 0)
        {
            if (data[i] == charToFind)
                return i;
 
            ++i;
        }
 
        return -1;
    }
 
    int indexOf (const juce_wchar charToFind, const bool ignoreCase) const noexcept
    {
        return ignoreCase ? CharacterFunctions::indexOfCharIgnoreCase (*this, charToFind)
                          : CharacterFunctions::indexOfChar (*this, charToFind);
    }
 
    bool isWhitespace() const               { return CharacterFunctions::isWhitespace (*data) != 0; }
    bool isDigit() const                    { return CharacterFunctions::isDigit (*data) != 0; }
    bool isLetter() const                   { return CharacterFunctions::isLetter (*data) != 0; }
    bool isLetterOrDigit() const            { return CharacterFunctions::isLetterOrDigit (*data) != 0; }
    bool isUpperCase() const                { return CharacterFunctions::isUpperCase (*data) != 0; }
    bool isLowerCase() const                { return CharacterFunctions::isLowerCase (*data) != 0; }
 
    juce_wchar toUpperCase() const noexcept { return CharacterFunctions::toUpperCase (*data); }
    juce_wchar toLowerCase() const noexcept { return CharacterFunctions::toLowerCase (*data); }
 
    int getIntValue32() const noexcept      { return CharacterFunctions::getIntValue <int, CharPointer_UTF32> (*this); }
    int64 getIntValue64() const noexcept    { return CharacterFunctions::getIntValue <int64, CharPointer_UTF32> (*this); }
 
    double getDoubleValue() const noexcept  { return CharacterFunctions::getDoubleValue (*this); }
 
    CharPointer_UTF32 findEndOfWhitespace() const noexcept   { return CharacterFunctions::findEndOfWhitespace (*this); }
 
    static bool canRepresent (juce_wchar character) noexcept
    {
        return ((unsigned int) character) < (unsigned int) 0x10ffff;
    }
 
    static bool isValidString (const CharType* dataToTest, int maxBytesToRead)
    {
        maxBytesToRead /= (int) sizeof (CharType);
 
        while (--maxBytesToRead >= 0 && *dataToTest != 0)
            if (! canRepresent (*dataToTest++))
                return false;
 
        return true;
    }
 
    CharPointer_UTF32 atomicSwap (const CharPointer_UTF32 newValue)
    {
        return CharPointer_UTF32 (reinterpret_cast <Atomic<CharType*>&> (data).exchange (newValue.data));
    }
 
private:
    CharType* data;
};
 
 
#endif   // JUCE_CHARPOINTER_UTF32_H_INCLUDED