IMPORTANT: This repository is no longer maintained, because in context of issue kitsudaiki/OpenHanami#31 the content was moved into the main-repository (https://github.com/kitsudaiki/Hanami-AI).
Small and easy to use parser for CLI-arguments.
| name | repository | version | task |
|---|---|---|---|
| g++ | g++ | >= 8.0 | Compiler for the C++ code. |
| make | make | >= 4.0 | process the make-file, which is created by qmake to build the programm with g++ |
| qmake | qt5-qmake | >= 5.0 | This package provides the tool qmake, which is similar to cmake and create the make-file for compilation. |
Installation on Ubuntu/Debian:
sudo apt-get install g++ make qt5-qmakeIMPORTANT: All my projects are only tested on Linux.
| Repository-Name | Version-Tag | Download-Path |
|---|---|---|
| libKitsunemimiCommon | develop | https://github.com/kitsudaiki/libKitsunemimiCommon.git |
HINT: These Kitsunemimi-Libraries will be downloaded and build automatically with the build-script below.
In all of my repositories you will find a build.sh. You only have to run this script. It doesn't required sudo, because you have to install required tool via apt, for example, by yourself. But if other projects from me are required, it download them from github and build them in the correct version too. This script is also use by the ci-pipeline, so its tested with every commit.
Run the following commands:
git clone https://github.com/kitsudaiki/libKitsunemimiArgs.git
cd libKitsunemimiArgs
./build.sh
cd ../result
It create automatic a build and result directory in the directory, where you have cloned the project. At first it build all into the build-directory and after all build-steps are finished, it copy the include directory from the cloned repository and the build library into the result-directory. So you have all in one single place.
Tested on Debian and Ubuntu. If you use Centos, Arch, etc and the build-script fails on your machine, then please write me a mail and I will try to fix the script.
This example should show, how the parser is used and what is possible.
HINT: The flags --help and -h for the help-output are hard coded and don't have to be set.
#include <libKitsunemimiArgs/arg_parser.h>
#include <libKitsunemimiPersistence/logger/logger.h>
#include <libKitsunemimiCommon/logger.h>
int main(int argc, char *argv[])
{
// error messages of the parser are printed via logger
Kitsunemimi::initConsoleLogger(true);
// with "initFileLogger" the error-message of the argument-parser can also be written into a file
Kitsunemimi::ArgParser parser("0.1.0");
Kitsunemimi::ErrorContainer error;
// register flags without value
parser.registerPlain("debug,d",
"debug-flag to enable addtional debug output",
error);
// "registerPlain" allows it to register flags without any value, which says only true or flase
// if they were set or not set
// register flags
parser.registerString("source",
"source-path",
error,
true);
parser.registerInteger("input,i",
"additional parameter");
// register other values
parser.registerString("mode",
"modus for converting",
error,
true, // true to make it requried
true); // true to register this without a "--"-flag
parser.registerString("destination",
"destination path for output",
error,
true,
true);
// register types:
// registerString
// registerInteger
// registerFloat
// registerBoolean
// parse incoming arguments
bool ret = parser.parse(argc, argv, error);
if(ret == false)
{
LOG_ERROR(error);
return 1;
}
// ret say, if the converting was successful or not. Error-message are written in the logger
// check if flags without values were set. In this case check if the debug-flag was set
bool debug = parser.wasSet("debug");
// get values with or without flag as list of value for the case, that a flag was
// used multiple times within one cli-call:
const std::vector<std::string> testValues = parser.getStringValues("source");
const std::vector<long> numbers = parser.getIntValues("input");
// get types:
// getStringValues
// getIntValues
// getFloatValues
// getBoolValues
// get values without flag:
const std::string mode = parser.getStringValue("mode");
const std::string destination = parser.getStringValue("destination");
// get types:
// getStringValue
// getIntValue
// getFloatValue
// getBoolValue
//...
return 0;
}
If the tool would called cli_test the command cli_test --help would produce the following output:
command: cli_test [options] --source ... <mode> <destination>
Options:
+-----------+-------+--------+-------------+---------------------------------------------+
| long | short | type | is required | help-text |
+===========+=======+========+=============+=============================================+
| --help | -h | | | print help ouput |
+-----------+-------+--------+-------------+---------------------------------------------+
| --version | -v | | | print program version |
+-----------+-------+--------+-------------+---------------------------------------------+
| --debug | -d | | | debug-flag to enable addtional debug output |
+-----------+-------+--------+-------------+---------------------------------------------+
| --source | | string | x | source-path |
+-----------+-------+--------+-------------+---------------------------------------------+
| --input | -i | number | | additional parameter |
+-----------+-------+--------+-------------+---------------------------------------------+
Required:
+---------------+--------+-----------------------------+
| name | type | text |
+===============+========+=============================+
| <mode> | string | modus for converting |
+---------------+--------+-----------------------------+
| <destination> | number | destination path for output |
+---------------+--------+-----------------------------+
If this example is called with a string asdf for the flag -i, the error-message looks like this:
ERROR: argument has the false type:
required type: number
identifier: -i
given value: asdf
Please give me as many inputs as possible: Bugs, bad code style, bad documentation and so on.
This project is licensed under the MIT License - see the LICENSE file for details