--- gforth/environ.fs 1999/02/03 00:10:19 1.18 +++ gforth/environ.fs 2000/08/17 12:48:01 1.23 @@ -21,14 +21,15 @@ \ wordlist constant environment-wordlist Create environment-wordlist ( -- wid ) \ gforth - \G wid identifies the word list that is searched by environmental + \G @i{wid} identifies the word list that is searched by environmental \G queries. wordlist drop : environment? ( c-addr u -- false / ... true ) \ core environment-query - \G c-addr, u specify the address and length of a string. If the string is - \G not recognised, return a @code{false} flag. Otherwise return a true - \G flag and some (string-specific) information about the queried string. + \G @i{c-addr, u} specify a counted string. If the string is not + \G recognised, return a @code{false} flag. Otherwise return a + \G @code{true} flag and some (string-specific) information about + \G the queried string. environment-wordlist search-wordlist if execute true else @@ -49,7 +50,7 @@ get-order environment-wordlist swap 1+ s \ this should be computed in C as CHAR_BITS/sizeof(char), \ but I don't know any machine with gcc where an au does not have 8 bits. 8 constant ADDRESS-UNIT-BITS ( -- n ) \ environment -\G Size of one address unit, it bits. +\G Size of one address unit, in bits. 1 ADDRESS-UNIT-BITS chars lshift 1- constant MAX-CHAR ( -- u ) \ environment \G Maximum value of any character in the character set @@ -70,7 +71,7 @@ true constant CORE-EXT ( -- f ) \ enviro \G True if the complete core extension word set is present. Always true for Gforth. 1 -3 mod 0< constant FLOORED ( -- f ) \ environment -\G True if division is floored by default. +\G True if @code{/} etc. perform floored division 1 ADDRESS-UNIT-BITS cells 1- lshift 1- constant MAX-N ( -- n ) \ environment \G Largest usable signed integer. @@ -85,10 +86,9 @@ true constant CORE-EXT ( -- f ) \ enviro \G Largest usable unsigned double. version-string 2constant gforth ( -- c-addr u ) \ gforth-environment -\G Counted string representing a version string for this version of Gforth -\G (for versions>0.3.0). -\ the version strings of the various versions are guaranteed to be -\ sorted lexicographically +\G Counted string representing a version string for this version of +\G Gforth (for versions>0.3.0). The version strings of the various +\G versions are guaranteed to be ordered lexicographically. : return-stack-cells ( -- n ) \ environment \G Maximum size of the return stack, in cells. @@ -99,8 +99,8 @@ version-string 2constant gforth ( -- c-a [ forthstart 4 cells + ] literal @ cell / ; : floating-stack ( -- n ) \ environment - \G n is non-zero, showing that Gforth maintains a separate - \G floating-point stack of depth n. + \G @var{n} is non-zero, showing that Gforth maintains a separate + \G floating-point stack of depth @var{n}. [ forthstart 5 cells + ] literal @ [IFDEF] float float [ELSE] [ 1 floats ] Literal [THEN] / ;