retroforth/doc/words.tsv
crc 4be717f578 core: add "bye"
FossilOrigin-Name: ea15f1bf0112b8756fb59e2dacd44559c972e50d6b460271365e15711689ae82
2021-06-21 16:10:34 +00:00

65 KiB

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