A char string. Any multibyte encoding can be used. If the encoding is unknown, assume it is UTF-8. More...

#include <opennurbs_string.h>

Public Types
enum	: int { MaximumStringLength = 100000000 }

enum	Encoding : unsigned int { Encoding::Unset = 0, Encoding::Unknown = 1, Encoding::ASCII = 2, Encoding::UTF8 = 3, Encoding::SloppyUTF8 = 4, Encoding::BIG5andASCII = 5 }

Public Member Functions
	ON_String () ON_NOEXCEPT
	Constructors. More...

	ON_String (char, int=1)

	ON_String (const char *)

	ON_String (const char *, int)
	from substring More...

	ON_String (const ON_String &)

	ON_String (const ON_wString &src)
	src = UTF-16 string More...

	ON_String (const unsigned char *)

	ON_String (const unsigned char *, int)
	from substring More...

	ON_String (const wchar_t *src)
	construct a UTF-8 string string from a UTF-16 string. More...

	ON_String (const wchar_t *src, int length)
	from a UTF-16 substring More...

	ON_String (unsigned char, int=1)

	~ON_String ()

void	Append (const char *, int)
	string concatenation More...

void	Append (const unsigned char *, int)
	append specified number of characters More...

char *	Array ()

const char *	Array () const

int	Compare (const char *) const

int	Compare (const char *other_string, const class ON_Locale &locale, bool bIgnoreCase) const

int	Compare (const ON_String &other_string, const class ON_Locale &locale, bool bIgnoreCase) const

int	Compare (const unsigned char *) const

int	CompareAttributeName (const char *other_name) const

int	CompareNoCase (const char *) const

int	CompareNoCase (const unsigned char *) const

int	CompareOrdinal (const char *other_string, bool bIgnoreCase) const

int	CompareOrdinal (const ON_String &other_string, bool bIgnoreCase) const

int	ComparePath (const char *other_path) const

const ON_SHA1_Hash	ContentHash (ON_StringMapOrdinalType mapping) const

void	Create ()

ON__UINT32	DataCRC (ON__UINT32 current_remainder) const

void	Destroy ()
	releases any memory and initializes to default empty string More...

const ON_String	Duplicate () const

void	EmergencyDestroy ()

void	Empty ()
	sets length to zero - if possible, memory is retained More...

void	EnableReferenceCounting (bool bEnable)

bool	Equal (const char *other_string, const class ON_Locale &locale, bool bIgnoreCase) const

bool	Equal (const ON_String &other_string, const class ON_Locale &locale, bool bIgnoreCase) const

bool	EqualAttributeName (const char *other_name) const

bool	EqualOrdinal (const char *other_string, bool bOrdinalIgnoreCase) const

bool	EqualOrdinal (const ON_String &other_string, bool bOrdinalIgnoreCase) const

bool	EqualPath (const char *other_path) const

int	Find (char utf8_single_byte_c) const

int	Find (const char *) const
	look for a specific sub-string More...

int	Find (const char *, int start_index) const

int	Find (const unsigned char *) const

int	Find (const unsigned char *, int start_index) const

int	Find (unsigned char utf8_single_byte_c) const

bool ON_VARGS_FUNC_CDECL	Format (const char *format,...)

bool ON_VARGS_FUNC_CDECL	Format (const unsigned char *format,...)

bool	FormatVargs (const char *format, va_list args)

bool	FormatVargs (const unsigned char *format, va_list args)

char	GetAt (int) const

bool	IsEmpty () const
	returns true if length == 0 More...

bool	IsNotEmpty () const
	returns true if length > 0 More...

bool	IsPossibleEncoding (ON_String::Encoding encoding) const

bool	IsReferenceCounted () const

bool	IsValid (bool bLengthTest) const

ON_String	Left (int) const

int	Length () const
	Attributes & Operations. More...

void	MakeLower ()

void	MakeLowerOrdinal ()

void	MakeReverse ()

void	MakeUpper ()
	upper/lower/reverse conversion More...

void	MakeUpperOrdinal ()

ON_String	MapString (const class ON_Locale &locale, ON_StringMapType map_type) const

ON_String	MapStringOrdinal (ON_StringMapOrdinalType map_type) const

ON_String	Mid (int) const

ON_String	Mid (int, int) const
	simple sub-string extraction More...

const ON_wString	MultiByteDecode (int windows_code_page) const

	operator const char * () const

ON_String	operator+ (char) const

ON_String	operator+ (const char *) const

ON_String	operator+ (const ON_String &) const
	operator+() More...

ON_String	operator+ (const unsigned char *) const

ON_String	operator+ (unsigned char) const

const ON_String &	operator+= (char)

const ON_String &	operator+= (const char *)

const ON_String &	operator+= (const ON_String &)

const ON_String &	operator+= (const unsigned char *)

const ON_String &	operator+= (unsigned char)

ON_String &	operator= (char)

ON_String &	operator= (const char *)

ON_String &	operator= (const ON_String &)
	overloaded assignment More...

ON_String &	operator= (const ON_wString &src)
	src = Wide char string, result is a UTF-8 string More...

ON_String &	operator= (const unsigned char *)

ON_String &	operator= (const wchar_t *src)
	src = Wide char string, result is a UTF-8 string More...

ON_String &	operator= (unsigned char)

char &	operator[] (int)

char	operator[] (int) const

ON_String::Encoding	ProbableEncoding () const

int	Remove (const char utf8_single_byte_c)
	remove occurrences of chRemove More...

int	Replace (char utf8_single_byte_c1, char utf8_single_byte_c2)

int	Replace (const char token1, const char token2)

int	Replace (const unsigned char token1, const unsigned char token2)

int	Replace (unsigned char utf8_single_byte_c1, unsigned char utf8_single_byte_c2)

char *	ReserveArray (size_t)
	Low level access to string contents as character array. More...

ON_String	Reverse () const

int	ReverseFind (char utf8_single_byte_c) const

int	ReverseFind (const char *) const

int	ReverseFind (const unsigned char *) const

int	ReverseFind (unsigned char utf8_single_byte_c) const

ON_String	Right (int) const

int ON_VARGS_FUNC_CDECL	Scan (const char *format,...)

int ON_VARGS_FUNC_CDECL	Scan (const unsigned char *format,...)

void	SetAt (int, char)

void	SetAt (int, unsigned char)

char *	SetLength (size_t)
	set length (<=capacity) More...

void	ShrinkArray ()
	the requested capacity. More...

unsigned int	SizeOf () const

const ON_String	ToBIG5 (int *error_count) const

const ON_String	ToUTF8 () const

void	TrimLeft (const char *=nullptr)

void	TrimLeftAndRight (const char *=nullptr)

void	TrimRight (const char *=nullptr)

unsigned int	UnsignedLength () const

bool	WildCardMatch (const char *) const

bool	WildCardMatch (const unsigned char *) const

bool	WildCardMatchNoCase (const char *) const

bool	WildCardMatchNoCase (const unsigned char *) const

Static Public Member Functions
static const ON_String	ApproximateFromNumber (double d)

static int	Compare (const char string1, const char string2, const class ON_Locale &locale, bool bIgnoreCase)

static int	Compare (const char string1, int element_count1, const char string2, int element_count2, const class ON_Locale &locale, bool bIgnoreCase)

static int	CompareAttributeName (const char name1, const char name2)

static int	CompareOrdinal (const char string1, const char string2, bool bIgnoreCase)

static int	CompareOrdinal (const char string1, int element_count1, const char string2, int element_count2, bool bOrdinalIgnoreCase)

static int	ComparePath (const char path1, const char path2)

static int	ComparePath (const char path1, int element_count1, const char path2, int element_count2)

static bool	Equal (const char string1, const char string2, const class ON_Locale &locale, bool bIgnoreCase)

static bool	Equal (const char string1, int element_count1, const char string2, int element_count2, const class ON_Locale &locale, bool bOrdinalIgnoreCase)

static bool	EqualAttributeName (const char name1, const char name2)

