crc/retroforth
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
retroforth/doc/words.tsv
crc de4a28c43c add missing glossary entries for n: words 
FossilOrigin-Name: e803f95e3921bb93011b4171dfb6e6262690063c990a96199d6cc7b181c1f8e8
2022-07-25 12:06:29 +00:00

71 KiB
Raw Blame History

1$-c--Return ASCII:NUL (0).class:macro{n/a}{n/a}globalall
2'-s--Return an empty string.class:macro{n/a}{n/a}globalall
3(---Provide a visual indication of a code group.class:macro{n/a}{n/a}sigilall
4)---Provide a visual indication of a code group.class:macro{n/a}{n/a}sigilall
5*nn-n--Multiply `n1` by `n2` and return the result.class:primitive #2 #6 *\n #-1 #100 *{n/a}globalall
6*/modxyz-rv--Multiply `x` by `y` and then divide by `z` and return the integer part of the quotient and remainder.class:word{n/a}{n/a}globalrre
7+nn-n--Add `n1` to `n2` and return the result.class:primitive #1 #2 + {n/a}globalall
8,n---Store the specified value into the memory at `here` and increment `Heap` by 1.class:word $a , $b , $c , #0 ,{n/a}globalall
9-nn-n--Subtract `n2` from `n1` and return the result.class:primitive #2 #1 - {n/a}globalall
10---reveal------Switch to the exposed (public) portion of a lexical namespace.class:word{n/a}{n/a}globalall
11-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}globalall
12-iffq---Execute the quotation if the flag is `FALSE`.class:word{n/a}{n/a}globalall
13-if;fq---Execute the quotation if the flag is `FALSE`. If false, also exit the word.class:word{n/a}{n/a}globalall
14/nm-v--Divide `n` by `m` and return the integer part of the quotient.class:word{n/a}{n/a}globalall
15//---Ignore any tokens remaining on the current line. Works with files and the interactive "listener".class:word{n/a}{n/a}globalrre
16/modnm-rv--Divide `n` by `m` and return the integer part of the quotient and remainder.class:primitive{n/a}{n/a}globalall
170;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}globalall
18;---End the current definition.class:macro{n/a}{n/a}globalall
19?dupn-nn || n-n--Duplicate top value on stack if not zero. If zero, do nothing.class:word #1 ?dup\n #0 ?dup{n/a}globalall
20ASCII:ACK-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
21ASCII:BEL-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
22ASCII:BS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
23ASCII:CAN-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
24ASCII:CR-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
25ASCII:DC1-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
26ASCII:DC2-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
27ASCII:DC3-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
28ASCII:DC4-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
29ASCII:DEL-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
30ASCII:DLE-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
31ASCII:EM-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
32ASCII:ENQ-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
33ASCII:EOT-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
34ASCII:ESC-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
35ASCII:ETB-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
36ASCII:ETX-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
37ASCII:FF-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
38ASCII:FS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
39ASCII:GS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
40ASCII:HT-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
41ASCII:LF-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
42ASCII:NAK-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
43ASCII:NUL-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
44ASCII:RS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
45ASCII:SI-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
46ASCII:SO-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
47ASCII:SOH-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
48ASCII:SPACE-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
49ASCII:STX-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
50ASCII:SUB-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
51ASCII:SYN-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
52ASCII:US-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
53ASCII:VT-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
54BUILD-n--Constant. Return a build identifier. Use along with version to identify an image.class:data{n/a}{n/a}globalall
55Base-a--Variable. Holds the current numeric base. Base must be in the range of 2-16.class:data{n/a}{n/a}globalall
56Compiler-a--Variable. Holds the compiler state. If TRUE, the compiler is active. If FALSE, it is not.class:data{n/a}{n/a}globalall
57Dictionary-a--Variable. Holds a pointer to the most recent dictionary header.class:data{n/a}{n/a}globalall
58EOM-a--Constant. Returns the last addressable memory address.class:word{n/a}{n/a}globalall
59FALSE-n--Returns `0`, the value used to indicate a FALSE result.class:word{n/a}{n/a}globalall
60FREE-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}globalall
61Heap-a--Variable. Holds the address of the next available cell.class:data{n/a}{n/a}globalall
62I-n--Access the loop index for the current loop. (For loops made using `indexed-times`)class:word{n/a}{n/a}globalall
63J-n--Access the parent loop index for the current loop. (For loops made using `indexed-times`)class:word{n/a}{n/a}globalall
64K-n--Access the grandparent loop index for the current loop. (For loops made using `indexed-times`)class:word{n/a}{n/a}globalall
65NoEcho-a--Deprecated. Variable. If TRUE, allow display of the startup banner when running listen.class:word{n/a}{n/a}globalrre
66RewriteUnderscores-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}globalall
67STRINGS-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}globalall
68ScopeList-a--Variable. This holds some information used by `{{` and `}}`.class:data{n/a}{n/a}globalall
69TIB-a--Constant. Returns a pointer to the text input buffer.class:data{n/a}{n/a}globalrre
70TRUE-n--Returns `-1`, the value used to indicate a TRUE result.class:word{n/a}{n/a}globalall
71TempStringMax-a--Variable. Holds the maximum length of a temporary string.class:data{n/a}{n/a}globalall
72TempStrings-a--Variable. Holds the number of temporary strings.class:data{n/a}{n/a}globalall
73Version-a--Variable. This stores the version number.class:data{n/a}{n/a}globalall
74[---Begin a quotation.class:macro{n/a}{n/a}globalall
75]---End a quotation.class:macro{n/a}{n/a}globalall
76a:-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}aall
77a:appendaa-a--Return a new array consisting of the values in a1 followed by the values in a2.class:word{n/a}{n/a}aall
78a:begins-with?aa-f--Return `TRUE` if a1 begins with a2 or `FALSE` otherwise.class:word{n/a}{n/a}aall
79a:chopa-a--Return a new array containing all but the last value in the source array.class:word{n/a}{n/a}aall
80a: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}aall
81a:contains/string?sa-f--Return `TRUE` if the string value is in the array or `FALSE` otherwise.class:word{n/a}{n/a}aall
82a:contains?na-f--Return `TRUE` if the value is in the array or `FALSE` otherwise.class:word{n/a}{n/a}aall
83a:copyaa---Copy an array (a1) to a destination (a2).class:word{n/a}{n/a}aall
84a:counted-resultsq-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}aall
85a:dupa-b--Make a copy of an array. Return the address of the copy.class:word{n/a}{n/a}aall
86a:ends-with?aa-f--Return `TRUE` if a1 ends with a2 or `FALSE` otherwise.class:word{n/a}{n/a}aall
87a: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}aall
88a:fetchan-n--Fetch the value stored at the specified index in the specified array.class:word { #0 #1 #3 } #2 a:fetch{n/a}aall
89a:filteraq-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}aall
90a:for-eachaq---Execute the quote once for each item in the array.class:word{n/a}{n/a}aall
91a:from-strings-a--Create a new array with the characters in the source string.class:word{n/a}{n/a}aall
92a:indexan-n--Return the location of the first instance of the specified value in the array.class:word{n/a}{n/a}aall
93a:index-ofan-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}aall
94a:index-of-stringas-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}aall
95a:index/stringas-n--Return the location of the first instance of the specified string in the array.class:word{n/a}{n/a}aall
96a:leftan-a--Return a new array containing the first `n` values from the source array.class:word{n/a}{n/a}aall
97a:lengtha-n--Return the length of a array.class:word{n/a}{n/a}aall
98a:makeq-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}aall
99a:mapaq-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}aall
100a:middleafl-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}aall
101a:prependaa-a--Return a new array consisting of the values in a2 followed by the values in a1.class:word{n/a}{n/a}aall
102a:reducepnq-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}aall
103a:reversea-b--Reverse the order of items in a array. This will return a new array.class:word{n/a}{n/a}aall
104a:rightan-a--Return a new array containing the specified number of values from the right side of the array.class:word{n/a}{n/a}aall
105a:storevan---Store a value into the array at the specified index.class:word #3 { #0 #1 #2 } #1 a:store{n/a}aall
106a:than-b--Return the actual address of the `n`th item in the array.class:word{n/a}{n/a}aall
107a:to-stringa-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}aall
108abort---Abort execution.class:macro{n/a}{n/a}globalrre
109again---Close an unconditional loop. Branches back to the prior `repeat`.class:macro{n/a}{n/a}globalall
110allotn---Allocate the specified number of cells from the `Heap`.class:word 'Buffer d:create #100 allot{n/a}globalall
111andnm-o--Perform a bitwise AND operation between the two provided values.class:primitive{n/a}{n/a}globalall
112b:fetcha-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}globalall
113b:fetch-nexta-an--Fetch the value stored at the specified address. Returns the next address and the value.class:word{n/a}{n/a}ball
114b:storena---Store an 8-bit value into the specified address. Addressing for this is in 8-bit units.class:word{n/a}{n/a}globalall
115b:store-nextna-a--Store a value into the specified address and return the next address.class:word{n/a}{n/a}ball
116b:to-byte-addressa-a--Translate a physical address to a byte address.class:word{n/a}{n/a}globalall
117banner---Display a welcome message on startup.class:word{n/a}{n/a}globalrre{n/a}
118bixqq-?--Execute q1 against x, then execute q2 against a copy of x.class:word #100 [ #10 * ] [ #10 - ] bi{n/a}globalall
119bi*xyqq-?--Execute q1 against x and q2 against y.class:word #10 #20 [ #2 * ] [ #10 / ] bi*{n/a}globalall
120bi@xyq-?--Execute q against x, then execute q against y.class:word #10 #20 [ #3 * ] bi@{n/a}globalall
121binary---Set `Base` to binary.class:word{n/a}{n/a}aall
122buffer:addn---Append a value to the current buffer.class:word{n/a}{n/a}bufferall
123buffer:empty---Reset the current buffer to an empty state.class:word{n/a}{n/a}bufferall
124buffer:end-a--Return a pointer to the current end of the active buffer.class:word{n/a}{n/a}bufferall
125buffer:get-n--Remove the last value from the current buffer.class:word{n/a}{n/a}bufferall
126buffer:preserveq---Save and restore the current buffer before and after executing the specified quote.class:word{n/a}{n/a}bufferall
127buffer:seta---Assign a new buffer as the current one.class:word{n/a}{n/a}bufferall
128buffer:size-n--Return the number of cells in the buffer.class:word{n/a}{n/a}bufferall
129buffer:start-a--Return the start address of the current buffer.class:word{n/a}{n/a}bufferall
130bye---Exit Retro.class:word{n/a}{n/a}globalall
131c:-consonant?c-f--Return TRUE if character is a not consonant or FALSE otherwise.class:word{n/a}{n/a}call
132c:-digit?c-f--Return TRUE if character is a not numeric digit or FALSE otherwise.class:word{n/a}{n/a}call
133c:-lowercase?c-f--Return TRUE if character is not lowercase or FALSE otherwise.class:word{n/a}{n/a}call
134c:-uppercase?c-f--Return TRUE if character is not uppercase or FALSE otherwise.class:word{n/a}{n/a}call
135c:-visible?c-f--Return TRUE if character is not printable or FALSE otherwise.class:word{n/a}{n/a}call
136c:-vowel?c-f--Return TRUE if character is not a vowel or FALSE otherwise.class:word{n/a}{n/a}call
137c:-whitespace?c-f--Return TRUE if character is not whitespace, or FALSE otherwise.class:word{n/a}{n/a}call
138c:consonant?c-f--Return TRUE if character is a consonant or FALSE otherwise.class:word{n/a}{n/a}call
139c:digit?c-f--Return TRUE if character is a numeric digit or FALSE otherwise.class:word{n/a}{n/a}call
140c:get-c--Vectored. Read a single keypress.class:word{n/a}{n/a}globalrre
141c:letter?c-f--Return TRUE if character is an ASCII letter or FALSE otherwise.class:word{n/a}{n/a}call
142c:lowercase?c-f--Return TRUE if character is lowercase or FALSE otherwise.class:word{n/a}{n/a}call
143c:putc---Vectored. Display a single character.class:word{n/a}{n/a}globalall
144c:to-lowerc-c--Convert character to lowercase equivalent.class:word{n/a}{n/a}call
145c:to-numberc-n--Convert an ASCII digit character into the corresponding decimal valueclass:word{n/a}{n/a}globalall
146c:to-stringc-s--Convert character into a string.class:word{n/a}{n/a}call
147c:to-upperc-c--Convert character to uppercase equivalent.class:word{n/a}{n/a}call
148c:toggle-casec-c--Convert an ASCII character to the opposite case.class:word{n/a}{n/a}call
149c:uppercase?c-f--Return TRUE if character is uppercase or FALSE otherwise.class:word{n/a}{n/a}call
150c:visible?c-f--Return TRUE if character is printable or FALSE otherwise.class:word{n/a}{n/a}call
151c:vowel?c-f--Return TRUE if character is a vowel or FALSE otherwise.class:word{n/a}{n/a}call
152c:whitespace?c-f--Return TRUE if character is whitespace, or FALSE otherwise.class:word{n/a}{n/a}call
153calla---Call a function.class:primitive{n/a}{n/a}globalall
154casenmq- || 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}globalall
155choosefqq---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}globalall
156class:datan- || 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}classall
157class:macroa---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}classall
158class:primitivea---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}classall
159class:worda---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}classall
160clear---Clear the display.class:word{n/a}{n/a}globalrre
161clock:day-n--Return the current day.class:word{n/a}{n/a}clockiOS, rre
162clock:hour-n--Return the current hour. This will be in the range of 0-23, inclusive.class:word{n/a}{n/a}clockiOS, rre
163clock:minute-n--Return the current minute. This will be in the range of 0-59, inclusive.class:word{n/a}{n/a}clockiOS, rre
164clock:month-n--Return the current month. This will be in the range of 1-12, inclusive.class:word{n/a}{n/a}clockiOS, rre
165clock:operation...n---Trigger a clock operation. This is not intended to be used directly.class:word{n/a}{n/a}clockrre
166clock:second-n--Return the current second. This will be in the range of 0-59, inclusive.class:word{n/a}{n/a}clockiOS, rre
167clock: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}clockrre
168clock:utc:day-n--Return the current day in UTC.class:word{n/a}{n/a}clockiOS, rre
169clock:utc:hour-n--Return the current hour in UTC.class:word{n/a}{n/a}clockiOS, rre
170clock:utc:minute-n--Return the current minute in UTC.class:word{n/a}{n/a}clockiOS, rre
171clock:utc:month-n--Return the current month in UTC.class:word{n/a}{n/a}clockiOS, rre
172clock:utc:second-n--Return the current second in UTC.class:word{n/a}{n/a}clockiOS, rre
173clock:utc:year-n--Return the current year in UTC.class:word{n/a}{n/a}clockiOS, rre
174clock:year-n--Return the current year.class:word{n/a}{n/a}clockiOS, rre
175compile:calla---Compile a call to the specified address into the current definition.class:word{n/a}{n/a}compileall
176compile:jumpa---Compile a jump to the specified address into the current definition.class:word{n/a}{n/a}compileall
177compile:litn---Compile the code to push a number to the stack into the current definition.class:word{n/a}{n/a}compileall
178compile:ret---Compile a return instruction into the current definition.class:word{n/a}{n/a}compileall
179compiling?-f--Return `TRUE` if compiler is on or `FALSE` otherwise.class:word{n/a}{n/a}globalall
180constns---Create a constant returning the specified value.class:word{n/a}{n/a}globalall
181copysdl---Copy `l` cells from memory at `s` to the memory at `d`. These should not overlap.class:word{n/a}{n/a}globalall
182core:initn---Clear the internal state of core `n`. This should be done prior to use of `core:start`, which activates processing on the core.class:word{n/a}{n/a}corerre
183core:pausen---Suspend processing on core `n`.class:word{n/a}{n/a}corerre
184core:pause-current---Suspend processing on the current core.class:word{n/a}{n/a}corerre
185core:read/regn-v--Read a value from register `n` on the current core.class:word{n/a}{n/a}corerre
186core:resumen---Resume processing on core `n` after a `core:pause` or `core:pause-current`.class:word{n/a}{n/a}corerre
187core:startan---Set the IP of core `n` to address `a` and begin processing on core `n`.class:word{n/a}{n/a}corerre
188core:write/regvn---Write a value to register number `n` on the current core.class:word{n/a}{n/a}corerre
189currynq-q--Bind a value to a function and return a new quote that calls the bound action.class:word{n/a}{n/a}globalall
190dn---Inline a numeric value to the current assembly segment.class:word{n/a}{n/a}globalall
191d:add-headersaa---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}dall
192d:classd-a--Given a dictionary header, return the class field.class:word{n/a}{n/a}dall
193d:creates---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}dall
194d:for-eachq---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}dall
195d:last-d--Return the most recent dictionary header.class:word{n/a}{n/a}dall
196d:last.class-a--Return a pointer to the class field of the most recent dictionary header.class:word{n/a}{n/a}dall
197d:last.name-s--Return a pointer to the name field of the most recent dictionary header.class:word{n/a}{n/a}dall
198d:last.xt-a--Return a pointer to the xt field of the most recent dictionary header.class:word{n/a}{n/a}dall
199d:linkd-a--Given a dictionary header, return the link field.class:word{n/a}{n/a}dall
200d:lookups-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}dall
201d:lookup-xta-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}dall
202d:named-s--Given a dictionary header, return the name field.class:word{n/a}{n/a}dall
203d:sourced-a--Given a dictionary header, return the source field.class:word{n/a}{n/a}dall
204d:words---Display a list of all named items in the `Dictionary`.class:word{n/a}{n/a}drre
205d:words-beginning-withs---Display a list of all named items in the `Dictionary` that begin with the provided substring.class:word{n/a}{n/a}drre
206d:words-withs---Display a list of all named items in the `Dictionary` that contain the provided substring.class:word{n/a}{n/a}drre
207d:xtd-a--Given a dictionary header, return the xt field.class:word{n/a}{n/a}dall
208data---Change the class of the most recently defined word to `class:data`.class:word{n/a}{n/a}globalall
209decimal---Set `Base` to decimal.class:word{n/a}{n/a}aall
210depth-n--Return the number of items on the stack.class:word{n/a}{n/a}globalall
211dipnq-n--Temporarily remove n from the stack, execute the quotation, and then restore n to the stack.class:word{n/a}{n/a}globalall
212doesq---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}globalall
213dropn---Discard the top value on the stack.class:primitive{n/a}{n/a}globalall
214drop-pairnn---Remove top two items on the stack.class:word{n/a}{n/a}globalall
215dump-stack---Display the items on the data stack.class:word{n/a}{n/a}globalall
216dupn-nn--Duplicate the top item on the stack.class:primitive{n/a}{n/a}globalall
217dup-pairnm-nmnm--Duplicate the top two items on the stack.class:word{n/a}{n/a}globalall
218e:-INF-e--Constant. Negative infinity. For encoded floating-point values.class:word{n/a}{n/a}erre{n/a}
219e:-inf?e-f--Is encoded value negative infinity?class:word{n/a}{n/a}erre{n/a}
220e:INF-e--Constant. Infinity. For encoded floating-point values.class:word{n/a}{n/a}erre{n/a}
221e:MAX-e--Constant. Maximum value. For encoded floating-point values.class:word{n/a}{n/a}erre
222e:MIN-e--Constant. Minimum value. For encoded floating-point values.class:word{n/a}{n/a}erre{n/a}
223e:NAN-e--Constant. Not a Number. For encoded floating-point values.class:word{n/a}{n/a}erre{n/a}
224e:clipe-E--Constrain the encoded value to the allowable range.class:word{n/a}{n/a}erre
225e:inf?e-f--Is encoded value infinity?class:word{n/a}{n/a}erre{n/a}
226e:max?e-f--Is encoded value at the maximum?class:word{n/a}{n/a}erre{n/a}
227e:min?e-f--Is encoded value at the minimum?class:word{n/a}{n/a}erre{n/a}
228e:n?e-f--Return `TRUE` if the encoded value is a valid number, or `FALSE` otherwise.class:word{n/a}{n/a}erre
229e:nan?e-f--Is encoded value a Nan?class:word{n/a}{n/a}erre{n/a}
230e:pute---Display an encoded number.class:word{n/a}{n/a}erre
231e:to-fe---nDecode an encoded floating-point value.class:word{n/a}{n/a}erre
232e:zero?e-f--Return `TRUE` if the value is zero, or `FALSE` otherwise.class:word{n/a}{n/a}erre
233eq?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}globalall
234err:notfound---Vectored. Error handler. Called when a word is not found by `interpret`.class:word{n/a}{n/a}errall
235f:*--FF-FMultiply two floating-point numbers, returning the result.class:word .3.1415 .22 f:*{n/a}frre
236f:+--FF-FAdd two floating-point numbers, returning the result.class:word .3.1 .22 f:+{n/a}frre
237f:---FF-FSubtract F2 from F1 returning the result.class:word .22.3 .0.12 f:-{n/a}frre
238f:-INF---nReturn a value corresponding to negative infinityclass:word{n/a}{n/a}frre
239f:-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}frre
240f:-inf?-f-F-Return `TRUE` if floating-point value is -INF or `FALSE` otherwise.class:word{n/a}{n/a}frre
241f:/--FF-FDivide floating-point value F1 by F2.class:word{n/a}{n/a}frre
242f:E---FReturn the floating-point value for Euler's number.class:word{n/a}{n/a}frre
243f:E1---fHook. Return a constant used as the scaling factor for the e: words.class:word{n/a}{n/a}frre{n/a}
244f:INF---nReturn a value corresponding to positive infinityclass:word{n/a}{n/a}frre
245f:NAN---nReturn a value corresponding to NaNclass:word{n/a}{n/a}frre
246f:PI---FReturn the floating-point value for PI.class:word{n/a}{n/a}frre
247f:abs--F-FReturn the absolute value for a floating-point value.class:word{n/a}{n/a}frre
248f:acos--F-FReturn the arc cosine of a floating-point number.class:word{n/a}{n/a}frre
249f:adepth-n--Return the number of items on the alternate floating-point stack.class:word{n/a}{n/a}frre
250f:asin--F-FReturn the arc sine of a floating-point number.class:word{n/a}{n/a}frre
251f:atan--F-FReturn the arc tangent of a floating-point number.class:word{n/a}{n/a}frre
252f: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}frre
253f:caseq--nm-nIf `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}frre
254f:ceiling--F-FReturn the smallest integral value greater than or equal to the specified value.class:word{n/a}{n/a}frre
255f:cos--F-FReturn the cosine of a floating-point number.class:word{n/a}{n/a}frre
256f:dec--n-mDecrement n by one.class:word .100 f:dec{n/a}frre
257f:depth-n--Return the number of items on the floating-point stack.class:word{n/a}{n/a}frre
258f:drop--F-Discard the top item on the floating-point stack.class:word{n/a}{n/a}frre
259f:drop-pair--FF-Remove top two items on the stack.class:word{n/a}{n/a}frre
260f:dump-astack---Display the items on the alternate floating-point stack.class:word{n/a}{n/a}frre
261f:dump-stack---Display the items on the floating-point stack.class:word{n/a}{n/a}frre
262f:dup--F-FFDuplicate the top item on the floating-point stack.class:word{n/a}{n/a}frre
263f:dup-pair--nm-nmnmDuplicate the top two items on the stack.class:word{n/a}{n/a}frre
264f: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}frre
265f:fetcha---nFetch a stored floating-point value.class:word{n/a}{n/a}frre
266f:floor--F-FPerform a mathematical floor operation on the floating-point value.class:word{n/a}{n/a}frre
267f:gt?-f-FF-Compare two floating-point values for greater than.class:word{n/a}{n/a}frre
268f:inc--n-mIncrement n by one.class:word .100 f:inc{n/a}frre
269f:inf?-f-F-Return `TRUE` if floating-point value is INF or `FALSE` otherwise.class:word{n/a}{n/a}frre
270f:limit--nlu-mReturn 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}frre
271f:log--FF-FReturn log(F1) for base F2 for floating-point values.class:word{n/a}{n/a}frre
272f:lt?-f-FF-Compare two floating-point values for less than.class:word{n/a}{n/a}frre
273f:max--mn-oReturn the greater of two values.class:word .1 .7 f:max\n .-8 .-10 f:max{n/a}frre
274f:min--mn-oReturn the lesser of two values.class:word .1 .7 f:min\n .-8 .-10 f:min{n/a}frre
275f:nan?-f-F-Return `TRUE` if floating-point value is NaN or `FALSE` otherwise.class:word{n/a}{n/a}frre
276f:negate--F-FInvert the sign of the floating-point value.class:word .3.1415 f:negate{n/a}frre
277f:negative?-f-F-Return `TRUE` if floating-point value is negative or `FALSE` if not.class:word{n/a}{n/a}frre
278f:nip--NM-MRemove the second item from the stack.class:word{n/a}{n/a}frre
279f:over--FG-FGFPut a copy of the second floating-point value over the top one.class:word{n/a}{n/a}frre
280f:pop---FPop a floating-point value from the alternate stack.class:word{n/a}{n/a}frre
281f:positive?-f-F-Return `TRUE` if floating-point value is positive or `FALSE` otherwise.class:word{n/a}{n/a}frre
282f:power--FF-FReturn F1^F2 for floating-point values.class:word{n/a}{n/a}frre
283f:push--F-Push a floating-point value to an alternative stack.class:word{n/a}{n/a}frre
284f:put--F-Display a floating-point number.class:word{n/a}{n/a}globalrre
285f:rot--abc-bcaRotate the top three values.class:word{n/a}{n/a}frre
286f:round--f-fRound a floating-point value.class:word{n/a}{n/a}frre
287f: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}frre
288f:signed-sqrt--F-FReturn the square root of a floating-point number.class:word{n/a}{n/a}frre
289f:signed-square--f-fReturn the square of a floating-point number.class:word{n/a}{n/a}frre
290f:sin--F-FReturn the sine of a floating-point number.class:word{n/a}{n/a}frre
291f:sqrt--F-FReturn the square root of a floating-point number.class:word{n/a}{n/a}frre
292f:square--f-fReturn the square of a floating-point number.class:word{n/a}{n/a}frre
293f:storea--n-Store a floating-point value to the specified memory location.class:word{n/a}{n/a}frre
294f:swap--FG-GFExchange the top and second items on the floating-point stack.class:word{n/a}{n/a}frre
295f:tan--F-FReturn the tangent of a floating-point number.class:word{n/a}{n/a}frre
296f:to-e-e-n-Encode the floating-point value to an integer.class:word{n/a}{n/a}frre
297f:to-number-n-F-Convert a floating-point value into a number.class:word{n/a}{n/a}frre
298f:to-string-s-F-Convert a floating-point value into a string.class:word{n/a}{n/a}frre
299f:tuck--FG-GFGTuck a copy of the top floating-point value under the second one.class:word{n/a}{n/a}frre
300fetcha-n--Fetch the value stored at the specified address.class:primitive &Version fetch{n/a}globalall
301fetch-nexta-an--Fetch the value stored at the specified address. Returns the next address and the value.class:word{n/a}{n/a}globalall
302file:A-n--Constant for opening a file in APPEND mode.class:data{n/a}{n/a}filerre
303file:R-n--Constant for opening a file in READ mode.class:data{n/a}{n/a}filerre
304file:R+-n--Constant for opening a file in READ & WRITE mode.class:data{n/a}{n/a}filerre
305file:W-n--Constant for opening a file in WRITE mode.class:data{n/a}{n/a}filerre
306file:closeh---Given a file handle, close the file.class:word{n/a}{n/a}filerre
307file:deletes---Delete the named file.class:word{n/a}{n/a}filerre
308file:exists?s-f--Given a file name, return `TRUE` if it exists or `FALSE` if it does not.class:word{n/a}{n/a}filerre
309file:flushh---Given a file handle, flush any pending writes to disk.class:word{n/a}{n/a}filerre
310file:for-each-linesq---Given a file name, open it and run the quote once for each line in the file.class:word{n/a}{n/a}filerre
311file:opensm-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}filerre
312file:open-for-appends-nn--Open a file for reading & writing. Returns the size (NOS) and a file ID (TOS)class:word{n/a}{n/a}filerre
313file:open-for-readings-nn--Open a file for reading. Returns the size (NOS) and a file ID (TOS)class:word{n/a}{n/a}filerre
314file:open-for-writings-n--Open a file for writing. Returns the file IDclass:word{n/a}{n/a}filerre
315file:operation...n---Trigger a file I/O operation. This is not intended to be used directly.class:word{n/a}{n/a}filerre
316file:readh-c--Given a file handle, read and return the next character in it.class:word{n/a}{n/a}filerre
317file:read-linef-s--Given a file handle, read a line and return a pointer to it.class:word{n/a}{n/a}filerre
318file:seeknh---Move the current offset into a file to the specified one.class:word{n/a}{n/a}filerre
319file:sizeh-n--Given a file handle, return the size of the file (in bytes).class:word{n/a}{n/a}filerre
320file:slurpas---Given an address and a file name, read the file contents into memory starting at the address.class:word{n/a}{n/a}filerre
321file:spewss---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}filerre
322file:tellh-n--Given a file handle, return the current offset in the file.class:word{n/a}{n/a}filerre
323file:writech---Write a character to the file represented by the handle.class:word{n/a}{n/a}filerre
324float:operation...n---Trigger a floating-point operation. This is not intended to be used directly.class:word{n/a}{n/a}floatrre
325foreverq---Run quotation in an endless loop.class:word{n/a}{n/a}aall
326gopher:getasns-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}gopherios
327gt?nn-f--Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise.class:primitive{n/a}{n/a}globalall
328gteq?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}globalall
329h:fetcha-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}globalall
330h:fetch-nexta-an--Fetch the value stored at the specified address. Returns the next address and the value.class:word{n/a}{n/a}hall
331h:storena---Store an 16-bit value into the specified address. Addressing for this is in 8-bit units.class:word{n/a}{n/a}globalall
332h:store-nextna-a--Store a value into the specified address and return the next address.class:word{n/a}{n/a}hall
333here-a--Return the next free address in memory.class:word{n/a}{n/a}globalall
334hex---Set `Base` to hexadecimal.class:word{n/a}{n/a}aall
335hook---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 ;globalglobal
336is---Assemble the instructions specified by the string into the current assembly scope.class:word{n/a}{n/a}globalall
337iffq---Execute the quote if the flag is `TRUE`.class:word{n/a}{n/a}globalall
338if;fq---Execute the quotation if the flag is `TRUE`. If true, also exit the word.class:word{n/a}{n/a}globalall
339image:saves---Save the current system to a new image file.class:word{n/a}{n/a}imagerre
340immediate---Change the class of the most recently defined word to `class:macro`.class:word{n/a}{n/a}globalall
341includes---Run the code in the specified file. class:word{n/a}{n/a}globalrre
342indexed-timesnq---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}globalall
343interprets---Vectored. Interpret a single input token.class:word '#100 interpret\n 'words interpret{n/a}globalall
344io:core...n---Trigger an I/O operation involving multicore support. Unix system call.class:word{n/a}{n/a}iorre
345io:enumerate-n--Return the number of I/O devices.class:word{n/a}{n/a}ioall
346io:invoken---Invoke an interaction with an I/O device.class:word{n/a}{n/a}ioall
347io:queryn-mN--Ask an I/O device to identify itself. Returns a version (m) and device ID (N).class:word{n/a}{n/a}ioall
348io:scan-forn-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}ioall
349io:unix-syscall...n---Trigger a Unix system call. This is not intended to be used directly.class:word{n/a}{n/a}iorre
350listen---Run interactive "listener" (a REPL).class:word{n/a}{n/a}globalrre
351lt?nn-f--Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise.class:primitive{n/a}{n/a}globalall
352lteq?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}globalall
353modnm-o--Divide `n` by `m` and return the remainder.class:word{n/a}{n/a}globalall
354n:-zero?n-f--Return `TRUE` if number is not zero, or `FALSE` otherwise.class:word{n/a}{n/a}nall
355n:MAX-n--Return the maximum value that will fit in a cell.class:word{n/a}{n/a}nall
356n:MIN-n--Return the minimum value that will fit in a cell.class:word{n/a}{n/a}nall
357n:absn-n--Return the absolute value of a number.class:word #10 n:abs\n #-10 n:abs\n{n/a}nall
358n:addnn-n--Add `n1` to `n2` and return the result.class:primitive #1 #2 + {n/a}globalall
359n: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}nall
360n:decn-m--Decrement n by one.class:word #100 n:dec{n/a}nall
361n:divnm-v--Divide `n` by `m` and return the integer part of the quotient.class:word{n/a}{n/a}globalall
362n:divmodnm-rv--Divide `n` by `m` and return the integer part of the quotient and remainder.class:primitive{n/a}{n/a}globalall
363n:even?n-f--Return `TRUE` if number is even, or `FALSE` if not.class:word #12 n:even?\n #11 n:even?{n/a}nall
364n:incn-m--Increment n by one.class:word #100 n:inc{n/a}nall
365n:limitnlu-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}nall
366n:maxmn-o--Return the greater of two values.class:word #1 #7 n:max\n #-8 #-10 n:max{n/a}nall
367n:minmn-o--Return the lesser of two values.class:word #1 #7 n:min\n #-8 #-10 n:min{n/a}nall
368n:modnm-o--Divide `n` by `m` and return the remainder.class:word{n/a}{n/a}globalall
369n:mulnn-n--Multiply `n1` by `n2` and return the result.class:primitive #2 #6 *\n #-1 #100 *{n/a}globalall
370n:negaten-n--Invert the sign of a number.class:word #10 n:negate\n #-10 n:negate{n/a}nrre
371n:negative?n-f--Return `TRUE` if number is negative, or `FALSE` if not.class:word{n/a}{n/a}nall
372n:odd?n-f--Return `TRUE` if number is odd, or `FALSE` if not.class:word{n/a}{n/a}nall
373n:positive?n-f--Return `TRUE` if number is positive, or `FALSE` if not.class:word{n/a}{n/a}nall
374n:powbp-n--Return base (b) to power (p).class:word{n/a}{n/a}nall
375n:putn---Display a number.class:word{n/a}{n/a}globalall
376n:random-n--Return a random number.class:word n:random n:put{n/a}nrre
377n:sqrtn-m--Return the square root of a number.class:word{n/a}{n/a}nall
378n:squaren-m--Return the square of a number.class:word{n/a}{n/a}nall
379n: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}nall
380n:subnn-n--Subtract `n2` from `n1` and return the result.class:primitive #2 #1 - {n/a}globalall
381n:to-floatn---FConvert a number into a floating-point value.class:word{n/a}{n/a}nrre
382n:to-stringn-s--Convert a number into a string.class:word{n/a}{n/a}nall
383n:zero?n-f--Return `TRUE` if number is zero, or `FALSE` otherwise.class:word{n/a}{n/a}nall
384nipnm-m--Remove the second item from the stack.class:word{n/a}{n/a}globalall
385nl---Display a newline.class:word{n/a}{n/a}globalall
386notn-m--Perform a logical NOT operation.class:word{n/a}{n/a}globalall
387octal---Set `Base` to octal.class:word{n/a}{n/a}aall
388ormn-o--Perform a bitwise OR between the provided values.class:primitive{n/a}{n/a}globalall
389overnm-nmn--Put a copy of n over m.class:word{n/a}{n/a}globalall
390packnnnn-n--Pack four 8-bit values into a 32-bit value.class:word{n/a}{n/a}globalall
391parse-untilq-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}allrre
392pb:geta---Copy a string from the pasteboard to the specified address.class:word{n/a}{n/a}pbiOS{n/a}
393pb:length-n--Return the length of the string on the pasteboard.class:word{n/a}pbpbiOS
394pb:sets---Copy a string to the pasteboard.class:word{n/a}{n/a}pbiOS
395pop-nn--Move a value from the return stack to the data stack.class:macro{n/a}{n/a}globalall
396primitive---Change the class of the most recently defined word to `class:primitive`.class:word{n/a}{n/a}globalall
397pushn--n-Move a value from the data stack to the return stack.class:macro{n/a}{n/a}globalall
398rs---Lookup a reference by name and inline its pointer to the current assembly segment.class:word{n/a}{n/a}globalall
399reclassa---Change the class handler of the most recently defined word to the specified one.class:word{n/a}{n/a}globalall
400reorder...ss-?--Restructure the order of items on the stack.class:word{n/a}{n/a}globalall
401repeat---Begin an unconditional loop.class:macro{n/a}{n/a}globalall
402reset...---Remove all items from the stack.class:word{n/a}{n/a}globalall
403rotabc-bca--Rotate the top three values.class:word{n/a}{n/a}globalall
404s,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}globalall
405s:ASCII-LETTERS-s--Constant. Returns a string of the ASCII letters (upper and lower case)class:data{n/a}{n/a}sall
406s:ASCII-LOWERCASE-s--Constant. Returns a string of the ASCII letters in lowercaseclass:data{n/a}{n/a}sall
407s:ASCII-UPPERCASE-s--Constant. Returns a string of the ASCII letters in uppercaseclass:data{n/a}{n/a}sall
408s:DIGITS-s--Constant. Return a string of characters recognized as numeric digits.class:data{n/a}{n/a}sall
409s:PUNCTUATION-s--Constant. Return a string of characters recognized as punctuation.class:data{n/a}{n/a}sall
410s:WHITESPACE-s--Constant. Returns a string of characters recognized as whitespace.class:data{n/a}{n/a}sall
411s:appendss-s--Return a new string consisting of s1 followed by s2.class:word{n/a}{n/a}sall
412s:begins-with?ss-f--Return `TRUE` if s1 begins with s2 or `FALSE` otherwise.class:word{n/a}{n/a}sall
413s:casesSq- || 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}sall
414s:chops-s--Remove the last character from a string. Returns a new string.class:word{n/a}{n/a}sall
415s:constss---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}sall
416s: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}sall
417s: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}sall
418s:contains/char?sc-f--Return `TRUE` if the character is present in the string or `FALSE` otherwise.class:word{n/a}{n/a}sall
419s: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}sall
420s:copysa---Copy a string (s) to a destination (a). This will include the terminator character when copying.class:word{n/a}{n/a}sall
421s:empty-s--Return an empty string.class:word{n/a}{n/a}sall
422s:ends-with?ss-f--Return `TRUE` if s1 ends with s2 or `FALSE` otherwise.class:word{n/a}{n/a}sall
423s: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}sall
424s:evaluates-?--?Evaluate string as if it was typed into the interpreter.class:word{n/a}{n/a}sall
425s:fetchsn-n--Fetch the character value stored at the specified index in the string.class:word 'abcdef #2 s:fetch{n/a}sall
426s:filtersq-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}sall
427s:for-eachsq---Execute the quote once for each value in the string.class:word{n/a}{n/a}sall
428s:format...s-s--Construct a new string using the template passed and items from the stack.class:word{n/a}{n/a}sall
429s: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}allrre
430s: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}allrre
431s:hashs-n--Calculate a hash value for a string. This uses the djb2 algorithm.class:word{n/a}{n/a}sall
432s:index-ofsc-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}sall
433s:index-of-stringss-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}sall
434s:index/charsc-n--Return the location of the first instance of the specified character in the string.class:word{n/a}{n/a}sall
435s:index/stringss-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}sall
436s:keeps-s--Store a string into the heap and return a pointer to the start of it.class:word{n/a}{n/a}sall
437s:leftsn-s--Return a new string containing the first `n` characters from the source string.class:word{n/a}{n/a}sall
438s:lengths-n--Return the number of characters in a string, excluding the NULL terminator.class:word{n/a}{n/a}sall
439s:mapsq-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}sall
440s:prependss-s--Return a new string consisting of s2 followed by s1.class:word{n/a}{n/a}sall
441s:puts---Display a string.class:word{n/a}{n/a}globalall
442s:replacesss-s--Replace the first instance of s2 in s1 with s3.class:word{n/a}{n/a}sall
443s:replace-allsss-s--Replace all instances of s2 in s1 with s3.class:word{n/a}{n/a}sall
444s:reverses-s--Reverse the order of ASCII characters in a string.class:word{n/a}{n/a}sall
445s:rightsn-s--Return a new string containing the specified number of characters from the right side of the string.class:word{n/a}{n/a}sall
446s:skip---Internal helper function used to skip over a string in a definition.class:word{n/a}{n/a}sall
447s:splitsc-ss--Deprecated. Use `s:split/char` instead. Split a string on the first occurrence of the specified character.class:word{n/a}{n/a}sall
448s:split-on-stringss-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}sall
449s:split/charsc-ss--Split a string on the first occurrence of the specified character.class:word{n/a}{n/a}sall
450s:split/stringss-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}sall
451s:storecsn---Store a character value into the string at the specified index.class:word $z 'abcdef #1 s:store{n/a}sall
452s:substrsfl-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}sall
453s:temps-s--Move a string into the temporary string buffers.class:word{n/a}{n/a}sall
454s:to-floats---FConvert a string representation into a floating-point value.class:word{n/a}{n/a}srre
455s:to-lowers-s--Convert uppercase ASCII characters in a string to lowercase.class:word{n/a}{n/a}sall
456s:to-numbers-n--Convert a string to a number.class:word{n/a}{n/a}sall
457s:to-uppers-s--Convert lowercase ASCII characters in a string to uppercase.class:word{n/a}{n/a}sall
458s:tokenizesc-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}sall
459s:tokenize-on-stringss-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}sall
460s:trims-s--Trim leading and trailing whitespace from a string.class:word '__hello__ s:trim{n/a}sall
461s:trim-lefts-s--Trim leading whitespace from a string.class:word '__hello__ s:trim-left{n/a}sall
462s:trim-rights-s--Trim trailing whitespace from a string.class:word '__hello__ s:trim-right{n/a}sall
463script: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}sysrre
464script:arguments-n--Return the number of arguments passed to the program.class:word{n/a}{n/a}sysrre
465script: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}sysrre
466script: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}scriptrre
467script:get-argumentn-s--Given an argument number, return the argument as a string.class:word{n/a}{n/a}scriptrre
468script: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}scriptrre
469script: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}scriptrre
470script:name-s--Return the filename of the program being run.class:word{n/a}{n/a}scriptrre
471set-hookaa---Patch the hook point in a2 to point to a1.class:word :foo hook ;\n :bar #1 ;\n &bar &foo set-hook{n/a}globalall
472shiftmn-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}globalall
473sigil:!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}sigilall
474sigil:#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}sigilall
475sigil:$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}sigilall
476sigil:&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}sigilall
477sigil:'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}sigilall
478sigil:(s---Process token as a comment.Discard the string.Discard the string.class:macro{n/a}{n/a}sigilall
479sigil:.s---FInterpret 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}sigilrre
480sigil::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}sigilall
481sigil:@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}sigilall
482sigil:\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}sigilall
483sigil:^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}sigilall
484sigil:`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}sigilall
485sigil:|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}sigilall
486sipnq(?n-?)-n--Run quote. After execution completes, put a copy of n back on top of the stack.class:word{n/a}{n/a}globalall
487socket:acceptn-nn--Begin accepting connections. Returns a new socket and an error code.class:word{n/a}{n/a}socketrre
488socket:bindsn-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}socketrre
489socket:closen---Close a socket.class:word{n/a}{n/a}socketrre
490socket:configuress---Configure internal settings for a host (s1) and port (s2). Use before `socket:bind`.class:word{n/a}{n/a}socketrre
491socket:connectn-nn--Connect to a server. Provide a socket, this will return a status flag and an error code.class:word{n/a}{n/a}socketrre
492socket:create-n--Obtain a new socket.class:word{n/a}{n/a}socketrre
493socket:gethostbynameas---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}socketrre
494socket:listennn-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}socketrre
495socket:operation...n---Trigger a socket operation. This is not intended to be used directly.class:word{n/a}{n/a}socketrre
496socket:recvann-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}socketrre
497socket:sendsn-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}socketrre
498sp---Display a space (`ASCII:SPACE`)class:word :spaces (n-) [ sp ] times ;\n #12 spaces{n/a}globalall
499storena---Store a value into the specified address.class:primitive 'Base var\n #10 &Base store{n/a}globalall
500store-nextna-a--Store a value into the specified address and return the next address.class:word{n/a}{n/a}globalall
501swapnm-mn--Exchange the position of the top two items on the stackclass:primitive{n/a}{n/a}globalall
502tab---Display a tab (`ASCII:HT`)class:word{n/a}{n/a}globalall
503tail-recurse---Convert a call before the semicolon to a jump.class:word{n/a}{n/a}globalall
504timesnq---Run the specified quote the specified number of times.class:word #12 [ $- c:put ] times{n/a}globalall
505trixqqq-?--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}globalall
506tri*xyzqqq-?--Apply q1 against x, q2 against y, and q3 against z.class:word{n/a}{n/a}globalall
507tri@xyzq-?--Apply q against x, then against y, and finally against z.class:word{n/a}{n/a}globalall
508tucknm-mnm--Put a copy of the top item on the stack under the second one.class:word{n/a}{n/a}globalall
509ui:add-views---Add view named `s` to the displayed views.class:word{n/a}{n/a}uiretro/python
510ui:create-viewss---Create a new view. `s1` is the name and `s2` is the type.class:word{n/a}{n/a}uiretro/python
511ui:get-actions-a--Return the address of the Retro handler for a view's associated action.class:word{n/a}{n/a}uiretro/python
512ui:get-positions-nn--Return the row and column of the named view.class:word{n/a}{n/a}uiretro/python
513ui:get-sizes-nn--Return the height and width of the named view.class:word{n/a}{n/a}uiretro/python
514ui:get-texts-s--Get the value of the text property of the named view.class:word{n/a}{n/a}uiretro/python
515ui:get-titles-s--Get the value of the title property for the named view.class:word{n/a}{n/a}uiretro/python
516ui:operation...n---Carry out a UI operation. Used internally by the other `ui:` words.class:word{n/a}{n/a}uiretro/python
517ui:present---Display all views.class:word{n/a}{n/a}uiretro/python
518ui:remove-views---Remove view named `s` from the displayed views.class:word{n/a}{n/a}uiretro/python
519ui:set-actionas---Set the action handler for a view to the specified Retro word address.class:word{n/a}{n/a}uiretro/python
520ui:set-positionnns---Move view `s` to row `n1` and column `n2`.class:word{n/a}{n/a}uiretro/python
521ui:set-sizenns---Set view `s` to height `n1` and width `n2`.class:word{n/a}{n/a}uiretro/python
522ui:set-textss---Set the text property of view `s2` to `s1`.class:word{n/a}{n/a}uiretro/python
523ui:set-titless---Set the title property of view `s2` to `s1`.class:word{n/a}{n/a}uiretro/python
524unhooka---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}globalall
525unix:chdirs---Change the current working directory to the specified one.class:word '/etc unix:chdir{n/a}unixrre
526unix:count-files-in-cwd-n--Return the number of files (and subdirectories) in the current working directoryclass:word{n/a}{n/a}unixrre
527unix:exec0s---Execute a process by running the application specified by s.class:word{n/a}{n/a}unixrre
528unix:exec1ss---Execute a process by running the application specified by s1. Pass s2 as an argument.class:word{n/a}{n/a}unixrre
529unix:exec2sss---Execute a process by running the application specified by s1. Pass s2 and s3 as arguments.class:word{n/a}{n/a}unixrre
530unix:exec3ssss---Execute a process by running the application specified by s1. Pass s2, s3, and s4 as arguments.class:word{n/a}{n/a}unixrre
531unix:executes---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}unixrre
532unix:exitn---Exit the current process, returning the specified return code.class:word{n/a}{n/a}unixrre
533unix:for-each-fileq---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}unixrre
534unix:fork-n--Fork the current process. Returns a PID.class:word{n/a}{n/a}unixrre
535unix:get-cwd-s--Return the current working directoryclass:word{n/a}{n/a}unixrre
536unix:getenvsa---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}unixrre
537unix:getpid-n--Return the PID of the current process.class:word{n/a}{n/a}unixrre
538unix:killnn---Terminates a process. Takes a process and a signal to send.class:word{n/a}{n/a}unixrre
539unix:pclosen---Close a pipe.class:word{n/a}{n/a}unixrre
540unix:pipes---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}unixrre
541unix:popensn-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}unixrre
542unix:putenvs---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}unixrre
543unix:sleepn---Sleep for the specified number of seconds.class:word{n/a}{n/a}unixrre
544unix:slurp-pipeas-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}unixrre
545unix:systems---Runs another application using the system shell and returns after execution is completed.class:word 'ls_-lh_/etc unix:system{n/a}unixrre
546unix:wait-n--Waits for a child process to complete. This maps to the wait() system call.class:word{n/a}{n/a}unixrre
547unpackn-nnnn--Unpack a 32-bit value into four 8-bit values.class:word{n/a}{n/a}globalall
548unsigned:*nn-n--Multiply `n1` by `n2` and return the result.class:word #2 #6 unsigned:*\n #-1 #100 unsigned:*{n/a}unsignedall
549unsigned:*/modxyz-rv--Multiply `x` by `y` and then divide by `z` and return the integer part of the quotient and remainder.class:word{n/a}{n/a}globalrre
550unsigned:+nn-n--Add `n1` to `n2` and return the result.class:word #1 #2 unsigned:+ {n/a}unsignedall
551unsigned:-nn-n--Subtract `n2` from `n1` and return the result.class:word #2 #1 unsigned:- {n/a}unsignedall
552unsigned:-eq?nn-f--Compare two values for inequality. Returns `TRUE` if they are not equal or `FALSE` otherwise.class:word #1 #2 unsigned:-eq?\n $a $b unsigned:-eq?{n/a}unsignedall
553unsigned:/modnm-rv--Divide `n` by `m` and return the integer part of the quotient and remainder.class:word{n/a}{n/a}unsignedall
554unsigned:eq?nn-f--Compare two values for equality. Returns `TRUE` if they are equal or `FALSE` otherwise.class:word #1 #2 unsigned:eq?\n $a $b unsigned:eq?{n/a}unsignedall
555unsigned:gt?nn-f--Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise.class:word{n/a}{n/a}unsignedall
556unsigned:lt?nn-f--Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise.class:word{n/a}{n/a}unsignedall
557unsigned:shiftmn-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:word{n/a}{n/a}unsignedall
558untilq(-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}globalall
559v:deca---Decrement the value stored at the specified address by 1.class:word{n/a}{n/a}vall
560v:dec-byna---Decrement the value stored at the specified address by the specified value.class:word{n/a}{n/a}vall
561v:inca---Increment the value stored at the specified address by 1.class:word{n/a}{n/a}vall
562v:inc-byna---Increment the value stored at the specified address by the specified value.class:word{n/a}{n/a}vall
563v:limitalu---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}vall
564v:offa---Set a variable to 0.class:word{n/a}{n/a}vall
565v:ona---Set a variable to -1.class:word{n/a}{n/a}vall
566v:preserveaq---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}vall
567v:updateaq---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}vall
568vars---Create a variable. The variable is initialized to 0.class:word 'Base var{n/a}globalall
569var-nns---Create a variable with the specified initial value.class:word #10 'Base var-n\n{n/a}globalall
570var-sss---Create a variable with the specified initial value.class:word 'Test 'Word var-s\n{n/a}globalall
571w:fetcha-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}globalall
572w:fetch-nexta-an--Fetch the value stored at the specified address. Returns the next address and the value.class:word{n/a}{n/a}wall
573w:storena---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}globalall
574w:store-nextna-a--Store a value into the specified address and return the next address.class:word{n/a}{n/a}wall
575whileq(-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}globalall
576xormn-o--Perform a bitwise XOR operation.class:primitive{n/a}{n/a}globalall
577{---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}globalall
578{{---Begin a lexically scoped area.class:word{n/a}{n/a}globalall
579}-a--Complete an array begun by `{`. Returns a pointer to the data.class:word{n/a}{n/a}globalall
580}}---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}globalall