X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;ds=sidebyside;f=reference.html;h=9137d075cfd0bd68e35fda305d8050d21cc8f636;hb=7a99f2ed7cfe55f3aa69560b31c055ce45fe1f0c;hp=9cb4b59609eabf30834431443a2a66a96331f340;hpb=3080215f0d03403858b04f5bab8332a9b66a4adf;p=rrq%2Frrqforth.git diff --git a/reference.html b/reference.html index 9cb4b59..9137d07 100644 --- a/reference.html +++ b/reference.html @@ -786,7 +786,8 @@ asciidoc.install(); >R   R@   R>   -R[n]  

+R[n]   +D[n]  

DATA-STACK   RETURN-STACK     @@ -850,7 +851,9 @@ asciidoc.install(); LOAD-BUFFER-SIZE   LOAD-FILE  

MAIN-ARGS   -MALLOC  

+MALLOC   +MIN   +MAX  

NEGATE   NIP   NL   @@ -864,6 +867,7 @@ asciidoc.install(); PROGRAM_VERSION  

QUIT  

READ-STREAM-CHAR   +READ-STREAM-LINE   READ-WORD   REALLOC   RETURN   @@ -884,7 +888,9 @@ asciidoc.install();

TELL   .TEMP   TEMP   +TEMPHELD   TEMPSPACE   +TEMPUSED   TERMINATE0   TFA>CFA   TFA>DFA   @@ -1194,6 +1200,19 @@ also is incremented accordingly.

_______________________________________________________
+

+
+
+

Word: D[n]

+
+
+
Data stack: ( n -- a )
+
+

"D[n]" is a function word that pushes the address for the n:th cell of +the data stack onto the data stack.

+
+_______________________________________________________ +

@@ -1396,7 +1415,8 @@ _______________________________________________________

"ARGS" is a value word that holds a pointer to the command line data block which consists of a count cell followed by that many asciiz -pointers and then a 0 cell.

+pointers and then a 0 cell. That is next followed by the environment +as a number of asciiz pointers and a 0 cell.

@@ -1404,9 +1424,10 @@ pointers and then a 0 cell.

ARGS -> 8 bytes: count of non-zero asciiz pointers following
         8 bytes: command name string
-        8 bytes: first argument string
-        8* ...
-        8 zero
+ 8* bytes: argument strings + 8 bytes: zero cell + 8* bytes: envirnment strings + 8 bytes: zero cell
@@ -2754,6 +2775,32 @@ page" of mmap for details.

_______________________________________________________
+

+ +
+

Word: MAX

+
+
+
Data stack: ( v1 v2 -- v3 )
+
+

"MAX" is a function word that selects the greatest of v1 and v2. To +that end, the values are 64-bit signed integers.

+
+_______________________________________________________ +
+

+
+
+

Word: MIN

+
+
+
Data stack: ( v1 v2 -- v3 )
+
+

"MIN" is a function word that selects the least of v1 and v2. To that +end, the values are 64-bit signed integers.

+
+_______________________________________________________ +

@@ -3038,8 +3085,8 @@ _______________________________________________________ 
Data stack: ( n -- a )
-

"R[n]" is a function word that pushes the address for the n:th cell on -the top return stack value onto the data stack.

+

"R[n]" is a function word that pushes the address for the n:th cell of +the return stack onto the data stack.

@@ -3069,6 +3116,22 @@ instead.

_______________________________________________________
+

+
+
+

Word: READ-STREAM-LINE

+
+
+
Data stack: ( stream -- n )
+
+

"READ-STREAM-LINE" is a function word that gets the next line from the +given stream buffer into PAD and returns number of characters. If the +stream is backed by a file descriptor, the stream buffer is refilled +from there as needed, by a SYS_READ call when more characters are +needed.

+
+_______________________________________________________ +

@@ -3490,6 +3553,22 @@ small and short-lived data areas.

_______________________________________________________
+

+
+
+

Word: TEMPHELD

+
+
+
Data stack: ( -- a )
+
+

"TEMPHELD" is a variable word that keeps the lowest offset of the +TEMPSPACE space to reuse upon cycling. The space +below TEMPHELD is "held" in the sense of not being reused upon +cycling. An application may change the TEMPSPACE offset as needed to +dynamically preserve memory longer term.

+
+_______________________________________________________ +

@@ -3523,6 +3602,22 @@ overlapping a prior request.

_______________________________________________________
+

+ +
+

Word: TEMPUSED

+
+
+
Data stack: ( -- a )
+
+

"TEMPUSED" is a variable word that keeps the lowest offset of the +TEMPSPACE space to use next as temporary space. This +is advance upon each allocation via TEMP, and recycled back +to TEMPHELD when next allocation otherwise would exceed +the space size.

+
+_______________________________________________________ +

@@ -3830,7 +3925,7 @@ is deepest.