(Tcl) Crypt2 Compression Example

The Chilkat Crypt2 class include a few methods for compression and decompression (inflate). These are legacy method that existed long before the Chilkat.Compression class was first introduced. These methods should be avoided in favor of using the Chilkat.Compression methods. The reason is that they are limited to bzip2, and the compressed output includes an 8-byte header that is composed of a magic number (0xB394A7E1) and the size of the original uncompressed data (4 bytes and thus limited to 4GB).

This example demonstrates compression and decompression, and also how to compress using Crypt2 and decompress using Chilkat.Compression. The Chilkat.Compression class does not emit any header, and supports other compression methods.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

set crypt [new_CkCrypt2]

set sb [new_CkStringBuilder]

set i 0
while {$i < 10} {
    CkStringBuilder_AppendInt $sb $i
    CkStringBuilder_Append $sb " the quick brown fox jumps over the crazy dog\r\n"
    set i [expr $i + 1]
}

puts "Before compression:"
puts [CkStringBuilder_getAsString $sb]

# Before compression:
# 0 the quick brown fox jumps over the crazy dog
# 1 the quick brown fox jumps over the crazy dog
# 2 the quick brown fox jumps over the crazy dog
# 3 the quick brown fox jumps over the crazy dog
# 4 the quick brown fox jumps over the crazy dog
# 5 the quick brown fox jumps over the crazy dog
# 6 the quick brown fox jumps over the crazy dog
# 7 the quick brown fox jumps over the crazy dog
# 8 the quick brown fox jumps over the crazy dog
# 9 the quick brown fox jumps over the crazy dog

CkCrypt2_put_EncodingMode $crypt "base64"
# Compress the utf-8 representation of the string.
# Note: Choosing "Unicode" or "utf-16" is a poor choice for text that is mostly us-ascii.
# The utf-8 representation will result in a smaller size.
CkCrypt2_put_Charset $crypt "utf-8"
set compressedStr [CkCrypt2_compressStringENC $crypt [CkStringBuilder_getAsString $sb]]

puts "After compression:"
puts "$compressedStr"

# After compression:
# 4aeUs+ABAABCWmgzMUFZJlNZT/+H9wAAN1mAABJAAH/gP/v/8CAAkDGExNBgjEMjCYFKqGoAaDygNDamyTYmKe6Ypqn0mqZpgmaZd/hv8fLz9McsU7kyTgmwnAmibU4pyJom5PxNqapxTBO1M05JuT4TrT+TRMCapqm9VzTmn+LuSKcKEgn/8P7g

# Note: The compressed data includes an 8-byte header composed of a magic number (0xB394A7E1) and the original data byte count.
# Therefore, the Crypt2 compress/inflate methods are considered legacy and should only be used for data already
# compressed with these methods.  The Chilkat.Compression class is generalized, emits no headers, and can interoperate with
# with other software systems without trouble.  

# If we re-encode from base64 to hex, then we can see the header:
puts [CkCrypt2_reEncode $crypt $compressedStr base64 hex]

# The hex compressed string is:
# E1A794B3E0010000425A68333141592653594...
# We can see the 8-byte header in the hex:  magic number = 0xE1A794B3E (little-endian), and byte count = 0xE0010000 (little-endian)

set originalStr [CkCrypt2_inflateStringENC $crypt $compressedStr]
puts "After inflate:"
puts "$originalStr"

# ---------------------------------------------------------------------------
# To inflate with Chilkat.Compression:

set compress [new_CkCompression]

CkCompression_put_Algorithm $compress "bzip2"
CkCompression_put_Charset $compress "utf-8"
CkCompression_put_EncodingMode $compress "base64"

set bd [new_CkBinData]

CkBinData_AppendEncoded $bd $compressedStr "base64"
# Remove the 1st 8 bytes.
CkBinData_RemoveChunk $bd 0 8

CkCompression_DecompressBd $compress $bd

puts "After decompression:"
puts [CkBinData_getString $bd utf-8]

delete_CkCrypt2 $crypt
delete_CkStringBuilder $sb
delete_CkCompression $compress
delete_CkBinData $bd