From c2b699ef337aa301393802fd1f9c255f77a3929e Mon Sep 17 00:00:00 2001 From: Dirk Herrmann Date: Fri, 1 Mar 2002 20:53:03 +0000 Subject: [PATCH] * api.txt, data-rep.texi: Renamed the struct scm_cell to scm_t_cell. --- doc/ref/ChangeLog | 5 +++++ doc/ref/api.txt | 8 ++++---- doc/ref/data-rep.texi | 10 +++++----- 3 files changed, 14 insertions(+), 9 deletions(-) diff --git a/doc/ref/ChangeLog b/doc/ref/ChangeLog index 755253b76..e4807d73d 100644 --- a/doc/ref/ChangeLog +++ b/doc/ref/ChangeLog @@ -1,3 +1,8 @@ +2002-03-01 Dirk Herrmann + + * api.txt, data-rep.texi: Renamed the struct scm_cell to + scm_t_cell. + 2002-02-26 Thien-Thi Nguyen * Makefile.am: Update path to pre-inst-guile automake frag. diff --git a/doc/ref/api.txt b/doc/ref/api.txt index 367cbbf95..cc26b839f 100644 --- a/doc/ref/api.txt +++ b/doc/ref/api.txt @@ -66,8 +66,8 @@ determined from the scm_bits_t value that is delivered by SCM_UNPACK (x). Non immediate objects ===================== -- (scm_cell *) SCM2PTR (SCM x) (FIXME:: this name should be changed) -- SCM PTR2SCM (scm_cell * x) (FIXME:: this name should be changed) +- (scm_t_cell *) SCM2PTR (SCM x) (FIXME:: this name should be changed) +- SCM PTR2SCM (scm_t_cell * x) (FIXME:: this name should be changed) A scheme object of type SCM that does not fullfill the SCM_IMP predicate holds an encoded reference to a heap cell. This reference can be decoded to a C @@ -76,14 +76,14 @@ a heap cell into a SCM value is done using the PTR2SCM macro. Note that it is also possible to transform a non immediate SCM value by using SCM_UNPACK into a scm_bits_t variable. Hower, the result of SCM_UNPACK may -not be used as a pointer to a scm_cell: Only SCM2PTR is guaranteed to +not be used as a pointer to a scm_t_cell: Only SCM2PTR is guaranteed to transform a SCM object into a valid pointer to a heap cell. Also, it is not allowed to apply PTR2SCM to anything that is not a valid pointer to a heap cell. Summary: * Only use SCM2PTR for SCM values for which SCM_IMP is false! -* Don't use '(scm_cell*) SCM_UNPACK (x)'! Use 'SCM2PTR (x)' instead! +* Don't use '(scm_t_cell*) SCM_UNPACK (x)'! Use 'SCM2PTR (x)' instead! * Don't use PTR2SCM for anything but a cell pointer! diff --git a/doc/ref/data-rep.texi b/doc/ref/data-rep.texi index f48d70a41..73db925bf 100644 --- a/doc/ref/data-rep.texi +++ b/doc/ref/data-rep.texi @@ -46,7 +46,7 @@ @c essay @sp 10 @c essay @comment The title is printed in a large font. @c essay @title Data Representation in Guile -@c essay @subtitle $Id: data-rep.texi,v 1.1.2.2 2002-01-08 09:22:36 ttn Exp $ +@c essay @subtitle $Id: data-rep.texi,v 1.1.2.3 2002-03-01 20:53:03 dirk Exp $ @c essay @subtitle For use with Guile @value{VERSION} @c essay @author Jim Blandy @c essay @author Free Software Foundation @@ -1168,13 +1168,13 @@ This reference can be decoded to a C pointer to a heap cell using the @code{SCM} value is done using the @code{PTR2SCM} macro. @c (FIXME:: this name should be changed) -@deftypefn Macro (scm_cell *) SCM2PTR (SCM @var{x}) +@deftypefn Macro (scm_t_cell *) SCM2PTR (SCM @var{x}) Extract and return the heap cell pointer from a non-immediate @code{SCM} object @var{x}. @end deftypefn @c (FIXME:: this name should be changed) -@deftypefn Macro SCM PTR2SCM (scm_cell * @var{x}) +@deftypefn Macro SCM PTR2SCM (scm_t_cell * @var{x}) Return a @code{SCM} value that encodes a reference to the heap cell pointer @var{x}. @end deftypefn @@ -1182,7 +1182,7 @@ pointer @var{x}. Note that it is also possible to transform a non-immediate @code{SCM} value by using @code{SCM_UNPACK} into a @code{scm_bits_t} variable. However, the result of @code{SCM_UNPACK} may not be used as a pointer to -a @code{scm_cell}: only @code{SCM2PTR} is guaranteed to transform a +a @code{scm_t_cell}: only @code{SCM2PTR} is guaranteed to transform a @code{SCM} object into a valid pointer to a heap cell. Also, it is not allowed to apply @code{PTR2SCM} to anything that is not a valid pointer to a heap cell. @@ -1194,7 +1194,7 @@ Summary: Only use @code{SCM2PTR} on @code{SCM} values for which @code{SCM_IMP} is false! @item -Don't use @code{(scm_cell *) SCM_UNPACK (@var{x})}! Use @code{SCM2PTR +Don't use @code{(scm_t_cell *) SCM_UNPACK (@var{x})}! Use @code{SCM2PTR (@var{x})} instead! @item Don't use @code{PTR2SCM} for anything but a cell pointer!