summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKaz Kylheku <kaz@kylheku.com>2022-04-26 07:53:24 -0700
committerKaz Kylheku <kaz@kylheku.com>2022-04-26 07:53:24 -0700
commit5c834d64a58d7176ff246431074707f4bf0f2abf (patch)
tree857b3bbe6a0152a3ff6ba421c618cd67863260f5
parent125d02c3c9b6a70ae43a6139ad9e83d1a6aa069a (diff)
downloadtxr-5c834d64a58d7176ff246431074707f4bf0f2abf.tar.gz
txr-5c834d64a58d7176ff246431074707f4bf0f2abf.tar.bz2
txr-5c834d64a58d7176ff246431074707f4bf0f2abf.zip
doc: FFI string types map null pointer to nil.
* txr.1: Document the existing behavior that the various FFI string types map between the null pointer and the nil object.
-rw-r--r--txr.110
1 files changed, 7 insertions, 3 deletions
diff --git a/txr.1 b/txr.1
index 02d4b686..cba901b3 100644
--- a/txr.1
+++ b/txr.1
@@ -79199,7 +79199,9 @@ to close the stream.
These FFI types correspond to the C pointer type
.codn "char *" ,
providing automatic conversion between Lisp strings and null-terminated
-C strings.
+C strings. The null pointer corresponds to the
+.B nil
+symbol.
The related types
.codn bstr ,
@@ -79320,7 +79322,8 @@ C strings, like the
family, and the family members have memory management semantics
similar to their
.code str
-counterparts.
+counterparts. Likewise, under these types also, the null pointer corresponds to
+.codn nil .
The
.code b
@@ -79364,7 +79367,8 @@ The family members of
.code wstr
have memory management semantics similar to their
.code str
-counterparts,
+counterparts, Likewise, under these types also, the null pointer corresponds to
+.codn nil .
Note: because wide characters do not require UTF-8 conversion, the
.code wstr