retroforth/words.tsv
crc d8f8118ec8 selective inlining of some stack shufflers for improved code density and performance
FossilOrigin-Name: 08b17ea4033026c0c9e2ce82950e9ed6b93e918f876caecbf85c19dc9a10b86b
2018-11-13 03:12:42 +00:00

48 KiB

1*nn-n--Multiply `n1` by `n2` and return the result.class:primitive #2 #6 *\n #-1 #100 *{n/a}globalall
2+nn-n--Add `n1` to `n2` and return the result.class:primitive #1 #2 + {n/a}globalall
3,n---Store the specified value into the memory at `here` and increment `Heap` by 1.class:word $a , $b , $c , #0 ,{n/a}globalall
4-nn-n--Subtract `n1` from `n2` and return the difference.class:primitive #2 #1 -\n #-10 #3 -{n/a}globalall
5---reveal------Switch to the exposed (public) portion of a lexical namespace.class:word{n/a}{n/a}globalall
6-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
7-iffq---Execute the quotation if the flag is `FALSE`.class:word{n/a}{n/a}globalall
8/mn-o--Divide `m` by `n` and return the result.class:word{n/a}{n/a}globalall
9/modnm-op--Divide `n` by `m` and return the result and remainder.class:primitive{n/a}{n/a}globalall
100;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
11;---End the current definition.class:macro{n/a}{n/a}globalall
12?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
13ASCII:ACK-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
14ASCII:BEL-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
15ASCII:BS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
16ASCII:CAN-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
17ASCII:CR-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
18ASCII:DC1-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
19ASCII:DC2-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
20ASCII:DC3-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
21ASCII:DC4-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
22ASCII:DEL-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
23ASCII:DLE-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
24ASCII:EM-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
25ASCII:ENQ-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
26ASCII:EOT-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
27ASCII:ESC-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
28ASCII:ETB-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
29ASCII:ETX-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
30ASCII:FF-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
31ASCII:FS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
32ASCII:GS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
33ASCII:HT-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
34ASCII:LF-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
35ASCII:NAK-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
36ASCII:NUL-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
37ASCII:RS-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
38ASCII:SI-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
39ASCII:SO-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
40ASCII:SOH-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
41ASCII:SPACE-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
42ASCII:STX-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
43ASCII:SUB-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
44ASCII:SYN-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
45ASCII:US-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
46ASCII:VT-n--Constant. Refers to specific ASCII code.class:data{n/a}{n/a}ASCIIall
47Compiler-a--Variable. Holds the compiler state. If TRUE, the compiler is active. If FALSE, it is not.class:data{n/a}{n/a}globalall
48Dictionary-a--Variable. Holds a pointer to the most recent dictionary header.class:data{n/a}{n/a}globalall
49EOM-n--Constant. Returns the last addressable memory address.class:word{n/a}{n/a}globalall
50FALSE-n--Returns `0`, the value used to indicate a FALSE result.class:word{n/a}{n/a}globalall
51FREE-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
52Heap-a--Variable. Holds the address of the next available cell.class:data{n/a}{n/a}globalall
53I-n--Access the loop index for the current loop. (For loops made using `times<with-index>`)class:word{n/a}{n/a}globalall
54J-n--Access the parent loop index for the current loop. (For loops made using `times<with-index>`)class:word{n/a}{n/a}globalall
55K-n--Access the grandparent loop index for the current loop. (For loops made using `times<with-index>`)class:word{n/a}{n/a}globalall
56RewriteUnderscores-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
57STRINGS-a--Return the address of the start of the temporary string pool.class:word{n/a}{n/a}globalall
58ScopeList-a--Variable. This holds some information used by `{{` and `}}`.class:data{n/a}{n/a}globalall
59TRUE-n--Returns `-1`, the value used to indicate a TRUE result.class:word{n/a}{n/a}globalall
60TempStringMax-a--Variable. Holds the maximum length of a temporary string.class:data{n/a}{n/a}globalall
61TempStrings-a--Variable. Holds the number of temporary strings.class:data{n/a}{n/a}globalall
62Version-a--Variable. This stores the version number.class:data{n/a}{n/a}globalall
63[---Begin a quotation.class:macro{n/a}{n/a}globalall
64]---End a quotation.class:macro{n/a}{n/a}globalall
65again---Close an unconditional loop. Branches back to the prior `repeat`.class:macro{n/a}{n/a}globalall
66allotn---Allocate the specified number of cells from the `Heap`.class:word 'Buffer d:create #100 allot{n/a}globalall
67andnm-o--Perform a bitwise AND operation between the two provided values.class:primitive{n/a}{n/a}globalall
68as{-f--Begin an assembly section.class:macro{n/a}{n/a}globalall
69banner---Display a welcome message on startup.class:word{n/a}{n/a}globalrre{n/a}
70bixqq-?--Execute q1 against x, then execute q2 against a copy of x.class:word #100 [ #10 * ] [ #10 - ] bi{n/a}globalall
71bi*xyqq-?--Execute q1 against x and q2 against y.class:word #10 #20 [ #2 * ] [ #10 / ] bi*{n/a}globalall
72bi@xyq-?--Execute q against x, then execute q against y.class:word #10 #20 [ #3 * ] bi@{n/a}globalall
73buffer:addn---Append a value to the current buffer.class:word{n/a}{n/a}bufferall
74buffer:empty---Reset the current buffer to an empty state.class:word{n/a}{n/a}bufferall
75buffer:end-a--Return a pointer to the current end of the active buffer.class:word{n/a}{n/a}bufferall
76buffer:get-n--Remove the last value from the current buffer.class:word{n/a}{n/a}bufferall
77buffer:preserveq---Save and restore the current buffer before and after executing the specified quote.class:word{n/a}{n/a}bufferall
78buffer:seta---Assign a new buffer as the current one.class:word{n/a}{n/a}bufferall
79buffer:size-n--Return the number of cells in the buffer.class:word{n/a}{n/a}bufferall
80buffer:start-a--Return the start address of the current buffer.class:word{n/a}{n/a}bufferall
81bye---Exit RETRO.class:word{n/a}{n/a}globalrre
82c:-consonant?c-f--Return TRUE if character is a not consonant or FALSE otherwise.class:word{n/a}{n/a}call
83c:-digit?c-f--Return TRUE if character is a not numeric digit or FALSE otherwise.class:word{n/a}{n/a}call
84c:-lowercase?c-f--Return TRUE if character is not lowercase or FALSE otherwise.class:word{n/a}{n/a}call
85c:-uppercase?c-f--Return TRUE if character is not uppercase or FALSE otherwise.class:word{n/a}{n/a}call
86c:-visible?c-f--Return TRUE if character is not printable or FALSE otherwise.class:word{n/a}{n/a}call
87c:-vowel?c-f--Return TRUE if character is not a vowel or FALSE otherwise.class:word{n/a}{n/a}call
88c:-whitespace?c-f--Return TRUE if character is not whitespace, or FALSE otherwise.class:word{n/a}{n/a}call
89c:consonant?c-f--Return TRUE if character is a consonant or FALSE otherwise.class:word{n/a}{n/a}call
90c:digit?c-f--Return TRUE if character is a numeric digit or FALSE otherwise.class:word{n/a}{n/a}call
91c:get-c--Read a single keypress.class:word{n/a}{n/a}globalrre
92c:letter?c-f--Return TRUE if character is an ASCII letter or FALSE otherwise.class:word{n/a}{n/a}call
93c:lowercase?c-f--Return TRUE if character is lowercase or FALSE otherwise.class:word{n/a}{n/a}call
94c:putc---Display a single character.class:word{n/a}{n/a}globalall
95c:to-lowerc-c--Convert character to lowercase equivalent.class:word{n/a}{n/a}call
96c:to-numberc-n--Convert an ASCII digit character into the corresponding decimal valueclass:word{n/a}{n/a}globalall
97c:to-stringc-s--Convert character into a string.class:word{n/a}{n/a}call
98c:to-upperc-c--Convert character to uppercase equivalent.class:word{n/a}{n/a}call
99c:toggle-casec-c--Convert an ASCII character to the opposite case.class:word{n/a}{n/a}call
100c:uppercase?c-f--Return TRUE if character is uppercase or FALSE otherwise.class:word{n/a}{n/a}call
101c:visible?c-f--Return TRUE if character is printable or FALSE otherwise.class:word{n/a}{n/a}call
102c:vowel?c-f--Return TRUE if character is a vowel or FALSE otherwise.class:word{n/a}{n/a}call
103c:whitespace?c-f--Return TRUE if character is whitespace, or FALSE otherwise.class:word{n/a}{n/a}call
104calla---Call a function.class:primitive{n/a}{n/a}globalall
105casenmq- || 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
106choosefqq---Execute q1 if the flag is true (-1) or q2 if the flag is false (0). Only these flags are valid when using `choose`.class:word{n/a}{n/a}globalall
107class: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
108class: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
109class: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
110class: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
111clock:day-n--Return the current day.class:word{n/a}{n/a}clockiOS
112clock:hour-n--Return the current hour.class:word{n/a}{n/a}clockiOS
113clock:minute-n--Return the current minute.class:word{n/a}{n/a}clockiOS
114clock:month-n--Return the current month.class:word{n/a}{n/a}clockiOS
115clock:second-n--Return the current second.class:word{n/a}{n/a}clockiOS
116clock:year-n--Return the current year.class:word{n/a}{n/a}clockiOS
117compile:calla---Compile a call to the specified address into the current definition.class:word{n/a}{n/a}compileall
118compile:jumpa---Compile a jump to the specified address into the current definition.class:word{n/a}{n/a}compileall
119compile:litn---Compile the code to push a number to the stack into the current definition.class:word{n/a}{n/a}compileall
120compile:ret---Compile a return instruction into the current definition.class:word{n/a}{n/a}compileall
121compiling?-f--Return `TRUE` if compiler is on or `FALSE` otherwise.class:word{n/a}{n/a}globalall
122config:set-editor-fonts---Set the font to use in the editor. If the font fails to load, RETRO will fall back to a safe default.class:word{n/a}{n/a}configiOS
123config:set-editor-sizen---Set the size of the font to use in the editor.class:word{n/a}{n/a}configiOS
124config:set-output-fonts---Set the font to use in output area. If the font fails to load, RETRO will fall back to a safe default.class:word{n/a}{n/a}configiOS
125config:set-output-sizen---Set the size of the font to use in the output area.class:word{n/a}{n/a}configiOS
126config:set-toolbar-fonts---Set the font to use in the toolbar. If the font fails to load, RETRO will fall back to a safe default.class:word{n/a}{n/a}configiOS
127config:set-toolbar-sizen---Set the size of the font to use in the toolbar.class:word{n/a}{n/a}configiOS
128constns---Create a constant returning the specified value.class:word{n/a}{n/a}globalall
129copysdl---Copy `l` cells from memory at `s` to the memory at `d`. These should not overlap.class:word{n/a}{n/a}globalall
130currynq-q--Bind a value to a function and return a new quote that calls the bound action.class:word{n/a}{n/a}globalall
131dn---Inline a numeric value to the current assembly segment.class:word{n/a}{n/a}globalall
132d: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
133d:classd-a--Given a dictionary header, return the class field.class:word{n/a}{n/a}dall
134d: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
135d: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
136d:last-d--Return the most recent dictionary header.class:word{n/a}{n/a}dall
137d:last<class>-a--Return a pointer to the class field of the most recent dictionary header.class:word{n/a}{n/a}dall
138d:last<name>-s--Return a pointer to the name field of the most recent dictionary header.class:word{n/a}{n/a}dall
139d:last<xt>-a--Return a pointer to the xt field of the most recent dictionary header.class:word{n/a}{n/a}dall
140d:linkd-a--Given a dictionary header, return the link field.class:word{n/a}{n/a}dall
141d: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
142d: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
143d:named-s--Given a dictionary header, return the name field.class:word{n/a}{n/a}dall
144d:words---Display a list of all named items in the `Dictionary`.class:word{n/a}{n/a}globalall
145d:words-withs---Display a list of all named items in the `Dictionary` that contain the provided substring.class:word{n/a}{n/a}globalall
146d:xtd-a--Given a dictionary header, return the xt field.class:word{n/a}{n/a}dall
147data---Change the class of the most recently defined word to `class:data`.class:word{n/a}{n/a}globalall
148depth-n--Return the number of items on the stack.class:word{n/a}{n/a}globalall
149dipnq-n--Temporarily remove n from the stack, execute the quotation, and then restore n to the stack.class:word{n/a}{n/a}globalall
150doesq---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
151dropn---Discard the top value on the stack.class:primitive{n/a}{n/a}globalall
152drop-pairnn---Remove top two items on the stack.class:word{n/a}{n/a}globalall
153dump-stack---Display the items on the data stack.class:word{n/a}{n/a}globalall
154dupn-nn--Duplicate the top item on the stack.class:primitive{n/a}{n/a}globalall
155dup-pairnm-nmnm--Duplicate the top two items on the stack.class:word{n/a}{n/a}globalall
156eq?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
157err:notfound---Error handler. Called when a word is not found by `interpret`.class:word{n/a}{n/a}errall
158f:*--FF-FMultiply two floating point numbers, returning the result.class:word .3.1415 .22 f:*{n/a}frre
159f:+--FF-FAdd two floating point numbers, returning the result.class:word .3.1 .22 f:+{n/a}frre
160f:---FF-FSubtract F2 from F1 returing the result.class:word .22.3 .0.12 f:-{n/a}frre
161f:-INF---nReturn a value corresponding to negative infinityclass:word{n/a}{n/a}frre
162f:-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
163f:-inf?-f-F-Return `TRUE` if floating point value is -INF or `FALSE` otherwise.class:word{n/a}{n/a}frre
164f:/--FF-FDivide floating point value F1 by F2.class:word{n/a}{n/a}frre
165f:E---FReturn the floating point value for Euler's number.class:word{n/a}{n/a}frre
166f:INF---nReturn a value corresponding to positive infinityclass:word{n/a}{n/a}frre
167f:NAN---nReturn a value corresponding to NaNclass:word{n/a}{n/a}frre
168f:PI---FReturn the floating point value for PI.class:word{n/a}{n/a}frre
169f:abs--F-FReturn the absolute value for a floating point value.class:word{n/a}{n/a}frre
170f:acos--f-fReturn the arc cosine of a floating point number.class:word{n/a}{n/a}frre
171f:asin--f-fReturn the arc sine of a floating point number.class:word{n/a}{n/a}frre
172f:atan--f-fReturn the arc tangent of a floating point number.class:word{n/a}{n/a}frre
173f:ceiling--F-FReturn the smallest integral value greater than or equal to the specified value.class:word{n/a}{n/a}frre
174f:cos--f-fReturn the cosine of a floating point number.class:word{n/a}{n/a}frre
175f:depth-n--Return the number of items on the floating point stack.class:word{n/a}{n/a}frre
176f:drop--F-Discard the top item on the floating point stack.class:word{n/a}{n/a}frre
177f:dup--F-FFDuplicate the top item on the floating point stack.class:word{n/a}{n/a}frre
178f: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
179f:floor--F-FPerform a mathmatical floor operation on the floating point value.class:word{n/a}{n/a}frre
180f:gt?-f-FF-Compare two floating point values for greater than.class:word{n/a}{n/a}frre
181f:inf?-f-F-Return `TRUE` if floating point value is INF or `FALSE` otherwise.class:word{n/a}{n/a}frre
182f:log--FF-FReturn log(F1) for base F2 for floating point values.class:word{n/a}{n/a}frre
183f:lt?-f-FF-Compare two floating point values for less than.class:word{n/a}{n/a}frre
184f:nan?-f-F-Return `TRUE` if floating point value is NaN or `FALSE` otherwise.class:word{n/a}{n/a}frre
185f:negate--F-FInvert the sign of the floating point value.class:word .3.1415 f:negate{n/a}frre
186f:negative?-f-F-Return `TRUE` if floating point value is negative or `FALSE` if not.class:word{n/a}{n/a}frre
187f:over--FG-FGFPut a copy of the second floating point value over the top one.class:word{n/a}{n/a}frre
188f:positive?-f-F-Return `TRUE` if floating point value is positive or `FALSE` otherwise.class:word{n/a}{n/a}frre
189f:power--FF-FReturn F1^F2 for floating point values.class:word{n/a}{n/a}frre
190f:put--F-Display a floating point number.class:word{n/a}{n/a}globalrre
191f:round--f-fRound a floating point value.class:word{n/a}{n/a}frre
192f:sin--F-FReturn the sine of a floating point number.class:word{n/a}{n/a}frre
193f:sqrt--F-FReturn the square root of a floating point number.class:word{n/a}{n/a}frre
194f:square--f-fReturn the square of a floating point number.class:word{n/a}{n/a}frre
195f:swap--FG-GFExchange the top and second items on the floating point stack.class:word{n/a}{n/a}frre
196f:tan--F-FReturn the tangent of a floating point number.class:word{n/a}{n/a}frre
197f:to-number-n-F-Convert a floating point value into a number.class:word{n/a}{n/a}frre
198f:to-string-s-F-Convert a floating point value into a string.class:word{n/a}{n/a}frre
199f:tuck--FG-GFGTuck a copy of the top floating point value under the second one.class:word{n/a}{n/a}frre
200fetcha-n--Fetch the value stored at the specified address.class:primitive &Version fetch{n/a}globalall
201fetch-nexta-an--Fetch the value stored at the specified address. Returns the next address and the value.class:word{n/a}{n/a}globalall
202file:A-n--Constant for opening a file in APPEND mode.class:data{n/a}{n/a}filerre
203file:R-n--Constant for opening a file in READ mode.class:data{n/a}{n/a}filerre
204file:R+-n--Constant for opening a file in READ & WRITE mode.class:data{n/a}{n/a}filerre
205file:W-n--Constant for opening a file in WRITE mode.class:data{n/a}{n/a}filerre
206file:closeh---Given a file handle, close the file.class:word{n/a}{n/a}filerre
207file:deletes---Delete the named file.class:word{n/a}{n/a}filerre
208file: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
209file:flushh---Given a file handle, flush any pending writes to disk.class:word{n/a}{n/a}filerre
210file: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
211file: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
212file:open<for-append>s-nn--Open a file for reading & writing. Returns the size (NOS) and a file ID (TOS)class:word{n/a}{n/a}filerre
213file:open<for-reading>s-nn--Open a file for reading. Returns the size (NOS) and a file ID (TOS)class:word{n/a}{n/a}filerre
214file:open<for-writing>s-nn--Open a file for reading. Returns the file IDclass:word{n/a}{n/a}filerre
215file:readh-c--Given a file handle, read and return the next character in it.class:word{n/a}{n/a}filerre
216file:read-linef-s--Given a file handle, read a line and return a pointer to it.class:word{n/a}{n/a}filerre
217file:seeknh---Move the current offset into a file to the specified one.class:word{n/a}{n/a}filerre
218file:sizeh-n--Given a file handle, return the size of the file (in bytes).class:word{n/a}{n/a}filerre
219file: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
220file: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
221file:tellh-n--Given a file handle, return the current offset in the file.class:word{n/a}{n/a}filerre
222file:writech---Write a character to the file represented by the handle.class:word{n/a}{n/a}filerre
223gopher: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}gopherrre
224gt?nn-f--Compare n1 and n2. Return `TRUE` if n1 is greater than n2, or `FALSE` otherwise.class:primitive{n/a}{n/a}globalall
225gteq?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
226here-a--Return the next free address in memory.class:word{n/a}{n/a}globalall
227is---Assemble the instructions specified by the string into the current assembly scope.class:word{n/a}{n/a}globalall
228iffq---Execute the quote if the flag is `TRUE`.class:word{n/a}{n/a}globalall
229immediate---Change the class of the most recently defined word to `class:macro`.class:word{n/a}{n/a}globalall
230includes---Run the code in the specified file. class:word{n/a}{n/a}globalrre
231interprets---Interpret a single input token.class:word '#100 interpret\n 'words interpret{n/a}globalall
232ios:list-fonts---Display a list of all installed fonts.class:word{n/a}{n/a}iosiOS
233lt?nn-f--Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise.class:primitive{n/a}{n/a}globalall
234lteq?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
235modnm-o--Divide `n` by `m` and return the remainder.class:word{n/a}{n/a}globalall
236n:-zero?n-f--Return `TRUE` if number is not zero, or `FALSE` otherwise.class:word{n/a}{n/a}nall
237n:MAX-n--Return the maximum value that will fit in a cell.class:word{n/a}{n/a}nall
238n:MIN-n--Return the minimum value that will fit in a cell.class:word{n/a}{n/a}nall
239n:absn-n--Return the absolute value of a number.class:word #10 n:abs\n #-10 n:abs\n{n/a}nall
240n: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
241n:decn-m--Decrement n by one.class:word #100 n:dec{n/a}nall
242n: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
243n:incn-m--Increment n by one.class:word #100 n:inc{n/a}nall
244n: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
245n:maxmn-o--Return the greater of two values.class:word #1 #7 n:max\n #-8 #-10 n:max{n/a}nall
246n:minmn-o--Return the lesser of two values.class:word #1 #7 n:min\n #-8 #-10 n:min{n/a}nall
247n:negaten-n--Invert the sign of a number.class:word #10 n:negate\n #-10 n:negate{n/a}nall
248n:negative?n-f--Return `TRUE` if number is negative, or `FALSE` if not.class:word{n/a}{n/a}nall
249n:odd?n-f--Return `TRUE` if number is odd, or `FALSE` if not.class:word{n/a}{n/a}nall
250n:positive?n-f--Return `TRUE` if number is positive, or `FALSE` if not.class:word{n/a}{n/a}nall
251n:powbp-n--Return base (b) to power (p).class:word{n/a}{n/a}nall
252n:putn---Display a number.class:word{n/a}{n/a}globalall
253n:sqrtn-m--Return the square root of a number.class:word{n/a}{n/a}nall
254n:squaren-m--Return the square of a number.class:word{n/a}{n/a}nall
255n: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
256n:to-floatn---FConvert a number into a floating point value.class:word{n/a}{n/a}nrre
257n:to-stringn-s--Convert a number into a string.class:word{n/a}{n/a}nall
258n:zero?n-f--Return `TRUE` if number is zero, or `FALSE` otherwise.class:word{n/a}{n/a}nall
259nipnm-m--Remove the second item from the stack.class:word{n/a}{n/a}globalall
260nl---Display a newline.class:word{n/a}{n/a}globalall
261notn-m--Perform a logical NOT operation.class:word{n/a}{n/a}globalall
262ormn-o--Perform a bitwise OR between the provided values.class:primitive{n/a}{n/a}globalall
263overnm-nmn--Put a copy of n over m.class:word{n/a}{n/a}globalall
264parse-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
265pb:geta---Copy a string from the pasteboard to the specified address.class:word{n/a}{n/a}pbiOS{n/a}
266pb:length-n--Return the length of the string on the pasteboard.class:word{n/a}pb{n/a}iOS{n/a}
267pb:sets---Copy a string to the pasteboard.class:word{n/a}{n/a}pbiOS{n/a}
268pop-nn--Move a value from the return stack to the data stack.class:macro{n/a}{n/a}globalall
269prefix:!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
270prefix:#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
271prefix:$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
272prefix:&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
273prefix:'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
274prefix:(s---Process token as a comment.Discard the string.Discard the string.class:macro{n/a}{n/a}prefixall
275prefix:.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
276prefix::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
277prefix:@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
278prefix:`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
279prefix:|s---POSTPONE equivilent.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
280primitive---Change the class of the most recently defined word to `class:primitive`.class:word{n/a}{n/a}globalall
281pushn--n-Move a value from the data stack to the return stack.class:macro{n/a}{n/a}globalall
282rs---Lookup a reference by name and inline its pointer to the current assembly segment.class:word{n/a}{n/a}globalall
283reclassa---Change the class handler of the most recently defined word to the specified one.class:word{n/a}{n/a}globalall
284reorder...ss-?--Restructure the order of items on the stack.class:word{n/a}{n/a}globalall
285repeat---Begin an unconditional loop.class:macro{n/a}{n/a}globalall
286reset...---Remove all items from the stack.class:word{n/a}{n/a}globalall
287rotabc-bca--Rotate the top three values.class:word{n/a}{n/a}globalall
288s,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
289s:ASCII-LETTERS-s--Constant. Returns a string of the ASCII letters (upper and lower case)class:data{n/a}{n/a}sall
290s:ASCII-LOWERCASE-s--Constant. Returns a string of the ASCII letters in lowercaseclass:data{n/a}{n/a}sall
291s:ASCII-UPPERCASE-s--Constant. Returns a string of the ASCII letters in uppercaseclass:data{n/a}{n/a}sall
292s:DIGITS-s--Constant. Return a string of characters recognized as numeric digits.class:data{n/a}{n/a}sall
293s:PUNCTUATION-s--Constant. Return a string of characters recognized as punctuation.class:data{n/a}{n/a}sall
294s:WHITESPACE-s--Constant. Returns a string of characters recognized as whitespace.class:data{n/a}{n/a}sall
295s:appendss-s--Return a new string consisting of s1 followed by s2.class:word{n/a}{n/a}sall
296s: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
297s:chops-s--Remove the last character from a string.class:word{n/a}{n/a}sall
298s: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
299s:contains-char?sc-f--Return `TRUE` if the character is present in the string or `FALSE` otherwise.class:word{n/a}{n/a}sall
300s: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
301s:copysa---Copy a string (s) to a destination (a). This will include the terminator character when copying.class:word{n/a}{n/a}sall
302s:empty-s--Return an empty string.class:word{n/a}{n/a}sall
303s: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
304s:evaluates-?--Evaluate string as if it was typed into the interpreter.class:word{n/a}{n/a}sall
305s: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
306s:for-eachsq---Execute the quote once for each value in the string.class:word{n/a}{n/a}sall
307s:format...s-s--Construct a new string using the template passed and items from the stack.class:word{n/a}{n/a}sall
308s: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
309s:hashs-n--Calculate a hash value for a string. This uses the djb2 algorithm.class:word{n/a}{n/a}sall
310s:index-ofsc-n--Return the location of the first instance of the specified character in the string.class:word{n/a}{n/a}sall
311s: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
312s:keeps-s--Store a string into the heap and return a pointer to the start of it.class:word{n/a}{n/a}sall
313s:leftsn-s--Return a new string containing the first `n` characters from the source string.class:word{n/a}{n/a}sall
314s:lengths-n--Return the number of characters in a string, excluding the NULL terminator.class:word{n/a}{n/a}sall
315s: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
316s:prependss-s--Return a new string consisting of s2 followed by s1.class:word{n/a}{n/a}sall
317s:puts---Display a string.class:word{n/a}{n/a}globalall
318s:replacesss-s--Replace the first instance of s2 in s1 with s3.class:word{n/a}{n/a}sall
319s:reverses-s--Reverse the order of ASCII characters in a string.class:word{n/a}{n/a}sall
320s: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
321s:skip---Internal helper function used to skip over a string in a definition.class:word{n/a}{n/a}sall
322s:splitsc-ss--Split a string on the first occurrance of the specified character.class:word{n/a}{n/a}sall
323s: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
324s: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
325s:temps-s--Move a string into the temporary string buffers.class:word{n/a}{n/a}sall
326s:to-floats---FConvert a string representation into a floating point value.class:word{n/a}{n/a}srre
327s:to-lowers-s--Convert uppercase ASCII characters in a string to lowercase.class:word{n/a}{n/a}sall
328s:to-numbers-n--Convert a string to a number.class:word{n/a}{n/a}sall
329s:to-uppers-s--Convert lowercase ASCII characters in a string to uppercase.class:word{n/a}{n/a}sall
330s:tokenizesc-a--Takes a string and a character to use as a separator. It splits the string into a set of substrings and returns a set containing pointers to each of them.class:word{n/a}{n/a}{n/a}{n/a}
331s:tokenize-on-stringss-a--Takes a string (s1) and a substring (s2) use as a separator. It splits the string into a set of substrings and returns a set containing pointers to each of them.class:word{n/a}{n/a}{n/a}{n/a}
332s:trims-s--Trim leading and trailing whitespace from a string.class:word '__hello__ s:trim{n/a}sall
333s:trim-lefts-s--Trim leading whitespace from a string.class:word '__hello__ s:trim-left{n/a}sall
334s:trim-rights-s--Trim trailing whitespace from a string.class:word '__hello__ s:trim-right{n/a}sall
335set:contains-string?sa-f--Return `TRUE` if the string value is in the set or`FALSE` otherwise.class:word{n/a}{n/a}setall
336set:contains?na-f--Return `TRUE` if the value is in the set or `FALSE` otherwise.class:word{n/a}{n/a}setall
337set:dupa-b--Make a copy of a set. Return the address of the copy.class:word{n/a}{n/a}setall
338set:filteraq-b--For each item in the initial set, run the specified quote. If the quote returns `TRUE`, copy the item into a new set. If `FALSE`, discard it. Returns a pointer to the new set.class:word{n/a}{n/a}setall
339set:for-eachaq---Execute the quote once for each item in the set.class:word{n/a}{n/a}setall
340set:from-resultsq-a--Execute quote. Return a new set containing the values the quote leaves on the stack.class:word{n/a}{n/a}setall
341set:from-strings-a--Create a new set with the characters in the source string.class:word{n/a}{n/a}setall
342set:lengtha-n--Return the length of a set.class:word{n/a}{n/a}setall
343set:makeq-a--Execute quote. Return a new set containing the values the quote leaves on the stack. This is identical to doing `set:from-results set:reverse`class:word{n/a}{n/a}setall
344set:mapaq---Execute quote once for each item in the set. Constructs a new set from the value returned by the quote.class:word{n/a}{n/a}setall
345set:nthan-b--Return the actual address of the nth item in the set.class:word{n/a}{n/a}setall
346set:reducepnq-n--Takes a set, a starting value, and a quote. This will apply the quote to each item in the set; the quote should consume two values and return one.class:word{n/a}{n/a}setall
347set:reversea-b--Reverse the order of items in a set. This will return a new set.class:word{n/a}{n/a}setall
348shiftmn-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
349sipnq-n--Run quote. After execution completes, put a copy of n back on top of the stack.class:word{n/a}{n/a}globalall
350sp---Display a space (`ASCII:SPACE`)class:word :spaces (n-) [ sp ] times ;\n #12 spaces{n/a}globalall
351storena---Store a value into the specified address.class:primitive 'Base var\n #10 &Base store{n/a}globalall
352store-nextna-a--Store a value into the specified address and return the next address.class:word{n/a}{n/a}globalall
353swapnm-mn--Exchange the position of the top two items on the stackclass:primitive{n/a}{n/a}globalall
354sys:argc-n--Return the number of arguments passed to the program.class:word{n/a}{n/a}sysrre
355sys:argvn-s--Given an argument number, return the argument as a string.class:word{n/a}{n/a}sysrre
356tab---Display a tab (`ASCII:HT`)class:word{n/a}{n/a}globalall
357timesnq---Run the specified quote the specified number of times.class:word #12 [ $- c:put ] times{n/a}globalall
358times<with-index>nq---Run a quote the specified number of times, tracking the loop index in `I`.class:word{n/a}{n/a}globalall
359trixqqq-?--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
360tri*xyzqqq-?--Apply q1 against x, q2 against y, and q3 against z.class:word{n/a}{n/a}globalall
361tri@xyzq-?--Apply q against x, then against y, and finally against z.class:word{n/a}{n/a}globalall
362tucknm-mnm--Put a copy of the top item on the stack under the second one.class:word{n/a}{n/a}globalall
363unix:chdirs---Change the current working directory to the specified one.class:word '/etc unix:chdir{n/a}unixrre
364unix:exec0s---Execute a process by running the application specified by s.class:word{n/a}{n/a}unixrre
365unix:exec1ss---Execute a process by running the application specified by s1. Pass s2 as an argument.class:word{n/a}{n/a}unixrre
366unix:exec2sss---Execute a process by running the application specified by s1. Pass s2 and s3 as arguments.class:word{n/a}{n/a}unixrre
367unix: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
368unix:exitn---Exit the current process, returning the specified return code.class:word{n/a}{n/a}unixrre
369unix:fork-n--Fork the current process. Returns a PID.class:word{n/a}{n/a}unixrre
370unix: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
371unix:getpid-n--Return the PID of the current process.class:word{n/a}{n/a}unixrre
372unix:io:n:putn---Display a number (in base 10) to the standard output device. This is faster than `n:put`, but not portable.class:word{n/a}{n/a}unix:iorre
373unix:io:s:puts---Display a string to stdout. This is faster than `s:put`, but not portable.class:word{n/a}{n/a}unix:iorre
374unix:killnn---Terminates a process. Takes a process and a signal to send.class:word{n/a}{n/a}unixrre
375unix:pclosen---Close a pipe.class:word{n/a}{n/a}unixrre
376unix: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
377unix: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
378unix:sleepn---Sleep for the specified number of seconds.class:word{n/a}{n/a}unixrre
379unix:systems---Runs another application using the system shell and returns after execution is completed.class:word 'ls_-lh_/etc unix:system{n/a}unixrre
380unix:wait-n--Waits for a child process to complete. This maps to the wait() system call.class:word{n/a}{n/a}unixrre
381unix:writesh---Write a string to the specified file handle.class:word{n/a}{n/a}unixrre
382untilq---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
383v:deca---Decrement the value stored at the specified address by 1.class:word{n/a}{n/a}vall
384v:dec-byna---Decrement the value stored at the specified address by the specified value.class:word{n/a}{n/a}vall
385v:inca---Increment the value stored at the specified address by 1.class:word{n/a}{n/a}vall
386v:inc-byna---Increment the value stored at the specified address by the specified value.class:word{n/a}{n/a}vall
387v: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
388v:offa---Set a variable to 0.class:word{n/a}{n/a}vall
389v:ona---Set a variable to -1.class:word{n/a}{n/a}vall
390v: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
391v:update-usingaq---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
392vars---Create a variable. The variable is initialized to 0.class:word 'Base var{n/a}globalall
393var<n>ns---Create a variable with the specified initial value.class:word #10 'Base var<n>\n{n/a}globalall
394whileq---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
395xormn-o--Perform a bitwise XOR operation.class:primitive{n/a}{n/a}globalall
396{---Begin a set. This is intended to make creating sets a bit cleaner than using a quotation and `set:from-results`.class:word{n/a}{n/a}setall
397{{---Begin a lexically scoped area.class:word{n/a}{n/a}globalall
398}-a--Complete a set begun by `{`. Returns a pointer to the data.class:word{n/a}{n/a}setall
399}asf---End an assembly section.class:macro{n/a}{n/a}globalall
400}}---End a lexically scoped area.class:word{n/a}{n/a}globalall