https://github.com/nkh-lab/liblightargparser

Lightweight static library for parsing program input arguments in <Key>=<Value> format.
https://github.com/nkh-lab/liblightargparser

argument-parser

Last synced: 4 days ago
JSON representation

Lightweight static library for parsing program input arguments in <Key>=<Value> format.

• Host: GitHub
• URL: https://github.com/nkh-lab/liblightargparser
• Owner: nkh-lab
• License: gpl-3.0
• Created: 2022-08-23T15:52:52.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-06T09:37:44.000Z (about 1 year ago)
• Last Synced: 2023-11-06T10:41:18.399Z (about 1 year ago)
• Topics: argument-parser
• Language: C++
• Homepage:
• Size: 44.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## Intro

Lightweight static library for parsing program input arguments in `=` format. 

If `` starts with "-" (one minus character) or "--" (two minus characters), it is called **a configuration argument**, otherwise it is called **a data argument**.

Configuration arguments examples:

```

-v

--help

-xyz // equals -x -y -z

--file=/temp/file1

```

Data arguments examples:

```

DataKey1 // with omitted value

DataKey2=DataValue2

```

Application run example:

```

$ ./my-app -v --help -xyz DataKey1 DataKey2=DataValue2 --file=/temp/file1

```

## Build Status

[![CI](https://github.com/nkh-lab/liblightargparser/actions/workflows/ci.yml/badge.svg)](https://github.com/nkh-lab/liblightargparser/actions/workflows/ci.yml)

## How to use

This is a cmake based project, so add it to your build process, link your target to the `lightargparser` library, and include the `LightArgParser.h` header in your source code.

API usage example:

```

#include 

#include "LightArgParser.h"

using namespace nkhlab::lightargparser;

int main(int argc, char const* argv[])

{

    LightArgParser lap(argc, argv);

    Args_t config_args, data_args;

    std::string bad_arg;

    if (lap.Parse(config_args, data_args, bad_arg))

    {

        if (!config_args.empty())

        {

            if (LightArgParserHelper(config_args).AnyKeyExists({"v", "version"}))

                std::cout << "v1.0.0\n";

            std::cout << "Configuration arguments : :\n";

            for (auto c : config_args) std::cout << "    " << c.first << ": " << c.second << "\n";

        }

        else

            std::cout << "No configuration arguments provided!\n";

        if (!data_args.empty())

        {

            std::cout << "Data arguments : :\n";

            for (auto d : data_args) std::cout << "    " << d.first << ": " << d.second << "\n";

        }

        else

            std::cout << "No data arguments provided!\n";

    }

    else

        std::cout << "Bad argument: " << bad_arg << "\n";

    // ...

}

```

And its execution:

```

./myapp -r=RPSH_1 -t=100 -v data1=100 data2

v1.0.0

Configuration arguments : :

    r: RPSH_1

    t: 100

    v:

Data arguments : :

    data1: 100

    data2:

```

For more details, refer to [tests/component](tests/component) as a real example of `lightargparser` library usage.