static bool	EqualOrdinal (const char string1, const char string2, bool bOrdinalIgnoreCase)

static bool	EqualOrdinal (const char string1, int element_count1, const char string2, int element_count2, bool bOrdinalIgnoreCase)

static bool	EqualPath (const char path1, const char path2)

static bool	EqualPath (const char path1, int element_count1, const char path2, int element_count2)

static int ON_VARGS_FUNC_CDECL	FormatIntoBuffer (char buffer, size_t buffer_capacity, const char format,...)

static int ON_VARGS_FUNC_CDECL	FormatIntoBuffer (ON_StringBuffer &buffer, const char *format,...)

static const ON_String ON_VARGS_FUNC_CDECL	FormatToString (const char *format,...)

static int	FormatVargsIntoBuffer (char buffer, size_t buffer_capacity, const char format, va_list args)

static int	FormatVargsIntoBuffer (ON_StringBuffer &buffer, const char *format, va_list args)

static int	FormatVargsOutputCount (const char *format, va_list args)

static const ON_String	FromNumber (char n)

static const ON_String	FromNumber (double d)

static const ON_String	FromNumber (int n)

static const ON_String	FromNumber (ON__INT64 n)

static const ON_String	FromNumber (ON__UINT64 n)

static const ON_String	FromNumber (short n)

static const ON_String	FromNumber (unsigned char n)

static const ON_String	FromNumber (unsigned int n)

static const ON_String	FromNumber (unsigned short n)

static const ON_String	HexadecimalFromBytes (const ON__UINT8 *bytes, size_t byte_count, bool bCapitalDigits, bool bReverse)

static bool	IsDecimalDigit (char c)

static bool	IsHexDigit (char c)

static bool	IsPossibleEncoding (ON_String::Encoding encoding, const char *buffer, int buffer_length)

static int	Length (const char *string)

static int	Length (const char *string, size_t string_capacity)

static char	MapCharacterOrdinal (ON_StringMapOrdinalType map_type, char c)

static ON_String	MapString (const class ON_Locale &locale, ON_StringMapType map_type, const char *string, int element_count)

static int	MapString (const class ON_Locale &locale, ON_StringMapType map_type, const char string, int element_count, char mapped_string, int mapped_string_capacity)

static int	MapStringOrdinal (ON_StringMapOrdinalType map_type, const char string, int element_count, char mapped_string, int mapped_string_capacity)

static const ON_String	PreciseFromNumber (double d)

static ON_String::Encoding	ProbableEncoding (const char *buffer, int buffer_length)

static char *	Reverse (char *string, int element_count)

static int ON_VARGS_FUNC_CDECL	ScanBuffer (const char buffer, const char format,...)

static int ON_VARGS_FUNC_CDECL	ScanBuffer (const unsigned char buffer, const unsigned char format,...)

static int	ScanBufferVargs (const char buffer, const char format, va_list args)

static int	ScanBufferVargs (const unsigned char buffer, const unsigned char format, va_list args)

static void	SplitPath (const char path, ON_String drive, ON_String dir, ON_String fname, ON_String *ext)

static const ON_String	ToBIG5 (const char buffer, int buffer_length, int error_count)

static const char *	ToNumber (const char buffer, char value_on_failure, char value)

static const char *	ToNumber (const char buffer, double value_on_failure, double value)

static const char *	ToNumber (const char buffer, int value_on_failure, int value)

static const char *	ToNumber (const char buffer, ON__INT64 value_on_failure, ON__INT64 value)

static const char *	ToNumber (const char buffer, ON__UINT64 value_on_failure, ON__UINT64 value)

static const char *	ToNumber (const char buffer, short value_on_failure, short value)

static const char *	ToNumber (const char buffer, unsigned char value_on_failure, unsigned char value)

static const char *	ToNumber (const char buffer, unsigned int value_on_failure, unsigned int value)

static const char *	ToNumber (const char buffer, unsigned short value_on_failure, unsigned short value)

static const ON_String	ToUTF8 (const char *buffer, int buffer_length)

static unsigned int	UnsignedLength (const char *string)

Static Public Attributes
static const char	Ampersand = (char)ON_UnicodeCodePoint::ON_Ampersand
	AMPERSAND U+0026 (&) More...

