Solo Forth 0.14.0-pre.209+20170427 G+DOS

The following table shows the main disk-management words implemented on each DOS.

The MGT disk image file format (used for G+DOS disks) does not include format-describing metadata: The MGT file is just a dump of the original 800-KiB disk. Beside, G+DOS does not need its own metadata (the directory tracks) be present in order to read or write sectors.

That’s why converting Forth sources to MGT disk images is most simple, and the full capacity of the disks can be used to store the Forth blocks.

All this means the MGT disk images actually are identical to Forth block files, as used by modern Forth systems. Therefore, for example, they can be browsed with a Forth block editor.

Also the TRD disk images, one of the formats used for TR-DOS disk images, are dumps of the original disks, without any format-describing metadata. But, contrary to G+DOS, TR-DOS needs the system track (track 0) to contain certain data in order to recognize the disk, even for sector-level access. That’s why only 636 KiB can be used for Forth blocks, 4 KiB (one track) less than the maximum capacity.

Anyway, TRD disk images can be browsed with a Forth block editor, with the following restriction: blocks 0..3 will be shown as garbage (they are track 0 of the disk), while the actual first Forth block of the disk (block 0) will be shown as block 4.

The DSK disk image format, used for +3DOS and other systems, is quite a different thing: It contains a lot of metadata to describe the format of the disk, the tracks and the sectors…​

On +3DOS, sector 0 of track 0 can not be used for Forth blocks, because it must contain the disk specification, even for sector-level access. Since the size of a sector is 512 B, only one Forth block is lost because of this restriction.

The need word and its related words search the index line (line 0) of all blocks of the disk for the first occurence of the required word, within a configurable range of blocks (using the variables first-locatable and last-locatable). Of course, nested need are resolved the same way: searching the library from the beginning. This can be slow. This is not a problem, because the goal of Solo Forth is cross development, and therefore only the last step of the development loop, i.e., the compilation of the sources from the disk images created in the host system, compilation that includes all the slow searching of library blocks, is done in the real (actually, emulated) machine. But the system includes a tool to create an index of the library, which is used to locate their contents instantaneously, what makes things more comfortable when the Forth system is used interactively.

How to use the library index:

The indexer creates an index (actually, a Forth word list whose definitions use no code or data space) and changes the default behaviour of need and related words to use it. Then need name will automatically start loading the first block where the word "name" is defined.

An alternative indexer is under development. It’s activated with use-fly-index and does not make and index in advance: Instead, it indexes the blocks on the fly, when they are searched the first time. This indexer was included in Solo Forth 0.12.0 but it’s not finished yet.

Three simple one-line wrapper scripts are included to search the Forth sources for a regular expression: <tools/search_library>, <tools/search_kernel> and <tools/search_source> (to search all files in the <src> directory).

The scripts use ack. In order to use the more common grep, edit the files. ack and grep are compatible.

Their first parameter is the regular expression. An optional second parameter is passed to ack.

Usage examples:

Store x at a.

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: @, +!, 2!, c!.

Source file: <src/kernel.z80s>.

A simpler and faster alternative to standard to and value.

!> is an immediate word.

Interpretation:

Parse name, which is the name of a word created by constant or const, and make x its value.

Compilation:

Parse name, which is a word created by constant or const, and append the run-time semantics given below to the current definition.

Run-time:

Make x the current value of constant name.

Origin: IsForth.

See also: c!>, 2!>.

Source file: <src/lib/data.store-to.fs>.

Store x at the address register.

See also: a, @a.

Source file: <src/lib/memory.address_register.fs>.

Store x at the address register and increment the address register by one cell.

See also: a, @a+.

Source file: <src/lib/memory.address_register.fs>.

Store cell x into address a ($C000..$FFFF) of bank n (0..7).

!bank is written in Z80. Its equivalent definition in Forth is the following:

Source file: <src/lib/memory.far.fs>.

Store flag f in an element of a bit-array, represented by address ca and bitmask b.

See also: @bit, bit-array.

Source file: <src/lib/data.array.bit.fs>.

Save the the current data stack position, sp@, into csp, to be checked later by ?csp.

Definition:

Origin: fig-Forth.

Source file: <src/kernel.z80s>.

Store x at the Plus D memory address a.

See also: @dos, c!dos.

Source file: <src/lib/dos.gplusdos.fs>.

Store x into the G+DOS variable n.

See also: @dosvar, c!dosvar, !dos.

Source file: <src/lib/dos.gplusdos.fs>.

Store x1 into a and return its previous contents x2.

See also: c!exchange, exchange.

Source file: <src/lib/memory.MISC.fs>.

Output byte b to port a.

See also: @p, !, c!.

Source file: <src/lib/memory.ports.fs>.

Set sound register b2 (0…​13) to value b1.

See also: @sound, sound, play, sound-register-port, sound-write-port.

Source file: <src/lib/sound.128.fs>.

Store b1 at volume register of channel b2 (0..2, equivalent to notation 'A'..'C').

See also: @volume, !sound.

Source file: <src/lib/sound.128.fs>.

Divide d1 by current base. The remainder is converted to an ASCII character and appended to the output text string. The quotient d2 is left on stack.

Definition:

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

Convert keyboard key number n to its data: bitmask is the key bitmask and port is the keyboard row port.

Source file: <src/lib/keyboard.MISC.fs>.

Source file: <src/kernel.z80s>.

A character variable that holds the number of block drives defined in block-drives, i.e. the number of drives that are used for blocks. #block-drives could be modified manually, provided also block-drives is configured accordingly, but set-block-drives is provided for that.

Source file: <src/kernel.z80s>.

Return the count +n of chars c in a string ca len.

See also: #spaces, char-in-string?, char-position?.

Source file: <src/lib/strings.MISC.fs>.

A variable that holds the number of word lists in the escaped strings search order.

See also: esc-context, esc-max-order, esc-get-order, esc-set-order, >esc-order.

Source file: <src/lib/strings.escaped.fs>.

Return cursor address ca and count n after cursor till end of line.

Source file: <src/lib/editor.specforth.fs>.

From the cursor pointer r# compute the line address a in the block buffer and the offset from a to the cursor location n.

Source file: <src/lib/editor.specforth.fs>.

From the cursor pointer r# compute the line number n2 and the character offset n1 in line number n2.

Source file: <src/lib/editor.specforth.fs>.

User variable that holds the number of word lists in the search order.

See also: context, max-order, get-order, set-order, >order, order.

Source file: <src/kernel.z80s>.

Count number +n of spaces in a string ca len.

See also: #chars, spaces.

Source file: <src/lib/strings.MISC.fs>.

a is the address of a cell containing the number of characters in the terminal input buffer.

Origin: Forth-83 (Required Word Set), Forth-94 (CORE EXT, obsolescent).

See also: tib, /tib.

Source file: <src/kernel.z80s>.

u is the number of words currently defined in the system.

Source file: <src/kernel.z80s>.

n1 is percentage n3 of n2.

See also: u%, */.

Source file: <src/lib/math.operators.1-cell.fs>.

If name is found in the current search order, return its execution token xt, else throw an exception.

Definition:

