Description:

template<typename TChar>
class alib::strings::TCString< TChar >

This class specializes its base class String in that respect that the character strings represented are guaranteed to be zero-terminated.
Zero-terminated strings are widely used by programming language C and are often called "C-strings", what gave the class its name.

See also: For an introduction into the ALib string classes see this module's Programmer's Manual.

Template Parameters

TChar The character type of this string.

Definition at line 34 of file strings/fwds.hpp.

#include <cstring.hpp>

Inheritance diagram for TCString< TChar >:

[legend]

Collaboration diagram for TCString< TChar >:

[legend]

Public Method Index:
constexpr	TCString ()
	Default constructor creating a 6.1 Nulled Strings "nulled" c-string.

constexpr	TCString (const TChar *pBuffer, integer contentLength)

template<typename TZTCharArray >
constexpr	TCString (const TTerminatable &src)

template<typename TAllocator , typename TEnableIf = typename TAllocator::ChainedAllocator>
	TCString (TAllocator &allocator, const TString< TChar > &copy)

template<typename TAllocator >
void	Allocate (TAllocator &allocator, const TString< TChar > &copy)

template<typename TAllocator >
void	Free (TAllocator &allocator) const

template<lang::Inclusion TInclusion, typename TCheck = CHK>
integer	IndexOfAny (const TCString &needles, integer startIdx=0) const

template<typename TZTCharArray >
	operator TZTCharArray () const

template<typename TZTCharArray >
	operator TZTCharArray () const

TChar	operator[] (integer op) const

Public Method Index: inherited from TString< TChar >
constexpr	TString () noexcept=default
	Defaulted default constructor.

constexpr	TString (const TChar *pBuffer, integer pLength) noexcept

template<typename TCharArray >
constexpr	TString (const TCharArray &src)

constexpr	TString (const TString &) noexcept=default
	Defaulted copy constructor.

	TString (ConstIterator &start, ConstIterator &end)

template<typename TAllocator , typename TEnableIf = typename TAllocator::ChainedAllocator>
	TString (TAllocator &allocator, const TString< TChar > &copy)

constexpr	TString (TString &&) noexcept=default
	Defaulted move constructor.

template<typename TCharArray >
	operator TCharArray () const

template<typename TCharArray >
	operator TCharArray () const

TString &	operator= (const TString &) noexcept=default

TString &	operator= (TString &&) noexcept=default

constexpr const TChar *	Buffer () const

constexpr integer	Length () const

integer	WStringLength () const

constexpr bool	IsNull () const

constexpr bool	IsNotNull () const

constexpr bool	IsEmpty () const

constexpr bool	IsNotEmpty () const

template<typename TCheck = CHK>
TString< TChar >	Substring (integer regionStart, integer regionLength=MAX_LEN) const

template<typename TCheck = CHK>
TChar	CharAt (integer idx) const

template<typename TCheck = CHK>
TChar	CharAtStart () const

template<typename TCheck = CHK>
TChar	CharAtEnd () const

TChar	operator[] (integer idx) const

std::size_t	Hashcode () const

std::size_t	HashcodeIgnoreCase () const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
bool	Equals (const TString< TChar > &rhs) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
int	CompareTo (const TString< TChar > &rhs) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
int	CompareTo (const TString &rhs, integer rhsRegionStart, integer rhsRegionLength=MAX_LEN) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
int	CompareTo (const TString &rhs, integer rhsRegionStart, integer rhsRegionLength, integer regionStart, integer regionLength=MAX_LEN) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
bool	ContainsAt (const TString &needle, integer pos) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
bool	StartsWith (const TString &needle) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
bool	EndsWith (const TString &needle) const

template<typename TCheck = CHK>
integer	IndexOf (TChar needle, integer startIdx=0) const

template<typename TCheck = CHK>
integer	IndexOf (TChar needle, integer regionStart, integer regionLength) const

integer	IndexOfOrLength (TChar needle) const

template<typename TCheck = CHK>
ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE integer	IndexOfOrLength (TChar needle, integer startIdx) const

template<typename TCheck = CHK>
ALIB_WARNINGS_RESTORE integer	LastIndexOf (TChar needle, integer startIndex=MAX_LEN) const

