home
 
 index of namespace default
 
 index of project core
 
 index of module core

Class core.String


SynopsisA buffered String class that can handle ASCII character sequences.

  Base classes:
  Methods: See also:  


Method abbrev
This method supports the => operator.
Signature
abbrev(intlength)
 :String
Arguments
intlength
Returns
String

 
 top of page
Method alloc
Signature
alloc(intbufSize)
Arguments
intbufSize

 
 top of page
Method append
This method supports the => operator.
Signature
append(Strings)
 :String
Arguments
Strings
Returns
String

 
 top of page
Method charsetIndexOf
Signature
charsetIndexOf(Stringcharset,
  intoff 
  )  
 :int
Arguments
Stringcharset
intoff
Returns
int

 
 top of page
Method compare
Signature
compare(Strings)
 :boolean
Arguments
Strings
Returns
boolean

 
 top of page
Method compareIgnoreCase
Signature
compareIgnoreCase(Strings)
 :boolean
Arguments
Strings
Returns
boolean

 
 top of page
Method copy
Signature
copy(Objecto)
Arguments
Objecto

 
 top of page
Method deleteRegion
This method supports the => operator.
Signature
deleteRegion(intoff,
  intlen 
  )  
 :String
Arguments
intoff
intlen
Returns
String

 
 top of page
Method empty
Signature
empty()

 
 top of page
Method endsWith
Signature
endsWith(Strings)
 :boolean
Arguments
Strings
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:  


 
 top of page
Method freeStack
Signature
freeStack()

 
 top of page
Method getc
Signature
getc(intoffset)
 :char
Arguments
intoffset
Returns
char

 
 top of page
Method getChecksum
Return checksum for the given String.
Signature
getChecksum():int
Returns
int32bit 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
StringDirectory 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(intwordNr)
 :String
Arguments
intwordNr
Returns
String

 
 top of page
Method indexOf
Signature
indexOf(Strings,
  intoff 
  )  
 :int
Arguments
Strings
intoff
Returns
int

 
 top of page
Method indexOfChar
Signature
indexOfChar(charc,
  intoff 
  )  
 :int
Arguments
charc
intoff
Returns
int

 
 top of page
Method indexOfControlCharacter
Signature
indexOfControlCharacter(charc)
 :int
Arguments
charc
Returns
int

 
 top of page
Method indexOfWordEnd
Signature
indexOfWordEnd(intoff)
 :int
Arguments
intoff
Returns
int

 
 top of page
Method indexOfWordStart
Signature
indexOfWordStart(intoff)
 :int
Arguments
intoff
Returns
int

 
 top of page
Method insert
This method supports the => operator.
Signature
insert(intindex,
  Strings 
  )  
 :String
Arguments
intindex
Strings
Returns
String

 
 top of page
Method isBlank
Signature
isBlank():boolean
Returns
boolean

 
 top of page
Method lastIndexOf
Signature
lastIndexOf(Strings)
 :int
Arguments
Strings
Returns
int

 
 top of page
Method load
Signature
load(StringfileName,
  booleanbRemoveCR 
  )  
 :boolean
Arguments
StringfileName
booleanbRemoveCR
Returns
boolean
See also:  


 
 top of page
Method loadLocal
Signature
loadLocal(StringfileName,
  booleanbRemoveCR 
  )  
 :boolean
Arguments
StringfileName
booleanbRemoveCR
Returns
boolean

 
 top of page
Method New
Signature
New(Strings)
 :String
Arguments
Strings
Returns
String

 
 top of page
Method numIndicesOf
Signature
numIndicesOf(Strings)
 :int
Arguments
Strings
Returns
int

 
 top of page
Method parseXML
Signature
parseXML():TreeNode
Returns

 
 top of page
Method patternMatch
Signature
patternMatch(Stringpattern)
 :int
Arguments
Stringpattern
Returns
int

 
 top of page
Method putc
Signature
putc(intoffset,
  charc 
  )  
Arguments
intoffset
charc

 
 top of page
Method realloc
Signature
realloc(intbufSize)
 :boolean
Arguments
intbufSize
Returns
boolean

 
 top of page
Method replace
Replace all occurences of String a by String b.
Signature
replace(Stringa,
  Stringb 
  )  
Arguments
Stringa
Stringb
Description

This method supports the => operator.

 
 top of page
Method replaceChar
This method supports the => operator.
Signature
replaceChar(chara,
  charb 
  )  
 :String
Arguments
chara
charb
Returns
String

 
 top of page
Method replaceCharReturnNum
Signature
replaceCharReturnNum(chara,
  charb 
  )  
 :int
Arguments
chara
charb
Returns
int

 
 top of page
Method replaceIncludes
Signature
replaceIncludes(StringoptFilePrefix)
 :int
Arguments
StringoptFilePrefix
Returns
int

 
 top of page
Method replaceRegion
This method supports the => operator.
Signature
replaceRegion(intstartOff,
  intendOff,
  Strings 
  )  
 :String
Arguments
intstartOff
intendOff
Strings
Returns
String

 
 top of page
Method replaceReturnNum
Signature
replaceReturnNum(Stringa,
  Stringb 
  )  
 :int
Arguments
Stringa
Stringb
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:  


 
 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:  


 
 top of page
Method revIndexOfChar
Signature
revIndexOfChar(charc,
  intoff 
  )  
 :int
Arguments
charc
intoff
Returns
int

 
 top of page
Method saveLocal
Signature
saveLocal(StringfileName)
 :boolean
Arguments
StringfileName
Returns
boolean

 
 top of page
Method split
Deprecated:  Use splitChar() instead
Signature
split(chardelimiter)
 :int
Arguments
chardelimiter
Returns
int

 
 top of page
Method splitChar
This method supports the => operator.
Signature
splitChar(chardelimiter)
 :StringArray
Arguments
chardelimiter
Returns

 
 top of page
Method splitCharset
This method supports the => operator.
Signature
splitCharset(StringdelimiterCharset)
 :StringArray
Arguments
StringdelimiterCharset
Returns

 
 top of page
Method splitSpace
This method supports the => operator.
Signature
splitSpace(booleanbQuotes)
 :StringArray
Arguments
booleanbQuotes
Returns

 
 top of page
Method startsWith
Signature
startsWith(Strings)
 :boolean
Arguments
Strings
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:  


 
 top of page
Method substring
This method supports the => operator
Signature
substring(intoff,
  intlen 
  )  
 :String
Arguments
intoff
intlen
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(Strings,
  intoff,
  intlen 
  )  
Arguments
Strings
intoff
intlen

 
 top of page
Method words
Deprecated:  Use splitSpace() instead
Signature
words(booleanbQuotes)
 :int
Arguments
booleanbQuotes
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