Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kyriets/lzw

Implementation of LZW dictionary compression algorithm.
https://github.com/kyriets/lzw

Last synced: 21 days ago
JSON representation

Implementation of LZW dictionary compression algorithm.

Host: GitHub
URL: https://github.com/kyriets/lzw
Owner: KyrietS
License: mit
Created: 2020-04-06T23:29:09.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2021-07-25T00:31:59.000Z (over 3 years ago)
Last Synced: 2024-11-07T13:52:42.140Z (2 months ago)
Language: C++
Size: 205 KB
Stars: 0
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.adoc

Awesome Lists containing this project

README

        = LZW (Lempel-Ziv-Welch) Dictionary Coding

A simple implementation of compression method known as LZW (Lempel-Ziv-Welch). LZW is a loseless data compression algorithm.

== Usage

Type `lzw --help` to get help. General usage:

----

lzw (--encode|--decode) [-o,-s] source [dest]

----

=== Available options

----

  -e,--encode                 Encode a file

  -d,--decode                 Decode a file

  -h,--help                   Print help message and exit

  -o,--override               Whether output file should override existing file.

  -s,--stats                  Print stats during and after encoding process.

----

By default `dest` is set to `{source}.lzw`.

=== Examples

*Encoding file with stats printed out* (`dest` file must not exist)

----

./lzw --encode -s file.txt output.lzw

----

*Decoding file with progress bar* (`dest file will be overwritten`)

----

./lzw -dso output.lzw file2.txt

----

== Project structure

There are currently 3 projects in this workspace.

[%autowidth]

|===

^|Project | Description

^.^|LZW_Core

|Core functionality of LZW coding. All logic is there including file i/o. This project produces [underline]#static library# that is used in _LZW_CLI_ and _LZW_Core_Tests_ as a dependency.

^.^|LZW_CLI

|Command-Line Interface for _LZW_Core_ functions. This project produces executable program called `lzw` (by default).

^.^|LZW_Core_Tests

|Collection of unit tests for _LZW_Core_ functionalities. This project produces executable with embeded CLI from Catch2. For more info read https://github.com/catchorg/Catch2/blob/master/docs/command-line.md[official docs].

|===

=== External libraries

_LZW_Core_ library doesn't have any external dependencies except C++ standard library.

* https://github.com/CLIUtils/CLI11[CLI11] provides command-line arguments parser for _LZW_CLI_.

* https://github.com/catchorg/Catch2[Catch2] is used in _LZW_Core_Tests_ as a testing framework.

== Building

You need https://premake.github.io/download.html[Premake5] to easily generate project files (e.g. for Visual Studio, Code::Blocks, Xcode, GNU Make and more)

In root folder run `premake5` with an argument depending on IDE you want to use. For example, run: `premake5 vs2019` if you want to generate project for Visual Studio 2019.

=== Visual Studio (Windows)

In root folder run `premak5 vs2019`. Visual Studio solution with projects will be generated. Open `LZW.sln` with Visual Studio. Everything should be configured properly to build, run and test the program.

=== Makefile (Linux)

In root folder run `premake5 [--cc=gcc|clang] gmake2`. If `--cc` option is not set, then default C++ compiler will be used. Makefile files structure will be generated. In root folder run `make help` to get available build options. General usage is:

----

make [config=release|debug] [target]

TARGETS:

    all (default)

    LZW_CLI

    LZW_Core

    LZW_Core_Tests

----

Executable binaries are stored in `bin/` folder. Release config is used by default.

*Importnat note:* Because of using `` standard library in `LZW_CLI` and `LZW_Core_Tests` projects it is necessary to have it installed on your computer. If you generate project for *gcc* then library `stdc\++fs` is automatically linked via `-l` option. Note that `` library is available in gcc since version _8.x_. In earlier versions there was ``. Since version _9.x_ of gcc it's not necessary to link against `stdc++fs` anymore. *Clang* was not tested.

== Tests

Project _LZW_Core_Tests_ contains all the tests for _LZW_Core_. You can build it and run executable `lzw_core_tests` to verify tests.

== License

Copyright © 2020 KyrietS +

Use of this software is granted under the terms of the MIT License.

See the link:LICENCE[LICENSE] for the full license text.