From ce2cd05f974de4c544b319b5ad6e788d9988bf60 Mon Sep 17 00:00:00 2001 From: crc <> Date: Mon, 8 Jan 2024 18:07:49 +0000 Subject: [PATCH] all words now have glossary data FossilOrigin-Name: 6011cfc3c51f784839ec281bc0639c79c03d901c3aecabe8004267bb4a349853 --- doc/Glossary-Concise.txt | 27 +++++++++ doc/Glossary-Names-and-Stack.txt | 9 +++ doc/Glossary.html | 63 ++++++++++++++++++++ doc/Glossary.txt | 99 ++++++++++++++++++++++++++++++++ doc/words.tsv | 9 +++ 5 files changed, 207 insertions(+) diff --git a/doc/Glossary-Concise.txt b/doc/Glossary-Concise.txt index 8ca6086..4faa10d 100644 --- a/doc/Glossary-Concise.txt +++ b/doc/Glossary-Concise.txt @@ -244,12 +244,18 @@ Returns `0`, the value used to indicate a FALSE result. FREE D: -n A: - F: - Returns the number of cells available to your application. This is the amount of memory, less the already consumed portion and buffers mapped for Retro's internal use. +HOME D: -s A: - F: - +Hold the path to the users home directory. + Heap D: -a A: - F: - Variable. Holds the address of the next available cell. I D: -n A: - F: - Access the loop index for the current loop. (For loops made using `indexed-times`) +Ignoring D: -a A: - F: - +Variable. When TRUE, ignore input to end of line. + J D: -n A: - F: - Access the parent loop index for the current loop. (For loops made using `indexed-times`) @@ -1261,6 +1267,27 @@ Scan the I/O devices for a device with a specified ID. Returns the device number io:unix-syscall D: ...n- A: - F: - Trigger a Unix system call. This is not intended to be used directly. +library:.CONFIG D: -s A: - F: - +Data. Return a template for a library file name in `~/.config/retroforth/library`. + +library:.config D: s-s A: - F: - +Find the users home directory and construct a filename for a library in the `~/.config/retroforth/library` directory. + +library:CWD D: -s A: - F: - +Data. Return a template for a library file name in `./library`. + +library:contains? D: s-f A: - F: - +Check to see if a library exists. + +library:cwd D: s-s A: - F: - +Construct a filename for a library in the `~/library` directory. + +library:filename D: s-s A: - F: - +Given a library name, construct the actual filename to load. + +library:load D: s- A: - F: - +Load a library. This will load the string, with ".retro". + listen D: - A: - F: - "Run interactive ""listener"" (a REPL)." diff --git a/doc/Glossary-Names-and-Stack.txt b/doc/Glossary-Names-and-Stack.txt index 8160a9c..2eaf33a 100644 --- a/doc/Glossary-Names-and-Stack.txt +++ b/doc/Glossary-Names-and-Stack.txt @@ -80,8 +80,10 @@ END D: - A: - F: - EOM D: -a A: - F: - FALSE D: -n A: - F: - FREE D: -n A: - F: - +HOME D: -s A: - F: - Heap D: -a A: - F: - I D: -n A: - F: - +Ignoring D: -a A: - F: - J D: -n A: - F: - K D: -n A: - F: - RewriteUnderscores D: -a A: - F: - @@ -419,6 +421,13 @@ io:invoke D: n- A: - F: - io:query D: n-mN A: - F: - io:scan-for D: n-m A: - F: - io:unix-syscall D: ...n- A: - F: - +library:.CONFIG D: -s A: - F: - +library:.config D: s-s A: - F: - +library:CWD D: -s A: - F: - +library:contains? D: s-f A: - F: - +library:cwd D: s-s A: - F: - +library:filename D: s-s A: - F: - +library:load D: s- A: - F: - listen D: - A: - F: - lt? D: nn-f A: - F: - lteq? D: nn-f A: - F: - diff --git a/doc/Glossary.html b/doc/Glossary.html index 7f76f92..c243d7d 100644 --- a/doc/Glossary.html +++ b/doc/Glossary.html @@ -599,6 +599,13 @@

