juce_CharPointer_ASCII.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_ASCII_H_INCLUDED
#define JUCE_CHARPOINTER_ASCII_H_INCLUDED
 
 
//==============================================================================
class CharPointer_ASCII
{
public:
    typedef char CharType;
 
    inline explicit CharPointer_ASCII (const CharType* const rawPointer) noexcept
        : data (const_cast <CharType*> (rawPointer))
    {
    }
 
    inline CharPointer_ASCII (const CharPointer_ASCII& other) noexcept
        : data (other.data)
    {
    }
 
    inline CharPointer_ASCII operator= (const CharPointer_ASCII other) noexcept
    {
        data = other.data;
        return *this;
    }
 
    inline CharPointer_ASCII operator= (const CharType* text) noexcept
    {
        data = const_cast <CharType*> (text);
        return *this;
    }
 
    inline bool operator== (CharPointer_ASCII other) const noexcept     { return data == other.data; }
    inline bool operator!= (CharPointer_ASCII other) const noexcept     { return data != other.data; }
    inline bool operator<= (CharPointer_ASCII other) const noexcept     { return data <= other.data; }
    inline bool operator<  (CharPointer_ASCII other) const noexcept     { return data <  other.data; }
    inline bool operator>= (CharPointer_ASCII other) const noexcept     { return data >= other.data; }
    inline bool operator>  (CharPointer_ASCII 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 (juce_wchar) (uint8) *data; }
 
    inline CharPointer_ASCII operator++() noexcept
    {
        ++data;
        return *this;
    }
 
    inline CharPointer_ASCII operator--() noexcept
    {
        --data;
        return *this;
    }
 
    inline juce_wchar getAndAdvance() noexcept  { return (juce_wchar) (uint8) *data++; }
 
    CharPointer_ASCII operator++ (int) noexcept
    {
        CharPointer_ASCII 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 (juce_wchar) (unsigned char) data [characterIndex];
    }
 
    CharPointer_ASCII operator+ (const int numToSkip) const noexcept
    {
        return CharPointer_ASCII (data + numToSkip);
    }
 
    CharPointer_ASCII operator- (const int numToSkip) const noexcept
    {
        return CharPointer_ASCII (data - numToSkip);
    }
 
    inline void write (const juce_wchar charToWrite) noexcept
    {
        *data++ = (char) charToWrite;
    }
 
    inline void replaceChar (const juce_wchar newChar) noexcept
    {
        *data = (char) newChar;
    }
 
    inline void writeNull() const noexcept
    {
        *data = 0;
    }
 
    size_t length() const noexcept
    {
        return (size_t) strlen (data);
    }
 
    size_t lengthUpTo (const size_t maxCharsToCount) const noexcept
    {
        return CharacterFunctions::lengthUpTo (*this, maxCharsToCount);
    }
 
    size_t lengthUpTo (const CharPointer_ASCII end) const noexcept
    {
        return CharacterFunctions::lengthUpTo (*this, end);
    }
 
    size_t sizeInBytes() const noexcept
    {
        return length() + 1;
    }
 
    static inline size_t getBytesRequiredFor (const juce_wchar) noexcept
    {
        return 1;
    }
 
    template <class CharPointer>
    static size_t getBytesRequiredFor (const CharPointer text) noexcept
    {
        return text.length();
    }
 
    CharPointer_ASCII findTerminatingNull() const noexcept
    {
        return CharPointer_ASCII (data + length());
    }
 
    template <typename CharPointer>
    void writeAll (const CharPointer src) noexcept
    {
        CharacterFunctions::copyAll (*this, src);
    }
 
    void writeAll (const CharPointer_ASCII src) noexcept
    {
        strcpy (data, src.data);
    }
 
    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);
    }
 
    int compare (const CharPointer_ASCII other) const noexcept
    {
        return strcmp (data, other.data);
    }
 
    template <typename CharPointer>
    int compareUpTo (const CharPointer other, const int maxChars) const noexcept
    {
        return CharacterFunctions::compareUpTo (*this, other, maxChars);
    }
 
    int compareUpTo (const CharPointer_ASCII other, const int maxChars) const noexcept
    {
        return strncmp (data, other.data, (size_t) maxChars);
    }
 
    template <typename CharPointer>
    int compareIgnoreCase (const CharPointer other) const
    {
        return CharacterFunctions::compareIgnoreCase (*this, other);
    }
 
    int compareIgnoreCase (const CharPointer_ASCII other) const
    {
       #if JUCE_MSVC
        return stricmp (data, other.data);
       #elif JUCE_MINGW
        return CharacterFunctions::compareIgnoreCase (*this, other);
       #else
        return strcasecmp (data, other.data);
       #endif
    }
 
    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] == (char) 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 ((juce_wchar) (uint8) *data) != 0; }
    bool isLowerCase() const                { return CharacterFunctions::isLowerCase ((juce_wchar) (uint8) *data) != 0; }
 
    juce_wchar toUpperCase() const noexcept { return CharacterFunctions::toUpperCase ((juce_wchar) (uint8) *data); }
    juce_wchar toLowerCase() const noexcept { return CharacterFunctions::toLowerCase ((juce_wchar) (uint8) *data); }
 
    int getIntValue32() const noexcept      { return atoi (data); }
 
    int64 getIntValue64() const noexcept
    {
       #if JUCE_LINUX || JUCE_ANDROID || JUCE_MINGW
        return atoll (data);
       #elif JUCE_WINDOWS
        return _atoi64 (data);
       #else
        return CharacterFunctions::getIntValue <int64, CharPointer_ASCII> (*this);
       #endif
    }
 
    double getDoubleValue() const noexcept  { return CharacterFunctions::getDoubleValue (*this); }
 
    CharPointer_ASCII findEndOfWhitespace() const noexcept   { return CharacterFunctions::findEndOfWhitespace (*this); }
 
    static bool canRepresent (juce_wchar character) noexcept
    {
        return ((unsigned int) character) < (unsigned int) 128;
    }
 
    static bool isValidString (const CharType* dataToTest, int maxBytesToRead)
    {
        while (--maxBytesToRead >= 0)
        {
            if (((signed char) *dataToTest) <= 0)
                return *dataToTest == 0;
 
            ++dataToTest;
        }
 
        return true;
    }
 
private:
    CharType* data;
};
 
 
#endif   // JUCE_CHARPOINTER_ASCII_H_INCLUDED