static const char	Apostrophe = (char)ON_UnicodeCodePoint::ON_Apostrophe
	APOSTROPHE U+0027 (') More...

static const char	Backslash = (char)ON_UnicodeCodePoint::ON_Backslash
	REVERSE SOLIDUS U+005C (\) More...

static const char	Backspace = (char)ON_UnicodeCodePoint::ON_Backspace
	BACKSPACE control U+0008 More...

static const ON_String	ByteOrderMark
	Even though a char string has endian independent byte order, it is valid for UTF-8 encoded text to begin with the UTF-8 encoding of U+FEFF. A UTF-8 BOM is sometimes used to mark a char string as UTF-8 encoded. A UTF-8 BOM can occur when UTF-16 and UTF-32 encoded text with a byte order mark is converted to UTF-8 encoded text. Conversely a UTF-8 BOM is sometimes used when UTF-8 encode text will be converted to UTF-16/UTF-32 encoded text and a BOM is desired in the result. More...

static const char	CarriageReturn = (char)ON_UnicodeCodePoint::ON_CarriageReturn
	CARRIAGE RETURN control U+000D More...

static const char	Colon = (char)ON_UnicodeCodePoint::ON_Colon
	COLON U+003A (:) More...

static const char	Comma = (char)ON_UnicodeCodePoint::ON_Comma
	COMMA U+002C (,) More...

static const char	DecimalAsComma = (char)ON_UnicodeCodePoint::ON_Comma
	Comma decimal point (,) More...

static const char	DecimalAsPeriod = (char)ON_UnicodeCodePoint::ON_Period
	Period decimal point (.) More...

static const char	Delete = (char)ON_UnicodeCodePoint::ON_Delete
	DELETE U+007F More...

static const ON_String	EmptyString
	ON_String::EmptyString has length 0. const char* s = ON_String::EmptyString sets s = ""; More...

static const char	Escape = (char)ON_UnicodeCodePoint::ON_Escape
	ESCAPE control U+001B More...

static const char	FormFeed = (char)ON_UnicodeCodePoint::ON_FormFeed
	FORM FEED control U+000C More...

static const char	GreaterThanSign = (char)ON_UnicodeCodePoint::ON_GreaterThanSign
	GREATER-THAN SIGN U+003E (>) More...

static const char	HyphenMinus = (char)ON_UnicodeCodePoint::ON_HyphenMinus
	HYPHEN-MINUS U+002D (-) More...

static const char	LessThanSign = (char)ON_UnicodeCodePoint::ON_LessThanSign
	LESS-THAN SIGN U+003C (<) More...

static const char	LineFeed = (char)ON_UnicodeCodePoint::ON_LineFeed
	LINE FEED control U+000A More...

static const char	NumberSign = (char)ON_UnicodeCodePoint::ON_NumberSign
	NUMBER SIGN U+0023 (#) More...

static const char	PercentSign = (char)ON_UnicodeCodePoint::ON_PercentSign
	PERCENT SIGN U+0025 (%) More...

static const char	Period = (char)ON_UnicodeCodePoint::ON_Period
	PERIOD U+002E (decimal 46) (.) More...

static const char	Pipe = (char)ON_UnicodeCodePoint::ON_Pipe
	VERTICAL LINE U+007C (\|) More...

static const char	QuotationMark = (char)ON_UnicodeCodePoint::ON_QuotationMark
	QUOTATION MARK U+0022 (") More...

static const char	Semicolon = (char)ON_UnicodeCodePoint::ON_Semicolon
	SEMICOLON U+003B (;) More...

static const char	Slash = (char)ON_UnicodeCodePoint::ON_Slash
	SOLIDUS U+002F (/) More...

static const char	Space = (char)ON_UnicodeCodePoint::ON_Space
	SPACE U+0020 More...

static const char	Tab = (char)ON_UnicodeCodePoint::ON_Tab
	CHARACTER TABULATION control U+0009 More...

static const char	Tilde = (char)ON_UnicodeCodePoint::ON_Tilde
	TILDE U+007E (~) More...

static const char	Underscore = (char)ON_UnicodeCodePoint::ON_Underscore
	///< Unicode LOW LINE U+005F (_) More...

static const char	VerticalTab = (char)ON_UnicodeCodePoint::ON_VerticalTab
	LINE TABULATION control U+000B More...

Protected Member Functions
void	AppendToArray (const ON_String &)

void	AppendToArray (int, const char *)

void	AppendToArray (int, const unsigned char *)

void	CopyArray ()

void	CopyToArray (const ON_String &)

void	CopyToArray (int, const char *)

void	CopyToArray (int, const unsigned char *)

void	CopyToArray (int, const wchar_t *)

char *	CreateArray (int)

class ON_aStringHeader *	Header () const
	m_s - 12 bytes points at the string's ON_aStringHeader More...

class ON_aStringHeader *	IncrementedHeader () const

Protected Attributes
char *	m_s
	Implementation. More...

Detailed Description

A char string. Any multibyte encoding can be used. If the encoding is unknown, assume it is UTF-8.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : int

Enumerator

MaximumStringLength

This ON_String::MaximumStringLength value of 100,000,000 is used for string length sanity checking in both ON_String and ON_wString. The design of the ON_String and ON_wString classes could support string lengths up to 0xFFFFFFFEU = 4,294,967,294 but a cap of 100 million seems generous enough for current usage and is small enough to detect many corrupt memory situations. This value is used for both ON_String and ON_wString.

◆ Encoding

enum ON_String::Encoding : unsigned int

strong

Enumerator
Unset	Encoding not set.
Unknown	Encoding not known or cannot be determined.
ASCII	All byte values are in the range 0 to 0x7F (127)
UTF8	The sequence of byte values could be a UTF-8 encode string. UTF-8 extends ASCII encoding.
SloppyUTF8	The sequence of byte values could be a UTF-8 encoding with oversized encodings or surrogate pair code points.
BIG5andASCII	The sequence of byte values could be a BIG5 encode string that may also contain single byte ASCII code points. BIG5 is a double byte encoding and the first byte always has the high bit set.

Constructor & Destructor Documentation

◆ ON_String() [1/11]

ON_String::ON_String ( )

Constructors.

◆ ON_String() [2/11]

ON_String::ON_String ( const ON_String & )

◆ ON_String() [3/11]

ON_String::ON_String ( const char * )

◆ ON_String() [4/11]

ON_String::ON_String	(	const char *	,
		int
	)

from substring

◆ ON_String() [5/11]

ON_String::ON_String	(	char	,
		int	= `1`
	)

◆ ON_String() [6/11]

ON_String::ON_String ( const unsigned char * )

◆ ON_String() [7/11]

ON_String::ON_String	(	const unsigned char *	,
		int
	)

from substring

◆ ON_String() [8/11]

ON_String::ON_String	(	unsigned char	,
		int	= `1`
	)

◆ ON_String() [9/11]

ON_String::ON_String ( const wchar_t * src )

construct a UTF-8 string string from a UTF-16 string.

src = UTF-16 string

◆ ON_String() [10/11]

ON_String::ON_String	(	const wchar_t *	src,
		int	length
	)

from a UTF-16 substring

◆ ON_String() [11/11]

ON_String::ON_String ( const ON_wString & src )

src = UTF-16 string

◆ ~ON_String()

ON_String::~ON_String ( )

Member Function Documentation

◆ Append() [1/2]

void ON_String::Append	(	const char *	,
		int
	)

string concatenation

append specified number of characters

◆ Append() [2/2]

void ON_String::Append	(	const unsigned char *	,
		int
	)

append specified number of characters

◆ AppendToArray() [1/3]

void ON_String::AppendToArray ( const ON_String & )

protected

◆ AppendToArray() [2/3]

void ON_String::AppendToArray	(	int	,
		const char *
	)

protected

◆ AppendToArray() [3/3]

void ON_String::AppendToArray	(	int	,
		const unsigned char *
	)

protected

◆ ApproximateFromNumber()

static const ON_String ON_String::ApproximateFromNumber ( double d )

static

Parameters

d	"%f" when possible, otherwise "%g"

◆ Array() [1/2]

char* ON_String::Array ( )

◆ Array() [2/2]

const char* ON_String::Array ( ) const

◆ Compare() [1/6]

int ON_String::Compare ( const char * ) const

Deprecated:: Use CompareOrdinal(), ComparePath(), CompareAttributeName(), or a test that is linguistically apprropriate

◆ Compare() [2/6]

int ON_String::Compare	(	const char *	other_string,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)		const

◆ Compare() [3/6]

static int ON_String::Compare	(	const char *	string1,
		const char *	string2,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)

static

Description: Compare string1 and string2 by normalizing (NFC) and using invariant culture ordering. Parameters: string1 - [in] string2 - [in] bIgnoreCase - [in] Remarks: 1) Ordinal compares are the fastest. 2) Equal(...) is faster than Compare(...)

◆ Compare() [4/6]

static int ON_String::Compare	(	const char *	string1,
		int	element_count1,
		const char *	string2,
		int	element_count2,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)

static

Description: Compare string1 and string2 by normalizing (NFC) and using invariant culture ordering. Parameters: string1 - [in] element_count1 - [in] The number of string1[] elements to compare. If element_count1 < 0, then string1 must be null terminated. string2 - [in] element_count2 - [in] The number of string2[] elements to compare. If element_count2 < 0, then string2 must be null terminated. locale - [in] Typically ON_Locale::Ordinal, ON_Locale::InvariantCulture, or ON_Locale::CurrentCulture. bIgnoreCase - [in] Remarks: 1) Ordinal compares are the fastest. 2) Equal(...) is faster than Compare(...)

◆ Compare() [5/6]

int ON_String::Compare	(	const ON_String &	other_string,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)		const

Description: Compare this string and other_string by normalizing (NFC) and using invariant culture ordering. Parameters: other_string - [in] bIgnoreCase - [in] Remarks: 1) Ordinal compares are the fastest. 2) Equal(...) is faster than Compare(...)

◆ Compare() [6/6]

int ON_String::Compare ( const unsigned char * ) const

Deprecated:: Use CompareOrdinal(), ComparePath(), CompareAttributeName(), or a test that is linguistically apprropriate

◆ CompareAttributeName() [1/2]

static int ON_String::CompareAttributeName	(	const char *	name1,
		const char *	name2
	)

static

Description: Compare this string and other_name as a name attribute of an object like ON_3dmObjectAttributes.m_name, ON_Layer.m_name, and so on. These comparisons ignore case and use appropriate string normalization.
Parameters: name1 - [in] null terminated string name2 - [in] null terminated string

◆ CompareAttributeName() [2/2]

int ON_String::CompareAttributeName ( const char * other_name ) const

Description: Compare this string and other_name as a name attribute of an object like ON_3dmObjectAttributes.m_name, ON_Layer.m_name, and so on. These comparisons ignore case and use appropriate string normalization.
Parameters: other_name - [in] null terminated string

◆ CompareNoCase() [1/2]

int ON_String::CompareNoCase ( const char * ) const

Deprecated:: Use CompareOrdinal(), ComparePath(), CompareAttributeName(), or a test that is linguistically apprropriate

◆ CompareNoCase() [2/2]

int ON_String::CompareNoCase ( const unsigned char * ) const

Deprecated:: Use CompareOrdinal(), ComparePath(), CompareAttributeName(), or a test that is linguistically apprropriate

◆ CompareOrdinal() [1/4]

int ON_String::CompareOrdinal	(	const char *	other_string,
		bool	bIgnoreCase
	)		const

◆ CompareOrdinal() [2/4]