Returns the number of cells available to your application. This is the amount of memory, less the already consumed portion and buffers mapped for Retro's internal use.

Class: class:word
Namespace: global
Interface Layer: all
+

HOME

+

Data: -s
+Addr: -
+Float: -

+
+

Hold the path to the users home directory.

+
Class: class:data
Namespace: global
Interface Layer: rre

Heap

Data: -a
Addr: -
@@ -613,6 +620,13 @@

Access the loop index for the current loop. (For loops made using `indexed-times`)

Class: class:word
Namespace: global
Interface Layer: all
+

Ignoring

+

Data: -a
+Addr: -
+Float: -

+
+

Variable. When TRUE, ignore input to end of line.

+
Class: class:data
Namespace: global
Interface Layer: all

J

Data: -n
Addr: -
@@ -3115,6 +3129,55 @@

Trigger a Unix system call. This is not intended to be used directly.

Class: class:word
Namespace: io
Interface Layer: rre
+

library:.CONFIG

+

Data: -s
+Addr: -
+Float: -

+
+

Data. Return a template for a library file name in `~/.config/retroforth/library`.

+
Class: class:data
Namespace: global
Interface Layer: rre
+

library:.config

+

Data: s-s
+Addr: -
+Float: -

+
+

Find the users home directory and construct a filename for a library in the `~/.config/retroforth/library` directory.

+
Class: class:word
Namespace: global
Interface Layer: rre
+

library:CWD

+

Data: -s
+Addr: -
+Float: -

+
+

Data. Return a template for a library file name in `./library`.

+
Class: class:data
Namespace: global
Interface Layer: rre
+

library:contains?

+

Data: s-f
+Addr: -
+Float: -

+
+

Check to see if a library exists.

+
Class: class:word
Namespace: global
Interface Layer: rre
+

library:cwd

+

Data: s-s
+Addr: -
+Float: -

+
+

Construct a filename for a library in the `~/library` directory.

+
Class: class:word
Namespace: global
Interface Layer: rre
+

library:filename

+

Data: s-s
+Addr: -
+Float: -

+
+

Given a library name, construct the actual filename to load.

+
Class: class:word
Namespace: global
Interface Layer: rre
+

library:load

+

Data: s-
+Addr: -
+Float: -

+
+

Load a library. This will load the string, with ".retro".

+
Class: class:word
Namespace: global
Interface Layer: rre

listen

