string Documentation

Functions and Properties

Return Type	Function Information
`bool`	`isControlCode(int chr)Returns true if 'chr' is in the control code range of ascii characters`
`bool`	`isNumber(int chr)Returns true if 'chr' is in the range of ascii characters '0' to '9'`
`bool`	`isAlphabetic(int chr)Returns true if 'chr' is an alphabetic character`
`bool`	`isAlphaNumeric(int chr)Returns true if 'chr' is an alphanumeric character`
`bool`	`isHex(int chr)Returns true if 'chr' is in the set { '0'-'9', 'A'-'F' , 'a'-'f' }`
`bool`	`isUpperCase(int chr)Returns true if 'chr' is an upper-case character`
`bool`	`isLowerCase(int chr)Returns true if 'chr' is a lower-case character`
`int`	`UpperToLower(int chr)Converts all upper case characters to lower case, leaving non-alphabetic characters unchanged`
`int`	`LowerToUpper(int chr)Converts all lower case characters to upper case, leaving non-alphabetic characters unchanged`
`int`	`ConvertCase(int chr)Converts lower case to upper case and upper case to lower case`
`void`	`memset(int ptr[], int value, int n)Memory Set Sets block of memory of size 'n' pointed by 'ptr' to 'value'`
`int`	`memcpy(int dest[], int src[], int n)Memory Copy Copys block of memory pointed by 'src' of size 'n' to 'dest' and returns 'dest'`
`int`	`memmove(int dest[], int src[], int n)Memory Move As memcpy, but uses a buffer so memory space can overlap`
`void`	`arrayset(int a[], int a0, int a1, int a2, ...)Array Set Assign all elements of array 'a'. Overloaded for up to 16 elements`
`void`	`strcpy(int dest[], int src[])String Copy Copys string 'src' into string 'dest' without checking for overflow in 'dest' As strcpy, but only takes the first 'n' characters from src`
`void`	`strncpy(int dest[], int src[], int n)String Copy Copys string 'src' into string 'dest' without checking for overflow in 'dest' As strcpy, but only takes the first 'n' characters from src`
`void`	`remchr(int string[])Remove Characters Remove all characters starting from pointer 'string' Remove 'n' characters and shift the rest of the string back to pointer 'string'`
`void`	`remnchr(int string[], int n)Remove Characters Remove all characters starting from pointer 'string' Remove 'n' characters and shift the rest of the string back to pointer 'string'`
`int`	`strlen(int string[])String Length Returns the length of string 'string'`
`int`	`strcat(int dest[], int src[])String Concatenate Appends string 'src' onto string 'dest' (assuming dest has enough extra memory allocated to allow the operation) strcat for the first 'n' characters in src`
`int`	`strncat(int dest, int src, int n)String Concatenate Appends string 'src' onto string 'dest' (assuming dest has enough extra memory allocated to allow the operation) strcat for the first 'n' characters in src`
`int`	`strchr(int string[], int character)String Character Returns the position of the first occurence of 'character' in 'string', or -1 if none are found`
`int`	`strrchr(int string[], int character)String Reverse Character Returns the position of the last occurence of 'character' in 'string' starting from the end, or -1 if none are found`
`int`	`strstr(int string[], int sub[])String Sub-String Returns the position of the first occurence of sub-string 'sub' in 'string, or -1 if sub is not found`
`int`	`strspn(int str[], int keys[])String Span Returns the length of characters in 'str' before a character not contained in 'keys' is found`
`int`	`strcspn(int str[], int keys[])String Complement Span Returns the length of characters in 'str' before a character contained in 'keys' is found`
`int`	`strcmp(int str1[], int str2[])String Compare Iterates through str1 and str2 until a character is found which is not the same in both strings, and then returns > 0 if the character is larger in str1, and < 0 if it is larger in str2. Returns 0 if the strings are equal strcmp up to 'n' characters`
`int`	`strncmp(int str1[], int str2[], int n)String Compare Iterates through str1 and str2 until a character is found which is not the same in both strings, and then returns > 0 if the character is larger in str1, and < 0 if it is larger in str2. Returns 0 if the strings are equal strcmp up to 'n' characters`
`int`	`atoi(int string[])ASCII to Integer Returns the decimal integer pointed by 'string'`
`int`	`ilen(int string[])Integer Length Returns the length of characters of the decimal integer pointed by 'string'`
`int`	`xtoi(int string[])Hexadecimal ASCII to Integer Returns the (positive) hexadecimal integer pointed by 'string'`
`int`	`xlen(int string[])Hexadecimal Length Returns the length of characters of the (positive) hexadecimal integer pointed by 'string'`
`float`	`atof(int string[])ASCII to Float Returns the floating point number pointed by 'string'`
`int`	`flen(int string[])Float Length Returns the length of characters of the floating point number pointed by 'string'`
`float`	`aton(int string[])ASCII to Number Returns the number pointed by 'string', calling either atoi or atof depending on context`
`int`	`nlen(int string[])Number Length Returns the length of characters of the number pointed by 'string', calling either ilen or flen depending on context`
`int`	`itoa(int string[], int num)Integer to ASCII Places integer 'num' into string 'string' without checking for overflow, and returns the number of characters used`
`int`	`ftoa(int string[], float num, bool printall)Float to ASCII Places float 'num' into string 'string' without checking for overflow, and returns the number of characters used. If 'printall' is true, it will add 4 decimal places regardless of the most significant digit`
`int`	`ntoa(int string[], float num)Number to ASCII Checks whether 'num' is an integer or not, and calls the appropriate function`
`int`	`strcatf(int dest[], int arg, int format)String Concatenate Format Appends 'arg' onto 'dest' as the MF_ constant passed into 'format' As strcatf, using only 'n' characters of 'arg'`
`int`	`strncatf(int dest[], int arg, int format, int n)String Concatenate Format Appends 'arg' onto 'dest' as the MF_ constant passed into 'format' As strcatf, using only 'n' characters of 'arg'`
`void`	sprintf(int ret[], int formatstr[], int a0, int a1, int a2, ...)String Print Format Prints string 'formatstr' into 'ret' according to the arguments inputted (see C function for reference), returning the number of characters used. Does not check for overflow in 'ret' Overloaded up to a maximum of 16 arguments. Enter the right number of arguments for your format string; there is (currently) no way to check how many arguments have been entered or of what type they are Currently supported arguments: '%s' - String '%i' - Integer '%f' - Float '%d' - Number (Integer/Float depending on context) '%n' - Nothing '%p' - Pointer Address '%c' - Single character '%x' - Hexadecimal Integer (lower case) '%X' - Hexadecimal Integer (upper case) '\n' places a line feed ASCII character into the string
`void`	`printf(int formatstr[], int a0, int a1, int a2, ...)Print Format Uses a buffer to print the results of sprintf(formatstr,...) straight to allegro.log Overloaded up to a maximum of 16 arguments`