Objeck Documentation

Bundle

Core runtime library providing primitive types (Bool, Byte, Char, Int, Float, String), base collections, and system utilities. Every Objeck program links against this bundle automatically via lang.obl.

Char

Character class represents a Unicode character value.

Inherits: Number

Operations

Clamp
Clear
Compare
Error
ErrorLine
Find
FindAll
IsChar
IsDigit
IsLower
IsUpper
IsWhitespace
Max
Min
Print
Sort
ToByte
ToBytes
ToFloat
ToHexString
ToInt
ToLower
ToString
ToStringUnsigned
ToUpper

Clamp # function

Returns a given value between an upper and lower bound

function : Clamp(min:Char, value:Char, max:Char) ~ Char

Parameters

Name	Type	Description
min	Char	minimal value
value	Char	value between the min and max
max	Char	maximum value

Return

Type	Description
Char	min if vaule is less than main, max if max is less than value, otherwise the value

Clear # function

Set all array elements to zero

function : Clear(c:Char[]) ~ Nil

Parameters

Name	Type	Description
c	Char	array

Compare # native

Compares two values

function : native : Compare(l:Char, r:Char) ~ Int

Parameters

Name	Type	Description
l	Char	left compare object
r	Char	right compare object

Return

Type	Description
Int	0 if equal, -1 if types differ, 1 if equal

Error # function

Prints error value

function : Error() ~ Nil

ErrorLine # function

Prints error value with newline

function : ErrorLine() ~ Nil

Find # native

Searches for the first occurrence of a byte

function : native : Find(chars:Char[], search:Char) ~ Int

Parameters

Name	Type	Description
chars	Char	character array to search
search	Char	byte to search for

Return

Type	Description
Int	true of found, false otherwise

Find # native

Searches for the first occurrence of a byte

function : native : Find(chars:Char[], offset:Int, search:Char) ~ Int

Parameters

Name	Type	Description
chars	Char	character array to search
offset	Int	search offset
search	Char	byte to search for

Return

Type	Description
Int	true of found, false otherwise

Find # native

Searches for the first occurrence of a character array

function : native : Find(chars:Char[], search:Char[]) ~ Int

Parameters

Name	Type	Description
chars	Char	character array to search
search	Char	character array to search for

Return

Type	Description
Int	index of first occurrence, -1 otherwise

Find # native

Searches for the first occurrence of a character array

function : native : Find(chars:Char[], offset:Int, search:Char[]) ~ Int

Parameters

Name	Type	Description
chars	Char	character array to search
offset	Int	search offset
search	Char	character array to search for

Return

Type	Description
Int	index of first occurrence, -1 otherwise

FindAll # function

Searches for all occurrences of the character array

function : FindAll(chars:Char[], search:Char[]) ~ Int[]

Parameters

Name	Type	Description
chars	Char	character array to search
search	Char	character array to search for

Return

Type	Description
Int	an array of indexes

IsChar # native

Checks of the character is a alpha digit

function : native : IsChar() ~ Bool

Return

Type	Description
Bool	true if alpha digit, false otherwise

IsDigit # native

Checks of the character is a numeric digit

function : native : IsDigit() ~ Bool

Return

Type	Description
Bool	true if numeric digit, false otherwise

IsLower # native

Checks if the character is lower-case

function : native : IsLower() ~ Bool

Return

Type	Description
Bool	true if lower-case, false otherwise

IsUpper # native

Checks if the character is upper-case

function : native : IsUpper() ~ Bool

Return

Type	Description
Bool	true if upper-case, false otherwise

IsWhitespace # native

Checks of the character is white space

function : native : IsWhitespace() ~ Bool

Return

Type	Description
Bool	true if white space, false otherwise

Max # native

Returns the largest byte value

function : native : Max(l:Char, r:Char) ~ Char

Parameters

Name	Type	Description
l	Char	value to compare
r	Char	value to compare

Return

Type	Description
Char	largest byte value

Min # native

Returns the smallest byte value

function : native : Min(l:Char, r:Char) ~ Char

Parameters

Name	Type	Description
l	Char	value to compare
r	Char	value to compare

Return

Type	Description
Char	smallest byte value

Print # function

Prints value

function : Print() ~ Nil

Sort # native

Prints value with newline

function : native : Sort() ~ Char[]

ToByte # function

Returns the Character value

function : ToByte() ~ Byte

Return

Type	Description
Byte	value

ToBytes # function

Converts the character array to a byte array

function : ToBytes(c:Char[]) ~ Byte[]

Parameters

Name	Type	Description
c	Char	character array

Return

Type	Description
Byte	byte array

ToFloat # function

Returns the Float value

function : ToFloat() ~ Float

Return

Type	Description
Float	value

ToHexString # native

Returns a hex string value

function : native : ToHexString() ~ String

Return

Type	Description
String	hex string value

ToInt # function

Returns the Int value

function : ToInt() ~ Int

Return

Type	Description
Int	value

ToLower # function

Converts character to lower-case

function : ToLower() ~ Char

Return

Type	Description
Char	lower-case representation

ToString # function

Returns a string representation of the char array

function : ToString(v:Char[,]) ~ String

Parameters

Name	Type	Description
v	Char	char array

Return

Type	Description
String	string representation of the char array

ToString # native

Returns a string representation of the value

function : native : ToString() ~ String

Return

Type	Description
String	string representation of the value

ToStringUnsigned # native

Returns an unsigned string representation of the value

function : native : ToStringUnsigned() ~ String

Return

Type	Description
String	unsigned string representation of the value

ToUpper # native

Converts character to upper-case

function : native : ToUpper() ~ Char

Return

Type	Description
Char	upper-case representation