Data: -
Addr: -
diff --git a/doc/Glossary.txt b/doc/Glossary.txt index f18bb50..747d739 100644 --- a/doc/Glossary.txt +++ b/doc/Glossary.txt @@ -933,6 +933,17 @@ Returns the number of cells available to your application. This is the amount of Class: class:word | Namespace: global | Interface Layer: all ------------------------------------------------------------------------ +HOME + + Data: -s + Addr: - + Float: - + +Hold the path to the users home directory. + +Class: class:data | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + Heap Data: -a @@ -955,6 +966,17 @@ Access the loop index for the current loop. (For loops made using `indexed-times Class: class:word | Namespace: global | Interface Layer: all ------------------------------------------------------------------------ +Ignoring + + Data: -a + Addr: - + Float: - + +Variable. When TRUE, ignore input to end of line. + +Class: class:data | Namespace: global | Interface Layer: all +------------------------------------------------------------------------ + J Data: -n @@ -4833,6 +4855,83 @@ Trigger a Unix system call. This is not intended to be used directly. Class: class:word | Namespace: io | Interface Layer: rre ------------------------------------------------------------------------ +library:.CONFIG + + Data: -s + Addr: - + Float: - + +Data. Return a template for a library file name in `~/.config/retroforth/library`. + +Class: class:data | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + +library:.config + + Data: s-s + Addr: - + Float: - + +Find the users home directory and construct a filename for a library in the `~/.config/retroforth/library` directory. + +Class: class:word | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + +library:CWD + + Data: -s + Addr: - + Float: - + +Data. Return a template for a library file name in `./library`. + +Class: class:data | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + +library:contains? + + Data: s-f + Addr: - + Float: - + +Check to see if a library exists. + +Class: class:word | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + +library:cwd + + Data: s-s + Addr: - + Float: - + +Construct a filename for a library in the `~/library` directory. + +Class: class:word | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + +library:filename + + Data: s-s + Addr: - + Float: - + +Given a library name, construct the actual filename to load. + +Class: class:word | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + +library:load + + Data: s- + Addr: - + Float: - + +Load a library. This will load the string, with ".retro". + +Class: class:word | Namespace: global | Interface Layer: rre +------------------------------------------------------------------------ + listen Data: - diff --git a/doc/words.tsv b/doc/words.tsv index 4a936a7..b51187f 100644 --- a/doc/words.tsv +++ b/doc/words.tsv @@ -80,8 +80,10 @@ END - - - Used to denote the end of a linked list. The last cons will have the c EOM -a - - Constant. Returns the last addressable memory address. class:word {n/a} {n/a} global all FALSE -n - - Returns `0`, the value used to indicate a FALSE result. class:word {n/a} {n/a} global all FREE -n - - Returns the number of cells available to your application. This is the amount of memory, less the already consumed portion and buffers mapped for Retro's internal use. class:word {n/a} {n/a} global all +HOME -s - - Hold the path to the users home directory. class:data {n/a} {n/a} global rre Heap -a - - Variable. Holds the address of the next available cell. class:data {n/a} {n/a} global all I -n - - Access the loop index for the current loop. (For loops made using `indexed-times`) class:word {n/a} {n/a} global all +Ignoring -a - - Variable. When TRUE, ignore input to end of line. class:data {n/a} {n/a} global all J -n - - Access the parent loop index for the current loop. (For loops made using `indexed-times`) class:word {n/a} {n/a} global all K -n - - Access the grandparent loop index for the current loop. (For loops made using `indexed-times`) class:word {n/a} {n/a} global all RewriteUnderscores -a - - Variable. When set to `TRUE`, Retro will replace underscores in strings with spaces. When `FALSE`, Retro does not. class:data {n/a} {n/a} global all @@ -419,6 +421,13 @@ io:invoke n- - - Invoke an interaction with an I/O device. class:word {n/a} {n io:query n-mN - - Ask an I/O device to identify itself. Returns a version (m) and device ID (N). class:word {n/a} {n/a} io all io:scan-for n-m - - Scan the I/O devices for a device with a specified ID. Returns the device number, or -1 if not found. class:word {n/a} {n/a} io all io:unix-syscall ...n- - - Trigger a Unix system call. This is not intended to be used directly. class:word {n/a} {n/a} io rre +library:.CONFIG -s - - Data. Return a template for a library file name in `~/.config/retroforth/library`. class:data {n/a} {n/a} global rre +library:.config s-s - - Find the users home directory and construct a filename for a library in the `~/.config/retroforth/library` directory. class:word {n/a} {n/a} global rre +library:CWD -s - - Data. Return a template for a library file name in `./library`. class:data {n/a} {n/a} global rre +library:contains? s-f - - Check to see if a library exists. class:word {n/a} {n/a} global rre +library:cwd s-s - - Construct a filename for a library in the `~/library` directory. class:word {n/a} {n/a} global rre +library:filename s-s - - Given a library name, construct the actual filename to load. class:word {n/a} {n/a} global rre +library:load s- - - Load a library. This will load the string, with ".retro". class:word {n/a} {n/a} global rre listen - - - "Run interactive ""listener"" (a REPL)." class:word {n/a} {n/a} global rre lt? nn-f - - Compare n1 and n2. Return `TRUE` if n1 is less than n2, or `FALSE` otherwise. class:primitive {n/a} {n/a} global all lteq? nn-f - - Compare n1 and n2. Return `TRUE` if n1 is less than or equal to n2, or `FALSE` otherwise. class:word {n/a} {n/a} global all