Buffer to accumulate string part by part. This type can be allocated either in stack as value type or in heap using System::MakeObject() function. Once the object is allocated, never mix up these two usecases: having SmartPtr pointers onto stack-allocated objects is strictly prohibited. More...

#include <string_builder.h>

Inherits System::Object.

Public Member Functions
	StringBuilder ()
	Constructor. More...

	StringBuilder (int capacity)
	Constructor. More...

	StringBuilder (const String &str)
	Constructor. More...

	StringBuilder (const String &value, int capacity)
	Constructor. More...

	StringBuilder (const String &value, int startIndex, int length, int capacity)
	Constructor. More...

	~StringBuilder ()
	Destructor. More...

int	get_Length () const
	Gets length of string currently in builder. More...

void	set_Length (int len)
	Trunkates or extends string builder to specified length. More...

int	get_Capacity () const
	Gets current capacity of string builder. More...

void	set_Capacity (int capacity)
	Sets current capacity of string builder. More...

char_t	operator[] (int index) const
	Gets character at specified position. More...

char_t	idx_get (int index) const
	Gets character at specified position. More...

void	idx_set (int index, char_t c)
	Sets character at specified position. More...

StringBuilder *	Append (char_t c)
	Adds character to builder. More...

StringBuilder *	Append (char_t c, int count)
	Adds characters to builder. More...

StringBuilder *	Append (const ArrayPtr< char_t > &arr)
	Adds characters array to builder. More...

StringBuilder *	Append (const ArrayPtr< char_t > &arr, int startIndex, int charCount)
	Adds characters array slice to builder. More...

StringBuilder *	Append (const String &str)
	Adds string to builder. More...

StringBuilder *	Append (const String &str, int startIndex, int charCount)
	Adds string slice to builder. More...

template<class T >
StringBuilder *	Append (const SharedPtr< T > &obj)
	Adds object's string representation to builder. More...

StringBuilder *	Append (const SharedPtr< StringBuilder > &builder)
	Adds builder's content to builder. More...

StringBuilder *	Append (float f)
	Adds floating point value to builder. More...

StringBuilder *	Append (double df)
	Adds floating point value to builder. More...

StringBuilder *	Append (int i)
	Adds integer value to builder. More...

template<typename T >
std::enable_if< std::is_arithmetic< T >::value, StringBuilder * >::type	Append (T value)
	Adds arithmetic value to builder. More...

template<class E >
std::enable_if< std::is_enum< E >::value, StringBuilder * >::type	Append (E e)
	Adds enum value string representation to builder. More...

template<class... TArgs>
StringBuilder *	AppendFormat (const String &format, const TArgs &... args)
	Appends formated string to builder. More...

template<class... TArgs>
StringBuilder *	AppendFormat (const SharedPtr< IFormatProvider > &fp, const String &format, const TArgs &... args)
	Appends formated string to builder. More...

StringBuilder *	AppendLine ()
	Appends new line character to builder. More...

StringBuilder *	AppendLine (const String &str)
	Appends string followed by new line character to builder. More...

StringBuilder *	Clear ()
	Removes all characters from the builder. More...

StringBuilder *	Insert (int startIndex, const String &str)
	Inserts string into builder's fixed position. More...

StringBuilder *	Insert (int32_t index, const String &value, int32_t count)
	Inserts repeated string into builder's fixed position. More...

StringBuilder *	Insert (int startIndex, char_t ch)
	Inserts character into builder's fixed position. More...

StringBuilder *	Insert (int index, const System::ArrayPtr< char_t > &chars, int startIndex, int charCount)
	Inserts characters into builder's fixed position. More...

template<typename T >
std::enable_if< std::is_arithmetic< T >::value, StringBuilder * >::type	Insert (int startIndex, T value)
	Inserts value into builder's fixed position. More...

StringBuilder *	Replace (const String &oldString, const String &newString)
	Replaces substring through the builder. More...

