retroforth/doc/words.tsv

547 lines
67 KiB
Text
Raw Normal View History

$ -c - - Return ASCII:NUL (0). class:macro {n/a} {n/a} global all
' -s - - Return an empty string. class:macro {n/a} {n/a} global all
( - - - Provide a visual indication of a code group. class:macro {n/a} {n/a} sigil all
) - - - Provide a visual indication of a code group. class:macro {n/a} {n/a} sigil all
* nn-n - - Multiply `n1` by `n2` and return the result. class:primitive #2 #6 *\n #-1 #100 * {n/a} global all
+ nn-n - - Add `n1` to `n2` and return the result. class:primitive #1 #2 + {n/a} global all
, n- - - Store the specified value into the memory at `here` and increment `Heap` by 1. class:word $a , $b , $c , #0 , {n/a} global all
- nn-n - - Subtract `n2` from `n1` and return the result. class:primitive #2 #1 - {n/a} global all
---reveal--- - - - Switch to the exposed (public) portion of a lexical namespace. class:word {n/a} {n/a} global all
-eq? nn-f - - Compare two values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise. class:primitive #1 #2 -eq?\n $a $b -eq? {n/a} global all
-if fq- - - Execute the quotation if the flag is `FALSE`. class:word {n/a} {n/a} global all
-if; fq- - - Execute the quotation if the flag is `FALSE`. If false, also exit the word. class:word {n/a} {n/a} global all
/ nm-v - - Divide `n` by `m` and return the integer part of the quotient. class:word {n/a} {n/a} global all
// - - - "Ignore any tokens remaining on the current line. Works with files and the interactive ""listener""." class:word {n/a} {n/a} global rre
/mod nm-rv - - Divide `n` by `m` and return the integer part of the quotient and remainder. class:primitive {n/a} {n/a} global all
0; n-n || n- - - If `n` is zero, drop `n` and exit the current word. If non-zero, leave `n` alone and allow execution to continue. class:macro {n/a} {n/a} global all
; - - - End the current definition. class:macro {n/a} {n/a} global all
?dup n-nn || n-n - - Duplicate top value on stack if not zero. If zero, do nothing. class:word #1 ?dup\n #0 ?dup {n/a} global all
ASCII:ACK -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:BEL -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:BS -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:CAN -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:CR -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:DC1 -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:DC2 -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:DC3 -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:DC4 -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:DEL -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:DLE -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:EM -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:ENQ -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:EOT -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:ESC -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:ETB -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:ETX -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:FF -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:FS -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:GS -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:HT -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:LF -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:NAK -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:NUL -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:RS -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:SI -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:SO -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:SOH -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:SPACE -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:STX -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:SUB -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:SYN -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:US -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
ASCII:VT -n - - Constant. Refers to specific ASCII code. class:data {n/a} {n/a} ASCII all
Base -a - - Variable. Holds the current numeric base. class:data {n/a} {n/a} global all
Compiler -a - - Variable. Holds the compiler state. If TRUE, the compiler is active. If FALSE, it is not. class:data {n/a} {n/a} global all
Dictionary -a - - Variable. Holds a pointer to the most recent dictionary header. class:data {n/a} {n/a} global all
EOM -a - - Constant. Returns the last addressable memory address. class:word {n/a} {n/a} global all
FALSE -n - - Returns `0`, the value used to indicate a FALSE result. class:word {n/a} {n/a} global all
FREE -n - - 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:word {n/a} {n/a} global all
Heap -a - - Variable. Holds the address of the next available cell. class:data {n/a} {n/a} global all
I -n - - Access the loop index for the current loop. (For loops made using `indexed-times`) class:word {n/a} {n/a} global all
J -n - - Access the parent loop index for the current loop. (For loops made using `indexed-times`) class:word {n/a} {n/a} global all
K -n - - Access the grandparent loop index for the current loop. (For loops made using `indexed-times`) class:word {n/a} {n/a} global all
NoEcho -a - - "Variable. If TRUE, allow display of the ""ok"" prompt and startup banner." class:word {n/a} {n/a} global rre
RewriteUnderscores -a - - Variable. When set to `TRUE`, Retro will replace underscores in strings with spaces. When `FALSE`, Retro does not. class:data {n/a} {n/a} global all
STRINGS -a - - Return the address of the start of the temporary string pool. This can be altered by changing the values of `TempStrings` and `TempStringMax`. class:word {n/a} {n/a} global all
ScopeList -a - - Variable. This holds some information used by `{{` and `}}`. class:data {n/a} {n/a} global all
TIB -a - - Constant. Returns a pointer to the text input buffer. class:data {n/a} {n/a} global rre
TRUE -n - - Returns `-1`, the value used to indicate a TRUE result. class:word {n/a} {n/a} global all
TempStringMax -a - - Variable. Holds the maximum length of a temporary string. class:data {n/a} {n/a} global all
TempStrings -a - - Variable. Holds the number of temporary strings. class:data {n/a} {n/a} global all
Version -a - - Variable. This stores the version number. class:data {n/a} {n/a} global all
[ - - - Begin a quotation. class:macro {n/a} {n/a} global all
] - - - End a quotation. class:macro {n/a} {n/a} global all
a:-eq? aa-f - - 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:word {n/a} {n/a} a all
a:append aa-a - - Return a new array consisting of the values in a1 followed by the values in a2. class:word {n/a} {n/a} a all
a:begins-with? aa-f - - Return `TRUE` if a1 begins with a2 or `FALSE` otherwise. class:word {n/a} {n/a} a all
a:chop a-a - - Return a new array containing all but the last value in the source array. class:word {n/a} {n/a} a all
a:contains-string? sa-f - - Deprecated. Use `a:contains/string?` instead. Return `TRUE` if the string value is in the array or `FALSE` otherwise. class:word {n/a} {n/a} a all
a:contains/string? sa-f - - Return `TRUE` if the string value is in the array or `FALSE` otherwise. class:word {n/a} {n/a} a all
a:contains? na-f - - Return `TRUE` if the value is in the array or `FALSE` otherwise. class:word {n/a} {n/a} a all
a:copy aa- - - Copy an array (a1) to a destination (a2). class:word {n/a} {n/a} a all
a:counted-results q-a - - 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:word {n/a} {n/a} a all
a:dup a-b - - Make a copy of an array. Return the address of the copy. class:word {n/a} {n/a} a all
a:ends-with? aa-f - - Return `TRUE` if a1 ends with a2 or `FALSE` otherwise. class:word {n/a} {n/a} a all
a:eq? aa-f - - 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:word {n/a} {n/a} a all
a:fetch an-n - - Fetch the value stored at the specified index in the specified array. class:word { #0 #1 #3 } #2 a:fetch {n/a} a all
a:filter aq-b - - 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:word {n/a} {n/a} a all
a:for-each aq- - - Execute the quote once for each item in the array. class:word {n/a} {n/a} a all
a:from-string s-a - - Create a new array with the characters in the source string. class:word {n/a} {n/a} a all
a:index an-n - - Return the location of the first instance of the specified value in the array. class:word {n/a} {n/a} a all
a:index-of an-n - - Deprecated. Use `a:index` instead. Return the location of the first instance of the specified value in the array. class:word {n/a} {n/a} a all
a:index-of-string as-n - - Deprecated. Use `a:index/string` instead. Return the location of the first instance of the specified string in the array. class:word {n/a} {n/a} a all
a:index/string as-n - - Return the location of the first instance of the specified string in the array. class:word {n/a} {n/a} a all
a:left an-a - - Return a new array containing the first `n` values from the source array. class:word {n/a} {n/a} a all
a:length a-n - - Return the length of a array. class:word {n/a} {n/a} a all
a:make q-a - - 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:word {n/a} {n/a} a all
a:map aq-b - - Execute quote once for each item in the array. Constructs a new array from the value returned by the quote. class:word {n/a} {n/a} a all
a:middle afl-a - - 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:word {n/a} {n/a} a all
a:prepend aa-a - - Return a new array consisting of the values in a2 followed by the values in a1. class:word {n/a} {n/a} a all
a:reduce pnq-n - - 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:word {n/a} {n/a} a all
a:reverse a-b - - Reverse the order of items in a array. This will return a new array. class:word {n/a} {n/a} a all
a:right an-a - - Return a new array containing the specified number of values from the right side of the array. class:word {n/a} {n/a} a all
a:store vna- - - Store a value into the array at the specified index. class:word #3 { #0 #1 #2 } #1 a:store {n/a} a all
a:th an-b - - Return the actual address of the `n`th item in the array. class:word {n/a} {n/a} a all
a:to-string a-s - - Create a new string from the provided array of character values. This string will be stored in the temporal string buffers. class:word { $h $e $l $l $o } a:to-string s:put nl {n/a} a all
abort - - - Abort execution. class:macro {n/a} {n/a} global rre
again - - - Close an unconditional loop. Branches back to the prior `repeat`. class:macro {n/a} {n/a} global all
allot n- - - Allocate the specified number of cells from the `Heap`. class:word 'Buffer d:create #100 allot {n/a} global all
and nm-o - - Perform a bitwise AND operation between the two provided values. class:primitive {n/a} {n/a} global all
b:fetch a-n - - Fetch the 8-bit value stored at the specified address. Addressing for this is in 8-bit units. class:word {n/a) {n/a} global all
b:store na- - - Store an 8-bit value into the specified address. Addressing for this is in 8-bit units. class:word {n/a} {n/a} global all
b:to-byte-address a-a - - Tronslate a physical address to a byte address. class:word {n/a} {n/a} global all
banner - - - Display a welcome message on startup. class:word {n/a} {n/a} global rre {n/a}
bi xqq-? - - Execute q1 against x, then execute q2 against a copy of x. class:word #100 [ #10 * ] [ #10 - ] bi {n/a} global all
bi* xyqq-? - - Execute q1 against x and q2 against y. class:word #10 #20 [ #2 * ] [ #10 / ] bi* {n/a} global all
bi@ xyq-? - - Execute q against x, then execute q against y. class:word #10 #20 [ #3 * ] bi@ {n/a} global all
binary - - - Set `Base` to binary. class:word {n/a} {n/a} a all
buffer:add n- - - Append a value to the current buffer. class:word {n/a} {n/a} buffer all
buffer:empty - - - Reset the current buffer to an empty state. class:word {n/a} {n/a} buffer all
buffer:end -a - - Return a pointer to the current end of the active buffer. class:word {n/a} {n/a} buffer all
buffer:get -n - - Remove the last value from the current buffer. class:word {n/a} {n/a} buffer all
buffer:preserve q- - - Save and restore the current buffer before and after executing the specified quote. class:word {n/a} {n/a} buffer all
buffer:set a- - - Assign a new buffer as the current one. class:word {n/a} {n/a} buffer all
buffer:size -n - - Return the number of cells in the buffer. class:word {n/a} {n/a} buffer all
buffer:start -a - - Return the start address of the current buffer. class:word {n/a} {n/a} buffer all
bye - - - Exit Retro. class:word {n/a} {n/a} global all
c:-consonant? c-f - - Return TRUE if character is a not consonant or FALSE otherwise. class:word {n/a} {n/a} c all
c:-digit? c-f - - Return TRUE if character is a not numeric digit or FALSE otherwise. class:word {n/a} {n/a} c all
c:-lowercase? c-f - - Return TRUE if character is not lowercase or FALSE otherwise. class:word {n/a} {n/a} c all
c:-uppercase? c-f - - Return TRUE if character is not uppercase or FALSE otherwise. class:word {n/a} {n/a} c all
c:-visible? c-f - - Return TRUE if character is not printable or FALSE otherwise. class:word {n/a} {n/a} c all
c:-vowel? c-f - - Return TRUE if character is not a vowel or FALSE otherwise. class:word {n/a} {n/a} c all
c:-whitespace? c-f - - Return TRUE if character is not whitespace, or FALSE otherwise. class:word {n/a} {n/a} c all
c:consonant? c-f - - Return TRUE if character is a consonant or FALSE otherwise. class:word {n/a} {n/a} c all
c:digit? c-f - - Return TRUE if character is a numeric digit or FALSE otherwise. class:word {n/a} {n/a} c all
c:get -c - - Vectored. Read a single keypress. class:word {n/a} {n/a} global rre
c:letter? c-f - - Return TRUE if character is an ASCII letter or FALSE otherwise. class:word {n/a} {n/a} c all
c:lowercase? c-f - - Return TRUE if character is lowercase or FALSE otherwise. class:word {n/a} {n/a} c all
c:put c- - - Vectored. Display a single character. class:word {n/a} {n/a} global all
c:to-lower c-c - - Convert character to lowercase equivalent. class:word {n/a} {n/a} c all
c:to-number c-n - - Convert an ASCII digit character into the corresponding decimal value class:word {n/a} {n/a} global all
c:to-string c-s - - Convert character into a string. class:word {n/a} {n/a} c all
c:to-upper c-c - - Convert character to uppercase equivalent. class:word {n/a} {n/a} c all
c:toggle-case c-c - - Convert an ASCII character to the opposite case. class:word {n/a} {n/a} c all
c:uppercase? c-f - - Return TRUE if character is uppercase or FALSE otherwise. class:word {n/a} {n/a} c all
c:visible? c-f - - Return TRUE if character is printable or FALSE otherwise. class:word {n/a} {n/a} c all
c:vowel? c-f - - Return TRUE if character is a vowel or FALSE otherwise. class:word {n/a} {n/a} c all
c:whitespace? c-f - - Return TRUE if character is whitespace, or FALSE otherwise. class:word {n/a} {n/a} c all
call a- - - Call a function. class:primitive {n/a} {n/a} global all
case nmq- || nmq-n - - 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:word {n/a} {n/a} global all
choose fqq- - - Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`; passing other values as flags will result in memory corruption. class:word {n/a} {n/a} global all
class:data n- || n-n - - Class handler for data structures. Keep the address or value on the stack. Compile the value or address as a literal into the current definition. class:word {n/a} {n/a} class all
class:macro a- - - Class handler for compiler macros (immediate words) Execute the function at the provided address. Execute the function at the provided address. class:word {n/a} {n/a} class all
class:primitive a- - - Class handler for primitive words (words which map to Nga instructions) Execute the function. Compile the machine code in the definiton into the current definition. class:word {n/a} {n/a} class all
class:word a- - - Class handler for normal words. Execute the function at the provided address. Compile a call to the specified address into the current definition. class:word {n/a} {n/a} class all
clear - - - Clear the display. class:word {n/a} {n/a} global rre
clock:day -n - - Return the current day. class:word {n/a} {n/a} clock iOS, rre
clock:hour -n - - Return the current hour. This will be in the range of 0-23, inclusive. class:word {n/a} {n/a} clock iOS, rre
clock:minute -n - - Return the current minute. This will be in the range of 0-59, inclusive. class:word {n/a} {n/a} clock iOS, rre
clock:month -n - - Return the current month. This will be in the range of 1-12, inclusive. class:word {n/a} {n/a} clock iOS, rre
clock:operation ...n- - - Trigger a clock operation. This is not intended to be used directly. class:word {n/a} {n/a} clock rre
clock:second -n - - Return the current second. This will be in the range of 0-59, inclusive. class:word {n/a} {n/a} clock iOS, rre
clock:timestamp -n - - Return a host specific timestamp. In the standard system, this is a 32-bit Unix timestamp, but this is not required. class:word {n/a} {n/a} clock rre
clock:utc:day -n - - Return the current day in UTC. class:word {n/a} {n/a} clock iOS, rre
clock:utc:hour -n - - Return the current hour in UTC. class:word {n/a} {n/a} clock iOS, rre
clock:utc:minute -n - - Return the current minute in UTC. class:word {n/a} {n/a} clock iOS, rre
clock:utc:month -n - - Return the current month in UTC. class:word {n/a} {n/a} clock iOS, rre
clock:utc:second -n - - Return the current second in UTC. class:word {n/a} {n/a} clock iOS, rre
clock:utc:year -n - - Return the current year in UTC. class:word {n/a} {n/a} clock iOS, rre
clock:year -n - - Return the current year. class:word {n/a} {n/a} clock iOS, rre
compile:call a- - - Compile a call to the specified address into the current definition. class:word {n/a} {n/a} compile all
compile:jump a- - - Compile a jump to the specified address into the current definition. class:word {n/a} {n/a} compile all
compile:lit n- - - Compile the code to push a number to the stack into the current definition. class:word {n/a} {n/a} compile all
compile:ret - - - Compile a return instruction into the current definition. class:word {n/a} {n/a} compile all
compiling? -f - - Return `TRUE` if compiler is on or `FALSE` otherwise. class:word {n/a} {n/a} global all
const ns- - - Create a constant returning the specified value. class:word {n/a} {n/a} global all
copy sdl- - - Copy `l` cells from memory at `s` to the memory at `d`. These should not overlap. class:word {n/a} {n/a} global all
curry nq-q - - Bind a value to a function and return a new quote that calls the bound action. class:word {n/a} {n/a} global all
d n- - - Inline a numeric value to the current assembly segment. class:word {n/a} {n/a} global all
d:add-header saa- - - Vectored. 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:word {n/a} {n/a} d all
d:class d-a - - Given a dictionary header, return the class field. class:word {n/a} {n/a} d all
d:create s- - - Hook. Create a new dictionary header named the specified string. The new header will point to `here` and have a class of `class:data`. class:word {n/a} {n/a} d all
d:for-each q- - - 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:word {n/a} {n/a} d all
d:last -d - - Return the most recent dictionary header. class:word {n/a} {n/a} d all
d:last.class -a - - Return a pointer to the class field of the most recent dictionary header. class:word {n/a} {n/a} d all
d:last.name -s - - Return a pointer to the name field of the most recent dictionary header. class:word {n/a} {n/a} d all
d:last.xt -a - - Return a pointer to the xt field of the most recent dictionary header. class:word {n/a} {n/a} d all
d:link d-a - - Given a dictionary header, return the link field. class:word {n/a} {n/a} d all
d:lookup s-d - - Lookup the specified name in the dictionary and return a pointer to its dictionary header. This returns zero if the word is not found. This also sets an internal variable ('which' in retro.muri) to the header address. class:word {n/a} {n/a} d all
d:lookup-xt a-d - - 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:word {n/a} {n/a} d all
d:name d-s - - Given a dictionary header, return the name field. class:word {n/a} {n/a} d all
d:source d-a - - Given a dictionary header, return the source field. class:word {n/a} {n/a} d all
d:words - - - Display a list of all named items in the `Dictionary`. class:word {n/a} {n/a} d rre
d:words-beginning-with s- - - Display a list of all named items in the `Dictionary` that begin with the provided substring. class:word {n/a} {n/a} d rre
d:words-with s- - - Display a list of all named items in the `Dictionary` that contain the provided substring. class:word {n/a} {n/a} d rre
d:xt d-a - - Given a dictionary header, return the xt field. class:word {n/a} {n/a} d all
data - - - Change the class of the most recently defined word to `class:data`. class:word {n/a} {n/a} global all
decimal - - - Set `Base` to decimal. class:word {n/a} {n/a} a all
depth -n - - Return the number of items on the stack. class:word {n/a} {n/a} global all
dip nq-n - - Temporarily remove n from the stack, execute the quotation, and then restore n to the stack. class:word {n/a} {n/a} global all
does q- - - Attach an action to the most recently created word. This is used in a manner similar to CREATE/DOES> in traditional Forth. class:word {n/a} {n/a} global all
drop n- - - Discard the top value on the stack. class:primitive {n/a} {n/a} global all
drop-pair nn- - - Remove top two items on the stack. class:word {n/a} {n/a} global all
dump-stack - - - Display the items on the data stack. class:word {n/a} {n/a} global all
dup n-nn - - Duplicate the top item on the stack. class:primitive {n/a} {n/a} global all
dup-pair nm-nmnm - - Duplicate the top two items on the stack. class:word {n/a} {n/a} global all
e:-INF -e - - Constant. Negative infinity. For encoded floating-point values. class:word {n/a} {n/a} e rre {n/a}
e:-inf? e-f - - Is encoded value negative infinity? class:word {n/a} {n/a} e rre {n/a}
e:INF -e - - Constant. Infinity. For encoded floating-point values. class:word {n/a} {n/a} e rre {n/a}
e:MAX -e - - Constant. Maximum value. For encoded floating-point values. class:word {n/a} {n/a} e rre
e:MIN -e - - Constant. Minimum value. For encoded floating-point values. class:word {n/a} {n/a} e rre {n/a}
e:NAN -e - - Constant. Not a Number. For encoded floating-point values. class:word {n/a} {n/a} e rre {n/a}
e:clip e-E - - Constrain the encoded value to the allowable range. class:word {n/a} {n/a} e rre
e:inf? e-f - - Is encoded value infinity? class:word {n/a} {n/a} e rre {n/a}
e:max? e-f - - Is encoded value at the maximum? class:word {n/a} {n/a} e rre {n/a}
e:min? e-f - - Is encoded value at the minimum? class:word {n/a} {n/a} e rre {n/a}
e:n? e-f - - Return `TRUE` if the encoded value is a valid number, or `FALSE` otherwise. class:word {n/a} {n/a} e rre
e:nan? e-f - - Is encoded value a Nan? class:word {n/a} {n/a} e rre {n/a}
e:put e- - - Display an encoded number. class:word {n/a} {n/a} e rre
e:to-f e- - -n Decode an encoded floating-point value. class:word {n/a} {n/a} e rre
e:zero? e-f - - Return `TRUE` if the value is zero, or `FALSE` otherwise. class:word {n/a} {n/a} e rre
eq? nn-f - - Compare two values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise. class:primitive #1 #2 eq?\n $a $b eq? {n/a} global all
err:notfound - - - Vectored. Error handler. Called when a word is not found by `interpret`. class:word {n/a} {n/a} err all
f:* - - FF-F Multiply two floating-point numbers, returning the result. class:word .3.1415 .22 f:* {n/a} f rre
f:+ - - FF-F Add two floating-point numbers, returning the result. class:word .3.1 .22 f:+ {n/a} f rre
f:- - - FF-F Subtract F2 from F1 returning the result. class:word .22.3 .0.12 f:- {n/a} f rre
f:-INF - - -n Return a value corresponding to negative infinity class:word {n/a} {n/a} f rre
f:-eq? -f - FF- Compare two floating-point values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise. class:word {n/a} {n/a} f rre
f:-inf? -f - F- Return `TRUE` if floating-point value is -INF or `FALSE` otherwise. class:word {n/a} {n/a} f rre
f:/ - - FF-F Divide floating-point value F1 by F2. class:word {n/a} {n/a} f rre
f:E - - -F Return the floating-point value for Euler's number. class:word {n/a} {n/a} f rre
f:E1 - - -f Hook. Return a constant used as the scaling factor for the e: words. class:word {n/a} {n/a} f rre {n/a}
f:INF - - -n Return a value corresponding to positive infinity class:word {n/a} {n/a} f rre
f:NAN - - -n Return a value corresponding to NaN class:word {n/a} {n/a} f rre
f:PI - - -F Return the floating-point value for PI. class:word {n/a} {n/a} f rre
f:abs - - F-F Return the absolute value for a floating-point value. class:word {n/a} {n/a} f rre
f:acos - - F-F Return the arc cosine of a floating-point number. class:word {n/a} {n/a} f rre
f:adepth -n - - Return the number of items on the alternate floating-point stack. class:word {n/a} {n/a} f rre
f:asin - - F-F Return the arc sine of a floating-point number. class:word {n/a} {n/a} f rre
f:atan - - F-F Return the arc tangent of a floating-point number. class:word {n/a} {n/a} f rre
f:between? -f - nlu- Return TRUE if number is between the lower (l) and upper (u) bounds. If not, return FALSE. This is inclusive of the limits. class:word .3 .1 .100 f:between?\n .100 .200 .300 f:between? {n/a} f rre
f:case q- - nm-n 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:word {n/a} {n/a} f rre
f:ceiling - - F-F Return the smallest integral value greater than or equal to the specified value. class:word {n/a} {n/a} f rre
f:cos - - F-F Return the cosine of a floating-point number. class:word {n/a} {n/a} f rre
f:dec - - n-m Decrement n by one. class:word .100 f:dec {n/a} f rre
f:depth -n - - Return the number of items on the floating-point stack. class:word {n/a} {n/a} f rre
f:drop - - F- Discard the top item on the floating-point stack. class:word {n/a} {n/a} f rre
f:drop-pair - - FF- Remove top two items on the stack. class:word {n/a} {n/a} f rre
f:dump-astack - - - Display the items on the alternate floating-point stack. class:word {n/a} {n/a} f rre
f:dump-stack - - - Display the items on the floating-point stack. class:word {n/a} {n/a} f rre
f:dup - - F-FF Duplicate the top item on the floating-point stack. class:word {n/a} {n/a} f rre
f:dup-pair - - nm-nmnm Duplicate the top two items on the stack. class:word {n/a} {n/a} f rre
f:eq? -f - FF- Compare two floating-point values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise. class:word {n/a} {n/a} f rre
f:fetch a- - -n Fetch a stored floating-point value. class:word {n/a} {n/a} f rre
f:floor - - F-F Perform a mathematical floor operation on the floating-point value. class:word {n/a} {n/a} f rre
f:gt? -f - FF- Compare two floating-point values for greater than. class:word {n/a} {n/a} f rre
f:inc - - n-m Increment n by one. class:word .100 f:inc {n/a} f rre
f:inf? -f - F- Return `TRUE` if floating-point value is INF or `FALSE` otherwise. class:word {n/a} {n/a} f rre
f:limit - - nlu-m Return n if it is within the lower (l) and upper (u) bounds. If outside the bounds, return the closes boundary value. class:word .-10 .5 .8 f:limit\n .10 .1 .15 f:limit {n/a} f rre
f:log - - FF-F Return log(F1) for base F2 for floating-point values. class:word {n/a} {n/a} f rre
f:lt? -f - FF- Compare two floating-point values for less than. class:word {n/a} {n/a} f rre
f:max - - mn-o Return the greater of two values. class:word .1 .7 f:max\n .-8 .-10 f:max {n/a} f rre
f:min - - mn-o Return the lesser of two values. class:word .1 .7 f:min\n .-8 .-10 f:min {n/a} f rre
f:nan? -f - F- Return `TRUE` if floating-point value is NaN or `FALSE` otherwise. class:word {n/a} {n/a} f rre
f:negate - - F-F Invert the sign of the floating-point value. class:word .3.1415 f:negate {n/a} f rre
f:negative? -f - F- Return `TRUE` if floating-point value is negative or `FALSE` if not. class:word {n/a} {n/a} f rre
f:nip - - NM-M Remove the second item from the stack. class:word {n/a} {n/a} f rre
f:over - - FG-FGF Put a copy of the second floating-point value over the top one. class:word {n/a} {n/a} f rre
f:pop - - -F Pop a floating-point value from the alternate stack. class:word {n/a} {n/a} f rre
f:positive? -f - F- Return `TRUE` if floating-point value is positive or `FALSE` otherwise. class:word {n/a} {n/a} f rre
f:power - - FF-F Return F1^F2 for floating-point values. class:word {n/a} {n/a} f rre
f:push - - F- Push a floating-point value to an alternative stack. class:word {n/a} {n/a} f rre
f:put - - F- Display a floating-point number. class:word {n/a} {n/a} global rre
f:rot - - abc-bca Rotate the top three values. class:word {n/a} {n/a} f rre
f:round - - f-f Round a floating-point value. class:word {n/a} {n/a} f rre
f:sign -n - F- Return 1 if the floating-point value is positive or -1 if it is negative. class:word .3.1415 f:sign {n/a} f rre
f:signed-sqrt - - F-F Return the square root of a floating-point number. class:word {n/a} {n/a} f rre
f:signed-square - - f-f Return the square of a floating-point number. class:word {n/a} {n/a} f rre
f:sin - - F-F Return the sine of a floating-point number. class:word {n/a} {n/a} f rre
f:sqrt - - F-F Return the square root of a floating-point number. class:word {n/a} {n/a} f rre
f:square - - f-f Return the square of a floating-point number. class:word {n/a} {n/a} f rre
f:store a- - n- Store a floating-point value to the specified memory location. class:word {n/a} {n/a} f rre
f:swap - - FG-GF Exchange the top and second items on the floating-point stack. class:word {n/a} {n/a} f rre
f:tan - - F-F Return the tangent of a floating-point number. class:word {n/a} {n/a} f rre
f:to-e -e - n- Encode the floating-point value to an integer. class:word {n/a} {n/a} f rre
f:to-number -n - F- Convert a floating-point value into a number. class:word {n/a} {n/a} f rre
f:to-string -s - F- Convert a floating-point value into a string. class:word {n/a} {n/a} f rre
f:tuck - - FG-GFG Tuck a copy of the top floating-point value under the second one. class:word {n/a} {n/a} f rre
fetch a-n - - Fetch the value stored at the specified address. class:primitive &Version fetch {n/a} global all
fetch-next a-an - - Fetch the value stored at the specified address. Returns the next address and the value. class:word {n/a} {n/a} global all
file:A -n - - Constant for opening a file in APPEND mode. class:data {n/a} {n/a} file rre
file:R -n - - Constant for opening a file in READ mode. class:data {n/a} {n/a} file rre
file:R+ -n - - Constant for opening a file in READ & WRITE mode. class:data {n/a} {n/a} file rre
file:W -n - - Constant for opening a file in WRITE mode. class:data {n/a} {n/a} file rre
file:close h- - - Given a file handle, close the file. class:word {n/a} {n/a} file rre
file:delete s- - - Delete the named file. class:word {n/a} {n/a} file rre
file:exists? s-f - - Given a file name, return `TRUE` if it exists or `FALSE` if it does not. class:word {n/a} {n/a} file rre
file:flush h- - - Given a file handle, flush any pending writes to disk. class:word {n/a} {n/a} file rre
file:for-each-line sq- - - Given a file name, open it and run the quote once for each line in the file. class:word {n/a} {n/a} file rre
file:open sm-h - - Open a named file (s) with the given mode (m). Returns a handle identifying the file. class:word '/etc/motd file:R file:open {n/a} file rre
file:open-for-append s-nn - - Open a file for reading & writing. Returns the size (NOS) and a file ID (TOS) class:word {n/a} {n/a} file rre
file:open-for-reading s-nn - - Open a file for reading. Returns the size (NOS) and a file ID (TOS) class:word {n/a} {n/a} file rre
file:open-for-writing s-n - - Open a file for writing. Returns the file ID class:word {n/a} {n/a} file rre
file:operation ...n- - - Trigger a file I/O operation. This is not intended to be used directly. class:word {n/a} {n/a} file rre
file:read h-c - - Given a file handle, read and return the next character in it. class:word {n/a} {n/a} file rre
file:read-line f-s - - Given a file handle, read a line and return a pointer to it. class:word {n/a} {n/a} file rre
file:seek nh- - - Move the current offset into a file to the specified one. class:word {n/a} {n/a} file rre
file:size h-n - - Given a file handle, return the size of the file (in bytes). class:word {n/a} {n/a} file rre
file:slurp as- - - Given an address and a file name, read the file contents into memory starting at the address. class:word {n/a} {n/a} file rre
file:spew ss- - - Given a string (s1) and a file name (s2), write the string into the file, replacing any existing content. class:word {n/a} {n/a} file rre
file:tell h-n - - Given a file handle, return the current offset in the file. class:word {n/a} {n/a} file rre
file:write ch- - - Write a character to the file represented by the handle. class:word {n/a} {n/a} file rre
float:operation ...n- - - Trigger a floating-point operation. This is not intended to be used directly. class:word {n/a} {n/a} float rre
forever q- - - Run quotation in an endless loop. class:word {n/a} {n/a} a all
gopher:get asns-n - - 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:word here 'forthworks.com #70 '/ gopher:get\n here s:put {n/a} gopher ios
gt? nn-f - - Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise. class:primitive {n/a} {n/a} global all
gteq? nn-f - - Compare n1 and n2. Return `TRUE` if n1 is greater than or equal to n2, or `FALSE` otherwise. class:word {n/a} {n/a} global all
h:fetch a-n - - Fetch the 16-bit value stored at the specified address. Addressing for this is in 8-bit units. class:word {n/a) {n/a} global all
h:store na- - - Store an 16-bit value into the specified address. Addressing for this is in 8-bit units. class:word {n/a} {n/a} global all
here -a - - Return the next free address in memory. class:word {n/a} {n/a} global all
hex - - - Set `Base` to hexadecimal. class:word {n/a} {n/a} a all
hook - - - Add a hook point into the current word. This should only be used as the first word in a definition. class:macro :foo hook ; :bar hook (default_action: n:square n:put nl ; global global
i s- - - Assemble the instructions specified by the string into the current assembly scope. class:word {n/a} {n/a} global all
if fq- - - Execute the quote if the flag is `TRUE`. class:word {n/a} {n/a} global all
if; fq- - - Execute the quotation if the flag is `TRUE`. If true, also exit the word. class:word {n/a} {n/a} global all
image:save s- - - Save the current system to a new image file. class:word {n/a} {n/a} image rre
immediate - - - Change the class of the most recently defined word to `class:macro`. class:word {n/a} {n/a} global all
include s- - - Run the code in the specified file. class:word {n/a} {n/a} global rre
indexed-times nq- - - Run a quote the specified number of times, tracking the loop index in `I`. This is less efficient than `times`, so if the index is not needed, this should be avoided. class:word {n/a} {n/a} global all
interpret s- - - Vectored. Interpret a single input token. class:word '#100 interpret\n 'words interpret {n/a} global all
io:enumerate -n - - Return the number of I/O devices. class:word {n/a} {n/a} io all
io:invoke n- - - Invoke an interaction with an I/O device. class:word {n/a} {n/a} io all
io:query n-mN - - Ask an I/O device to identify itself. Returns a version (m) and device ID (N). class:word {n/a} {n/a} io all
io:scan-for n-m - - Scan the I/O devices for a device with a specified ID. Returns the device number, or -1 if not found. class:word {n/a} {n/a} io all
io:unix-syscall ...n- - - Trigger a Unix system call. This is not intended to be used directly. class:word {n/a} {n/a} io rre
listen - - - "Run interactive ""listener"" (a REPL)." class:word {n/a} {n/a} global rre
lt? nn-f - - Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise. class:primitive {n/a} {n/a} global all
lteq? nn-f - - Compare n1 and n2. Return `TRUE` if n1 is less than or equal to n2, or `FALSE` otherwise. class:word {n/a} {n/a} global all
mod nm-o - - Divide `n` by `m` and return the remainder. class:word {n/a} {n/a} global all
n:-zero? n-f - - Return `TRUE` if number is not zero, or `FALSE` otherwise. class:word {n/a} {n/a} n all
n:MAX -n - - Return the maximum value that will fit in a cell. class:word {n/a} {n/a} n all
n:MIN -n - - Return the minimum value that will fit in a cell. class:word {n/a} {n/a} n all
n:abs n-n - - Return the absolute value of a number. class:word #10 n:abs\n #-10 n:abs\n {n/a} n all
n:between? nlu-f - - Return TRUE if number is between the lower (l) and upper (u) bounds. If not, return FALSE. This is inclusive of the limits. class:word #3 #1 #100 n:between?\n $q $a $b n:between? {n/a} n all
n:dec n-m - - Decrement n by one. class:word #100 n:dec {n/a} n all
n:even? n-f - - Return `TRUE` if number is even, or `FALSE` if not. class:word #12 n:even?\n #11 n:even? {n/a} n all
n:inc n-m - - Increment n by one. class:word #100 n:inc {n/a} n all
n:limit nlu-m - - Return n if it is within the lower (l) and upper (u) bounds. If outside the bounds, return the closes boundary value. class:word #-10 #5 #8 n:limit\n #10 #1 #15 n:limit {n/a} n all
n:max mn-o - - Return the greater of two values. class:word #1 #7 n:max\n #-8 #-10 n:max {n/a} n all
n:min mn-o - - Return the lesser of two values. class:word #1 #7 n:min\n #-8 #-10 n:min {n/a} n all
n:negate n-n - - Invert the sign of a number. class:word #10 n:negate\n #-10 n:negate {n/a} n rre
n:negative? n-f - - Return `TRUE` if number is negative, or `FALSE` if not. class:word {n/a} {n/a} n all
n:odd? n-f - - Return `TRUE` if number is odd, or `FALSE` if not. class:word {n/a} {n/a} n all
n:positive? n-f - - Return `TRUE` if number is positive, or `FALSE` if not. class:word {n/a} {n/a} n all
n:pow bp-n - - Return base (b) to power (p). class:word {n/a} {n/a} n all
n:put n- - - Display a number. class:word {n/a} {n/a} global all
n:random -n - - Return a random number. class:word n:random n:put {n/a} n rre
n:sqrt n-m - - Return the square root of a number. class:word {n/a} {n/a} n all
n:square n-m - - Return the square of a number. class:word {n/a} {n/a} n all
n:strictly-positive? n-f - - Return TRUE if number is greater than zero or FALSE if it is zero or less. class:word {n/a} {n/a} n all
n:to-float n- - -F Convert a number into a floating-point value. class:word {n/a} {n/a} n rre
n:to-string n-s - - Convert a number into a string. class:word {n/a} {n/a} n all
n:zero? n-f - - Return `TRUE` if number is zero, or `FALSE` otherwise. class:word {n/a} {n/a} n all
nip nm-m - - Remove the second item from the stack. class:word {n/a} {n/a} global all
nl - - - Display a newline. class:word {n/a} {n/a} global all
not n-m - - Perform a logical NOT operation. class:word {n/a} {n/a} global all
octal - - - Set `Base` to octal. class:word {n/a} {n/a} a all
or mn-o - - Perform a bitwise OR between the provided values. class:primitive {n/a} {n/a} global all
over nm-nmn - - Put a copy of n over m. class:word {n/a} {n/a} global all
pack nnnn-n - - Pack four 8-bit values into a 32-bit value. class:word {n/a} {n/a} global all
parse-until q-s - - Read input from stdin (via `c:get`) until the returned character is matched by the quote. Returns a string. class:word :read-until-period (-s)\n [ $. eq? ] parse-until ; {n/a} all rre
pb:get a- - - Copy a string from the pasteboard to the specified address. class:word {n/a} {n/a} pb iOS {n/a}
pb:length -n - - Return the length of the string on the pasteboard. class:word {n/a} pb pb iOS
pb:set s- - - Copy a string to the pasteboard. class:word {n/a} {n/a} pb iOS
pop -n n- - Move a value from the return stack to the data stack. class:macro {n/a} {n/a} global all
primitive - - - Change the class of the most recently defined word to `class:primitive`. class:word {n/a} {n/a} global all
push n- -n - Move a value from the data stack to the return stack. class:macro {n/a} {n/a} global all
r s- - - Lookup a reference by name and inline its pointer to the current assembly segment. class:word {n/a} {n/a} global all
reclass a- - - Change the class handler of the most recently defined word to the specified one. class:word {n/a} {n/a} global all
reorder ...ss-? - - Restructure the order of items on the stack. class:word {n/a} {n/a} global all
repeat - - - Begin an unconditional loop. class:macro {n/a} {n/a} global all
reset ...- - - Remove all items from the stack. class:word {n/a} {n/a} global all
rot abc-bca - - Rotate the top three values. class:word {n/a} {n/a} global all
s, s- - - Compile the code needed to push a string pointer to the stack and inline the string data into the current definition. class:word {n/a} {n/a} global all
s:ASCII-LETTERS -s - - Constant. Returns a string of the ASCII letters (upper and lower case) class:data {n/a} {n/a} s all
s:ASCII-LOWERCASE -s - - Constant. Returns a string of the ASCII letters in lowercase class:data {n/a} {n/a} s all
s:ASCII-UPPERCASE -s - - Constant. Returns a string of the ASCII letters in uppercase class:data {n/a} {n/a} s all
s:DIGITS -s - - Constant. Return a string of characters recognized as numeric digits. class:data {n/a} {n/a} s all
s:PUNCTUATION -s - - Constant. Return a string of characters recognized as punctuation. class:data {n/a} {n/a} s all
s:WHITESPACE -s - - Constant. Returns a string of characters recognized as whitespace. class:data {n/a} {n/a} s all
s:append ss-s - - Return a new string consisting of s1 followed by s2. class:word {n/a} {n/a} s all
s:begins-with? ss-f - - Return `TRUE` if s1 begins with s2 or `FALSE` otherwise. class:word {n/a} {n/a} s all
s:case sSq- || sSq-s - - 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:word {n/a} {n/a} s all
s:chop s-s - - Remove the last character from a string. Returns a new string. class:word {n/a} {n/a} s all
s:const ss- - - Create a constant named s2, returning a pointer to s1. This will use `s:keep` to preserve the original string. class:word {n/a} {n/a} s all
s:contains-char? sc-f - - Deprecated. Use `s:contains/char?` instead. Return `TRUE` if the character is present in the string or `FALSE` otherwise. class:word {n/a} {n/a} s all
s:contains-string? ss-f - - Deprecated. Use `s:contains/string?` instead. Return `TRUE` if the second string is present in the first string or `FALSE` otherwise. class:word {n/a} {n/a} s all
s:contains/char? sc-f - - Return `TRUE` if the character is present in the string or `FALSE` otherwise. class:word {n/a} {n/a} s all
s:contains/string? ss-f - - Return `TRUE` if the second string is present in the first string or `FALSE` otherwise. class:word {n/a} {n/a} s all
s:copy sa- - - Copy a string (s) to a destination (a). This will include the terminator character when copying. class:word {n/a} {n/a} s all
s:empty -s - - Return an empty string. class:word {n/a} {n/a} s all
s:ends-with? ss-f - - Return `TRUE` if s1 ends with s2 or `FALSE` otherwise. class:word {n/a} {n/a} s all
s:eq? ss-f - - Compare two strings for equality. Return `TRUE` if identical or `FALSE` if not. class:word 'hello 'again s:eq?\n 'test 'test s:eq? {n/a} s all
s:evaluate s-? - -? Evaluate string as if it was typed into the interpreter. class:word {n/a} {n/a} s all
s:fetch sn-n - - Fetch the character value stored at the specified index in the string. class:word 'abcdef #2 s:fetch {n/a} s all
s:filter sq-s - - 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:word {n/a} {n/a} s all
s:for-each sq- - - Execute the quote once for each value in the string. class:word {n/a} {n/a} s all
s:format ...s-s - - Construct a new string using the template passed and items from the stack. class:word {n/a} {n/a} s all
s:get -s - - Read input from standard in (via `c:get`) until a CR or LF is encountered. Returns a string. class:word {n/a} {n/a} all rre
s:get-word -s - - Read input from standard in (via `c:get`) until a whitespace is encountered. Returns a string. class:word {n/a} {n/a} all rre
s:hash s-n - - Calculate a hash value for a string. This uses the djb2 algorithm. class:word {n/a} {n/a} s all
s:index-of sc-n - - Deprecated. Use `s:index/char` instead. Return the location of the first instance of the specified character in the string. class:word {n/a} {n/a} s all
s:index-of-string ss-n - - Derpecated. Use `s:index/string` instead. Return the location of the first instance of the specified substring (s2) in the string (s1). Returns -1 if not found. class:word {n/a} {n/a} s all
s:index/char sc-n - - Return the location of the first instance of the specified character in the string. class:word {n/a} {n/a} s all
s:index/string ss-n - - Return the location of the first instance of the specified substring (s2) in the string (s1). Returns -1 if not found. class:word {n/a} {n/a} s all
s:keep s-s - - Store a string into the heap and return a pointer to the start of it. class:word {n/a} {n/a} s all
s:left sn-s - - Return a new string containing the first `n` characters from the source string. class:word {n/a} {n/a} s all
s:length s-n - - Return the number of characters in a string, excluding the NULL terminator. class:word {n/a} {n/a} s all
s:map sq-s - - 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:word {n/a} {n/a} s all
s:prepend ss-s - - Return a new string consisting of s2 followed by s1. class:word {n/a} {n/a} s all
s:put s- - - Display a string. class:word {n/a} {n/a} global all
s:replace sss-s - - Replace the first instance of s2 in s1 with s3. class:word {n/a} {n/a} s all
s:replace-all sss-s - - Replace all instances of s2 in s1 with s3. class:word {n/a} {n/a} s all
s:reverse s-s - - Reverse the order of ASCII characters in a string. class:word {n/a} {n/a} s all
s:right sn-s - - Return a new string containing the specified number of characters from the right side of the string. class:word {n/a} {n/a} s all
s:skip - - - Internal helper function used to skip over a string in a definition. class:word {n/a} {n/a} s all
s:split sc-ss - - Deprecated. Use `s:split/char` instead. Split a string on the first occurrence of the specified character. class:word {n/a} {n/a} s all
s:split-on-string ss-ss - - Deprecated. Use `s:split/string` instead. Split a string on the first occurrence of the specified string. After the split, the top stack item will be the part of the string before the specified substring, and the second item will be the rest of the original string. class:word 'Hello_Brave_World! 'Brave s:split-on-string s:put nl s:put nl {n/a} s all
s:split/char sc-ss - - Split a string on the first occurrence of the specified character. class:word {n/a} {n/a} s all
s:split/string ss-ss - - Split a string on the first occurrence of the specified string. After the split, the top stack item will be the part of the string before the specified substring, and the second item will be the rest of the original string. class:word 'Hello_Brave_World! 'Brave s:split-on-string s:put nl s:put nl {n/a} s all
s:store csn- - - Store a character value into the string at the specified index. class:word $z 'abcdef #1 s:store {n/a} s all
s:substr sfl-s - - Extract a substring from the specified string. This will take the characters starting at `f` and extend `l` characters in length. class:word {n/a} {n/a} s all
s:temp s-s - - Move a string into the temporary string buffers. class:word {n/a} {n/a} s all
s:to-float s- - -F Convert a string representation into a floating-point value. class:word {n/a} {n/a} s rre
s:to-lower s-s - - Convert uppercase ASCII characters in a string to lowercase. class:word {n/a} {n/a} s all
s:to-number s-n - - Convert a string to a number. class:word {n/a} {n/a} s all
s:to-upper s-s - - Convert lowercase ASCII characters in a string to uppercase. class:word {n/a} {n/a} s all
s:tokenize sc-a - - 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:word {n/a} {n/a} s all
s:tokenize-on-string ss-a - - 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:word {n/a} {n/a} s all
s:trim s-s - - Trim leading and trailing whitespace from a string. class:word '__hello__ s:trim {n/a} s all
s:trim-left s-s - - Trim leading whitespace from a string. class:word '__hello__ s:trim-left {n/a} s all
s:trim-right s-s - - Trim trailing whitespace from a string. class:word '__hello__ s:trim-right {n/a} s all
script:abort-include - - - Discard remaining tokens on the current line being evaluated. This only works when including a file, not at the interpreter. class:word {n/a} {n/a} sys rre
script:arguments -n - - Return the number of arguments passed to the program. class:word {n/a} {n/a} sys rre
script:current-file -s - - Return the filename of the file being processed by the current `include`, or `/dev/stdin` if the input source is the terminal. class:word {n/a} {n/a} sys rre
script:current-line -n - - Return the current line number of the file being processed by the current `include`, or `0` if the input source is the terminal. Line numbering starts at 1. class:macro {n/a} {n/a} script rre
script:get-argument n-s - - Given an argument number, return the argument as a string. class:word {n/a} {n/a} script rre
script:ignore-to-eof - - - Discard remaining lines in the file currently being evaluated. This only works when including a file, not at the interpreter. class:word {n/a} {n/a} script rre
script:ignore-to-eol - - - Discard remaining tokens in the current line. This only works when including a file, not at the interpreter. class:word {n/a} {n/a} script rre
script:name -s - - Return the filename of the program being run. class:word {n/a} {n/a} script rre
set-hook aa- - - Patch the hook point in a2 to point to a1. class:word :foo hook ;\n :bar #1 ;\n &bar &foo set-hook {n/a} global all
shift mn-o - - 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:primitive {n/a} {n/a} global all
sigil:! ns- - - Store a value into a variable. Store a value into the named variable. Compile the code to store a value into a named variable. class:macro {n/a} {n/a} sigil all
sigil:# s-n - - Process token as a number. Convert the string into a number and leave on the stack. Convert the string into a number and compile into the current definition as a literal. class:macro {n/a} {n/a} sigil all
sigil:$ s-c - - Process token as an ASCII character. Fetch first character from string. Leave on stack. Fetch first character from the string. Compile into the current definition as literal. class:macro {n/a} {n/a} sigil all
sigil:& s-a - - Return a pointer to a named item. If name is not found, returns 0. Lookup name in dictionary, return contents of the xt field on the stack. Lookup name in dictionary, compile code to push the contents of the xt field into the current definition. class:macro {n/a} {n/a} sigil all
sigil:' s-s - - Process token as a string. Move string into temporary buffer. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space. Move string into temporary buffer. If `RewriteUnderscores` is `TRUE`, replace all instances of _ with space. Then compile the string into the current definition. class:macro {n/a} {n/a} sigil all
sigil:( s- - - Process token as a comment. Discard the string. Discard the string. class:macro {n/a} {n/a} sigil all
sigil:. s- - -F 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:macro {n/a} {n/a} sigil rre
sigil:: s- - - Hook. Process token as a new definition. Create a header pointing to `here` with the provided string as the name. Sets class to `class:word`. class:macro {n/a} {n/a} sigil all
sigil:@ s-n - - Fetch from a stored variable. Fetch a value from a named variable. Compile the code to fetch a value from a named variable into the current definition. class:macro {n/a} {n/a} sigil all
sigil:\ s- - - Process token as an instruction bundle. Discard the string. Assemble the opcodes in the string and use `,` to inline it into the current definition. class:macro {n/a} {n/a} sigil all
sigil:^ s- - - Process token as a function reference. Discard the string. Comma the XT of the word into the current definition. class:macro {n/a} {n/a} sigil all
sigil:` s- - - Process token as a bytecode. Discard the string. Convert the string to a number and use `,` to inline it into the current definition. class:macro {n/a} {n/a} sigil all
sigil:| s- - - POSTPONE equivalent. Discard the string. Convert the string to a number and use `,` to inline it into the current definition. class:macro {n/a} {n/a} sigil all
sip nq(?n-?)-n - - Run quote. After execution completes, put a copy of n back on top of the stack. class:word {n/a} {n/a} global all
socket:accept n-nn - - Begin accepting connections. Returns a new socket and an error code. class:word {n/a} {n/a} socket rre
socket:bind sn-nn - - Bind a socket to a port. The port should be a string. Returns 0 if successful or -1 otherwise and an error code. class:word {n/a} {n/a} socket rre
socket:close n- - - Close a socket. class:word {n/a} {n/a} socket rre
socket:configure ss- - - Configure internal settings for a host (s1) and port (s2). Use before `socket:bind`. class:word {n/a} {n/a} socket rre
socket:connect n-nn - - Connect to a server. Provide a socket, this will return a status flag and an error code. class:word {n/a} {n/a} socket rre
socket:create -n - - Obtain a new socket. class:word {n/a} {n/a} socket rre
socket:gethostbyname as- - - Get the host IP in dotted notation. The host is specified by the string and the address is the start of the buffer for the dotted IP. class:word {n/a} {n/a} socket rre
socket:listen nn-nn - - Prepare a socket for accepting incoming connections. Takes a backlog count (n1) and a socket (n2). Returns a flag (0 success, -1 failed) and an error code. class:word {n/a} {n/a} socket rre
socket:operation ...n- - - Trigger a socket operation. This is not intended to be used directly. class:word {n/a} {n/a} socket rre
socket:recv ann-nn - - Receive data from a socket. This will read into memory starting at address *a*, up to *n1* bytes. *n2* is the socket. Returns the number of bytes read and an error code. class:word {n/a} {n/a} socket rre
socket:send sn-nn - - Send a string to a socket. This will return the number of characters sent and an error code. class:word {n/a} {n/a} socket rre
sp - - - Display a space (`ASCII:SPACE`) class:word :spaces (n-) [ sp ] times ;\n #12 spaces {n/a} global all
store na- - - Store a value into the specified address. class:primitive 'Base var\n #10 &Base store {n/a} global all
store-next na-a - - Store a value into the specified address and return the next address. class:word {n/a} {n/a} global all
swap nm-mn - - Exchange the position of the top two items on the stack class:primitive {n/a} {n/a} global all
tab - - - Display a tab (`ASCII:HT`) class:word {n/a} {n/a} global all
times nq- - - Run the specified quote the specified number of times. class:word #12 [ $- c:put ] times {n/a} global all
tri xqqq-? - - Apply q1 against x, then q2 against a copy of x, and finally q3 against another copy of x. class:word {n/a} {n/a} global all
tri* xyzqqq-? - - Apply q1 against x, q2 against y, and q3 against z. class:word {n/a} {n/a} global all
tri@ xyzq-? - - Apply q against x, then against y, and finally against z. class:word {n/a} {n/a} global all
tuck nm-mnm - - Put a copy of the top item on the stack under the second one. class:word {n/a} {n/a} global all
ui:add-view s- - - Add view named `s` to the displayed views. class:word {n/a} {n/a} ui retro/python
ui:create-view ss- - - Create a new view. `s1` is the name and `s2` is the type. class:word {n/a} {n/a} ui retro/python
ui:get-action s-a - - Return the address of the Retro handler for a view's associated action. class:word {n/a} {n/a} ui retro/python
ui:get-position s-nn - - Return the row and column of the named view. class:word {n/a} {n/a} ui retro/python
ui:get-size s-nn - - Return the height and width of the named view. class:word {n/a} {n/a} ui retro/python
ui:get-text s-s - - Get the value of the text property of the named view. class:word {n/a} {n/a} ui retro/python
ui:get-title s-s - - Get the value of the title property for the named view. class:word {n/a} {n/a} ui retro/python
ui:operation ...n- - - Carry out a UI operation. Used internally by the other `ui:` words. class:word {n/a} {n/a} ui retro/python
ui:present - - - Display all views. class:word {n/a} {n/a} ui retro/python
ui:remove-view s- - - Remove view named `s` from the displayed views. class:word {n/a} {n/a} ui retro/python
ui:set-action as- - - Set the action handler for a view to the specified Retro word address. class:word {n/a} {n/a} ui retro/python
ui:set-position nns- - - Move view `s` to row `n1` and column `n2`. class:word {n/a} {n/a} ui retro/python
ui:set-size nns- - - Set view `s` to height `n1` and width `n2`. class:word {n/a} {n/a} ui retro/python
ui:set-text ss- - - Set the text property of view `s2` to `s1`. class:word {n/a} {n/a} ui retro/python
ui:set-title ss- - - Set the title property of view `s2` to `s1`. class:word {n/a} {n/a} ui retro/python
unhook a- - - Reset the hook point in a1 to the default definition. class:word :foo hook #1 ;\n :bar #2 ;\n &bar &foo set-hook\n &foo unhook {n/a} global all
unix:chdir s- - - Change the current working directory to the specified one. class:word '/etc unix:chdir {n/a} unix rre
unix:count-files-in-cwd -n - - Return the number of files (and subdirectories) in the current working directory class:word {n/a} {n/a} unix rre
unix:exec0 s- - - Execute a process by running the application specified by s. class:word {n/a} {n/a} unix rre
unix:exec1 ss- - - Execute a process by running the application specified by s1. Pass s2 as an argument. class:word {n/a} {n/a} unix rre
unix:exec2 sss- - - Execute a process by running the application specified by s1. Pass s2 and s3 as arguments. class:word {n/a} {n/a} unix rre
unix:exec3 ssss- - - Execute a process by running the application specified by s1. Pass s2, s3, and s4 as arguments. class:word {n/a} {n/a} unix rre
unix:execute s- - - Runs another application and return after execution is completed. This does not invoke the shell like `unix:system` and does not support globbing. class:word 'ls_-lh_/etc unix:system {n/a} unix rre
unix:exit n- - - Exit the current process, returning the specified return code. class:word {n/a} {n/a} unix rre
unix:for-each-file q- - - 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:word {n/a} {n/a} unix rre
unix:fork -n - - Fork the current process. Returns a PID. class:word {n/a} {n/a} unix rre
unix:get-cwd -s - - Return the current working directory class:word {n/a} {n/a} unix rre
unix:getenv sa- - - Get an environment variable. Provide the name and an address to store it in. class:word 'SHELL s:empty [ unix:getenv ] sip s:put nl {n/a} unix rre
unix:getpid -n - - Return the PID of the current process. class:word {n/a} {n/a} unix rre
unix:kill nn- - - Terminates a process. Takes a process and a signal to send. class:word {n/a} {n/a} unix rre
unix:pclose n- - - Close a pipe. class:word {n/a} {n/a} unix rre
unix:pipe s- - - Takes a string with a Unix command line and run it in a pipe, returning a new string with the first line of the output from the pipe. class:word 'ls_-l unix:pipe s:put nl {n/a} unix rre
unix:popen sn-n - - 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:word {n/a} {n/a} unix rre
unix:putenv s- - - Takes a string in the form `name=value` and sets an environment variable named `name` to `value`. class:word 'EDITOR=vi unix:putenv {n/a} unix rre
unix:sleep n- - - Sleep for the specified number of seconds. class:word {n/a} {n/a} unix rre
unix:slurp-pipe as-n - - Open a pipe. Read all output from the pipe (until ASCII:NULL) and store in the specified buffer. Return the number of bytes read. class:word {n/a} {n/a} unix rre
unix:system s- - - Runs another application using the system shell and returns after execution is completed. class:word 'ls_-lh_/etc unix:system {n/a} unix rre
unix:wait -n - - Waits for a child process to complete. This maps to the wait() system call. class:word {n/a} {n/a} unix rre
unpack n-nnnn - - Unpack a 32-bit value into four 8-bit values. class:word {n/a} {n/a} global all
until q(-f)- - - 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:word #10 [ dup n:put nl n:dec dup n:zero? ] until {n/a} global all
v:dec a- - - Decrement the value stored at the specified address by 1. class:word {n/a} {n/a} v all
v:dec-by na- - - Decrement the value stored at the specified address by the specified value. class:word {n/a} {n/a} v all
v:inc a- - - Increment the value stored at the specified address by 1. class:word {n/a} {n/a} v all
v:inc-by na- - - Increment the value stored at the specified address by the specified value. class:word {n/a} {n/a} v all
v:limit alu- - - 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:word {n/a} {n/a} v all
v:off a- - - Set a variable to 0. class:word {n/a} {n/a} v all
v:on a- - - Set a variable to -1. class:word {n/a} {n/a} v all
v:preserve aq- - - 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:word {n/a} {n/a} v all
v:update aq- - - 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:word {n/a} {n/a} v all
var s- - - Create a variable. The variable is initialized to 0. class:word 'Base var {n/a} global all
var-n ns- - - Create a variable with the specified initial value. class:word #10 'Base var-n\n {n/a} global all
w:fetch a-n - - Fetch the 32-bit value stored at the specified address. Addressing for this is in 8-bit units. The address must be aligned on a four byte boundary. class:word {n/a) {n/a} global all
w:store na- - - Store an 32-bit value into the specified address. Addressing for this is in 8-bit units. The address must be aligned on a four byte boundary. class:word {n/a} {n/a} global all
while q(-f)- - - 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:word #10 [ dup n:put nl n:dec dup n:-zero? ] while {n/a} global all
xor mn-o - - Perform a bitwise XOR operation. class:primitive {n/a} {n/a} global all
{ - - - Begin an array. This is intended to make creating arrays a bit cleaner than using a quotation and `a:counted-results`. class:word {n/a} {n/a} global all
{{ - - - Begin a lexically scoped area. class:word {n/a} {n/a} global all
} -a - - Complete an array begun by `{`. Returns a pointer to the data. class:word {n/a} {n/a} global all
}} - - - End a lexically scoped area. This will hide any headers between `{{` and `---reveal---`, leaving only headers between `---reveal---` and the `}}` visible. class:word {n/a} {n/a} global all