static int ON_String::CompareOrdinal	(	const char *	string1,
		const char *	string2,
		bool	bIgnoreCase
	)

static

Description: Compare string1 and string2 unsigned byte by unsigned byte. Parameters: string1 - [in] string2 - [in] bIgnoreCase - [in] Remarks: 1) If the string is UTF-8 encoded and bOrdinalIgnoreCase is true, only small latin a - z and capital latin A - Z are considered equal. It is impossible to ignore case for any other values in a UTF-8 ordinal compare.

2) If you are comparing file system paths, you should use ComparePath().

3) If locale, linguistic issues, UTF-8 encoding issues or unicode normalization or collation issues need to be considered, then CompareOrdinal() is the wrong function to use.

◆ CompareOrdinal() [3/4]

static int ON_String::CompareOrdinal	(	const char *	string1,
		int	element_count1,
		const char *	string2,
		int	element_count2,
		bool	bOrdinalIgnoreCase
	)

static

Description: Compare string1 and string2 unsigned byte by unsigned byte. Parameters: string1 - [in] element_count1 - [in] The number of elements in string1[] to compare. If element_count1 < 1, string1 must be null terminated and every element before the null terminator will be compared. string2 - [in] element_count2 - [in] The number of elements in string2[] to compare. If element_count2 < 1, string2 must be null terminated and every element before the null terminator will be compared. bOrdinalIgnoreCase - [in] If true, elements with values a-z are compared as if they had values A-Z. Remarks: 1) If the string is UTF-8 encoded and bOrdinalIgnoreCase is true, only small latin a - z and capital latin A - Z are considered equal. It is impossible to ignore case for any other values in a UTF-8 ordinal compare.

2) If you are comparing file system paths, you should use ComparePath().

3) If locale, linguistic issues, UTF-8 encoding issues or unicode normalization or collation issues need to be considered, then CompareOrdinal() is the wrong function to use.

◆ CompareOrdinal() [4/4]

int ON_String::CompareOrdinal	(	const ON_String &	other_string,
		bool	bIgnoreCase
	)		const

Description: Compare this string and other_string unsigned byte by unsigned byte. Parameters: other_string - [in] bIgnoreCase - [in] Remarks: 1) If the string is UTF-8 encoded and bOrdinalIgnoreCase is true, only small latin a - z and capital latin A - Z are considered equal. It is impossible to ignore case for any other values in an ordinal compare.

2) If you are comparing file system paths, you should use ComparePath().

3) If locale, linguistic issues, UTF-8 encoding issues or unicode normalization or collation issues need to be considered, then CompareOrdinal() is the wrong function to use.

◆ ComparePath() [1/3]

int ON_String::ComparePath ( const char * other_path ) const

Description: Compare this string and other_path as file system paths using appropriate tests for the current operating system. Parameters: other_path - [in] Remarks: 1) Windows and UNIX directory separators (/ and ) are considered equal.

2) Case is ignored when the file system is not case sensitive, like Windows.

3) String normalization appropriate for the current operating system is performed.

◆ ComparePath() [2/3]

static int ON_String::ComparePath	(	const char *	path1,
		const char *	path2
	)

static

Description: Compare sPath1 and sPath2 as file system paths using appropriate tests for the current operating system. Parameters: path1 - [in] null terminated string path2 - [in] null terminated string Remarks: 1) Windows and UNIX directory separators (/ and ) are considered equal.

2) Case is ignored when the file system is not case sensitive, like Windows.

3) String normalization appropriate for the current operating system is performed.

◆ ComparePath() [3/3]

static int ON_String::ComparePath	(	const char *	path1,
		int	element_count1,
		const char *	path2,
		int	element_count2
	)

static

Description: Compare sPath1 and sPath2 as file system paths using appropriate tests for the current operating system. Parameters: path1 - [in] maximum_element_count1 - [in] path2 - [in] maximum_element_count2 - [in] Remarks: 1) Windows and UNIX directory separators (/ and ) are considered equal.

2) Case is ignored when the file system is not case sensitive, like Windows.

3) String normalization appropriate for the current operating system is performed.

◆ ContentHash()

const ON_SHA1_Hash ON_String::ContentHash ( ON_StringMapOrdinalType mapping ) const

◆ CopyArray()

void ON_String::CopyArray ( )

protected

◆ CopyToArray() [1/4]

void ON_String::CopyToArray ( const ON_String & )

protected

◆ CopyToArray() [2/4]

void ON_String::CopyToArray	(	int	,
		const char *
	)

protected

◆ CopyToArray() [3/4]

void ON_String::CopyToArray	(	int	,
		const unsigned char *
	)

protected

◆ CopyToArray() [4/4]

void ON_String::CopyToArray	(	int	,
		const wchar_t *
	)

protected

◆ Create()

void ON_String::Create ( )

◆ CreateArray()

char* ON_String::CreateArray ( int )

protected

◆ DataCRC()

ON__UINT32 ON_String::DataCRC ( ON__UINT32 current_remainder ) const

◆ Destroy()

void ON_String::Destroy ( )

releases any memory and initializes to default empty string

◆ Duplicate()

const ON_String ON_String::Duplicate ( ) const

Returns: A duplicate of this that does not share memory with any other string. (A new array is allocated for the returned string.)

◆ EmergencyDestroy()

void ON_String::EmergencyDestroy ( )

◆ Empty()

void ON_String::Empty ( )

sets length to zero - if possible, memory is retained

◆ EnableReferenceCounting()

void ON_String::EnableReferenceCounting ( bool bEnable )

Deprecated:: Obsolete - does nothing.

◆ Equal() [1/4]

bool ON_String::Equal	(	const char *	other_string,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)		const

◆ Equal() [2/4]

static bool ON_String::Equal	(	const char *	string1,
		const char *	string2,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)

static

◆ Equal() [3/4]

static bool ON_String::Equal	(	const char *	string1,
		int	element_count1,
		const char *	string2,
		int	element_count2,
		const class ON_Locale &	locale,
		bool	bOrdinalIgnoreCase
	)

static

◆ Equal() [4/4]

bool ON_String::Equal	(	const ON_String &	other_string,
		const class ON_Locale &	locale,
		bool	bIgnoreCase
	)		const

◆ EqualAttributeName() [1/2]

static bool ON_String::EqualAttributeName	(	const char *	name1,
		const char *	name2
	)

static

◆ EqualAttributeName() [2/2]

bool ON_String::EqualAttributeName ( const char * other_name ) const

◆ EqualOrdinal() [1/4]

bool ON_String::EqualOrdinal	(	const char *	other_string,
		bool	bOrdinalIgnoreCase
	)		const

◆ EqualOrdinal() [2/4]

static bool ON_String::EqualOrdinal	(	const char *	string1,
		const char *	string2,
		bool	bOrdinalIgnoreCase
	)

static

◆ EqualOrdinal() [3/4]

static bool ON_String::EqualOrdinal	(	const char *	string1,
		int	element_count1,
		const char *	string2,
		int	element_count2,
		bool	bOrdinalIgnoreCase
	)

static

◆ EqualOrdinal() [4/4]

bool ON_String::EqualOrdinal	(	const ON_String &	other_string,
		bool	bOrdinalIgnoreCase
	)		const

◆ EqualPath() [1/3]

bool ON_String::EqualPath ( const char * other_path ) const

◆ EqualPath() [2/3]

static bool ON_String::EqualPath	(	const char *	path1,
		const char *	path2
	)

static

◆ EqualPath() [3/3]

static bool ON_String::EqualPath	(	const char *	path1,
		int	element_count1,
		const char *	path2,
		int	element_count2
	)

static

◆ Find() [1/6]

int ON_String::Find ( char utf8_single_byte_c ) const

searching (return starting index, or -1 if not found) look for a single character match

◆ Find() [2/6]

int ON_String::Find ( const char * ) const

look for a specific sub-string

◆ Find() [3/6]

int ON_String::Find	(	const char *	,
		int	start_index
	)		const

◆ Find() [4/6]

