https://github.com/tony-go/qupp
A library for creating interactive command-line prompts in C++.
https://github.com/tony-go/qupp
Last synced: 3 months ago
JSON representation
A library for creating interactive command-line prompts in C++.
- Host: GitHub
- URL: https://github.com/tony-go/qupp
- Owner: tony-go
- Created: 2023-08-27T08:07:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-03T17:49:03.000Z (over 1 year ago)
- Last Synced: 2025-02-04T16:18:35.200Z (5 months ago)
- Language: C++
- Size: 983 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
🚧 **Disclaimer:** This project is currently under development and might not be production-ready.
# qupp
**qupp** is a lightweight library designed to simplify the user input prompt process in C++ applications.
## 🌟 Features
- 🎉 Simplified user input prompts.
- 🌍 Cross-platform (work in progress).
- 🛠️ CMake-friendly integration (work in progress)
## 📖 Usage (API)
### Prompt::ask_for_input
Prompts the user for input with the provided question.
| Parameter | Type | Description |
|------------|----------------|-------------------------------|
| `question` | `std::string` | The question to present to the user. |
**Returns**: `std::optional` containing the user's input if provided, or an empty optional if the user provides no input.
```cpp
#include
int main() {
qupp::prompt::Prompt prompt;
auto result = prompt.ask_for_input("What's your name? ");
std::cout << "Hello, " << result.value() << "!" << std::endl;
return 0;
}
```
### Prompt::select
Presents a list of options to the user and allows them to select one.
| Parameter | Type | Description |
|------------|-----------------------------|------------------------------------|
| `question` | `std::string` | The question to present to the user. |
| `options` | `std::vector` | A list of options for the user to select from. |
**Returns:** `std::optional` containing the selected option or empty if no selection was made.
```cpp
#include
int main() {
qupp::prompt::Prompt prompt;
auto selected = prompt.select(
"Select an option:", {"Option 1", "Option 2", "Option 3 "});
if (selected.has_value()) {
std::cout << "You selected: " << selected.value() << "\n";
} else {
std::cout << "You did not select anything."
<< "\n";
}
return 0;
}
```
### Prompt::select_multiple
Presents a list of options to the user and allows them to select multiple.
| Parameter | Type | Description |
|------------|-----------------------------|------------------------------------|
| `question` | `std::string` | The question to present to the user. |
| `options` | `std::vector` | A list of options for the user to select from. |
**Returns:** `std::optional>` containing the selected options or empty if no selections were made.
```cpp
#include
int main() {
auto choices = prompt.select_multiple("Select multiple options:",
{"Option 1", "Option 2", "Option 3 "});
if (choices.has_value()) {
std::cout << "You selected: ";
for (const auto &choice : choices.value()) {
std::cout << choice << " ";
}
std::cout << "\n";
} else {
std::cout << "You did not select anything."
<< "\n";
}
}
```
## 🤝 Contributing
### Building
1. Clone the repository:
```bash
git clone https://github.com/tony-go/qupp.git
```
2. Build
```bash
make
```
### 🧪 Testing
Tests are implemented using Google Test.
After building, run:
```bash
make test
```
## 📜 License
MIT License. See `LICENSE` for more information.