SleelaDoc API
HTML documentation for the SLeeLa standard library (/lib)
Home › Packages › compression

Package compression

This package contains 22 source unit(s) defining 24 class(es) / struct(s). Each unit below lists its fields (the values it stores) and methods (the actions it performs), with a plain explanation of each.

compression #sleela 2.5 (lib/compression/compression.sleela)

Compression class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
loadedint[] loadedNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
countint count()No description in source.
initvoid init()No description in source.
isLoadedboolean isLoaded(int id)No description in source.
loadvoid load(int id)No description in source.
unloadvoid unload(int id)No description in source.
unloadAllvoid unloadAll()No description in source.
isNativeboolean isNative(int id)No description in source.
nameOfString nameOf(int id)No description in source.
stateWordString stateWord(int id)No description in source.
reportvoid report(int id)No description in source.
mainvoid main()No description in source.

compression-pipeline #sleela 2.5 (lib/compression/compression-pipeline.sleela)

Verifier class

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resolveExtensionint resolveExtension(String ext)No description in source.
probeMagicint probeMagic(String tag)No description in source.
resultTextString resultText(int code)No description in source.

Processor class

Methods — the actions this unit can perform.

MethodSignatureWhat it does
compressint compress(boolean loaded, boolean nativeAlg, boolean backendReady)No description in source.
decompressint decompress(boolean loaded, boolean nativeAlg, boolean backendReady)No description in source.

Controller class

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
loadedint[] loadedNo description in source.
backendint[] backendNo description in source.
verifierVerifier verifierwired by create(), called via the field (1.11)
processorProcessor processorNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
createvoid create()No description in source.
countint count()No description in source.
isNativeboolean isNative(int id)No description in source.
nameOfString nameOf(int id)No description in source.
loadint load(int id)No description in source.
isLoadedboolean isLoaded(int id)No description in source.
unloadAllvoid unloadAll()No description in source.
registerBackendint registerBackend(int id)No description in source.
hasBackendboolean hasBackend(int id)No description in source.
loadedCountint loadedCount()No description in source.
resolveExtensionint resolveExtension(String ext)Clean facade methods: delegate to the wired collaborators.
probeMagicint probeMagic(String tag)No description in source.
resultTextString resultText(int code)No description in source.
compressint compress(int id)No description in source.
decompressint decompress(int id)No description in source.
mainvoid main()No description in source.

SLCompressionBrotli #sleela 2.5 (lib/compression/SLCompressionBrotli.sleela)

SLCompressionBrotli class

Brotli algorithm class — the SLeeLa-facing handle to algorithm id 12.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionBzip2 #sleela 2.5 (lib/compression/SLCompressionBzip2.sleela)

SLCompressionBzip2 class

bzip2 algorithm class — the SLeeLa-facing handle to algorithm id 7.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionController #sleela 2.5 (lib/compression/SLCompressionController.sleela)

SLCompressionController class extends SLPluginService

Defines the SLeeLa standard-library type SLCompressionController used within the compression library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
verifierSLCompressionVerifier verifierThe verification collaborator, wired by create() and called via the field. (Lifecycle tables + ready flag are inherited from SLPluginService.)

Methods — the actions this unit can perform.

MethodSignatureWhat it does
createvoid create()Build the controller with every algorithm registered but none loaded. Mirrors sleela_compression_manager_create. configure() (inherited) allocates the 15-entry lifecycle tables and records the native-id mask; then wire the Verifier. Native algorithms compress/decompress in-package: Store (0), RLE (1), Huffman (2), LZW (3) -> mask bits 0..3.
resolveExtensionint resolveExtension(String extension)Resolve an algorithm id from a file extension via the Controller's Verifier.
compressint compress(int id)compress(id) / decompress(id): gated by the shared dispatchCode(): -2 invalid, -5 not loaded, -1 backend absent, 0 ok.
decompressint decompress(int id)No description in source.
serviceNameString serviceName()---- identity + result text -----------------------------------------
resultTextString resultText(int code)Human-readable text for a result code (via the wired Verifier, which uses the shared SLServiceResult vocabulary).

SLCompressionDeflate #sleela 2.5 (lib/compression/SLCompressionDeflate.sleela)

SLCompressionDeflate class

DEFLATE (RFC 1951) algorithm class — the SLeeLa-facing handle to algorithm id 4.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionGzip #sleela 2.5 (lib/compression/SLCompressionGzip.sleela)

SLCompressionGzip class

gzip (RFC 1952) algorithm class — the SLeeLa-facing handle to algorithm id 6.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionHuffman #sleela 2.5 (lib/compression/SLCompressionHuffman.sleela)

SLCompressionHuffman class

Canonical Huffman algorithm class — the SLeeLa-facing handle to algorithm id 2.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 0 == native.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionLoader #sleela 2.5 (lib/compression/SLCompressionLoader.sleela)

SLCompressionLoader class

Defines the SLeeLa standard-library type SLCompressionLoader used within the compression library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
loadedint[] loadedPer-algorithm loaded flag (1 loaded, 0 not), indexed by id. Backed by the first-class array type; call init() before use.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
algorithmCountint algorithmCount()The number of algorithms the native manager knows (SLEELA_COMPRESSION_COUNT).
initvoid init()Allocate the loaded-flag table with every algorithm unloaded.
loadvoid load(int id)load(id): mark an algorithm loaded. Mirrors sleela_compression_manager_load.
unloadvoid unload(int id)unload(id): mark an algorithm unloaded. Mirrors sleela_compression_manager_unload.
isLoadedboolean isLoaded(int id)No description in source.
unloadAllvoid unloadAll()unloadAll(): release every loaded algorithm. Mirrors sleela_compression_manager_unload_all.
nameOfString nameOf(int id)Human-readable algorithm name by id, matching the native registry.
isNativeboolean isNative(int id)Native algorithms implement compress/decompress in-package (no external backend): Store (0), RLE (1), Huffman (2), LZW (3). The rest are backend or container handlers until an approved library adapter is registered.