int ON_String::Find ( const unsigned char * ) const

◆ Find() [5/6]

int ON_String::Find	(	const unsigned char *	,
		int	start_index
	)		const

◆ Find() [6/6]

int ON_String::Find ( unsigned char utf8_single_byte_c ) const

◆ Format() [1/2]

bool ON_VARGS_FUNC_CDECL ON_String::Format	(	const char *	format,
			...
	)

Parameters: format - [in] Format control.
Positional parameters of the form N$x where N >= 1 and x is the standard format specification are supported. Avoid using S (capital S). See the Remarks for details. ... - [in] arguments for replacable items in the format string. Returns: True if successful. False if the string is too long or the format string is not valid. Remarks: When using Microsoft's compiler and other compilers that provide similar locale support, the locale is the invariant culture locale returned by ON_Locale::InvariantCulture::LocalePtr().

The way Windows handles the S (capital S) format parameter depends on locale and code page settings. It is strongly recommended that you never use S to include any string that may possibly contain elements with values > 127. The following examples illustrate a way to predictably use UTF-8 and wchar_t parameters in buffers of the other element type.

const char* utf8_string = ...; / UNRELIABLE ///< ON_wString::Format(buffer,buffer_capacity,"%S",utf8_string); / The code below will treat utf8_string as a UTF-8 encoded string. wchar_t wchar_buffer[...]; const size_t wchar_buffer_capacity= sizeof(buffer)/sizeof(buffer[0]); ON_wString::Format(wchar_buffer, wchar_buffer_capacity, "%s", ON_wString(utf8_string));

const wchar_t* wide_string = ...; / UNRELIABLE ///< ON_wString::Format(buffer,buffer_capacity,"%S",char_string); / The code below will include wide_string as a UTF-8 encoded string. char char_buffer[...]; const size_t char_buffer_capacity = sizeof(buffer)/sizeof(buffer[0]); ON_String::Format(char_buffer, char_buffer_capacity, "%s", ON_String(wide_string));

◆ Format() [2/2]

bool ON_VARGS_FUNC_CDECL ON_String::Format	(	const unsigned char *	format,
			...
	)

◆ FormatIntoBuffer() [1/2]

static int ON_VARGS_FUNC_CDECL ON_String::FormatIntoBuffer	(	char *	buffer,
		size_t	buffer_capacity,
		const char *	format,
			...
	)

static

Description: A platform independent, secure, culture invariant way to format a char string. This function is provide to be used when it is critical that the formatting be platform independent, secure and culture invariant. Parameters: buffer - [out] not null buffer_capacity - [in] > 0 Number of char elements in buffer. sFormat - [in] Avoid using S (capital S). See the Remarks for details. ... - [in] Returns: >= 0: The number of char elements written to buffer[], not including the null terminator. A null terminator is always added (buffer[returned value] = 0). The last element of buffer[] is always set to zero (buffer[buffer_capacity-1] = 0). < 0: failure: If buffer is not null and buffer_capacity > 0, then buffer[0] = 0 and buffer[buffer_capacity-1] = 0; Remarks: The way Windows handles the S (capital S) format parameter depends on locale and code page settings. It is strongly recommended that you never use S to include any string that may possibly contain elements with values > 127.
The following examples illustrate a way to predictably use UTF-8 and wchar_t parameters in buffers of the other element type.

 const char* utf8_string = ...;

/ UNRELIABLE ///< ON_wString::Format(buffer,buffer_capacity,"%S",utf8_string); wchar_t wchar_buffer[...]; const size_t wchar_buffer_capacity= sizeof(buffer)/sizeof(buffer[0]); ON_wString::Format(wchar_buffer, wchar_buffer_capacity, "%s", ON_wString(utf8_string));

const wchar_t* wide_string = ...; / UNRELIABLE ///< ON_wString::Format(buffer,buffer_capacity,"%S",char_string); char char_buffer[...]; const size_t char_buffer_capacity = sizeof(buffer)/sizeof(buffer[0]); ON_String::Format(char_buffer, char_buffer_capacity, "%s", ON_String(wide_string));

◆ FormatIntoBuffer() [2/2]

static int ON_VARGS_FUNC_CDECL ON_String::FormatIntoBuffer	(	ON_StringBuffer &	buffer,
		const char *	format,
			...
	)

static

◆ FormatToString()

static const ON_String ON_VARGS_FUNC_CDECL ON_String::FormatToString	(	const char *	format,
			...
	)

static

◆ FormatVargs() [1/2]

bool ON_String::FormatVargs	(	const char *	format,
		va_list	args
	)

◆ FormatVargs() [2/2]

bool ON_String::FormatVargs	(	const unsigned char *	format,
		va_list	args
	)

◆ FormatVargsIntoBuffer() [1/2]

static int ON_String::FormatVargsIntoBuffer	(	char *	buffer,
		size_t	buffer_capacity,
		const char *	format,
		va_list	args
	)

static

◆ FormatVargsIntoBuffer() [2/2]

static int ON_String::FormatVargsIntoBuffer	(	ON_StringBuffer &	buffer,
		const char *	format,
		va_list	args
	)

static

◆ FormatVargsOutputCount()

static int ON_String::FormatVargsOutputCount	(	const char *	format,
		va_list	args
	)

static

Returns: >= 0: Number of char elements in the formatted string, not including the null terminator. < 0: Invalid input

◆ FromNumber() [1/9]

static const ON_String ON_String::FromNumber ( char n )

static

It is common to format single numbers into strings and the FromNumber and FromDouble functions are the fastest way to do this and provide consistent results. They return a pointer to their buffer so the can be used as function parameters.

◆ FromNumber() [2/9]

static const ON_String ON_String::FromNumber ( double d )

static

Parameters

d	"%g" format

◆ FromNumber() [3/9]

static const ON_String ON_String::FromNumber ( int n )

static

◆ FromNumber() [4/9]

static const ON_String ON_String::FromNumber ( ON__INT64 n )

static

◆ FromNumber() [5/9]

static const ON_String ON_String::FromNumber ( ON__UINT64 n )

static

◆ FromNumber() [6/9]

static const ON_String ON_String::FromNumber ( short n )

static

◆ FromNumber() [7/9]

static const ON_String ON_String::FromNumber ( unsigned char n )

static

◆ FromNumber() [8/9]

static const ON_String ON_String::FromNumber ( unsigned int n )

static

◆ FromNumber() [9/9]

static const ON_String ON_String::FromNumber ( unsigned short n )

static

◆ GetAt()

char ON_String::GetAt ( int ) const

◆ Header()

class ON_aStringHeader* ON_String::Header ( ) const

protected

m_s - 12 bytes points at the string's ON_aStringHeader

implementation helpers

◆ HexadecimalFromBytes()

static const ON_String ON_String::HexadecimalFromBytes	(	const ON__UINT8 *	bytes,
		size_t	byte_count,
		bool	bCapitalDigits,
		bool	bReverse
	)

static

Description: Each byte value is converted to 2 hexadecimal digits. Parameters: bytes - [in] list of byte values byte_count - [in] Number of byte values in bytes[] array. bCapitalDigits - [in] false: Use 0-9, a - b true: Use 0-9, A - F bReverse - [in] false: The digits in the string will be in the order bytes[0], bytes[1], ..., bytes[byte_count-1]. true: The digits in the string will be in the order bytes[byte_count-1], ..., bytes[1], bytes[0].

◆ IncrementedHeader()

class ON_aStringHeader* ON_String::IncrementedHeader ( ) const

protected

◆ IsDecimalDigit()

static bool ON_String::IsDecimalDigit ( char c )

static

Parameters: c - [in] Returns: True if c is '0', '1', ..., or '9'.

◆ IsEmpty()

bool ON_String::IsEmpty ( ) const

returns true if length == 0

◆ IsHexDigit()

static bool ON_String::IsHexDigit ( char c )

static

Parameters: c - [in] Returns: True if c is '0', '1', ..., '9', 'A', 'B', ..., 'F', 'a', 'b', ..., of 'f'.

