summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKim F. Storm <storm@cua.dk>2006-05-28 22:20:49 +0000
committerKim F. Storm <storm@cua.dk>2006-05-28 22:20:49 +0000
commitb35444d58bc3e75d79bf34bef9145a6dd4c5d84d (patch)
treeca46e632c349828d3187f42956632313b6aa7d9c
parent6c6e0bb44e484071e69ec6d3e703f20f328b20ad (diff)
downloademacs-b35444d58bc3e75d79bf34bef9145a6dd4c5d84d.tar.gz
(Bindat Functions): Rename `pos' and `raw-data' to
`bindat-idx' and `bindat-raw' for clarity.
-rw-r--r--lispref/processes.texi24
1 files changed, 12 insertions, 12 deletions
diff --git a/lispref/processes.texi b/lispref/processes.texi
index ba6ab18a39c..0f0b617e36c 100644
--- a/lispref/processes.texi
+++ b/lispref/processes.texi
@@ -2185,11 +2185,11 @@ field name is specified, the value is bound to that field name.
@var{form} can access and update these dynamically bound variables:
@table @code
-@item raw-data
+@item bindat-raw
The data as a byte array.
-@item pos
-Current position of the unpacking or packing operation.
+@item bindat-idx
+Current index into bindat-raw of the unpacking or packing operation.
@item struct
Alist.
@@ -2243,14 +2243,14 @@ include a name.
@subsection Functions to Unpack and Pack Bytes
In the following documentation, @var{spec} refers to a data layout
-specification, @code{raw-data} to a byte array, and @var{struct} to an
+specification, @code{bindat-raw} to a byte array, and @var{struct} to an
alist representing unpacked field data.
-@defun bindat-unpack spec raw-data &optional pos
+@defun bindat-unpack spec bindat-raw &optional bindat-idx
This function unpacks data from the unibyte string or byte
-array @code{raw-data}
+array @code{bindat-raw}
according to @var{spec}. Normally this starts unpacking at the
-beginning of the byte array, but if @var{pos} is non-@code{nil}, it
+beginning of the byte array, but if @var{bindat-idx} is non-@code{nil}, it
specifies a zero-based starting position to use instead.
The value is an alist or nested alist in which each element describes
@@ -2283,15 +2283,15 @@ This function returns the total length of the data in @var{struct},
according to @var{spec}.
@end defun
-@defun bindat-pack spec struct &optional raw-data pos
+@defun bindat-pack spec struct &optional bindat-raw bindat-idx
This function returns a byte array packed according to @var{spec} from
the data in the alist @var{struct}. Normally it creates and fills a
-new byte array starting at the beginning. However, if @var{raw-data}
+new byte array starting at the beginning. However, if @var{bindat-raw}
is non-@code{nil}, it specifies a pre-allocated unibyte string or vector to
-pack into. If @var{pos} is non-@code{nil}, it specifies the starting
-offset for packing into @code{raw-data}.
+pack into. If @var{bindat-idx} is non-@code{nil}, it specifies the starting
+offset for packing into @code{bindat-raw}.
-When pre-allocating, you should make sure @code{(length @var{raw-data})}
+When pre-allocating, you should make sure @code{(length @var{bindat-raw})}
meets or exceeds the total length to avoid an out-of-range error.
@end defun