"

Return an empty string.

Class: class:macro | Namespace: global | Interface Layer: all

$

Return ASCII:NUL (0).

Class: class:macro | Namespace: global | Interface Layer: all

'

Return an empty string.

Class: class:macro | Namespace: global | Interface Layer: all

(

Provide a visual indication of a code group.

Class: class:macro | Namespace: prefix | Interface Layer: all

)

Provide a visual indication of a code group.

Class: class:macro | Namespace: prefix | Interface Layer: all

*

Multiply `n1` by `n2` and return the result.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

+

Add `n1` to `n2` and return the result.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

,

Store the specified value into the memory at `here` and increment `Heap` by 1.

Class: class:word | Namespace: global | Interface Layer: all

Example:

-

Subtract `n2` from `n1` and return the result.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

---reveal---

Switch to the exposed (public) portion of a lexical namespace.

Class: class:word | Namespace: global | Interface Layer: all

-eq?

Compare two values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

-if

Execute the quotation if the flag is `FALSE`.

Class: class:word | Namespace: global | Interface Layer: all

-if;

Execute the quotation if the flag is `FALSE`. If false, also exit the word.

Class: class:word | Namespace: global | Interface Layer: all

/

Divide `n` by `m` and return the integer part of the quotient.

Class: class:word | Namespace: global | Interface Layer: all

/mod

Divide `n` by `m` and return the integer part of the quotient and remainder.

Class: class:primitive | Namespace: global | Interface Layer: all

0;

If `n` is zero, drop `n` and exit the current word. If non-zero, leave `n` alone and allow execution to continue.

Class: class:macro | Namespace: global | Interface Layer: all

;

End the current definition.

Class: class:macro | Namespace: global | Interface Layer: all

?dup

Duplicate top value on stack if not zero. If zero, do nothing.

Class: class:word | Namespace: global | Interface Layer: all

Example:

ASCII:ACK

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:BEL

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:BS

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:CAN

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:CR

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:DC1

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:DC2

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:DC3

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:DC4

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:DEL

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:DLE

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:EM

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:ENQ

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:EOT

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:ESC

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:ETB

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:ETX

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:FF

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:FS

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:GS

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:HT

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:LF

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:NAK

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:NUL

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:RS

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:SI

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:SO

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:SOH

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:SPACE

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:STX

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:SUB

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:SYN

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:US

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

ASCII:VT

Constant. Refers to specific ASCII code.

Class: class:data | Namespace: ASCII | Interface Layer: all

Compiler

Variable. Holds the compiler state. If TRUE, the compiler is active. If FALSE, it is not.

Class: class:data | Namespace: global | Interface Layer: all

Dictionary

Variable. Holds a pointer to the most recent dictionary header.

Class: class:data | Namespace: global | Interface Layer: all

EOM

Constant. Returns the last addressable memory address.

Class: class:word | Namespace: global | Interface Layer: all

FALSE

Returns `0`, the value used to indicate a FALSE result.

Class: class:word | Namespace: global | Interface Layer: all

FREE

Returns the number of cells available to your application. This is the amount of memory, less the already consumed portion and buffers mapped for RETRO's internal use.

Class: class:word | Namespace: global | Interface Layer: all

FullScreenListener

Variable. This is set by the startup flags to the rre interface. If `TRUE`, rre will run the `listen:fullscreen` interface for interactive use instead of the `listen` interface.

Class: class:data | Namespace: global | Interface Layer: rre

Heap

Variable. Holds the address of the next available cell.

Class: class:data | Namespace: global | Interface Layer: all

I

Access the loop index for the current loop. (For loops made using `times<with-index>`)

Class: class:word | Namespace: global | Interface Layer: all

J

Access the parent loop index for the current loop. (For loops made using `times<with-index>`)

Class: class:word | Namespace: global | Interface Layer: all

K

Access the grandparent loop index for the current loop. (For loops made using `times<with-index>`)

Class: class:word | Namespace: global | Interface Layer: all

NoEcho

Variable. If TRUE, allow display of the "ok" prompt and startup banner.

Class: class:word | Namespace: global | Interface Layer: rre

RewriteUnderscores

Variable. When set to `TRUE`, RETRO will replace underscores in strings with spaces. When `FALSE`, RETRO does not.

Class: class:data | Namespace: global | Interface Layer: all

STRINGS

Return the address of the start of the temporary string pool.

Class: class:word | Namespace: global | Interface Layer: all

ScopeList

Variable. This holds some information used by `{{` and `}}`.

Class: class:data | Namespace: global | Interface Layer: all

TIB

Constant. Returns a pointer to the text input buffer.

Class: class:data | Namespace: global | Interface Layer: rre

TRUE

Returns `-1`, the value used to indicate a TRUE result.

Class: class:word | Namespace: global | Interface Layer: all

TempStringMax

Variable. Holds the maximum length of a temporary string.

Class: class:data | Namespace: global | Interface Layer: all

TempStrings

Variable. Holds the number of temporary strings.

Class: class:data | Namespace: global | Interface Layer: all

Version

Variable. This stores the version number.

Class: class:data | Namespace: global | Interface Layer: all

[

Begin a quotation.

Class: class:macro | Namespace: global | Interface Layer: all

]

End a quotation.

Class: class:macro | Namespace: global | Interface Layer: all

a:-eq?

Compare all values in the array. Return `FALSE` if all values are equal or `TRUE` otherwise. This assumes the array contains only numeric values.

Class: class:word | Namespace: a | Interface Layer: all

a:append

Return a new array consisting of the values in a1 followed by the values in a2.

Class: class:word | Namespace: a | Interface Layer: all

a:begins-with?

Return `TRUE` if a1 begins with a2 or `FALSE` otherwise.

Class: class:word | Namespace: a | Interface Layer: all

a:chop

Return a new array containing all but the last value in the source array.

Class: class:word | Namespace: a | Interface Layer: all

a:contains-string?

Return `TRUE` if the string value is in the array or`FALSE` otherwise.

Class: class:word | Namespace: a | Interface Layer: all

a:contains?

Return `TRUE` if the value is in the array or `FALSE` otherwise.

Class: class:word | Namespace: a | Interface Layer: all

a:copy

Copy an array (a1) to a destination (a2).

Class: class:word | Namespace: a | Interface Layer: all

a:counted-results

Run a quote and construct a new array from the returned values. The quote should return the values and the number of values to put into the array.

Class: class:word | Namespace: a | Interface Layer: all

a:dup

Make a copy of an array. Return the address of the copy.

Class: class:word | Namespace: a | Interface Layer: all

a:ends-with?

Return `TRUE` if a1 ends with a2 or `FALSE` otherwise.