◆ IsNotEmpty()

bool ON_String::IsNotEmpty ( ) const

returns true if length > 0

◆ IsPossibleEncoding() [1/2]

bool ON_String::IsPossibleEncoding ( ON_String::Encoding encoding ) const

Description: Determine if the string's buffer can be parsed using the specified encoding.

◆ IsPossibleEncoding() [2/2]

static bool ON_String::IsPossibleEncoding	(	ON_String::Encoding	encoding,
		const char *	buffer,
		int	buffer_length
	)

static

Description: Determine if the buffer can be parsed using the specified encoding.

◆ IsReferenceCounted()

bool ON_String::IsReferenceCounted ( ) const

Returns: True if the string is reference counted.

◆ IsValid()

bool ON_String::IsValid ( bool bLengthTest ) const

Parameters: bLengthTest - [in] true (common case) If this->Length() != ON_wString::Length(static_cast<const wchar_t*)(this)), then this string is not valid. false (less common case) There may be null elements in the first this->Length()-1 chars. Returns: True - this is valid. False There is a serious memory corruption bug in your code. This was not valid and converted to ON_wString::EmptyString to prevent future crashes.

◆ Left()

ON_String ON_String::Left ( int ) const

◆ Length() [1/3]

int ON_String::Length ( ) const

Attributes & Operations.

Returns: number of char elements in string not including the null terminator.

◆ Length() [2/3]

static int ON_String::Length ( const char * string )

static

Returns: number of nonzero elements in string before the first null terminator. If string is nullptr, 0 is returned.

◆ Length() [3/3]

static int ON_String::Length	(	const char *	string,
		size_t	string_capacity
	)

static

Parameters: string_capacity - [in] number of elements that can be read in string[] array. Returns: number of nonzero elements in string before the first null terminator or string_capacity if no null terminator is in string[]. If string is nullptr, 0 is returned.

◆ MakeLower()

void ON_String::MakeLower ( )

ON_DEPRECATED

◆ MakeLowerOrdinal()

void ON_String::MakeLowerOrdinal ( )

◆ MakeReverse()

void ON_String::MakeReverse ( )

◆ MakeUpper()

void ON_String::MakeUpper ( )

upper/lower/reverse conversion

ON_DEPRECATED

◆ MakeUpperOrdinal()

void ON_String::MakeUpperOrdinal ( )

◆ MapCharacterOrdinal()

static char ON_String::MapCharacterOrdinal	(	ON_StringMapOrdinalType	map_type,
		char	c
	)

static

Description: Map a single byte UTF-8 element to upper or lower case. Parameters: c - [in] If c is in the range A to Z or a to z, the map specified by map_type is applied. All other values of c are unchanged.
Remarks: MapCharacterOrdinal is not appropriate for general string mapping.

◆ MapString() [1/3]

ON_String ON_String::MapString	(	const class ON_Locale &	locale,
		ON_StringMapType	map_type
	)		const

◆ MapString() [2/3]

static ON_String ON_String::MapString	(	const class ON_Locale &	locale,
		ON_StringMapType	map_type,
		const char *	string,
		int	element_count
	)

static

◆ MapString() [3/3]

static int ON_String::MapString	(	const class ON_Locale &	locale,
		ON_StringMapType	map_type,
		const char *	string,
		int	element_count,
		char *	mapped_string,
		int	mapped_string_capacity
	)

static

Description: Maps element_count elements of string[] to mapped_string[].

Parameters: locale - [in] Locale to use when converting case. It is common to pass one of the preset locales ON_Locale::Ordinal, ON_Locale::InvariantCulture, or ON_Locale::m_CurrentCulture.

map_type - [in] selects the mapping

string - [in] input string to map.

element_count - [in] The number of char elements to map from input string[].

If element_count < 1, then string[] must be null terminated and ON_wString::Length(string)+1 elements are mapped. The +1 insures the output is null terminated.

mapped_string - [out] The result of the mapping is returned in mapped_string[].

mapped_string_capacity - [in] Number of char elements available in mapped_string[] or 0 to calculate the minimum number of elements needed for the mapping.

Returns: If mapped_string_capacity > 0, then the number elements set in mapped_string[] is returned.

If mapped_string_capacity == 0, then the number elements required to perform the mapping is returned.

When there is room, mapped_string[] is null terminated.

0: Failure.

◆ MapStringOrdinal() [1/2]

ON_String ON_String::MapStringOrdinal ( ON_StringMapOrdinalType map_type ) const

◆ MapStringOrdinal() [2/2]

static int ON_String::MapStringOrdinal	(	ON_StringMapOrdinalType	map_type,
		const char *	string,
		int	element_count,
		char *	mapped_string,
		int	mapped_string_capacity
	)

static

Description: Map a wchar_t string. Parameters: map_type - [in] string - [in] element_count - [in] number of string[] elements to map. If element_count < 0, then ON_wString::Length(string) elements are mapped. mapped_string - [out] mapped_string_capacity - [in] number of available elements in mapped_string[]. map_type - [in] Returns: Number of mapped_string[] elements that were mapped from string[].

When the number of string[] input elements is >= mapped_string_capacity, mapped_string_capacity mapped_string[] elements are set and mapped_string_capacity is returned.

When the return value is < mapped_string_capacity, a null terminator is appended after the last mapped element.

◆ Mid() [1/2]

ON_String ON_String::Mid ( int ) const

◆ Mid() [2/2]

ON_String ON_String::Mid	(	int	,
		int
	)		const

simple sub-string extraction

◆ MultiByteDecode()

const ON_wString ON_String::MultiByteDecode ( int windows_code_page ) const

Description: Decode this char string using the encoding specified by windows_code_page to a UTF encoded wide character string. Parameters: windows_code_page - [in] WIndows code page. For example, big5 = 950. Returns: A UTF encoded wide character string. See Also: ON_wString::MultiByteEncode()

◆ operator const char *()

ON_String::operator const char * ( ) const

◆ operator+() [1/5]

ON_String ON_String::operator+ ( char ) const

◆ operator+() [2/5]

ON_String ON_String::operator+ ( const char * ) const

◆ operator+() [3/5]

ON_String ON_String::operator+ ( const ON_String & ) const

operator+()

◆ operator+() [4/5]

ON_String ON_String::operator+ ( const unsigned char * ) const

◆ operator+() [5/5]

ON_String ON_String::operator+ ( unsigned char ) const

◆ operator+=() [1/5]

const ON_String& ON_String::operator+= ( char )

◆ operator+=() [2/5]

const ON_String& ON_String::operator+= ( const char * )

◆ operator+=() [3/5]

const ON_String& ON_String::operator+= ( const ON_String & )

◆ operator+=() [4/5]

const ON_String& ON_String::operator+= ( const unsigned char * )

◆ operator+=() [5/5]

const ON_String& ON_String::operator+= ( unsigned char )

◆ operator=() [1/7]

ON_String& ON_String::operator= ( char )

◆ operator=() [2/7]

ON_String& ON_String::operator= ( const char * )

◆ operator=() [3/7]

ON_String& ON_String::operator= ( const ON_String & )

overloaded assignment

◆ operator=() [4/7]

ON_String& ON_String::operator= ( const ON_wString & src )

src = Wide char string, result is a UTF-8 string

◆ operator=() [5/7]

ON_String& ON_String::operator= ( const unsigned char * )

◆ operator=() [6/7]

ON_String& ON_String::operator= ( const wchar_t * src )

src = Wide char string, result is a UTF-8 string

◆ operator=() [7/7]

ON_String& ON_String::operator= ( unsigned char )

◆ operator[]() [1/2]

char& ON_String::operator[] ( int )

◆ operator[]() [2/2]

char ON_String::operator[] ( int ) const

◆ PreciseFromNumber()

static const ON_String ON_String::PreciseFromNumber ( double d )

static

Parameters

d "%.17g"

◆ ProbableEncoding() [1/2]

