→ home

→ index of namespace default

→ index of project core

→ index of module core

Class `core.String`

Synopsis: A buffered String class that can handle ASCII character sequences.

Base classes:

core.Object

Methods:

abbrev(int length) : String - This method supports the => operator.
alloc(int bufSize) -
append(String s) : String - This method supports the => operator.
charsetIndexOf(String charset, int off) : int -
compare(String s) : boolean -
compareIgnoreCase(String s) : boolean -
copy(Object o) -
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.
getDebugString() : String -
getDirName() : String - Return directory part of file.
getLength() : int -
getWord(int wordNr) : String -
indexOf(String s, int off) : int -
indexOfChar(char c, int off) : int -
indexOfControlCharacter(char c) : int -
indexOfWordEnd(int off) : int -
indexOfWordStart(int off) : int -
insert(int index, String s) : String - This method supports the => operator.
isBlank() : boolean -
lastIndexOf(String s) : int -
load(String fileName, boolean bRemoveCR) : boolean -
loadLocal(String fileName, boolean bRemoveCR) : boolean -
New(String s) : String -
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 -
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
toLower() : String - This method supports the => operator.
toUpper() : String - This method supports the => operator.
trim() : String - This method supports the => operator.
visit(String s, int off, len) -
words(boolean bQuotes) : int -

See also:

StringArray

Method abbrev

This method supports the => operator.

Signature

abbrev	(	int	length	)
	:	String

Arguments

int

length

–

Returns

String

–

→ top of page

Method alloc

Signature

alloc

(

int

bufSize

)

Arguments

int

bufSize

–

→ top of page

Method append

This method supports the => operator.

Signature

append	(	String	s	)
	:	String

Arguments

String

–

Returns

String

–

→ top of page

Method charsetIndexOf

Signature

charsetIndexOf	(	String	charset	,
		int	off
		)
	:	int

Arguments

String	charset	–
int	off	–

Returns

int

–

→ top of page

Method compare

Signature

compare	(	String	s	)
	:	boolean

Arguments

String

–

Returns

boolean

–

→ top of page

Method compareIgnoreCase

Signature

compareIgnoreCase	(	String	s	)
	:	boolean

Arguments

String

–

Returns

boolean

–

→ top of page

Method copy

Signature

copy

(

Object

)

Arguments

Object

–

→ top of page

Method deleteRegion

This method supports the => operator.

Signature

deleteRegion	(	int	off	,
		int	len
		)
	:	String

Arguments

int	off	–
int	len	–

Returns

String

–

→ top of page

Method empty

Signature

empty

(

)

→ top of page

Method endsWith

Signature

endsWith	(	String	s	)
	:	boolean

Arguments

String

–

Returns

boolean

–

→ top of page

Method escapeControlChars

Replace control characters and "' by escape sequences

Signature

escapeControlChars

(

)

→ top of page

Method fixLength

Signature

fixLength

(

)

→ top of page

Method free

Signature

free

(

)

See also:

alloc()

→ top of page

Method freeStack

Signature

freeStack

(

)

→ top of page

Method getc

Signature

getc	(	int	offset	)
	:	char

Arguments

int

offset

–

Returns

char

–

→ top of page

Method getChecksum

Return checksum for the given String.

Signature

getChecksum

(

)

int

Returns

int

–

32bit string checksum

→ top of page

Method getDebugString

Signature

getDebugString

(

)

String

Returns

String

–

→ top of page

Method getDirName

Return directory part of file.

Signature

getDirName

(

)

String

Returns

String

–

Directory name (including trailing forward/backward slash resp. drive letter)

Description

This method supports the => operator.

→ top of page

Method getLength

Signature

getLength

(

)

int

Returns

int

–

→ top of page

Method getWord

Deprecated: Use splitSpace(), splitChar(), splitCharset() instead

Signature

getWord	(	int	wordNr	)
	:	String

Arguments

int

wordNr

–

Returns

String

–

→ top of page

Method indexOf

Signature

indexOf	(	String	s	,
		int	off
		)
	:	int

Arguments

String	s	–
int	off	–

Returns

int

–

→ top of page

Method indexOfChar

Signature

indexOfChar	(	char	c	,
		int	off
		)
	:	int

Arguments

char	c	–
int	off	–

Returns

