ArgParser is a simple C++ library for parsing command-line arguments with support for various data types.
ArgParser is designed to provide an easy-to-use interface for parsing command-line arguments in C++ programs. It supports various data types such as bool, int, double, and string, allowing developers to quickly integrate command-line argument parsing into their applications.
To use ArgParser in your C++ project, follow these steps:
-
Clone the ArgParser repository:
git clone https://github.com/Pankaja-Suganda/Argparser.git
-
Include the
argparserdirectory in your project. -
Link your project with the ArgParser library.
To use ArgParser in your C++ program, include the argparser.h header file and create an instance of the ArgParser class. Add arguments using the addArgument method, parse command-line arguments using the parse method, and retrieve values using the get method.
#include <argparser.h>
int main(int argc, char* argv[]) {
ArgParser parser(
"Argument Parser v1.1", // Project name
"This project can be used to parse command line arguments" // Description
);
// Add arguments
parser.addArgument("boolArg", "-b", "--bool", "Bool argument", false);
parser.addArgument("intArg", "-i", "--int", "Int argument", 12);
parser.addArgument("doubleArg", "-d", "--double", "Double argument", 12.23);
parser.addArgument("strArg", "-s", "--string", "String argument", "default");
// Parse command-line arguments
parser.parse(argc, argv);
// Retrieve values
bool boolValue = parser.get<bool>("boolArg");
int intValue = parser.get<int>("intArg");
double doubleValue = parser.get<double>("doubleArg");
std::string stringValue = parser.get<std::string>("strArg");
// Use retrieved values in your program logic
return 0;
}To display help information, use the following commands:
./<exe-name>.exe -h or
./<exe-name>.exe --helpUpon execution, it will output:
Argument Parser v1.1
DESCRIPTION:
This project can be used to parse command line arguments
USAGE:
-b, --bool : This is a flag argument
-d, --double : This is a double argument
-i, --int : This is a int argument
-s, --string : This is a string argument
Replace <exe-name> with the actual name of your executable. This section provides a quick guide on how users can access help information along with an example output showcasing the available command-line arguments.
Otherthan that user can add own help command with built-in help command, then the user specified function will execute before help command.
// Example user-specified callback
void userSpecifiedCallback() {
printf("Executing user-specified callback before the built-in help command.");
}
int main(int argc, char* argv[]) {
ArgParser parser;
// Set user-specified callback for help
parser.setHelpCallback(userSpecifiedCallback);
// Parse command-line arguments
parser.parse(argc, argv);
// ... rest of the program
return 0;
}Here are some examples demonstrating the usage of ArgParser:
// Add a boolean argument with a default value of false
parser.addArgument("boolArg", "-b", "--bool", "Bool argument", false);
// Parse command-line arguments
parser.parse(argc, argv);
// Retrieve the boolean value
bool boolValue = parser.get<bool>("boolArg");// Add an integer argument with a default value of 42
parser.addArgument("intArg", "-i", "--int", "Int argument", 42);
// Parse command-line arguments
parser.parse(argc, argv);
// Retrieve the integer value
int intValue = parser.get<int>("intArg");// Add a double argument with a default value of 3.14
parser.addArgument("doubleArg", "-d", "--double", "Double argument", 3.14);
// Parse command-line arguments
parser.parse(argc, argv);
// Retrieve the double value
double doubleValue = parser.get<double>("doubleArg");// Add a string argument with a default value of "default"
parser.addArgument("strArg", "-s", "--string", "String argument", "default");
// Parse command-line arguments
parser.parse(argc, argv);
// Retrieve the string value
std::string stringValue = parser.get<std::string>("strArg");Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
This project is not licensed yet - see the LICENSE.md file for details.