ON_String::Encoding ON_String::ProbableEncoding ( ) const

◆ ProbableEncoding() [2/2]

static ON_String::Encoding ON_String::ProbableEncoding	(	const char *	buffer,
		int	buffer_length
	)

static

◆ Remove()

int ON_String::Remove ( const char utf8_single_byte_c )

remove occurrences of chRemove

◆ Replace() [1/4]

int ON_String::Replace	(	char	utf8_single_byte_c1,
		char	utf8_single_byte_c2
	)

◆ Replace() [2/4]

int ON_String::Replace	(	const char *	token1,
		const char *	token2
	)

Description: Replace all substrings that match token1 with token2 Parameters: token1 - [in] token2 - [in] Returns: Number of times token1 was replaced with token2.

◆ Replace() [3/4]

int ON_String::Replace	(	const unsigned char *	token1,
		const unsigned char *	token2
	)

◆ Replace() [4/4]

int ON_String::Replace	(	unsigned char	utf8_single_byte_c1,
		unsigned char	utf8_single_byte_c2
	)

◆ ReserveArray()

char* ON_String::ReserveArray ( size_t )

Low level access to string contents as character array.

make sure internal array has at least

◆ Reverse() [1/2]

ON_String ON_String::Reverse ( ) const

◆ Reverse() [2/2]

static char* ON_String::Reverse	(	char *	string,
		int	element_count
	)

static

◆ ReverseFind() [1/4]

int ON_String::ReverseFind ( char utf8_single_byte_c ) const

◆ ReverseFind() [2/4]

int ON_String::ReverseFind ( const char * ) const

◆ ReverseFind() [3/4]

int ON_String::ReverseFind ( const unsigned char * ) const

◆ ReverseFind() [4/4]

int ON_String::ReverseFind ( unsigned char utf8_single_byte_c ) const

◆ Right()

ON_String ON_String::Right ( int ) const

◆ Scan() [1/2]

int ON_VARGS_FUNC_CDECL ON_String::Scan	(	const char *	format,
			...
	)

Parameters: format - [in] null terminated string to scan ... - [out] pointers to elements to assign. Returns: >= 0: number of fields successfully converted and assigned. <0: failure

◆ Scan() [2/2]

int ON_VARGS_FUNC_CDECL ON_String::Scan	(	const unsigned char *	format,
			...
	)

◆ ScanBuffer() [1/2]

static int ON_VARGS_FUNC_CDECL ON_String::ScanBuffer	(	const char *	buffer,
		const char *	format,
			...
	)

static

◆ ScanBuffer() [2/2]

static int ON_VARGS_FUNC_CDECL ON_String::ScanBuffer	(	const unsigned char *	buffer,
		const unsigned char *	format,
			...
	)

static

◆ ScanBufferVargs() [1/2]

static int ON_String::ScanBufferVargs	(	const char *	buffer,
		const char *	format,
		va_list	args
	)

static

◆ ScanBufferVargs() [2/2]

static int ON_String::ScanBufferVargs	(	const unsigned char *	buffer,
		const unsigned char *	format,
		va_list	args
	)

static

◆ SetAt() [1/2]

void ON_String::SetAt	(	int	,
		char
	)

◆ SetAt() [2/2]

void ON_String::SetAt	(	int	,
		unsigned char
	)

◆ SetLength()

char* ON_String::SetLength ( size_t )

set length (<=capacity)

◆ ShrinkArray()

void ON_String::ShrinkArray ( )

the requested capacity.

shrink internal storage to minimum size

◆ SizeOf()

unsigned int ON_String::SizeOf ( ) const