int

–

→ top of page

Method indexOfControlCharacter

Signature

indexOfControlCharacter	(	char	c	)
	:	int

Arguments

char

–

Returns

int

–

→ top of page

Method indexOfWordEnd

Signature

indexOfWordEnd	(	int	off	)
	:	int

Arguments

int

off

–

Returns

int

–

→ top of page

Method indexOfWordStart

Signature

indexOfWordStart	(	int	off	)
	:	int

Arguments

int

off

–

Returns

int

–

→ top of page

Method insert

This method supports the => operator.

Signature

insert	(	int	index	,
		String	s
		)
	:	String

Arguments

int	index	–
String	s	–

Returns

String

–

→ top of page

Method isBlank

Signature

isBlank

(

)

boolean

Returns

boolean

–

→ top of page

Method lastIndexOf

Signature

lastIndexOf	(	String	s	)
	:	int

Arguments

String

–

Returns

int

–

→ top of page

Method load

Signature

load	(	String	fileName	,
		boolean	bRemoveCR
		)
	:	boolean

Arguments

String	fileName	–
boolean	bRemoveCR	–

Returns

boolean

–

See also:

loadLocal()

→ top of page

Method loadLocal

Signature

loadLocal	(	String	fileName	,
		boolean	bRemoveCR
		)
	:	boolean

Arguments

String	fileName	–
boolean	bRemoveCR	–

Returns

boolean

–

→ top of page

Method New

Signature

New	(	String	s	)
	:	String

Arguments

String

–

Returns

String

–

→ top of page

Method numIndicesOf

Signature

numIndicesOf	(	String	s	)
	:	int

Arguments

String

–

Returns

int

–

→ top of page

Method parseXML

Signature

parseXML

(

)

TreeNode

Returns

TreeNode

–

→ top of page

Method patternMatch

Signature

patternMatch	(	String	pattern	)
	:	int

Arguments

String

pattern

–

Returns

int

–

→ top of page

Method putc

Signature

putc	(	int	offset	,
		char	c
		)

Arguments

int	offset	–
char	c	–

→ top of page

Method realloc

Signature

realloc	(	int	bufSize	)
	:	boolean

Arguments

int

bufSize

–

Returns

boolean

–

→ top of page

Method replace

Replace all occurences of String a by String b.

Signature

replace	(	String	a	,
		String	b
		)

Arguments

String	a	–
String	b	–

Description

This method supports the => operator.

→ top of page

Method replaceChar

This method supports the => operator.

Signature

replaceChar	(	char	a	,
		char	b
		)
	:	String

Arguments

char	a	–
char	b	–

Returns

String

–

→ top of page

Method replaceCharReturnNum

Signature

replaceCharReturnNum	(	char	a	,
		char	b
		)
	:	int

Arguments

char	a	–
char	b	–

Returns

int

–

→ top of page

Method replaceIncludes

Signature

replaceIncludes	(	String	optFilePrefix	)
	:	int

Arguments

String

optFilePrefix

–

Returns

int

–

→ top of page

Method replaceRegion

This method supports the => operator.

Signature

replaceRegion	(	int	startOff	,
		int	endOff	,
		String	s
		)
	:	String

Arguments

int	startOff	–
int	endOff	–
String	s	–

Returns

String

–

→ top of page

Method replaceReturnNum

Signature

replaceReturnNum	(	String	a	,
		String	b
		)
	:	int

Arguments

String	a	–
String	b	–

Returns

int

–

→ top of page

Method resubstEscapeSeq

Replace internal escape sequences by ASCII-style ones.

Signature

resubstEscapeSeq

(

)

Description

Please see script engine source for details.

See also:

substEscapeSeq(),resubstEscapeSeq2

→ top of page

Method resubstEscapeSeq2

Replace internal escape sequences by script-parseable ASCII-style ones.

Signature

resubstEscapeSeq2

(

)

Description

Please see script engine source for details.

See also:

substEscapeSeq(),resubstEscapeSeq

→ top of page

Method revIndexOfChar

Signature

revIndexOfChar	(	char	c	,
		int	off
		)
	:	int

Arguments

char	c	–
int	off	–

Returns

int

–

→ top of page

Method saveLocal

Signature

saveLocal	(	String	fileName	)
	:	boolean

Arguments

