All Classes

A Block is the fundamental unit of parsed and ready to execute sleep code.

To execute a block of code:

 ScriptInstance    script; // asume
 Block             code;   // assume
 
 ScriptEnvironment env   = script.getEnvironment();  
 Scalar            value = SleepUtils.runCode(code, env);
 

The variable value would contain the return value after the block was executed.

A check object is the internal atomic step representing a predicate condition.

The ConsoleImplementation is the "engine" behind the sleep console.

Blocks of code associated with an identifier are processed by their environment.

A Sleep evaluation is a way to define how a `back quoted` string should work.

Filtered environments are similar to normal keyword environments except they also allow a parameter specified by the user.

A function bridge is used to define a built-in function.

The IOObject is the parent class for all IO Source objects that are compatible with Sleep's I/O API.

When an IOObject is created, calling openRead() with the appropriate input stream will initialize this IOObject to work with IO functions that read data.

Arguments passed to functions with the form key => expression are available via the KeyValuePair object.

A loadable bridge is used to perform actions on scripts when they are loaded and unloaded.

An operator in sleep parlance is anything used to operate on two variables inside of an expression.

This class offers access to modify some settings within the sleep parser.

Install an Escape Constant

In sleep a character prefixed by a \ backslash within a "double quoted" string is said to be escaped.

A predicate is an operator used inside of comparisons.

Predicate environments are similar to normal keyword environments except instead of binding commands to an identifier they are bound to a predicate condition.

In general the sleep syntax for declaring a predicate environment is:

Script predicate environment bridge keywords should be registered with the script parser before any scripts are loaded.

A scalar is the universal data type for sleep variables.

This interface lets you implement your own data structure behind a scalar array.

To instantiate a custom scalar array:

When implementing the following interface, keep in mind you are implementing an interface to an array data structure.

This interface lets you create your own scalar hash implementation.

To create a new type of scalar hash: create a class that implements the sleep.runtime.ScalarHash interface.

This interface makes it possible to create a new scalar type.

This class contains methods for accessing the data stack, return value of a function, and the environment hashtable for a script.

The ScriptLoader is a convienence container for instantiating and managing ScriptInstances.

To load a script from a file and run it:

 ScriptLoader   loader = new ScriptLoader();
 ScriptInstance script = loader.loadScript("script.sl");

 script.runScript();
 

The above will load the file script.sl and then execute it immediately.

Installation of loadable bridges you create can also be managed by the ScriptLoader.

A loadable bridge is installed into the language by adding it to a script loader class.

This class provides a character translation utility similar to the UNIX tr command.

A variable bridge is a container for storing scalars.