SLCompressionLz4 #sleela 2.5 (lib/compression/SLCompressionLz4.sleela)

SLCompressionLz4 class

LZ4 algorithm class — the SLeeLa-facing handle to algorithm id 11.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionLzma #sleela 2.5 (lib/compression/SLCompressionLzma.sleela)

SLCompressionLzma class

LZMA algorithm class — the SLeeLa-facing handle to algorithm id 8.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionLzw #sleela 2.5 (lib/compression/SLCompressionLzw.sleela)

SLCompressionLzw class

Lempel-Ziv-Welch algorithm class — the SLeeLa-facing handle to algorithm id 3.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 0 == native.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionProcessor #sleela 2.5 (lib/compression/SLCompressionProcessor.sleela)

SLCompressionProcessor class

Defines the SLeeLa standard-library type SLCompressionProcessor used within the compression library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
canProcessboolean canProcess(boolean loaded, boolean nativeAlg, boolean backendReady)canProcess: can this algorithm compress/decompress right now, given the facts? True for a loaded native algorithm, or a loaded backend algorithm with a backend registered — what a GUI checks before enabling an action.
compressint compress(boolean loaded, boolean nativeAlg, boolean backendReady)compress: dispatch a compress against the given facts. Returns a result code: -5 not loaded, 0 ok (native or backend ready), -1 backend absent.
decompressint decompress(boolean loaded, boolean nativeAlg, boolean backendReady)decompress: same result-code contract as compress.

SLCompressionRle #sleela 2.5 (lib/compression/SLCompressionRle.sleela)

SLCompressionRle class

Run-Length Encoding algorithm class — the SLeeLa-facing handle to algorithm id 1.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 0 == native.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionSnappy #sleela 2.5 (lib/compression/SLCompressionSnappy.sleela)

SLCompressionSnappy class

Snappy algorithm class — the SLeeLa-facing handle to algorithm id 13.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionStore #sleela 2.5 (lib/compression/SLCompressionStore.sleela)

SLCompressionStore class

Store (raw) algorithm class — the SLeeLa-facing handle to algorithm id 0.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 0 == native.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionVerifier #sleela 2.5 (lib/compression/SLCompressionVerifier.sleela)

SLCompressionVerifier class

Defines the SLeeLa standard-library type SLCompressionVerifier used within the compression library family.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
resolveExtensionint resolveExtension(String ext)---- extension resolution (mirrors sleela_compression_by_extension) ----- Returns the algorithm id for a known extension, or -1 if unrecognized.
probeMagicint probeMagic(String tag)---- content-signature probe (mirrors each plugin's probe()) ------------ Given a short leading-byte signature tag (as text), return the algorithm id that claims it, or -1. The actual byte comparison lives in the native plugin; here the Verifier encodes which magic belongs to which algorithm so a GUI can pre-classify.
headerlessboolean headerless(int id)headerless(id): true for algorithms with no reliable magic (Store, RLE, raw DEFLATE, Brotli), where probing by content cannot confirm the format — the caller must select it out-of-band by id or extension.
verifyLoadableint verifyLoadable(int id)---- loadability / lifecycle verification ------------------------------- verifyLoadable(id): 0 if the id is a real algorithm that can be loaded, else -2 (invalid). Mirrors the manager's id_ok guard.
resultTextString resultText(int code)---- result-code text (mirrors sleela_compression_result_text) ----------
okboolean ok(int code)No description in source.

SLCompressionXz #sleela 2.5 (lib/compression/SLCompressionXz.sleela)

SLCompressionXz class

xz (LZMA2) algorithm class — the SLeeLa-facing handle to algorithm id 9.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionZip #sleela 2.5 (lib/compression/SLCompressionZip.sleela)

SLCompressionZip class

ZIP archive algorithm class — the SLeeLa-facing handle to algorithm id 14.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 3 == container.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionZlib #sleela 2.5 (lib/compression/SLCompressionZlib.sleela)

SLCompressionZlib class

zlib (RFC 1950) algorithm class — the SLeeLa-facing handle to algorithm id 5.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLCompressionZstd #sleela 2.5 (lib/compression/SLCompressionZstd.sleela)

SLCompressionZstd class

Zstandard algorithm class — the SLeeLa-facing handle to algorithm id 10.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
idint id()Registry identity (mirrors sleela_compressor_handler).
nameString name()No description in source.
mimeString mime()No description in source.
extensionsString extensions()No description in source.
stateint state()Capability state: 1 == backend.
stateNameString stateName()No description in source.
canCompressboolean canCompress()Direction support advertised by the plugin vtable.
canDecompressboolean canDecompress()No description in source.
isNativeboolean isNative()Native algorithms implement compress/decompress in-package (no external backend).
needsBackendboolean needsBackend()A backend adapter must be registered before a backend algorithm can run.

SLPackage #sleela 2.5 (lib/compression/SLPackage.sleela)

SLPackage class

Defines the SLeeLa standard-library package for compression.

Carries the standard Metadata Class record — eleven catalogued provenance attributes (version, id, author, date, copyright, trademark, corporation, origin, birth date, science rating, national schedule) with matching get/set accessors. These are omitted from the tables below for brevity.

Fields — the named values this unit stores.

FieldDeclarationWhat it holds
packageNameString packageNameNo description in source.

Methods — the actions this unit can perform.

MethodSignatureWhat it does
configurevoid configure(String name)No description in source.
nameString name()No description in source.
availableboolean available()No description in source.