StringBuilder *	Replace (const String &oldString, const String &newString, int position, int count)
	Replaces substring through the builder's range. More...

StringBuilder *	Replace (char_t oldChar, char_t newChar)
	Replaces character through the builder. More...

StringBuilder *	Replace (char_t oldChar, char_t newChar, int startIndex, int count)
	Replaces character through the builder's range. More...

StringBuilder *	Remove (int startIndex, int length)
	Removes fragment from builder. More...

String	ToString () const override
	Gets string currently contained in builder. More...

String	ToString (int startIndex, int length) const
	Gets substring currently contained in builder. More...

void	CopyTo (int sourceIndex, System::ArrayPtr< char_t > const &destination, int destinationIndex, int count)
	Copies builder's data into existing array positions. More...

Public Member Functions inherited from System::Object
	Object ()
	Creates object. Initializes all internal data structures. More...

virtual	~Object ()
	Destroys object. Frees all internal data structures. More...

	Object (Object const &x)
	Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	SharedRefRemovedSafe ()
	Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

int	RemovedSharedRefs (int count)
	Decreases shared reference count by specified value. More...

Detail::SmartPtrCounter *	WeakRefAdded ()
	Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

void	WeakRefRemoved ()
	Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...

Detail::SmartPtrCounter *	GetCounter ()
	Gets reference counter data structure associated with the object. More...

int	SharedCount () const
	Gets current value of shared reference counter. More...

void	Lock ()
	Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...

void	Unlock ()
	Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...

virtual bool	Equals (ptr obj)
	Compares objects using C# Object.Equals semantics. More...

virtual int32_t	GetHashCode () const
	Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...

virtual String	ToString () const
	Analog of C# Object.ToString() method. Enables converting custom objects to string. More...

virtual ptr	MemberwiseClone () const
	Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...

virtual const TypeInfo &	GetType () const
	Gets actual type of object. Analog of C# System.Object.GetType() call. More...

virtual bool	Is (const TypeInfo &targetType) const
	Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...

virtual void	SetTemplateWeakPtr (uint32_t argument)
	Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...

virtual bool	FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
	For internal purposes only. More...

template<>
bool	ReferenceEquals (String const &str, std::nullptr_t)
	Specialization of Object::ReferenceEquals for case of string and nullptr. More...

template<>
bool	ReferenceEquals (String const &str1, String const &str2)
	Specialization of Object::ReferenceEquals for case of strings. More...

Additional Inherited Members
Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	Alias for smart pointer type. More...

Static Public Member Functions inherited from System::Object
static bool	ReferenceEquals (ptr const &objA, ptr const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, T const &objB)
	Compares objects by reference. More...

template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type	ReferenceEquals (T const &objA, std::nullptr_t)
	Reference-compares value type object with nullptr. More...

template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares reference type objects in C# style. More...

template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type	Equals (T1 const &objA, T2 const &objB)
	Compares value type objects in C# style. More...

static const TypeInfo &	Type ()
	Implements C# typeof(System.Object) construct. More...

