README.md

Examples of LiteString usage

This directory contains examples of using the LiteString library.

Before building the examples, make sure that the LiteString library is built or installed.

For building the LiteString library, refer to the README file in the root directory.

C API

word stats - Counts the number of characters and words in a text file.

The text file should not be bigger than 1MB.

# Compile and link the example
ian@github:examples$ gcc -std=c2x -o word_stats word_stats.c -L /path/to/built/lite-string/library -llite-string

# Run the example
ian@github:examples$ ./word_stats blindtext.txt
# Expected output:
Word count: 5800
Character count: 33355
Average word length: 5.75

C++ API

grep clone - A simple clone of the grep command.

# Compile and link the example
ian@github:examples$ g++ -std=c++20 -o cheap_grep cheap_grep.cpp -L /path/to/built/lite-string/library -llite-string

# Run the example
ian@github:examples$ ./cheap_grep -i "ipsum dolor" blindtext.txt

# The program can also read from standard input, when the file name is replaced with a hyphen
ian@github:examples$ cat blindtext.txt | ./cheap_grep -i "ipsum dolor" -
./cheap_grep -i "lorem ipsum dolor sit amet consectetur adipiscing" - < blindtext.txt

Building with CMake

The CMakeLists.txt file in this directory can be used to build the examples.

# From this directory (examples), run:
mkdir build
cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -G Ninja
cmake --build build --config Release -j 4

The examples can be run from the build directory. (Or, from the Release subdirectory of build directory, if you have built with a multi-configuration generator, like Visual Studio.)

# From this directory (examples), run:
./build/word_stats blindtext.txt
./build/cheap_grep -i "ipsum dolor" blindtext.txt

For more elaborate examples, refer to the tests' directory.

You can also check Cachetron, a simple cache server, which uses an earlier version of LiteString for parsing the commands and for other string manipulations.