Giter VIP home page Giter VIP logo

cppclip's Introduction

cppclip

C++ cli parser

License: MIT

A small C++ library to simplify parsing arguments

Usage

Include in your app

#include "CppClip.hpp"

Instantiate the parser

CppClip::ArgumentParser parser("program");

Add a description

parser.addDescription("Program description");

Add an epilogue

parser.addEpilogue("Epilogue");

Add arguments

The parser uses method chaining to specify parameters for arguments
Arguments must be added in reverse order! (bottom to top gets processed left to right)

Non-optional positional arguments

parser.add("ip").nargs(2);

Long & short argument form

parser.add("-v", "--version").help("show version and exit");
parser.add("-h", "--help").help("Show help and exit");

Adding help to an argument

parser.add("-s").help("something");

Add an optional positional argument

parser.add("number");

Processing arguments

Exception handling is done using a try catch block

try {
    ...
} catch (std::exception &e) {
    parser.printHelp();
    std::cerr << "\nError: " << e.what() << '\n';
    exit(1);
}

Parsing user input

parser.parse(argc, argv);

Checking if an option is set

// The long option is checked automatically
if (parser.isSet("-h")) {
    parser.printHelp();
    exit(0);
}

Extracting positional arguments

const std::vector<std::string> &ip = parser.getPositional("ip");

Missing features

  • Ability to add multiple optional positional arguments

cppclip's People

Contributors

matyassykora avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.