Ufy Libraries

Introduction

Ufy comes with a few standard libraries (modules), either implemented in source or in machine code. This document deals with a standard ufy configuration. Since it's possible that the interpreter that you're running has been set up differently, not all of this may apply to your situation. The situation that'll be described here is the one where each script loads the '$lang' module, and where 'std' is an alias for the 'stdio', 'string', 'stdlib', 'time', 'net' and 'types' modules, which are all described here.

About modules

All modules share a single namespace, which consists of identifiers, optionally separated by slashes. A dollar-sign at the beginning indicates a standard, native library, since it's illegal to declare a module-name with such a character through the '#module' directive, but it's legal to resolve a module-name with such a dollar-sign. Functions and classes are not sorted alphabetically; they are grouped more or less by type.

Module '$lang'

Functions and classes

byte
int
float
string
list
callable
isvoid
isbyte
isint
isfloat
isstring
islist
isobject
isfunction
exit
throw
catch
eval
include
use
serialize
unserialize
call
sizeof
delete
keys
values
put
pop
pop2
wait
release
releaseAll
yield
Thread
Regex
object
Error
BREAKPOINT

Function 'byte'

Function 'int'

Function 'float'

Function 'string'

Function 'list'

Function 'callable'

Function 'isvoid'

Function 'isbyte'

Function 'isint'

Function 'isfloat'

Function 'isstring'

Function 'islist'

Function 'isobject'

Function 'isfunction'

Function 'exit'

Function 'throw'

Usage:

throw(any);

Creates an error situation, which breaks down the stack of this thread, either until the end (also of the program execution), or until a fail, or a the end of an eval. The instance thrown can be caught using the catch function.

Function 'catch'

Usage:

var err = catch();

Or, more comprehensively:

try {
  1/0;
} fail {
  var err = catch();
  printf("Error: " + err);
}

Catches the error thrown, or the error object as generated by the interpreter upon encountering an erronous situation (as above; a division by zero).

Function 'eval'

Usage:

var outcome = eval(code);

Evaluates a piece of code, captured inside a string.

Function 'include'

Function 'use'

Function 'serialize'

Function 'unserialize'

Function 'call'

Usage:

var result = call(string, list);
var result = call(functor, list);
var result = call(object, string, list);

Wraps around a function call, in case the argument list can only be had as a proper list, or the name of the function can only be had as a string. Allows for variable argument lists to be passed on to the next function:

function foo_format(string fmt) {
  return "foo" + call("format", fmt, _);
}

Function 'sizeof'

Function 'delete'

Function 'keys'

Function 'values'

Function 'put'

Function 'pop'

Function 'pop2'

Function 'wait'

Usage:

wait(object);
wait();

Blocks execution of the current thread, until the object is released. Calling wait() without arguments is only valid within the context of a class definition, as the object itself will be used to block.

Function 'release'

Usage:

release(object);
release();

Releases one waiter on an object. Calling release() without arguments is only valid within the context of a class definition, as the object itself will be used.

Function 'releaseAll'

Usage:

releaseAll(object);
releaseAll();

Releases all waiters on an object. Calling releaseAll() without arguments is only valid within the context of a class definition, as the object itself will be used.

Function 'yield'

Usage:

yield(any);

Pushes an instance into the thread's FIFO to its parent thread, where it can be retrieved with the 'fetch' method.

Class 'Thread'

Usage:

var thread = clone some_func();
thread.fetch();
thread.cancel();
thread.join();

The 'Thread' class is returned automatically from the clone keyword. It can be used to manipulate the execution of the child-thread, and to communicate with it. Threads have their own FIFO to communicate with their parent:

#use std

function slowyield() {
  for (i=0; i<4; i++) {
    printf("Thread yielding %a\n", i);
    yield(i);
    sleep(1);
  }
  printf("Thread exiting.\n");
}

var n, th = clone slowyield();
while (!isvoid(n = th.fetch())) {
  printf("Mainthread fetches %a\n", n);
}
printf("Mainthread exiting.\n");

Will result (slowly), in:

Thread yielding 0
Mainthread fetches 0
Thread yielding 1
Mainthread fetches 1
Thread yielding 2
Mainthread fetches 2
Thread yielding 3
Mainthread fetches 3
Thread exiting.
Mainthread exiting.

Class 'Regex'

Class 'object'

Class 'Error'

Usage:

var error = Error();
var error = Error(string);
var error = Error(int, string);
error.add_string(string);
error.set_code(string);

Spoons up the current error state for your thread, optionally adding to it the parameters that you provide (the strings go first on the stack of error messages, the integer becomes the error code). The methods 'add_string' and 'set_code' perform those functions as well, but allow you to 're-throw' errors; the state of an original error is appended to, as is shown in the following example:

try {
  1/0;
} fail {
  var e = catch();
  e.add_string("You divided by zero !");
  throw(e);
}

Function 'BREAKPOINT'

Usage:

BREAKPOINT();

Works only when the interpreter has been compiled with _DEBUG defined. Allows you to step throw your, and the interpreter's code.

Function 'clientsocket'

Function 'serversocket'

Function 'accept'

Function 'parse_url'

Function 'http_get'

stdio / $stdio

fopen
fseek
flock
truncate
rename
remove
mkdir
chdir
pwd
exist
stat
dir
tmpfile
tmpname
pipe
realpath
printf
copy

Function 'fopen'

Function 'fseek'

Function 'flock'

Function 'truncate'

Function 'rename'

Function 'remove'

Function 'mkdir'

Function 'chdir'

Function 'pwd'

Function 'exist'

Function 'stat'

Function 'dir'

Function 'tmpfile'

Function 'tmpname'

Function 'pipe'

Function 'realpath'

Function 'printf'

Function 'copy'

stdlib / $stdlib

rand
srand
getenv
setenv
system

Function 'rand'

Function 'srand'

Function 'getenv'

Function 'setenv'

Function 'system'

string / $string

strlen
toupper
tolower
charat
substr
strspn
strcspn
left
right
trim
ltrim
rtrim
split
join
chop
strstr
format
levenshtein
b64encode
b64decode
htoni
blob
unblob
sort
hex

Function 'strlen'

Function 'toupper'

Function 'tolower'

Function 'charat'

Function 'substr'

Function 'strspn'

Function 'strcspn'

Function 'left'

Function 'right'

Function 'trim'

Function 'ltrim'

Function 'rtrim'

Function 'split'

Function 'join'

Function 'chop'

Function 'strstr'

Function 'format'

Function 'levenshtein'

Function 'b64encode'

Function 'b64decode'

Function 'htoni'

Function 'blob'

Function 'unblob'

Function 'sort'

Function 'hex'

time / $time

time

utime

sleep

usleep

strftime

Function 'TM'

Function 'time'

Function 'utime'

Function 'sleep'

Function 'usleep'

Function 'strftime'

Author: Kees Jan Hermans
Date: 2006-07-06