summaryrefslogtreecommitdiff
path: root/doc/ref/api-foreign.texi
diff options
context:
space:
mode:
authorAndy Wingo <wingo@pobox.com>2014-02-08 14:18:40 +0100
committerAndy Wingo <wingo@pobox.com>2014-02-08 14:28:07 +0100
commitfb7dd00169304a5922838e4d2f25253640a35def (patch)
treec7f8aa54df8b33d7238f8a1718e4ff91711e262e /doc/ref/api-foreign.texi
parentdc65b88d839c326889618112c4870ad3a64e9446 (diff)
downloadguile-fb7dd00169304a5922838e4d2f25253640a35def.tar.gz
Deprecate general "uniform-vector" interface
* libguile/uniform.h: * libguile/uniform.c (scm_is_uniform_vector, scm_uniform_vector_p) (scm_c_uniform_vector_length, scm_uniform_vector_length) (scm_uniform_vector_element_type, scm_uniform_vector_element_size) (scm_c_uniform_vector_ref, scm_uniform_vector_ref): (scm_c_uniform_vector_set_x, scm_uniform_vector_set_x): (scm_uniform_vector_to_list) (scm_uniform_vector_elements, scm_uniform_vector_writable_elements): Deprecate. This interface lacked both generality and specificity. The general replacement is array-length, array-ref, and friends on the scheme side, or the array handle interface on the C side. On the specific side of things, there are the specific bytevector, srfi-4, and bitvector interfaces. * test-suite/tests/arrays.test: * test-suite/tests/bitvectors.test: * test-suite/tests/ports.test: * test-suite/tests/srfi-4.test: Update to use array interfaces. * doc/ref/api-foreign.texi (Void Pointers and Byte Access): * doc/ref/srfi-modules.texi (SRFI-4): Update.
Diffstat (limited to 'doc/ref/api-foreign.texi')
-rw-r--r--doc/ref/api-foreign.texi12
1 files changed, 5 insertions, 7 deletions
diff --git a/doc/ref/api-foreign.texi b/doc/ref/api-foreign.texi
index e59566849..381c10d63 100644
--- a/doc/ref/api-foreign.texi
+++ b/doc/ref/api-foreign.texi
@@ -1,7 +1,7 @@
@c -*-texinfo-*-
@c This is part of the GNU Guile Reference Manual.
@c Copyright (C) 1996, 1997, 2000, 2001, 2002, 2003, 2004, 2007, 2008,
-@c 2009, 2010, 2011, 2012, 2013 Free Software Foundation, Inc.
+@c 2009, 2010, 2011, 2012, 2013, 2014 Free Software Foundation, Inc.
@c See the file guile.texi for copying conditions.
@node Foreign Function Interface
@@ -613,12 +613,10 @@ Scheme objects such as strings, floating point numbers, or integers.
Return a bytevector aliasing the @var{len} bytes pointed to by
@var{pointer}.
-The user may specify an alternate default interpretation for
-the memory by passing the @var{uvec_type} argument, to indicate
-that the memory is an array of elements of that type.
-@var{uvec_type} should be something that
-@code{uniform-vector-element-type} would return, like @code{f32}
-or @code{s16}.
+The user may specify an alternate default interpretation for the memory
+by passing the @var{uvec_type} argument, to indicate that the memory is
+an array of elements of that type. @var{uvec_type} should be something
+that @code{array-type} would return, like @code{f32} or @code{s16}.
When @var{offset} is passed, it specifies the offset in bytes relative
to @var{pointer} of the memory region aliased by the returned