Class: class:word | Namespace: a | Interface Layer: all

a:eq?

Compare all values in the array. Return `TRUE` if all values are equal or `FALSE` otherwise. This assumes the array contains only numeric values.

Class: class:word | Namespace: a | Interface Layer: all

a:filter

For each item in the initial array, run the specified quote. If the quote returns `TRUE`, copy the item into a new array. If `FALSE`, discard it. Returns a pointer to the new array.

Class: class:word | Namespace: a | Interface Layer: all

a:for-each

Execute the quote once for each item in the array.

Class: class:word | Namespace: a | Interface Layer: all

a:from-string

Create a new array with the characters in the source string.

Class: class:word | Namespace: a | Interface Layer: all

a:index-of

Return the location of the first instance of the specified value in the array.

Class: class:word | Namespace: a | Interface Layer: all

a:left

Return a new array containing the first `n` values from the source array.

Class: class:word | Namespace: a | Interface Layer: all

a:length

Return the length of a array.

Class: class:word | Namespace: a | Interface Layer: all

a:make

Execute quote. Return a new array containing the values the quote leaves on the stack. This is identical to doing `a:counted-results a:reverse`

Class: class:word | Namespace: a | Interface Layer: all

a:map

Execute quote once for each item in the array. Constructs a new array from the value returned by the quote.

Class: class:word | Namespace: a | Interface Layer: all

a:middle

Extract a new array from the middle of the specified array. This will take the values starting at `f` and extend to the `l` last value.

Class: class:word | Namespace: a | Interface Layer: all

a:prepend

Return a new array consisting of the values in a2 followed by the values in a1.

Class: class:word | Namespace: a | Interface Layer: all

a:reduce

Takes an array, a starting value, and a quote. This will apply the quote to each item in the array; the quote should consume two values and return one.

Class: class:word | Namespace: a | Interface Layer: all

a:reverse

Reverse the order of items in a array. This will return a new array.

Class: class:word | Namespace: a | Interface Layer: all

a:right

Return a new array containing the specified number of values from the right side of the array.

Class: class:word | Namespace: a | Interface Layer: all

a:th

Return the actual address of the `n`th item in the array.

Class: class:word | Namespace: a | Interface Layer: all

a:to-string

Create a new string from the provided array. This string will be stored in the temporal string buffers.

Class: class:word | Namespace: a | Interface Layer: all

again

Close an unconditional loop. Branches back to the prior `repeat`.

Class: class:macro | Namespace: global | Interface Layer: all

allot

Allocate the specified number of cells from the `Heap`.

Class: class:word | Namespace: global | Interface Layer: all

Example:

and

Perform a bitwise AND operation between the two provided values.

Class: class:primitive | Namespace: global | Interface Layer: all

