config -- Forth system specific words

Module description

config -- Forth system specific words: The config module contains the extension and missing words for a forth system.

System Settings

end-of-line ( -- c-addr ): Counted string for the end of line for the current system

#bits/byte ( -- n ): Number of bits in a byte

#bits/char ( -- n ): Number of bits in a char

#bits/cell ( -- n ): Number of bits in a cell

bigendian? ( -- flag ): Check for bigendian hardware

Extension words

ms@ ( -- u ): Fetch milliseconds timer

max-ms@ ( -- u ): Maximum value of the milliseconds timer

#args ( -- n ): Get the number of command line arguments

arg@ ( n -- c-addr u ): Get the nth command line argument

<w@ ( w-addr -- n ): Fetch a word, 16 bit, sign extend

<l@ ( l-addr -- n ): Fetch a long word, 32 bit, sign extend

Float extension constants

0e+0 ( F: -- r ): Float constant 0.0

1e+0 ( F: -- r ): Float constant 1.0

2e+0 ( F: -- r ): Float constant 2.0

Exceptions

exp-index-out-of-range ( -- n ): Index out of range exception number

exp-invalid-state ( -- n ): Invalid state exception number

exp-no-data ( -- n ): No data available exception number

exp-invalid-parameters ( -- n ): Invalid parameters on stack

exp-wrong-file-type ( -- n ): Wrong file type

exp-wrong-file-version ( -- n ): Wrong file version

exp-wrong-file-data ( -- n ): Wrong file data

exp-wrong-checksum ( -- n ): Wrong checksum

exp-wrong-length ( -- n ): Wrong length

exp-invalid-data ( -- n ): Invalid data exception number

Toolbelt

Generated by fsdocgen 0.1.0