libclime

Command line arguments parser for modern C++.

Using this library

#include "clime/parser.hpp"
...
int main(int argc, const char **argv) {
    int intValue = 0;
    auto floatValue = 0.0f;
    auto userName = StringView{getenv("USER")};

    auto const res = Parser("Solace cli single action example", {
                Parser::printHelp(),
                Parser::printVersion(kAppName, kAppVersion),

                {{"i", "intOption"}, "Some useless parameter for the demo", &intValue},
                {{"fOption"}, "Foating point value for the demo", &floatValue},
                {{"u", "name"}, "Greet user name", &userName}
            })
            .parse(argc, argv);

    if (!res) {
        std::cerr << res.getError();
        return EXIT_FAILURE;
    }

    std::cout << "Hello '" << userName << "'" << std::endl;

    return EXIT_SUCCESS;
}

See examples for other example usage of this library.

Dependencies

This library depends on libsolace for low level data manipulation primitives such as ByteReader/ByteWriter and Result<> type.

GTest

Note test framework used is gtest and it is managed via git modules. Don't forget to do git submodule update --init --recursive on a new checkout to pull sub-module dependencies.

Contributing changes

The framework is work in progress and contributions are very welcomed. Please see CONTRIBUTING.md for details on how to contribute to this project.

Please note that in order to maintain code quality a set of static code analysis tools is used as part of the build process. Thus all contributions must be verified by this tools before PR can be accepted.

Building

Build tool dependencies

In order to build this project following tools must be present in the system:

git (to check out project and it’s external modules, see dependencies section)
doxygen (for documentation)
cppcheck (static code analysis, latest version from git is used as part of the 'codecheck' step)
cpplint (for static code analysis in addition to cppcheck)
valgrind (for runtime code quality verification)

This project is using C++17 features extensively. The minimal tested/required version of gcc is gcc-7. CI is using clang-6 and gcc-7. To install build tools on Debian based Linux distribution:

sudo apt-get update -qq
sudo apt-get install git doxygen python-pip valgrind ggcov
sudo pip install cpplint

The library has one external dependency: libsolace which is managed via conan. Please make sure conan is installed on your system if you want to build this project.

Building the project

# In the project check-out directory:
# To build debug version with sanitizer enabled (recommended for development)
./configure --enable-debug --enable-sanitizer

# To build the library it self
make

# To build and run unit tests:
make test

# To run valgrind on test suit:
# Note: `valgrind` doesn’t work with ./configure --enable-sanitize option
make verify

# To build API documentation using doxygen:
make doc

To install locally for testing:

make --prefix=/user/home/<username>/test/lib install

To install system wide (as root):

make install

To run code quality check before submission of a patch:

# Verify code quality before submission
make codecheck

License

Please see LICENSE file for details

Authors

Please see AUTHORS file for the list of contributors

abbyssoul/libclime