as{

Begin an assembly section.

Class: class:macro | Namespace: global | Interface Layer: all

banner

Display a welcome message on startup.

Class: class:word | Namespace: global | Interface Layer: rre

bi

Execute q1 against x, then execute q2 against a copy of x.

Class: class:word | Namespace: global | Interface Layer: all

Example:

bi*

Execute q1 against x and q2 against y.

Class: class:word | Namespace: global | Interface Layer: all

Example:

bi@

Execute q against x, then execute q against y.

Class: class:word | Namespace: global | Interface Layer: all

Example:

buffer:add

Append a value to the current buffer.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:empty

Reset the current buffer to an empty state.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:end

Return a pointer to the current end of the active buffer.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:get

Remove the last value from the current buffer.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:preserve

Save and restore the current buffer before and after executing the specified quote.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:set

Assign a new buffer as the current one.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:size

Return the number of cells in the buffer.

Class: class:word | Namespace: buffer | Interface Layer: all

buffer:start

Return the start address of the current buffer.

Class: class:word | Namespace: buffer | Interface Layer: all

bye

Exit RETRO.

Class: class:word | Namespace: global | Interface Layer: rre

c:-consonant?

Return TRUE if character is a not consonant or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:-digit?

Return TRUE if character is a not numeric digit or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:-lowercase?

Return TRUE if character is not lowercase or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:-uppercase?

Return TRUE if character is not uppercase or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:-visible?

Return TRUE if character is not printable or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:-vowel?

Return TRUE if character is not a vowel or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:-whitespace?

Return TRUE if character is not whitespace, or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:consonant?

Return TRUE if character is a consonant or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:digit?

Return TRUE if character is a numeric digit or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:get

Read a single keypress.

Class: class:word | Namespace: global | Interface Layer: rre

c:letter?

Return TRUE if character is an ASCII letter or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:lowercase?

Return TRUE if character is lowercase or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:put

Display a single character.

Class: class:word | Namespace: global | Interface Layer: all

c:to-lower

Convert character to lowercase equivalent.

Class: class:word | Namespace: c | Interface Layer: all

c:to-number

Convert an ASCII digit character into the corresponding decimal value

Class: class:word | Namespace: global | Interface Layer: all

c:to-string

Convert character into a string.

Class: class:word | Namespace: c | Interface Layer: all

c:to-upper

Convert character to uppercase equivalent.

Class: class:word | Namespace: c | Interface Layer: all

c:toggle-case

Convert an ASCII character to the opposite case.

Class: class:word | Namespace: c | Interface Layer: all

c:uppercase?

Return TRUE if character is uppercase or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:visible?

Return TRUE if character is printable or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:vowel?

Return TRUE if character is a vowel or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

c:whitespace?

Return TRUE if character is whitespace, or FALSE otherwise.

Class: class:word | Namespace: c | Interface Layer: all

call

Call a function.

Class: class:primitive | Namespace: global | Interface Layer: all

case

If `n` is equal to `m`, drop both and execute the specified quote before exiting the calling word. If not equal, leave `n` on the stack and let execution continue.

Class: class:word | Namespace: global | Interface Layer: all

choose

Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`.

Class: class:word | Namespace: global | Interface Layer: all

class:data

Class handler for data structures.

Interpret Time: Keep the address or value on the stack.

Compile Time: Compile the value or address as a literal into the current definition.

Class: class:word | Namespace: class | Interface Layer: all

class:macro

Class handler for compiler macros (immediate words)

Interpret Time: Execute the function at the provided address.

Compile Time: Execute the function at the provided address.

Class: class:word | Namespace: class | Interface Layer: all

class:primitive

Class handler for primitive words (words which map to Nga instructions)

Interpret Time: Execute the function.

Compile Time: Compile the machine code in the definiton into the current definition.

Class: class:word | Namespace: class | Interface Layer: all

class:word

Class handler for normal words.

Interpret Time: Execute the function at the provided address.

Compile Time: Compile a call to the specified address into the current definition.

Class: class:word | Namespace: class | Interface Layer: all

clear

Clear the display.

Class: class:word | Namespace: global | Interface Layer: rre

clock:day

Return the current day.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:hour

Return the current hour.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:minute

Return the current minute.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:month

Return the current month.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:second

Return the current second.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:utc:day

Return the current day.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:utc:hour

Return the current hour.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:utc:minute

Return the current minute.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:utc:month

Return the current month.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:utc:second

Return the current second.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:utc:year

Return the current year.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

clock:year

Return the current year.

Class: class:word | Namespace: clock | Interface Layer: iOS, rre

compile:call

Compile a call to the specified address into the current definition.

Class: class:word | Namespace: compile | Interface Layer: all

compile:jump

Compile a jump to the specified address into the current definition.

Class: class:word | Namespace: compile | Interface Layer: all

compile:lit

Compile the code to push a number to the stack into the current definition.

Class: class:word | Namespace: compile | Interface Layer: all

compile:ret

Compile a return instruction into the current definition.

Class: class:word | Namespace: compile | Interface Layer: all

compiling?

Return `TRUE` if compiler is on or `FALSE` otherwise.

Class: class:word | Namespace: global | Interface Layer: all

const

Create a constant returning the specified value.

Class: class:word | Namespace: global | Interface Layer: all

copy

Copy `l` cells from memory at `s` to the memory at `d`. These should not overlap.

Class: class:word | Namespace: global | Interface Layer: all

curry

Bind a value to a function and return a new quote that calls the bound action.

Class: class:word | Namespace: global | Interface Layer: all

d

Inline a numeric value to the current assembly segment.

Class: class:word | Namespace: global | Interface Layer: all

d:add-header

Create a header. Provide a string (s) for the name, a pointer to the class handler (a1) and a pointer to the word definition (a2) Generally this won't be used directly.

Class: class:word | Namespace: d | Interface Layer: all

d:class

Given a dictionary header, return the class field.

Class: class:word | Namespace: d | Interface Layer: all

d:create

Create a new dictionary header named the specified string. The new header will point to `here` and have a class of `class:data`.

Class: class:word | Namespace: d | Interface Layer: all

d:for-each

Execute the specified quote once for each header in the dictionary. Before running the quote, this also pushes a pointer to the header onto the stack.

Class: class:word | Namespace: d | Interface Layer: all

d:last

Return the most recent dictionary header.

Class: class:word | Namespace: d | Interface Layer: all

d:last<class>

Return a pointer to the class field of the most recent dictionary header.

Class: class:word | Namespace: d | Interface Layer: all

d:last<name>

Return a pointer to the name field of the most recent dictionary header.

Class: class:word | Namespace: d | Interface Layer: all

d:last<xt>

Return a pointer to the xt field of the most recent dictionary header.

Class: class:word | Namespace: d | Interface Layer: all

d:link

Given a dictionary header, return the link field.

Class: class:word | Namespace: d | Interface Layer: all

d:lookup

Lookup the specified name in the dictionary and return a pointer to its dictionary header. This returns zero if the word is not found.

Class: class:word | Namespace: d | Interface Layer: all

d:lookup-xt

Lookup the specified address in the dictionary and return a pointer to its dictionary header. This returns zero if the word is not found.

Class: class:word | Namespace: d | Interface Layer: all

d:name

Given a dictionary header, return the name field.

Class: class:word | Namespace: d | Interface Layer: all

d:words

Display a list of all named items in the `Dictionary`.

Class: class:word | Namespace: d | Interface Layer: rre

d:words-beginning-with

Display a list of all named items in the `Dictionary` that begin with the provided substring.

Class: class:word | Namespace: d | Interface Layer: rre

d:words-with

Display a list of all named items in the `Dictionary` that contain the provided substring.

Class: class:word | Namespace: d | Interface Layer: rre

d:xt

Given a dictionary header, return the xt field.

Class: class:word | Namespace: d | Interface Layer: all

data

Change the class of the most recently defined word to `class:data`.

Class: class:word | Namespace: global | Interface Layer: all

depth

Return the number of items on the stack.

Class: class:word | Namespace: global | Interface Layer: all

dip

Temporarily remove n from the stack, execute the quotation, and then restore n to the stack.

Class: class:word | Namespace: global | Interface Layer: all

does

Attach an action to the most recently created word. This is used in a manner similar to CREATE/DOES> in traditional Forth.

Class: class:word | Namespace: global | Interface Layer: all

drop

Discard the top value on the stack.

Class: class:primitive | Namespace: global | Interface Layer: all

drop-pair

Remove top two items on the stack.

Class: class:word | Namespace: global | Interface Layer: all

dump-stack

Display the items on the data stack.

Class: class:word | Namespace: global | Interface Layer: all

dup

Duplicate the top item on the stack.

Class: class:primitive | Namespace: global | Interface Layer: all

dup-pair

Duplicate the top two items on the stack.

Class: class:word | Namespace: global | Interface Layer: all

e:-INF

Constant. Negative infinity. For encoded floating point values.

Class: class:word | Namespace: e | Interface Layer: rre

e:-inf?

Is encoded value negative infinity?

Class: class:word | Namespace: e | Interface Layer: rre

e:INF

Constant. Infinity. For encoded floating point values.

Class: class:word | Namespace: e | Interface Layer: rre

e:MAX

Constant. Maximum value. For encoded floating point values.

Class: class:word | Namespace: e | Interface Layer: rre

e:MIN

Constant. Minimum value. For encoded floating point values.

Class: class:word | Namespace: e | Interface Layer: rre

e:NAN

Constant. Not a Number. For encoded floating point values.

Class: class:word | Namespace: e | Interface Layer: rre

e:clip

Constrain the encoded value to the allowable range.

Class: class:word | Namespace: e | Interface Layer: rre

e:inf?

Is encoded value infinity?

Class: class:word | Namespace: e | Interface Layer: rre

e:max?

Is encoded value at the maximum?

Class: class:word | Namespace: e | Interface Layer: rre

e:min?

Is encoded value at the minimum?

Class: class:word | Namespace: e | Interface Layer: rre

e:n?

Return `TRUE` if the encoded value is a valid number, or `FALSE` otherwise.

Class: class:word | Namespace: e | Interface Layer: rre

e:nan?

Is encoded value a Nan?

Class: class:word | Namespace: e | Interface Layer: rre

e:put

Display an encoded number.

Class: class:word | Namespace: e | Interface Layer: rre

e:to-f

Decode an encoded floating point value.

Class: class:word | Namespace: e | Interface Layer: rre

e:zero?

Return `TRUE` if the value is zero, or `FALSE` otherwise.

Class: class:word | Namespace: e | Interface Layer: rre

eq?

Compare two values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

err:notfound

Error handler. Called when a word is not found by `interpret`.

Class: class:word | Namespace: err | Interface Layer: all

f:*

Multiply two floating point numbers, returning the result.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:+

Add two floating point numbers, returning the result.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:-

Subtract F2 from F1 returing the result.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:-INF

Return a value corresponding to negative infinity

Class: class:word | Namespace: f | Interface Layer: rre

f:-eq?

Compare two floating point values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise.

Class: class:word | Namespace: f | Interface Layer: rre

f:-inf?

Return `TRUE` if floating point value is -INF or `FALSE` otherwise.

Class: class:word | Namespace: f | Interface Layer: rre

f:/

Divide floating point value F1 by F2.

Class: class:word | Namespace: f | Interface Layer: rre

f:E

Return the floating point value for Euler's number.

Class: class:word | Namespace: f | Interface Layer: rre

f:E1

Hook. Return a constant used as the scaling factor for the e: words.

Class: class:word | Namespace: f | Interface Layer: rre

f:INF

Return a value corresponding to positive infinity

Class: class:word | Namespace: f | Interface Layer: rre

f:NAN

Return a value corresponding to NaN

Class: class:word | Namespace: f | Interface Layer: rre

f:PI

Return the floating point value for PI.

Class: class:word | Namespace: f | Interface Layer: rre

f:abs

Return the absolute value for a floating point value.

Class: class:word | Namespace: f | Interface Layer: rre

f:acos

Return the arc cosine of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:adepth

Return the number of items on the alternate floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:asin

Return the arc sine of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:atan

Return the arc tangent of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:between?

Return TRUE if number is between the lower (l) and upper (u) bounds. If not, return FALSE. This is inclusive of the limits.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:case

If `n` is equal to `m`, drop both and execute the specified quote before exiting the calling word. If not equal, leave `n` on the stack and let execution continue.

Class: class:word | Namespace: f | Interface Layer: rre

f:ceiling

Return the smallest integral value greater than or equal to the specified value.

Class: class:word | Namespace: f | Interface Layer: rre

f:cos

Return the cosine of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:dec

Decrement n by one.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:depth

Return the number of items on the floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:drop

Discard the top item on the floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:drop-pair

Remove top two items on the stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:dump-astack

Display the items on the alternate floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:dump-stack

Display the items on the floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:dup

Duplicate the top item on the floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:dup-pair

Duplicate the top two items on the stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:eq?

Compare two floating point values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise.

Class: class:word | Namespace: f | Interface Layer: rre

f:fetch

Fetch a stored floating point value.

Class: class:word | Namespace: f | Interface Layer: rre

f:floor

Perform a mathmatical floor operation on the floating point value.

Class: class:word | Namespace: f | Interface Layer: rre

f:gt?

Compare two floating point values for greater than.

Class: class:word | Namespace: f | Interface Layer: rre

f:inc

Increment n by one.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:inf?

Return `TRUE` if floating point value is INF or `FALSE` otherwise.

Class: class:word | Namespace: f | Interface Layer: rre

f:limit

Return n if it is within the lower (l) and upper (u) bounds. If outside the bounds, return the closes boundary value.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:log

Return log(F1) for base F2 for floating point values.

Class: class:word | Namespace: f | Interface Layer: rre

f:lt?

Compare two floating point values for less than.

Class: class:word | Namespace: f | Interface Layer: rre

f:max

Return the greater of two values.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:min

Return the lesser of two values.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:nan?

Return `TRUE` if floating point value is NaN or `FALSE` otherwise.

Class: class:word | Namespace: f | Interface Layer: rre

f:negate

Invert the sign of the floating point value.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:negative?

Return `TRUE` if floating point value is negative or `FALSE` if not.

Class: class:word | Namespace: f | Interface Layer: rre

f:nip

Remove the second item from the stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:over

Put a copy of the second floating point value over the top one.

Class: class:word | Namespace: f | Interface Layer: rre

f:pop

Pop a floating point value from the alternate stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:positive?

Return `TRUE` if floating point value is positive or `FALSE` otherwise.

Class: class:word | Namespace: f | Interface Layer: rre

f:power

Return F1^F2 for floating point values.

Class: class:word | Namespace: f | Interface Layer: rre

f:push

Push a floating point value to an alternative stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:put

Display a floating point number.

Class: class:word | Namespace: global | Interface Layer: rre

f:rot

Rotate the top three values.

Class: class:word | Namespace: f | Interface Layer: rre

f:round

Round a floating point value.

Class: class:word | Namespace: f | Interface Layer: rre

f:sign

Return 1 if the floating point value is positive or -1 if it is negative.

Class: class:word | Namespace: f | Interface Layer: rre

Example:

f:signed-sqrt

Return the square root of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:signed-square

Return the square of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:sin

Return the sine of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:sqrt

Return the square root of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:square

Return the square of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:store

Store a floating point value to the specified memory location.

Class: class:word | Namespace: f | Interface Layer: rre

f:swap

Exchange the top and second items on the floating point stack.

Class: class:word | Namespace: f | Interface Layer: rre

f:tan

Return the tangent of a floating point number.

Class: class:word | Namespace: f | Interface Layer: rre

f:to-e

Encode the floating point value to an integer.

Class: class:word | Namespace: f | Interface Layer: rre

f:to-number

Convert a floating point value into a number.

Class: class:word | Namespace: f | Interface Layer: rre

f:to-string

Convert a floating point value into a string.

Class: class:word | Namespace: f | Interface Layer: rre

f:tuck

Tuck a copy of the top floating point value under the second one.

Class: class:word | Namespace: f | Interface Layer: rre

fetch

Fetch the value stored at the specified address.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

fetch-next

Fetch the value stored at the specified address. Returns the next address and the value.

Class: class:word | Namespace: global | Interface Layer: all

file:A

Constant for opening a file in APPEND mode.

Class: class:data | Namespace: file | Interface Layer: rre

file:R

Constant for opening a file in READ mode.

Class: class:data | Namespace: file | Interface Layer: rre

file:R+

Constant for opening a file in READ & WRITE mode.

Class: class:data | Namespace: file | Interface Layer: rre

file:W

Constant for opening a file in WRITE mode.

Class: class:data | Namespace: file | Interface Layer: rre

file:close

Given a file handle, close the file.

Class: class:word | Namespace: file | Interface Layer: rre

file:delete

Delete the named file.

Class: class:word | Namespace: file | Interface Layer: rre

file:exists?

Given a file name, return `TRUE` if it exists or `FALSE` if it does not.

Class: class:word | Namespace: file | Interface Layer: rre

file:flush

Given a file handle, flush any pending writes to disk.

Class: class:word | Namespace: file | Interface Layer: rre

file:for-each-line

Given a file name, open it and run the quote once for each line in the file.

Class: class:word | Namespace: file | Interface Layer: rre

file:open

Open a named file (s) with the given mode (m). Returns a handle identifying the file.

Class: class:word | Namespace: file | Interface Layer: rre

Example:

file:open<for-append>

Open a file for reading & writing. Returns the size (NOS) and a file ID (TOS)

Class: class:word | Namespace: file | Interface Layer: rre

file:open<for-reading>

Open a file for reading. Returns the size (NOS) and a file ID (TOS)

Class: class:word | Namespace: file | Interface Layer: rre

file:open<for-writing>

Open a file for writing. Returns the file ID

Class: class:word | Namespace: file | Interface Layer: rre

file:read

Given a file handle, read and return the next character in it.

Class: class:word | Namespace: file | Interface Layer: rre

file:read-line

Given a file handle, read a line and return a pointer to it.

Class: class:word | Namespace: file | Interface Layer: rre

file:seek

Move the current offset into a file to the specified one.

Class: class:word | Namespace: file | Interface Layer: rre

file:size

Given a file handle, return the size of the file (in bytes).

Class: class:word | Namespace: file | Interface Layer: rre

file:slurp

Given an address and a file name, read the file contents into memory starting at the address.

Class: class:word | Namespace: file | Interface Layer: rre

file:spew

Given a string (s1) and a file name (s2), write the string into the file, replacing any existing cotent.

Class: class:word | Namespace: file | Interface Layer: rre

file:tell

Given a file handle, return the current offset in the file.

Class: class:word | Namespace: file | Interface Layer: rre

file:write

Write a character to the file represented by the handle.

Class: class:word | Namespace: file | Interface Layer: rre

gopher:get

Takes an address, a server, a port, and a selector. Fetch the resource and store it at address. Return the number of bytes received.

Class: class:word | Namespace: gopher | Interface Layer: rre

Example:

gt?

Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise.

Class: class:primitive | Namespace: global | Interface Layer: all

gteq?

Compare n1 and n2. Return `TRUE` if n1 is greater than or equal to n2, or `FALSE` otherwise.

Class: class:word | Namespace: global | Interface Layer: all

here

Return the next free address in memory.

Class: class:word | Namespace: global | Interface Layer: all

hook

Add a hook point into the current word. This should only be used as the first word in a definition.

Class: class:macro | Namespace: global | Interface Layer: global

Example:

i

Assemble the instructions specified by the string into the current assembly scope.

Class: class:word | Namespace: global | Interface Layer: all

if

Execute the quote if the flag is `TRUE`.

Class: class:word | Namespace: global | Interface Layer: all

if;

Execute the quotation if the flag is `TRUE`. If true, also exit the word.

Class: class:word | Namespace: global | Interface Layer: all

image:save

Save the current system to a new image file.

Class: class:word | Namespace: image | Interface Layer: rre

immediate

Change the class of the most recently defined word to `class:macro`.

Class: class:word | Namespace: global | Interface Layer: all

include

Run the code in the specified file.

Class: class:word | Namespace: global | Interface Layer: rre

interpret

Interpret a single input token.

Class: class:word | Namespace: global | Interface Layer: all

Example:

io:enumerate

Return the number of I/O devices.

Class: class:word | Namespace: io | Interface Layer: all

io:file-operation

Trigger a file I/O operation. This is not intended to be used directly.

Class: class:word | Namespace: io | Interface Layer: rre

io:float-operation

Trigger a floating point operation. This is not intended to be used directly.

Class: class:word | Namespace: io | Interface Layer: rre

io:invoke

Invoke an interaction with an I/O device.

Class: class:word | Namespace: io | Interface Layer: all

io:query

Ask an I/O device to identify itself. Returns a version (m) and device ID (N).

Class: class:word | Namespace: io | Interface Layer: all

io:scan-for

Scan the I/O devices for a device with a specified ID. Returns the device number, or -1 if not found.

Class: class:word | Namespace: io | Interface Layer: all

io:unix-syscall

Trigger a Unix system call. This is not intended to be used directly.

Class: class:word | Namespace: io | Interface Layer: rre

listen

Run interactive "listener" (a REPL).

Class: class:word | Namespace: global | Interface Layer: rre

listen:fullscreen

Run interactive "listener" (a REPL) in fullscreen mode (with a minimalistic console UI).

Class: class:word | Namespace: listen | Interface Layer: rre

listen:fullscreen:bye

Exit RETRO while running the fullscreen listener.

Class: class:word | Namespace: listen | Interface Layer: rre

lt?

Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise.

Class: class:primitive | Namespace: global | Interface Layer: all

lteq?

Compare n1 and n2. Return `TRUE` if n1 is less than or equal to n2, or `FALSE` otherwise.

Class: class:word | Namespace: global | Interface Layer: all

mod

Divide `n` by `m` and return the remainder.

Class: class:word | Namespace: global | Interface Layer: all

n:-zero?

Return `TRUE` if number is not zero, or `FALSE` otherwise.

Class: class:word | Namespace: n | Interface Layer: all

n:MAX

Return the maximum value that will fit in a cell.

Class: class:word | Namespace: n | Interface Layer: all

n:MIN

Return the minimum value that will fit in a cell.

Class: class:word | Namespace: n | Interface Layer: all

n:abs

Return the absolute value of a number.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:between?

Return TRUE if number is between the lower (l) and upper (u) bounds. If not, return FALSE. This is inclusive of the limits.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:dec

Decrement n by one.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:even?

Return `TRUE` if number is even, or `FALSE` if not.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:inc

Increment n by one.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:limit

Return n if it is within the lower (l) and upper (u) bounds. If outside the bounds, return the closes boundary value.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:max

Return the greater of two values.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:min

Return the lesser of two values.

Class: class:word | Namespace: n | Interface Layer: all

Example:

n:negate

Invert the sign of a number.

Class: class:word | Namespace: n | Interface Layer: rre

Example:

n:negative?

Return `TRUE` if number is negative, or `FALSE` if not.

Class: class:word | Namespace: n | Interface Layer: all

n:odd?

Return `TRUE` if number is odd, or `FALSE` if not.

Class: class:word | Namespace: n | Interface Layer: all

n:positive?

Return `TRUE` if number is positive, or `FALSE` if not.

Class: class:word | Namespace: n | Interface Layer: all

n:pow

Return base (b) to power (p).

Class: class:word | Namespace: n | Interface Layer: all

n:put

Display a number.

Class: class:word | Namespace: global | Interface Layer: all

n:random

Return a random number

Class: class:word | Namespace: n | Interface Layer: rre, ri

Example:

n:sqrt

Return the square root of a number.

Class: class:word | Namespace: n | Interface Layer: all

n:square

Return the square of a number.

Class: class:word | Namespace: n | Interface Layer: all

n:strictly-positive?

Return TRUE if number is greater than zero or FALSE if it is zero or less.

Class: class:word | Namespace: n | Interface Layer: all

n:to-float

Convert a number into a floating point value.

Class: class:word | Namespace: n | Interface Layer: rre

n:to-string

Convert a number into a string.

Class: class:word | Namespace: n | Interface Layer: all

n:zero?

Return `TRUE` if number is zero, or `FALSE` otherwise.

Class: class:word | Namespace: n | Interface Layer: all

nip

Remove the second item from the stack.

Class: class:word | Namespace: global | Interface Layer: all

nl

Display a newline.

Class: class:word | Namespace: global | Interface Layer: all

not

Perform a logical NOT operation.

Class: class:word | Namespace: global | Interface Layer: all

or

Perform a bitwise OR between the provided values.

Class: class:primitive | Namespace: global | Interface Layer: all

over

Put a copy of n over m.

Class: class:word | Namespace: global | Interface Layer: all

parse-until

Read input from stdin (via `c:get`) until the returned character is matched by the quote. Returns a string.

Class: class:word | Namespace: all | Interface Layer: rre

Example:

pb:get

Copy a string from the pasteboard to the specified address.

Class: class:word | Namespace: pb | Interface Layer: iOS

pb:length

Return the length of the string on the pasteboard.

Class: class:word | Namespace: pb | Interface Layer: iOS

Example:

pb:set

Copy a string to the pasteboard.

Class: class:word | Namespace: pb | Interface Layer: iOS

pop

Move a value from the return stack to the data stack.

Class: class:macro | Namespace: global | Interface Layer: all

prefix:!

Store a value into a variable.

Interpret Time: Store a value into the named variable.

Compile Time: Compile the code to store a value into a named variable.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:"

Process token as a string.

Interpret Time: Keep string as permanent. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space.

Compile Time: Keep string as permanent. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space. Then compile the string into the current definition.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:#

Process token as a number.

Interpret Time: Convert the string into a number and leave on the stack.

Compile Time: Convert the string into a number and compile into the current definition as a literal.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:$

Process token as an ASCII character.

Interpret Time: Fetch first character from string. Leave on stack.

Compile Time: Fetch first character from the string. Compile into the current definition as literal.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:&

Return a pointer to a named item.

Interpret Time: Lookup name in dictionary, return contents of the xt field on the stack.

Compile Time: Lookup name in dictionary, compile code to push the contents of the xt field into the current definition.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:'

Process token as a string.

Interpret Time: Move string into temporary buffer. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space.

Compile Time: Move string into temporary buffer. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space. Then compile the string into the current definition.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:(

Process token as a comment.

Interpret Time: Discard the string.

Compile Time: Discard the string.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:.

Interpret time: convert string to a floating point value. Compile time: convert string to a floating point value and compile code to push this value to the float stack.

Class: class:macro | Namespace: prefix | Interface Layer: rre

prefix::

Process token as a new definition.

Interpret Time: Create a header pointing to `here` with the provided string as the name. Sets class to `class:word`.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:@

Fetch from a stored variable.

Interpret Time: Fetch a value from a named variable.

Compile Time: Compile the code to fetch a value from a named variable into the current definition.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:`

Process token as a bytecode.

Interpret Time: Discard the string.

Compile Time: Convert the string to a number and use `,` to inline it into the current definition.

Class: class:macro | Namespace: prefix | Interface Layer: all

prefix:|

POSTPONE equivalent.

Interpret Time: Discard the string.

Compile Time: Convert the string to a number and use `,` to inline it into the current definition.

Class: class:macro | Namespace: prefix | Interface Layer: all

primitive

Change the class of the most recently defined word to `class:primitive`.

Class: class:word | Namespace: global | Interface Layer: all

push

Move a value from the data stack to the return stack.

Class: class:macro | Namespace: global | Interface Layer: all

r

Lookup a reference by name and inline its pointer to the current assembly segment.

Class: class:word | Namespace: global | Interface Layer: all

random:mersenne

Return a random number using a mersenne shifter

Class: class:word | Namespace: random | Interface Layer: rre, ri

random:mersenne:set-seed

Seed random:mersenne with the specified value

Class: class:word | Namespace: random | Interface Layer: rre, ri

random:xoroshiro128**

Return a random number using xoroshiro128**

Class: class:word | Namespace: random | Interface Layer: rre, ri

random:xoroshiro128**:jump

Updates the internal xoroshiro128** state registers with the equivalent of 2^64 calls to random:xoroshiro128**.

Class: class:word | Namespace: random | Interface Layer: rre, ri

random:xoroshiro128**:set-seed

Seed random:xoroshiro128** with the specified value

Class: class:word | Namespace: random | Interface Layer: rre, ri

random:xoroshiro128**:test-seed

Sets the internal xoroshiro128** state registers s0..s3 starting with TOS.

Class: class:word | Namespace: random | Interface Layer: rre, ri

reclass

Change the class handler of the most recently defined word to the specified one.

Class: class:word | Namespace: global | Interface Layer: all

reorder

Restructure the order of items on the stack.

Class: class:word | Namespace: global | Interface Layer: all

repeat

Begin an unconditional loop.

Class: class:macro | Namespace: global | Interface Layer: all

reset

Remove all items from the stack.

Class: class:word | Namespace: global | Interface Layer: all

rot

Rotate the top three values.

Class: class:word | Namespace: global | Interface Layer: all

s,

Compile the code needed to push a string pointer to the stack and inline the string data into the current definition.

Class: class:word | Namespace: global | Interface Layer: all

s:ASCII-LETTERS

Constant. Returns a string of the ASCII letters (upper and lower case)

Class: class:data | Namespace: s | Interface Layer: all

s:ASCII-LOWERCASE

Constant. Returns a string of the ASCII letters in lowercase

Class: class:data | Namespace: s | Interface Layer: all

s:ASCII-UPPERCASE

Constant. Returns a string of the ASCII letters in uppercase

Class: class:data | Namespace: s | Interface Layer: all

s:DIGITS

Constant. Return a string of characters recognized as numeric digits.

Class: class:data | Namespace: s | Interface Layer: all

s:PUNCTUATION

Constant. Return a string of characters recognized as punctuation.

Class: class:data | Namespace: s | Interface Layer: all

s:WHITESPACE

Constant. Returns a string of characters recognized as whitespace.

Class: class:data | Namespace: s | Interface Layer: all

s:append

Return a new string consisting of s1 followed by s2.

Class: class:word | Namespace: s | Interface Layer: all

s:begins-with?

Return `TRUE` if s1 begins with s2 or `FALSE` otherwise.

Class: class:word | Namespace: s | Interface Layer: all

s:case

If the `s` matches `S`, discard `s` and run the quote before exiting the caller. If they do not match, discard the quote and leave `s` on the stack.

Class: class:word | Namespace: s | Interface Layer: all

s:chop

Remove the last character from a string. Returns a new string.

Class: class:word | Namespace: s | Interface Layer: all

s:const

Create a constant named s2, returning a pointer to s1. This will use `s:keep` to preserve the original string.

Class: class:word | Namespace: s | Interface Layer: all

s:contains-char?

Return `TRUE` if the character is present in the string or `FALSE` otherwise.

Class: class:word | Namespace: s | Interface Layer: all

s:contains-string?

Return `TRUE` if the second string is present in the first string or `FALSE` otherwise.

Class: class:word | Namespace: s | Interface Layer: all

s:copy

Copy a string (s) to a destination (a). This will include the terminator character when copying.

Class: class:word | Namespace: s | Interface Layer: all

s:empty

Return an empty string.

Class: class:word | Namespace: s | Interface Layer: all

s:ends-with?

Return `TRUE` if s1 ends with s2 or `FALSE` otherwise.

Class: class:word | Namespace: s | Interface Layer: all

s:eq?

Compare two strings for equality. Return `TRUE` if identical or `FALSE` if not.

Class: class:word | Namespace: s | Interface Layer: all

Example:

s:evaluate

Evaluate string as if it was typed into the interpreter.

Class: class:word | Namespace: s | Interface Layer: all

s:filter

Execute the quote once for each value in the string. If the quote returns `TRUE`, append the value into a new string. If `FALSE` the value will be discarded.

Class: class:word | Namespace: s | Interface Layer: all

s:for-each

Execute the quote once for each value in the string.

Class: class:word | Namespace: s | Interface Layer: all

s:format

Construct a new string using the template passed and items from the stack.

Class: class:word | Namespace: s | Interface Layer: all

s:get

Read input from standard in (via `c:get`) until a CR or LF is encountered. Returns a strig.

Class: class:word | Namespace: all | Interface Layer: rre

s:hash

Calculate a hash value for a string. This uses the djb2 algorithm.

Class: class:word | Namespace: s | Interface Layer: all

s:index-of

Return the location of the first instance of the specified character in the string.

Class: class:word | Namespace: s | Interface Layer: all

s:index-of-string

Return the location of the first instance of the specified substring (s2) in the string (s1). Returns -1 if not found.

Class: class:word | Namespace: s | Interface Layer: all

s:keep

Store a string into the heap and return a pointer to the start of it.

Class: class:word | Namespace: s | Interface Layer: all

s:left

Return a new string containing the first `n` characters from the source string.

Class: class:word | Namespace: s | Interface Layer: all

s:length

Return the number of characters in a string, excluding the NULL terminator.

Class: class:word | Namespace: s | Interface Layer: all

s:map

Execute the specified quote once for each character in the string. Builds a new string from the return value of the quote. The quote should return only one value.

Class: class:word | Namespace: s | Interface Layer: all

s:prepend

Return a new string consisting of s2 followed by s1.

Class: class:word | Namespace: s | Interface Layer: all

s:put

Display a string.

Class: class:word | Namespace: global | Interface Layer: all

s:replace

Replace the first instance of s2 in s1 with s3.

Class: class:word | Namespace: s | Interface Layer: all

s:reverse

Reverse the order of ASCII characters in a string.

Class: class:word | Namespace: s | Interface Layer: all

s:right

Return a new string containing the specified number of characters from the right side of the string.

Class: class:word | Namespace: s | Interface Layer: all

s:skip

Internal helper function used to skip over a string in a definition.

Class: class:word | Namespace: s | Interface Layer: all

s:split

Split a string on the first occurrance of the specified character.

Class: class:word | Namespace: s | Interface Layer: all

s:split-on-string

Split a string on the first occurrance of the specified string. After the split, the top stack item will be the part of the string before the specified subsring, and the second item will be the rest of the original string.

Class: class:word | Namespace: s | Interface Layer: all

Example:

s:substr

Extract a substring from the specified string. This will take the characters starting at `f` and extend `l` characters in length.

Class: class:word | Namespace: s | Interface Layer: all

s:temp

Move a string into the temporary string buffers.

Class: class:word | Namespace: s | Interface Layer: all

s:to-float

Convert a string representation into a floating point value.

Class: class:word | Namespace: s | Interface Layer: rre

s:to-lower

Convert uppercase ASCII characters in a string to lowercase.

Class: class:word | Namespace: s | Interface Layer: all

s:to-number

Convert a string to a number.

Class: class:word | Namespace: s | Interface Layer: all

s:to-upper

Convert lowercase ASCII characters in a string to uppercase.

Class: class:word | Namespace: s | Interface Layer: all

s:tokenize

Takes a string and a character to use as a separator. It splits the string into substrings and returns an array containing pointers to each of them.

Class: class:word | Namespace: s | Interface Layer: all

s:tokenize-on-string

Takes a string (s1) and a substring (s2) use as a separator. It splits the string into substrings and returns as array containing pointers to each of them.

Class: class:word | Namespace: s | Interface Layer: all

s:trim

Trim leading and trailing whitespace from a string.

Class: class:word | Namespace: s | Interface Layer: all

Example:

s:trim-left

Trim leading whitespace from a string.

Class: class:word | Namespace: s | Interface Layer: all

Example:

s:trim-right

Trim trailing whitespace from a string.

Class: class:word | Namespace: s | Interface Layer: all

Example:

set-hook

Patch the hook point in a2 to point to a1.

Class: class:word | Namespace: global | Interface Layer: all

Example:

shift

Peform a bitwise shift of m by n bits. If n is positive, shift right. If negative, the shift will be to the left.

Class: class:primitive | Namespace: global | Interface Layer: all

sip

Run quote. After execution completes, put a copy of n back on top of the stack.

Class: class:word | Namespace: global | Interface Layer: all

sp

Display a space (`ASCII:SPACE`)

Class: class:word | Namespace: global | Interface Layer: all

Example:

store

Store a value into the specified address.

Class: class:primitive | Namespace: global | Interface Layer: all

Example:

store-next

Store a value into the specified address and return the next address.

Class: class:word | Namespace: global | Interface Layer: all

swap

Exchange the position of the top two items on the stack

Class: class:primitive | Namespace: global | Interface Layer: all

sys:argc

Return the number of arguments passed to the program.

Class: class:word | Namespace: sys | Interface Layer: rre

sys:argv

Given an argument number, return the argument as a string.

Class: class:word | Namespace: sys | Interface Layer: rre

sys:name

Return the filename of the program being run.

Class: class:word | Namespace: sys | Interface Layer: rre

tab

Display a tab (`ASCII:HT`)

Class: class:word | Namespace: global | Interface Layer: all

times

Run the specified quote the specified number of times.

Class: class:word | Namespace: global | Interface Layer: all

Example:

times<with-index>

Run a quote the specified number of times, tracking the loop index in `I`.

Class: class:word | Namespace: global | Interface Layer: all

tri

Apply q1 against x, then q2 against a copy of x, and finally q3 against another copy of x.

Class: class:word | Namespace: global | Interface Layer: all

tri*

Apply q1 against x, q2 against y, and q3 against z.

Class: class:word | Namespace: global | Interface Layer: all

tri@

Apply q against x, then against y, and finally against z.

Class: class:word | Namespace: global | Interface Layer: all

tuck

Put a copy of the top item on the stack under the second one.

Class: class:word | Namespace: global | Interface Layer: all

unhook

Reset the hook point in a1 to the default definition.

Class: class:word | Namespace: global | Interface Layer: all

Example:

unix:chdir

Change the current working directory to the specified one.

Class: class:word | Namespace: unix | Interface Layer: rre

Example:

unix:count-files-in-cwd

Return the number of files (and subdirectories) in the current working directory

Class: class:word | Namespace: unix | Interface Layer: rre

unix:exec0

Execute a process by running the application specified by s.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:exec1

Execute a process by running the application specified by s1. Pass s2 as an argument.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:exec2

Execute a process by running the application specified by s1. Pass s2 and s3 as arguments.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:exec3

Execute a process by running the application specified by s1. Pass s2, s3, and s4 as arguments.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:exit

Exit the current process, returning the specified return code.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:for-each-file

Run a quote once for each file or subdirectory in the current directory. The quote will receive the file name as a string and should consume this and return nothing on the stack.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:fork

Fork the current process. Returns a PID.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:get-cwd

Return the current working directory

Class: class:word | Namespace: unix | Interface Layer: rre

unix:getenv

Get an environment variable. Provide the name and an address to store it in.

Class: class:word | Namespace: unix | Interface Layer: rre

Example:

unix:getpid

Return the PID of the current process.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:io:n:put

Display a number (in base 10) to the standard output device. This is faster than `n:put`, but not portable.

Class: class:word | Namespace: unix:io | Interface Layer: rre

unix:io:s:put

Display a string to stdout. This is faster than `s:put`, but not portable.

Class: class:word | Namespace: unix:io | Interface Layer: rre

unix:kill

Terminates a process. Takes a process and a signal to send.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:pclose

Close a pipe.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:popen

Open a pipe. Takes a command to run, and a file mode (`file:R` or `file:W`; `file:R+` may work on some systems). Returns a file ID usable with words in the `file:` namespace.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:putenv

Takes a string in the form `name=value` and sets an environment variable named `name` to `value`.

Class: class:word | Namespace: unix | Interface Layer: rre

Example:

unix:sleep

Sleep for the specified number of seconds.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:system

Runs another application using the system shell and returns after execution is completed.

Class: class:word | Namespace: unix | Interface Layer: rre

Example:

unix:time

Return a timestamp.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:wait

Waits for a child process to complete. This maps to the wait() system call.

Class: class:word | Namespace: unix | Interface Layer: rre

unix:write

Write a string to the specified file handle.

Class: class:word | Namespace: unix | Interface Layer: rre

until

Execute quote repeatedly while the quote returns a value of `FALSE`. The quote should return a flag of either `TRUE` or `FALSE`, though `until` will treat any non-zero value as `TRUE`.

Class: class:word | Namespace: global | Interface Layer: all

Example:

v:dec

Decrement the value stored at the specified address by 1.

Class: class:word | Namespace: v | Interface Layer: all

v:dec-by

Decrement the value stored at the specified address by the specified value.

Class: class:word | Namespace: v | Interface Layer: all

v:inc

Increment the value stored at the specified address by 1.

Class: class:word | Namespace: v | Interface Layer: all

v:inc-by

Increment the value stored at the specified address by the specified value.

Class: class:word | Namespace: v | Interface Layer: all

v:limit

Fetch the value stored at the address, then run `n:limit` against it, using the specified lower and upper bounds. Then store the resulting value back to the original address.

Class: class:word | Namespace: v | Interface Layer: all

v:off

Set a variable to 0.

Class: class:word | Namespace: v | Interface Layer: all

v:on

Set a variable to -1.

Class: class:word | Namespace: v | Interface Layer: all

v:preserve

Make a copy of the value at the address, then run the quote. Once the quote completes, restore the address to the specified value.

Class: class:word | Namespace: v | Interface Layer: all

v:update-using

Fetch a value from the specified address, then run the quotation with this value on the stack. Afterwards, store the returned value at the original address.

Class: class:word | Namespace: v | Interface Layer: all

var

Create a variable. The variable is initialized to 0.

Class: class:word | Namespace: global | Interface Layer: all

Example:

var<n>

Create a variable with the specified initial value.

Class: class:word | Namespace: global | Interface Layer: all

Example:

while

Execute quote repeatedly while the quote returns a `TRUE` value. The quote should return a flag of either `TRUE` or `FALSE`, though `while` will treat any non-zero value as `TRUE`.

Class: class:word | Namespace: global | Interface Layer: all

Example:

xor

Perform a bitwise XOR operation.

Class: class:primitive | Namespace: global | Interface Layer: all

{

Begin an array. This is intended to make creating arrays a bit cleaner than using a quotation and `a:counted-results`.

Class: class:word | Namespace: global | Interface Layer: all

{{

Begin a lexically scoped area.

Class: class:word | Namespace: global | Interface Layer: all

}

Complete an array begun by `{`. Returns a pointer to the data.

Class: class:word | Namespace: global | Interface Layer: all

}as

End an assembly section.

Class: class:macro | Namespace: global | Interface Layer: all

}}

End a lexically scoped area. This will hide any headers between `{{` and `---reveal---`, leaving only headers between `---reveal---` and the `}}` visible.

Class: class:word | Namespace: global | Interface Layer: all