Built-in type that string - an array of characters - text. More...

Inheritance diagram for System::String:

Public Member Functions
	String ()
	constructor taking no param More...

Int	at (Int index)
	Gets an element as int at the specified index Out of range just returns 0. More...

String	format (String input)
	Formats the string, sprintf-like. More...

String	build (...)
	Builds the string from multiple components. More...

UInt	length ()

String	upcase ()
	Returns the string as uppercase. More...

String	downcase ()
	Returns the string as lowercase. More...

Array< String >	split (String separator)
	Splits the string into multiple strings. More...

void	substr (Int start_index=0)
	returns a portion of the string, starting at the specified index. More...

void	substr (Int start_index, Int length)
	returns a portion of the string, starting at the specified index and extending for a given number of characters afterwards. More...

Bool	beginWith (String str)
	Returns whether the string starts with the specified string. More...

Bool	beginsWith (String str)
	Returns whether the string starts with the specified string. More...

Bool	endWith (String str)
	Returns whether the string ends with the specified string. More...

Bool	endsWith (String str)
	Returns whether the string ends with the specified string. More...

String	removeLastOf (String str)
	Returns a new string with the end truncated from the specified string. More...

String	trim ()
	Returns a new string with any whitespaces truncated from both ends. More...

String	trim (String trim_str)
	Returns a new string with any specified string truncated from the end. More...

String	chop ()
	Removes new lines (\r ) from the string (unless text more text is available) More...

Int	find (String str, Int start_index=0)
	Searches for the first occurence of a string and returns its index location. More...

Int	rfind (String str, Int start_index=0)
	Searches for the first occurence starting from the end of a string backwards and returns its index location. More...

String	replace (UInt index, UInt size, string replacement)
	Adds or replace a string at the specified index. More...

String	replaceAll (String pattern, String replacement)
	Replaces all occurence of a string. More...

Byte	toByte ()
	Converts the string to a Byte. More...

UByte	toUByte ()
	Converts the string to a UByte. More...

Short	toShort ()
	Converts the string to a Short. More...

UShort	toUShort ()
	Converts the string to a UShort. More...

Int	toInt ()
	Converts the string to a Int. More...

UInt	toUInt ()
	Converts the string to a UInt. More...

Long	toLong ()
	Converts the string to a Long. More...

ULong	toULong ()
	Converts the string to a ULong. More...

String	operator+ (String left, String right)
	Concatenates two strings together. More...

String	operator- (String left, String right)
	Removes the first occurence of the right string. More...

Bool	operator== ()
	strcmp strings equal More...

Bool	operator!= ()
	strcmp strings not-equal More...

Bool	operator> ()
	strcmp left string > right string More...

Bool	operator>= ()
	strcmp left string >= right string More...

Bool	operator< ()
	strcmp left string < right string More...

Bool	operator<= ()
	strcmp left string <= right string More...

Public Member Functions inherited from System::Object
	Object ()
	constructor taking no param More...

Bool	isInstanceOf (Class classType)
	Returns whether an object is of a specific class/type. More...

Object	getDeepCopy ()
	Gets a deep copy of this object. More...

void	setDeepCopy (Object obj)
	Unk. More...

String	dump ()
	Dumps all info about an object. More...

Object	getObjectAttribute (string path)

void	setObjectAttribute (string path, Object value)

Bool	hasPrimitiveInterface ()
	Returns whether this object has a primitive interface. More...

Bool	toBool ()
	Casts this object to Bool. More...

Byte	toByte ()
	Casts this object to Byte. More...

Short	toShort ()
	Casts this object to Short. More...

Int	toInt ()
	Casts this object to Int. More...

Long	toLong ()
	Casts this object to Long. More...

UByte	toUByte ()
	Casts this object to UByte. More...

UShort	toUShort ()
	Casts this object to UShort. More...

UInt	toUInt ()
	Casts this object to UInt. More...

ULong	toULong ()
	Casts this object to ULong. More...

Float	toFloat ()
	Casts this object to Float. More...

Double	toDouble ()
	Casts this object to Double. More...

String	toString ()
	Casts this object to String. More...

Symbol	toSymbol ()
	Casts this object to Symbol. More...

Bool	hasArrayInterface ()
	Returns whether this object has an Array interface. More...

Int	getArrayCount ()
	Gets the Array item count for this object. More...

void	setArrayCount ()
	Sets the Array item count for this object. More...

Object	getArrayElement (Object arg0)
	Gets an Array item for this object. More...

void	setArrayElement (Object arg0, Object arg1)
	Sets the Array item for this object. More...

Bool	hasMapInterface ()
	Returns whether this object has a Map interface. More...

int	getMapCount ()
	Returns the count of items in the map. More...

void	setMapElement (Object arg0, Object arg1)
	Returns whether the Map has a specific object key. Bool hasMapElement(Object arg0);. More...

Object	getMapElement (Object arg0)
	Gets a Map element by key. More...

void	hasGeneratorInterface ()
	Returns whether this object has a generator interface. More...

Iterator	generator ()
	Returns generator (?) More...

void	hasIteratorInterface ()
	Returns whether this object has an iterator. More...

Iterator	iterator ()
	Gets the iterator for this object. More...

void	hasVariableInterface ()
	Returns whether this object is a variable. More...

void	hasFunctionInterface ()
	Returns whether this object has a function interface. More...

Object	call ()
	Calls this object as a function. More...

Bool	hasByteDataInterface ()
	Returns whether this object has a byte data interface. More...