template<lang::Inclusion TInclusion, typename TCheck = CHK>
integer	IndexOfAny (const TString &needles, integer startIdx=0) const

template<lang::Inclusion TInclusion, typename TCheck = CHK>
integer	LastIndexOfAny (const TString &needles, integer startIdx=MAX_LEN) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
integer	IndexOf (const TString &needle, integer startIdx=0, integer endIdx=strings::MAX_LEN) const

template<typename TCheck = CHK>
integer	IndexOfFirstDifference (const TString &needle, lang::Case sensitivity=lang::Case::Sensitive, integer startIdx=0) const

integer	IndexOfSegmentEnd (TChar opener, TChar closer, integer idx) const

template<typename TCheck = CHK>
integer	CountChar (TChar needle, integer startPos=0) const

template<typename TCheck = CHK>
integer	CountChar (TChar needle, TChar omit, integer startPos) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
integer	Count (const TString &needle, integer startPos=0) const

template<typename TCheck = CHK, lang::Case TSensitivity = lang::Case::Sensitive>
integer	Count (const TString &needle, const TString &omit, integer startPos=0) const

ALIB_API uint64_t	ParseDecDigits (integer startIdx=0, integer *newIdx=nullptr) const

ALIB_API int64_t	ParseInt (integer startIdx=0, TNumberFormat< TChar > numberFormat=nullptr, integer newIdx=nullptr) const

int64_t	ParseInt (TNumberFormat< TChar > numberFormat, integer newIdx=nullptr) const

int64_t	ParseInt (integer *newIdx) const

int64_t	ParseInt (integer startIdx, integer *newIdx) const

ALIB_API uint64_t	ParseDec (integer startIdx=0, TNumberFormat< TChar > numberFormat=nullptr, integer newIdx=nullptr) const

uint64_t	ParseDec (TNumberFormat< TChar > numberFormat, integer newIdx=nullptr) const

uint64_t	ParseDec (integer *newIdx) const

uint64_t	ParseDec (integer startIdx, integer *newIdx) const

ALIB_API uint64_t	ParseBin (integer startIdx=0, TNumberFormat< TChar > numberFormat=nullptr, integer newIdx=nullptr) const

uint64_t	ParseBin (TNumberFormat< TChar > numberFormat, integer newIdx=nullptr) const

uint64_t	ParseBin (integer *newIdx) const

uint64_t	ParseBin (integer startIdx, integer *newIdx) const

ALIB_API uint64_t	ParseHex (integer startIdx=0, TNumberFormat< TChar > numberFormat=nullptr, integer newIdx=nullptr) const

uint64_t	ParseHex (TNumberFormat< TChar > numberFormat, integer newIdx=nullptr) const

uint64_t	ParseHex (integer *newIdx) const

uint64_t	ParseHex (integer startIdx, integer *newIdx) const

ALIB_API uint64_t	ParseOct (integer startIdx=0, TNumberFormat< TChar > numberFormat=nullptr, integer newIdx=nullptr) const

uint64_t	ParseOct (TNumberFormat< TChar > numberFormat, integer newIdx=nullptr) const

uint64_t	ParseOct (integer *newIdx) const

uint64_t	ParseOct (integer startIdx, integer *newIdx) const

ALIB_API double	ParseFloat (integer startIdx=0, TNumberFormat< TChar > numberFormat=nullptr, integer newIdx=nullptr) const

double	ParseFloat (TNumberFormat< TChar > numberFormat, integer newIdx=nullptr) const

double	ParseFloat (integer *newIdx) const

double	ParseFloat (integer startIdx, integer *newIdx) const

integer	CopyTo (TChar *dest) const

template<typename TAllocator >
void	Allocate (TAllocator &allocator, const TString< TChar > &copy)

template<typename TAllocator >
void	Free (TAllocator &allocator)

ConstIterator	begin () const

ConstIterator	cbegin () const

ALIB_WARNINGS_ALLOW_UNSAFE_BUFFER_USAGE ConstIterator	end () const

ConstIterator	cend () const

ALIB_WARNINGS_RESTORE ConstReverseIterator	rbegin () const

ConstReverseIterator	rend () const

ConstReverseIterator	crbegin () const

ConstReverseIterator	crend () const

