diff options
author | Daniel Baumann <mail@daniel-baumann.ch> | 2015-11-07 13:40:04 +0000 |
---|---|---|
committer | Daniel Baumann <mail@daniel-baumann.ch> | 2015-11-07 13:40:04 +0000 |
commit | db724c11c1c030ce650bb587aa9e810c26287684 (patch) | |
tree | c2aed4f2d4e22187f30d2f0fb436f4158ca20228 /doc | |
parent | Adding upstream version 0.9. (diff) | |
download | lzlib-db724c11c1c030ce650bb587aa9e810c26287684.tar.xz lzlib-db724c11c1c030ce650bb587aa9e810c26287684.zip |
Adding upstream version 1.0.upstream/1.0
Signed-off-by: Daniel Baumann <mail@daniel-baumann.ch>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/lzlib.info | 50 | ||||
-rw-r--r-- | doc/lzlib.texinfo | 32 |
2 files changed, 67 insertions, 15 deletions
diff --git a/doc/lzlib.info b/doc/lzlib.info index 9a516a9..af9f67b 100644 --- a/doc/lzlib.info +++ b/doc/lzlib.info @@ -12,7 +12,7 @@ File: lzlib.info, Node: Top, Next: Introduction, Up: (dir) Lzlib Manual ************ -This manual is for Lzlib (version 0.9, 10 February 2010). +This manual is for Lzlib (version 1.0, 8 May 2010). * Menu: @@ -373,6 +373,28 @@ be verified by calling `LZ_decompress_errno' before using it. Returns 1 if all the data has been read and `LZ_decompress_close' can be safely called. Otherwise it returns 0. + -- Function: int LZ_decompress_member_finished ( struct LZ_Decoder * + const DECODER ) + Returns 1 if the previous call to `LZ_decompress_read' finished + reading the current member, indicating that final values for + member are available through `LZ_decompress_data_crc', + `LZ_decompress_data_position', and + `LZ_decompress_member_position'. Otherwise it returns 0. + + -- Function: int LZ_decompress_member_version ( struct LZ_Decoder * + const DECODER ) + Returns the version of current member from member header. + + -- Function: int LZ_decompress_dictionary_size ( struct LZ_Decoder * + const DECODER ) + Returns the dictionary size of current member from member header. + + -- Function: unsigned int LZ_decompress_data_crc ( struct LZ_Decoder * + const DECODER ) + Returns the 32 bit Cyclic Redundancy Check of the data + decompressed from the current member. The returned value is valid + only when `LZ_decompress_member_finished' returns 1. + -- Function: long long LZ_decompress_data_position ( struct LZ_Decoder * const DECODER ) Returns the number of decompressed bytes already produced, but @@ -575,6 +597,8 @@ Example 4: Decompression using LZ_decompress_write_size. 3) LZ_decompress_write 4) if no more data to write, call LZ_decompress_finish 5) LZ_decompress_read + 5a) optionally, if LZ_decompress_member_finished returns 1, read + final values for member with LZ_decompress_data_crc, etc. 6) go back to step 2 until LZ_decompress_finished returns 1 7) LZ_decompress_close @@ -676,17 +700,17 @@ Concept Index Tag Table: Node: Top219 -Node: Introduction1158 -Node: Library Version2933 -Node: Buffering3578 -Node: Parameter Limits4698 -Node: Compression Functions5655 -Node: Decompression Functions11701 -Node: Error Codes16763 -Node: Error Messages18702 -Node: Data Format19281 -Node: Examples21251 -Node: Problems24827 -Node: Concept Index25399 +Node: Introduction1152 +Node: Library Version2927 +Node: Buffering3572 +Node: Parameter Limits4692 +Node: Compression Functions5649 +Node: Decompression Functions11695 +Node: Error Codes17766 +Node: Error Messages19705 +Node: Data Format20284 +Node: Examples22254 +Node: Problems25967 +Node: Concept Index26539 End Tag Table diff --git a/doc/lzlib.texinfo b/doc/lzlib.texinfo index 8163502..ef46af9 100644 --- a/doc/lzlib.texinfo +++ b/doc/lzlib.texinfo @@ -5,8 +5,8 @@ @finalout @c %**end of header -@set UPDATED 10 February 2010 -@set VERSION 0.9 +@set UPDATED 8 May 2010 +@set VERSION 1.0 @dircategory Data Compression @direntry @@ -424,6 +424,32 @@ can be safely called. Otherwise it returns 0. @end deftypefun +@deftypefun int LZ_decompress_member_finished ( struct LZ_Decoder * const @var{decoder} ) +Returns 1 if the previous call to @samp{LZ_decompress_read} finished +reading the current member, indicating that final values for member are +available through @samp{LZ_decompress_data_crc}, +@samp{LZ_decompress_data_position}, and +@samp{LZ_decompress_member_position}. Otherwise it returns 0. +@end deftypefun + + +@deftypefun int LZ_decompress_member_version ( struct LZ_Decoder * const @var{decoder} ) +Returns the version of current member from member header. +@end deftypefun + + +@deftypefun int LZ_decompress_dictionary_size ( struct LZ_Decoder * const @var{decoder} ) +Returns the dictionary size of current member from member header. +@end deftypefun + + +@deftypefun {unsigned int} LZ_decompress_data_crc ( struct LZ_Decoder * const @var{decoder} ) +Returns the 32 bit Cyclic Redundancy Check of the data decompressed from +the current member. The returned value is valid only when +@samp{LZ_decompress_member_finished} returns 1. +@end deftypefun + + @deftypefun {long long} LZ_decompress_data_position ( struct LZ_Decoder * const @var{decoder} ) Returns the number of decompressed bytes already produced, but perhaps not yet read, in the current member. @@ -652,6 +678,8 @@ Example 4: Decompression using LZ_decompress_write_size. 3) LZ_decompress_write 4) if no more data to write, call LZ_decompress_finish 5) LZ_decompress_read +5a) optionally, if LZ_decompress_member_finished returns 1, read + final values for member with LZ_decompress_data_crc, etc. 6) go back to step 2 until LZ_decompress_finished returns 1 7) LZ_decompress_close @end example |