https://github.com/bialger/argparser
C++/CMake library for POSIX-compatible argument parsing. ITMO SE'27 first year programming laboratory work.
https://github.com/bialger/argparser
argument-parser cli-argument-parser cpp-argparse cpp-library posix-compliant student-project
Last synced: 3 months ago
JSON representation
C++/CMake library for POSIX-compatible argument parsing. ITMO SE'27 first year programming laboratory work.
- Host: GitHub
- URL: https://github.com/bialger/argparser
- Owner: bialger
- License: gpl-3.0
- Created: 2024-07-06T11:53:54.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-08-28T16:34:16.000Z (about 1 year ago)
- Last Synced: 2025-03-07T14:52:12.483Z (7 months ago)
- Topics: argument-parser, cli-argument-parser, cpp-argparse, cpp-library, posix-compliant, student-project
- Language: C++
- Homepage:
- Size: 222 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Библиотека ArgParser
Данная библиотека определяет POSIX-совместимый парсер аргументов командной строки - библиотеку `argparser`.
Использует CMake.
Она была написана как лабораторная работа в курсе "Основы программирования на C++" в программе ITMO SE.
С заданием можно ознакомиться [здесь](./TASK.md).
В библиотеке определен парсинг стандартных примитивов, таких как `int`, `float`, `char` и т.д., а также
парсинг `std::string`.
Есть возможность добавлять логику парсинга для иных типов документов (см. [пример](./bin/main.cpp)).
Документация библиотеки находится [во вложенной папке](./lib/argparser/docs/README.md).
## Использование в проекте
Более подробно об использовании ArgParser можно прочитать на странице
[пользовательской документации](./lib/argparser/docs/ArgParser.md).
### CMake
Данную библиотеку можно получить через FetchContent:
```cmake
FetchContent_Declare(argparser GIT_REPOSITORY https://github.com/bialger/ArgParser)
FetchContent_MakeAvailable(argparser)
target_link_libraries(MyTarget PUBLIC argparser)
```
Можно использовать конкретную ветку, тег версии или коммит:
```cmake
FetchContent_Declare(argparser GIT_REPOSITORY https://github.com/bialger/ArgParser GIT_TAG dev)
```
```cmake
FetchContent_Declare(argparser GIT_REPOSITORY https://github.com/bialger/ArgParser GIT_TAG v1.1.0)
```
## Пример использования и добавления аргумента
Для добавления пользовательского типа аргумента `Type`, он должен удовлетворять следующим требованиям:
* Иметь конструктор без параметров и конструктор копирования
* Иметь оператор присваивания с копированием
* Должен быть определен оператор `std::ostream& operator<<(std::ostream& os, const Type& t)`
* Должна быть определена функция получения значения из `std::string`:
`ArgumentParser::NonMemberParsingResult ParseType(const std::string&)`
Тогда для добавления аргумента можно использовать макрос:
`AddArgumentType(Type, ParseType)`.
При вызове конструктора класса `ArgParser` должен быть передан аргумент типа
`ArgumentTypes`, где `Args...` - типы добавленных аргументов.
Это можно сделать удобно при помощи макроса `PassArgumentTypes(Args...)`.
В вышеприведенном примере следует передать `PassArgumentTypes(Type)`.
CMakeLists.txt:
```cmake
cmake_minimum_required(VERSION 3.28)
project(TestArgParser)
set(CMAKE_CXX_STANDARD 20)
include(FetchContent)
FetchContent_Declare(argparser GIT_REPOSITORY https://github.com/bialger/ArgParser)
FetchContent_MakeAvailable(argparser)
add_executable(TestArgParser main.cpp)
target_link_libraries(TestArgParser PRIVATE argparser)
```
main.cpp:
```cpp
#include
#include
enum class Action {
kNone = 0,
kSum = 1,
kMul = 2,
};
std::ostream& operator<<(std::ostream& os, Action action) {
switch (action) {
case Action::kSum:
os << "sum";
break;
case Action::kMul:
os << "mul";
break;
case Action::kNone:
os << "none";
break;
}
return os;
}
ArgumentParser::NonMemberParsingResult ParseAction(const std::string& action) {
ArgumentParser::NonMemberParsingResult result{};
if (action == "sum") {
result.value = Action::kSum;
} else if (action == "mul") {
result.value = Action::kMul;
} else {
result.success = false;
result.value = Action::kNone;
}
return result;
}
AddArgumentType(Action, ParseAction)
void InitializeParser(ArgumentParser::ArgParser& parser) {
std::string action_alias = "Action";
std::string action_description = "Action type";
parser.SetAliasForType(action_alias);
parser.AddArgument('a', "action", action_description);
parser.AddHelp('h', "help", "Program accumulate arguments");
}
int main(int argc, char *argv[]) {
ArgumentParser::ArgParser parser("TestArgParser", PassArgumentTypes(Action));
InitializeParser(parser);
bool result = parser.Parse(argc, argv, {std::cerr, true});
if (!result) {
std::cout << parser.HelpDescription() << std::endl;
return 1;
}
if (parser.Help()) {
std::cout << parser.HelpDescription() << std::endl;
return 0;
}
if (parser.GetValue() == Action::kSum) {
std::cout << "Summarize" << std::endl;
} else if (parser.GetValue() == Action::kMul) {
std::cout << "Multiply" << std::endl;
}
std::cout << std::boolalpha << parser.GetFlag("test") << std::endl;
return 0;
}
```