summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2016-12-20 11:04:30 -0800
committerKaz Kylheku <kaz@kylheku.com>2016-12-20 11:04:30 -0800
commitc754352c724712482fcc1a612080f930e14ad632 (patch)
tree940eb21fe9f609619315af25f2b9b86a6eab1ce6
parentff6f02a23e3fb2fa29f086ea90f81250fba25ea8 (diff)
downloadtxr-c754352c724712482fcc1a612080f930e14ad632.tar.gz
txr-c754352c724712482fcc1a612080f930e14ad632.tar.bz2
txr-c754352c724712482fcc1a612080f930e14ad632.zip
doc: document place expander hashes.
* txr.1: Document *place-update-expander*, *place-clobber-expander* and *place-delete-expander*.
-rw-r--r--txr.117
1 files changed, 17 insertions, 0 deletions
diff --git a/txr.1 b/txr.1
index 4ae879cd..6f8021b7 100644
--- a/txr.1
+++ b/txr.1
@@ -30400,6 +30400,23 @@ treat the situation in a satisfactory way using a
definition, which effectively then supplies inline code whenever a certain form
is used as a place, and that code itself is treated as a place.
+.coNP Special variables @, *place-update-expander* @ *place-clobber-expander* and @ *place-delete-expander*
+.desc
+These variables hold hash tables, by means of which update expanders,
+clobber expanders and delete expanders are registered, as associations
+between symbols and functions.
+
+If
+.code "[*place-update-expander* 'sym]"
+yields a function, then symbol
+.code sym
+is the basis for a syntactic place. If the expression yields
+.codn nil ,
+then forms beginning with
+.code sym
+are not syntactic places. (The situation of a clobber accessor or delete
+accessor being defined without an update expander is improper).
+
.SS* Quasiquote Operator Syntax
.coNP Macro @ qquote
.synb