--- al.pod 2002/10/17 14:57:44 1.7
+++ al.pod 2002/10/17 15:02:49 1.8
@@ -1,5 +1,5 @@
##
-## OSSP al - Assembly Lists
+## OSSP al - Assembly Line
## Copyright (c) 2002 The OSSP Project <http://www.ossp.org/>
## Copyright (c) 2002 Cable & Wireless Deutschland <http://www.cw.com/de/>
## Copyright (c) 2002 Ralf S. Engelschall <rse@engelschall.com>
@@ -26,14 +26,14 @@
## OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
## SUCH DAMAGE.
##
-## al.pod: assembly lists library manual page
+## al.pod: assembly line library manual page
##
=pod
=head1 NAME
-B<OSSP al> - Assembly Lists
+B<OSSP al> - Assembly Line
=head1 VERSION
@@ -51,7 +51,7 @@
al_td_t,
al_chunk_t.
-=item B<Assembly List Operations>:
+=item B<Assembly Line Operations>:
al_create,
al_destroy,
@@ -114,7 +114,7 @@
AL_ERR_EOF End Of Communication
AL_ERR_INT Internal Error
-=item B<al_t> (Assembly List Type)
+=item B<al_t> (Assembly Line Type)
This is an opaque data type representing a data buffer.
Only pointers to this abstract data type are used in the API.
@@ -130,8 +130,8 @@
This is an exported enumerated integer type with the following possible
values:
- AL_FORWARD traverse list from beginning to end
- AL_BACKWARD traverse list from end to beginning
+ AL_FORWARD traverse assembly line from beginning to end
+ AL_BACKWARD traverse assembly line from end to beginning
=item B<al_chunk_t> (Chunk Type)
@@ -153,34 +153,34 @@
prefix C<al_> and receives a C<al_t> (or C<al_chunk_t>) object on which
it operates as its first argument.
-=head2 Assembly List Operations
+=head2 Assembly Line Operations
=over 4
=item al_rc_t B<al_create>(al_t **I<alp>);
-Create an assembly list abstraction object.
+Create an assembly line abstraction object.
The object is stored in I<alp> on success.
Example: C<al_t *al; al_create(&al);>
=item al_rc_t B<al_destroy>(al_t *I<al>);
-Destroy an assembly list abstraction object.
+Destroy an assembly line abstraction object.
The object I<al> is invalid after this call succeeded.
Example: C<al_destroy(al);>
=item al_rc_t B<al_append_bytes>(al_t *I<al>, const char *I<src>, size_t I<n>);
-Append I<n> bytes from a storage array at I<src> to the assembly list. The
+Append I<n> bytes from a storage array at I<src> to the assembly line. The
bytes are copied, memory is allocated as necessary.
Example: C<al_append_bytes(al, "Goodbye cruel world\n", 20);>
=item al_rc_t B<al_prepend_bytes>(al_t *I<al>, const char *I<src>, size_t I<n>);
-Prepend I<n> bytes from a storage array at I<src> to the assembly list. The
+Prepend I<n> bytes from a storage array at I<src> to the assembly line. The
bytes are copied, memory is allocated as necessary.
Example: C<al_prepend_bytes(al, "Hello world\n", 12);>
@@ -188,10 +188,10 @@
=item al_rc_t B<al_attach_buffer>(al_t *I<al>, char *I<p>, size_t I<n>);
Attach the storage array starting at I<p> with size I<n> at the end of
-the assembly list. Its content becomes part of the assembly list
-and is subject to assembly list operations. The storage array must stay
-in scope for the whole life time of the assembly list, there is no way
-to detach it from the assembly list.
+the assembly line. Its content becomes part of the assembly line
+and is subject to assembly line operations. The storage array must stay
+in scope for the whole life time of the assembly line, there is no way
+to detach it from the assembly line.
Example: C<char store[] = "foo\n"; al_attach_buffer(al, store, sizeof(store));>
@@ -201,21 +201,21 @@
B<splice>.
I<off> and I<n> are byte counts that define a span of bytes within the
-source assembly list I<al>. These bytes are moved to the target list
-I<tal> while the content of the new list I<nal> is moved to the source
+source assembly line I<al>. These bytes are moved to the target assembly line
+I<tal> while the content of the new assembly line I<nal> is moved to the source
to replace the selected span.
There are two deviations from the Perl operator to avoid copying:
-The move to the target list I<tal> appends the data to its end.
-The move from the new list I<nal> removes the data from its origin.
+The move to the target assembly line I<tal> appends the data to its end.
+The move from the new assembly line I<nal> removes the data from its origin.
-The target list I<tal> may be B<NULL>, the data bytes that would
+The target assembly line I<tal> may be B<NULL>, the data bytes that would
be moved to the target are then discarded. This avoids creation
and destruction of a dummy target.
-The new list I<nal> may be B<NULL>, then nothing is inserted into
-the source. This avoids creation and destruction of an empty list.
+The new assembly line I<nal> may be B<NULL>, then nothing is inserted into
+the source. This avoids creation and destruction of an empty assembly line.
Examples:
@@ -254,7 +254,7 @@
=item size_t B<al_bytes>(const al_t *I<al>);
-Returns the number of bytes stored in the assembly list.
+Returns the number of bytes stored in the assembly line.
Example: C<al_t *al; size_t count; count = al_bytes(al);>
@@ -278,25 +278,25 @@
=item al_rc_t B<al_traverse>(al_t *I<al>, size_t I<off>, size_t I<n>, al_td_t I<dir>, al_tx_t *I<tx>);
-Start traversing the assembly list I<al> beginning at byte offset I<off>
+Start traversing the assembly line I<al> beginning at byte offset I<off>
for up to I<n> bytes in direction I<dir>. The state of the traversal is
stored in the supplied context I<tx>.
-This function fails when the offset is outside the assembly list bounds.
+This function fails when the offset is outside the assembly line bounds.
=item al_rc_t B<al_traverse_next>(al_t *I<al>, al_tx_t *I<tx>, al_chunk_t **I<alcp>);
-Complete a traversal step on the assembly list I<al> using the initialized
+Complete a traversal step on the assembly line I<al> using the initialized
context I<tx>. In each step a chunk descriptor is filled and stored in
I<alcp>. All bytes of the chunk are guaranteed to be stored in a flat
array and can be accessed through the chunk operations described below.
The function returns AL_ERR_EOF when it passes the end (or beginning
-in case of backward traversal) of the list.
+in case of backward traversal) of the assembly line.
=item al_rc_t B<al_traverse_cb>(al_t *I<al>, size_t I<off>, size_t I<n>, al_td_t I<dir>, al_rc_t (*I<cb>)(al_chunk_t *, void *), void *u);
-B<al_traverse_cb> is a wrapper function that does a full list traversal in
+B<al_traverse_cb> is a wrapper function that does a full assembly line traversal in
a single call. In every step a chunk descriptor is passed to the callback
function I<cb> together with a user supplied pointer I<u>. When the
callback function returns AL_OK the traversal continues, when it returns
@@ -313,10 +313,10 @@
=item al_rc_t B<al_flatten>(al_t *I<al>, size_t I<off>, size_t I<n>, char *I<dst>, size_t *I<lenp>);
I<off> and I<n> are byte counts that define a span of bytes with the
-assembly list I<al>. These bytes are copied to the storage array I<dst>
+assembly line I<al>. These bytes are copied to the storage array I<dst>
which must be sized appropriately.
I<off> must be a valid offset, I<n> must be positive but may exceed
-the size of the assembly list.
+the size of the assembly line.
The actual number of bytes that is copied to the destination is stored
in I<lenp>.
@@ -331,10 +331,10 @@
=item al_rc_t B<al_copy>(al_t *I<al>, size_t I<off>, size_t I<n>, al_t *I<tal);
I<off> and I<n> are byte counts that define a span of bytes within the
-assembly list I<al>. These bytes are appended to the target list I<tal>,
+assembly line I<al>. These bytes are appended to the target assembly line I<tal>,
memory is allocated as necessary.
I<off> must be a valid offset, I<n> must be positive but may exceed
-the size of the assembly list.
+the size of the assembly line.
Example:
|
