From: Ralph Ronnquist Date: Thu, 3 Jun 2021 11:08:26 +0000 (+1000) Subject: document the INPUT word X-Git-Url: https://git.rrq.au/?a=commitdiff_plain;h=8a2d8dc0e8ff7f3e6b402d2d496169d19d032db5;p=rrq%2Frrqforth.git document the INPUT word --- diff --git a/adoc/p_input.adoc b/adoc/p_input.adoc new file mode 100644 index 0000000..d5f8022 --- /dev/null +++ b/adoc/p_input.adoc @@ -0,0 +1,13 @@ +// compile.asm: WORD p_input,'INPUT',dovariable + +anchor:p_input[] + +=== Word: INPUT + +.... +Data stack: ( -- a ) +.... + +"INPUT" is a variable word for the input stream buffer used by +<>. + diff --git a/reference.adoc b/reference.adoc index 9175d73..1700ddf 100644 --- a/reference.adoc +++ b/reference.adoc @@ -153,6 +153,8 @@ include::adoc/p_ifbreak.adoc[] include::separator.adoc[] include::adoc/p_immediate.adoc[] include::separator.adoc[] +include::adoc/p_input.adoc[] +include::separator.adoc[] include::adoc/p_left_bracket.adoc[] include::separator.adoc[] include::adoc/p_lessequal.adoc[] diff --git a/reference.html b/reference.html index f49869a..0fc06e1 100644 --- a/reference.html +++ b/reference.html @@ -832,7 +832,8 @@ asciidoc.install();

IF   IFAGAIN   IFBREAK   -IMMEDIATE  

+IMMEDIATE   +INPUT  

LIT   LOAD-FILE"  

MAIN-ARGS   @@ -2338,6 +2339,19 @@ the most recent word to 1, thereby making that word an immediate word.

_______________________________________________________
+

+ +
+

Word: INPUT

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

"INPUT" is a variable word for the input stream buffer used by +EVALUATE-STREAM.

+
+_______________________________________________________ +

@@ -3397,7 +3411,7 @@ is deepest.

diff --git a/wordindex.adoc b/wordindex.adoc index 8623a0b..ebac853 100644 --- a/wordindex.adoc +++ b/wordindex.adoc @@ -105,6 +105,7 @@ xref:p_if[IF] {nbsp} xref:p_ifagain[IFAGAIN] {nbsp} xref:p_ifbreak[IFBREAK] {nbsp} xref:p_immediate[IMMEDIATE] {nbsp} +xref:p_input[INPUT] {nbsp} xref:p_literal[LIT] {nbsp} xref:p_load_file_quote[LOAD-FILE"] {nbsp}