Int	getByteDataCount ()
	Returns the ByteData size for this object. More...

void	setByteDataCount (Int count)
	Sets the ByteData size for this object. More...

Int	getByteDataCapacity ()
	Returns the ByteData capacity for this object. More...

void	setByteDataCapacity (Int capacity)
	Sets the ByteData capacity for this object. More...

ByteData	getByteData ()
	Gets the underlaying ByteData. More...

void	setByteData (ByteData bytedata)
	Sets the underlaying ByteData. More...

void	hasObjectSelectorInterface ()
	Returns whether this object has an object selector interface. More...

void	self ()
	Gets the get for this object if it has a get interface. More...

void	getArchiveTree ()

void	setArchiveTree ()

ByteData	serialize ()
	Serializes this object. More...

void	deserialize (ByteData serializedData)
	Deserializes this object. More...

void	defined (Object obj)
	Returns whether a certain object is defined within this object. More...

Array	find_all (FunctionObject func)
	Finds all the elements in this object that matches the predicates. More...

void	each_all (FunctionObject func)
	Applies callback to all elements in this object. More...

Array	map_all (FunctionObject< Object > func)
	Maps all the elements in this object. More...

Bool	operator!= ()
	Returns whether this object is not equal to another. More...

Bool	operator== ()
	Returns whether this object is equal to another. More...

Public Attributes
String	value

Public Attributes inherited from System::Object
Int	rc_size
	Getter-only. Reference counter size of this object. More...

Object	rc_class
	Getter-only. Type name of the object. More...

Int	rc_count
	Getter-only. Reference count of this object. More...

Int	weak_count
	Getter-only. Weak reference count of this object. More...

Class	class_id
	Class (type) object for this object. More...

Detailed Description

Built-in type that string - an array of characters - text.

Definition at line 4 of file String.cpp.

Constructor & Destructor Documentation

◆ String()

System::String::String ( )

inline

constructor taking no param

Definition at line 9 of file String.cpp.

Member Function Documentation

◆ at()

Int System::String::at ( Int index )

Gets an element as int at the specified index Out of range just returns 0.

◆ beginsWith()

Bool System::String::beginsWith ( String str )

Returns whether the string starts with the specified string.

◆ beginWith()

Bool System::String::beginWith ( String str )

Returns whether the string starts with the specified string.

◆ build()

String System::String::build ( ... )

Builds the string from multiple components.

"{0} {1}".format("hello", "world!"); // "hello world!"

◆ chop()

String System::String::chop ( )

Removes new lines (\r
) from the string (unless text more text is available)

◆ downcase()

String System::String::downcase ( )

Returns the string as lowercase.

◆ endsWith()

Bool System::String::endsWith ( String str )

Returns whether the string ends with the specified string.

◆ endWith()

Bool System::String::endWith ( String str )

Returns whether the string ends with the specified string.

◆ find()

Int System::String::find	(	String	str,
		Int	start_index = `0`
	)

Searches for the first occurence of a string and returns its index location.

Returns: Index if found, otherwise -1

◆ format()

String System::String::format ( String input )

Formats the string, sprintf-like.

"%d".format(1); // "1"

◆ length()

UInt System::String::length ( )

◆ operator!=()

Bool System::String::operator!= ( )

inline

strcmp strings not-equal

Definition at line 132 of file String.cpp.

◆ operator+()

String System::String::operator+	(	String	left,
		String	right
	)

inline

Concatenates two strings together.

Definition at line 123 of file String.cpp.

◆ operator-()

String System::String::operator-	(	String	left,
		String	right
	)

inline

Removes the first occurence of the right string.

Definition at line 126 of file String.cpp.

◆ operator<()

Bool System::String::operator< ( )

inline

strcmp left string < right string

Definition at line 141 of file String.cpp.

◆ operator<=()

Bool System::String::operator<= ( )

inline

strcmp left string <= right string

Definition at line 144 of file String.cpp.

◆ operator==()

Bool System::String::operator== ( )

inline

strcmp strings equal

Definition at line 129 of file String.cpp.

◆ operator>()

Bool System::String::operator> ( )

inline

strcmp left string > right string

Definition at line 135 of file String.cpp.

◆ operator>=()

Bool System::String::operator>= ( )

inline

strcmp left string >= right string

Definition at line 138 of file String.cpp.

◆ removeLastOf()

String System::String::removeLastOf ( String str )

Returns a new string with the end truncated from the specified string.

◆ replace()

String System::String::replace	(	UInt	index,
		UInt	size,
		string	replacement
	)

Adds or replace a string at the specified index.

Parameters

index	Index to place the string
size	Size of the string, if 0 it will not overwrite anything and insert instead
replacement	Seplacement string

Returns: New string

◆ replaceAll()

String System::String::replaceAll	(	String	pattern,
		String	replacement
	)

Replaces all occurence of a string.

Returns: New string

◆ rfind()

Int System::String::rfind	(	String	str,
		Int	start_index = `0`
	)

Searches for the first occurence starting from the end of a string backwards and returns its index location.

Returns: Index if found, otherwise -1

◆ split()

Array< String > System::String::split ( String separator )

Splits the string into multiple strings.

◆ substr() [1/2]

void System::String::substr	(	Int	start_index,
		Int	length
	)

returns a portion of the string, starting at the specified index and extending for a given number of characters afterwards.

◆ substr() [2/2]

void System::String::substr ( Int start_index = 0 )

returns a portion of the string, starting at the specified index.