Advanced API

Utilities for compressing arrays of strings and internal structures. More...

Functions
int	unishox2_compress_lines (const char *in, int len, char *out, int olen, const unsigned char usx_hcodes[], const unsigned char usx_hcode_lens[], const char *usx_freq_seq[], const char *usx_templates[], struct us_lnk_lst *prev_lines)
int	unishox2_decompress_lines (const char *in, int len, char *out, int olen, const unsigned char usx_hcodes[], const unsigned char usx_hcode_lens[], const char *usx_freq_seq[], const char *usx_templates[], struct us_lnk_lst *prev_lines)

Detailed Description

Utilities for compressing arrays of strings and internal structures.

Function Documentation

unishox2_compress_lines()

int unishox2_compress_lines ( const char * in, int len, char * out, int olen, const unsigned char usx_hcodes[], const unsigned char usx_hcode_lens[], const char * usx_freq_seq[], const char * usx_templates[], struct us_lnk_lst * prev_lines )

extern

More Comprehensive API for compressing array of strings

See unishox2_compress() function for parameter definitions.
This function takes an additional parameter, i.e. 'prev_lines' - the usx_lnk_lst structure
See -g parameter in test_unishox2.c to find out how this can be used.
This function is used when an array of strings need to be compressed
and stored in a compressed array of bytes for use as a constant in other programs
where each element of the array can be decompressed and used at runtime.

unishox2_decompress_lines()

int unishox2_decompress_lines ( const char * in, int len, char * out, int olen, const unsigned char usx_hcodes[], const unsigned char usx_hcode_lens[], const char * usx_freq_seq[], const char * usx_templates[], struct us_lnk_lst * prev_lines )

extern

More Comprehensive API for de-compressing array of strings
This function is not be used in conjuction with unishox2_compress_lines()

See unishox2_decompress() function for parameter definitions.
Typically an array is compressed using unishox2_compress_lines() and
a header (.h) file is generated using the resultant compressed array.
This header file can be used in another program with another decompress
routine which takes this compressed array as parameter and index to be
decompressed.