retroforth/doc/words.tsv
crc 11fa881179 add stubs for sys:current-file and sys:current-line
FossilOrigin-Name: d2b032dae32b987c44b7df66c658b29df8b4f8cf6410beb657cb1b9fe8e8b399
2020-09-10 19:59:33 +00:00

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