default
core
corecore.Stringabbrev(int length) : String - This method supports the => operator.
alloc(int bufSize) -
append(String s) : String - This method supports the => operator.
appendRepeat(String s, int numRepeats) - Append the given String 'numRepeats' times.
charsetBlacklist(String charset) - Remove all chars present in 'charset'.
charsetIndexOf(String charset, int off) : int -
charsetIndexOfWordEnd(String charset, int off) : int -
charsetIndexOfWordStart(String charset, int off) : int -
charsetWhitelist(String charset) - Keep all chars present in 'charset'.
checkConversions() : int - Check available type conversions
checkFloatConversion() : boolean - Check if string is a float
checkIntConversion() : boolean - Check if string is an integer
compare(String s) : boolean -
compareIgnoreCase(String s) : boolean -
compareIgnoreWhitespace(String s) : boolean -
copy(Object o) -
cp1252ToUTF8(boolean bBOM) - Convert CP1252 extended ASCII string to UTF-8
deleteRegion(int off, len) : String - This method supports the => operator.
empty() -
endsWith(String s) : boolean -
escapeControlChars() - Replace control characters and "' by escape sequences
fixLength() -
free() -
freeStack() -
getc(int offset) : char -
getChecksum() : int - Return checksum for the given String.
getChecksumIgnoreWhitespace() : int - Return checksum for the given String, ignoring all white space (< 32) characters.
getDebugString() : String -
getDirName() : String - Return directory part of file.
getLength() : int - Return number of chars, including ASCIIZ.
getMetaFlags() : int - Get string meta flags (e.g. whether String was originally enclosed in \"\", TKS_STRFL_QUOT)
getNumChars() : int - Return number of chars, excluding ASCIIZ.
getQuotFlag() : int - Get quotation flag.
getWord(int wordNr) : String -
hasUTFBOM() : boolean - Check if string starts with UTF-8 byte order mark (U+FEFF encoded as 0xEF 0xBB 0xBF)
indexOf(String s, int off) : int -
indexOfChar(char c, int off) : int -
indexOfControlCharacter(char c) : int -
indexOfFirstDifference(String o) : int -
indexOfWordEnd(int off) : int -
indexOfWordStart(int off) : int -
insert(int index, String s) : String - This method supports the => operator.
isBlank() : boolean -
isPredecessor(String o, boolean bCaseSensitive) : boolean - Check whether String is lexicographical predecessor of other string.
isUTF8() : boolean - Check if string starts with UTF-8 byte order mark (see →hasUTF8BOM) or if it contains any UTF-8 multi-byte chars
lastIndexOf(String s) : int -
load(String fileName, boolean bRemoveCR) : boolean -
loadLocal(String fileName, boolean bRemoveCR) : boolean -
New(String s) : String -
numCharsAt(char c) : int - Count number of consecutive characters at the given string offset.
numIndicesOf(String s) : int -
parseXML() : TreeNode -
patternMatch(String pattern) : int -
putc(int offset, char c) -
realloc(int bufSize) : boolean -
replace(String a, b) - Replace all occurences of String a by String b.
replaceChar(char a, b) : String - This method supports the => operator.
replaceCharReturnNum(char a, b) : int -
replaceIncludes(String optFilePrefix) : int -
replaceRegion(int startOff, endOff, String s) : String - This method supports the => operator.
replaceReturnNum(String a, b) : int -
resubstEscapeSeq() - Replace internal escape sequences by ASCII-style ones.
resubstEscapeSeq2() - Replace internal escape sequences by script-parseable ASCII-style ones.
revIndexOfChar(char c, int off) : int -
saveLocal(String fileName) : boolean -
setQuotFlag(int flag) - Set quotation flag
split(char delimiter) : int -
splitChar(char delimiter) : StringArray - This method supports the => operator.
splitCharset(String delimiterCharset) : StringArray - This method supports the => operator.
splitSpace(boolean bQuotes) : StringArray - This method supports the => operator.
startsWith(String s) : boolean -
substEscapeSeq() - Replace ASCII-style escape sequences by internal ones.
substring(int off, len) : String - This method supports the => operator
tokenize(String delimiterCharset) : StringArray - Split string at delimiter chars and return substring array.
tokenizeWithRanges(String delimiterCharset, IntArray retRanges) : StringArray - Split string at delimiter chars and return substring and startoffset+numchars arrays.
toLower() : String - This method supports the => operator.
toUpper() : String - This method supports the => operator.
trim() : String - This method supports the => operator.
utf8ToASCII() - Convert UTF-8 string to ASCII.
utf8ToCP1252() - Convert UTF-8 string to CP1252 extended ASCII.
visit(String s, int off, len) -
wasQuoted() : boolean - Check whether String was originally enclosed in \"\" or \'\'
wasQuotedDouble() : boolean - Check whether String was originally enclosed in \"\"
wasQuotedSingle() : boolean - Check whether String was originally enclosed in \'\'
wordIndexAtCharIndex(int charIndex, boolean bQuot) : int - Find word index at char index.
words(boolean bQuotes) : int -
Method abbrev | ||||||||||
This method supports the => operator. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method alloc | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method append | ||||
This method supports the => operator. | ||||
Signature | ||||
Arguments | ||||
| ||||
Returns | ||||
Method appendRepeat | |||||||||||||||
Append the given String 'numRepeats' times. | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
| |||||||||||||||
Description | |||||||||||||||
Does nothing when 's' is empty or numRepeats is <= 0. This method supports the => operator. |
Method charsetBlacklist | |||||
Remove all chars present in 'charset'. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method charsetIndexOf | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method charsetIndexOfWordEnd | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method charsetIndexOfWordStart | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method charsetWhitelist | |||||
Keep all chars present in 'charset'. | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method checkConversions | |||||
Check available type conversions | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method checkFloatConversion | |||||
Check if string is a float | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method checkIntConversion | |||||
Check if string is an integer | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method compareIgnoreCase | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method compareIgnoreWhitespace | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method cp1252ToUTF8 | |||||
Convert CP1252 extended ASCII string to UTF-8 | |||||
Signature | |||||
| |||||
Arguments | |||||
| |||||
Description | |||||
(note) CP1252 is the HTML5 default encoding for text labeled as ISO8859-1 |
Method deleteRegion | ||||||||||||||||||||
This method supports the => operator. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
Method empty | |||
Signature | |||
|
Method escapeControlChars | |||
Replace control characters and "' by escape sequences | |||
Signature | |||
|
Method fixLength | |||
Signature | |||
|
Method free | |||
Signature | |||
|
Method freeStack | |||
Signature | |||
|
Method getc | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method getChecksum | |||||
Return checksum for the given String. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getChecksumIgnoreWhitespace | |||||
Return checksum for the given String, ignoring all white space (< 32) characters. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getDirName | |||||
Return directory part of file. | |||||
Signature | |||||
| |||||
Returns | |||||
| |||||
Description | |||||
This method supports the => operator. |
Method getLength | |||||
Return number of chars, including ASCIIZ. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getMetaFlags | |||||
Get string meta flags (e.g. whether String was originally enclosed in \"\", TKS_STRFL_QUOT) | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getNumChars | |||||
Return number of chars, excluding ASCIIZ. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getQuotFlag | |||||
Get quotation flag. | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method getWord | ||||||||||
Deprecated: Use splitSpace(), splitChar(), splitCharset(), tokenize() instead | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method hasUTFBOM | |||||
Check if string starts with UTF-8 byte order mark (U+FEFF encoded as 0xEF 0xBB 0xBF) | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method indexOfChar | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method indexOfControlCharacter | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method indexOfFirstDifference | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method indexOfWordEnd | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method indexOfWordStart | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method insert | ||||||||
This method supports the => operator. | ||||||||
Signature | ||||||||
Arguments | ||||||||
| ||||||||
Returns | ||||||||
Method isBlank | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method isPredecessor | ||||||||||||||||||||
Check whether String is lexicographical predecessor of other string. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method isUTF8 | |||||
Check if string starts with UTF-8 byte order mark (see →hasUTF8BOM) or if it contains any UTF-8 multi-byte chars | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method load | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method loadLocal | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method numCharsAt | ||||||||||
Count number of consecutive characters at the given string offset. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method patternMatch | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method putc | |||||||||||||||
Signature | |||||||||||||||
| |||||||||||||||
Arguments | |||||||||||||||
|
Method realloc | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method replace | |
Replace all occurences of String a by String b. | |
Signature | |
Arguments | |
Description | |
This method supports the => operator. |
Method replaceChar | ||||||||||||||||||||
This method supports the => operator. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
Method replaceCharReturnNum | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method replaceIncludes | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method replaceRegion | ||||||||||||
This method supports the => operator. | ||||||||||||
Signature | ||||||||||||
Arguments | ||||||||||||
| ||||||||||||
Returns | ||||||||||||
Method replaceReturnNum | |||
Signature | |||
Arguments | |||
Returns | |||
|
Method resubstEscapeSeq | |||
Replace internal escape sequences by ASCII-style ones. | |||
Signature | |||
| |||
Description | |||
Please see script engine source for details. |
substEscapeSeq(),resubstEscapeSeq2
Method resubstEscapeSeq2 | |||
Replace internal escape sequences by script-parseable ASCII-style ones. | |||
Signature | |||
| |||
Description | |||
Please see script engine source for details. |
substEscapeSeq(),resubstEscapeSeq
Method revIndexOfChar | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method saveLocal | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method setQuotFlag | |||||
Set quotation flag | |||||
Signature | |||||
| |||||
Arguments | |||||
|
Method split | ||||||||||
Deprecated: Use splitChar() instead | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
Method splitChar | ||||||||||
This method supports the => operator. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method splitCharset | ||||||||||
This method supports the => operator. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method splitSpace | ||||||||||
This method supports the => operator. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Method substEscapeSeq | |||
Replace ASCII-style escape sequences by internal ones. | |||
Signature | |||
| |||
Description | |||
This method is mostly useful when generating script source.Please see script engine source for details. |
resubstEscapeSeq(),resubstEscapeSeq2
Method substring | ||||||||||||||||||||
This method supports the => operator | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
Method tokenize | ||||||||||
Split string at delimiter chars and return substring array. | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
Description | ||||||||||
This method supports the => operator. Unlike splitCharset(), the result array will contain the delimiter chars and this method will consider quoted strings. | ||||||||||
Method tokenizeWithRanges | ||||||||||||||||||||
Split string at delimiter chars and return substring and startoffset+numchars arrays. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
Returns | ||||||||||||||||||||
Description | ||||||||||||||||||||
This method supports the => operator. Unlike splitCharset(), the result array will contain the delimiter chars and this method will consider quoted strings. | ||||||||||||||||||||
Method utf8ToASCII | |||
Convert UTF-8 string to ASCII. | |||
Signature | |||
| |||
Description | |||
Replace non-ASCII chars (>=128) with SUB (26) character. |
Method utf8ToCP1252 | |||
Convert UTF-8 string to CP1252 extended ASCII. | |||
Signature | |||
| |||
Description | |||
Replace non-convertable chars with SUB (26) character.
(note) CP1252 is the same as ISO8859-1 except for the 0x80..0x9F area (ctl codes in ISO)(note) CP1252 is the HTML5 default encoding for text labeled as ISO8859-1 |
Method wasQuoted | |||||
Check whether String was originally enclosed in \"\" or \'\' | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wasQuotedDouble | |||||
Check whether String was originally enclosed in \"\" | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wasQuotedSingle | |||||
Check whether String was originally enclosed in \'\' | |||||
Signature | |||||
| |||||
Returns | |||||
|
Method wordIndexAtCharIndex | ||||||||||||||||||||
Find word index at char index. | ||||||||||||||||||||
Signature | ||||||||||||||||||||
| ||||||||||||||||||||
Arguments | ||||||||||||||||||||
| ||||||||||||||||||||
Returns | ||||||||||||||||||||
| ||||||||||||||||||||
Method words | ||||||||||
Deprecated: Use splitSpace() instead | ||||||||||
Signature | ||||||||||
| ||||||||||
Arguments | ||||||||||
| ||||||||||
Returns | ||||||||||
| ||||||||||
auto-generated by "DOG", the TkScript document generator. Thu, 11/Dec/2025 13:41:59