String

fileName

–

Returns

boolean

–

→ top of page

Method split

Deprecated: Use splitChar() instead

Signature

split	(	char	delimiter	)
	:	int

Arguments

char

delimiter

–

Returns

int

–

→ top of page

Method splitChar

This method supports the => operator.

Signature

splitChar	(	char	delimiter	)
	:	StringArray

Arguments

char

delimiter

–

Returns

StringArray

–

→ top of page

Method splitCharset

This method supports the => operator.

Signature

splitCharset	(	String	delimiterCharset	)
	:	StringArray

Arguments

String

delimiterCharset

–

Returns

StringArray

–

→ top of page

Method splitSpace

This method supports the => operator.

Signature

splitSpace	(	boolean	bQuotes	)
	:	StringArray

Arguments

boolean

bQuotes

–

Returns

StringArray

–

→ top of page

Method startsWith

Signature

startsWith	(	String	s	)
	:	boolean

Arguments

String

–

Returns

boolean

–

→ top of page

Method substEscapeSeq

Replace ASCII-style escape sequences by internal ones.

Signature

substEscapeSeq

(

)

Description

This method is mostly useful when generating script source. Please see script engine source for details.

See also:

resubstEscapeSeq(),resubstEscapeSeq2

→ top of page

Method substring

This method supports the => operator

Signature

substring	(	int	off	,
		int	len
		)
	:	String

Arguments

int	off	–
int	len	–

Returns

String

–

→ top of page

Method toLower

This method supports the => operator.

Signature

toLower

(

)

String

Returns

String

–

→ top of page

Method toUpper

This method supports the => operator.

Signature

toUpper

(

)

String

Returns

String

–

→ top of page

Method trim

This method supports the => operator.

Signature

trim

(

)

String

Returns

String

–

→ top of page

Method visit

Signature

visit	(	String	s	,
		int	off	,
		int	len
		)

Arguments

String	s	–
int	off	–
int	len	–

→ top of page

Method words

Deprecated: Use splitSpace() instead

Signature

words	(	boolean	bQuotes	)
	:	int

Arguments

boolean

bQuotes

–

Returns

int

–

→ top of page

Project Modules:	`core`
Project Classes:	`Boolean` , `Buffer` , `Byte` , `Class` , `ClassArray` , `Condition` , `Configuration` , `Double` , `DummyStream` , `Envelope` , `Event` , `Exception` , `File` , `Float` , `FloatArray` , `FloatArray128` , `FloatArray16` , `FloatArray32` , `FloatArray64` , `FloatArray8` , `Function` , `HashTable` , `IntArray` , `IntArray128` , `IntArray16` , `IntArray32` , `IntArray64` , `IntArray8` , `Integer` , `List` , `ListNode` , `Long` , `Mailbox` , `Mutex` , `Object` , `ObjectArray` , `PakFile` , `PointerArray` , `Pool` , `Script` , `SharedBuffer` , `Short` , `Stack` , `StdErrStream` , `StdInStream` , `StdOutStream` , `Stream` , `String` , `String128` , `String16` , `String32` , `String64` , `String8` , `StringArray` , `StringIterator` , `Thread` , `Time` , `TKS` , `TreeNode` , `UnsignedByte` , `UnsignedInteger` , `UnsignedLong` , `UnsignedShort` , `Value` , `ValueArray` , `Variable`
Project Functions:	`ceil` , `exit` , `floor` , `GetCurrentThread` , `getenv` , `lcchar` , `mathAbsMaxf` , `mathAbsMinf` , `mathAbsMini` , `mathAbsMini` , `mathClampf` , `mathClampi` , `mathDistancePointPlane2d` , `mathLerpf` , `mathMaxf` , `mathMaxi` , `mathMinf` , `mathMini` , `mathPowerf` , `mathPoweri` , `mathSmoothStepf` , `mathWrapf` , `mathWrapi` , `milliSeconds` , `psystem` , `putenv` , `srand` , `system` , `ucchar`
All Namespaces:	`default` , `ui`
All Projects:	`core` , `debugtext` , `tkfreetype2` , `tkmath` , `tkmidi` , `tkopengl` , `tkportaudio` , `tksdl` , `tkui` , `tkunit`

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 13:15:54

Class core.String

Class `core.String`