Data stack: ( v -- )
+X-Git-Url: https://git.rrq.au/?a=blobdiff_plain;ds=sidebyside;f=reference.html;h=9cb4b59609eabf30834431443a2a66a96331f340;hb=2c1ddb0d590be01213e6aab07bc5d073b0d3c567;hp=7b6cb8a76ba03b4ffab29e3c1afa8e80369db11c;hpb=b49fed131d5a7806d0737bdc6f9b693c64753cf2;p=rrq%2Frrqforth.git diff --git a/reference.html b/reference.html index 7b6cb8a..9cb4b59 100644 --- a/reference.html +++ b/reference.html @@ -770,13 +770,19 @@ asciidoc.install(); ! C@ C! +W@ +W! +D@ +D! 2@ 2! !+ @n++ @n-- C, -S" +W, +D, +S" >R R@ R> @@ -801,10 +807,12 @@ asciidoc.install(); BEGIN BREAK
MAIN-ARGS @@ -857,6 +866,7 @@ asciidoc.install();
@@ -865,6 +875,7 @@ asciidoc.install(); STDIN STREAM STREAM-NCHARS +STR>TEMP STRLEN STRNCMP STRNCPY @@ -872,6 +883,8 @@ asciidoc.install(); SYSTEMTELL .TEMP +TEMP +TEMPSPACE TERMINATE0 TFA>CFA TFA>DFA @@ -881,7 +894,8 @@ asciidoc.install(); THIS-WORD TRUE TUCK
Data stack: ( v -- )
+"W," (W-comma) is a function word that puts a "word" (double-byte) on +the HERE heap. The two least significant bytes of the value +are put at the current free head address, which also is incremented +accordingly.
Data stack: ( v -- )
+"D," (D-comma) is a function word that puts a "double word" +(double-byte) on the HERE heap. The four least significant +bytes of the value are put at the current free head address, which +also is incremented accordingly.
Data stack: ( cfa -- tfa )
+"CFA>TFA" is a function word that pushes word tfa of the given cfa.
Data stack: ( a -- v )
+"W@" is a function word that pushes the "word" (double-byte) value v +from the address a.
Data stack: ( -- v ) Return stack: ( v -- v )
+"R@" is a function word that "copies" the top return stack value onto +the data stack.
Data stack: ( v a -- )
+"W!" is a function word that stores the "word" (2-byte) value v (the +two least significant bytes of the cell) at the address a.
Data stack: ( v a -- )
+"D!" is a function word that stores the "doublw word" (4-byte) value v +(the four least significant bytes of the cell) at the address a.
Data stack: ( -- v ) Return stack: ( v -- v )
@@ -1634,6 +1766,27 @@ _______________________________________________________
Data stack: ( wordlist -- )
+"DEFINITIONS" is a function word that installs the given wordlist as +the CURRENT-WORDLIST one.
Data stack: ( -- )
+Data stack: ( v -- )
"EXIT" is a function word that implements the ending of a FORTH -definition and its threading to the subsequent step of the calling -definition.
"EXIT" is a function word that terminates the rrqforth
process
+immediately with the given exit code.
Data stack: ( -- chars* n )
"S"" is a function word that pushes the [n:char] pointer for a string -inlined subsequently to it in the containing definition. This is -similar to LIT but for a string literal.
"LIT-STRING" is a function word that pushes the char* and length n of +a subsequent inline string, then advances execution to continue after +the string. This is similar to LIT but for a block literal.
Note that the inlined byte count includes the terminating NUL byte.
Data stack: ( -- ) Input stream: " chars"
"S"" is an immediate function word that compiles the subseqent +characters up to terminating double-quote into the current definition, +preceded by a LIT-STRING cell, and the count of +bytes scanned. The inline text includes a terminating NUL character +which also is included in the inlined count.
Note that "S"" uses " for reading the string.
Data stack: ( -- )
+"RETURN" is a function word that implements the ending of a FORTH +definition and make execution return to the next step in the calling +definition.
compile.asm: WORD p_right_bracket,],fasm
Data stack: ( -- )
";" (semi-colon) is a function word that ends a new forth definition -by means of adding an EXIT
";" (semi-colon) is an immediate function word that ends a new forth +definition by means of adding an EXIT cell, then changing +<<p_state,STATE> to interpreting.
"STR>TEMP" is a function word that copies a given string plus a +terminating NUL character into a TEMPSPACE snippet, +all preceded by a length cell. It returns a pointer for to the text in +the snippet and its length, excluding the NUL character at end and the +length cell before tie text.
length: 8 bytes
+returned char*: n bytes
+ nul: 1 byte
+"TEMP" is a function word that "allocates" a TEMPSPACE +area of given size and returns its base address. The allocation is +temporary and only valid until there is a later allocation that +overruns this area.
Allocations are done in succession until the requested size overruns +the TEMPSPACE. If so, the allocation pointer is reset +and the space is allocated from start again. This is all intended for +small and short-lived data areas.
Data stack: ( -- a )
+"TEMPSPACE" is a variable word that holds three cells the for managing +"temporary memory":
+the size of the temporary memory space (default 104857600 bytes) +
++the base address for whole temporary memory area +
++the amount currently used +
+This memory is intended to be used by requesting snippets of memory in +a cyclic fashion via TEMP without concern about it possibly +overlapping a prior request.
Data value: ( wordlist -- ) Input stream: word
+"USE" is a function word that looks up next word given the wordlist. +It reads next word on INPUT via READ-WORD, +then temporarily changes CURRENT-WORDLIST to +FIND the word via the given wordlist, and returns the TFA +of that word, or just 0 if the word coudn’t be found.