!!! ROUGH COMPILATION !!!

The information in this file has not yet been verified for completeness or accuracy. I think, maybe roughly about 20 more new (mostly HTTP related) methods havn't yet been entered into this file.

accessible(filepath)

Returns: Full file path on success, or "" on failure.
Scope: generic

Determine the accessibility of a file.

Example:

path = accessible("/etc/motd"); if (path != "") print("MOTD:", loadText(path)); else print("MOTD: not accessible.");

See also: txtDisp.

Bug: it does not work.

argument()

Returns: the string following the -ar option.
Scope: generic.

ascii(ASCII code)

Returns: the corresponding ASCII character.
Scope: generic.

Returns the character given the ASCII value.

Example:

print("This program is brought to you by the letter ``", ascii(86), "''.\n"); /* ring terminal bell */ print(ascii(7));

Bugs

There needs to be a method for setting this mask dynamically.

charMask()

Returns: (int) character tag value.
Scope: txtDisp.

Low level stuff. To be described later.

charUnderlineMask()

Returns: (int) character underline-mask value.
Scope: txtDisp.

For telling whether this character has the underline-drawing mask turned on. If it does, the character would appear underlined.

To achieve this effect, use the '\u' directive in the text.

Example:

\name {culmtest} \class {txtDisp} \parent {} \content {Sometimes we want to \u(underline) text.} \script { if (arg[0] == "buttonRelease") { if (umask = charUnderlineMask()) { print("is underlined char.\n"); } else { print("is not underlined char.\n"); } } usual(); } \width {100} \height {50}

Bugs

There needs to be a method for setting this mask dynamically.

clean()

Returns: unaffected.
Scope: field.

Cleans up the effect of smudge() -- Clears window, then sends self a "render" message.

Bug

Cursor change is affected only within the window of the method caller.

cycleColors(0|1)

Returns: none.
Scope: Field.

Cycles the caller object's FGColor, BGColor and BDColor one way or another... Typical use is to provide simple visual feedback for buttons.

date()

Returns: date string.
Scope: generic.

Sample output: ``Mon Aug 29 21:46:34 PDT 1994''

Bug

The character count argument is ignored. De-highlights to the end of the line.

debug(option)

Returns: undefined.
Scope: cosmic.

For debugging purposes. Used to turn on/off various debugging flags.

Options:

pa: print AST right after it's built.
pc: print PCode right after it's built.
pe: PCode execution trace.
dumpPCode: Dump PCode.

Example:

debug("pa");

delay(seconds)

Returns:
Scope: generic.

deleteFile(fileName)

Returns:
Scope: generic.

Deletes file.

the interpreter will not permitted the execution of this method if the calling object's 'security' attribute is non zero.

Example:

deleteFile("junk.txt");

drawCursor()

Returns: undefined.
Scope: txtDisp.

Draws the text field's cursor, if the attribute ``cursor'' is 1.

See also: txtDisp.

exist(object name)

Returns: 1 if object exists, 0 if not.
Scope: cosmic.

Checks to see if the named object is instantiated.

exit(code)

Returns: none.
Scope: cosmic.

Exit program with specified exit value (integer). No automatic saving of objects.

See also: txtDisp.

findPattern(text, pattern)

Returns: position where the matching string pattern ends, or -1 if not found.
Scope: generic.

String pattern matching.

Example:

print(findPattern("01234", "23"));

Outputs:

firstCard()

Returns: first object in FCardList.
Scope: stack.

First object in FCardList. See stack class for FCardList object list.

See also: nextCard(), lastCard(), stack.

float(int|str|char)

Returns: floating number.
Scope: generic.

Converts argument to floating point number type.

Example:

x = "57"; y = float(x) * 3.5;

See also: txtDisp.

Bug

Argument characterCount is ignored. Highlights to the end of the line.

info(info flags)

Returns: unaffected.
Scope: cosmic.

A debugger's friend.

Flags:

listMethods
listNPSlots
listNCSlots
listSlotsRW
listSlotsR
listSlotsW
listAllMethods

Example:

info(); /* spews out all the slot values to stdout */

initialize()

Dignostic purpose.

Returns: unaffected.
Scope: generic.

Initializes object. Typically effected by having an object receive a "init" message. See the classScript. Application script writers should never have to use this -- should be called from the classScript.

input()

Returns: the gotten text.
Scope: client.

Reads character from a client (via socket or pseudo terminal).

The attribute inDelimStat is affected:

2: if matched with inDelimStr2.
1: If matched with inDelimStr1.
0: Don't use (and if unexpected '\0' is encountered).
-1: If fd is closed (fd == -1).
-2: If fd is if (read() < 1). Are these stats even useful?
-3: If fd is if (read() != 1).

Example:

Inputting self's attributes...

....

See also: inputn(), socket, TTY, classHierarchy.

inputn(n)

Returns: the gotten text.
Scope: client.

Reads character from a client (via socket or pseudo terminal).

The argument n specifies the number of characters to read from the pipe. If n is more than there is to read, it'll will block (avoid this condition as viola doesn't yet have a way to escape from this).

The attribute inDelimStat is affected:

2: if matched with inDelimStr2.
1: If matched with inDelimStr1.
0: Don't use (and if unexpected '\0' is encountered).
-1: If fd is closed (fd == -1).
-2: If fd is if (read() < 1). Are these stats even useful?
-3: If fd is if (read() != 1).

Example:

Inputting self's attributes...

See also: input(), socket, TTY, classHierarchy.

insert(string)

Returns: undefined.
Scope: txtDisp.

Inserts text into the text field at the cursor point.

See also: txtDisp.

int(float|str|char)

Returns: integer number.
Scope: generic.

Converts argument to integer type.

Example:

print(int("2") + 3, '\n');

Output:

See also: txtDisp.

listAllObjects()

Returns: undefine.
Scope:

For dianostic purposes. Lists all objects currently loaded (created or otherwise referenced and caused to come to being).

loadFile(fileName)

Returns: file content.
Scope: generic.

Loads and returns content of a file. Error codes???

the interpreter will not permitted the execution of this method if the calling object's 'security' attribute is non zero.

Example:

print(loadFile("/etc/motd")); /* prints MOTD to stdout */

See also: txtDisp.

object(name)

Caution: the object struct pointer is the actual pointer to internal object data structure, as opposed to the string name of the object. Has efficiency benefits, but could raise problems if the object is short lived.

Returns: the named object in object type.
Scope: cosmic.

objectListAppend(objList, obj)

Returns: object count, -1 if the list is not found.
Scope: generic.

Append an object to a named object list.

objectListCount(objList)

Returns: object count, -1 if the list is not found.
Scope: generic.

Count the number of objects in a named object list.

objectListDelete(objList, obj)

Returns: object count, -1 if the list is not found.
Scope: generic

Delete an object from a named object list.

objectListPrepend(objList, obj)

Returns: object count, -1 if the list is not found.
Scope: generic.

Prepend an object to a named object list.

objectListSend(objectListName, arg1, arg2, ..., argn)

Returns: undefined.
Scope: generic.

Send the message to each objects in the object list.

objectPosition(obj, name of obj list)

Returns: Position (starting from 0), -1 if object is not found in list.
Scope: generic.

Return the position an object in the named object list.

In generic, possible lists are: children

output(str)

Returns: 1 on success, 0 on failure.
Scope: client.

Outputs characters to a client (via socket or pseudo terminal). The outDelimStr is appended to the output string.

See also: input(), inputn(), socket, TTY, classHierarchy.

previousCard()

Returns: an object in FCardList.
Scope: stack.

``Previous'' object in FCardList. See stack class for FCardList object list.

See also: firstCard(), lastCard(), stack.

previousCard()

Returns: an object in FCardList.
Scope: stack.

``Previous'' object in FCardList. See stack class for FCardList object list.

See also: firstCard(), lastCard(), stack.

previousTag()

Returns: tagged string, or nothing.
Scope: txtDisp.

Returns the embedded string associated with the character at the current cursor point. If no embedded string is found here, characters to the left, until the beginning of the line, is searched.

Example:

This text field object displays the string "12345".

What to expect: If you click on character '1', '2' or '3', you get the string "one". If you click on '4', you get "four". And, clicking on '5' gives you "five".

\name {pttest} \class {txtDisp} \content {1\e(one)234\e(four)5\e(five)} \script { if (arg[0] == "buttonPress") { if (es = previousTag()) { print("previousTag: ", es, ".\n"); } else { print("No embedded string detected.\n"); } } usual(); } \width {100} \height {100}

See also: txtDisp.

quit()

Returns: undefined.
Scope: cosmic

Exits program. (BUG: should saves currently loaded objects before exiting. For now, use save() to save objects).

Example:

quit();

See also: txtDisp.

sin(degree)

Returns: Sinine at the given degree.
Scope: generic.

Sine value at given degree.

See also: txtDisp.

tweak(object, script)

Returns: The last result of interpreting the script argument.
Scope: cosmic.

Interprets the given script string in context of the specified object. Try not to use this evil method. The interpreter will not permitted execution of this method if calling object's 'security' attribute is non zero.

Don't forget semicolons at the end of statements in the script!

Example:

Tell the object named "stranger" to set a variable, and change its name:

tweak("objStanger", "foo = 10;"); tweak("objStanger", "set(\"name\", \"objBuddy\");");

Make another object think you're its parent:

tweak("objOrphan", concat("set(\"parent\"", get("name"), ");"));

usual()

Returns: undefined.
Scope: cosmic.

Executes the caller object's classScript. See chapter ____ on more info on the classScript.

version()

Returns: (str) version string.
Scope: generic

Return the Viola version identifier string.

violaPath(str)

Returns: (int) number of paths set.
Scope: generic.

Set a new path for searching viola object files. The path can also set at start up time using the -path flag. In lieu of -path, the default path comes from the environment variable VIOLA_PATH. In lieu

Example:

violaPath("/usr/tmp/newObjs /usr/lib/viola/objs");

windowName(name)

Returns: window name.
Scope: field.

Allows you to set a window's name, which is displayed by the window title bar (depending on your window manager). The default window name is the name of the object.

Example:

windowName("Sbiffydyne Application");

windowPosition()

Find the caller window's x and y position in the root window's reference frame.

wp = windowPosition(); print("This window's position is at ", x, ", ", y, "\n");