1 files changed, 40 insertions, 29 deletions

diff --git a/examples/zran.h b/examples/zran.h
index 2314125..ebf780d 100644
--- a/examples/zran.h
+++ b/examples/zran.h
@@ -1,40 +1,51 @@
-/* zran.h -- example of zlib/gzip stream indexing and random access
- * Copyright (C) 2005, 2012, 2018 Mark Adler
+/* zran.h -- example of deflated stream indexing and random access
+ * Copyright (C) 2005, 2012, 2018, 2023 Mark Adler
  * For conditions of distribution and use, see copyright notice in zlib.h
- * Version 1.2  14 Oct 2018  Mark Adler */
+ * Version 1.3  18 Feb 2023  Mark Adler */
 
 #include <stdio.h>
 #include "zlib.h"
 
-/* Access point list. */
+// Access point.
+typedef struct point {
+    off_t out;          // offset in uncompressed data
+    off_t in;           // offset in compressed file of first full byte
+    int bits;           // 0, or number of bits (1-7) from byte at in-1
+    unsigned char window[32768];    // preceding 32K of uncompressed data
+} point_t;
+
+// Access point list.
 struct deflate_index {
-    int have;           /* number of list entries */
-    int gzip;           /* 1 if the index is of a gzip file, 0 if it is of a
-                           zlib stream */
-    off_t length;       /* total length of uncompressed data */
-    void *list;         /* allocated list of entries */
+    int have;           // number of access points in list
+    int mode;           // -15 for raw, 15 for zlib, or 31 for gzip
+    off_t length;       // total length of uncompressed data
+    point_t *list;      // allocated list of access points
 };
 
-/* Make one entire pass through a zlib or gzip compressed stream and build an
-   index, with access points about every span bytes of uncompressed output.
-   gzip files with multiple members are indexed in their entirety. span should
-   be chosen to balance the speed of random access against the memory
-   requirements of the list, about 32K bytes per access point. The return value
-   is the number of access points on success (>= 1), Z_MEM_ERROR for out of
-   memory, Z_DATA_ERROR for an error in the input file, or Z_ERRNO for a file
-   read error. On success, *built points to the resulting index. */
+// Make one pass through a zlib, gzip, or raw deflate compressed stream and
+// build an index, with access points about every span bytes of uncompressed
+// output. gzip files with multiple members are fully indexed. span should be
+// chosen to balance the speed of random access against the memory requirements
+// of the list, which is about 32K bytes per access point. The return value is
+// the number of access points on success (>= 1), Z_MEM_ERROR for out of
+// memory, Z_BUF_ERROR for a premature end of input, Z_DATA_ERROR for a format
+// or verification error in the input file, or Z_ERRNO for a file read error.
+// On success, *built points to the resulting index.
 int deflate_index_build(FILE *in, off_t span, struct deflate_index **built);
 
-/* Deallocate an index built by deflate_index_build() */
-void deflate_index_free(struct deflate_index *index);
+// Use the index to read len bytes from offset into buf. Return the number of
+// bytes read or a negative error code. If data is requested past the end of
+// the uncompressed data, then deflate_index_extract() will return a value less
+// than len, indicating how much was actually read into buf. If given a valid
+// index, this function should not return an error unless the file was modified
+// somehow since the index was generated, given that deflate_index_build() had
+// validated all of the input. If nevertheless there is a failure, Z_BUF_ERROR
+// is returned if the compressed data ends prematurely, Z_DATA_ERROR if the
+// deflate compressed data is not valid, Z_MEM_ERROR if out of memory,
+// Z_STREAM_ERROR if the index is not valid, or Z_ERRNO if there is an error
+// reading or seeking on the input file.
+ptrdiff_t deflate_index_extract(FILE *in, struct deflate_index *index,
+                                off_t offset, unsigned char *buf, size_t len);
 
-/* Use the index to read len bytes from offset into buf. Return bytes read or
-   negative for error (Z_DATA_ERROR or Z_MEM_ERROR). If data is requested past
-   the end of the uncompressed data, then deflate_index_extract() will return a
-   value less than len, indicating how much was actually read into buf. This
-   function should not return a data error unless the file was modified since
-   the index was generated, since deflate_index_build() validated all of the
-   input. deflate_index_extract() will return Z_ERRNO if there is an error on
-   reading or seeking the input file. */
-int deflate_index_extract(FILE *in, struct deflate_index *index, off_t offset,
-                          unsigned char *buf, int len);
+// Deallocate an index built by deflate_index_build().
+void deflate_index_free(struct deflate_index *index);