From 37ca74d53d7f69d4288fba4ae65b5479a9fad51c Mon Sep 17 00:00:00 2001 From: Kaz Kylheku Date: Sat, 8 Jul 2017 17:37:14 -0700 Subject: doc: merge redundant sections on cptr. * txr.1: The FFI cptr type is described in two separate sections. These are merged and duplication removed. --- txr.1 | 61 ++++++++++++++++++++++++++++--------------------------------- 1 file changed, 28 insertions(+), 33 deletions(-) diff --git a/txr.1 b/txr.1 index 95571c12..82c6ee4f 100644 --- a/txr.1 +++ b/txr.1 @@ -54310,12 +54310,35 @@ positives: admit some invalid objects may be admitted into the Lisp realm, possibly with catastrophic results. .coNP FFI type @ cptr -This type corresponds to a C pointer of any type, including a function pointer; -\*(TX doesn't run on any exotic platforms in which there is a representational -difference among C pointers. -This foreign type converts between the \*(TL type +This type corresponds to a foreign pointer of any type, including a pointer to a function. + +The +.code cptr +type converts between a foreign pointer and a Lisp object of type +.codn cptr . + +Lisp objects of type +.code cptr +are tagged with a symbolic tag, which may be +.codn nil . + +The unparametrized +.code cptr +converts foreign pointers to .code cptr -and C pointers. +objects which are tagged with +.codn nil . + +In the reverse direction, it converts +.code cptr +Lisp objects of type +.code cptr +to foreign pointer, without regard for their type tag. + +There is a parametrized version of the +.code cptr +FFI type, which provides a measure of type safety. + Note: the .code cptr type, in the context of FFI, is particularly useful for representing @@ -54585,34 +54608,6 @@ macro. The type is useful for passing callbacks to foreign functions: Lisp functions which appear to be C functions to foreign code. -.coNP FFI types @ cptr -The -.code cptr -type converts between a foreign pointer and a Lisp object of type -.codn cptr . - -Lisp objects of type -.code cptr -are tagged with a symbolic tag, which may be -.codn nil . - -The unparametrized -.code cptr -converts foreign pointers to -.code cptr -objects which are tagged with -.codn nil . - -In the reverse direction, it converts -.code cptr -Lisp objects of type -.code cptr -to foreign pointer, without regard for their type tag. - -There is a parametrized version of the -.code cptr -FFI type, which provides a measure of type safety. - .coNP FFI type @ void The .code void -- cgit v1.2.3