From 03699dd7d47cbf95552bed02e5c37f078528a3b2 Mon Sep 17 00:00:00 2001
From: Kaz Kylheku <kaz@kylheku.com>
Date: Wed, 12 Oct 2016 20:46:47 -0700
Subject: New accessor: hash-userdata.

The get-hash-userdata function is now deprecated in favor of
hash-userdata, which is an accessor.

* hash.c (hash_init): Register hash-userdata as a synonym
for the same function as get-hash-userdata.

* share/txr/stdlib/place.tl (hash-userdata): New defplace.

* txr.1: Document new accessor, marking get-hash-userdata as a
deprecated synonym.  Replace references to get-hash-userdata
with references to hash-userdata.
---
 txr.1 | 43 ++++++++++++++++++++++++++++++++++++-------
 1 file changed, 36 insertions(+), 7 deletions(-)

(limited to 'txr.1')

diff --git a/txr.1 b/txr.1
index c6842dd4..f19603cc 100644
--- a/txr.1
+++ b/txr.1
@@ -10424,7 +10424,7 @@ keyword is present,
 it must be followed by an object; that object
 specifies the hash table's user data, which
 can be retrieved using the
-.code get-hash-userdata
+.code hash-userdata
 function.
 
 An empty list can be specified as
@@ -15231,7 +15231,7 @@ if they use the same equality (both are
 or both are the default
 .codn :eql-based ),
 if their associated user data elements are equal (see the function
-.codn get-hash-userdata ),
+.codn hash-userdata ),
 if their sets of keys are identical, and if the data items associated with
 corresponding keys from each respective hash are
 .code equal
@@ -33215,7 +33215,7 @@ If
 .code :userdata
 is present, it must be followed by an argument value; that value
 specifies the user data for the hash table, which can be retrieved using the
-.code get-hash-userdata
+.code hash-userdata
 function.
 
 If a hash table has weak keys, this means that from the point of view
@@ -33729,16 +33729,45 @@ function returns an integer representing the number of
 key-value pairs stored in
 .metn hash .
 
-.coNP Function @ get-hash-userdata
+.coNP Accessor @ hash-userdata
 .synb
-.mets (get-hash-userdata << hash )
+.mets (hash-userdata << hash )
+.mets (set (hash-userdata << hash ) << new-value )
 .syne
 .desc
-This function retrieves the user data object associated with
+The
+.code hash-userdata
+function retrieves the user data object associated with
 .metn hash .
-The user data object of a newly-created hash table is initialized to
+
+A hash table can be created with user data using the
+.code :userdata
+keyword in a hash table literal or in a call to the
+.code hash
+function, directly, or via other hash-constructing functions which take the
+hash construction keywords, such as
+.codn group-by .
+If a hash table is created without user data, its user
+data is initialized to
 .codn nil .
 
+Because
+.code hash-userdata
+is an accessor, a
+.code hash-userdata
+form can be used as a place. Assigning a value to this place
+causes the user data of
+.meta hash
+to be replaced with that value.
+
+.coNP Function @ get-hash-userdata
+.synb
+.mets (get-hash-userdata << hash )
+.syne
+.desc
+This function is a deprecated synonym for
+.codn hash-userdata .
+
 .coNP Function @ set-hash-userdata
 .synb
 .mets (set-hash-userdata < hash << object )
-- 
cgit v1.2.3