The BASIC compatibility module provides miscellaneous functions that emulate the behaviour
of 'classic' BASIC.
The functions in this module have largely been superceded by BlitzMax features such as
'string slicing', and the Find, Replace, Trim, ToLower and ToUpper string methods.
However, for programmers from a classic BASIC background, these utility functions should make
the transition to BlitzMax a little easier.
NOTE: Strings in classic BASIC are '1 based'. This means that the first character within a
string is at index 1, the second at index 2 and so on. However, BlitzMax strings are '0 based',
meaning the first character is at index 0, the second at index 1 and so on. The instr and
Mid functions in this module retain the '1 based' behaviour of classic BASIC.
Functions
Mid | Extract substring from a string |
Instr | Find a string within a string |
Left | Extract characters from the beginning of a string |
Right | Extract characters from the end of a string |
LSet | Left justify string |
RSet | Right justify string |
Replace | Performs a search and replace function |
Trim | Remove unprintable characters from ends a string |
Lower | Convert string to lowercase |
Upper | Convert string to uppercase |
Hex | Convert an integer value to a hexadecimal string |
Bin | Convert an integer value to a binary string |
LongHex | Convert a 64 bit long integer value to a hexadecimal string |
LongBin | Convert a 64 bit long integer value to a binary string |
Function reference
Function Mid$( str$,pos,size=-1 ) |
Returns | A sequence of characters from str starting at position pos and of length size
|
Description | Extract substring from a string |
Information |
The Mid$ command returns a substring of a String.
Given an existing string, a position from the start of the string and
an optional size, Mid creates a new string equal to the section specified.
If no size if given, Mid returns the characters in the existing string from
position to the end of the string.
For compatibility with classic BASIC, the pos parameter is 'one based'.
|
Function Instr( str$,sub$,start=1 ) |
Returns | The position within str of the first matching occurance of sub
|
Description | Find a string within a string |
Information |
The start parameter allows you to specifying a starting index for the search.
For compatiblity with classic BASIC, the start parameter and returned position
are both 'one based'.
|
Function Left$( str$,n ) |
Returns | size leftmost characers of str
|
Description | Extract characters from the beginning of a string |
Information |
The Left$ command returns a substring of a String.
Given an existing String and a size, Left$ returns the first size
characters from the start of the String in a new String.
|
Function Right$( str$,n ) |
Returns | size rightmost characters of str
|
Description | Extract characters from the end of a string |
Information |
The Right$ command returns a substring of a String.
Given an existing String and a size, Right$ returns the last size
characters from the end of the String.
|
Function LSet$( str$,n ) |
Returns | A string of length n, padded with spaces
|
Description | Left justify string |
Function RSet$( str$,n ) |
Returns | A string of length n, padded with spaces
|
Description | Right justify string |
Function Replace$( str$,sub$,replaceWith$ ) |
Returns | A string with all instances of sub$ replaced by replace$
|
Description | Performs a search and replace function |
Information |
The Replace$ command replaces all instances of one string with another.
|
Function Trim$( str$ ) |
Returns | str with leading and trailing unprintable characters removed
|
Description | Remove unprintable characters from ends a string |
Function Lower$( str$ ) |
Returns | Lowercase equivalent of str
|
Description | Convert string to lowercase |
Function Upper$( str$ ) |
Returns | Uppercase equivalent of str
|
Description | Convert string to uppercase |
Function Hex$( val ) |
Returns | The hexadecimal string representation of val
|
Description | Convert an integer value to a hexadecimal string |
Function Bin$( val ) |
Returns | The binary string representation of val
|
Description | Convert an integer value to a binary string |
Function LongHex$( val:Long ) |
Returns | The hexadecimal string representation of val
|
Description | Convert a 64 bit long integer value to a hexadecimal string |
Function LongBin$( val:Long ) |
Returns | The binary string representation of val
|
Description | Convert a 64 bit long integer value to a binary string |