template<>
bool	Equals (float const &objA, float const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

template<>
bool	Equals (double const &objA, double const &objB)
	Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...

Detailed Description

Buffer to accumulate string part by part. This type can be allocated either in stack as value type or in heap using System::MakeObject() function. Once the object is allocated, never mix up these two usecases: having SmartPtr pointers onto stack-allocated objects is strictly prohibited.

Constructor & Destructor Documentation

◆ StringBuilder() [1/5]

System::Text::StringBuilder::StringBuilder ( )

Constructor.

◆ StringBuilder() [2/5]

System::Text::StringBuilder::StringBuilder ( int capacity )

Constructor.

Parameters

capacity Initial string capacity.

◆ StringBuilder() [3/5]

System::Text::StringBuilder::StringBuilder ( const String & str )

Constructor.

Parameters

str	Initial value.

◆ StringBuilder() [4/5]

System::Text::StringBuilder::StringBuilder	(	const String &	value,
		int	capacity
	)

Constructor.

Parameters

value	Initial value.
capacity	Initial string capacity.

◆ StringBuilder() [5/5]

System::Text::StringBuilder::StringBuilder	(	const String &	value,
		int	startIndex,
		int	length,
		int	capacity
	)

Constructor.

Parameters

value	Initial value.
startIndex	Index of initial value slice beginning.
length	Initial value slice length.
capacity	Initial string capacity.

◆ ~StringBuilder()

System::Text::StringBuilder::~StringBuilder ( )

Destructor.

Member Function Documentation

◆ Append() [1/13]

StringBuilder * System::Text::StringBuilder::Append ( char_t c )

Adds character to builder.

Parameters

c	Character value.

Returns: This pointer.

◆ Append() [2/13]

StringBuilder * System::Text::StringBuilder::Append	(	char_t	c,
		int	count
	)

Adds characters to builder.

Parameters

c	Character value.
count	How many times to repeat insertee character.

Returns: This pointer.

◆ Append() [3/13]

StringBuilder * System::Text::StringBuilder::Append ( const ArrayPtr< char_t > & arr )

Adds characters array to builder.

Parameters

arr	Characters to add.

Returns: This pointer.

◆ Append() [4/13]

StringBuilder * System::Text::StringBuilder::Append	(	const ArrayPtr< char_t > &	arr,
		int	startIndex,
		int	charCount
	)

Adds characters array slice to builder.

Parameters

arr	Characters to add.
startIndex	Slice beginning index.
charCount	Slice length.

Returns: This pointer.

◆ Append() [5/13]

StringBuilder * System::Text::StringBuilder::Append ( const SharedPtr< StringBuilder > & builder )

Adds builder's content to builder.

Parameters

builder Builder to add content from.

Returns: This pointer.

◆ Append() [6/13]

template<class T >

StringBuilder * System::Text::StringBuilder::Append ( const SharedPtr< T > & obj )

inline

Adds object's string representation to builder.

Template Parameters

T	Object type.

Parameters

obj	Object to serialize and add.

Returns: This pointer.

◆ Append() [7/13]

StringBuilder * System::Text::StringBuilder::Append ( const String & str )

Adds string to builder.

Parameters

str	String to add.

Returns: This pointer.

◆ Append() [8/13]

StringBuilder * System::Text::StringBuilder::Append	(	const String &	str,
		int	startIndex,
		int	charCount
	)

Adds string slice to builder.

Parameters

str	String to add.
startIndex	Slice beginning index.
charCount	Slice length.

Returns: This pointer.

◆ Append() [9/13]

StringBuilder * System::Text::StringBuilder::Append ( double df )

Adds floating point value to builder.

Parameters

df	Value to serialize and add.

Returns: This pointer.

◆ Append() [10/13]

template<class E >

std::enable_if< std::is_enum< E >::value, StringBuilder * >::type System::Text::StringBuilder::Append ( E e )

inline

Adds enum value string representation to builder.

Template Parameters

E	Enum type.

Parameters

e	Value to serialize and add.

Returns: This pointer.

◆ Append() [11/13]

StringBuilder * System::Text::StringBuilder::Append ( float f )

Adds floating point value to builder.

Parameters

f	Value to serialize and add.

Returns: This pointer.

◆ Append() [12/13]

StringBuilder * System::Text::StringBuilder::Append ( int i )

Adds integer value to builder.

Parameters

i	Value to serialize and add.

Returns: This pointer.

◆ Append() [13/13]

template<typename T >

std::enable_if< std::is_arithmetic< T >::value, StringBuilder * >::type System::Text::StringBuilder::Append ( T value )

inline

Adds arithmetic value to builder.

Template Parameters

T	Arithmetic type.

Parameters

value Value to serialize and add.

Returns: This pointer.

◆ AppendFormat() [1/2]

template<class... TArgs>

StringBuilder * System::Text::StringBuilder::AppendFormat	(	const SharedPtr< IFormatProvider > &	fp,
		const String &	format,
		const TArgs &...	args
	)

inline

Appends formated string to builder.

Template Parameters

TArgs Arguments type.

Parameters

fp	Format provider; ignored.
format	Format string.
args	Arguments to insert into format string positions.

Returns: This pointer.

◆ AppendFormat() [2/2]

template<class... TArgs>

StringBuilder * System::Text::StringBuilder::AppendFormat	(	const String &	format,
		const TArgs &...	args
	)

inline

Appends formated string to builder.

Template Parameters

TArgs Arguments type.

Parameters

format	Format string.
args	Arguments to insert into format string positions.

Returns: This pointer.

◆ AppendLine() [1/2]

StringBuilder * System::Text::StringBuilder::AppendLine ( )

Appends new line character to builder.

Returns: This pointer.

◆ AppendLine() [2/2]

StringBuilder * System::Text::StringBuilder::AppendLine ( const String & str )

Appends string followed by new line character to builder.

Parameters

str	String to add.

Returns: This pointer.

◆ Clear()

StringBuilder * System::Text::StringBuilder::Clear ( )

Removes all characters from the builder.

Returns: This pointer.

◆ CopyTo()

void System::Text::StringBuilder::CopyTo	(	int	sourceIndex,
		System::ArrayPtr< char_t > const &	destination,
		int	destinationIndex,
		int	count
	)

Copies builder's data into existing array positions.

Parameters

sourceIndex	Index in builder to start copying from.
destination	Destination array.
destinationIndex	Index in destination array to start insertion at.
count	Number of characters to copy.

◆ get_Capacity()

int System::Text::StringBuilder::get_Capacity ( ) const

Gets current capacity of string builder.

Returns: Number of allocated characters.

◆ get_Length()

int System::Text::StringBuilder::get_Length ( ) const

Gets length of string currently in builder.

Returns: Number of characters currently stored in builder.

◆ idx_get()

char_t System::Text::StringBuilder::idx_get ( int index ) const

Gets character at specified position.

Parameters

index Position in builder.

Returns: Character at specified position.

◆ idx_set()

void System::Text::StringBuilder::idx_set	(	int	index,
		char_t	c
	)

Sets character at specified position.

Parameters

index	Position in builder.
c	Character to set.

◆ Insert() [1/5]

StringBuilder * System::Text::StringBuilder::Insert	(	int	index,
		const System::ArrayPtr< char_t > &	chars,
		int	startIndex,
		int	charCount
	)

Inserts characters into builder's fixed position.

Parameters

index	Position to insert characters into.
chars	Array to insert slice from.
startIndex	Array slice beginning index.
charCount	Array slice length.

Returns: This pointer.

◆ Insert() [2/5]

StringBuilder * System::Text::StringBuilder::Insert	(	int	startIndex,
		char_t	ch
	)

Inserts character into builder's fixed position.

Parameters

startIndex	Position to insert characters into.
ch	Character to insert.

Returns: This pointer.

◆ Insert() [3/5]

StringBuilder * System::Text::StringBuilder::Insert	(	int	startIndex,
		const String &	str
	)

Inserts string into builder's fixed position.

Parameters

startIndex	Position to insert characters into.
str	String to insert.

Returns: This pointer.

◆ Insert() [4/5]

template<typename T >

std::enable_if< std::is_arithmetic< T >::value, StringBuilder * >::type System::Text::StringBuilder::Insert	(	int	startIndex,
		T	value
	)

inline

Inserts value into builder's fixed position.

Template Parameters

Parameter type.

Parameters

startIndex	Position to insert characters into.
value	Value to format and insert.

Returns: This pointer.

◆ Insert() [5/5]

StringBuilder * System::Text::StringBuilder::Insert	(	int32_t	index,
		const String &	value,
		int32_t	count
	)

Inserts repeated string into builder's fixed position.

Parameters

index	Position to insert characters into.
value	String to insert.
count	How many times to repeat `value` string.

Returns: This pointer.

◆ operator[]()

char_t System::Text::StringBuilder::operator[] ( int index ) const

Gets character at specified position.

Parameters

index Position in builder.

Returns: Character at specified position.

◆ Remove()

StringBuilder * System::Text::StringBuilder::Remove	(	int	startIndex,
		int	length
	)

Removes fragment from builder.

Parameters

startIndex	Deletion range beginning index.
length	Number of characters to remove.

Returns: This pointer.

◆ Replace() [1/4]

StringBuilder * System::Text::StringBuilder::Replace	(	char_t	oldChar,
		char_t	newChar
	)

Replaces character through the builder.

Parameters

oldChar	Character to replace.
newChar	Replacement character.

Returns: This pointer.

◆ Replace() [2/4]

StringBuilder * System::Text::StringBuilder::Replace	(	char_t	oldChar,
		char_t	newChar,
		int	startIndex,
		int	count
	)

Replaces character through the builder's range.

Parameters

oldChar	Character to replace.
newChar	Replacement character.
startIndex	Builder's replacement range beginning position.
count	Builder's replacement range length.

Returns: This pointer.

◆ Replace() [3/4]

StringBuilder * System::Text::StringBuilder::Replace	(	const String &	oldString,
		const String &	newString
	)

Replaces substring through the builder.

Parameters

oldString	String to replace.
newString	Replacement string.

Returns: This pointer.

◆ Replace() [4/4]

StringBuilder * System::Text::StringBuilder::Replace	(	const String &	oldString,
		const String &	newString,
		int	position,
		int	count
	)

Replaces substring through the builder's range.

Parameters

oldString	String to replace.
newString	Replacement string.
position	Builder's replacement range beginning position.
count	Builder's replacement range length.

Returns: This pointer.

◆ set_Capacity()

void System::Text::StringBuilder::set_Capacity ( int capacity )

Sets current capacity of string builder.

Parameters

capacity Maximum number of characters that can be contained in the memory allocated by the current instance.

◆ set_Length()

void System::Text::StringBuilder::set_Length ( int len )

Trunkates or extends string builder to specified length.

Parameters

len	Length to set.

◆ ToString() [1/2]

String System::Text::StringBuilder::ToString ( ) const

overridevirtual

Gets string currently contained in builder.

Returns: String representation of builder's data.

Reimplemented from System::Object.

◆ ToString() [2/2]

String System::Text::StringBuilder::ToString	(	int	startIndex,
		int	length
	)		const

Gets substring currently contained in builder.

Parameters

startIndex	Extraction range beginning index.
length	Number of characters to extract.

Returns: String representation of builder's data subrange.

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ StringBuilder() [1/5]

◆ StringBuilder() [2/5]

◆ StringBuilder() [3/5]

◆ StringBuilder() [4/5]

◆ StringBuilder() [5/5]

◆ ~StringBuilder()

Member Function Documentation

◆ Append() [1/13]

◆ Append() [2/13]

◆ Append() [3/13]

◆ Append() [4/13]

◆ Append() [5/13]

◆ Append() [6/13]

◆ Append() [7/13]

◆ Append() [8/13]

◆ Append() [9/13]

◆ Append() [10/13]

◆ Append() [11/13]

◆ Append() [12/13]

◆ Append() [13/13]

◆ AppendFormat() [1/2]

◆ AppendFormat() [2/2]

◆ AppendLine() [1/2]

◆ AppendLine() [2/2]

◆ Clear()

◆ CopyTo()

◆ get_Capacity()

◆ get_Length()

◆ idx_get()

◆ idx_set()

◆ Insert() [1/5]

◆ Insert() [2/5]

◆ Insert() [3/5]

◆ Insert() [4/5]

◆ Insert() [5/5]

◆ operator[]()

◆ Remove()

◆ Replace() [1/4]

◆ Replace() [2/4]

◆ Replace() [3/4]

◆ Replace() [4/4]

◆ set_Capacity()

◆ set_Length()

◆ ToString() [1/2]

◆ ToString() [2/2]