Rhino C++ API  7.21
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
ON_UnicodeShortCodePoint Class Reference

ON_UnicodeShortCodePoint is a tool to use when working with Unicode code points with values &lt=0xFFFF. Note that valid Unicode code point values can be as large as 0x10FFFD. (0x10FFFE and 0x10FFFF are specified as &ltnot a character&gt by the Unicode Standard code chart https://www.unicode.org/charts/PDF/U10FF80.pdf) This class is used when converting between Unicode and BIG5 encodings and in other settings where Unicode code points &gt 0xFFFF are not encountered and the 2 byte size of ON_UnicodeShortCodePoint appreciably more efficient that a 4 byte size of an unsigned int. More...

#include <opennurbs_unicode.h>

Public Member Functions

 ON_UnicodeShortCodePoint ()=default
 
 ON_UnicodeShortCodePoint (const ON_UnicodeShortCodePoint &)=default
 
 ~ON_UnicodeShortCodePoint ()=default
 
bool IsASCII (bool bNullIsASCII) const
 The Unicode is a extension of ASCII encoding and code points &lt= 0x7F are valid Unicode code points. More...
 
bool IsByteOrderMark () const
 The Unicode code point value 0xFFFE os not a character and is used as a byte order mark. More...
 
bool IsNull () const
 Determine if this Unicode code point is 0. More...
 
bool IsPrivateUse () const
 Unicode code points are separated into standard and private use (user defined) code points. More...
 
bool IsReplacementCharacter () const
 The Unicode code point U+FFFD is called the replacement character. It is typically a light question mark with a dark diamond background. It is often used to indicate a character is unknown, unavailable, does not exist, or an error occured when creating that code point. More...
 
bool IsStandard (bool bNullIsValid) const
 Unicode code points are separated into standard and private use (user defined) code points. More...
 
bool IsValid (bool bNullIsValid, bool bByteOrderMarkIsValid) const
 Determine if the Unicode code point is valid. More...
 
ON_UnicodeShortCodePointoperator= (const ON_UnicodeShortCodePoint &)=default
 
unsigned int UnicodeCodePoint () const
 

Static Public Member Functions

static int Compare (const ON_UnicodeShortCodePoint *lhs, const ON_UnicodeShortCodePoint *rhs)
 
static const ON_UnicodeShortCodePoint Create (unsigned int unicode_code_point)
 Creates a Unicode code point with the specified code point value. More...
 
static const ON_UnicodeShortCodePoint CreateFromBig5 (const class ON_Big5CodePoint &big5_code_point, ON_UnicodeShortCodePoint not_available)
 Find a Unicode code point with the same character as big5_code_point. More...
 
static const ON_UnicodeShortCodePoint CreateFromBig5 (unsigned int big5_code_point, ON_UnicodeShortCodePoint not_available)
 Find a Unicode code point with the same character as big5_code_point. More...
 

Static Public Attributes

static const ON_UnicodeShortCodePoint ByteOrderMark
 ON_UnicodeShortCodePoint::ByteOrderMark has a code point value = 0xFFFE. (0xFFFE is not a Unicode character code point.) More...
 
static const ON_UnicodeShortCodePoint Error
 ON_UnicodeShortCodePoint::Error has a code point value = 0xFFFF. (0xFFFF is not a Unicode character code point.) More...
 
static const ON_UnicodeShortCodePoint Null
 ON_UnicodeShortCodePoint::NUll has a code point value = 0. More...
 
static const ON_UnicodeShortCodePoint ReplacementCharacter
 ON_UnicodeShortCodePoint::ReplacementCharacter has a code point = U+FFFD. More...
 

Detailed Description

ON_UnicodeShortCodePoint is a tool to use when working with Unicode code points with values &lt=0xFFFF. Note that valid Unicode code point values can be as large as 0x10FFFD. (0x10FFFE and 0x10FFFF are specified as &ltnot a character&gt by the Unicode Standard code chart https://www.unicode.org/charts/PDF/U10FF80.pdf) This class is used when converting between Unicode and BIG5 encodings and in other settings where Unicode code points &gt 0xFFFF are not encountered and the 2 byte size of ON_UnicodeShortCodePoint appreciably more efficient that a 4 byte size of an unsigned int.

Constructor & Destructor Documentation

◆ ON_UnicodeShortCodePoint() [1/2]

ON_UnicodeShortCodePoint::ON_UnicodeShortCodePoint ( )
default

◆ ~ON_UnicodeShortCodePoint()

ON_UnicodeShortCodePoint::~ON_UnicodeShortCodePoint ( )
default

◆ ON_UnicodeShortCodePoint() [2/2]

ON_UnicodeShortCodePoint::ON_UnicodeShortCodePoint ( const ON_UnicodeShortCodePoint )
default

Member Function Documentation

◆ Compare()

static int ON_UnicodeShortCodePoint::Compare ( const ON_UnicodeShortCodePoint lhs,
const ON_UnicodeShortCodePoint rhs 
)
static

◆ Create()

static const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::Create ( unsigned int  unicode_code_point)
static

Creates a Unicode code point with the specified code point value.

Parameters
unicode_code_pointA valid Unicode code point.
Returns
If unicode_code_point is &lt= 0xFFFE and a valid Unicode code point or is the Unicode byte order mark (0xFFFE), then an instance with that value as code point is returned. Otherwise ON_UnicodeShortCodePoint::Error is returned. Notes:
  1. Valid Unicode code points can be as large as 0x10FFFD and ON_UnicodeShortCodePoint cannot accomodate code points &gt= U+10000.
  2. Values &gt= 0xD800 and &lt 0xE000 are not valid Unicode code points. These values are used in UTF-16 surrogate pair encodings of code points &gt= U+10000.

◆ CreateFromBig5() [1/2]

static const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::CreateFromBig5 ( const class ON_Big5CodePoint big5_code_point,
ON_UnicodeShortCodePoint  not_available 
)
static

Find a Unicode code point with the same character as big5_code_point.

Parameters
big5_code_point
not_availableValue to return when big5_code_point is valid but does not map to a Unicode code point.
Returns
If there is a corresponding BIG5 or ASCII code point, that code point is returned. Otherwise, if big5_code_point is valid, not_available is returned. Otherwise ON_UnicodeShortCodePoint::Error is returned.

◆ CreateFromBig5() [2/2]

static const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::CreateFromBig5 ( unsigned int  big5_code_point,
ON_UnicodeShortCodePoint  not_available 
)
static

Find a Unicode code point with the same character as big5_code_point.

Parameters
big5_code_point
not_availableValue to return when big5_code_point is valid but does not map to a Unicode code point.
Returns
If there is a corresponding BIG5 or ASCII code point, that code point is returned. Otherwise, if big5_code_point is valid, not_available is returned. Otherwise ON_UnicodeShortCodePoint::Error is returned.

◆ IsASCII()

bool ON_UnicodeShortCodePoint::IsASCII ( bool  bNullIsASCII) const

The Unicode is a extension of ASCII encoding and code points &lt= 0x7F are valid Unicode code points.

Parameters
bNullIsASCIIValue to return if this Unicode code point equal to ON_UnicodeShortCodePoint::Null.
Returns
True if the code point value &le= 0x7F.

◆ IsByteOrderMark()

bool ON_UnicodeShortCodePoint::IsByteOrderMark ( ) const

The Unicode code point value 0xFFFE os not a character and is used as a byte order mark.

Returns
True if this Unicode code point value is 0xFFFE.

◆ IsNull()

bool ON_UnicodeShortCodePoint::IsNull ( ) const

Determine if this Unicode code point is 0.

Returns
True if the code point value is 0.

◆ IsPrivateUse()

bool ON_UnicodeShortCodePoint::IsPrivateUse ( ) const

Unicode code points are separated into standard and private use (user defined) code points.

Returns
True if this Unicode code point is a private use (user defined) code point.

◆ IsReplacementCharacter()

bool ON_UnicodeShortCodePoint::IsReplacementCharacter ( ) const

The Unicode code point U+FFFD is called the replacement character. It is typically a light question mark with a dark diamond background. It is often used to indicate a character is unknown, unavailable, does not exist, or an error occured when creating that code point.

Returns
True if this Unicode code point is U+FFFD.

◆ IsStandard()

bool ON_UnicodeShortCodePoint::IsStandard ( bool  bNullIsValid) const

Unicode code points are separated into standard and private use (user defined) code points.

Parameters
bNullIsValidValue to return if the code point value is 0.
Returns
Returns true this Unicode code point is a standard code point.

◆ IsValid()

bool ON_UnicodeShortCodePoint::IsValid ( bool  bNullIsValid,
bool  bByteOrderMarkIsValid 
) const

Determine if the Unicode code point is valid.

Parameters
bNullIsValidValue to return if the code point value is 0.
bByteOrderMarkIsValidValue to return if the code point value is 0xFFFE.
Returns
True if the code point value is a valud Unicode code point.

◆ operator=()

ON_UnicodeShortCodePoint& ON_UnicodeShortCodePoint::operator= ( const ON_UnicodeShortCodePoint )
default

◆ UnicodeCodePoint()

unsigned int ON_UnicodeShortCodePoint::UnicodeCodePoint ( ) const

Member Data Documentation

◆ ByteOrderMark

const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::ByteOrderMark
static

ON_UnicodeShortCodePoint::ByteOrderMark has a code point value = 0xFFFE. (0xFFFE is not a Unicode character code point.)

◆ Error

const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::Error
static

ON_UnicodeShortCodePoint::Error has a code point value = 0xFFFF. (0xFFFF is not a Unicode character code point.)

◆ Null

const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::Null
static

ON_UnicodeShortCodePoint::NUll has a code point value = 0.

◆ ReplacementCharacter

const ON_UnicodeShortCodePoint ON_UnicodeShortCodePoint::ReplacementCharacter
static