vcodepoint.h

Go to the documentation of this file.

/*
Copyright c1997-2014 Trygve Isaacson. All rights reserved.
This file is part of the Code Vault version 4.1
http://www.bombaydigital.com/
License: MIT. See LICENSE.md in the Vault top level directory.
*/

#ifndef vcodepoint_h
#define vcodepoint_h

#include "vtypes.h"

class VChar;
class VString;
class VBinaryIOStream;
class VTextIOStream;

class VCodePoint {

    public:
    
        explicit VCodePoint(int i);
        explicit VCodePoint(char c);
        explicit VCodePoint(const VChar& c);
        explicit VCodePoint(const VString& hexNotation);
        explicit VCodePoint(const Vu8* buffer, int startOffset);
        explicit VCodePoint(VBinaryIOStream& stream);
        explicit VCodePoint(VTextIOStream& utf8Stream);
        explicit VCodePoint(const std::wstring& utf16WideString, int atIndex);

        int getUTF8Length() const { return mUTF8Length; }
        int getUTF16Length() const { return mUTF16Length; }
        int intValue() const { return mIntValue; }
        VString toString() const;
        VChar toASCIIChar() const;
        std::wstring toUTF16WideString() const;
        void writeToBinaryStream(VBinaryIOStream& stream) const;
        bool isNull() const { return mIntValue == 0; }
        bool isNotNull() const { return mIntValue != 0; }
        bool isASCII() const { return mUTF8Length == 1; }
        bool isWhitespace() const;
        bool isAlpha() const;
        bool isNumeric() const;
        bool isAlphaNumeric() const;
        bool isHexadecimal() const;

        friend inline bool operator==(const VCodePoint& p1, const VCodePoint& p2);
        
        // Helper utility functions for dealing with UTF-8 buffers in VString and VStringIterator:
        
        static int getUTF8LengthFromUTF8StartByte(Vu8 startByte);
        static int getUTF8LengthFromCodePointValue(int intValue);
        static bool isUTF8ContinuationByte(Vu8 byteValue);
        static int countUTF8CodePoints(const Vu8* buffer, int numBytes);
        static int getPreviousUTF8CodePointOffset(const Vu8* buffer, int offset);

        static int getUTF16LengthFromCodePointValue(int intValue);
        static bool isUTF16SurrogateCodeUnit(wchar_t codeUnit);

    private:
    
        void _initFromUTF8Bytes(int numBytesToUse, Vu8 byte0, Vu8 byte1, Vu8 byte2, Vu8 byte3);
        
        void _initFromUTF16Surrogates(wchar_t leadSurrogate, wchar_t trailSurrogate);
    
        int mIntValue;      
        int mUTF8Length;    
        int mUTF16Length;   

        friend inline bool operator==(const VCodePoint& cp, char c);
        friend inline bool operator==(char c, const VCodePoint& cp);
};

inline bool operator==(const VCodePoint& p1, const VCodePoint& p2) { return p1.mIntValue == p2.mIntValue; }
inline bool operator==(const VCodePoint& cp, char c) { return cp.mIntValue == (int) c; }
inline bool operator==(char c, const VCodePoint& cp) { return cp.mIntValue == (int) c; }

#endif /* vcodepoint_h */