Origin: Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: ['], '', defined, ?defined, >.

Source file: <src/kernel.z80s>.

If name is found in the current search order, return its execution-token pointer xtp, else throw an exception.

Since aliases share the execution token of their original word, it’s not possible to get the name of an alias from its execution token. But '' can do it:

See also: [''], '.

Source file: <src/lib/compilation.fs>.

A character constant that returns the caracter code used as backspace (8).

See also: 'cr', 'tab'.

Source file: <src/lib/display.control.fs>.

A character constant that returns the caracter code used as carriage return (13).

See also: cr, crs.

Source file: <src/lib/display.control.fs>.

Index another task’s user variable.

Source file: <src/lib/multitask.muench-koh.fs>.

A character constant that returns the caracter code used as tabulator (6).

See also: tab, 'cr', 'bs'.

Source file: <src/lib/display.control.fs>.

Parse until a right paren is found. The number of parsed characters may be zero to the number of characters in the parse area.

( is an immediate word.

Source file: <src/kernel.z80s>.

Show a disk catalogue of the current drive, calling the corresponding G+DOS hook command, which uses the data in ufia1. Return error result ior.

((cat is a low-level factor of (cat.

Source file: <src/lib/dos.gplusdos.fs>.

Add n1 to element n2 of 1-dimension single-cell values array xt.

See also: avalue, +ato.

Source file: <src/lib/data.array.value.fs>.

Add c to element n of 1-dimension character values array xt.

See also: cavalue, +cato.

Source file: <src/lib/data.array.value.fs>.

Add n to the loop index. If the loop index did not cross the boundary between the loop limit minus one and the loop limit, continue execution at the beginning of the loop. Otherwise, discard the loop parameters and continue execution immediately following the loop.

(+loop) is compiled by +loop.

See also: (loop).

Source file: <src/kernel.z80s>.

If n1|u1 is not less than n2|u2, discard both parameters and continue execution at the location given by the consumer of the do-sys left by -do at compilation time. Otherwise set up loop control parameters loop-sys with index n2|u2 and limit n1|u1 and continue executing immediately following -do. Anything already on the return stack becomes unavailable until the loop control parameters loop_sys are discarded.

(-do) is compiled by -do.

Source file: <src/lib/flow.do.fs>.

Type the compiled string that follows.

Definition:

Source file: <src/kernel.z80s>.

Default action of .word: print the name of the definition nt and execute tab.

Source file: <src/lib/tool.list.words.fs>.

Display a list of the items in the current xstack; TOS is the right-most item.

(.xs) is a factor of .xs.

Source file: <src/lib/data.xstack.fs>.

Print control character c. Then convert n to the set 0, 1 and 8 and print it as a character. The conversion of n is done as follows:

This word is a factor of flash. and bright..

Source file: <src/lib/display.attributes.fs>.

Return the address a of a routine used by paper. and ink.. This routine prints a color attribute in the range 0..9.

Input: - A = attribute control char ($10 for ink, $11 for paper) - TOS = attribute value (0..9)

Note: If TOS is greater than 9, 9 is used instead.

Source file: <src/lib/display.attributes.fs>.

Store xd into element n of 1-dimension double-cell values array xt.

See also: 2ato.

Source file: <src/lib/data.array.value.fs>.

Rewrite the code field of the most recently defined high-level word (it can not be a code word) to point to the following machine code sequence.

(;code) is the run-time procedure compiled by ;code and does>.

Definition:

See also: latest, name>.

Source file: <src/kernel.z80s>.

Convert block u1 to its equivalent u2 in its corresponding disk drive, which is set the current drive.

(>drive-block becomes the action of >drive-block after block-drives has been loaded.

See also: ?drive#, ?block-drive, set-drive, set-block-drives.

Source file: <src/lib/dos.COMMON.fs>.

Save a file to disk using the data hold in ufia and return error result ior.

(>file) is a factor of >file.

Source file: <src/lib/dos.gplusdos.fs>.

Write a tape file using the data stored at tape-header.

(>tape-file) is a factor of >tape-file.

Source file: <src/lib/tape.fs>.

Run-time procedure compiled by ?ccase. If c is in the string ca len, execute the n-th word compiled after ?ccase, where n is the position of the first c in the string (0..len-1). If c is not in ca len, do nothing.

Source file: <src/lib/flow.ccase.fs>.

If n1|u1 is equal to n2|u2, continue execution at the location given by the consumer of the do-sys left by ?do at compilation time. Otherwise set up loop control parameters loop-sys with index n2|u2 and limit n1|u1 and continue executing immediately following ?do. Anything already on the return stack becomes unavailable until the loop control parameters loop_sys are discarded.

(?do) is compiled by ?do.

See also: (do), (-do).

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

The run-time factor of any-of. If x0 equals any of x1..xn, return x0 x0; else return x0 0.

Source file: <src/lib/flow.case.fs>.

Set the cursor coordinates to column col and row row, by displaying control character 22 followed by col and row, as needed by some display modes, e.g. mode-64 and mode-42. The upper left corner is column zero, row zero.

(at-xy is a possible action of at-xy, which is a deferred word configured by the current display mode.

Source file: <src/lib/display.mode.COMMON.fs>.

Store x into element n of 1-dimension single-cell values array xt.

See also: ato.

Source file: <src/lib/data.array.value.fs>.

Integer square root n3 of radicand n1 with remainder n2. (baden-sqrt is a factor of baden-sqrt.

Source file: <src/lib/math.operators.1-cell.fs>.

Source file: <src/kernel.z80s>.

Copy the string ca len to the cursor line at the cursor position.

Source file: <src/lib/editor.specforth.fs>.

Show a disk catalogue of the current drive, using the data in ufia, being b the type of catalogue:

(cat is the common factor of all words that show disk catalogues: cat, acat, wcat, wacat.

See also: ((cat, set-drive.

Source file: <src/lib/dos.gplusdos.fs>.

Store c into element n of 1-dimension character values array xt.

See also: cato.

Source file: <src/lib/data.array.value.fs>.

Run-time procedure compiled by ccase. If c is in the string ca len, execute the n-th word compiled after ccase, where n is the position of the first c in the string (0..len-1). If c is not in ca len, execute the word compiled right before endccase.

Source file: <src/lib/flow.ccase.fs>.

Run-time procedure compiled by ccase0. If c is in the string ca len, execute the n-th word compiled after ccase0, where n is the position of the first c in the string (0..len-1) plus 1. If c is not in ca len, execute the word compiled right after ccase0.

Source file: <src/lib/flow.ccase.fs>.

A factor of name>compile. If nt is an immediate word, return the xt of execute, else return the xt of compile,.

Source file: <src/lib/compilation.fs>.

Default action of the deferred word cr: Transmit a carriage return to the selected output device.

Source file: <src/kernel.z80s>.

Convert d to an unsigned number in the current base, with n digits, as string ca len.

See also: (bin., (hex..

Source file: <src/lib/display.numbers.fs>.

Display d as an unsigned binary number with n digits.

See also: (hex., 32bin., 16bin., 8bin., bin..

Source file: <src/lib/display.numbers.fs>.

Default action of an uninitialized deferred word: error.

Source file: <src/kernel.z80s>.

Delete a disk file using the data hold in ufia. Return an error result ior.

(delete-file) is a factor of delete-file.

Source file: <src/lib/dos.gplusdos.fs>.

Display d as an unsigned hexadecimal number with n digits.

See also: (bin., 32hex., 16hex., 8hex., hex..

Source file: <src/lib/display.numbers.fs>.

Set up loop control parameters loop-sys with index n2|u2 and limit n1|u1 and continue executing immediately following do. Anything already on the return stack becomes unavailable until the loop control parameters loop_sys are discarded.

(do) is compiled by do.

See also: (?do), (-do).

Source file: <src/kernel.z80s>.

The run-time procedure compiled by dstep.

If the loop index ud is zero, discard it and continue execution after the loop. Otherwise decrement the loop index and continue execution at the beginning of the loop.

Source file: <src/lib/flow.dfor.fs>.

Return the status of the file whose name is hold in ufia. If the file exists, its file header is read into ufia, a is the address returned by ufia, and ior is zero. If the file does not exists, a is useless and ior is the corresponding error code.

(file-status) is a low-level factor of file-status.

Source file: <src/lib/dos.gplusdos.fs>.

Read a file from disk, using the data hold in ufia and the alternative destination zone ca len, following the following two rules:

Return error result ior.

(file>) is a factor of file>.

See also: file-address, file-length.

Source file: <src/lib/dos.gplusdos.fs>.

Display character c (32..127) at the current graphic coordinates.

The character is printed with overprinting (equivalent to 1 overprint).

See also: g-emit, g-emit_.

Source file: <src/lib/display.g-emit.fs>.

If len is greater than zero, display text string ca len at screen address a1 using style data table a2.

(gigatype is written in Z80 and it’s a factor of gigatype.

Source file: <src/lib/display.gigatype.fs>.

The run-time factor of greater-of.

Source file: <src/lib/flow.case.fs>.

If the current heap was created by bank-heap, page in its bank, which is stored at heap-bank; else do nothing.

(heap-in is the action of heap-in.

Source file: <src/lib/memory.allocate.COMMON.fs>.

Default action of home: Set the cursor position at the top left position (column 0, row 0).

Source file: <src/kernel.z80s>.

Index block u, evaluating its header line. The only word list in the search order must be index-wordlist.

This is a common factor of (indexer) (from the indexer tool) and (index-block) (from the fly-indexer tool).

Source file: <src/lib/blocks.indexer.COMMON.fs>.

The run-time factor of less-of.

Source file: <src/lib/flow.case.fs>.

Make block u the current input source and interpret it.

(load) is a common factor of load and continued.

Definition:

See also: block>source, interpret.

Source file: <src/kernel.z80s>.

Locate the first block whose header contains the string ca len (surrounded by spaces), and return its number. If not found, return zero. The search is case-sensitive.

Only the blocks delimited by first-locatable and last-locatable are searched.

This is the default action of located, which is changed by use-fly-index.

See also: default-first-locatable.

Source file: <src/lib/002.need.fs>.

Increment the loop index by one. If the loop index did not cross the boundary between the loop limit minus one and the loop limit, continue execution at the beginning of the loop. Otherwise, discard the loop parameters and continue execution immediately following the loop.

(loop) is compiled by loop.

See also: (+loop).

Source file: <src/kernel.z80s>.

Create the blocks index, from first-locatable to last-locatable.

(make-thru-index) is a factor of make-thru-index.

See also: use-thru-index.

Source file: <src/lib/blocks.indexer.thru.fs>.

Run-time procedure compiled by options[.

x = option to search for

Source file: <src/lib/flow.options-bracket.fs>.

Parse a text string delimited by a double quote, translating some configurable characters that are escaped with a backslash. Add the translated string to ca len, returning a new string ca' len' in the stringer.

(parse-esc-string) is a factor of parse-esc-string.

See also: set-esc-order.

Source file: <src/lib/strings.escaped.fs>.

Return the address a of a Z80 routine that pans the whole screen one pixel to the right.

Note: The BC register (the Forth IP) is not preserved. This is intended, in order to save time when this routine is called in a loop. Therefore the calling code must save the BC register.

See also: pixel-pan-right, pixel-scroll-up.

Source file: <src/lib/graphics.scroll.fs>.

Return the address a of a Z80 routine that scrolls the whole screen one pixel up.

Note: The BC register (the Forth IP) is not preserved. This is intended, in order to save time when this routine is called in a loop. Therefore the calling code must save the BC register.

See also: pixel-scroll-up.

Source file: <src/lib/graphics.scroll.fs>.

Rename the file named by the filename stored in ufia1 to the filename stored in ufia2. and return error result ior.

(rename-file is a factor of `rename-file.

Source file: <src/lib/dos.gplusdos.fs>.

A variable that contains the value returned by source-id.

Source file: <src/kernel.z80s>.

The run-time procedure compiled by step.

Run-time: ( R: n — n' )

If the loop index is zero, discard the loop parameters and continue execution after the loop. Otherwise decrement the loop index and continue execution at the beginning of the loop.

Source file: <src/lib/flow.for.fs>.

Given a string ca1 len1 create its definition in substitute-wordlist its substitution and return the address of its storage space in data space, not allocated.

(substitution is a common factor of substitution and xt-substitution.

See also: substitution, xt-substitution, replaces.

Source file: <src/lib/strings.replaces.fs>.

Read a tape file using the data stored at tape-header.

(tape-file>) is a factor of tape-file>.

Source file: <src/lib/tape.fs>.

Source file: <src/kernel.z80s>.

Create a user variable name. +n is the offset within the user area where the value for name is stored. Execution of name leaves its absolute user area storage address.

(user) is a factor of ucreate.

Origin: user in fig-Forth, Forth-79 (Reference Word Set) and Forth-83 (Uncontrolled Reference Words).

See also: user, 2user.

Source file: <src/kernel.z80s>.

Inner procedure compiled by warning". If f is not zero, print the compiled message; else do nothing.

Source file: <src/lib/exception.fs>.

If the content of ~~? is not zero, execute the debugging code that was compiled by ~~ during the definition of word nt in line n of block u.

See also: ~~y, ~~control.

Source file: <src/lib/tool.debug.tilde-tilde.fs>.

End an assertion.

) is an immediate word.

Origin: Gforth.

See: assert(.

Source file: <src/lib/tool.debug.assert.fs>.

Multiply n1|u1 by n2|u2 giving the product n3|u3.

Origin: fig-Forth, Forth-79, Forth-83, Forth-94, Forth-2012.

Source file: <src/kernel.z80s>.

Multiply n|u by the single-cell number at a and store the product in a

See also: 2*! /!, +!, -!.

Source file: <src/lib/memory.MISC.fs>.

Multiply n1 by n2 producing the intermediate d. Divide d by n3 giving the quotient n4.

Definition:

Origin: fig-Forth, Forth-79, Forth-94, Forth-2012.

See also: */mod, m*/, *, /, '*/_mod`, */-rem.

Source file: <src/kernel.z80s>.

Multiply n1 by n2 producing the intermediate result d. Divide d by n3 (doing a symmetric division), giving the symmetric quotient n4.

See also: */-rem, */, */_, sm/rem.

Source file: <src/lib/math.operators.1-cell.fs>.

Multiply n1 by n2 producing the intermediate result d. Divide d by n3 (doing a symmetric division), giving the remainder n4 and the symmetric quotient n5.

See also: */mod, */_mod, sm/rem.

Source file: <src/lib/math.operators.1-cell.fs>.

Multiply n1 by n2 producing the intermediate result d. Divide d by n3 (doing a floored division), giving the floored quotient n4.

See also: */_mod, */, */-, fm/mod.

Source file: <src/lib/math.operators.1-cell.fs>.

Multiply n1 by n2 producing the intermediate result d. Divide d by n3 (doing a floored division), giving the remainder n4 and the floored quotient n5.

See also: */mod, */-rem, fm/mod.

Source file: <src/lib/math.operators.1-cell.fs>.

Multiply n1 by n2 producing the intermediate result d. Divide d by n3 producing the remainder n4 and the quotient n5.

Definition:

Origin: fig-Forth, Forth-79, Forth-94, Forth-2012.

See also: /mod, */, */_mod, */-rem, m*, m/.

Source file: <src/kernel.z80s>.

See also: d+.

Source file: <src/kernel.z80s>.

Add n|u to the single-cell number at a.

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: c+!, @, +, !.

Source file: <src/kernel.z80s>.

An alias of noop that is defined only in the +3DOS version of Solo Forth. Its goal is to be used to check the DOS the application is running on.

+3dos is an immediate word.

See also: dos, tr-dos, g+dos, defined, [defined].

Source file: <src/kernel.z80s>.

Add n1 to element n2 of 1-dimension single-cell values array name.

+ato is an immediate word.

See also: avalue, (+ato).

Source file: <src/lib/data.array.value.fs>.

Convert a Sinclair BASIC BEEP’s positive pitch +n1 to its corresponding note +n3 (0..11) in octave +n2, being zero the middle octave.

See also: beep>note, -beep>note, /octave.

Source file: <src/lib/sound.48.fs>.

A run-time procedure to branch conditionally. If n is positive, the following in-line address is copied to IP to branch forward or backward.

+branch is compiled by -if and -until.

See also: -while.

Source file: <src/lib/flow.branch.fs>.

Add c to element n of 1-dimension character values array name.

+cato is an immediate word.

See also: cavalue, (+cato).

Source file: <src/lib/data.array.value.fs>.

If n is positive, return control to the calling definition, specified by nest-sys.

+exit is not intended to be used within a do-loop. Use 0>= if unloop exit then instead.

In Solo Forth +exit can be used in interpretation mode to stop the interpretation of a block.

Source file: <src/lib/flow.conditionals.positive.fs>.

Create a definition for name with the execution semantics defined below. Return n3 = n1 + n2 where n1 is the offset in the data structure before +field executes, and n2 is the size of the data to be added to the data structure. n1 and n2 are in address units.

name execution: ( a1 — a2 )

Add n1 to a1 giving a2.

+field is not required to align items. This is deliberate and allows the construction of unaligned data structures for communication with external elements such as a hardware register map or protocol packet. Field alignment has been left to the appropriate field definition, e.g. field:, 2field:, cfield:.

In Solo Forth, +field is an unitialized deferred word, for which three implementations are provided: +field-unopt, +field-opt-0 and +field-opt-0124.

Origin: Forth-2012 (FACILITY EXT).

See also: begin-structure.

Source file: <src/lib/data.begin-structure.fs>.

Optimized implementation of +field. This implementation is more efficient than +field-unopt (but less than +field-opt-0124) because the field 0 does not calculate the field offset.

+field-opt-0 uses 31 bytes of data space.

Source file: <src/lib/data.begin-structure.fs>.

Optimized implementation of +field that optimizes the calculation of field offsets 0, 1, 2 and 4. Therefore it is more efficient than +field-unopt and +field-opt-0, but it uses 106 bytes of data space and needs case.

Source file: <src/lib/data.begin-structure.fs>.

Unoptimized implementation of +field. This implementation is less efficient than +field-opt-0 and +field-opt-0124 because the field offset is calculated also when it is 0.

The advantage of this implementation is it uses only 22 bytes of data space, so it could be useful in some cases.

Source file: <src/lib/data.begin-structure.fs>.

Faster and smaller alternative to the idiom 0>= if.

+if is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.positive.fs>.

Load the block that is n blocks from the current one.

See also: load, blk, +thru.

Source file: <src/lib/blocks.fs>.

Compile (+loop) and resolve the do-sys address left by do, ?do or -do.

+loop is an immediate and compile-only word.

Origin: Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: loop.

Source file: <src/kernel.z80s>.

Remove all instances of the word list identified by wid from the search order, then add it to the top.

See also: -order, >order, set-order, order.

Source file: <src/lib/word_lists.fs>.

Leave the memory address relative by n bytes to the origin parameter area. +origin is used to access or modify the boot-up parameters at the origin area.

Origin: fig-Forth.

Source file: <src/kernel.z80s>.

Execute the execution token pointed by an offset of n cells from base address a, i.e., execute the contents of element n of the cell table that starts at a.

If the execution token is zero, do nothing.

See also: perform, execute.

Source file: <src/lib/flow.MISC.fs>.

Add the string ca1 len1 to the end of the counted string ca2.

See also: place, s+, smove, count.

Source file: <src/lib/strings.MISC.fs>.

Start more private definitions of a seclusion module.

See also: -seclusion, end-seclusion.

Source file: <src/lib/modules.MISC.fs>.

A variable that holds the pointer of the stringer, i.e. an offset to its first free address. The offset equals the number of free characters in the stringer.

See also: empty-stringer.

Source file: <src/kernel.z80s>.

Load consecutively the blocks that are u1 blocks through u2 blocks from the current one.

See also: +load, blk, load.

Source file: <src/lib/blocks.fs>.

Set the add action for the next local variable. Used with locals created by arguments.

Loading +toarg makes @ the default action of arguments locals, which is hold in arg-default-action.

See also: toarg.

Source file: <src/lib/locals.arguments.fs>.

Add n2|u2 to n1|u2, giving the sum n3|u3.

+under is written in Z80. Its definition in Forth is the following:

Origin: Comus.

See also: under+

Source file: <src/lib/math.operators.1-cell.fs>.

Faster and smaller alternative to the idiom 0>= until.

+until is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.positive.fs>.

Faster and smaller alternative to the idiom 0>= while.

+while is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.positive.fs>.

Source file: <src/kernel.z80s>.

Parse "ccc" delimited by a double-quote and compile the string.

Definition:

Source file: <src/kernel.z80s>.

Store x into the address pointed by the name-space pointer, advancing the name-space pointer.

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

Subtract n|u from the single-cell number at a.

See also: +!, 1-!, c-!.

Source file: <src/lib/memory.MISC.fs>.

Continue interpretation with the next block.

-→ is an immediate word.

Definition:

Origin: fig-Forth, Forth-79 (Reference Word Set), Forth-83 (Controlled Reference Words).

See also: ?-->, load, continued, ?loading, refill.

Source file: <src/kernel.z80s>.

Return -1. -1 is not a constant, but a code word, which is faster.

See also: 0, 1, 2, true.

Source file: <src/kernel.z80s>.

Return a random number: -1, 0 or 1.

See also: -1|1, rnd, fast-random.

Source file: <src/lib/random.fs>.

Return a random number: -1 or 1.

See also: -1..1, rnd, fast-random.

Source file: <src/lib/random.fs>.

Convert a Sinclair BASIC BEEP’s negative pitch -n1 to its corresponding note +n3 (0..11) in octave -n2, being zero the middle octave.

See also: beep>note, +beep>note, /octave.

Source file: <src/lib/sound.48.fs>.

Fill block-drives with not-block-drive, making no disk drive be used as block drive.

See also: set-block-drives, get-block-drives.

Source file: <src/lib/dos.COMMON.fs>.

A run-time procedure to branch conditionally. If n is negative, the following in-line address is copied to IP to branch forward or backward.

-branch is compiled by +if and +until.

See also: +while.

Source file: <src/lib/flow.branch.fs>.

Compile (-do) and leave do-sys to be consumed by loop or +loop. -do is an alternative to do and ?do, to create count-down loops with +loop.

-do is an immediate and compile-only word.

Definition:

Usage example:

Origin: Gforth.

Source file: <src/lib/flow.do.fs>.

Duplicate x if it’s negative.

See also: dup, 0dup.

Source file: <src/lib/data_stack.fs>.

If n is negative, return control to the calling definition, specified by nest-sys.

-exit is not intended to be used within a do-loop. Use 0< if unloop exit then instead.

In Solo Forth -exit can be used in interpretation mode to stop the interpretation of a block.

Source file: <src/lib/flow.conditionals.negative.fs>.

Blank the filename in ufia, i.e. replace it with spaces.

See also: /filename, set-filename.

Source file: <src/lib/dos.gplusdos.fs>.

Faster and smaller alternative to the idiom 0< if.

-if is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.negative.fs>.

Adjust the start and length of a string to suppress the leading blanks.

See also: -trailing, trim.

Source file: <src/kernel.z80s>.

Disable the noise and tone mixers for the three channels of the AY-3-8912 sound generator.

See also: set-mixer, get-mixer, silence.

Source file: <src/lib/sound.128.fs>.

Move a line of text from ca to line n of current block.

Source file: <src/lib/editor.specforth.fs>.

Remove all instances of word list identified by wid from the search order.

See also: +order, >order, set-order, order.

Source file: <src/lib/word_lists.fs>.

Remove prefix ca2 len2 from string ca1 len1.

See also: -suffix, /string, 1/string, -leading.

Source file: <src/lib/strings.MISC.fs>.

Divide n1 by n2 (doing a symmetric division), giving the remainder n3.

See also: /-rem, /, /_mod.

Source file: <src/lib/math.operators.1-cell.fs>.

Source file: <src/kernel.z80s>.

Start the public definitions of a seclusion module.

See also: +seclusion, end-seclusion.

Source file: <src/lib/modules.MISC.fs>.

Remove suffix ca2 len2 from string ca1 len1.

See also: -prefix, string/, chop, -trailing.

Source file: <src/lib/strings.MISC.fs>.

Blank tape-filename in tape-header.

Source file: <src/lib/tape.fs>.

Return a non-zero f if string ca1 len1 exactly match string ca2 len1, else return a false flag.

Source file: <src/lib/editor.specforth.fs>.

Adjust the length of a string to suppress the trailing blanks.

If len is greater than zero, len2 is equal to len1 less the number of spaces at the end of the character string specified by ca1 len1. If len1 is zero or the entire string consists of spaces, len2 is zero.

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (STRING), Forth-2012 (STRING).

See also: -leading, trim.

Source file: <src/kernel.z80s>.

Faster and smaller alternative to the idiom 0< until.

-until is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.negative.fs>.

Faster and smaller alternative to the idiom 0< while.

-while is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.negative.fs>.

Print signed integer n according to current base, followed by only one blank.

Source file: <src/kernel.z80s>.

Compilation: ( "ccc<quote>" — )

Parse "ccc" delimited by a double-quote. Append the run-time semantics given below to the current definition.

Display "ccc".

." is an immediate and compile-only word.

Definition:

Origin: Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

Source file: <src/kernel.z80s>.

.( is an immediate word.

Source file: <src/kernel.z80s>.

.\" is an immediate and compile-only word.

Note: When .\" is loaded, esc-standard-chars-wordlist is set as the only word list in esc-order. That is the standard behaviour. Alternative escaped chars can be configured with esc-block-chars-wordlist and esc-udg-chars-wordlist.

See also: parse-esc-string, set-esc-order, s\".

Source file: <src/lib/strings.escaped.fs>.

Display the word lists in the search order in their search order sequence, from first searched to last searched.

See also: get-order, .wordlist, order.

Source file: <src/lib/tool.list.word_lists.fs>.

Display the compilation word list.

See also: get-current, .wordlist, order.

Source file: <src/lib/tool.list.word_lists.fs>.

Source file: <src/kernel.z80s>.

Print the map of the current memory heap, in the implementation based on code written by Javier Gil, whose words are defined in gil-heap-wordlist.

Occupied chunks are marked with a 'x'; free chunks are marked with a '-'.

Source file: <src/lib/memory.allocate.gil.fs>.

Print the first line of the block u, which conventionally contains a comment with a title.

Source file: <src/lib/tool.list.blocks.fs>.

Print line n1 from block n2, without trailing spaces.

Origin: fig-Forth.

Source file: <src/lib/tool.list.blocks.fs>.

Print line number n right-aligned in a field whose width depends on the current radix (decimal, hex or binary).

Source file: <src/lib/tool.list.blocks.fs>.

Display the current menu, which has been set by set-menu and can be activated by menu.

See also: new-menu.

Source file: <src/lib/menu.sinclair.fs>.

Source file: <src/kernel.z80s>.

Print "ok". .ok is the default action of ok, the word called by quit after interpreting a command.

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

Deferred word that prints error message n. By default it prints only the number.

Source file: <src/kernel.z80s>.

Print the number of throw error n, as a decimal number, prefixed with a '#' and followed by a space.

Source file: <src/kernel.z80s>.

Extended action of the deferred word .throw: Print the text of throw error n. The variable errors-block holds the number of the first block where messages are hold. If it contains zero, only the error number is printed.

Source file: <src/lib/exception.fs>.

Display the total RAM in the system, and the amount of space remaining in the regions addressed by here and np, in address units.

See also: unused, farunused.

Source file: <src/kernel.z80s>.

Print the Solo Forth version.

Source file: <src/kernel.z80s>.

A deferred word whose default action is (.word). This word is used by words, words-like and wordlist-words, therefore their output can be changed by the user in special cases, for example when more details are needed for debugging.

Source file: <src/lib/tool.list.words.fs>.

If the word list identified by wid has an associated name, display it; else display wid.

See also: wordlists.

Source file: <src/lib/tool.list.word_lists.fs>.

An alternative action for the deferred word .word, which is used by words, words-like and wordlist-words. .wordname prints nt and its correspondent name.

Source file: <src/lib/tool.list.words.fs>.

Source file: <src/kernel.z80s>.

Display the number of items on the current xstack, followed by a list of the items, if any; TOS is the right-most item.

See also: xdepth ,(.xs).

Source file: <src/lib/data.xstack.fs>.

Divide n1 by n2, giving the quotient n3.

Definition:

Origin: fig-Forth, Forth-79, Forth-94, Forth-2012.

See also: /mod, /_, /-,

Source file: <src/kernel.z80s>.

Divide n by the single-cell number at a and store the quotient in a

See also: 2/!, *!, +!, -!.

Source file: <src/lib/memory.MISC.fs>.

Divide n1 by n2 (doing a symmetric division), giving the symmetric quotient n4.

See also: /-rem, /, /_, sm/rem.

Source file: <src/lib/math.operators.1-cell.fs>.

Divide n1 by n2 (doing a symmetric division), giving the remainder n3 and the symmetric quotient n4.

See also: /mod, /_mod, sm/rem.

Source file: <src/lib/math.operators.1-cell.fs>.

Divide n1 by n2 (doing a floored division), giving the floored quotient n4.

See also: /_mod, /, /-, fm/mod.

Source file: <src/lib/math.operators.1-cell.fs>.

Divide n1 by n2 (doing a floored division), giving the remainder n3 and the floored quotient n4.

See also: /mod, /-rem, fm/mod.

Source file: <src/lib/math.operators.1-cell.fs>.

Divide n1 by n2 (doing a floored division), giving the remainder n3.

See also: /_mod, /, -rem.

Source file: <src/lib/math.operators.1-cell.fs>.

A variable that holds the buffer max length used by the latest execution of accept.

Source file: <src/lib/keyboard.MISC.fs>.

n is the size in bytes of a memory bank: $4000.

See also: bank-start.

Source file: <src/kernel.z80s>.

n is the maximum size of a counted string, in characters.

See also: max-char, environment?.

Source file: <src/lib/environment-question.fs>.

A constant that returns the maximum length of a G+DOS filename.

See also: set-filename.

Source file: <src/lib/dos.gplusdos.fs>.

Size of the current heap, in address units.

See also: get-heap.

Source file: <src/lib/memory.allocate.COMMON.fs>.

A character constant that returns the length of the pictured output string buffer, which is located right below pad.

See also: hld, /pad.

Source file: <src/kernel.z80s>.

A constant that holds the bytes ocuppied by every key in the kk-ports table: 3 (smaller and slower table) or 4 (bigger and faster table).

There are two versions of kk, and kk@. They depend on the value of /kk.

The application can define /kk before loading this block; else it will be defined as a cconstant with value 4.

Source file: <src/lib/keyboard.MISC.fs>.

Maximum length of a line number in the current radix. It works for decimal, hex and binary.

Source file: <src/lib/tool.list.blocks.fs>.

Divide n1 by n2, giving the remainder n3 and the quotient n4.

Origin: fig-Forth, Forth-79, Forth-94, Forth-2012.

See also: du/mod.

Source file: <src/kernel.z80s>.

Split string ca1 len1 into ca2 len2 (from the start of the first name in ca1 len1) and ca3 len3 (from the char after the first name in _ca1 len1). A name is a substring separated by spaces.

See also: first-name, /string, -prefix, -suffix, string/.

Source file: <src/lib/strings.MISC.fs>.

A constant that returns the number of notes in one octave: 12.

See also: middle-octave.

Source file: <src/lib/sound.48.fs>.

n is the size of the scratch area pointed to by pad, in characters.

See also: /hold, environment?.

Source file: <src/lib/environment-question.fs>.

n is the number of header lines shown on a quick index. It depends on the rows and columns of the current screen mode.

See also: qx.

Source file: <src/lib/tool.list.blocks.fs>.

n is the width of a column of the quick index. It depends on the columns (32, 42, 64…​) of the current screen mode.

See also: qx, qx-columns.

Source file: <src/lib/tool.list.blocks.fs>.

A character constant that returns 14, the number of registers used by the 128K sounds.

See also: !sound, @sound, sound, play.

Source file: <src/lib/sound.128.fs>.

Adjust the character string ca1 len1 by n characters. The resulting character string ca2 len2 begins at ca1 plus n characters and is len1 minus n characters long.

/string is written in Z80. Equivalent definitions in Forth are the following:

Origin: Forth-94 (STRING), Forth-2012 (STRING).

See also: 1/string, -prefix, string/.

Source file: <src/kernel.z80s>.

A constant that holds the maximum size of the stringer, in characters.

See in stringer an example how to move and resize the stringer.

See also: +stringer, empty-stringer, `default-stringer'.

Source file: <src/kernel.z80s>.

A variable that holds the number of spaces that tabulate counts for. Its default value is 8.

See tabulate.

Source file: <src/lib/display.control.fs>.

n is the maximum length of a tape filename, which is 10 characters.

See also: tape-filename. /filename.

Source file: <src/lib/tape.fs>.

n is the length of a tape-header: 17 bytes.

Source file: <src/lib/tape.fs>.

Maximum size of the terminal input buffer,

See also: tib, #tib.

Source file: <src/kernel.z80s>.

b is the size of a UDG (User Defined Graphic), in bytes.

See also: udg-width, udg!.

Source file: <src/lib/graphics.udg.fs>.

Multiply n1 by the /udg, resulting n2. Used by udg>.

/udg* is an alias of 8*.

Source file: <src/lib/graphics.udg.fs>.

n is the length of a UFIA (User File Information Area), a 24-byte structure which describes a file.

See also: ufia, ufia1, ufia2.

Source file: <src/lib/dos.gplusdos.fs>.

n is the length of the user area.

See also: up.

Source file: <src/kernel.z80s>.

A constant that holds the size in bytes n occupied by the data of one window.

Source file: <src/lib/display.window.fs>.

Return 0. 0 is not a constant, but a code word, which is faster.

See also: -1, 1, 2, false.

Source file: <src/kernel.z80s>.

Print signed integer n according to current base, without any trailing blank.

Source file: <src/kernel.z80s>.

f is true if and only if n is less than zero.

Origin: Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: 0>, 0<=, 0=, 0<>.

Source file: <src/kernel.z80s>.

f is true if and only if n is less than or equal to zero.

See also: 0>=, <=, u<=.

Source file: <src/lib/math.operators.1-cell.fs>.

f is true if and only if x is not equal to zero.

Origin: Forth-94 (CORE EXT), Forth-2012 (CORE EXT).

See also: 0=.

Source file: <src/kernel.z80s>.

f is true if and only if x is equal to zero.

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: 0<>, 0<, 0>, negate, invert.

Source file: <src/kernel.z80s>.

f is true if and only if n is greater than zero.

Origin: Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE EXT), Forth-2012 (CORE EXT).

See also: 0<, 0>=, 0=, 0<>.

Source file: <src/kernel.z80s>.

f is true if and only if n is greater than or equal to zero.

See also: 0<=, >=, u>=.

Source file: <src/lib/math.operators.1-cell.fs>.

A run-time procedure to branch conditionally. If f is false (zero), the following in-line address is copied to IP to branch forward or backward.

Origin: fig-Forth.

See also: branch, ?branch, -branch, +branch.

Source file: <src/kernel.z80s>.

Print signed double integer d according to current base, without any trailing blank.

Source file: <src/kernel.z80s>.

Duplicate x if it’s zero.

See also: dup, -dup.

Source file: <src/lib/data_stack.fs>.

If f is zero, return control to the calling definition, specified by nest-sys.

0exit is not intended to be used within a do-loop. Use 0= if unloop exit then instead.

In Solo Forth 0exit can be used in interpretation mode to stop the interpretation of a block.

Source file: <src/lib/flow.conditionals.zero.fs>.

Faster and smaller alternative to the idiom 0= if.

0if is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.zero.fs>.

If n is negative, return 0; else return n. This is a faster alternative to the idiom 0 max.

See also: max, min.

Source file: <src/lib/math.operators.1-cell.fs>.

Faster and smaller alternative to the idiom 0= until.

0until is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.zero.fs>.

Faster and smaller alternative to the idiom 0= while.

0while is an immediate and compile-only word.

Source file: <src/lib/flow.conditionals.zero.fs>.

Return 1. 1 is not a constant, but a code word, which is faster.

See also: -1, 0, 2.

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

Increment the single-cell number at a.

See also: c1+!, 1-!, +!.

Source file: <src/lib/memory.MISC.fs>.

Source file: <src/kernel.z80s>.

Decrement the single-cell number at a.

See also: 1+!, c1-!, -!.

Source file: <src/lib/memory.MISC.fs>.

Adjust the character string ca1 len1 by 1 character.

1/string is equivalent to the idiom 1 /string but faster (0.9 the execution time).

See also: /string.

Source file: <src/kernel.z80s>.

Display n as an unsigned 16-bit binary number.

See also: 16bin., 32bin., 8bin., bin., binary.

Source file: <src/lib/display.numbers.fs>.

Display d as an unsigned 16-bit hexadecimal number.

See also: 16bin., 32hex., 8hex., hex., hex.

Source file: <src/lib/display.numbers.fs>.

Define a 1-dimension array name with n1 items of n2 address units each.

See also: }, array>items, 2array.

Source file: <src/lib/data.array.noble.fs>.

Scan the cursor line for a match to pad text. Return flag and update the cursor r# to the end of matching text, or to the start of the next line if no match is found.

Source file: <src/lib/editor.specforth.fs>.

If x is a byte, execute cliteral, else execute literal.

1literal is used in interpret-table to compile the single-cell literals. It is useful as an alternative to literal, in order to optimize the code when x is unknown.

1literal is an immediate and compile-only word.

Definition:

See also: 2literal, ]1l.

Source file: <src/kernel.z80s>.

Return 2. 2 is not a constant, but a code word, which is faster.

See also: -1, 0, 1, cell.

Source file: <src/kernel.z80s>.

Store the cell pair x1 x2 at a, with x2 at a and x1 at the next consecutive cell. It is equivalent to the sequence swap over ! cell+ !.

Origin: Forth-79 (Double Number Word Set), Forth-83 (Double Number Extension Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: 2@, !, c!.

Source file: <src/kernel.z80s>.

A simpler and faster alternative to standard to and 2value.

2!> is an immediate word.

Interpretation:

Parse name, which is the name of a word created by 2constant or 2const, and make xd its value.

Compilation:

Parse name, which is a word created by 2constant or 2const, and append the run-time semantics given below to the current definition.

Run-time:

Make xd the current value of double-cell constant name.

Origin: IsForth’s !>.

See also: !>, c!>.

Source file: <src/lib/data.store-to.fs>.

x2 is the result of shifting x1 one bit toward the most-significant bit, filling the vacated least-significant bit with zero.

2* is equivalent to 1 lshift.

Origin: Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: lshift, 8*.

Source file: <src/kernel.z80s>.

Do a 2* shift to the single-cell number at a.

See also: 2/!, 2*.

Source file: <src/lib/memory.MISC.fs>.

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

x2 is the result of shifting x1 one bit toward the least-significant bit, leaving the most-significant bit unchanged.

This is the same as s>d 2 fm/mod swap drop. It is not the same as 2 /, nor is it the same as 1 rshift.

Origin: Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

Source file: <src/lib/math.operators.1-cell.fs>.

Do a 2/ shift to the single-cell number at a.

See also: 2*!, 2/.

Source file: <src/lib/memory.MISC.fs>.

Replace x1 x2 with false.

See also: 2>true, >false.

Source file: <src/lib/data_stack.fs>.

See also: 2r>, 2r@, >r.

Source file: <src/kernel.z80s>.

Replace x1 x2 with true.

See also: 2>false, >true.

Source file: <src/lib/data_stack.fs>.

Move the cell pair x1 x2 from the data stack to the current xstack.

See also: 2x>, 2x@, >x.

Source file: <src/lib/data.xstack.fs>.

Fetch the cell pair x1 x2 stored at a. x2 is stored at a and x1 is stored at the next consecutive cell. It is equivalent to the sequence dup cell+ @ swap @.

Origin: Forth-79 (Double Number Word Set), Forth-83 (Double Number Extension Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: 2!, @, c@.

Source file: <src/kernel.z80s>.

Fetch xd from a. Return a', which is a incremented by two cells. This is handy for stepping through double-cell arrays.

See also: 2@, @+, c@+.

Source file: <src/lib/memory.MISC.fs>.

Define a 2-dimension array name with n1 x n2 items of n3 address units each.

See also: }}, 1array.

Source file: <src/lib/data.array.noble.fs>.

Return address a2 of element n of a 1-dimension single-cell array a1. 2array> is a common factor of 2avalue and 2avariable.

2array> is written in Z80. Its equivalent definition in Forth is the following:

Source file: <src/lib/data.array.COMMON.fs>.

Store xd into element n of 1-dimension double-cell values array name.

2ato is an immediate word.

See also: 2avalue, (2ato).

Source file: <src/lib/data.array.value.fs>.

Create a 1-dimension double-cell values array name with n elements and the execution semantics defined below.

name execution:

name ( n — xd )

Return contents xd of element n.

See also: 2ato, +2ato.

Source file: <src/lib/data.array.value.fs>.

Create a 1-dimension double-cell variables array name with n elements and the execution semantics defined below.

name execution:

name ( n — a )

Return address a of element n.

See also: avariable, cavariable, far2avariable.

Source file: <src/lib/data.array.variable.fs>.

Create a double fast constant name, with value x1 x2.

A double fast constant works like an ordinary 2constant, except its value is compiled as a literal.

Origin: IsForth’s const.

See: [2const], const, cconst.

Source file: <src/lib/data.const.fs>.

Create a definition for name with the executions semantics defined below:

name is referred to as a two-constant.

name Execution: ( — x1 x2 )

Place cell pair x1 x2 on the stack.

Origin: Forth-79 (Double Number Word Set), Forth-83 (Double Number Extension Word Set), Forth-94 (DOUBLE), Forth-2012 (DOUBLE).

Source file: <src/kernel.z80s>.

Source file: <src/kernel.z80s>.

Duplicate cell pair x1 x2.

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: dup, 2over, 2drop, 3dup.

Source file: <src/kernel.z80s>.

Create a double-cell entry "name" in associative list wid, with value dx.

Source file: <src/lib/data.associative-list.fs>.

Parse name. offset is the first double-cell aligned value greater than or equal to n1. n2 = offset + 2 cells.

Create a definition for name with the execution semantics defined below.

name execution: ( a1 — a2 )

Add the offset calculated during the compile-time action to a1 giving the address a2.

See also: begin-structure, +field.

Source file: <src/lib/data.begin-structure.fs>.

Source file: <src/kernel.z80s>.

Compile dx in the current definition.

2literal is an immediate and compile-only word.

Definition:

See also: 2lit, literal, cliteral, 1literal, ]2l.

Source file: <src/kernel.z80s>.

Drop n double cell items from the stack.

See also: ndrop, drop, 2drop.

Source file: <src/lib/data_stack.fs>.

See also: nip.

Source file: <src/lib/data_stack.fs>.

Source file: <src/kernel.z80s>.

See also: 2>r, 2r@, r>.

Source file: <src/kernel.z80s>.

See also: 2>r, 2r>, r@.

Source file: <src/kernel.z80s>.

Source file: <src/lib/return_stack.fs>.

Source file: <src/lib/data_stack.fs>.

Define a word name which, when executed, will cause that xd be stored at a.

Origin: variant of the word set found in Forth-79 (Reference Word Set) and Forth-83 (Appendix B. Uncontrolled Reference Words).

Source file: <src/lib/data.storer.fs>.

Source file: <src/kernel.z80s>.

Execute the switch switch for the key xd.

See also: switch:, :2clause.

Source file: <src/lib/flow.switch-colon.fs>.

Change the default behaviour of words created by 2val: make them store a new value instead of returning its actual one.

2toval and 2val are a non-parsing alternative to the standard to and 2value.

See also: toval, ctoval.

Source file: <src/lib/data.val.fs>.

Create a user double variable name in the first available offset within the user area. Execution of name leaves its absolute user area storage address.

See also: user, ucreate, uallot, ?user.

Source file: <src/lib/data.user.fs>.

Create a definition for name that will place x1 x2 on the stack (unless 2toval is used first) and then will execute init-2val.

2val is an alternative to the standard 2value.

See also: val, cval, 2variable, 2constant.

Source file: <src/lib/data.val.fs>.

Create a definition name with the following execution semantics: place x1 x2 on the stack.

Origin: Forth-94 (CORE EXT), Forth-2012 (CORE EXT).

See also: to, cvalue, value, 2constant, 2variable.

Source file: <src/lib/data.value.fs>.

Parse name. Create a definition for name with the execution semantics defined below. Reserve two consecutive cells of data space.

name is referred to as a two-variable.

name Execution: ( — a )

a is the address of the first (lower address) cell of two consecutive cells. A program is responsible for initializing the contents.

Origin: Forth-79 (Double Number Word Set), Forth-83 (Double Number Extension Word Set), Forth-94 (DOUBLE), Forth-2012 (DOUBLE).

Source file: <src/kernel.z80s>.

Move the cell pair x1 x2 from the current xstack to the data stack.

See also: 2>x, 2x@, x>.

Source file: <src/lib/data.xstack.fs>.

Copy the cell pair x1 x2 from the current xstack to the data stack.

Source file: <src/lib/data.xstack.fs>.

Remove the cell pair x1 x2 from the current xstack.

See also: xdrop.

Source file: <src/lib/data.xstack.fs>.

Duplicate the cell pair x1 x2 in the current xstack.

See also: xdup.

Source file: <src/lib/data.xstack.fs>.

Display d as an unsigned 32-bit binary number.

See also: 32hex., 16bin., 8bin., bin., binary.

Source file: <src/lib/display.numbers.fs>.

Display d as an unsigned 32-bit hexadecimal number.

See also: 32bin., 16hex., 8hex., hex., hex.

Source file: <src/lib/display.numbers.fs>.

See also: drop, 2drop, 4drop.

Source file: <src/lib/data_stack.fs>.

3dup is written is Z80. An equivalent definition in Forth is the following:

See also: dup, 2dup.

Source file: <src/lib/data_stack.fs>.

See also: drop, 2drop, 3drop.

Source file: <src/lib/data_stack.fs>.

x2 is the result of shifting x1 three bits toward the most-significant bit, filling the vacated least-significant bit with zero.

This is the same as 3 lshift or 2* 2* 2*, but faster.

See also: 2*, lshift.

Source file: <src/lib/math.operators.1-cell.fs>.

Display n as an unsigned 8-bit binary number.

See also: 8hex., 32bin., 16bin., bin., binary.

Source file: <src/lib/display.numbers.fs>.

Display d as an unsigned 8-bit hexadecimal number.

See also: 8bin., 16hex., 16hex., hex., hex.

Source file: <src/lib/display.numbers.fs>.

Parse name. Create a definition for name, called a "colon definition". Enter compilation state and start the current definition. Append the initiation semantics given below to the current definition.

Initiation: ( i*x — i*x ) ( R: — nest-sys )

Save implementation-dependent information nest-sys about the calling definition. The stack effects i*x represent arguments to name.

name execution: ( i*x — j*x )

Execute the definition name. The stack effects i*x and j*x represent arguments to and results from name, respectively.

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: ;, does>, header.

Source file: <src/kernel.z80s>.

Start the definition of a switch clause xd for switch switch.

See also: switch:, 2switch.

Source file: <src/lib/flow.switch-colon.fs>.

Compile the method for the selector name of the class class (not immediate!).

Source file: <src/lib/objects.mini-oof.fs>.

Start the definition of a switch clause c for switch switch.

See also: switch:, cswitch.

Source file: <src/lib/flow.switch-colon.fs>.

Start the definition of a switch clause x for switch switch.

See also: switch:, switch.

Source file: <src/lib/flow.switch-colon.fs>.

Create an execution token xt. Enter compilation state and start the current definition, which can be executed later by using xt.

Origin: Forth-94 (CORE EXT), Forth-2012 (CORE EXT).

Source file: <src/lib/define.MISC.fs>.

Create a code switch whose default action is given by xt. Leave the address of the head of its list on the stack.

The head of the switch structure is the address of a 2-cell structure:

See also: <switch, [switch.

Source file: <src/lib/flow.bracket-switch.fs>.

Compilation: Append the run-time semantics below to the current definition. End the current definition, allow it to be found in the dictionary and enter interpretation state.

Run-time: Return to the calling definition specified by nest-sys.

; is an immediate and compile-only word.

Definition:

Origin: fig-Forth, Forth-79 (Required Word Set), Forth-83 (Required Word Set), Forth-94 (CORE), Forth-2012 (CORE).

See also: exit, :, finish-code, ;code.