String operations

Collection of Ikarus functions to manipulate and format strings.

Initialization

The best way to initialize all Ikarus functions is to call MEM_InitAll() in the Init_Global() initialization function.

1

MEM_InitAll();

Implementation

Ikarus.d on GitHub

Functions

STR_GetCharAt

Returns the ASCII value of a character at a specific position in a string.

1

func int STR_GetCharAt (var string str, var int pos)

• var string str
  The input string
• var int pos
  The position of the character

Return value

The function returns the ASCII value of the character at the specified position.

STR_Len

Returns the length of a string.

1

func int STR_Len (var string str)

• var string str
  The input string

Return value

The function returns the length of the string in characters.

STR_toChar

Converts a string to a pointer to its character array.

1

func int STR_toChar (var string str)

• var string str
  The input string

Return value

The function returns a pointer to the character array representing the input string str

STR_FromChar

Converts a character array to a string.

1

func string STR_FromChar(var int char)

• var int char
  Pointer to the character array

Return value

The function returns a string representation of the character array.

STR_SubStr

Extracts a substring from a given string.

1

func string STR_SubStr (var string str, var int start, var int count)

• var string str
  The input string
• var int start
  The starting position of the substring
• var int count
  The length of the substring

Return value

The function returns a substring, if the starting position is invalid an empty string is returned.

STR_Prefix

Extracts a prefix of a given string, similar to STR_SubStr, but with the starting position set to the first character of the string.

1

func string STR_Prefix (var string str, var int len)

• var string str
  The input string
• var int count
  The length of the prefix

Return value

The function returns a prefix of the input string with the specified length.

STR_Compare

Compares two strings lexicographically and returns a result indicating their relative order.

1

func int STR_Compare(var string str1, var string str2)

• var string str1 The first string to compare
• var string str2 The second string to compare

Return Value

The function returns an integer value representing the result of the comparison:

• STR_GREATER (1): If str1 comes lexicographically after str2.
• STR_EQUAL (0): If str1 is lexicographically equal to str2.
• STR_SMALLER (-1): If str1 comes lexicographically before str2.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17

int result1 = STR_Compare("A", "B");
// The 'result1' variable now contains STR_SMALLER

int result2 = STR_Compare("ABC", "ABC");
// The 'result2' variable now contains STR_EQUAL

int result3 = STR_Compare("AA", "A");
// The 'result3' variable now contains STR_GREATER

int result4 = STR_Compare("BA", "BB");
// The 'result4' variable now contains STR_SMALLER

int result5 = STR_Compare("B", "a");
// The 'result5' variable now contains STR_SMALLER

int result6 = STR_Compare("A", "");
// The 'result6' variable now contains STR_GREATER

STR_ToInt

Converts a string to an integer.

1

func int STR_ToInt (var string str)

• var string str
  The input string

Return Value

The function returns an integer value of the string, if a string is invalid (doesn't contain an integer) zero is returned.

STR_IndexOf

Searches for a substring tok within a given string and returns the index of the first occurrence of tok, taking into account upper and lower case letters.

1

func int STR_IndexOf(var string str, var string tok)

• var string str
  The string in which to search for tok.
• var string tok
  The substring to search for within str.

Return Value

The function returns the index at which the first occurrence of tok begins within str. If tok is not found in str, the function returns -1.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

int index1 = STR_IndexOf("Hello World!", "Hell");
// The 'index1' variable now contains 0

int index2 = STR_IndexOf("Hello World!", "World");
// The 'index2' variable now contains 6

int index3 = STR_IndexOf("Hello World!", "Cake");
// The 'index3' variable now contains -1

int index4 = STR_IndexOf("Hello World!", "");
// The 'index4' variable now contains 0

int index5 = STR_IndexOf("Hello", "Hello World!");
// The 'index5' variable now contains -1

int index6 = STR_IndexOf("hello Hell!", "Hell");
// The 'index6' variable now contains 6

int index7 = STR_IndexOf("", "");
// The 'index7' variable now contains 0

STR_SplitCount

Counts the number of parts a string splits into when using a specified separator.

1

func int STR_SplitCount(var string str, var string separator)

• var string str
  The input string to be split.
• var string separator
  The separator character or string used to split the input string.

Return Value

The function returns a number of parts the input string splits into when using the specified separator.

1
2
3

string inputStr = "This is a sentence.";
int count = STR_SplitCount(inputStr, " ");
// The 'count' variable now contains 4

STR_Split

Splits a string into multiple substrings based on a specified separator and returns the substring at a specified offset.

1

func string STR_Split(var string str, var string separator, var int offset)

Parameters

• var string str
  The input string to be split.
• var string separator
  The separator character or string used to split the input string.
• var int offset
  The index of the substring to be returned after splitting. The index is zero-based.

Return Value

The function returns a substring at the specified offset after splitting the input string. If the offset is greater than or equal to the number of parts generated by splitting, an empty string is returned.

1
2
3
4
5
6
7

func void foo() {
    string inputStr = "This is a sentence.";
    string tok1 = STR_Split(inputStr, " ", 0); // This
    string tok2 = STR_Split(inputStr, " ", 1); // is
    string tok3 = STR_Split(inputStr, " ", 2); // a
    string tok4 = STR_Split(inputStr, " ", 3); // sentence
};

STR_Upper

Converts a string to uppercase.

1

func string STR_Upper(var string str)

• var string str
  The input string

Return Value

The function returns a copy of str with all uppercase letters converted to their corresponding uppercase letters.

STR_Lower

Converts a string to lowercase.

1

func string STR_Lower(var string str)

• var string str
  The input string

Return Value

The function returns a copy of str with all lowercase letters converted to their corresponding uppercase letters.