const type: gzipFile

File implementation type to decompress a GZIP file. GZIP is a file format used for compression.

const type: gzipWriteFile

File implementation type to compress data with the GZIP format.

const func string: gzuncompress (in string: compressed)

Decompress a string that was compressed with zlib (RFC 1950). Zlib uses the DEFLATE compression algorithm. DEFLATE uses a combination of the LZ77 algorithm and Huffman coding. Additionally to DEFLATE zlib uses a small header.

Returns:

the uncompressed string.

Raises:

RANGE_ERROR - If compressed is not in zlib format.

const func string: gunzip (in string: compressed)

Decompress a string that was compressed with gzip (RFC 1952). Gzip uses the DEFLATE compression algorithm. DEFLATE uses a combination of the LZ77 algorithm and Huffman coding. Additionally to DEFLATE gzip uses a magic number and a header.

Returns:

the uncompressed string.

Raises:

RANGE_ERROR - If compressed is not in gzip format.

const func file: openGzipFile (inout file: compressed, READ)

Open a GZIP file for reading (decompression). GZIP is a file format used for compression. Reading from the file delivers decompressed data. Writing is not supported. Gzip uses the DEFLATE compression algorithm. DEFLATE uses a combination of the LZ77 algorithm and Huffman coding. Additionally to DEFLATE gzip uses a magic number and a header.

Returns:

the file opened, or STD_NULL if the file is not in GZIP format.

const proc: close (in gzipFile: aFile)

Close a gzipFile.

const func char: getc (inout gzipFile: inFile)

Read a character from a gzipFile.

Returns:

the character read.

const func string: gets (inout gzipFile: inFile, in integer: maxLength)

Read a string with maximum length from a gzipFile.

Returns:

the string read.

Raises:

RANGE_ERROR - The parameter maxLength is negative.

const func boolean: eof (in gzipFile: inFile)

Determine the end-of-file indicator. The end-of-file indicator is set if at least one request to read from the file failed.

Returns:

TRUE if the end-of-file indicator is set, FALSE otherwise.

const func boolean: hasNext (inout gzipFile: inFile)

Determine if at least one character can be read successfully. This function allows a file to be handled like an iterator.

Returns:

FALSE if getc would return EOF, TRUE otherwise.

const func integer: length (inout gzipFile: aFile)

Obtain the length of a file. The file length is measured in bytes.

Returns:

the length of a file, or 0 if it cannot be obtained.

const boolean: seekable (in gzipFile: aFile)

Determine if the file aFile is seekable. If a file is seekable the functions seek and tell can be used to set and and obtain the current file position.

Returns:

TRUE, since a gzipFile is seekable.

const proc: seek (inout gzipFile: aFile, in integer: position)

Set the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Raises:

RANGE_ERROR - The file position is negative or zero.

const func integer: tell (in gzipFile: aFile)

Obtain the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Returns:

the current file position.

const func string: gzip (in string: uncompressed)

Compress a string to the gzip format. Gzip uses the DEFLATE compression algorithm. DEFLATE uses a combination of the LZ77 algorithm and Huffman coding. Additionally to DEFLATE gzip uses a magic number and a header.

Returns:

the compressed string.

const func file: openGzipFile (inout file: destFile, WRITE)

Open a GZIP file for writing (compression) GZIP is a file format used for compression. Writing to the file compresses the data to destFile. Reading is not supported. Gzip uses the DEFLATE compression algorithm. DEFLATE uses a combination of the LZ77 algorithm and Huffman coding. Additionally to DEFLATE gzip uses a magic number and a header.

Returns:

the file opened.

const proc: close (inout gzipWriteFile: aFile)

Close a gzipWriteFile.

const proc: write (inout gzipWriteFile: outFile, in string: stri)

Write the string stri to a gzipWriteFile.

const func integer: length (in gzipWriteFile: outFile)

Obtain the length of a file. The number of uncompressed characters written to the file.

Returns:

the length of a file.

const func integer: tell (in gzipWriteFile: outFile)

Obtain the current file position. The file position is measured in bytes from the start of the file. The first byte in the file has the position 1.

Returns:

the current file position.