From ac6a452df1c5c5c9d2fc3118278fddc913df1faa Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Fri, 16 Oct 2020 07:12:38 -0700
Subject: env-hash: now persistent and synced with setenv.

* sysif.c (env_hash): Function renamed to get_env_hash and a
static variable named env_hash introduced.
Function returns a previously allocated hash table, if
it exists, except in compat mode.
(getenv_wrap): Stash the result into the hash also.
(setenv_wrap): Keep the hash up-to-date with the action of
setenv.
(unsetenv_wrap): Also delete from the hash.
(sysif_init): Protect the env_hash variable from gc.

* txr.1: Documented, with compat notes.
---
 txr.1 | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 63 insertions(+), 3 deletions(-)

(limited to 'txr.1')

diff --git a/txr.1 b/txr.1
index d03525a5..6512ff9c 100644
--- a/txr.1
+++ b/txr.1
@@ -58879,10 +58879,28 @@ function.
 .desc
 The
 .code env-hash
-function constructs and returns an
+function returns an
 .code :equal-based
-hash.  The hash is
-populated with the environment variables, represented as key-value pairs. 
+hash whose keys and values are strings. The hash table is populated populated
+with the environment variables, represented as key-value character string
+pairs.
+
+The
+.code env-hash
+function allocates the hash table when it is first invoked; thereafter,
+it returns the same hash table.
+
+The hash table is updated by the functions
+.codn setenv ,
+.code unsetenv
+and
+.codn getenv .
+
+Note: calls to the underlying C library functions
+.code setenv
+and
+.codn getenv ,
+and other direct manipulations of the environment, will not update the hash table.
 
 .coNP Functions @, getenv @ setenv and @ unsetenv
 .synb
@@ -58989,6 +59007,43 @@ is restored by the
 .code unwind-protect
 cleanup form.
 
+These functions interact with the list returned by the
+.code env
+function and with the hash table returned by the
+.code env-hash
+function as follows.
+
+A previously returned list returned by
+.code env
+is not modified. The
+.code setenv
+and
+.code unsetenv
+functions may cause a subsequent call to
+.code env
+to return a different list. The
+.code getenv
+function has no effect on the list.
+
+The hash table previously returned by
+.code env-hash
+is modified by
+.code setenv
+in the manner consistent with its semantics. A new entry is created in the table,
+if required, and an existing entry is overwritten only if the
+.code overwrite-p
+flag is specified. Likewise, if
+.code setenv
+is invoked in a way that causes the environment variable to be deleted, it
+is removed from the hash also.
+The
+.code unsetenv
+function causes the variable to be removed from the hash table also.
+The
+.code getenv
+function accesses the underlying environment, and updates the hash
+table with the name-value pair which is retrieved.
+
 .SS* Command Line Option Processing
 
 \*(TL provides a support for recognizing, extracting and validating
@@ -75551,6 +75606,11 @@ of these version values, the described behaviors are provided if
 is given an argument which is equal or lower. For instance
 .code "-C 103"
 selects the behaviors described below for version 105, but not those for 102.
+.IP 244
+Until \*(TX 244, the
+.code env-hash
+function returned a new hash table each time it was called. The behavior is
+restored if 244 or older compatibility is selected.
 .IP 243
 Two mistakes in the pseudo-random-number generator (PRNG) were discovered,
 affecting \*(TX 243 and older. Using this compatibility value, or lower, will
-- 
cgit v1.2.3