Returns: Total number of bytes of memory used by this class. (For use in ON_Object::SizeOf() overrides.

◆ SplitPath()

static void ON_String::SplitPath	(	const char *	path,
		ON_String *	drive,
		ON_String *	dir,
		ON_String *	fname,
		ON_String *	ext
	)

static

OBSOLETE - use ON_FileSystemPath::SplitPath

◆ ToBIG5() [1/2]

static const ON_String ON_String::ToBIG5	(	const char *	buffer,
		int	buffer_length,
		int *	error_count
	)

static

Description: Make an educated guess at the encoding and convert the string to BIG5 encoding. Parameters: error_count - [out] number of errors in encoding (question mark is used as a replacement character). Returns: If the string encoding could be determined and parsed, a BIG5 encoded string is returned. Otherwise EmptyString is returned.

◆ ToBIG5() [2/2]

const ON_String ON_String::ToBIG5 ( int * error_count ) const

Description: Make an educated guess at the encoding and convert the string to BIG5 encoding. Parameters: error_count - [out] number of errors in encoding (question mark is used as a replacement character). Returns: If the string encoding could be determined and parsed, a BIG5 encoded string is returned. Otherwise EmptyString is returned.

◆ ToNumber() [1/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		char	value_on_failure,
		char *	value
	)

static

Parameters: buffer - [in] decimal number Returns: not zero: pointer to the first character that was not scanned nullptr: failure

◆ ToNumber() [2/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		double	value_on_failure,
		double *	value
	)

static

◆ ToNumber() [3/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		int	value_on_failure,
		int *	value
	)

static

◆ ToNumber() [4/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		ON__INT64	value_on_failure,
		ON__INT64 *	value
	)

static

◆ ToNumber() [5/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		ON__UINT64	value_on_failure,
		ON__UINT64 *	value
	)

static

◆ ToNumber() [6/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		short	value_on_failure,
		short *	value
	)

static

◆ ToNumber() [7/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		unsigned char	value_on_failure,
		unsigned char *	value
	)

static

◆ ToNumber() [8/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		unsigned int	value_on_failure,
		unsigned int *	value
	)

static

◆ ToNumber() [9/9]

static const char* ON_String::ToNumber	(	const char *	buffer,
		unsigned short	value_on_failure,
		unsigned short *	value
	)

static

◆ ToUTF8() [1/2]

const ON_String ON_String::ToUTF8 ( ) const

Description: Make an educated guess at the encoding and convert the string to UTF-8 encoding. Returns: If the string encoding could be determined and parsed, a UTF-8 encoded string is returned. Otherwise EmptyString is returned.

◆ ToUTF8() [2/2]

static const ON_String ON_String::ToUTF8	(	const char *	buffer,
		int	buffer_length
	)

static

Description: Make an educated guess at the encoding and convert the string to UTF-8 encoding. Returns: If the string encoding could be determined and parsed, a UTF-8 encoded string is returned. Otherwise EmptyString is returned.

◆ TrimLeft()

void ON_String::TrimLeft ( const char * = nullptr )

◆ TrimLeftAndRight()

void ON_String::TrimLeftAndRight ( const char * = nullptr )

◆ TrimRight()

void ON_String::TrimRight ( const char * = nullptr )

◆ UnsignedLength() [1/2]

unsigned int ON_String::UnsignedLength ( ) const

Returns: number of char elements in string not including the null terminator.

◆ UnsignedLength() [2/2]

static unsigned int ON_String::UnsignedLength ( const char * string )

static

Returns: number of nonzero elements in string before the first null terminator. If string is nullptr, 0 is returned.

◆ WildCardMatch() [1/2]

bool ON_String::WildCardMatch ( const char * ) const

Description: Simple case sensitive wildcard matching. A question mark (?) in the pattern matches a single character. An asterisk (*) in the pattern matches zero or more occurrences of any character.

Parameters: pattern - [in] pattern string where ? and * are wild cards.

Returns: true if the string matches the wild card pattern.

◆ WildCardMatch() [2/2]

bool ON_String::WildCardMatch ( const unsigned char * ) const

◆ WildCardMatchNoCase() [1/2]

bool ON_String::WildCardMatchNoCase ( const char * ) const

Description: Simple case insensitive wildcard matching. A question mark (?) in the pattern matches a single character. An asterisk (*) in the pattern matches zero or more occurrences of any character.

Parameters: pattern - [in] pattern string where ? and * are wild cards.

Returns: true if the string matches the wild card pattern.

◆ WildCardMatchNoCase() [2/2]

bool ON_String::WildCardMatchNoCase ( const unsigned char * ) const

Member Data Documentation

◆ Ampersand

const char ON_String::Ampersand = (char)ON_UnicodeCodePoint::ON_Ampersand

static

AMPERSAND U+0026 (&)

◆ Apostrophe

const char ON_String::Apostrophe = (char)ON_UnicodeCodePoint::ON_Apostrophe

static

APOSTROPHE U+0027 (')

◆ Backslash

const char ON_String::Backslash = (char)ON_UnicodeCodePoint::ON_Backslash

static

REVERSE SOLIDUS U+005C (\)

◆ Backspace

const char ON_String::Backspace = (char)ON_UnicodeCodePoint::ON_Backspace

static

BACKSPACE control U+0008

◆ ByteOrderMark

const ON_String ON_String::ByteOrderMark

static

Even though a char string has endian independent byte order, it is valid for UTF-8 encoded text to begin with the UTF-8 encoding of U+FEFF. A UTF-8 BOM is sometimes used to mark a char string as UTF-8 encoded. A UTF-8 BOM can occur when UTF-16 and UTF-32 encoded text with a byte order mark is converted to UTF-8 encoded text. Conversely a UTF-8 BOM is sometimes used when UTF-8 encode text will be converted to UTF-16/UTF-32 encoded text and a BOM is desired in the result.

◆ CarriageReturn

const char ON_String::CarriageReturn = (char)ON_UnicodeCodePoint::ON_CarriageReturn

static

CARRIAGE RETURN control U+000D

◆ Colon

const char ON_String::Colon = (char)ON_UnicodeCodePoint::ON_Colon

static

COLON U+003A (:)

◆ Comma

const char ON_String::Comma = (char)ON_UnicodeCodePoint::ON_Comma

static

COMMA U+002C (,)

◆ DecimalAsComma

const char ON_String::DecimalAsComma = (char)ON_UnicodeCodePoint::ON_Comma

static

Comma decimal point (,)

◆ DecimalAsPeriod

const char ON_String::DecimalAsPeriod = (char)ON_UnicodeCodePoint::ON_Period

static

Period decimal point (.)

◆ Delete

const char ON_String::Delete = (char)ON_UnicodeCodePoint::ON_Delete

static

DELETE U+007F

◆ EmptyString

const ON_String ON_String::EmptyString

static

ON_String::EmptyString has length 0. const char* s = ON_String::EmptyString sets s = "";

◆ Escape

const char ON_String::Escape = (char)ON_UnicodeCodePoint::ON_Escape

static

ESCAPE control U+001B

◆ FormFeed

const char ON_String::FormFeed = (char)ON_UnicodeCodePoint::ON_FormFeed

static

FORM FEED control U+000C

◆ GreaterThanSign

const char ON_String::GreaterThanSign = (char)ON_UnicodeCodePoint::ON_GreaterThanSign

static

GREATER-THAN SIGN U+003E (>)

◆ HyphenMinus

const char ON_String::HyphenMinus = (char)ON_UnicodeCodePoint::ON_HyphenMinus

static

HYPHEN-MINUS U+002D (-)

◆ LessThanSign

const char ON_String::LessThanSign = (char)ON_UnicodeCodePoint::ON_LessThanSign

static

LESS-THAN SIGN U+003C (<)

◆ LineFeed

const char ON_String::LineFeed = (char)ON_UnicodeCodePoint::ON_LineFeed

static

LINE FEED control U+000A

◆ m_s

char* ON_String::m_s

protected

Implementation.

pointer to ref counted string array

◆ NumberSign

const char ON_String::NumberSign = (char)ON_UnicodeCodePoint::ON_NumberSign

static

NUMBER SIGN U+0023 (#)

◆ PercentSign

const char ON_String::PercentSign = (char)ON_UnicodeCodePoint::ON_PercentSign

static

PERCENT SIGN U+0025 (%)

◆ Period

const char ON_String::Period = (char)ON_UnicodeCodePoint::ON_Period

static

PERIOD U+002E (decimal 46) (.)

◆ Pipe

const char ON_String::Pipe = (char)ON_UnicodeCodePoint::ON_Pipe

static

VERTICAL LINE U+007C (|)

◆ QuotationMark

const char ON_String::QuotationMark = (char)ON_UnicodeCodePoint::ON_QuotationMark

static

QUOTATION MARK U+0022 (")

◆ Semicolon

const char ON_String::Semicolon = (char)ON_UnicodeCodePoint::ON_Semicolon

static

SEMICOLON U+003B (;)

◆ Slash

const char ON_String::Slash = (char)ON_UnicodeCodePoint::ON_Slash

static

SOLIDUS U+002F (/)

◆ Space

const char ON_String::Space = (char)ON_UnicodeCodePoint::ON_Space

static

SPACE U+0020

◆ Tab

const char ON_String::Tab = (char)ON_UnicodeCodePoint::ON_Tab

static

CHARACTER TABULATION control U+0009

◆ Tilde

const char ON_String::Tilde = (char)ON_UnicodeCodePoint::ON_Tilde

static

TILDE U+007E (~)

◆ Underscore

const char ON_String::Underscore = (char)ON_UnicodeCodePoint::ON_Underscore

static

///< Unicode LOW LINE U+005F (_)

◆ VerticalTab

const char ON_String::VerticalTab = (char)ON_UnicodeCodePoint::ON_VerticalTab

static

LINE TABULATION control U+000B

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ Encoding

Constructor & Destructor Documentation

◆ ON_String() [1/11]

◆ ON_String() [2/11]

◆ ON_String() [3/11]

◆ ON_String() [4/11]

◆ ON_String() [5/11]

◆ ON_String() [6/11]

◆ ON_String() [7/11]

◆ ON_String() [8/11]

◆ ON_String() [9/11]

◆ ON_String() [10/11]

◆ ON_String() [11/11]

◆ ~ON_String()

Member Function Documentation

◆ Append() [1/2]

◆ Append() [2/2]

◆ AppendToArray() [1/3]

◆ AppendToArray() [2/3]

◆ AppendToArray() [3/3]

◆ ApproximateFromNumber()

◆ Array() [1/2]

◆ Array() [2/2]

◆ Compare() [1/6]

◆ Compare() [2/6]

◆ Compare() [3/6]

◆ Compare() [4/6]

◆ Compare() [5/6]

◆ Compare() [6/6]

◆ CompareAttributeName() [1/2]

◆ CompareAttributeName() [2/2]

◆ CompareNoCase() [1/2]

◆ CompareNoCase() [2/2]

◆ CompareOrdinal() [1/4]

◆ CompareOrdinal() [2/4]

◆ CompareOrdinal() [3/4]

◆ CompareOrdinal() [4/4]

◆ ComparePath() [1/3]

◆ ComparePath() [2/3]

◆ ComparePath() [3/3]

◆ ContentHash()

◆ CopyArray()

◆ CopyToArray() [1/4]

◆ CopyToArray() [2/4]

◆ CopyToArray() [3/4]

◆ CopyToArray() [4/4]

◆ Create()

◆ CreateArray()

◆ DataCRC()

◆ Destroy()

◆ Duplicate()

◆ EmergencyDestroy()

◆ Empty()

◆ EnableReferenceCounting()

◆ Equal() [1/4]

◆ Equal() [2/4]

◆ Equal() [3/4]

◆ Equal() [4/4]

◆ EqualAttributeName() [1/2]

◆ EqualAttributeName() [2/2]

◆ EqualOrdinal() [1/4]

◆ EqualOrdinal() [2/4]

◆ EqualOrdinal() [3/4]

◆ EqualOrdinal() [4/4]

◆ EqualPath() [1/3]

◆ EqualPath() [2/3]

◆ EqualPath() [3/3]

◆ Find() [1/6]

◆ Find() [2/6]

◆ Find() [3/6]

◆ Find() [4/6]