bool	AdjustRegion (integer &regionStart, integer &regionLength) const

Protected Type Index:
using	base = TString<TChar>
	Shortcut to the base type.

Additional Inherited Members
Public Type Index: inherited from TString< TChar >
using	CharType = TChar
	Expose template parameter TChar to the outer world.

using	ConstIterator = TRandomAccessIterator<const TChar>

using	ConstReverseIterator = std::reverse_iterator<ConstIterator>

Protected Field Index: inherited from TString< TChar >
const TChar *	buffer

integer	length

Protected Method Index: inherited from TString< TChar >
template<lang::Case TSensitivity = lang::Case::Sensitive>
ALIB_API integer	indexOfString (const TString &needle, integer startIdx, integer endIdx) const

Type Definition Details:

◆ base

template<typename TChar >

using base = TString<TChar>

protected

Shortcut to the base type.

Definition at line 39 of file cstring.hpp.

Constructor(s) / Destructor Details:

◆ TCString() [1/4]

template<typename TChar >

TCString ( )

inlineconstexpr

Default constructor creating a 6.1 Nulled Strings "nulled" c-string.

Definition at line 47 of file cstring.hpp.

◆ TCString() [2/4]

template<typename TChar >

TCString	(	const TChar *	pBuffer,
		integer	contentLength )

inlineexplicitconstexpr

Constructor accepting a pointer to a character array and a string length.

Note: It is a user's responsibility to ensure that the character array provided includes a terminating '\0' character.
In debug-compilations a run-time assertion is raised if the provided buffer is not zero-terminated.

Parameters

pBuffer	The buffer to use.
contentLength	The length of the content in the given buffer.

Definition at line 66 of file cstring.hpp.

Here is the call graph for this function:

◆ TCString() [3/4]

template<typename TChar >

template<typename TZTCharArray >

TCString ( const TTerminatable & src )

inlineconstexpr

This templated constructor accepts various different kinds of source data. Unlike this documentation suggests, this constructor is internally implemented by a series of different constructors which are selected using template meta programming (i.e., std::enable_if).

Together, the set of constructors provide maximum flexibility by allowing implicit construction with (and assignment of) any built-in or third-party character array type. Some of the constructors are defined using keyword explict.

In debug-compilations a run-time assertion is raised if the provided buffer is not zero-terminated.

See also: More information about construction of this type is provided with chapter 3.1.2 CString Construction of the Programmer's Manual of module ALib Strings.

Template Parameters

TZTCharArray Type that comprises a zero-terminated character array.

Parameters

src	The source object.

◆ TCString() [4/4]

template<typename TChar >

template<typename TAllocator , typename TEnableIf = typename TAllocator::ChainedAllocator>

TCString	(	TAllocator &	allocator,
		const TString< TChar > &	copy )

inline

Allocates memory including a termination character, copies the given string's contents and zero-terminates this string.

See also: Methods Allocate and Free for information how to use allocated string objects.

Template Parameters

TAllocator The type of the given allocator, as prototyped with Allocator. Deduced by the compiler.

Parameters

allocator	The allocator to use.
copy	The string to copy to the new memory allocated.

Definition at line 301 of file cstring.hpp.

Here is the call graph for this function:

Method Details:

◆ Allocate()

template<typename TChar >

template<typename TAllocator >

void Allocate	(	TAllocator &	allocator,
		const TString< TChar > &	copy )

inline

Sets this object to a zero-terminated copy of the given string, allocated in given allocator.

Note: In case given copy is empty or nulled, no allocation is performed and this string is set to empty. Still the pointer to the buffer is copied. Thus, this string behaves in respect to method IsNull the same as given string copy.

Template Parameters

TAllocator The type of the given allocator, as prototyped with Allocator. Deduced by the compiler.

Parameters

allocator	The allocator to use.
copy	The string to copy to the new memory allocated.

Definition at line 423 of file cstring.hpp.

Here is the call graph for this function:

◆ Free()

template<typename TChar >

template<typename TAllocator >

void Free ( TAllocator & allocator ) const

inline

Deallocates this String's memory in allocator and sets this instance to nulled.

Note

In case this instance is empty or nulled, no de-allocation is performed. This should not happen with due usage. Due usage is:

A string is allocated using method Allocate on another instance.
For the allocated string, this method is to be called, passing the same allocator.

Nevertheless, because of the fact that method Allocate likewise does not allocate in case an empty string was given, it is still good use to allocate and deallocate empty strings.

Template Parameters

TAllocator The type of the given allocator, as prototyped with Allocator. Deduced by the compiler.

Parameters

allocator The allocator to use.

Definition at line 452 of file cstring.hpp.

◆ IndexOfAny()

template<typename TChar >

template<lang::Inclusion TInclusion, typename TCheck = CHK>

integer IndexOfAny	(	const TCString< TChar > &	needles,
		integer	startIdx = 0 ) const

inline

Returns the index of the first character which is included, respectively not included in a given set of characters.

This method searches forwards. For backwards search, see String::LastIndexOfAny.

Note

This method overrides method String::IndexOf. This implementation however expects a CString with parameter needles (beside the fact that it has to be invoked on a CString itself). If no zero-terminated needle string is available, the parent's original method needs to be invoked. This has to be done by explicitly naming the parent class in the invocation, like for example in

   myCString.TString::IndexOfAny<Inclusion::Include>( myString );

On most platforms, this zero-terminated version should perform slightly faster than the original method in class String.

Template Parameters

TCheck	Defaults to CHK, which is the normal invocation mode. If `<false>` is added to the method name, no parameter checks are performed and the needles must not be empty.
TInclusion	Denotes whether the search returns the first index that holds a value that is included or that is not excluded in the set of needle characters.

Parameters

needles	Set of characters to be taken into account.
startIdx	The index to start the search at. If the given value is less than `0`, it is set to `0`. If it exceeds the length of the string, the length of the string is returned. Defaults to `0`.

Returns: The index of the first character found which is included, respectively not included, in the given set of characters. If nothing is found, -1 is returned.

Definition at line 376 of file cstring.hpp.

Here is the call graph for this function:

◆ operator TZTCharArray() [1/2]

template<typename TChar >

template<typename TZTCharArray >

operator TZTCharArray ( ) const

inline

Implicit cast operator to objects of type TZTCharArray.
This operator is available for all custom types that have an accordingly specialized version of TMP struct T_CharArray and/or T_ZTCharArray defined.

See also: More information about casting ALib string-types to built-in C++ types or custom types is provided with chapter 3.2.2 Casting From CString of the Programmer's Manual of module ALib Strings.

Template Parameters

TZTCharArray The custom type to implicitly convert this object to.

Returns: A value of custom string-type.

Definition at line 123 of file cstring.hpp.

◆ operator TZTCharArray() [2/2]

template<typename TChar >

template<typename TZTCharArray >

operator TZTCharArray ( ) const

inlineexplicit

Explicit cast operator to objects of type TZTCharArray.
This operator is available for all custom types that have an accordingly specialized version of TMP struct T_CharArray and/or T_ZTCharArray defined.

See also: More information about casting ALib string-types to built-in C++ types or custom types is provided with chapter 3.2.2 Casting From CString of the Programmer's Manual of module ALib Strings.

Template Parameters

TZTCharArray The custom type to explicitly convert this object to.

Returns: A value of custom string-type.

Definition at line 142 of file cstring.hpp.

◆ operator[]()

template<typename TChar >

TChar operator[] ( integer op ) const

inline

Reads a character at a given index.
Overrides String::operator[] to change the debug assertion to allow inclusion of the termination character.

Attention: No parameter check is performed (other than an assertions in debug-compilation of ALib). See String::operator[] for details.

Parameters

op	The index of the character within this object's buffer.

Returns: If the character contained at index op.

Definition at line 329 of file cstring.hpp.

The documentation for this class was generated from the following files:

Description:

Public Method Index:

Protected Type Index:

Additional Inherited Members

Type Definition Details:

◆ base

Constructor(s) / Destructor Details:

◆ TCString() [1/4]

◆ TCString() [2/4]

◆ TCString() [3/4]

◆ TCString() [4/4]

Method Details:

◆ Allocate()

◆ Free()

◆ IndexOfAny()

◆ operator TZTCharArray() [1/2]

◆ operator TZTCharArray() [2/2]

◆ operator[]()