mirror of
https://github.com/p-ranav/indicators.git
synced 2025-12-16 04:18:51 +08:00
Compare commits
107 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
695fac00b4 | ||
|
|
17e1f47fd4 | ||
|
|
a1ad525065 | ||
|
|
ad6cddbd0e | ||
|
|
b389f5e559 | ||
|
|
04cdd25844 | ||
|
|
e463046745 | ||
|
|
3a798551ba | ||
|
|
26c4c0286e | ||
|
|
5972b18450 | ||
|
|
6f057a51a1 | ||
|
|
b215cb850e | ||
|
|
e950065e34 | ||
|
|
643e5ce6a1 | ||
|
|
11ec12c0cb | ||
|
|
d2179d75ce | ||
|
|
6d73795218 | ||
|
|
6857345da5 | ||
|
|
3800785216 | ||
|
|
a949efd512 | ||
|
|
296bde6088 | ||
|
|
66af25ab62 | ||
|
|
371bcb2c3b | ||
|
|
df4a97b068 | ||
|
|
55494a572b | ||
|
|
3d1d01ba0d | ||
|
|
c2beb2ac22 | ||
|
|
d99cad1ede | ||
|
|
ad5cf841be | ||
|
|
4aef1470f1 | ||
|
|
dd08556b27 | ||
|
|
57a942f392 | ||
|
|
78a98fec4d | ||
|
|
06414bb6db | ||
|
|
cd6dc2aebf | ||
|
|
446b0d3147 | ||
|
|
a3e50e0862 | ||
|
|
936b8e66d8 | ||
|
|
16d3484788 | ||
|
|
833e1cd6db | ||
|
|
07b9eede8a | ||
|
|
562cb80a36 | ||
|
|
7e43298470 | ||
|
|
fd21e7d81f | ||
|
|
37b3fc395e | ||
|
|
99f4f3f05b | ||
|
|
5a9419b191 | ||
|
|
4ada9e3f77 | ||
|
|
8ad116cc5f | ||
|
|
4b1ce0d2f7 | ||
|
|
3fb4eb9dd1 | ||
|
|
0e041e8fea | ||
|
|
201ce9c4fb | ||
|
|
d4a38eb034 | ||
|
|
ec1973607d | ||
|
|
5049e70c50 | ||
|
|
5bc3183c12 | ||
|
|
fcda546c9c | ||
|
|
f5c1e61676 | ||
|
|
c7b25e7c3a | ||
|
|
5e75c285fe | ||
|
|
7298c7140d | ||
|
|
0ace816e52 | ||
|
|
91d51548fc | ||
|
|
83da7c3469 | ||
|
|
b13ff53c26 | ||
|
|
7c762ed146 | ||
|
|
3c969556c3 | ||
|
|
297790bcd7 | ||
|
|
f9d3eb1bcc | ||
|
|
89ae8cec39 | ||
|
|
f5b6b4d779 | ||
|
|
2b27d8f516 | ||
|
|
77bc52b591 | ||
|
|
a6c55b6936 | ||
|
|
e7b3d077f0 | ||
|
|
0588904b9d | ||
|
|
4442e3570f | ||
|
|
2698afb34b | ||
|
|
764d796f87 | ||
|
|
5c54b69e55 | ||
|
|
186f1aafc7 | ||
|
|
cfb1593806 | ||
|
|
4a207b8223 | ||
|
|
07734c412b | ||
|
|
d543453c0c | ||
|
|
e279bbb7e7 | ||
|
|
840743f312 | ||
|
|
46c9983fab | ||
|
|
b1c16d8881 | ||
|
|
06da3a97f4 | ||
|
|
a2272eba8a | ||
|
|
46bccdcc1c | ||
|
|
3c8975aa34 | ||
|
|
9a4729f577 | ||
|
|
866c008492 | ||
|
|
dcb7c656cc | ||
|
|
cfcc9f3b4c | ||
|
|
91ac917bbc | ||
|
|
0939406db4 | ||
|
|
d4dea6db2a | ||
|
|
0dec563049 | ||
|
|
4f9796e904 | ||
|
|
a91d3b6ff7 | ||
|
|
1cba7fd321 | ||
|
|
b1f01d5e52 | ||
|
|
2291c8c39c |
16
.appveyor.yml
Normal file
16
.appveyor.yml
Normal file
@@ -0,0 +1,16 @@
|
||||
environment:
|
||||
CONAN_RUN_TESTS: True
|
||||
matrix:
|
||||
- APPVEYOR_BUILD_WORKER_IMAGE: Visual Studio 2019
|
||||
PATH: C:\\Python37;C:\\Python37\Scripts;C:\Users\appveyor\AppData\Roaming\Python\Python37\Scripts;%PATH%
|
||||
# - APPVEYOR_BUILD_WORKER_IMAGE: Ubuntu
|
||||
# PATH: /home/appveyor/.local/bin:$PATH
|
||||
# - APPVEYOR_BUILD_WORKER_IMAGE: macOS
|
||||
|
||||
install:
|
||||
- python --version
|
||||
- python -m pip install conan --upgrade --user
|
||||
- conan user
|
||||
|
||||
build_script:
|
||||
- conan create .
|
||||
117
CMakeLists.txt
117
CMakeLists.txt
@@ -1,44 +1,105 @@
|
||||
cmake_minimum_required(VERSION 3.8)
|
||||
project(indica VERSION 1.0.0 LANGUAGES CXX)
|
||||
option(INDICA_BUILD_TESTS OFF)
|
||||
option(SAMPLES "Build Samples" OFF)
|
||||
option(DEMO "Build Demo" OFF)
|
||||
|
||||
if(DEFINED PROJECT_NAME)
|
||||
set(INDICATORS_SUBPROJECT ON)
|
||||
endif()
|
||||
|
||||
if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.12")
|
||||
project(indicators VERSION 1.8.0 LANGUAGES CXX
|
||||
HOMEPAGE_URL "https://github.com/p-ranav/indicators"
|
||||
DESCRIPTION "Activity Indicators for Modern C++")
|
||||
elseif(CMAKE_VERSION VERSION_GREATER_EQUAL "3.9")
|
||||
project(indicators VERSION 1.8.0 LANGUAGES CXX
|
||||
DESCRIPTION "Activity Indicators for Modern C++")
|
||||
else()
|
||||
project(indicators VERSION 1.8.0 LANGUAGES CXX)
|
||||
endif()
|
||||
|
||||
if(EXISTS "${CMAKE_BINARY_DIR}/conanbuildinfo.cmake")
|
||||
include("${CMAKE_BINARY_DIR}/conanbuildinfo.cmake")
|
||||
conan_basic_setup()
|
||||
endif()
|
||||
|
||||
option(INDICATORS_BUILD_TESTS "Build indicators tests + enable CTest")
|
||||
option(INDICATORS_SAMPLES "Build indicators samples")
|
||||
option(INDICATORS_DEMO "Build indicators demo" OFF)
|
||||
|
||||
include(CMakePackageConfigHelpers)
|
||||
include(GNUInstallDirs)
|
||||
|
||||
find_package(Threads REQUIRED)
|
||||
|
||||
add_library(indica INTERFACE)
|
||||
add_library(indica::indica ALIAS indica)
|
||||
add_library(indicators INTERFACE)
|
||||
add_library(indicators::indicators ALIAS indicators)
|
||||
|
||||
target_compile_features(indica INTERFACE cxx_std_11)
|
||||
target_include_directories(indica INTERFACE
|
||||
target_compile_features(indicators INTERFACE cxx_std_11)
|
||||
target_include_directories(indicators INTERFACE
|
||||
$<INSTALL_INTERFACE:${CMAKE_INSTALL_INCLUDEDIR}>
|
||||
$<BUILD_INTERFACE:${CMAKE_CURRENT_LIST_DIR}/include>)
|
||||
target_link_libraries(indica INTERFACE Threads::Threads)
|
||||
target_link_libraries(indicators INTERFACE Threads::Threads)
|
||||
|
||||
|
||||
if( DEMO )
|
||||
add_subdirectory(demo)
|
||||
if(INDICATORS_DEMO)
|
||||
add_subdirectory(demo)
|
||||
endif()
|
||||
|
||||
if( SAMPLES )
|
||||
add_subdirectory(samples)
|
||||
if(INDICATORS_SAMPLES)
|
||||
add_subdirectory(samples)
|
||||
endif()
|
||||
|
||||
configure_package_config_file(indicaConfig.cmake.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/indicaConfig.cmake
|
||||
INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/indica)
|
||||
if(NOT INDICATORS_SUBPROJECT)
|
||||
configure_package_config_file(indicatorsConfig.cmake.in
|
||||
${CMAKE_CURRENT_BINARY_DIR}/indicatorsConfig.cmake
|
||||
INSTALL_DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/indicators)
|
||||
write_basic_package_version_file(indicatorsConfigVersion.cmake
|
||||
COMPATIBILITY AnyNewerVersion)
|
||||
|
||||
install(TARGETS indica EXPORT indicaTargets)
|
||||
install(EXPORT indicaTargets
|
||||
FILE indicaTargets.cmake
|
||||
NAMESPACE indica::
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/indica)
|
||||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/indicaConfig.cmake
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/indica)
|
||||
install(DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/include/indicators
|
||||
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
|
||||
USE_SOURCE_PERMISSIONS
|
||||
PATTERN "*.hpp")
|
||||
configure_file(indicators.pc.in indicators.pc @ONLY)
|
||||
|
||||
install(TARGETS indicators EXPORT indicatorsTargets)
|
||||
install(EXPORT indicatorsTargets
|
||||
FILE indicatorsTargets.cmake
|
||||
NAMESPACE indicators::
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/indicators)
|
||||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/indicatorsConfig.cmake
|
||||
${CMAKE_CURRENT_BINARY_DIR}/indicatorsConfigVersion.cmake
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/indicators)
|
||||
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/indicators.pc
|
||||
DESTINATION ${CMAKE_INSTALL_LIBDIR}/pkgconfig)
|
||||
install(DIRECTORY ${CMAKE_CURRENT_LIST_DIR}/include/indicators
|
||||
DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
|
||||
USE_SOURCE_PERMISSIONS
|
||||
PATTERN "*.hpp")
|
||||
install(FILES LICENSE LICENSE.termcolor
|
||||
DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/licenses/indicators)
|
||||
|
||||
if(EXISTS "${PROJECT_SOURCE_DIR}/.gitignore")
|
||||
# Simple glob to regex conversion (.gitignore => CPACK_SOURCE_IGNORE_FILES)
|
||||
file(READ ".gitignore" DOT_GITIGNORE)
|
||||
string(REPLACE ";" "RANDOMSEQUENCE" DOT_GITIGNORE "${DOT_GITIGNORE}")
|
||||
string(REPLACE "\n" ";" DOT_GITIGNORE "${DOT_GITIGNORE}")
|
||||
string(REPLACE "RANDOMSEQUENCE" "\\;" DOT_GITIGNORE "${DOT_GITIGNORE}")
|
||||
foreach(IGNORE_LINE ${DOT_GITIGNORE})
|
||||
if(NOT IGNORE_LINE OR IGNORE_LINE MATCHES "^#")
|
||||
continue()
|
||||
endif()
|
||||
string(REPLACE "\\" "\\\\" IGNORE_LINE "${IGNORE_LINE}")
|
||||
string(REPLACE "." "\\\\." IGNORE_LINE "${IGNORE_LINE}")
|
||||
string(REPLACE "*" ".*" IGNORE_LINE "${IGNORE_LINE}")
|
||||
string(REPLACE "+" "\\\\+" IGNORE_LINE "${IGNORE_LINE}")
|
||||
list(APPEND CPACK_SOURCE_IGNORE_FILES "${IGNORE_LINE}")
|
||||
endforeach()
|
||||
endif()
|
||||
|
||||
# extra ignored files
|
||||
list(APPEND CPACK_SOURCE_IGNORE_FILES
|
||||
.editorconfig
|
||||
.git
|
||||
.gitignore
|
||||
.travis.yml
|
||||
.appveyor.yml
|
||||
)
|
||||
set(CPACK_SOURCE_PACKAGE_FILE_NAME "${PROJECT_NAME}-${PROJECT_VERSION}")
|
||||
set(CPACK_GENERATOR "TGZ;TXZ")
|
||||
set(CPACK_SOURCE_GENERATOR "TGZ;TXZ")
|
||||
include(CPack)
|
||||
endif()
|
||||
|
||||
551
README.md
551
README.md
@@ -6,33 +6,43 @@
|
||||
<a href="https://travis-ci.com/p-ranav/indicators">
|
||||
<img src="https://travis-ci.com/p-ranav/indicators.svg?branch=master" alt="ci status"/>
|
||||
</a>
|
||||
<a href="https://www.codacy.com/manual/p-ranav/indicators?utm_source=github.com&utm_medium=referral&utm_content=p-ranav/indicators&utm_campaign=Badge_Grade">
|
||||
<img src="https://api.codacy.com/project/badge/Grade/93401e73f250407cb32445afec4e3e99" alt="codacy"/>
|
||||
</a>
|
||||
<a href="https://github.com/p-ranav/indicators/blob/master/LICENSE">
|
||||
<img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="license"/>
|
||||
</a>
|
||||
<img src="https://img.shields.io/badge/version-1.5-blue.svg?cacheSeconds=2592000" alt="version"/>
|
||||
<img src="https://img.shields.io/badge/version-1.8-blue.svg?cacheSeconds=2592000" alt="version"/>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="img/demo.gif"/>
|
||||
</p>
|
||||
|
||||
# Highlights
|
||||
## Highlights
|
||||
|
||||
* Thread-safe progress bars and spinners
|
||||
* Header-only library. Grab a copy of `include/indicators`
|
||||
* Header-only library. Grab a copy of `include/indicators`.
|
||||
* Single-header version in `single_include/indicators`.
|
||||
* Source for the above GIF can be found [here](demo/demo.cpp)
|
||||
* MIT License
|
||||
|
||||
# Table of Contents
|
||||
## Table of Contents
|
||||
|
||||
* [Progress Bar](#progress-bar)
|
||||
* [Block Progress Bar](#block-progress-bar)
|
||||
* [Multi Progress](#multiprogress)
|
||||
* [Progress Spinner](#progress-spinner)
|
||||
* [Contributing](#contributing)
|
||||
* [License](#license)
|
||||
* Supported Indicators
|
||||
* [Basic Progress Bar](#basic-progress-bar)
|
||||
* [Indeterminate Progress Bar](#indeterminate-progress-bar)
|
||||
* [Block Progress Bar](#block-progress-bar)
|
||||
* [Multi Progress](#multiprogress)
|
||||
* [Dynamic Progress](#dynamicprogress)
|
||||
* [Progress Spinner](#progress-spinner)
|
||||
* [Working with Iterables](#working-with-iterables)
|
||||
* [Building Samples](#building-samples)
|
||||
* [Generating Single Header](#generating-single-header)
|
||||
* [Contributing](#contributing)
|
||||
* [License](#license)
|
||||
|
||||
# Progress bar
|
||||
## Basic Progress bar
|
||||
|
||||
To introduce a progress bar in your application, include `indicators/progress_bar.hpp` and create a `ProgressBar` object. Here's the general structure of a progress bar:
|
||||
|
||||
@@ -41,11 +51,11 @@ To introduce a progress bar in your application, include `indicators/progress_ba
|
||||
^^^^^^^^^^^^^ Bar Width ^^^^^^^^^^^^^^^
|
||||
```
|
||||
|
||||
The amount of progress in ProgressBar is maintained as a float in range `[0, 100]`. When progress reaches 100, the progression is complete.
|
||||
The amount of progress in ProgressBar is maintained as a `size_t` in range `[0, 100]`. When progress reaches 100, the progression is complete.
|
||||
|
||||
From application-level code, there are two ways in which you can update this progress:
|
||||
|
||||
## Update progress using `bar.tick()`
|
||||
### Update progress using `bar.tick()`
|
||||
|
||||
You can update the progress bar using `bar.tick()` which increments progress by exactly `1%`.
|
||||
|
||||
@@ -59,17 +69,18 @@ You can update the progress bar using `bar.tick()` which increments progress by
|
||||
#include <chrono>
|
||||
|
||||
int main() {
|
||||
indicators::ProgressBar bar;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with("[");
|
||||
bar.fill_bar_progress_with("=");
|
||||
bar.lead_bar_progress_with(">");
|
||||
bar.fill_bar_remainder_with(" ");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_postfix_text("Extracting Archive");
|
||||
bar.set_foreground_color(indicators::Color::GREEN);
|
||||
using namespace indicators;
|
||||
ProgressBar bar{
|
||||
option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"="},
|
||||
option::Lead{">"},
|
||||
option::Remainder{" "},
|
||||
option::End{"]"},
|
||||
option::PostfixText{"Extracting Archive"},
|
||||
option::ForegroundColor{Color::green},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
while (true) {
|
||||
@@ -85,7 +96,7 @@ int main() {
|
||||
|
||||
The above code will print a progress bar that goes from 0 to 100% at the rate of 1% every 100 ms.
|
||||
|
||||
## Updating progress using `bar.set_progress(value)`
|
||||
### Updating progress using `bar.set_progress(value)`
|
||||
|
||||
If you'd rather control progress of the bar in discrete steps, consider using `bar.set_progress(value)`. Example:
|
||||
|
||||
@@ -96,25 +107,27 @@ If you'd rather control progress of the bar in discrete steps, consider using `b
|
||||
|
||||
```cpp
|
||||
#include <chrono>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
using namespace indicators;
|
||||
|
||||
// Hide cursor
|
||||
std::cout << "\e[?25l";
|
||||
show_console_cursor(false);
|
||||
|
||||
indicators::ProgressBar bar;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with("[");
|
||||
bar.fill_bar_progress_with("■");
|
||||
bar.lead_bar_progress_with("■");
|
||||
bar.fill_bar_remainder_with("-");
|
||||
bar.end_bar_with(" ]");
|
||||
bar.set_postfix_text("Loading dependency 1/4");
|
||||
bar.set_foreground_color(indicators::Color::CYAN);
|
||||
ProgressBar bar{
|
||||
option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"■"},
|
||||
option::Lead{"■"},
|
||||
option::Remainder{"-"},
|
||||
option::End{" ]"},
|
||||
option::PostfixText{"Loading dependency 1/4"},
|
||||
option::ForegroundColor{Color::cyan},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
bar.set_progress(10); // 10% done
|
||||
@@ -122,34 +135,32 @@ int main() {
|
||||
// do some work
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(800));
|
||||
|
||||
bar.set_postfix_text("Loading dependency 2/4");
|
||||
bar.set_option(option::PostfixText{"Loading dependency 2/4"});
|
||||
|
||||
bar.set_progress(30); // 30% done
|
||||
|
||||
// do some more work
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(700));
|
||||
|
||||
bar.set_postfix_text("Loading dependency 3/4");
|
||||
bar.set_option(option::PostfixText{"Loading dependency 3/4"});
|
||||
|
||||
bar.set_progress(65); // 65% done
|
||||
|
||||
// do final bit of work
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(900));
|
||||
|
||||
bar.set_postfix_text("Loaded dependencies!");
|
||||
bar.set_option(option::PostfixText{"Loaded dependencies!"});
|
||||
|
||||
bar.set_progress(100); // all done
|
||||
|
||||
bar.mark_as_completed();
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
## Showing Time Elapsed/Remaining
|
||||
### Showing Time Elapsed/Remaining
|
||||
|
||||
All progress bars and spinners in `indicators` support showing time elapsed and time remaining. Inspired by python's [tqdm](https://github.com/tqdm/tqdm) module, the format of this meter is `[{elapsed}<{remaining}]`:
|
||||
|
||||
@@ -159,25 +170,29 @@ All progress bars and spinners in `indicators` support showing time elapsed and
|
||||
|
||||
```cpp
|
||||
#include <chrono>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
indicators::ProgressBar bar;
|
||||
using namespace indicators;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with(" [");
|
||||
bar.fill_bar_progress_with("█");
|
||||
bar.lead_bar_progress_with("█");
|
||||
bar.fill_bar_remainder_with("-");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_prefix_text("Training Gaze Network 👀");
|
||||
bar.set_foreground_color(indicators::Color::YELLOW);
|
||||
// Hide cursor
|
||||
show_console_cursor(false);
|
||||
|
||||
// Show time elapsed and remaining
|
||||
bar.show_elapsed_time();
|
||||
bar.show_remaining_time();
|
||||
indicators::ProgressBar bar{
|
||||
option::BarWidth{50},
|
||||
option::Start{" ["},
|
||||
option::Fill{"█"},
|
||||
option::Lead{"█"},
|
||||
option::Remainder{"-"},
|
||||
option::End{"]"},
|
||||
option::PrefixText{"Training Gaze Network 👀"},
|
||||
option::ForegroundColor{Color::yellow},
|
||||
option::ShowElapsedTime{true},
|
||||
option::ShowRemainingTime{true},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
while (true) {
|
||||
@@ -188,13 +203,68 @@ int main() {
|
||||
}
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
# Block Progress Bar
|
||||
## Indeterminate Progress Bar
|
||||
|
||||
You might have a use-case for a progress bar where the maximum amount of progress is unknown, e.g., you're downloading from a remote server that isn't advertising the total bytes.
|
||||
|
||||
Use an `indicators::IndeterminateProgressBar` for such cases. An `IndeterminateProgressBar` is similar to a regular progress bar except the total amount to progress towards is unknown. Ticking on this progress bar will happily run forever.
|
||||
|
||||
When you know progress is complete, simply call `bar.mark_as_completed()`.
|
||||
|
||||
<p align="center">
|
||||
<img src="img/indeterminate_progress_bar.gif"/>
|
||||
</p>
|
||||
|
||||
```cpp
|
||||
#include <chrono>
|
||||
#include <indicators/indeterminate_progress_bar.hpp>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/termcolor.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
indicators::IndeterminateProgressBar bar{
|
||||
indicators::option::BarWidth{40},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"·"},
|
||||
indicators::option::Lead{"<==>"},
|
||||
indicators::option::End{"]"},
|
||||
indicators::option::PostfixText{"Checking for Updates"},
|
||||
indicators::option::ForegroundColor{indicators::Color::yellow},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
auto job = [&bar]() {
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10000));
|
||||
bar.mark_as_completed();
|
||||
std::cout << termcolor::bold << termcolor::green
|
||||
<< "System is up to date!\n" << termcolor::reset;
|
||||
};
|
||||
std::thread job_completion_thread(job);
|
||||
|
||||
// Update bar state
|
||||
while (!bar.is_completed()) {
|
||||
bar.tick();
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
}
|
||||
|
||||
job_completion_thread.join();
|
||||
|
||||
indicators::show_console_cursor(true);
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
## Block Progress Bar
|
||||
|
||||
Are you in need of a smooth block progress bar using [unicode block elements](https://en.wikipedia.org/wiki/Block_Elements)? Use `BlockProgressBar` instead of `ProgressBar`. Thanks to [this blog post](https://mike42.me/blog/2018-06-make-better-cli-progress-bars-with-unicode-block-characters) for making `BlockProgressBar` an easy addition to the library.
|
||||
|
||||
@@ -209,16 +279,18 @@ Are you in need of a smooth block progress bar using [unicode block elements](ht
|
||||
|
||||
int main() {
|
||||
|
||||
using namespace indicators;
|
||||
|
||||
// Hide cursor
|
||||
std::cout << "\e[?25l";
|
||||
|
||||
indicators::BlockProgressBar bar;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(80);
|
||||
bar.start_bar_with("[");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_foreground_color(indicators::Color::WHITE);
|
||||
show_console_cursor(false);
|
||||
|
||||
BlockProgressBar bar{
|
||||
option::BarWidth{80},
|
||||
option::Start{"["},
|
||||
option::End{"]"},
|
||||
option::ForegroundColor{Color::white} ,
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
auto progress = 0.0f;
|
||||
@@ -231,18 +303,20 @@ int main() {
|
||||
}
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
# MultiProgress
|
||||
## MultiProgress
|
||||
|
||||
`indicators` supports management of multiple progress bars with the `MultiProgress` class template.
|
||||
|
||||
`template <typename Indicator, size_t count> class MultiProgress` is a class template that holds references to multiple progress bars and provides a safe interface to update the state of each bar. `MultiProgress` works with both `ProgressBar` and `BlockProgressBar` classes.
|
||||
|
||||
Use this class if you know the number of progress bars to manage at compile time.
|
||||
|
||||
Below is an example `MultiProgress` object that manages three `ProgressBar` objects.
|
||||
|
||||
<p align="center">
|
||||
@@ -254,45 +328,52 @@ Below is an example `MultiProgress` object that manages three `ProgressBar` obje
|
||||
#include <indicators/progress_bar.hpp>
|
||||
|
||||
int main() {
|
||||
|
||||
using namespace indicators;
|
||||
// Configure first progress bar
|
||||
indicators::ProgressBar bar1;
|
||||
bar1.set_bar_width(50);
|
||||
bar1.start_bar_with("[");
|
||||
bar1.fill_bar_progress_with("■");
|
||||
bar1.lead_bar_progress_with("■");
|
||||
bar1.fill_bar_remainder_with(" ");
|
||||
bar1.end_bar_with(" ]");
|
||||
bar1.set_foreground_color(indicators::Color::YELLOW);
|
||||
bar1.show_elapsed_time();
|
||||
bar1.show_remaining_time();
|
||||
bar1.set_prefix_text("Progress Bar #1 ");
|
||||
ProgressBar bar1{
|
||||
option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"■"},
|
||||
option::Lead{"■"},
|
||||
option::Remainder{" "},
|
||||
option::End{" ]"},
|
||||
option::ForegroundColor{Color::yellow},
|
||||
option::ShowElapsedTime{true},
|
||||
option::ShowRemainingTime{true},
|
||||
option::PrefixText{"Progress Bar #1 "},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Configure second progress bar
|
||||
indicators::ProgressBar bar2;
|
||||
bar2.set_bar_width(50);
|
||||
bar2.start_bar_with("[");
|
||||
bar2.fill_bar_progress_with("=");
|
||||
bar2.lead_bar_progress_with(">");
|
||||
bar2.fill_bar_remainder_with(" ");
|
||||
bar2.end_bar_with(" ]");
|
||||
bar2.set_foreground_color(indicators::Color::CYAN);
|
||||
bar2.show_elapsed_time();
|
||||
bar2.show_remaining_time();
|
||||
bar2.set_prefix_text("Progress Bar #2 ");
|
||||
|
||||
ProgressBar bar2{
|
||||
option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"="},
|
||||
option::Lead{">"},
|
||||
option::Remainder{" "},
|
||||
option::End{" ]"},
|
||||
option::ForegroundColor{Color::cyan},
|
||||
option::ShowElapsedTime{true},
|
||||
option::ShowRemainingTime{true},
|
||||
option::PrefixText{"Progress Bar #2 "},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Configure third progress bar
|
||||
indicators::ProgressBar bar3;
|
||||
bar3.set_bar_width(50);
|
||||
bar3.start_bar_with("[");
|
||||
bar3.fill_bar_progress_with("#");
|
||||
bar3.lead_bar_progress_with("#");
|
||||
bar3.fill_bar_remainder_with(" ");
|
||||
bar3.end_bar_with(" ]");
|
||||
bar3.set_foreground_color(indicators::Color::RED);
|
||||
bar3.show_elapsed_time();
|
||||
bar3.show_remaining_time();
|
||||
bar3.set_prefix_text("Progress Bar #3 ");
|
||||
indicators::ProgressBar bar3{
|
||||
option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"#"},
|
||||
option::Lead{"#"},
|
||||
option::Remainder{" "},
|
||||
option::End{" ]"},
|
||||
option::ForegroundColor{Color::red},
|
||||
option::ShowElapsedTime{true},
|
||||
option::ShowRemainingTime{true},
|
||||
option::PrefixText{"Progress Bar #3 "},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Construct MultiProgress object
|
||||
indicators::MultiProgress<indicators::ProgressBar, 3> bars(bar1, bar2, bar3);
|
||||
@@ -338,7 +419,164 @@ int main() {
|
||||
}
|
||||
```
|
||||
|
||||
# Progress Spinner
|
||||
## DynamicProgress
|
||||
|
||||
`DynamicProgress` is a container class, similar to `MultiProgress`, for managing multiple progress bars. As the name suggests, with `DynamicProgress`, you can dynamically add new progress bars.
|
||||
|
||||
To add new progress bars, call `bars.push_back(new_bar)`. This call will return the index of the appended bar. You can then refer to this bar with the indexing operator, e.g., `bars[4].set_progress(55)`.
|
||||
|
||||
Use this class if you don't know the number of progress bars at compile time.
|
||||
|
||||
Below is an example `DynamicProgress` object that manages six `ProgressBar` objects. Three of these bars are added dynamically.
|
||||
|
||||
<p align="center">
|
||||
<img src="img/dynamic_progress_bar.gif"/>
|
||||
</p>
|
||||
|
||||
```cpp
|
||||
#include <indicators/dynamic_progress.hpp>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
using namespace indicators;
|
||||
|
||||
int main() {
|
||||
|
||||
ProgressBar bar1{option::BarWidth{50}, option::ForegroundColor{Color::red},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"5c90d4a2d1a8: Downloading "}};
|
||||
|
||||
ProgressBar bar2{option::BarWidth{50}, option::ForegroundColor{Color::yellow},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"22337bfd13a9: Downloading "}};
|
||||
|
||||
ProgressBar bar3{option::BarWidth{50}, option::ForegroundColor{Color::green},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"10f26c680a34: Downloading "}};
|
||||
|
||||
ProgressBar bar4{option::BarWidth{50}, option::ForegroundColor{Color::white},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"6364e0d7a283: Downloading "}};
|
||||
|
||||
ProgressBar bar5{option::BarWidth{50}, option::ForegroundColor{Color::blue},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"ff1356ba118b: Downloading "}};
|
||||
|
||||
ProgressBar bar6{option::BarWidth{50}, option::ForegroundColor{Color::cyan},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"5a17453338b4: Downloading "}};
|
||||
|
||||
std::cout << termcolor::bold << termcolor::white << "Pulling image foo:bar/baz\n";
|
||||
|
||||
// Construct with 3 progress bars. We'll add 3 more at a later point
|
||||
DynamicProgress<ProgressBar> bars(bar1, bar2, bar3);
|
||||
|
||||
// Do not hide bars when completed
|
||||
bars.set_option(option::HideBarWhenComplete{false});
|
||||
|
||||
std::thread fourth_job, fifth_job, sixth_job;
|
||||
|
||||
auto job4 = [&bars](size_t i) {
|
||||
while (true) {
|
||||
bars[i].tick();
|
||||
if (bars[i].is_completed()) {
|
||||
bars[i].set_option(option::PrefixText{"6364e0d7a283: Pull complete "});
|
||||
bars[i].mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(50));
|
||||
}
|
||||
};
|
||||
|
||||
auto job5 = [&bars](size_t i) {
|
||||
while (true) {
|
||||
bars[i].tick();
|
||||
if (bars[i].is_completed()) {
|
||||
bars[i].set_option(option::PrefixText{"ff1356ba118b: Pull complete "});
|
||||
bars[i].mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
}
|
||||
};
|
||||
|
||||
auto job6 = [&bars](size_t i) {
|
||||
while (true) {
|
||||
bars[i].tick();
|
||||
if (bars[i].is_completed()) {
|
||||
bars[i].set_option(option::PrefixText{"5a17453338b4: Pull complete "});
|
||||
bars[i].mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(40));
|
||||
}
|
||||
};
|
||||
|
||||
auto job1 = [&bars, &bar6, &sixth_job, &job6]() {
|
||||
while (true) {
|
||||
bars[0].tick();
|
||||
if (bars[0].is_completed()) {
|
||||
bars[0].set_option(option::PrefixText{"5c90d4a2d1a8: Pull complete "});
|
||||
// bar1 is completed, adding bar6
|
||||
auto i = bars.push_back(bar6);
|
||||
sixth_job = std::thread(job6, i);
|
||||
sixth_job.join();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(140));
|
||||
}
|
||||
};
|
||||
|
||||
auto job2 = [&bars, &bar5, &fifth_job, &job5]() {
|
||||
while (true) {
|
||||
bars[1].tick();
|
||||
if (bars[1].is_completed()) {
|
||||
bars[1].set_option(option::PrefixText{"22337bfd13a9: Pull complete "});
|
||||
// bar2 is completed, adding bar5
|
||||
auto i = bars.push_back(bar5);
|
||||
fifth_job = std::thread(job5, i);
|
||||
fifth_job.join();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(25));
|
||||
}
|
||||
};
|
||||
|
||||
auto job3 = [&bars, &bar4, &fourth_job, &job4]() {
|
||||
while (true) {
|
||||
bars[2].tick();
|
||||
if (bars[2].is_completed()) {
|
||||
bars[2].set_option(option::PrefixText{"10f26c680a34: Pull complete "});
|
||||
// bar3 is completed, adding bar4
|
||||
auto i = bars.push_back(bar4);
|
||||
fourth_job = std::thread(job4, i);
|
||||
fourth_job.join();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(50));
|
||||
}
|
||||
};
|
||||
|
||||
std::thread first_job(job1);
|
||||
std::thread second_job(job2);
|
||||
std::thread third_job(job3);
|
||||
|
||||
third_job.join();
|
||||
second_job.join();
|
||||
first_job.join();
|
||||
|
||||
std::cout << termcolor::bold << termcolor::green << "✔ Downloaded image foo/bar:baz" << std::endl;
|
||||
std::cout << termcolor::reset;
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
In the above code, notice the option `bars.set_option(option::HideBarWhenComplete{true});`. Yes, you can hide progress bars as and when they complete by setting this option to `true`. If you do so, the above example will look like this:
|
||||
|
||||
<p align="center">
|
||||
<img src="img/dynamic_progress_bar_hide_completed.gif"/>
|
||||
</p>
|
||||
|
||||
## Progress Spinner
|
||||
|
||||
To introduce a progress spinner in your application, include `indicators/progress_spinner.hpp` and create a `ProgressSpinner` object. Here's the general structure of a progress spinner:
|
||||
|
||||
@@ -356,22 +594,23 @@ ProgressSpinner has a vector of strings: `spinner_states`. At each update, the s
|
||||
#include <indicators/progress_spinner.hpp>
|
||||
|
||||
int main() {
|
||||
indicators::ProgressSpinner spinner;
|
||||
|
||||
// Configure the spinner
|
||||
spinner.set_postfix_text("Checking credentials");
|
||||
spinner.set_foreground_color(indicators::Color::YELLOW);
|
||||
spinner.set_spinner_states({"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"});
|
||||
|
||||
using namespace indicators;
|
||||
indicators::ProgressSpinner spinner{
|
||||
option::PostfixText{"Checking credentials"},
|
||||
option::ForegroundColor{Color::yellow},
|
||||
option::SpinnerStates{std::vector<std::string>{"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"}},
|
||||
option::FontStyles{std::vector<FontStyle>{FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update spinner state
|
||||
auto job = [&spinner]() {
|
||||
while (true) {
|
||||
if (spinner.is_completed()) {
|
||||
spinner.set_foreground_color(indicators::Color::GREEN);
|
||||
spinner.set_prefix_text("✔");
|
||||
spinner.hide_spinner();
|
||||
spinner.hide_percentage();
|
||||
spinner.set_postfix_text("Authenticated!");
|
||||
spinner.set_option(option::ForegroundColor{Color::green});
|
||||
spinner.set_option(option::PrefixText{"✔"});
|
||||
spinner.set_option(option::ShowSpinner{false});
|
||||
spinner.set_option(option::ShowPercentage{false});
|
||||
spinner.set_option(option::PostfixText{"Authenticated!"});
|
||||
spinner.mark_as_completed();
|
||||
break;
|
||||
} else
|
||||
@@ -386,6 +625,84 @@ int main() {
|
||||
}
|
||||
```
|
||||
|
||||
## Working with Iterables
|
||||
|
||||
If you'd like to use progress bars to indicate progress while iterating over iterables, e.g., a list of numbers, this
|
||||
can be achieved by using the `option::MaxProgress`:
|
||||
|
||||
<p align="center">
|
||||
<img src="img/block_progress_bar_iterable.gif"/>
|
||||
</p>
|
||||
|
||||
```cpp
|
||||
#include <chrono>
|
||||
#include <indicators/block_progress_bar.hpp>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
|
||||
// Hide cursor
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
// Random list of numbers
|
||||
std::vector<size_t> numbers;
|
||||
for (size_t i = 0; i < 1259438; ++i) {
|
||||
numbers.push_back(i);
|
||||
}
|
||||
|
||||
using namespace indicators;
|
||||
BlockProgressBar bar{
|
||||
option::BarWidth{80},
|
||||
option::ForegroundColor{Color::white},
|
||||
option::FontStyles{
|
||||
std::vector<FontStyle>{FontStyle::bold}},
|
||||
option::MaxProgress{numbers.size()}
|
||||
};
|
||||
|
||||
std::cout << "Iterating over a list of numbers (size = "
|
||||
<< numbers.size() << ")\n";
|
||||
|
||||
std::vector<size_t> result;
|
||||
for (size_t i = 0; i < numbers.size(); ++i) {
|
||||
|
||||
// Perform some computation
|
||||
result.push_back(numbers[i] * numbers[i]);
|
||||
|
||||
// Show iteration as postfix text
|
||||
bar.set_option(option::PostfixText{
|
||||
std::to_string(i) + "/" + std::to_string(numbers.size())
|
||||
});
|
||||
|
||||
// update progress bar
|
||||
bar.tick();
|
||||
}
|
||||
|
||||
bar.mark_as_completed();
|
||||
|
||||
// Show cursor
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
## Building Samples
|
||||
|
||||
```bash
|
||||
git clone https://github.com/p-ranav/indicators
|
||||
cd indicators
|
||||
mkdir build && cd build
|
||||
cmake -DINDICATORS_SAMPLES=ON -DINDICATORS_DEMO=ON ..
|
||||
make
|
||||
```
|
||||
|
||||
## Generating Single Header
|
||||
|
||||
```bash
|
||||
python3 utils/amalgamate/amalgamate.py -c single_include.json -s .
|
||||
```
|
||||
|
||||
## Contributing
|
||||
Contributions are welcome, have a look at the [CONTRIBUTING.md](CONTRIBUTING.md) document for more information.
|
||||
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
#!/usr/bin/env bash
|
||||
find ./include ./demo/ ./samples/ -type f \( -iname \*.cpp -o -iname \*.hpp \) | xargs clang-format -style="{ColumnLimit : 100}" -i
|
||||
find ./include ./demo/ ./samples/ ./single_include -type f \( -iname \*.cpp -o -iname \*.hpp \) | xargs clang-format -style="{ColumnLimit : 100}" -i
|
||||
|
||||
78
conanfile.py
Normal file
78
conanfile.py
Normal file
@@ -0,0 +1,78 @@
|
||||
from conans import CMake, ConanFile, tools
|
||||
from conans.errors import ConanException
|
||||
from contextlib import contextmanager
|
||||
import os
|
||||
|
||||
|
||||
class IndicatorsConan(ConanFile):
|
||||
name = "indicators"
|
||||
description = "Activity Indicators for Modern C++"
|
||||
topics = ("indicators", "progress", "activity", "indicator", "header-only", "c++11")
|
||||
homepage = "https://github.com/p-ranav/indicators"
|
||||
url = "https://github.com/p-ranav/indicators"
|
||||
license = ("MIT", "BSD-3-Clause")
|
||||
exports_sources = "demo/**", "include/**", "samples/**", "CMakeLists.txt", "LICENSE*", \
|
||||
"indicators.pc.in", "indicatorsConfig.cmake.in", "README*", "img/**"
|
||||
exports = "LICENSE"
|
||||
no_copy_source = True
|
||||
settings = "os", "arch", "compiler", "build_type"
|
||||
generators = "cmake"
|
||||
|
||||
def set_version(self):
|
||||
import re
|
||||
m = re.search(r"project\(.*VERSION ([0-9a-zA-Z.-]+)[ )]",
|
||||
open(os.path.join(self.recipe_folder, "CMakeLists.txt")).read())
|
||||
if not m:
|
||||
raise ConanException("Could not extract version from CMakeLists.txt")
|
||||
self.version = m.group(1)
|
||||
|
||||
_cmake = None
|
||||
|
||||
def _configure_cmake(self):
|
||||
if self._cmake:
|
||||
return self._cmake
|
||||
generator = None
|
||||
if self.settings.compiler == "Visual Studio":
|
||||
generator = "NMake Makefiles"
|
||||
self._cmake = CMake(self, generator=generator)
|
||||
if tools.get_env("CONAN_RUN_TESTS", default=False):
|
||||
self._cmake.definitions["INDICATORS_DEMO"] = True
|
||||
self._cmake.definitions["INDICATORS_SAMPLES"] = True
|
||||
self._cmake.configure()
|
||||
return self._cmake
|
||||
|
||||
@property
|
||||
def _test_programs(self):
|
||||
programs = []
|
||||
import re
|
||||
for subdir in ("demo", "samples", ):
|
||||
for match in re.finditer(r"add_executable\((\S+)",
|
||||
open(os.path.join(self.source_folder, subdir, "CMakeLists.txt")).read()):
|
||||
programs.append(os.path.join(self.build_folder, "bin", match.group(1)))
|
||||
return programs
|
||||
|
||||
@contextmanager
|
||||
def _build_context(self):
|
||||
with tools.vcvars(self.settings) if self.settings.compiler == "Visual Studio" else tools.no_op():
|
||||
yield
|
||||
|
||||
def build(self):
|
||||
with self._build_context():
|
||||
cmake = self._configure_cmake()
|
||||
cmake.build()
|
||||
cmake.build(target="package_source")
|
||||
# if tools.get_env("CONAN_RUN_TESTS", default=False):
|
||||
# for program in self._test_programs:
|
||||
# self.output.info("Running program '{}'".format(program))
|
||||
# self.run(program, run_environment=True)
|
||||
|
||||
def package(self):
|
||||
with self._build_context():
|
||||
cmake = self._configure_cmake()
|
||||
cmake.install()
|
||||
|
||||
def package_id(self):
|
||||
self.info.header_only()
|
||||
|
||||
def package_info(self):
|
||||
self.cpp_info.includedirs.append(os.path.join("include", "indicators"))
|
||||
@@ -1,2 +1,2 @@
|
||||
add_executable(demo demo.cpp)
|
||||
target_link_libraries(demo PRIVATE indica::indica)
|
||||
target_link_libraries(demo PRIVATE indicators::indicators)
|
||||
|
||||
244
demo/demo.cpp
244
demo/demo.cpp
@@ -1,24 +1,25 @@
|
||||
#include <indicators/progress_bar.hpp>
|
||||
#include <indicators/progress_spinner.hpp>
|
||||
#include "indicators.hpp"
|
||||
#include <vector>
|
||||
|
||||
int main() {
|
||||
using namespace indicators;
|
||||
|
||||
// Hide cursor
|
||||
std::cout << "\e[?25l";
|
||||
show_console_cursor(false);
|
||||
|
||||
{
|
||||
//
|
||||
// PROGRESS BAR 1
|
||||
//
|
||||
indicators::ProgressBar p;
|
||||
p.set_bar_width(50);
|
||||
p.start_bar_with("[");
|
||||
p.fill_bar_progress_with("■");
|
||||
p.lead_bar_progress_with("■");
|
||||
p.fill_bar_remainder_with(" ");
|
||||
p.end_bar_with(" ]");
|
||||
p.set_foreground_color(indicators::Color::YELLOW);
|
||||
indicators::ProgressBar p{option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"■"},
|
||||
option::Lead{"■"},
|
||||
option::Remainder{" "},
|
||||
option::End{" ]"},
|
||||
option::ForegroundColor{indicators::Color::yellow},
|
||||
option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
std::atomic<size_t> index{0};
|
||||
std::vector<std::string> status_text = {"Rocket.exe is not responding",
|
||||
@@ -35,7 +36,7 @@ int main() {
|
||||
while (true) {
|
||||
if (p.is_completed())
|
||||
break;
|
||||
p.set_postfix_text(status_text[index % status_text.size()]);
|
||||
p.set_option(option::PostfixText{status_text[index % status_text.size()]});
|
||||
p.set_progress(index * 10);
|
||||
index += 1;
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(600));
|
||||
@@ -50,20 +51,22 @@ int main() {
|
||||
// PROGRESS BAR 2
|
||||
//
|
||||
indicators::ProgressBar p;
|
||||
p.set_bar_width(40);
|
||||
p.set_prefix_text("Reading package list... ");
|
||||
p.start_bar_with("");
|
||||
p.fill_bar_progress_with("");
|
||||
p.lead_bar_progress_with("");
|
||||
p.fill_bar_remainder_with("");
|
||||
p.end_bar_with("");
|
||||
p.set_foreground_color(indicators::Color::WHITE);
|
||||
p.hide_percentage();
|
||||
p.set_option(option::BarWidth{40});
|
||||
p.set_option(option::PrefixText{"Reading package list... "});
|
||||
p.set_option(option::Start{""});
|
||||
p.set_option(option::Fill{""});
|
||||
p.set_option(option::Lead{""});
|
||||
p.set_option(option::Remainder{""});
|
||||
p.set_option(option::End{""});
|
||||
p.set_option(option::ForegroundColor{indicators::Color::white});
|
||||
p.set_option(option::ShowPercentage{false});
|
||||
p.set_option(option::FontStyles{std::vector<indicators::FontStyle>{indicators::FontStyle::bold}});
|
||||
auto job = [&p]() {
|
||||
while (true) {
|
||||
p.set_prefix_text("Reading package list... " + std::to_string(p.current()) + "% ");
|
||||
p.set_option(
|
||||
option::PrefixText{"Reading package list... " + std::to_string(p.current()) + "% "});
|
||||
if (p.current() + 2 >= 100)
|
||||
p.set_prefix_text("Reading package list... Done");
|
||||
p.set_option(option::PrefixText{"Reading package list... Done"});
|
||||
p.tick();
|
||||
if (p.is_completed()) {
|
||||
break;
|
||||
@@ -80,25 +83,26 @@ int main() {
|
||||
// PROGRESS BAR 3
|
||||
//
|
||||
indicators::ProgressBar p;
|
||||
p.set_bar_width(50);
|
||||
p.start_bar_with("[");
|
||||
p.fill_bar_progress_with("=");
|
||||
p.lead_bar_progress_with(">");
|
||||
p.fill_bar_remainder_with(" ");
|
||||
p.end_bar_with("]");
|
||||
p.set_postfix_text("Getting started");
|
||||
p.set_foreground_color(indicators::Color::GREEN);
|
||||
p.set_option(option::BarWidth{50});
|
||||
p.set_option(option::Start{"["});
|
||||
p.set_option(option::Fill{"="});
|
||||
p.set_option(option::Lead{">"});
|
||||
p.set_option(option::Remainder{" "});
|
||||
p.set_option(option::End{"]"});
|
||||
p.set_option(option::PostfixText{"Getting started"});
|
||||
p.set_option(option::ForegroundColor{indicators::Color::green});
|
||||
p.set_option(option::FontStyles{std::vector<indicators::FontStyle>{indicators::FontStyle::bold}});
|
||||
auto job = [&p]() {
|
||||
while (true) {
|
||||
auto ticks = p.current();
|
||||
if (ticks > 20 && ticks < 50)
|
||||
p.set_postfix_text("Delaying the inevitable");
|
||||
p.set_option(option::PostfixText{"Delaying the inevitable"});
|
||||
else if (ticks > 50 && ticks < 80)
|
||||
p.set_postfix_text("Crying quietly");
|
||||
p.set_option(option::PostfixText{"Crying quietly"});
|
||||
else if (ticks > 80 && ticks < 98)
|
||||
p.set_postfix_text("Almost there");
|
||||
p.set_option(option::PostfixText{"Almost there"});
|
||||
else if (ticks >= 98)
|
||||
p.set_postfix_text("Done");
|
||||
p.set_option(option::PostfixText{"Done"});
|
||||
p.tick();
|
||||
if (p.is_completed())
|
||||
break;
|
||||
@@ -115,32 +119,32 @@ int main() {
|
||||
//
|
||||
std::vector<std::string> lead_spinner{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"};
|
||||
indicators::ProgressBar p4;
|
||||
p4.set_bar_width(40);
|
||||
p4.start_bar_with("");
|
||||
p4.fill_bar_progress_with("⠸");
|
||||
p4.lead_bar_progress_with("");
|
||||
p4.fill_bar_remainder_with(" ");
|
||||
p4.end_bar_with("");
|
||||
p4.set_foreground_color(indicators::Color::CYAN);
|
||||
p4.set_postfix_text("Restoring system state");
|
||||
p4.hide_percentage();
|
||||
p4.set_option(option::BarWidth{40});
|
||||
p4.set_option(option::Start{""});
|
||||
p4.set_option(option::Fill{"⠸"});
|
||||
p4.set_option(option::Lead{""});
|
||||
p4.set_option(option::Remainder{" "});
|
||||
p4.set_option(option::End{""});
|
||||
p4.set_option(option::ForegroundColor{indicators::Color::cyan});
|
||||
p4.set_option(option::PostfixText{"Restoring system state"});
|
||||
p4.set_option(option::ShowPercentage{false});
|
||||
p4.set_option(option::FontStyles{std::vector<indicators::FontStyle>{indicators::FontStyle::bold}});
|
||||
std::atomic<size_t> index4{0};
|
||||
auto job4 = [&p4, &index4, &lead_spinner]() {
|
||||
while (true) {
|
||||
p4.set_prefix_text("{ " + std::to_string(p4.current()) + "% } ");
|
||||
p4.lead_bar_progress_with(lead_spinner[index4 % lead_spinner.size()]);
|
||||
p4.set_option(option::PrefixText{"{ " + std::to_string(p4.current()) + "% } "});
|
||||
p4.set_option(option::Lead{lead_spinner[index4 % lead_spinner.size()]});
|
||||
index4 += 1;
|
||||
if (p4.current() + 2 >= 100) {
|
||||
std::cout << std::endl;
|
||||
p4.set_foreground_color(indicators::Color::RED);
|
||||
p4.set_prefix_text("{ ERROR }");
|
||||
p4.start_bar_with("");
|
||||
p4.fill_bar_progress_with("");
|
||||
p4.lead_bar_progress_with("");
|
||||
p4.fill_bar_remainder_with("");
|
||||
p4.end_bar_with("");
|
||||
p4.show_percentage();
|
||||
p4.set_postfix_text("Failed to restore system");
|
||||
p4.set_option(option::ForegroundColor{indicators::Color::red});
|
||||
p4.set_option(option::PrefixText{"{ ERROR }"});
|
||||
p4.set_option(option::Start{});
|
||||
p4.set_option(option::Fill{});
|
||||
p4.set_option(option::Lead{});
|
||||
p4.set_option(option::Remainder{});
|
||||
p4.set_option(option::ShowPercentage{true});
|
||||
p4.set_option(option::PostfixText{"Failed to restore system"});
|
||||
p4.mark_as_completed();
|
||||
break;
|
||||
}
|
||||
@@ -152,56 +156,26 @@ int main() {
|
||||
thread4.join();
|
||||
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
|
||||
{
|
||||
//
|
||||
// GOING BACKWARDS
|
||||
//
|
||||
indicators::ProgressBar p;
|
||||
p.set_bar_width(50);
|
||||
p.start_bar_with("[");
|
||||
p.fill_bar_progress_with("■");
|
||||
p.lead_bar_progress_with("■");
|
||||
p.fill_bar_remainder_with("-");
|
||||
p.end_bar_with("]");
|
||||
p.set_progress(100);
|
||||
p.set_foreground_color(indicators::Color::WHITE);
|
||||
p.set_postfix_text("Reverting system restore");
|
||||
std::atomic<size_t> progress{100};
|
||||
auto job = [&p, &progress]() {
|
||||
while (true) {
|
||||
progress -= 1;
|
||||
p.set_progress(progress);
|
||||
if (progress == 0) {
|
||||
p.set_postfix_text("Revert complete!");
|
||||
p.mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(60));
|
||||
}
|
||||
};
|
||||
std::thread thread(job);
|
||||
thread.join();
|
||||
}
|
||||
}
|
||||
|
||||
{
|
||||
//
|
||||
// PROGRESS BAR 5
|
||||
//
|
||||
indicators::ProgressSpinner p;
|
||||
p.set_prefix_text("");
|
||||
p.set_postfix_text("Checking credentials");
|
||||
p.set_foreground_color(indicators::Color::YELLOW);
|
||||
p.set_spinner_states({"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"});
|
||||
indicators::ProgressSpinner p{
|
||||
option::PrefixText{""}, option::PostfixText{"Checking credentials"},
|
||||
option::ForegroundColor{indicators::Color::yellow},
|
||||
option::SpinnerStates{std::vector<std::string>{"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"}},
|
||||
option::FontStyles{std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
auto job = [&p]() {
|
||||
while (true) {
|
||||
if (p.is_completed()) {
|
||||
p.set_foreground_color(indicators::Color::GREEN);
|
||||
p.set_prefix_text("✔");
|
||||
p.hide_spinner();
|
||||
p.hide_percentage();
|
||||
p.set_postfix_text("Authenticated!");
|
||||
p.set_option(option::ForegroundColor{indicators::Color::green});
|
||||
p.set_option(option::PrefixText{"✔"});
|
||||
p.set_option(option::ShowSpinner{false});
|
||||
p.set_option(option::ShowPercentage{false});
|
||||
p.set_option(option::PostfixText{"Authenticated!"});
|
||||
p.mark_as_completed();
|
||||
break;
|
||||
} else
|
||||
@@ -218,70 +192,70 @@ int main() {
|
||||
//
|
||||
// PROGRESS BAR 6
|
||||
//
|
||||
indicators::ProgressSpinner p;
|
||||
p.set_prefix_text(" - ");
|
||||
p.set_postfix_text("Searching for the Moon");
|
||||
p.set_foreground_color(indicators::Color::WHITE);
|
||||
p.set_spinner_states({"▖", "▘", "▝", "▗"});
|
||||
p.hide_percentage();
|
||||
indicators::ProgressSpinner p{
|
||||
option::PrefixText{" - "}, option::PostfixText{"Searching for the Moon"},
|
||||
option::ForegroundColor{indicators::Color::white}, option::ShowPercentage{false},
|
||||
option::SpinnerStates{std::vector<std::string>{"▖", "▘", "▝", "▗"}},
|
||||
option::FontStyles{std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
auto job = [&p]() {
|
||||
while (true) {
|
||||
auto current = p.current();
|
||||
if (current == 24) {
|
||||
p.set_prefix_text(" - ✔");
|
||||
p.hide_spinner();
|
||||
p.set_option(option::PrefixText{" - ✔"});
|
||||
p.set_option(option::ShowSpinner{false});
|
||||
} else if (current == 25) {
|
||||
std::cout << std::endl;
|
||||
p.show_spinner();
|
||||
p.set_prefix_text(" - ");
|
||||
p.set_postfix_text("Contacting Kerbal headquarters");
|
||||
p.set_option(option::ShowSpinner{true});
|
||||
p.set_option(option::PrefixText{" - "});
|
||||
p.set_option(option::PostfixText{"Contacting Kerbal headquarters"});
|
||||
} else if (current == 49) {
|
||||
p.set_prefix_text(" - ✔");
|
||||
p.hide_spinner();
|
||||
p.set_option(option::PrefixText{" - ✔"});
|
||||
p.set_option(option::ShowSpinner{false});
|
||||
} else if (current == 50) {
|
||||
std::cout << std::endl;
|
||||
p.show_spinner();
|
||||
p.set_prefix_text(" - ");
|
||||
p.set_postfix_text("Designing spaceship");
|
||||
p.set_option(option::ShowSpinner{true});
|
||||
p.set_option(option::PrefixText{" - "});
|
||||
p.set_option(option::PostfixText{"Designing spaceship"});
|
||||
} else if (current == 74) {
|
||||
p.set_prefix_text(" - ✔");
|
||||
p.hide_spinner();
|
||||
p.set_option(option::PrefixText{" - ✔"});
|
||||
p.set_option(option::ShowSpinner{false});
|
||||
} else if (current == 75) {
|
||||
std::cout << std::endl;
|
||||
p.show_spinner();
|
||||
p.set_prefix_text(" - ");
|
||||
p.set_postfix_text("Launching rocket");
|
||||
p.set_option(option::ShowSpinner{true});
|
||||
p.set_option(option::PrefixText{" - "});
|
||||
p.set_option(option::PostfixText{"Launching rocket"});
|
||||
} else if (current == 95) {
|
||||
p.set_prefix_text(" - ✔");
|
||||
p.hide_spinner();
|
||||
p.set_option(option::PrefixText{" - ✔"});
|
||||
p.set_option(option::ShowSpinner{false});
|
||||
} else if (current == 99) {
|
||||
std::cout << std::endl;
|
||||
//
|
||||
// NESTED PROGRESS BAR
|
||||
//
|
||||
indicators::ProgressBar p2;
|
||||
p2.set_bar_width(30);
|
||||
p2.set_prefix_text(" - ");
|
||||
p2.start_bar_with("🌎");
|
||||
p2.fill_bar_progress_with("·");
|
||||
p2.lead_bar_progress_with("🚀");
|
||||
p2.fill_bar_remainder_with(" ");
|
||||
p2.end_bar_with("🌑");
|
||||
p2.set_postfix_text("Achieved low-Earth orbit");
|
||||
p2.set_foreground_color(indicators::Color::WHITE);
|
||||
indicators::ProgressBar p2{option::BarWidth{30},
|
||||
option::PrefixText{" - "},
|
||||
option::Start{"🌎"},
|
||||
option::Fill{"·"},
|
||||
option::Lead{"🚀"},
|
||||
option::Remainder{" "},
|
||||
option::End{"🌑"},
|
||||
option::PostfixText{"Achieved low-Earth orbit"},
|
||||
option::ForegroundColor{indicators::Color::white},
|
||||
option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
std::vector<std::string> ship_trail{"⠁", "⠂", "⠄", "⡀", "⢀", "⠠", "⠐", "⠈"};
|
||||
std::atomic<int> ship_trail_index{0};
|
||||
auto job2 = [&p2, &ship_trail_index, &ship_trail]() {
|
||||
while (true) {
|
||||
auto ticks = p2.current();
|
||||
if (ticks > 20 && ticks < 50)
|
||||
p2.set_postfix_text("Switching to trans-lunar trajectory");
|
||||
p2.set_option(option::PostfixText{"Switching to trans-lunar trajectory"});
|
||||
else if (ticks > 50 && ticks < 80)
|
||||
p2.set_postfix_text("Transferred to Lunar lander");
|
||||
p2.set_option(option::PostfixText{"Transferred to Lunar lander"});
|
||||
else if (ticks > 80 && ticks < 98)
|
||||
p2.set_postfix_text("Almost there");
|
||||
p2.set_option(option::PostfixText{"Almost there"});
|
||||
else if (ticks >= 98)
|
||||
p2.set_postfix_text("Landed on the Moon");
|
||||
p2.set_option(option::PostfixText{"Landed on the Moon"});
|
||||
p2.tick();
|
||||
ship_trail_index += 1;
|
||||
if (p2.is_completed())
|
||||
@@ -291,7 +265,7 @@ int main() {
|
||||
};
|
||||
std::thread thread2(job2);
|
||||
thread2.join();
|
||||
p.set_postfix_text("Mission successful!");
|
||||
p.set_option(indicators::option::PostfixText{"Mission successful!"});
|
||||
p.mark_as_completed();
|
||||
break;
|
||||
}
|
||||
@@ -306,7 +280,7 @@ int main() {
|
||||
}
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
BIN
img/block_progress_bar_iterable.gif
Normal file
BIN
img/block_progress_bar_iterable.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 252 KiB |
BIN
img/dynamic_progress_bar.gif
Normal file
BIN
img/dynamic_progress_bar.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 221 KiB |
BIN
img/dynamic_progress_bar_hide_completed.gif
Normal file
BIN
img/dynamic_progress_bar_hide_completed.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 173 KiB |
BIN
img/indeterminate_progress_bar.gif
Normal file
BIN
img/indeterminate_progress_bar.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
@@ -1,262 +1,242 @@
|
||||
/*
|
||||
Activity Indicators for Modern C++
|
||||
https://github.com/p-ranav/indicators
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2019 Pranav Srinivas Kumar <pranav.srinivas.kumar@gmail.com>.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
#define NOMINMAX
|
||||
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/details/stream_helper.hpp>
|
||||
|
||||
#include <algorithm>
|
||||
#include <atomic>
|
||||
#include <chrono>
|
||||
#include <cmath>
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/setting.hpp>
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
#include <mutex>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
#include <vector>
|
||||
#include <tuple>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
class BlockProgressBar {
|
||||
using Settings = std::tuple<option::ForegroundColor, option::BarWidth, option::Start, option::End,
|
||||
option::PrefixText, option::PostfixText, option::ShowPercentage,
|
||||
option::ShowElapsedTime, option::ShowRemainingTime, option::Completed,
|
||||
option::SavedStartTime, option::MaxPostfixTextLen, option::FontStyles,
|
||||
option::MaxProgress, option::Stream>;
|
||||
|
||||
public:
|
||||
void set_foreground_color(Color color) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_foreground_color = color;
|
||||
template <typename... Args,
|
||||
typename std::enable_if<details::are_settings_from_tuple<
|
||||
Settings, typename std::decay<Args>::type...>::value,
|
||||
void *>::type = nullptr>
|
||||
explicit BlockProgressBar(Args &&... args)
|
||||
: settings_(details::get<details::ProgressBarOption::foreground_color>(
|
||||
option::ForegroundColor{Color::unspecified}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::bar_width>(option::BarWidth{100},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::start>(option::Start{"["},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::end>(option::End{"]"},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::prefix_text>(
|
||||
option::PrefixText{""}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::postfix_text>(
|
||||
option::PostfixText{""}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_percentage>(
|
||||
option::ShowPercentage{true}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_elapsed_time>(
|
||||
option::ShowElapsedTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_remaining_time>(
|
||||
option::ShowRemainingTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::completed>(option::Completed{false},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::saved_start_time>(
|
||||
option::SavedStartTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_postfix_text_len>(
|
||||
option::MaxPostfixTextLen{0}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::font_styles>(
|
||||
option::FontStyles{std::vector<FontStyle>{}}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_progress>(option::MaxProgress{100},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::stream>(
|
||||
option::Stream{std::cout}, std::forward<Args>(args)...)
|
||||
) {}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(details::Setting<T, id> &&setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = std::move(setting).value;
|
||||
}
|
||||
|
||||
void set_bar_width(size_t bar_width) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_bar_width = bar_width;
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(const details::Setting<T, id> &setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = setting.value;
|
||||
}
|
||||
|
||||
void start_bar_with(const std::string &start) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_start = start;
|
||||
void set_option(
|
||||
const details::Setting<std::string, details::ProgressBarOption::postfix_text> &setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = setting.value;
|
||||
if (setting.value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = setting.value.length();
|
||||
}
|
||||
}
|
||||
|
||||
void end_bar_with(const std::string &end) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_end = end;
|
||||
void
|
||||
set_option(details::Setting<std::string, details::ProgressBarOption::postfix_text> &&setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = std::move(setting).value;
|
||||
auto &new_value = get_value<details::ProgressBarOption::postfix_text>();
|
||||
if (new_value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = new_value.length();
|
||||
}
|
||||
}
|
||||
|
||||
void set_prefix_text(const std::string &text) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_prefix_text = text;
|
||||
}
|
||||
|
||||
void set_postfix_text(const std::string &text) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_postfix_text = text;
|
||||
if (_postfix_text.length() > _max_postfix_text_length)
|
||||
_max_postfix_text_length = _postfix_text.length();
|
||||
}
|
||||
|
||||
void show_percentage() { _show_percentage = true; }
|
||||
|
||||
void hide_percentage() { _show_percentage = false; }
|
||||
|
||||
void show_elapsed_time() { _show_elapsed_time = true; }
|
||||
|
||||
void hide_elapsed_time() { _show_elapsed_time = false; }
|
||||
|
||||
void show_remaining_time() { _show_remaining_time = true; }
|
||||
|
||||
void hide_remaining_time() { _show_remaining_time = false; }
|
||||
|
||||
void set_progress(float value) {
|
||||
{
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_progress = value;
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
progress_ = value;
|
||||
}
|
||||
_save_start_time();
|
||||
_print_progress();
|
||||
save_start_time();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
void tick() {
|
||||
{
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_progress += 1;
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
progress_ += 1;
|
||||
}
|
||||
_save_start_time();
|
||||
_print_progress();
|
||||
save_start_time();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
size_t current() {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
return std::min(static_cast<size_t>(_progress), size_t(100));
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
return std::min(static_cast<size_t>(progress_), size_t(get_value<details::ProgressBarOption::max_progress>()));
|
||||
}
|
||||
|
||||
bool is_completed() const { return _completed; }
|
||||
bool is_completed() const { return get_value<details::ProgressBarOption::completed>(); }
|
||||
|
||||
void mark_as_completed() {
|
||||
_completed = true;
|
||||
_print_progress();
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
print_progress();
|
||||
}
|
||||
|
||||
private:
|
||||
float _progress{0.0};
|
||||
size_t _bar_width{100};
|
||||
std::string _prefix_text{""};
|
||||
std::string _start{"["};
|
||||
std::string _fill{"█"};
|
||||
std::string _lead{" "};
|
||||
std::string _remainder{" "};
|
||||
std::string _end{"]"};
|
||||
std::string _postfix_text{""};
|
||||
std::atomic<size_t> _max_postfix_text_length{0};
|
||||
std::atomic<bool> _completed{false};
|
||||
std::atomic<bool> _show_percentage{true};
|
||||
std::atomic<bool> _show_elapsed_time{false};
|
||||
std::atomic<bool> _show_remaining_time{false};
|
||||
std::atomic<bool> _saved_start_time{false};
|
||||
std::chrono::time_point<std::chrono::high_resolution_clock> _start_time_point;
|
||||
std::mutex _mutex;
|
||||
Color _foreground_color{indicators::Color::WHITE};
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() -> decltype((details::get_value<id>(std::declval<Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() const
|
||||
-> decltype((details::get_value<id>(std::declval<const Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
Settings settings_;
|
||||
float progress_{0.0};
|
||||
std::chrono::time_point<std::chrono::high_resolution_clock> start_time_point_;
|
||||
std::mutex mutex_;
|
||||
|
||||
template <typename Indicator, size_t count> friend class MultiProgress;
|
||||
std::atomic<bool> _multi_progress_mode{false};
|
||||
template <typename Indicator> friend class DynamicProgress;
|
||||
std::atomic<bool> multi_progress_mode_{false};
|
||||
|
||||
std::ostream &_print_duration(std::ostream &os, std::chrono::nanoseconds ns) {
|
||||
using namespace std;
|
||||
using namespace std::chrono;
|
||||
typedef duration<int, ratio<86400>> days;
|
||||
char fill = os.fill();
|
||||
os.fill('0');
|
||||
auto d = duration_cast<days>(ns);
|
||||
ns -= d;
|
||||
auto h = duration_cast<hours>(ns);
|
||||
ns -= h;
|
||||
auto m = duration_cast<minutes>(ns);
|
||||
ns -= m;
|
||||
auto s = duration_cast<seconds>(ns);
|
||||
if (d.count() > 0)
|
||||
os << setw(2) << d.count() << "d:";
|
||||
if (h.count() > 0)
|
||||
os << setw(2) << h.count() << "h:";
|
||||
os << setw(2) << m.count() << "m:" << setw(2) << s.count() << 's';
|
||||
os.fill(fill);
|
||||
return os;
|
||||
};
|
||||
|
||||
void _save_start_time() {
|
||||
if ((_show_elapsed_time || _show_remaining_time) && !_saved_start_time) {
|
||||
_start_time_point = std::chrono::high_resolution_clock::now();
|
||||
_saved_start_time = true;
|
||||
void save_start_time() {
|
||||
auto &show_elapsed_time = get_value<details::ProgressBarOption::show_elapsed_time>();
|
||||
auto &saved_start_time = get_value<details::ProgressBarOption::saved_start_time>();
|
||||
auto &show_remaining_time = get_value<details::ProgressBarOption::show_remaining_time>();
|
||||
if ((show_elapsed_time || show_remaining_time) && !saved_start_time) {
|
||||
start_time_point_ = std::chrono::high_resolution_clock::now();
|
||||
saved_start_time = true;
|
||||
}
|
||||
}
|
||||
|
||||
void _print_progress(bool from_multi_progress = false) {
|
||||
if (_multi_progress_mode && !from_multi_progress) {
|
||||
if (_progress > 100.0) {
|
||||
_completed = true;
|
||||
public:
|
||||
void print_progress(bool from_multi_progress = false) {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
|
||||
auto& os = get_value<details::ProgressBarOption::stream>();
|
||||
|
||||
const auto max_progress = get_value<details::ProgressBarOption::max_progress>();
|
||||
if (multi_progress_mode_ && !from_multi_progress) {
|
||||
if (progress_ > max_progress) {
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
}
|
||||
return;
|
||||
}
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
|
||||
auto now = std::chrono::high_resolution_clock::now();
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::nanoseconds>(now - _start_time_point);
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::nanoseconds>(now - start_time_point_);
|
||||
|
||||
std::cout << termcolor::bold;
|
||||
switch (_foreground_color) {
|
||||
case Color::GREY:
|
||||
std::cout << termcolor::grey;
|
||||
break;
|
||||
case Color::RED:
|
||||
std::cout << termcolor::red;
|
||||
break;
|
||||
case Color::GREEN:
|
||||
std::cout << termcolor::green;
|
||||
break;
|
||||
case Color::YELLOW:
|
||||
std::cout << termcolor::yellow;
|
||||
break;
|
||||
case Color::BLUE:
|
||||
std::cout << termcolor::blue;
|
||||
break;
|
||||
case Color::MAGENTA:
|
||||
std::cout << termcolor::magenta;
|
||||
break;
|
||||
case Color::CYAN:
|
||||
std::cout << termcolor::cyan;
|
||||
break;
|
||||
case Color::WHITE:
|
||||
std::cout << termcolor::white;
|
||||
break;
|
||||
}
|
||||
std::cout << _prefix_text;
|
||||
std::cout << _start;
|
||||
if (get_value<details::ProgressBarOption::foreground_color>() != Color::unspecified)
|
||||
details::set_stream_color(os, get_value<details::ProgressBarOption::foreground_color>());
|
||||
|
||||
std::vector<std::string> lead_characters{" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"};
|
||||
auto progress = std::min(1.0f, std::max(0.0f, _progress / 100.0f));
|
||||
auto whole_width = std::floor(progress * _bar_width);
|
||||
auto remainder_width = fmod((progress * _bar_width), 1.0f);
|
||||
auto part_width = std::floor(remainder_width * lead_characters.size());
|
||||
_lead = lead_characters[size_t(part_width)];
|
||||
if ((_bar_width - whole_width - 1) < 0)
|
||||
_lead = "";
|
||||
for (size_t i = 0; i < whole_width; ++i)
|
||||
std::cout << _fill;
|
||||
std::cout << _lead;
|
||||
for (size_t i = 0; i < (_bar_width - whole_width - 1); ++i)
|
||||
std::cout << " ";
|
||||
for (auto &style : get_value<details::ProgressBarOption::font_styles>())
|
||||
details::set_font_style(os, style);
|
||||
|
||||
os << get_value<details::ProgressBarOption::prefix_text>();
|
||||
os << get_value<details::ProgressBarOption::start>();
|
||||
|
||||
std::cout << _end;
|
||||
if (_show_percentage) {
|
||||
std::cout << " " << std::min(static_cast<size_t>(_progress), size_t(100)) << "%";
|
||||
details::BlockProgressScaleWriter writer{os,
|
||||
get_value<details::ProgressBarOption::bar_width>()};
|
||||
writer.write(progress_ / max_progress * 100);
|
||||
|
||||
os << get_value<details::ProgressBarOption::end>();
|
||||
if (get_value<details::ProgressBarOption::show_percentage>()) {
|
||||
os << " " << std::min(static_cast<size_t>(progress_ / max_progress * 100.0), size_t(100)) << "%";
|
||||
}
|
||||
|
||||
if (_show_elapsed_time) {
|
||||
std::cout << " [";
|
||||
_print_duration(std::cout, elapsed);
|
||||
}
|
||||
auto &saved_start_time = get_value<details::ProgressBarOption::saved_start_time>();
|
||||
|
||||
if (_show_remaining_time) {
|
||||
if (_show_elapsed_time)
|
||||
std::cout << "<";
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>()) {
|
||||
os << " [";
|
||||
if (saved_start_time)
|
||||
details::write_duration(os, elapsed);
|
||||
else
|
||||
std::cout << " [";
|
||||
auto eta = std::chrono::nanoseconds(
|
||||
_progress > 0 ? static_cast<long long>(elapsed.count() * 100 / _progress) : 0);
|
||||
auto remaining = eta > elapsed ? (eta - elapsed) : (elapsed - eta);
|
||||
_print_duration(std::cout, remaining);
|
||||
std::cout << "]";
|
||||
} else {
|
||||
if (_show_elapsed_time)
|
||||
std::cout << "]";
|
||||
os << "00:00s";
|
||||
}
|
||||
|
||||
if (_max_postfix_text_length == 0)
|
||||
_max_postfix_text_length = 10;
|
||||
std::cout << " " << _postfix_text << std::string(_max_postfix_text_length, ' ') << "\r";
|
||||
std::cout.flush();
|
||||
if (_progress > 100.0) {
|
||||
_completed = true;
|
||||
if (get_value<details::ProgressBarOption::show_remaining_time>()) {
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
||||
os << "<";
|
||||
else
|
||||
os << " [";
|
||||
|
||||
if (saved_start_time) {
|
||||
auto eta = std::chrono::nanoseconds(
|
||||
progress_ > 0 ? static_cast<long long>(elapsed.count() * max_progress / progress_) : 0);
|
||||
auto remaining = eta > elapsed ? (eta - elapsed) : (elapsed - eta);
|
||||
details::write_duration(os, remaining);
|
||||
} else {
|
||||
os << "00:00s";
|
||||
}
|
||||
|
||||
os << "]";
|
||||
} else {
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
||||
os << "]";
|
||||
}
|
||||
if (_completed && !from_multi_progress) // Don't std::endl if calling from MultiProgress
|
||||
std::cout << termcolor::reset << std::endl;
|
||||
|
||||
if (get_value<details::ProgressBarOption::max_postfix_text_len>() == 0)
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = 10;
|
||||
os << " " << get_value<details::ProgressBarOption::postfix_text>()
|
||||
<< std::string(get_value<details::ProgressBarOption::max_postfix_text_len>(), ' ')
|
||||
<< "\r";
|
||||
os.flush();
|
||||
if (progress_ > max_progress) {
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
}
|
||||
if (get_value<details::ProgressBarOption::completed>() &&
|
||||
!from_multi_progress) // Don't std::endl if calling from MultiProgress
|
||||
os << termcolor::reset << std::endl;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@@ -1,32 +1,6 @@
|
||||
/*
|
||||
Activity Indicators for Modern C++
|
||||
https://github.com/p-ranav/indica
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2019 Pranav Srinivas Kumar <pranav.srinivas.kumar@gmail.com>.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
#include <indicators/termcolor.hpp>
|
||||
|
||||
namespace indicators {
|
||||
enum class Color { GREY, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE };
|
||||
enum class Color { grey, red, green, yellow, blue, magenta, cyan, white, unspecified };
|
||||
}
|
||||
|
||||
35
include/indicators/cursor_control.hpp
Executable file
35
include/indicators/cursor_control.hpp
Executable file
@@ -0,0 +1,35 @@
|
||||
#pragma once
|
||||
|
||||
#if defined(_MSC_VER)
|
||||
#if !defined(NOMINMAX)
|
||||
#define NOMINMAX
|
||||
#endif
|
||||
#include <io.h>
|
||||
#include <windows.h>
|
||||
#else
|
||||
#include <cstdio>
|
||||
#endif
|
||||
|
||||
namespace indicators {
|
||||
|
||||
#if defined(_MSC_VER)
|
||||
|
||||
void show_console_cursor(bool const show) {
|
||||
HANDLE out = GetStdHandle(STD_OUTPUT_HANDLE);
|
||||
|
||||
CONSOLE_CURSOR_INFO cursorInfo;
|
||||
|
||||
GetConsoleCursorInfo(out, &cursorInfo);
|
||||
cursorInfo.bVisible = show; // set the cursor visibility
|
||||
SetConsoleCursorInfo(out, &cursorInfo);
|
||||
}
|
||||
|
||||
#else
|
||||
|
||||
void show_console_cursor(bool const show) {
|
||||
std::fputs(show ? "\e[?25h" : "\e[?25l", stdout);
|
||||
}
|
||||
|
||||
#endif
|
||||
|
||||
} // namespace indicators
|
||||
46
include/indicators/cursor_movement.hpp
Executable file
46
include/indicators/cursor_movement.hpp
Executable file
@@ -0,0 +1,46 @@
|
||||
#pragma once
|
||||
|
||||
#if defined(_MSC_VER)
|
||||
#if !defined(NOMINMAX)
|
||||
#define NOMINMAX
|
||||
#endif
|
||||
#include <io.h>
|
||||
#include <windows.h>
|
||||
#else
|
||||
#include <iostream>
|
||||
#endif
|
||||
|
||||
namespace indicators {
|
||||
|
||||
#ifdef _MSC_VER
|
||||
|
||||
void move(int x, int y) {
|
||||
auto hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
|
||||
if (!hStdout)
|
||||
return;
|
||||
|
||||
CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
|
||||
GetConsoleScreenBufferInfo(hStdout, &csbiInfo);
|
||||
|
||||
COORD cursor;
|
||||
|
||||
cursor.X = csbiInfo.dwCursorPosition.X + x;
|
||||
cursor.Y = csbiInfo.dwCursorPosition.Y + y;
|
||||
SetConsoleCursorPosition(hStdout, cursor);
|
||||
}
|
||||
|
||||
void move_up(int lines) { move(0, -lines); }
|
||||
void move_down(int lines) { move(0, -lines); }
|
||||
void move_right(int cols) { move(cols, 0); }
|
||||
void move_left(int cols) { move(-cols, 0); }
|
||||
|
||||
#else
|
||||
|
||||
void move_up(int lines) { std::cout << "\033[" << lines << "A"; }
|
||||
void move_down(int lines) { std::cout << "\033[" << lines << "B"; }
|
||||
void move_right(int cols) { std::cout << "\033[" << cols << "C"; }
|
||||
void move_left(int cols) { std::cout << "\033[" << cols << "D"; }
|
||||
|
||||
#endif
|
||||
|
||||
} // namespace indicators
|
||||
183
include/indicators/details/stream_helper.hpp
Normal file
183
include/indicators/details/stream_helper.hpp
Normal file
@@ -0,0 +1,183 @@
|
||||
#pragma once
|
||||
|
||||
#include <indicators/setting.hpp>
|
||||
#include <indicators/termcolor.hpp>
|
||||
|
||||
#include <algorithm>
|
||||
#include <chrono>
|
||||
#include <iomanip>
|
||||
#include <ostream>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include <cassert>
|
||||
#include <cmath>
|
||||
|
||||
namespace indicators {
|
||||
namespace details {
|
||||
|
||||
inline void set_stream_color(std::ostream &os, Color color) {
|
||||
switch (color) {
|
||||
case Color::grey:
|
||||
os << termcolor::grey;
|
||||
break;
|
||||
case Color::red:
|
||||
os << termcolor::red;
|
||||
break;
|
||||
case Color::green:
|
||||
os << termcolor::green;
|
||||
break;
|
||||
case Color::yellow:
|
||||
os << termcolor::yellow;
|
||||
break;
|
||||
case Color::blue:
|
||||
os << termcolor::blue;
|
||||
break;
|
||||
case Color::magenta:
|
||||
os << termcolor::magenta;
|
||||
break;
|
||||
case Color::cyan:
|
||||
os << termcolor::cyan;
|
||||
break;
|
||||
case Color::white:
|
||||
os << termcolor::white;
|
||||
break;
|
||||
default:
|
||||
assert(false);
|
||||
}
|
||||
}
|
||||
|
||||
inline void set_font_style(std::ostream &os, FontStyle style) {
|
||||
switch (style) {
|
||||
case FontStyle::bold:
|
||||
os << termcolor::bold;
|
||||
break;
|
||||
case FontStyle::dark:
|
||||
os << termcolor::dark;
|
||||
break;
|
||||
case FontStyle::italic:
|
||||
os << termcolor::italic;
|
||||
break;
|
||||
case FontStyle::underline:
|
||||
os << termcolor::underline;
|
||||
break;
|
||||
case FontStyle::blink:
|
||||
os << termcolor::blink;
|
||||
break;
|
||||
case FontStyle::reverse:
|
||||
os << termcolor::reverse;
|
||||
break;
|
||||
case FontStyle::concealed:
|
||||
os << termcolor::concealed;
|
||||
break;
|
||||
case FontStyle::crossed:
|
||||
os << termcolor::crossed;
|
||||
break;
|
||||
default:
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
inline std::ostream &write_duration(std::ostream &os, std::chrono::nanoseconds ns) {
|
||||
using namespace std;
|
||||
using namespace std::chrono;
|
||||
using days = duration<int, ratio<86400>>;
|
||||
char fill = os.fill();
|
||||
os.fill('0');
|
||||
auto d = duration_cast<days>(ns);
|
||||
ns -= d;
|
||||
auto h = duration_cast<hours>(ns);
|
||||
ns -= h;
|
||||
auto m = duration_cast<minutes>(ns);
|
||||
ns -= m;
|
||||
auto s = duration_cast<seconds>(ns);
|
||||
if (d.count() > 0)
|
||||
os << setw(2) << d.count() << "d:";
|
||||
if (h.count() > 0)
|
||||
os << setw(2) << h.count() << "h:";
|
||||
os << setw(2) << m.count() << "m:" << setw(2) << s.count() << 's';
|
||||
os.fill(fill);
|
||||
return os;
|
||||
}
|
||||
|
||||
class BlockProgressScaleWriter {
|
||||
public:
|
||||
BlockProgressScaleWriter(std::ostream &os, size_t bar_width) : os(os), bar_width(bar_width) {}
|
||||
|
||||
std::ostream &write(float progress) {
|
||||
std::string fill_text{"█"};
|
||||
std::vector<std::string> lead_characters{" ", "▏", "▎", "▍", "▌", "▋", "▊", "▉"};
|
||||
auto value = std::min(1.0f, std::max(0.0f, progress / 100.0f));
|
||||
auto whole_width = std::floor(value * bar_width);
|
||||
auto remainder_width = fmod((value * bar_width), 1.0f);
|
||||
auto part_width = std::floor(remainder_width * lead_characters.size());
|
||||
std::string lead_text = lead_characters[size_t(part_width)];
|
||||
if ((bar_width - whole_width - 1) < 0)
|
||||
lead_text = "";
|
||||
for (size_t i = 0; i < whole_width; ++i)
|
||||
os << fill_text;
|
||||
os << lead_text;
|
||||
for (size_t i = 0; i < (bar_width - whole_width - 1); ++i)
|
||||
os << " ";
|
||||
return os;
|
||||
}
|
||||
|
||||
private:
|
||||
std::ostream &os;
|
||||
size_t bar_width = 0;
|
||||
};
|
||||
|
||||
class ProgressScaleWriter {
|
||||
public:
|
||||
ProgressScaleWriter(std::ostream &os, size_t bar_width, const std::string &fill,
|
||||
const std::string &lead, const std::string &remainder)
|
||||
: os(os), bar_width(bar_width), fill(fill), lead(lead), remainder(remainder) {}
|
||||
|
||||
std::ostream &write(float progress) {
|
||||
auto pos = static_cast<size_t>(progress * bar_width / 100.0);
|
||||
for (size_t i = 0; i < bar_width; ++i) {
|
||||
if (i < pos)
|
||||
os << fill;
|
||||
else if (i == pos)
|
||||
os << lead;
|
||||
else
|
||||
os << remainder;
|
||||
}
|
||||
return os;
|
||||
}
|
||||
|
||||
private:
|
||||
std::ostream &os;
|
||||
size_t bar_width = 0;
|
||||
std::string fill;
|
||||
std::string lead;
|
||||
std::string remainder;
|
||||
};
|
||||
|
||||
class IndeterminateProgressScaleWriter {
|
||||
public:
|
||||
IndeterminateProgressScaleWriter(std::ostream &os, size_t bar_width, const std::string &fill,
|
||||
const std::string &lead)
|
||||
: os(os), bar_width(bar_width), fill(fill), lead(lead) {}
|
||||
|
||||
std::ostream &write(size_t progress) {
|
||||
for (size_t i = 0; i < bar_width; ++i) {
|
||||
if (i < progress)
|
||||
os << fill;
|
||||
else if (i == progress)
|
||||
os << lead;
|
||||
else
|
||||
os << fill;
|
||||
}
|
||||
return os;
|
||||
}
|
||||
|
||||
private:
|
||||
std::ostream &os;
|
||||
size_t bar_width = 0;
|
||||
std::string fill;
|
||||
std::string lead;
|
||||
};
|
||||
|
||||
} // namespace details
|
||||
} // namespace indicators
|
||||
113
include/indicators/dynamic_progress.hpp
Normal file
113
include/indicators/dynamic_progress.hpp
Normal file
@@ -0,0 +1,113 @@
|
||||
#pragma once
|
||||
#include <atomic>
|
||||
#include <functional>
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/setting.hpp>
|
||||
#include <iostream>
|
||||
#include <mutex>
|
||||
#include <vector>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
template <typename Indicator> class DynamicProgress {
|
||||
using Settings = std::tuple<option::HideBarWhenComplete>;
|
||||
|
||||
public:
|
||||
template <typename... Indicators> explicit DynamicProgress(Indicators &... bars) {
|
||||
bars_ = {bars...};
|
||||
for (auto &bar : bars_) {
|
||||
bar.get().multi_progress_mode_ = true;
|
||||
++total_count_;
|
||||
++incomplete_count_;
|
||||
}
|
||||
}
|
||||
|
||||
Indicator &operator[](size_t index) {
|
||||
print_progress();
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
return bars_[index].get();
|
||||
}
|
||||
|
||||
size_t push_back(Indicator &bar) {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
bar.multi_progress_mode_ = true;
|
||||
bars_.push_back(bar);
|
||||
return bars_.size() - 1;
|
||||
}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(details::Setting<T, id> &&setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = std::move(setting).value;
|
||||
}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(const details::Setting<T, id> &setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = setting.value;
|
||||
}
|
||||
|
||||
private:
|
||||
Settings settings_;
|
||||
std::atomic<bool> started_{false};
|
||||
std::mutex mutex_;
|
||||
std::vector<std::reference_wrapper<Indicator>> bars_;
|
||||
std::atomic<size_t> total_count_{0};
|
||||
std::atomic<size_t> incomplete_count_{0};
|
||||
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() -> decltype((details::get_value<id>(std::declval<Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() const
|
||||
-> decltype((details::get_value<id>(std::declval<const Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
public:
|
||||
void print_progress() {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
auto &hide_bar_when_complete = get_value<details::ProgressBarOption::hide_bar_when_complete>();
|
||||
if (hide_bar_when_complete) {
|
||||
// Hide completed bars
|
||||
if (started_) {
|
||||
for (size_t i = 0; i < incomplete_count_; ++i)
|
||||
std::cout << "\033[A\r\033[K" << std::flush;
|
||||
}
|
||||
incomplete_count_ = 0;
|
||||
for (auto &bar : bars_) {
|
||||
if (!bar.get().is_completed()) {
|
||||
bar.get().print_progress(true);
|
||||
std::cout << "\n";
|
||||
++incomplete_count_;
|
||||
}
|
||||
}
|
||||
if (!started_)
|
||||
started_ = true;
|
||||
} else {
|
||||
// Don't hide any bars
|
||||
if (started_) {
|
||||
for (size_t i = 0; i < total_count_; ++i)
|
||||
std::cout << "\x1b[A";
|
||||
}
|
||||
for (auto &bar : bars_) {
|
||||
bar.get().print_progress(true);
|
||||
std::cout << "\n";
|
||||
}
|
||||
if (!started_)
|
||||
started_ = true;
|
||||
}
|
||||
total_count_ = bars_.size();
|
||||
std::cout << termcolor::reset;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace indicators
|
||||
7
include/indicators/font_style.hpp
Normal file
7
include/indicators/font_style.hpp
Normal file
@@ -0,0 +1,7 @@
|
||||
#pragma once
|
||||
|
||||
namespace indicators {
|
||||
|
||||
enum class FontStyle { bold, dark, italic, underline, blink, reverse, concealed, crossed };
|
||||
|
||||
}
|
||||
203
include/indicators/indeterminate_progress_bar.hpp
Normal file
203
include/indicators/indeterminate_progress_bar.hpp
Normal file
@@ -0,0 +1,203 @@
|
||||
#pragma once
|
||||
|
||||
#include <indicators/details/stream_helper.hpp>
|
||||
|
||||
#include <algorithm>
|
||||
#include <atomic>
|
||||
#include <chrono>
|
||||
#include <cmath>
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/setting.hpp>
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
#include <mutex>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
#include <tuple>
|
||||
#include <type_traits>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
class IndeterminateProgressBar {
|
||||
using Settings =
|
||||
std::tuple<option::BarWidth, option::PrefixText, option::PostfixText, option::Start,
|
||||
option::End, option::Fill, option::Lead,
|
||||
option::MaxPostfixTextLen, option::Completed,
|
||||
option::ForegroundColor, option::FontStyles, option::Stream>;
|
||||
|
||||
enum class Direction {
|
||||
forward,
|
||||
backward
|
||||
};
|
||||
|
||||
Direction direction_{Direction::forward};
|
||||
|
||||
public:
|
||||
template <typename... Args,
|
||||
typename std::enable_if<details::are_settings_from_tuple<
|
||||
Settings, typename std::decay<Args>::type...>::value,
|
||||
void *>::type = nullptr>
|
||||
explicit IndeterminateProgressBar(Args &&... args)
|
||||
: settings_(details::get<details::ProgressBarOption::bar_width>(option::BarWidth{100},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::prefix_text>(
|
||||
option::PrefixText{}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::postfix_text>(
|
||||
option::PostfixText{}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::start>(option::Start{"["},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::end>(option::End{"]"},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::fill>(option::Fill{"."},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::lead>(option::Lead{"<==>"},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_postfix_text_len>(
|
||||
option::MaxPostfixTextLen{0}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::completed>(option::Completed{false},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::foreground_color>(
|
||||
option::ForegroundColor{Color::unspecified}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::font_styles>(
|
||||
option::FontStyles{std::vector<FontStyle>{}}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::stream>(
|
||||
option::Stream{std::cout}, std::forward<Args>(args)...)) {
|
||||
// starts with [<==>...........]
|
||||
// progress_ = 0
|
||||
|
||||
// ends with [...........<==>]
|
||||
// ^^^^^^^^^^^^^^^^^ bar_width
|
||||
// ^^^^^^^^^^^^ (bar_width - len(lead))
|
||||
// progress_ = bar_width - len(lead)
|
||||
progress_ = 0;
|
||||
max_progress_ = get_value<details::ProgressBarOption::bar_width>()
|
||||
- get_value<details::ProgressBarOption::lead>().size()
|
||||
+ get_value<details::ProgressBarOption::start>().size()
|
||||
+ get_value<details::ProgressBarOption::end>().size();
|
||||
}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(details::Setting<T, id> &&setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = std::move(setting).value;
|
||||
}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(const details::Setting<T, id> &setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = setting.value;
|
||||
}
|
||||
|
||||
void set_option(
|
||||
const details::Setting<std::string, details::ProgressBarOption::postfix_text> &setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = setting.value;
|
||||
if (setting.value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = setting.value.length();
|
||||
}
|
||||
}
|
||||
|
||||
void
|
||||
set_option(details::Setting<std::string, details::ProgressBarOption::postfix_text> &&setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = std::move(setting).value;
|
||||
auto &new_value = get_value<details::ProgressBarOption::postfix_text>();
|
||||
if (new_value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = new_value.length();
|
||||
}
|
||||
}
|
||||
|
||||
void tick() {
|
||||
{
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
if (get_value<details::ProgressBarOption::completed>())
|
||||
return;
|
||||
|
||||
progress_ += (direction_ == Direction::forward) ? 1 : -1;
|
||||
if (direction_ == Direction::forward && progress_ == max_progress_) {
|
||||
// time to go back
|
||||
direction_ = Direction::backward;
|
||||
} else if (direction_ == Direction::backward && progress_ == 0) {
|
||||
direction_ = Direction::forward;
|
||||
}
|
||||
}
|
||||
print_progress();
|
||||
}
|
||||
|
||||
bool is_completed() {
|
||||
return get_value<details::ProgressBarOption::completed>();
|
||||
}
|
||||
|
||||
void mark_as_completed() {
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
print_progress();
|
||||
}
|
||||
|
||||
private:
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() -> decltype((details::get_value<id>(std::declval<Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() const
|
||||
-> decltype((details::get_value<id>(std::declval<const Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
size_t progress_{0};
|
||||
size_t max_progress_;
|
||||
Settings settings_;
|
||||
std::chrono::nanoseconds elapsed_;
|
||||
std::mutex mutex_;
|
||||
|
||||
template <typename Indicator, size_t count> friend class MultiProgress;
|
||||
template <typename Indicator> friend class DynamicProgress;
|
||||
std::atomic<bool> multi_progress_mode_{false};
|
||||
|
||||
public:
|
||||
void print_progress(bool from_multi_progress = false) {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
|
||||
auto& os = get_value<details::ProgressBarOption::stream>();
|
||||
|
||||
if (multi_progress_mode_ && !from_multi_progress) {
|
||||
return;
|
||||
}
|
||||
if (get_value<details::ProgressBarOption::foreground_color>() != Color::unspecified)
|
||||
details::set_stream_color(os, get_value<details::ProgressBarOption::foreground_color>());
|
||||
|
||||
for (auto &style : get_value<details::ProgressBarOption::font_styles>())
|
||||
details::set_font_style(os, style);
|
||||
|
||||
os << get_value<details::ProgressBarOption::prefix_text>();
|
||||
|
||||
os << get_value<details::ProgressBarOption::start>();
|
||||
|
||||
details::IndeterminateProgressScaleWriter writer{os,
|
||||
get_value<details::ProgressBarOption::bar_width>(),
|
||||
get_value<details::ProgressBarOption::fill>(),
|
||||
get_value<details::ProgressBarOption::lead>()};
|
||||
writer.write(progress_);
|
||||
|
||||
os << get_value<details::ProgressBarOption::end>();
|
||||
|
||||
if (get_value<details::ProgressBarOption::max_postfix_text_len>() == 0)
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = 10;
|
||||
os << " " << get_value<details::ProgressBarOption::postfix_text>()
|
||||
<< std::string(get_value<details::ProgressBarOption::max_postfix_text_len>(), ' ')
|
||||
<< "\r";
|
||||
os.flush();
|
||||
if (get_value<details::ProgressBarOption::completed>() &&
|
||||
!from_multi_progress) // Don't std::endl if calling from MultiProgress
|
||||
os << termcolor::reset << std::endl;
|
||||
}
|
||||
};
|
||||
|
||||
} // namespace indicators
|
||||
@@ -1,37 +1,13 @@
|
||||
/*
|
||||
Activity Indicators for Modern C++
|
||||
https://github.com/p-ranav/indicators
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2019 Pranav Srinivas Kumar <pranav.srinivas.kumar@gmail.com>.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
#include <atomic>
|
||||
#include <functional>
|
||||
#include <indicators/color.hpp>
|
||||
#include <iostream>
|
||||
#include <mutex>
|
||||
#include <vector>
|
||||
|
||||
#include <indicators/cursor_movement.hpp>
|
||||
#include <indicators/color.hpp>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
template <typename Indicator, size_t count> class MultiProgress {
|
||||
@@ -39,55 +15,62 @@ public:
|
||||
template <typename... Indicators,
|
||||
typename = typename std::enable_if<(sizeof...(Indicators) == count)>::type>
|
||||
explicit MultiProgress(Indicators &... bars) {
|
||||
_bars = {bars...};
|
||||
for (auto &bar : _bars) {
|
||||
bar.get()._multi_progress_mode = true;
|
||||
bars_ = {bars...};
|
||||
for (auto &bar : bars_) {
|
||||
bar.get().multi_progress_mode_ = true;
|
||||
}
|
||||
}
|
||||
|
||||
template <size_t index>
|
||||
typename std::enable_if<(index >= 0 && index < count), void>::type set_progress(size_t value) {
|
||||
if (!bars_[index].get().is_completed())
|
||||
bars_[index].get().set_progress(value);
|
||||
print_progress();
|
||||
}
|
||||
|
||||
template <size_t index>
|
||||
typename std::enable_if<(index >= 0 && index < count), void>::type set_progress(float value) {
|
||||
if (!_bars[index].get().is_completed())
|
||||
_bars[index].get().set_progress(value);
|
||||
_print_progress();
|
||||
if (!bars_[index].get().is_completed())
|
||||
bars_[index].get().set_progress(value);
|
||||
print_progress();
|
||||
}
|
||||
|
||||
template <size_t index>
|
||||
typename std::enable_if<(index >= 0 && index < count), void>::type tick() {
|
||||
if (!_bars[index].get().is_completed())
|
||||
_bars[index].get().tick();
|
||||
_print_progress();
|
||||
if (!bars_[index].get().is_completed())
|
||||
bars_[index].get().tick();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
template <size_t index>
|
||||
typename std::enable_if<(index >= 0 && index < count), bool>::type is_completed() const {
|
||||
return _bars[index].get().is_completed();
|
||||
return bars_[index].get().is_completed();
|
||||
}
|
||||
|
||||
private:
|
||||
std::atomic<bool> _started{false};
|
||||
std::mutex _mutex;
|
||||
std::vector<std::reference_wrapper<Indicator>> _bars;
|
||||
std::atomic<bool> started_{false};
|
||||
std::mutex mutex_;
|
||||
std::vector<std::reference_wrapper<Indicator>> bars_;
|
||||
|
||||
bool _all_completed() {
|
||||
bool result{true};
|
||||
for (size_t i = 0; i < count; ++i)
|
||||
result &= _bars[i].get().is_completed();
|
||||
result &= bars_[i].get().is_completed();
|
||||
return result;
|
||||
}
|
||||
|
||||
void _print_progress() {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
if (_started)
|
||||
for (size_t i = 0; i < count; ++i)
|
||||
std::cout << "\x1b[A";
|
||||
for (auto &bar : _bars) {
|
||||
bar.get()._print_progress(true);
|
||||
public:
|
||||
void print_progress() {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
if (started_)
|
||||
move_up(count);
|
||||
for (auto &bar : bars_) {
|
||||
bar.get().print_progress(true);
|
||||
std::cout << "\n";
|
||||
}
|
||||
std::cout << termcolor::reset;
|
||||
if (!_started)
|
||||
_started = true;
|
||||
if (!started_)
|
||||
started_ = true;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@@ -1,270 +1,257 @@
|
||||
/*
|
||||
Activity Indicators for Modern C++
|
||||
https://github.com/p-ranav/indicators
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2019 Pranav Srinivas Kumar <pranav.srinivas.kumar@gmail.com>.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
#define NOMINMAX
|
||||
|
||||
#include <indicators/details/stream_helper.hpp>
|
||||
|
||||
#include <algorithm>
|
||||
#include <atomic>
|
||||
#include <chrono>
|
||||
#include <cmath>
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/setting.hpp>
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
#include <mutex>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
#include <tuple>
|
||||
#include <type_traits>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
class ProgressBar {
|
||||
using Settings =
|
||||
std::tuple<option::BarWidth, option::PrefixText, option::PostfixText, option::Start,
|
||||
option::End, option::Fill, option::Lead, option::Remainder,
|
||||
option::MaxPostfixTextLen, option::Completed, option::ShowPercentage,
|
||||
option::ShowElapsedTime, option::ShowRemainingTime, option::SavedStartTime,
|
||||
option::ForegroundColor, option::FontStyles, option::MaxProgress, option::Stream>;
|
||||
|
||||
public:
|
||||
void set_foreground_color(Color color) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_foreground_color = color;
|
||||
template <typename... Args,
|
||||
typename std::enable_if<details::are_settings_from_tuple<
|
||||
Settings, typename std::decay<Args>::type...>::value,
|
||||
void *>::type = nullptr>
|
||||
explicit ProgressBar(Args &&... args)
|
||||
: settings_(details::get<details::ProgressBarOption::bar_width>(option::BarWidth{100},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::prefix_text>(
|
||||
option::PrefixText{}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::postfix_text>(
|
||||
option::PostfixText{}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::start>(option::Start{"["},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::end>(option::End{"]"},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::fill>(option::Fill{"="},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::lead>(option::Lead{">"},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::remainder>(option::Remainder{" "},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_postfix_text_len>(
|
||||
option::MaxPostfixTextLen{0}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::completed>(option::Completed{false},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_percentage>(
|
||||
option::ShowPercentage{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_elapsed_time>(
|
||||
option::ShowElapsedTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_remaining_time>(
|
||||
option::ShowRemainingTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::saved_start_time>(
|
||||
option::SavedStartTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::foreground_color>(
|
||||
option::ForegroundColor{Color::unspecified}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::font_styles>(
|
||||
option::FontStyles{std::vector<FontStyle>{}}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_progress>(
|
||||
option::MaxProgress{100}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::stream>(
|
||||
option::Stream{std::cout}, std::forward<Args>(args)...)) {}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(details::Setting<T, id> &&setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = std::move(setting).value;
|
||||
}
|
||||
|
||||
void set_bar_width(size_t bar_width) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_bar_width = bar_width;
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(const details::Setting<T, id> &setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = setting.value;
|
||||
}
|
||||
|
||||
void start_bar_with(const std::string &start) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_start = start;
|
||||
}
|
||||
|
||||
void fill_bar_progress_with(const std::string &fill) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_fill = fill;
|
||||
}
|
||||
|
||||
void lead_bar_progress_with(const std::string &lead) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_lead = lead;
|
||||
}
|
||||
|
||||
void fill_bar_remainder_with(const std::string &remainder) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_remainder = remainder;
|
||||
}
|
||||
|
||||
void end_bar_with(const std::string &end) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_end = end;
|
||||
}
|
||||
|
||||
void set_prefix_text(const std::string &text) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_prefix_text = text;
|
||||
}
|
||||
|
||||
void set_postfix_text(const std::string &text) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_postfix_text = text;
|
||||
if (_postfix_text.length() > _max_postfix_text_length)
|
||||
_max_postfix_text_length = _postfix_text.length();
|
||||
}
|
||||
|
||||
void show_percentage() { _show_percentage = true; }
|
||||
|
||||
void hide_percentage() { _show_percentage = false; }
|
||||
|
||||
void show_elapsed_time() { _show_elapsed_time = true; }
|
||||
|
||||
void hide_elapsed_time() { _show_elapsed_time = false; }
|
||||
|
||||
void show_remaining_time() { _show_remaining_time = true; }
|
||||
|
||||
void hide_remaining_time() { _show_remaining_time = false; }
|
||||
|
||||
void set_progress(float value) {
|
||||
{
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_progress = value;
|
||||
void set_option(
|
||||
const details::Setting<std::string, details::ProgressBarOption::postfix_text> &setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = setting.value;
|
||||
if (setting.value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = setting.value.length();
|
||||
}
|
||||
_save_start_time();
|
||||
_print_progress();
|
||||
}
|
||||
|
||||
void
|
||||
set_option(details::Setting<std::string, details::ProgressBarOption::postfix_text> &&setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = std::move(setting).value;
|
||||
auto &new_value = get_value<details::ProgressBarOption::postfix_text>();
|
||||
if (new_value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = new_value.length();
|
||||
}
|
||||
}
|
||||
|
||||
void set_progress(size_t new_progress) {
|
||||
{
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
progress_ = new_progress;
|
||||
}
|
||||
|
||||
save_start_time();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
void tick() {
|
||||
{
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_progress += 1;
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
progress_ += 1;
|
||||
}
|
||||
_save_start_time();
|
||||
_print_progress();
|
||||
save_start_time();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
size_t current() {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
return std::min(static_cast<size_t>(_progress), size_t(100));
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
return std::min(progress_, size_t(get_value<details::ProgressBarOption::max_progress>()));
|
||||
}
|
||||
|
||||
bool is_completed() const { return _completed; }
|
||||
bool is_completed() const { return get_value<details::ProgressBarOption::completed>(); }
|
||||
|
||||
void mark_as_completed() {
|
||||
_completed = true;
|
||||
_print_progress();
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
print_progress();
|
||||
}
|
||||
|
||||
private:
|
||||
float _progress{0.0};
|
||||
size_t _bar_width{100};
|
||||
std::string _prefix_text{""};
|
||||
std::string _start{"["};
|
||||
std::string _fill{"="};
|
||||
std::string _lead{">"};
|
||||
std::string _remainder{" "};
|
||||
std::string _end{"]"};
|
||||
std::string _postfix_text{""};
|
||||
std::atomic<size_t> _max_postfix_text_length{0};
|
||||
std::atomic<bool> _completed{false};
|
||||
std::atomic<bool> _show_percentage{true};
|
||||
std::atomic<bool> _show_elapsed_time{false};
|
||||
std::atomic<bool> _show_remaining_time{false};
|
||||
std::atomic<bool> _saved_start_time{false};
|
||||
std::chrono::time_point<std::chrono::high_resolution_clock> _start_time_point;
|
||||
std::mutex _mutex;
|
||||
Color _foreground_color{indicators::Color::WHITE};
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() -> decltype((details::get_value<id>(std::declval<Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() const
|
||||
-> decltype((details::get_value<id>(std::declval<const Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
size_t progress_{0};
|
||||
Settings settings_;
|
||||
std::chrono::nanoseconds elapsed_;
|
||||
std::chrono::time_point<std::chrono::high_resolution_clock> start_time_point_;
|
||||
std::mutex mutex_;
|
||||
|
||||
template <typename Indicator, size_t count> friend class MultiProgress;
|
||||
std::atomic<bool> _multi_progress_mode{false};
|
||||
template <typename Indicator> friend class DynamicProgress;
|
||||
std::atomic<bool> multi_progress_mode_{false};
|
||||
|
||||
std::ostream &_print_duration(std::ostream &os, std::chrono::nanoseconds ns) {
|
||||
using namespace std;
|
||||
using namespace std::chrono;
|
||||
typedef duration<int, ratio<86400>> days;
|
||||
char fill = os.fill();
|
||||
os.fill('0');
|
||||
auto d = duration_cast<days>(ns);
|
||||
ns -= d;
|
||||
auto h = duration_cast<hours>(ns);
|
||||
ns -= h;
|
||||
auto m = duration_cast<minutes>(ns);
|
||||
ns -= m;
|
||||
auto s = duration_cast<seconds>(ns);
|
||||
if (d.count() > 0)
|
||||
os << setw(2) << d.count() << "d:";
|
||||
if (h.count() > 0)
|
||||
os << setw(2) << h.count() << "h:";
|
||||
os << setw(2) << m.count() << "m:" << setw(2) << s.count() << 's';
|
||||
os.fill(fill);
|
||||
return os;
|
||||
};
|
||||
|
||||
void _save_start_time() {
|
||||
if ((_show_elapsed_time || _show_remaining_time) && !_saved_start_time) {
|
||||
_start_time_point = std::chrono::high_resolution_clock::now();
|
||||
_saved_start_time = true;
|
||||
void save_start_time() {
|
||||
auto &show_elapsed_time = get_value<details::ProgressBarOption::show_elapsed_time>();
|
||||
auto &saved_start_time = get_value<details::ProgressBarOption::saved_start_time>();
|
||||
auto &show_remaining_time = get_value<details::ProgressBarOption::show_remaining_time>();
|
||||
if ((show_elapsed_time || show_remaining_time) && !saved_start_time) {
|
||||
start_time_point_ = std::chrono::high_resolution_clock::now();
|
||||
saved_start_time = true;
|
||||
}
|
||||
}
|
||||
|
||||
void _print_progress(bool from_multi_progress = false) {
|
||||
if (_multi_progress_mode && !from_multi_progress) {
|
||||
if (_progress > 100.0) {
|
||||
_completed = true;
|
||||
public:
|
||||
void print_progress(bool from_multi_progress = false) {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
|
||||
auto& os = get_value<details::ProgressBarOption::stream>();
|
||||
|
||||
const auto max_progress = get_value<details::ProgressBarOption::max_progress>();
|
||||
if (multi_progress_mode_ && !from_multi_progress) {
|
||||
if (progress_ >= max_progress) {
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
}
|
||||
return;
|
||||
}
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
auto now = std::chrono::high_resolution_clock::now();
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::nanoseconds>(now - _start_time_point);
|
||||
if (!get_value<details::ProgressBarOption::completed>())
|
||||
elapsed_ = std::chrono::duration_cast<std::chrono::nanoseconds>(now - start_time_point_);
|
||||
|
||||
std::cout << termcolor::bold;
|
||||
switch (_foreground_color) {
|
||||
case Color::GREY:
|
||||
std::cout << termcolor::grey;
|
||||
break;
|
||||
case Color::RED:
|
||||
std::cout << termcolor::red;
|
||||
break;
|
||||
case Color::GREEN:
|
||||
std::cout << termcolor::green;
|
||||
break;
|
||||
case Color::YELLOW:
|
||||
std::cout << termcolor::yellow;
|
||||
break;
|
||||
case Color::BLUE:
|
||||
std::cout << termcolor::blue;
|
||||
break;
|
||||
case Color::MAGENTA:
|
||||
std::cout << termcolor::magenta;
|
||||
break;
|
||||
case Color::CYAN:
|
||||
std::cout << termcolor::cyan;
|
||||
break;
|
||||
case Color::WHITE:
|
||||
std::cout << termcolor::white;
|
||||
break;
|
||||
if (get_value<details::ProgressBarOption::foreground_color>() != Color::unspecified)
|
||||
details::set_stream_color(os, get_value<details::ProgressBarOption::foreground_color>());
|
||||
|
||||
for (auto &style : get_value<details::ProgressBarOption::font_styles>())
|
||||
details::set_font_style(os, style);
|
||||
|
||||
os << get_value<details::ProgressBarOption::prefix_text>();
|
||||
|
||||
os << get_value<details::ProgressBarOption::start>();
|
||||
|
||||
details::ProgressScaleWriter writer{os,
|
||||
get_value<details::ProgressBarOption::bar_width>(),
|
||||
get_value<details::ProgressBarOption::fill>(),
|
||||
get_value<details::ProgressBarOption::lead>(),
|
||||
get_value<details::ProgressBarOption::remainder>()};
|
||||
writer.write(double(progress_) / double(max_progress) * 100.0f);
|
||||
|
||||
os << get_value<details::ProgressBarOption::end>();
|
||||
|
||||
if (get_value<details::ProgressBarOption::show_percentage>()) {
|
||||
os << " " << std::min(static_cast<size_t>(static_cast<float>(progress_) / max_progress * 100), size_t(100)) << "%";
|
||||
}
|
||||
std::cout << _prefix_text;
|
||||
std::cout << _start;
|
||||
auto pos = static_cast<size_t>(_progress * static_cast<float>(_bar_width) / 100.0);
|
||||
for (size_t i = 0; i < _bar_width; ++i) {
|
||||
if (i < pos)
|
||||
std::cout << _fill;
|
||||
else if (i == pos)
|
||||
std::cout << _lead;
|
||||
|
||||
auto &saved_start_time = get_value<details::ProgressBarOption::saved_start_time>();
|
||||
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>()) {
|
||||
os << " [";
|
||||
if (saved_start_time)
|
||||
details::write_duration(os, elapsed_);
|
||||
else
|
||||
std::cout << _remainder;
|
||||
}
|
||||
std::cout << _end;
|
||||
if (_show_percentage) {
|
||||
std::cout << " " << std::min(static_cast<size_t>(_progress), size_t(100)) << "%";
|
||||
os << "00:00s";
|
||||
}
|
||||
|
||||
if (_show_elapsed_time) {
|
||||
std::cout << " [";
|
||||
_print_duration(std::cout, elapsed);
|
||||
}
|
||||
|
||||
if (_show_remaining_time) {
|
||||
if (_show_elapsed_time)
|
||||
std::cout << "<";
|
||||
if (get_value<details::ProgressBarOption::show_remaining_time>()) {
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
||||
os << "<";
|
||||
else
|
||||
std::cout << " [";
|
||||
auto eta = std::chrono::nanoseconds(
|
||||
_progress > 0 ? static_cast<long long>(elapsed.count() * 100 / _progress) : 0);
|
||||
auto remaining = eta > elapsed ? (eta - elapsed) : (elapsed - eta);
|
||||
_print_duration(std::cout, remaining);
|
||||
std::cout << "]";
|
||||
os << " [";
|
||||
|
||||
if (saved_start_time) {
|
||||
auto eta = std::chrono::nanoseconds(
|
||||
progress_ > 0 ? static_cast<long long>(elapsed_.count() * max_progress / progress_) : 0);
|
||||
auto remaining = eta > elapsed_ ? (eta - elapsed_) : (elapsed_ - eta);
|
||||
details::write_duration(os, remaining);
|
||||
} else {
|
||||
os << "00:00s";
|
||||
}
|
||||
|
||||
os << "]";
|
||||
} else {
|
||||
if (_show_elapsed_time)
|
||||
std::cout << "]";
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
||||
os << "]";
|
||||
}
|
||||
|
||||
if (_max_postfix_text_length == 0)
|
||||
_max_postfix_text_length = 10;
|
||||
std::cout << " " << _postfix_text << std::string(_max_postfix_text_length, ' ') << "\r";
|
||||
std::cout.flush();
|
||||
if (_progress > 100.0) {
|
||||
_completed = true;
|
||||
if (get_value<details::ProgressBarOption::max_postfix_text_len>() == 0)
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = 10;
|
||||
os << " " << get_value<details::ProgressBarOption::postfix_text>()
|
||||
<< std::string(get_value<details::ProgressBarOption::max_postfix_text_len>(), ' ')
|
||||
<< "\r";
|
||||
os.flush();
|
||||
if (progress_ >= max_progress) {
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
}
|
||||
if (_completed && !from_multi_progress) // Don't std::endl if calling from MultiProgress
|
||||
std::cout << termcolor::reset << std::endl;
|
||||
if (get_value<details::ProgressBarOption::completed>() &&
|
||||
!from_multi_progress) // Don't std::endl if calling from MultiProgress
|
||||
os << termcolor::reset << std::endl;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
@@ -1,230 +1,219 @@
|
||||
/*
|
||||
Activity Indicators for Modern C++
|
||||
https://github.com/p-ranav/indicators
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2019 Pranav Srinivas Kumar <pranav.srinivas.kumar@gmail.com>.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
#define NOMINMAX
|
||||
|
||||
#include <indicators/details/stream_helper.hpp>
|
||||
|
||||
#include <algorithm>
|
||||
#include <atomic>
|
||||
#include <chrono>
|
||||
#include <cmath>
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/setting.hpp>
|
||||
#include <iomanip>
|
||||
#include <iostream>
|
||||
#include <mutex>
|
||||
#include <string>
|
||||
#include <thread>
|
||||
#include <tuple>
|
||||
#include <vector>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
class ProgressSpinner {
|
||||
using Settings =
|
||||
std::tuple<option::ForegroundColor, option::PrefixText, option::PostfixText,
|
||||
option::ShowPercentage, option::ShowElapsedTime, option::ShowRemainingTime,
|
||||
option::ShowSpinner, option::SavedStartTime, option::Completed,
|
||||
option::MaxPostfixTextLen, option::SpinnerStates, option::FontStyles,
|
||||
option::MaxProgress, option::Stream>;
|
||||
|
||||
public:
|
||||
void set_foreground_color(Color color) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_foreground_color = color;
|
||||
template <typename... Args,
|
||||
typename std::enable_if<details::are_settings_from_tuple<
|
||||
Settings, typename std::decay<Args>::type...>::value,
|
||||
void *>::type = nullptr>
|
||||
explicit ProgressSpinner(Args &&... args)
|
||||
: settings_(details::get<details::ProgressBarOption::foreground_color>(
|
||||
option::ForegroundColor{Color::unspecified}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::prefix_text>(
|
||||
option::PrefixText{}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::postfix_text>(
|
||||
option::PostfixText{}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_percentage>(
|
||||
option::ShowPercentage{true}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_elapsed_time>(
|
||||
option::ShowElapsedTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::show_remaining_time>(
|
||||
option::ShowRemainingTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::spinner_show>(
|
||||
option::ShowSpinner{true}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::saved_start_time>(
|
||||
option::SavedStartTime{false}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::completed>(option::Completed{false},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_postfix_text_len>(
|
||||
option::MaxPostfixTextLen{0}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::spinner_states>(
|
||||
option::SpinnerStates{std::vector<std::string>{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴",
|
||||
"⠦", "⠧", "⠇", "⠏"}},
|
||||
std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::font_styles>(
|
||||
option::FontStyles{std::vector<FontStyle>{}}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::max_progress>(
|
||||
option::MaxProgress{100}, std::forward<Args>(args)...),
|
||||
details::get<details::ProgressBarOption::stream>(
|
||||
option::Stream{std::cout}, std::forward<Args>(args)...)) {}
|
||||
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(details::Setting<T, id> &&setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = std::move(setting).value;
|
||||
}
|
||||
|
||||
void set_prefix_text(const std::string &text) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_prefix_text = text;
|
||||
template <typename T, details::ProgressBarOption id>
|
||||
void set_option(const details::Setting<T, id> &setting) {
|
||||
static_assert(!std::is_same<T, typename std::decay<decltype(details::get_value<id>(
|
||||
std::declval<Settings>()))>::type>::value,
|
||||
"Setting has wrong type!");
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<id>() = setting.value;
|
||||
}
|
||||
|
||||
void set_postfix_text(const std::string &text) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_postfix_text = text;
|
||||
if (_postfix_text.length() > _max_postfix_text_length)
|
||||
_max_postfix_text_length = _postfix_text.length();
|
||||
}
|
||||
|
||||
void show_percentage() { _show_percentage = true; }
|
||||
|
||||
void hide_percentage() { _show_percentage = false; }
|
||||
|
||||
void show_elapsed_time() { _show_elapsed_time = true; }
|
||||
|
||||
void hide_elapsed_time() { _show_elapsed_time = false; }
|
||||
|
||||
void show_remaining_time() { _show_remaining_time = true; }
|
||||
|
||||
void hide_remaining_time() { _show_remaining_time = false; }
|
||||
|
||||
void show_spinner() { _show_spinner = true; }
|
||||
|
||||
void hide_spinner() { _show_spinner = false; }
|
||||
|
||||
void set_progress(float value) {
|
||||
{
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_progress = value;
|
||||
void set_option(
|
||||
const details::Setting<std::string, details::ProgressBarOption::postfix_text> &setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = setting.value;
|
||||
if (setting.value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = setting.value.length();
|
||||
}
|
||||
_save_start_time();
|
||||
_print_progress();
|
||||
}
|
||||
|
||||
void
|
||||
set_option(details::Setting<std::string, details::ProgressBarOption::postfix_text> &&setting) {
|
||||
std::lock_guard<std::mutex> lock(mutex_);
|
||||
get_value<details::ProgressBarOption::postfix_text>() = std::move(setting).value;
|
||||
auto &new_value = get_value<details::ProgressBarOption::postfix_text>();
|
||||
if (new_value.length() > get_value<details::ProgressBarOption::max_postfix_text_len>()) {
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = new_value.length();
|
||||
}
|
||||
}
|
||||
|
||||
void set_progress(size_t value) {
|
||||
{
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
progress_ = value;
|
||||
}
|
||||
save_start_time();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
void tick() {
|
||||
{
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_progress += 1;
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
progress_ += 1;
|
||||
}
|
||||
_save_start_time();
|
||||
_print_progress();
|
||||
save_start_time();
|
||||
print_progress();
|
||||
}
|
||||
|
||||
size_t current() {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
return std::min(static_cast<size_t>(_progress), size_t(100));
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
return std::min(progress_, size_t(get_value<details::ProgressBarOption::max_progress>()));
|
||||
}
|
||||
|
||||
bool is_completed() const { return _completed; }
|
||||
bool is_completed() const { return get_value<details::ProgressBarOption::completed>(); }
|
||||
|
||||
void mark_as_completed() {
|
||||
_completed = true;
|
||||
_print_progress();
|
||||
}
|
||||
|
||||
void set_spinner_states(const std::vector<std::string> &states) {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
_states = states;
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
print_progress();
|
||||
}
|
||||
|
||||
private:
|
||||
float _progress{0.0};
|
||||
std::string _prefix_text{""};
|
||||
size_t _index{0};
|
||||
std::vector<std::string> _states{"⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"};
|
||||
std::string _postfix_text{""};
|
||||
std::atomic<size_t> _max_postfix_text_length{0};
|
||||
std::atomic<bool> _completed{false};
|
||||
std::atomic<bool> _show_percentage{true};
|
||||
std::atomic<bool> _show_elapsed_time{false};
|
||||
std::atomic<bool> _show_remaining_time{false};
|
||||
std::atomic<bool> _saved_start_time{false};
|
||||
std::chrono::time_point<std::chrono::high_resolution_clock> _start_time_point;
|
||||
std::atomic<bool> _show_spinner{true};
|
||||
std::mutex _mutex;
|
||||
Color _foreground_color;
|
||||
Settings settings_;
|
||||
size_t progress_{0};
|
||||
size_t index_{0};
|
||||
std::chrono::time_point<std::chrono::high_resolution_clock> start_time_point_;
|
||||
std::mutex mutex_;
|
||||
|
||||
std::ostream &_print_duration(std::ostream &os, std::chrono::nanoseconds ns) {
|
||||
using namespace std;
|
||||
using namespace std::chrono;
|
||||
typedef duration<int, ratio<86400>> days;
|
||||
char fill = os.fill();
|
||||
os.fill('0');
|
||||
auto d = duration_cast<days>(ns);
|
||||
ns -= d;
|
||||
auto h = duration_cast<hours>(ns);
|
||||
ns -= h;
|
||||
auto m = duration_cast<minutes>(ns);
|
||||
ns -= m;
|
||||
auto s = duration_cast<seconds>(ns);
|
||||
if (d.count() > 0)
|
||||
os << setw(2) << d.count() << "d:";
|
||||
if (h.count() > 0)
|
||||
os << setw(2) << h.count() << "h:";
|
||||
os << setw(2) << m.count() << "m:" << setw(2) << s.count() << 's';
|
||||
os.fill(fill);
|
||||
return os;
|
||||
};
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() -> decltype((details::get_value<id>(std::declval<Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
void _save_start_time() {
|
||||
if ((_show_elapsed_time || _show_remaining_time) && !_saved_start_time) {
|
||||
_start_time_point = std::chrono::high_resolution_clock::now();
|
||||
_saved_start_time = true;
|
||||
template <details::ProgressBarOption id>
|
||||
auto get_value() const
|
||||
-> decltype((details::get_value<id>(std::declval<const Settings &>()).value)) {
|
||||
return details::get_value<id>(settings_).value;
|
||||
}
|
||||
|
||||
void save_start_time() {
|
||||
auto &show_elapsed_time = get_value<details::ProgressBarOption::show_elapsed_time>();
|
||||
auto &show_remaining_time = get_value<details::ProgressBarOption::show_remaining_time>();
|
||||
auto &saved_start_time = get_value<details::ProgressBarOption::saved_start_time>();
|
||||
if ((show_elapsed_time || show_remaining_time) && !saved_start_time) {
|
||||
start_time_point_ = std::chrono::high_resolution_clock::now();
|
||||
saved_start_time = true;
|
||||
}
|
||||
}
|
||||
|
||||
void _print_progress() {
|
||||
std::unique_lock<std::mutex> lock{_mutex};
|
||||
public:
|
||||
void print_progress() {
|
||||
std::lock_guard<std::mutex> lock{mutex_};
|
||||
|
||||
auto& os = get_value<details::ProgressBarOption::stream>();
|
||||
|
||||
const auto max_progress = get_value<details::ProgressBarOption::max_progress>();
|
||||
auto now = std::chrono::high_resolution_clock::now();
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::nanoseconds>(now - _start_time_point);
|
||||
auto elapsed = std::chrono::duration_cast<std::chrono::nanoseconds>(now - start_time_point_);
|
||||
|
||||
std::cout << termcolor::bold;
|
||||
switch (_foreground_color) {
|
||||
case Color::GREY:
|
||||
std::cout << termcolor::grey;
|
||||
break;
|
||||
case Color::RED:
|
||||
std::cout << termcolor::red;
|
||||
break;
|
||||
case Color::GREEN:
|
||||
std::cout << termcolor::green;
|
||||
break;
|
||||
case Color::YELLOW:
|
||||
std::cout << termcolor::yellow;
|
||||
break;
|
||||
case Color::BLUE:
|
||||
std::cout << termcolor::blue;
|
||||
break;
|
||||
case Color::MAGENTA:
|
||||
std::cout << termcolor::magenta;
|
||||
break;
|
||||
case Color::CYAN:
|
||||
std::cout << termcolor::cyan;
|
||||
break;
|
||||
case Color::WHITE:
|
||||
std::cout << termcolor::white;
|
||||
break;
|
||||
}
|
||||
std::cout << _prefix_text;
|
||||
if (_show_spinner)
|
||||
std::cout << _states[_index % _states.size()];
|
||||
if (_show_percentage) {
|
||||
std::cout << " " << std::min(static_cast<size_t>(_progress), size_t(100)) << "%";
|
||||
if (get_value<details::ProgressBarOption::foreground_color>() != Color::unspecified)
|
||||
details::set_stream_color(os, get_value<details::ProgressBarOption::foreground_color>());
|
||||
|
||||
for (auto &style : get_value<details::ProgressBarOption::font_styles>())
|
||||
details::set_font_style(os, style);
|
||||
|
||||
os << get_value<details::ProgressBarOption::prefix_text>();
|
||||
if (get_value<details::ProgressBarOption::spinner_show>())
|
||||
os << get_value<details::ProgressBarOption::spinner_states>()
|
||||
[index_ % get_value<details::ProgressBarOption::spinner_states>().size()];
|
||||
if (get_value<details::ProgressBarOption::show_percentage>()) {
|
||||
os << " " << std::min(progress_, size_t(max_progress)) << "%";
|
||||
}
|
||||
|
||||
if (_show_elapsed_time) {
|
||||
std::cout << " [";
|
||||
_print_duration(std::cout, elapsed);
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>()) {
|
||||
os << " [";
|
||||
details::write_duration(os, elapsed);
|
||||
}
|
||||
|
||||
if (_show_remaining_time) {
|
||||
if (_show_elapsed_time)
|
||||
std::cout << "<";
|
||||
if (get_value<details::ProgressBarOption::show_remaining_time>()) {
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
||||
os << "<";
|
||||
else
|
||||
std::cout << " [";
|
||||
os << " [";
|
||||
auto eta = std::chrono::nanoseconds(
|
||||
_progress > 0 ? static_cast<long long>(elapsed.count() * 100 / _progress) : 0);
|
||||
progress_ > 0 ? static_cast<long long>(elapsed.count() * max_progress / progress_) : 0);
|
||||
auto remaining = eta > elapsed ? (eta - elapsed) : (elapsed - eta);
|
||||
_print_duration(std::cout, remaining);
|
||||
std::cout << "]";
|
||||
details::write_duration(os, remaining);
|
||||
os << "]";
|
||||
} else {
|
||||
if (_show_elapsed_time)
|
||||
std::cout << "]";
|
||||
if (get_value<details::ProgressBarOption::show_elapsed_time>())
|
||||
os << "]";
|
||||
}
|
||||
|
||||
if (_max_postfix_text_length == 0)
|
||||
_max_postfix_text_length = 10;
|
||||
std::cout << " " << _postfix_text << std::string(_max_postfix_text_length, ' ') << "\r";
|
||||
std::cout.flush();
|
||||
_index += 1;
|
||||
if (_progress > 100.0) {
|
||||
_completed = true;
|
||||
if (get_value<details::ProgressBarOption::max_postfix_text_len>() == 0)
|
||||
get_value<details::ProgressBarOption::max_postfix_text_len>() = 10;
|
||||
os << " " << get_value<details::ProgressBarOption::postfix_text>()
|
||||
<< std::string(get_value<details::ProgressBarOption::max_postfix_text_len>(), ' ')
|
||||
<< "\r";
|
||||
os.flush();
|
||||
index_ += 1;
|
||||
if (progress_ > max_progress) {
|
||||
get_value<details::ProgressBarOption::completed>() = true;
|
||||
}
|
||||
if (_completed)
|
||||
std::cout << termcolor::reset << std::endl;
|
||||
if (get_value<details::ProgressBarOption::completed>())
|
||||
os << termcolor::reset << std::endl;
|
||||
}
|
||||
};
|
||||
|
||||
|
||||
212
include/indicators/setting.hpp
Normal file
212
include/indicators/setting.hpp
Normal file
@@ -0,0 +1,212 @@
|
||||
/*
|
||||
Activity Indicators for Modern C++
|
||||
https://github.com/p-ranav/indicators
|
||||
|
||||
Licensed under the MIT License <http://opensource.org/licenses/MIT>.
|
||||
SPDX-License-Identifier: MIT
|
||||
Copyright (c) 2019 Dawid Pilarski <dawid.pilarski@panicsoftware.com>.
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
*/
|
||||
#pragma once
|
||||
|
||||
#include <cstddef>
|
||||
#include <indicators/color.hpp>
|
||||
#include <indicators/font_style.hpp>
|
||||
#include <string>
|
||||
#include <type_traits>
|
||||
#include <utility>
|
||||
#include <vector>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
namespace details {
|
||||
|
||||
template <bool condition> struct if_else;
|
||||
|
||||
template <> struct if_else<true> { using type = std::true_type; };
|
||||
|
||||
template <> struct if_else<false> { using type = std::false_type; };
|
||||
|
||||
template <bool condition, typename True, typename False> struct if_else_type;
|
||||
|
||||
template <typename True, typename False> struct if_else_type<true, True, False> {
|
||||
using type = True;
|
||||
};
|
||||
|
||||
template <typename True, typename False> struct if_else_type<false, True, False> {
|
||||
using type = False;
|
||||
};
|
||||
|
||||
template <typename... Ops> struct conjuction;
|
||||
|
||||
template <> struct conjuction<> : std::true_type {};
|
||||
|
||||
template <typename Op, typename... TailOps>
|
||||
struct conjuction<Op, TailOps...>
|
||||
: if_else_type<!Op::value, std::false_type, conjuction<TailOps...>>::type {};
|
||||
|
||||
template <typename... Ops> struct disjunction;
|
||||
|
||||
template <> struct disjunction<> : std::false_type {};
|
||||
|
||||
template <typename Op, typename... TailOps>
|
||||
struct disjunction<Op, TailOps...>
|
||||
: if_else_type<Op::value, std::true_type, disjunction<TailOps...>>::type {};
|
||||
|
||||
enum class ProgressBarOption {
|
||||
bar_width = 0,
|
||||
prefix_text,
|
||||
postfix_text,
|
||||
start,
|
||||
end,
|
||||
fill,
|
||||
lead,
|
||||
remainder,
|
||||
max_postfix_text_len,
|
||||
completed,
|
||||
show_percentage,
|
||||
show_elapsed_time,
|
||||
show_remaining_time,
|
||||
saved_start_time,
|
||||
foreground_color,
|
||||
spinner_show,
|
||||
spinner_states,
|
||||
font_styles,
|
||||
hide_bar_when_complete,
|
||||
max_progress,
|
||||
stream
|
||||
};
|
||||
|
||||
template <typename T, ProgressBarOption Id> struct Setting {
|
||||
template <typename... Args,
|
||||
typename = typename std::enable_if<std::is_constructible<T, Args...>::value>::type>
|
||||
explicit Setting(Args &&... args) : value(std::forward<Args>(args)...) {}
|
||||
Setting(const Setting &) = default;
|
||||
Setting(Setting &&) = default;
|
||||
|
||||
static constexpr auto id = Id;
|
||||
using type = T;
|
||||
|
||||
T value{};
|
||||
};
|
||||
|
||||
template <typename T> struct is_setting : std::false_type {};
|
||||
|
||||
template <ProgressBarOption Id, typename T> struct is_setting<Setting<T, Id>> : std::true_type {};
|
||||
|
||||
template <typename... Args>
|
||||
struct are_settings : if_else<conjuction<is_setting<Args>...>::value>::type {};
|
||||
|
||||
template <> struct are_settings<> : std::true_type {};
|
||||
|
||||
template <typename Setting, typename Tuple> struct is_setting_from_tuple;
|
||||
|
||||
template <typename Setting> struct is_setting_from_tuple<Setting, std::tuple<>> : std::true_type {};
|
||||
|
||||
template <typename Setting, typename... TupleTypes>
|
||||
struct is_setting_from_tuple<Setting, std::tuple<TupleTypes...>>
|
||||
: if_else<disjunction<std::is_same<Setting, TupleTypes>...>::value>::type {};
|
||||
|
||||
template <typename Tuple, typename... Settings>
|
||||
struct are_settings_from_tuple
|
||||
: if_else<conjuction<is_setting_from_tuple<Settings, Tuple>...>::value>::type {};
|
||||
|
||||
template <ProgressBarOption Id> struct always_true { static constexpr auto value = true; };
|
||||
|
||||
template <ProgressBarOption Id, typename Default> Default &&get_impl(Default &&def) {
|
||||
return std::forward<Default>(def);
|
||||
}
|
||||
|
||||
template <ProgressBarOption Id, typename Default, typename T, typename... Args>
|
||||
auto get_impl(Default &&/*def*/, T &&first, Args &&... /*tail*/) ->
|
||||
typename std::enable_if<(std::decay<T>::type::id == Id),
|
||||
decltype(std::forward<T>(first))>::type {
|
||||
return std::forward<T>(first);
|
||||
}
|
||||
|
||||
template <ProgressBarOption Id, typename Default, typename T, typename... Args>
|
||||
auto get_impl(Default &&def, T &&/*first*/, Args &&... tail) ->
|
||||
typename std::enable_if<(std::decay<T>::type::id != Id),
|
||||
decltype(get_impl<Id>(std::forward<Default>(def),
|
||||
std::forward<Args>(tail)...))>::type {
|
||||
return get_impl<Id>(std::forward<Default>(def), std::forward<Args>(tail)...);
|
||||
}
|
||||
|
||||
template <ProgressBarOption Id, typename Default, typename... Args,
|
||||
typename = typename std::enable_if<are_settings<Args...>::value, void>::type>
|
||||
auto get(Default &&def, Args &&... args)
|
||||
-> decltype(details::get_impl<Id>(std::forward<Default>(def), std::forward<Args>(args)...)) {
|
||||
return details::get_impl<Id>(std::forward<Default>(def), std::forward<Args>(args)...);
|
||||
}
|
||||
|
||||
template <ProgressBarOption Id> using StringSetting = Setting<std::string, Id>;
|
||||
|
||||
template <ProgressBarOption Id> using IntegerSetting = Setting<std::size_t, Id>;
|
||||
|
||||
template <ProgressBarOption Id> using BooleanSetting = Setting<bool, Id>;
|
||||
|
||||
template <ProgressBarOption Id, typename Tuple, std::size_t counter = 0> struct option_idx;
|
||||
|
||||
template <ProgressBarOption Id, typename T, typename... Settings, std::size_t counter>
|
||||
struct option_idx<Id, std::tuple<T, Settings...>, counter>
|
||||
: if_else_type<(Id == T::id), std::integral_constant<std::size_t, counter>,
|
||||
option_idx<Id, std::tuple<Settings...>, counter + 1>>::type {};
|
||||
|
||||
template <ProgressBarOption Id, std::size_t counter> struct option_idx<Id, std::tuple<>, counter> {
|
||||
static_assert(always_true<(ProgressBarOption)Id>::value, "No such option was found");
|
||||
};
|
||||
|
||||
template <ProgressBarOption Id, typename Settings>
|
||||
auto get_value(Settings &&settings)
|
||||
-> decltype((std::get<option_idx<Id, typename std::decay<Settings>::type>::value>(
|
||||
std::declval<Settings &&>()))) {
|
||||
return std::get<option_idx<Id, typename std::decay<Settings>::type>::value>(
|
||||
std::forward<Settings>(settings));
|
||||
}
|
||||
|
||||
} // namespace details
|
||||
|
||||
namespace option {
|
||||
using BarWidth = details::IntegerSetting<details::ProgressBarOption::bar_width>;
|
||||
using PrefixText = details::StringSetting<details::ProgressBarOption::prefix_text>;
|
||||
using PostfixText = details::StringSetting<details::ProgressBarOption::postfix_text>;
|
||||
using Start = details::StringSetting<details::ProgressBarOption::start>;
|
||||
using End = details::StringSetting<details::ProgressBarOption::end>;
|
||||
using Fill = details::StringSetting<details::ProgressBarOption::fill>;
|
||||
using Lead = details::StringSetting<details::ProgressBarOption::lead>;
|
||||
using Remainder = details::StringSetting<details::ProgressBarOption::remainder>;
|
||||
using MaxPostfixTextLen = details::IntegerSetting<details::ProgressBarOption::max_postfix_text_len>;
|
||||
using Completed = details::BooleanSetting<details::ProgressBarOption::completed>;
|
||||
using ShowPercentage = details::BooleanSetting<details::ProgressBarOption::show_percentage>;
|
||||
using ShowElapsedTime = details::BooleanSetting<details::ProgressBarOption::show_elapsed_time>;
|
||||
using ShowRemainingTime = details::BooleanSetting<details::ProgressBarOption::show_remaining_time>;
|
||||
using SavedStartTime = details::BooleanSetting<details::ProgressBarOption::saved_start_time>;
|
||||
using ForegroundColor = details::Setting<Color, details::ProgressBarOption::foreground_color>;
|
||||
using ShowSpinner = details::BooleanSetting<details::ProgressBarOption::spinner_show>;
|
||||
using SpinnerStates =
|
||||
details::Setting<std::vector<std::string>, details::ProgressBarOption::spinner_states>;
|
||||
using HideBarWhenComplete =
|
||||
details::BooleanSetting<details::ProgressBarOption::hide_bar_when_complete>;
|
||||
using FontStyles =
|
||||
details::Setting<std::vector<FontStyle>, details::ProgressBarOption::font_styles>;
|
||||
using MaxProgress = details::IntegerSetting<details::ProgressBarOption::max_progress>;
|
||||
using Stream = details::Setting<std::ostream&, details::ProgressBarOption::stream>;
|
||||
} // namespace option
|
||||
} // namespace indicators
|
||||
@@ -32,6 +32,9 @@
|
||||
#if defined(TERMCOLOR_OS_MACOS) || defined(TERMCOLOR_OS_LINUX)
|
||||
#include <unistd.h>
|
||||
#elif defined(TERMCOLOR_OS_WINDOWS)
|
||||
#if !defined(NOMINMAX)
|
||||
#define NOMINMAX
|
||||
#endif
|
||||
#include <io.h>
|
||||
#include <windows.h>
|
||||
#endif
|
||||
|
||||
37
include/indicators/terminal_size.hpp
Normal file
37
include/indicators/terminal_size.hpp
Normal file
@@ -0,0 +1,37 @@
|
||||
#pragma once
|
||||
#include <utility>
|
||||
|
||||
namespace indicators {
|
||||
|
||||
#if defined(_MSC_VER)
|
||||
#include <windows.h>
|
||||
|
||||
std::pair<size_t, size_t> terminal_size() {
|
||||
CONSOLE_SCREEN_BUFFER_INFO csbi;
|
||||
int columns, rows;
|
||||
GetConsoleScreenBufferInfo(GetStdHandle(STD_OUTPUT_HANDLE), &csbi);
|
||||
columns = csbi.srWindow.Right - csbi.srWindow.Left + 1;
|
||||
rows = csbi.srWindow.Bottom - csbi.srWindow.Top + 1;
|
||||
return {static_cast<size_t>(rows), static_cast<size_t>(cols)};
|
||||
}
|
||||
|
||||
size_t terminal_width() {
|
||||
return terminal_size().second;
|
||||
}
|
||||
|
||||
#else
|
||||
#include <sys/ioctl.h> //ioctl() and TIOCGWINSZ
|
||||
#include <unistd.h> // for STDOUT_FILENO
|
||||
|
||||
std::pair<size_t, size_t> terminal_size() {
|
||||
struct winsize size;
|
||||
ioctl(STDOUT_FILENO, TIOCGWINSZ, &size);
|
||||
return {static_cast<size_t>(size.ws_row), static_cast<size_t>(size.ws_col)};
|
||||
}
|
||||
|
||||
size_t terminal_width() {
|
||||
return terminal_size().second;
|
||||
}
|
||||
#endif
|
||||
|
||||
}
|
||||
@@ -1,9 +0,0 @@
|
||||
@PACKAGE_INIT@
|
||||
|
||||
include(CMakeFindDependencyMacro)
|
||||
|
||||
find_dependency(Threads)
|
||||
|
||||
if (NOT TARGET indica::indica)
|
||||
include(${CMAKE_CURRENT_LIST_DIR}/indicaTargets.cmake)
|
||||
endif ()
|
||||
7
indicators.pc.in
Normal file
7
indicators.pc.in
Normal file
@@ -0,0 +1,7 @@
|
||||
includedir=@CMAKE_INSTALL_FULL_INCLUDEDIR@
|
||||
|
||||
Name: @PROJECT_NAME@
|
||||
Description: @PROJECT_DESCRIPTION@
|
||||
URL: @PROJECT_HOMEPAGE_URL@
|
||||
Version: @PROJECT_VERSION@
|
||||
Cflags: -I${includedir}
|
||||
9
indicatorsConfig.cmake.in
Normal file
9
indicatorsConfig.cmake.in
Normal file
@@ -0,0 +1,9 @@
|
||||
@PACKAGE_INIT@
|
||||
|
||||
include(CMakeFindDependencyMacro)
|
||||
|
||||
find_dependency(Threads REQUIRED)
|
||||
|
||||
if (NOT TARGET indicators::indicators)
|
||||
include(${CMAKE_CURRENT_LIST_DIR}/indicatorsTargets.cmake)
|
||||
endif ()
|
||||
@@ -1,24 +1,40 @@
|
||||
|
||||
add_executable(block_progress_bar block_progress_bar.cpp)
|
||||
target_link_libraries(block_progress_bar PRIVATE indica::indica)
|
||||
target_link_libraries(block_progress_bar PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(block_progress_bar_iterable block_progress_bar_iterable.cpp)
|
||||
target_link_libraries(block_progress_bar_iterable PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(multi_threaded_bar multi_threaded_bar.cpp)
|
||||
target_link_libraries(multi_threaded_bar PRIVATE indica::indica)
|
||||
target_link_libraries(multi_threaded_bar PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(progress_bar_set_progress progress_bar_set_progress.cpp)
|
||||
target_link_libraries(progress_bar_set_progress PRIVATE indica::indica)
|
||||
target_link_libraries(progress_bar_set_progress PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(progress_bar_tick progress_bar_tick.cpp)
|
||||
target_link_libraries(progress_bar_tick PRIVATE indica::indica)
|
||||
target_link_libraries(progress_bar_tick PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(progress_bar_sstream progress_bar_sstream.cpp)
|
||||
target_link_libraries(progress_bar_sstream PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(progress_spinner progress_spinner.cpp)
|
||||
target_link_libraries(progress_spinner PRIVATE indica::indica)
|
||||
target_link_libraries(progress_spinner PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(time_meter time_meter.cpp)
|
||||
target_link_libraries(time_meter PRIVATE indica::indica)
|
||||
target_link_libraries(time_meter PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(multi_progress_bar multi_progress_bar.cpp)
|
||||
target_link_libraries(multi_progress_bar PRIVATE indica::indica)
|
||||
target_link_libraries(multi_progress_bar PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(multi_block_progress_bar multi_block_progress_bar.cpp)
|
||||
target_link_libraries(multi_block_progress_bar PRIVATE indica::indica)
|
||||
target_link_libraries(multi_block_progress_bar PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(dynamic_progress dynamic_progress.cpp)
|
||||
target_link_libraries(dynamic_progress PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(max_progress max_progress.cpp)
|
||||
target_link_libraries(max_progress PRIVATE indicators::indicators)
|
||||
|
||||
add_executable(indeterminate_progress_bar indeterminate_progress_bar.cpp)
|
||||
target_link_libraries(indeterminate_progress_bar PRIVATE indicators::indicators)
|
||||
|
||||
|
||||
@@ -1,19 +1,18 @@
|
||||
#include <chrono>
|
||||
#include <indicators/block_progress_bar.hpp>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
|
||||
// Hide cursor
|
||||
std::cout << "\e[?25l";
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
indicators::BlockProgressBar bar;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(80);
|
||||
bar.start_bar_with("[");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_foreground_color(indicators::Color::WHITE);
|
||||
indicators::BlockProgressBar bar{
|
||||
indicators::option::BarWidth{80},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
auto progress = 0.0f;
|
||||
@@ -26,7 +25,7 @@ int main() {
|
||||
}
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
50
samples/block_progress_bar_iterable.cpp
Normal file
50
samples/block_progress_bar_iterable.cpp
Normal file
@@ -0,0 +1,50 @@
|
||||
#include <chrono>
|
||||
#include <indicators/block_progress_bar.hpp>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
|
||||
// Hide cursor
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
// Random list of numbers
|
||||
std::vector<size_t> numbers;
|
||||
for (size_t i = 0; i < 1259438; ++i) {
|
||||
numbers.push_back(i);
|
||||
}
|
||||
|
||||
using namespace indicators;
|
||||
BlockProgressBar bar{
|
||||
option::BarWidth{80},
|
||||
option::ForegroundColor{Color::white},
|
||||
option::FontStyles{
|
||||
std::vector<FontStyle>{FontStyle::bold}},
|
||||
option::MaxProgress{numbers.size()}
|
||||
};
|
||||
|
||||
std::cout << "Iterating over a list of numbers (size = "
|
||||
<< numbers.size() << ")\n";
|
||||
|
||||
std::vector<size_t> result;
|
||||
for (size_t i = 0; i < numbers.size(); ++i) {
|
||||
|
||||
// Perform some computation
|
||||
result.push_back(numbers[i] * numbers[i]);
|
||||
|
||||
// Show iteration as postfix text
|
||||
bar.set_option(option::PostfixText{
|
||||
std::to_string(i) + "/" + std::to_string(numbers.size())
|
||||
});
|
||||
|
||||
// update progress bar
|
||||
bar.tick();
|
||||
}
|
||||
|
||||
bar.mark_as_completed();
|
||||
|
||||
// Show cursor
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
143
samples/dynamic_progress.cpp
Normal file
143
samples/dynamic_progress.cpp
Normal file
@@ -0,0 +1,143 @@
|
||||
#include <indicators/dynamic_progress.hpp>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
using namespace indicators;
|
||||
|
||||
int main() {
|
||||
|
||||
ProgressBar bar1{option::BarWidth{50}, option::ForegroundColor{Color::red},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"5c90d4a2d1a8: Downloading "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
ProgressBar bar2{option::BarWidth{50}, option::ForegroundColor{Color::yellow},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"22337bfd13a9: Downloading "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
ProgressBar bar3{option::BarWidth{50}, option::ForegroundColor{Color::green},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"10f26c680a34: Downloading "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
ProgressBar bar4{option::BarWidth{50}, option::ForegroundColor{Color::white},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"6364e0d7a283: Downloading "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
ProgressBar bar5{option::BarWidth{50}, option::ForegroundColor{Color::blue},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"ff1356ba118b: Downloading "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
ProgressBar bar6{option::BarWidth{50}, option::ForegroundColor{Color::cyan},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"5a17453338b4: Downloading "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
std::cout << termcolor::bold << termcolor::white << "Pulling image foo:bar/baz\n";
|
||||
|
||||
DynamicProgress<ProgressBar> bars(bar1, bar2, bar3);
|
||||
bars.set_option(option::HideBarWhenComplete{false});
|
||||
|
||||
std::thread fourth_job, fifth_job, sixth_job;
|
||||
|
||||
auto job4 = [&bars](size_t i) {
|
||||
while (true) {
|
||||
bars[i].tick();
|
||||
if (bars[i].is_completed()) {
|
||||
bars[i].set_option(option::PrefixText{"6364e0d7a283: Pull complete "});
|
||||
bars[i].mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(50));
|
||||
}
|
||||
};
|
||||
|
||||
auto job5 = [&bars](size_t i) {
|
||||
while (true) {
|
||||
bars[i].tick();
|
||||
if (bars[i].is_completed()) {
|
||||
bars[i].set_option(option::PrefixText{"ff1356ba118b: Pull complete "});
|
||||
bars[i].mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
}
|
||||
};
|
||||
|
||||
auto job6 = [&bars](size_t i) {
|
||||
while (true) {
|
||||
bars[i].tick();
|
||||
if (bars[i].is_completed()) {
|
||||
bars[i].set_option(option::PrefixText{"5a17453338b4: Pull complete "});
|
||||
bars[i].mark_as_completed();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(40));
|
||||
}
|
||||
};
|
||||
|
||||
auto job1 = [&bars, &bar6, &sixth_job, &job6]() {
|
||||
while (true) {
|
||||
bars[0].tick();
|
||||
if (bars[0].is_completed()) {
|
||||
bars[0].set_option(option::PrefixText{"5c90d4a2d1a8: Pull complete "});
|
||||
// bar1 is completed, adding bar6
|
||||
auto i = bars.push_back(bar6);
|
||||
sixth_job = std::thread(job6, i);
|
||||
sixth_job.join();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(140));
|
||||
}
|
||||
};
|
||||
|
||||
auto job2 = [&bars, &bar5, &fifth_job, &job5]() {
|
||||
while (true) {
|
||||
bars[1].tick();
|
||||
if (bars[1].is_completed()) {
|
||||
bars[1].set_option(option::PrefixText{"22337bfd13a9: Pull complete "});
|
||||
// bar2 is completed, adding bar5
|
||||
auto i = bars.push_back(bar5);
|
||||
fifth_job = std::thread(job5, i);
|
||||
fifth_job.join();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(25));
|
||||
}
|
||||
};
|
||||
|
||||
auto job3 = [&bars, &bar4, &fourth_job, &job4]() {
|
||||
while (true) {
|
||||
bars[2].tick();
|
||||
if (bars[2].is_completed()) {
|
||||
bars[2].set_option(option::PrefixText{"10f26c680a34: Pull complete "});
|
||||
// bar3 is completed, adding bar4
|
||||
auto i = bars.push_back(bar4);
|
||||
fourth_job = std::thread(job4, i);
|
||||
fourth_job.join();
|
||||
break;
|
||||
}
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(50));
|
||||
}
|
||||
};
|
||||
|
||||
std::thread first_job(job1);
|
||||
std::thread second_job(job2);
|
||||
std::thread third_job(job3);
|
||||
|
||||
third_job.join();
|
||||
second_job.join();
|
||||
first_job.join();
|
||||
|
||||
std::cout << termcolor::bold << termcolor::green << "✔ Downloaded image foo/bar:baz" << std::endl;
|
||||
std::cout << termcolor::reset;
|
||||
|
||||
return 0;
|
||||
}
|
||||
40
samples/indeterminate_progress_bar.cpp
Normal file
40
samples/indeterminate_progress_bar.cpp
Normal file
@@ -0,0 +1,40 @@
|
||||
#include <chrono>
|
||||
#include <indicators/indeterminate_progress_bar.hpp>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/termcolor.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
indicators::IndeterminateProgressBar bar{
|
||||
indicators::option::BarWidth{40},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"·"},
|
||||
indicators::option::Lead{"<==>"},
|
||||
indicators::option::End{"]"},
|
||||
indicators::option::PostfixText{"Checking for Updates"},
|
||||
indicators::option::ForegroundColor{indicators::Color::yellow},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
auto job = [&bar]() {
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(10000));
|
||||
bar.mark_as_completed();
|
||||
std::cout << termcolor::bold << termcolor::green
|
||||
<< "System is up to date!\n" << termcolor::reset;
|
||||
};
|
||||
std::thread job_completion_thread(job);
|
||||
|
||||
// Update bar state
|
||||
while (!bar.is_completed()) {
|
||||
bar.tick();
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
}
|
||||
|
||||
job_completion_thread.join();
|
||||
|
||||
indicators::show_console_cursor(true);
|
||||
return 0;
|
||||
}
|
||||
30
samples/max_progress.cpp
Normal file
30
samples/max_progress.cpp
Normal file
@@ -0,0 +1,30 @@
|
||||
#include <chrono>
|
||||
#include <indicators/block_progress_bar.hpp>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
|
||||
// Hide cursor
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
indicators::BlockProgressBar bar{
|
||||
indicators::option::BarWidth{80},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}},
|
||||
indicators::option::MaxProgress{400}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
while (true) {
|
||||
bar.tick();
|
||||
if (bar.is_completed())
|
||||
break;
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(50));
|
||||
}
|
||||
|
||||
// Show cursor
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
@@ -2,27 +2,24 @@
|
||||
#include <indicators/multi_progress.hpp>
|
||||
|
||||
int main() {
|
||||
using namespace indicators;
|
||||
BlockProgressBar bar1{option::BarWidth{50}, option::ForegroundColor{Color::yellow},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"Progress Bar #1 "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
indicators::BlockProgressBar bar1;
|
||||
bar1.set_bar_width(50);
|
||||
bar1.set_foreground_color(indicators::Color::YELLOW);
|
||||
bar1.show_elapsed_time();
|
||||
bar1.show_remaining_time();
|
||||
bar1.set_prefix_text("Progress Bar #1 ");
|
||||
BlockProgressBar bar2{option::BarWidth{50}, option::ForegroundColor{Color::cyan},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"Progress Bar #2 "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
indicators::BlockProgressBar bar2;
|
||||
bar2.set_bar_width(50);
|
||||
bar2.set_foreground_color(indicators::Color::CYAN);
|
||||
bar2.show_elapsed_time();
|
||||
bar2.show_remaining_time();
|
||||
bar2.set_prefix_text("Progress Bar #2 ");
|
||||
|
||||
indicators::BlockProgressBar bar3;
|
||||
bar3.set_bar_width(50);
|
||||
bar3.set_foreground_color(indicators::Color::RED);
|
||||
bar3.show_elapsed_time();
|
||||
bar3.show_remaining_time();
|
||||
bar3.set_prefix_text("Progress Bar #3 ");
|
||||
BlockProgressBar bar3{option::BarWidth{50}, option::ForegroundColor{Color::red},
|
||||
option::ShowElapsedTime{true}, option::ShowRemainingTime{true},
|
||||
option::PrefixText{"Progress Bar #3 "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
indicators::MultiProgress<indicators::BlockProgressBar, 3> bars(bar1, bar2, bar3);
|
||||
|
||||
|
||||
@@ -3,41 +3,44 @@
|
||||
|
||||
int main() {
|
||||
|
||||
indicators::ProgressBar bar1;
|
||||
bar1.set_bar_width(50);
|
||||
bar1.start_bar_with("[");
|
||||
bar1.fill_bar_progress_with("■");
|
||||
bar1.lead_bar_progress_with("■");
|
||||
bar1.fill_bar_remainder_with(" ");
|
||||
bar1.end_bar_with(" ]");
|
||||
bar1.set_foreground_color(indicators::Color::YELLOW);
|
||||
bar1.show_elapsed_time();
|
||||
bar1.show_remaining_time();
|
||||
bar1.set_prefix_text("Progress Bar #1 ");
|
||||
indicators::ProgressBar bar1{indicators::option::BarWidth{50},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"■"},
|
||||
indicators::option::Lead{"■"},
|
||||
indicators::option::Remainder{" "},
|
||||
indicators::option::End{" ]"},
|
||||
indicators::option::ForegroundColor{indicators::Color::yellow},
|
||||
indicators::option::ShowElapsedTime{true},
|
||||
indicators::option::ShowRemainingTime{true},
|
||||
indicators::option::PrefixText{"Progress Bar #1 "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
indicators::ProgressBar bar2;
|
||||
bar2.set_bar_width(50);
|
||||
bar2.start_bar_with("[");
|
||||
bar2.fill_bar_progress_with("=");
|
||||
bar2.lead_bar_progress_with(">");
|
||||
bar2.fill_bar_remainder_with(" ");
|
||||
bar2.end_bar_with(" ]");
|
||||
bar2.set_foreground_color(indicators::Color::CYAN);
|
||||
bar2.show_elapsed_time();
|
||||
bar2.show_remaining_time();
|
||||
bar2.set_prefix_text("Progress Bar #2 ");
|
||||
indicators::ProgressBar bar2{indicators::option::BarWidth{50},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"="},
|
||||
indicators::option::Lead{">"},
|
||||
indicators::option::Remainder{" "},
|
||||
indicators::option::End{" ]"},
|
||||
indicators::option::ForegroundColor{indicators::Color::cyan},
|
||||
indicators::option::ShowElapsedTime{true},
|
||||
indicators::option::ShowRemainingTime{true},
|
||||
indicators::option::PrefixText{"Progress Bar #2 "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
indicators::ProgressBar bar3;
|
||||
bar3.set_bar_width(50);
|
||||
bar3.start_bar_with("[");
|
||||
bar3.fill_bar_progress_with("#");
|
||||
bar3.lead_bar_progress_with("#");
|
||||
bar3.fill_bar_remainder_with(" ");
|
||||
bar3.end_bar_with(" ]");
|
||||
bar3.set_foreground_color(indicators::Color::RED);
|
||||
bar3.show_elapsed_time();
|
||||
bar3.show_remaining_time();
|
||||
bar3.set_prefix_text("Progress Bar #3 ");
|
||||
indicators::ProgressBar bar3{indicators::option::BarWidth{50},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"#"},
|
||||
indicators::option::Lead{"#"},
|
||||
indicators::option::Remainder{" "},
|
||||
indicators::option::End{" ]"},
|
||||
indicators::option::ForegroundColor{indicators::Color::red},
|
||||
indicators::option::ShowElapsedTime{true},
|
||||
indicators::option::ShowRemainingTime{true},
|
||||
indicators::option::PrefixText{"Progress Bar #3 "},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}};
|
||||
|
||||
indicators::MultiProgress<indicators::ProgressBar, 3> bars(bar1, bar2, bar3);
|
||||
|
||||
|
||||
@@ -3,14 +3,17 @@
|
||||
|
||||
int main() {
|
||||
|
||||
indicators::ProgressBar bar;
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with("[");
|
||||
bar.fill_bar_progress_with("■");
|
||||
bar.lead_bar_progress_with("■");
|
||||
bar.fill_bar_remainder_with("-");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_foreground_color(indicators::Color::YELLOW);
|
||||
indicators::ProgressBar bar{
|
||||
indicators::option::BarWidth{50},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"■"},
|
||||
indicators::option::Lead{"■"},
|
||||
indicators::option::Remainder{"-"},
|
||||
indicators::option::End{" ]"},
|
||||
indicators::option::ForegroundColor{indicators::Color::yellow},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
// As configured, the bar will look like this:
|
||||
//
|
||||
@@ -39,7 +42,7 @@ int main() {
|
||||
if (bar.is_completed()) {
|
||||
break;
|
||||
}
|
||||
bar.set_postfix_text(status_text[index % status_text.size()]);
|
||||
bar.set_option(indicators::option::PostfixText{status_text[index % status_text.size()]});
|
||||
bar.tick();
|
||||
index += 1;
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(200));
|
||||
|
||||
@@ -1,23 +1,25 @@
|
||||
#include <chrono>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
|
||||
// Hide cursor
|
||||
std::cout << "\e[?25l";
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
indicators::ProgressBar bar;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with("[");
|
||||
bar.fill_bar_progress_with("■");
|
||||
bar.lead_bar_progress_with("■");
|
||||
bar.fill_bar_remainder_with("-");
|
||||
bar.end_bar_with(" ]");
|
||||
bar.set_postfix_text("Loading dependency 1/4");
|
||||
bar.set_foreground_color(indicators::Color::CYAN);
|
||||
indicators::ProgressBar bar{
|
||||
indicators::option::BarWidth{50},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"■"},
|
||||
indicators::option::Lead{"■"},
|
||||
indicators::option::Remainder{"-"},
|
||||
indicators::option::End{" ]"},
|
||||
indicators::option::PostfixText{"Loading dependency 1/4"},
|
||||
indicators::option::ForegroundColor{indicators::Color::cyan},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
bar.set_progress(10); // 10% done
|
||||
@@ -25,28 +27,26 @@ int main() {
|
||||
// do some work
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(800));
|
||||
|
||||
bar.set_postfix_text("Loading dependency 2/4");
|
||||
bar.set_option(indicators::option::PostfixText{"Loading dependency 2/4"});
|
||||
|
||||
bar.set_progress(30); // 30% done
|
||||
|
||||
// do some more work
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(700));
|
||||
|
||||
bar.set_postfix_text("Loading dependency 3/4");
|
||||
bar.set_option(indicators::option::PostfixText{"Loading dependency 3/4"});
|
||||
|
||||
bar.set_progress(65); // 65% done
|
||||
|
||||
// do final bit of work
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(900));
|
||||
|
||||
bar.set_postfix_text("Loaded dependencies!");
|
||||
bar.set_option(indicators::option::PostfixText{"Loaded dependencies!"});
|
||||
|
||||
bar.set_progress(100); // all done
|
||||
|
||||
bar.mark_as_completed();
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
37
samples/progress_bar_sstream.cpp
Normal file
37
samples/progress_bar_sstream.cpp
Normal file
@@ -0,0 +1,37 @@
|
||||
#include <chrono>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
#include <thread>
|
||||
#include <sstream>
|
||||
|
||||
int main() {
|
||||
using namespace indicators;
|
||||
|
||||
std::stringstream os;
|
||||
|
||||
ProgressBar bar{
|
||||
option::BarWidth{50},
|
||||
option::Start{"["},
|
||||
option::Fill{"="},
|
||||
option::Lead{">"},
|
||||
option::Remainder{" "},
|
||||
option::End{"]"},
|
||||
option::PostfixText{"Getting started"},
|
||||
option::ForegroundColor{indicators::Color::green},
|
||||
option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}},
|
||||
option::Stream{os}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
while (true) {
|
||||
bar.tick();
|
||||
if (bar.is_completed())
|
||||
break;
|
||||
std::this_thread::sleep_for(std::chrono::milliseconds(100));
|
||||
}
|
||||
|
||||
std::cout << "Stream contents:\n";
|
||||
std::cout << os.str() << "\n";
|
||||
|
||||
return 0;
|
||||
}
|
||||
@@ -3,17 +3,18 @@
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
indicators::ProgressBar bar;
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with("[");
|
||||
bar.fill_bar_progress_with("=");
|
||||
bar.lead_bar_progress_with(">");
|
||||
bar.fill_bar_remainder_with(" ");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_postfix_text("Getting started");
|
||||
bar.set_foreground_color(indicators::Color::GREEN);
|
||||
indicators::ProgressBar bar{
|
||||
indicators::option::BarWidth{50},
|
||||
indicators::option::Start{"["},
|
||||
indicators::option::Fill{"="},
|
||||
indicators::option::Lead{">"},
|
||||
indicators::option::Remainder{" "},
|
||||
indicators::option::End{" ]"},
|
||||
indicators::option::PostfixText{"Getting started"},
|
||||
indicators::option::ForegroundColor{indicators::Color::green},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
while (true) {
|
||||
|
||||
@@ -1,26 +1,29 @@
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/progress_spinner.hpp>
|
||||
|
||||
int main() {
|
||||
|
||||
// Hide cursor
|
||||
std::cout << "\e[?25l";
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
indicators::ProgressSpinner spinner;
|
||||
|
||||
// Configure the spinner
|
||||
spinner.set_postfix_text("Checking credentials");
|
||||
spinner.set_foreground_color(indicators::Color::YELLOW);
|
||||
spinner.set_spinner_states({"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"});
|
||||
indicators::ProgressSpinner spinner{
|
||||
indicators::option::PostfixText{"Checking credentials"},
|
||||
indicators::option::ForegroundColor{indicators::Color::yellow},
|
||||
indicators::option::SpinnerStates{
|
||||
std::vector<std::string>{"⠈", "⠐", "⠠", "⢀", "⡀", "⠄", "⠂", "⠁"}},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update spinner state
|
||||
auto job = [&spinner]() {
|
||||
while (true) {
|
||||
if (spinner.is_completed()) {
|
||||
spinner.set_foreground_color(indicators::Color::GREEN);
|
||||
spinner.set_prefix_text("✔");
|
||||
spinner.hide_spinner();
|
||||
spinner.hide_percentage();
|
||||
spinner.set_postfix_text("Authenticated!");
|
||||
spinner.set_option(indicators::option::ForegroundColor{indicators::Color::green});
|
||||
spinner.set_option(indicators::option::PrefixText{"✔"});
|
||||
spinner.set_option(indicators::option::ShowSpinner{false});
|
||||
spinner.set_option(indicators::option::ShowPercentage{false});
|
||||
spinner.set_option(indicators::option::PostfixText{"Authenticated!"});
|
||||
spinner.mark_as_completed();
|
||||
break;
|
||||
} else
|
||||
@@ -32,7 +35,7 @@ int main() {
|
||||
thread.join();
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
@@ -1,23 +1,26 @@
|
||||
#include <chrono>
|
||||
#include <indicators/cursor_control.hpp>
|
||||
#include <indicators/progress_bar.hpp>
|
||||
#include <thread>
|
||||
|
||||
int main() {
|
||||
indicators::ProgressBar bar;
|
||||
// Hide cursor
|
||||
indicators::show_console_cursor(false);
|
||||
|
||||
// Configure the bar
|
||||
bar.set_bar_width(50);
|
||||
bar.start_bar_with(" [");
|
||||
bar.fill_bar_progress_with("█");
|
||||
bar.lead_bar_progress_with("█");
|
||||
bar.fill_bar_remainder_with("-");
|
||||
bar.end_bar_with("]");
|
||||
bar.set_prefix_text("Training Gaze Network 👀");
|
||||
bar.set_foreground_color(indicators::Color::YELLOW);
|
||||
|
||||
// Show time elapsed and remaining
|
||||
bar.show_elapsed_time();
|
||||
bar.show_remaining_time();
|
||||
indicators::ProgressBar bar{
|
||||
indicators::option::BarWidth{50},
|
||||
indicators::option::Start{" ["},
|
||||
indicators::option::Fill{"█"},
|
||||
indicators::option::Lead{"█"},
|
||||
indicators::option::Remainder{"-"},
|
||||
indicators::option::End{"]"},
|
||||
indicators::option::PrefixText{"Training Gaze Network 👀"},
|
||||
indicators::option::ForegroundColor{indicators::Color::yellow},
|
||||
indicators::option::ShowElapsedTime{true},
|
||||
indicators::option::ShowRemainingTime{true},
|
||||
indicators::option::FontStyles{
|
||||
std::vector<indicators::FontStyle>{indicators::FontStyle::bold}}
|
||||
};
|
||||
|
||||
// Update bar state
|
||||
while (true) {
|
||||
@@ -28,7 +31,7 @@ int main() {
|
||||
}
|
||||
|
||||
// Show cursor
|
||||
std::cout << "\e[?25h";
|
||||
indicators::show_console_cursor(true);
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
21
single_include.json
Normal file
21
single_include.json
Normal file
@@ -0,0 +1,21 @@
|
||||
{
|
||||
"project": "Activity Indicators for Modern C++",
|
||||
"target": "single_include/indicators/indicators.hpp",
|
||||
"sources": [
|
||||
"include/indicators/color.hpp",
|
||||
"include/indicators/font_style.hpp",
|
||||
"include/indicators/termcolor.hpp",
|
||||
"include/indicators/terminal_size.hpp",
|
||||
"include/indicators/setting.hpp",
|
||||
"include/indicators/cursor_control.hpp",
|
||||
"include/indicators/cursor_movement.hpp",
|
||||
"include/indicators/details/stream_helper.hpp",
|
||||
"include/indicators/progress_bar.hpp",
|
||||
"include/indicators/block_progress_bar.hpp",
|
||||
"include/indicators/indeterminate_progress_bar.hpp",
|
||||
"include/indicators/multi_progress.hpp",
|
||||
"include/indicators/dynamic_progress.hpp",
|
||||
"include/indicators/progress_spinner.hpp"
|
||||
],
|
||||
"include_paths": ["include"]
|
||||
}
|
||||
2537
single_include/indicators/indicators.hpp
Normal file
2537
single_include/indicators/indicators.hpp
Normal file
File diff suppressed because it is too large
Load Diff
10
utils/amalgamate/CHANGES.md
Normal file
10
utils/amalgamate/CHANGES.md
Normal file
@@ -0,0 +1,10 @@
|
||||
The following changes have been made to the code with respect to <https://github.com/edlund/amalgamate/commit/c91f07eea1133aa184f652b8f1398eaf03586208>:
|
||||
|
||||
- Resolved inspection results from PyCharm:
|
||||
- replaced tabs with spaces
|
||||
- added encoding annotation
|
||||
- reindented file to remove trailing whitespaces
|
||||
- unused import `sys`
|
||||
- membership check
|
||||
- made function from `_is_within`
|
||||
- removed unused variable `actual_path`
|
||||
27
utils/amalgamate/LICENSE.md
Normal file
27
utils/amalgamate/LICENSE.md
Normal file
@@ -0,0 +1,27 @@
|
||||
amalgamate.py - Amalgamate C source and header files
|
||||
Copyright (c) 2012, Erik Edlund <erik.edlund@32767.se>
|
||||
|
||||
Redistribution and use in source and binary forms, with or without modification,
|
||||
are permitted provided that the following conditions are met:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimer.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimer in the documentation
|
||||
and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the name of Erik Edlund, nor the names of its contributors may
|
||||
be used to endorse or promote products derived from this software without
|
||||
specific prior written permission.
|
||||
|
||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
66
utils/amalgamate/README.md
Normal file
66
utils/amalgamate/README.md
Normal file
@@ -0,0 +1,66 @@
|
||||
|
||||
# amalgamate.py - Amalgamate C source and header files
|
||||
|
||||
Origin: https://bitbucket.org/erikedlund/amalgamate
|
||||
|
||||
Mirror: https://github.com/edlund/amalgamate
|
||||
|
||||
`amalgamate.py` aims to make it easy to use SQLite-style C source and header
|
||||
amalgamation in projects.
|
||||
|
||||
For more information, please refer to: http://sqlite.org/amalgamation.html
|
||||
|
||||
## Here be dragons
|
||||
|
||||
`amalgamate.py` is quite dumb, it only knows the bare minimum about C code
|
||||
required in order to be able to handle trivial include directives. It can
|
||||
produce weird results for unexpected code.
|
||||
|
||||
Things to be aware of:
|
||||
|
||||
`amalgamate.py` will not handle complex include directives correctly:
|
||||
|
||||
#define HEADER_PATH "path/to/header.h"
|
||||
#include HEADER_PATH
|
||||
|
||||
In the above example, `path/to/header.h` will not be included in the
|
||||
amalgamation (HEADER_PATH is never expanded).
|
||||
|
||||
`amalgamate.py` makes the assumption that each source and header file which
|
||||
is not empty will end in a new-line character, which is not immediately
|
||||
preceded by a backslash character (see 5.1.1.2p1.2 of ISO C99).
|
||||
|
||||
`amalgamate.py` should be usable with C++ code, but raw string literals from
|
||||
C++11 will definitely cause problems:
|
||||
|
||||
R"delimiter(Terrible raw \ data " #include <sneaky.hpp>)delimiter"
|
||||
R"delimiter(Terrible raw \ data " escaping)delimiter"
|
||||
|
||||
In the examples above, `amalgamate.py` will stop parsing the raw string literal
|
||||
when it encounters the first quotation mark, which will produce unexpected
|
||||
results.
|
||||
|
||||
## Installing amalgamate.py
|
||||
|
||||
Python v.2.7.0 or higher is required.
|
||||
|
||||
`amalgamate.py` can be tested and installed using the following commands:
|
||||
|
||||
./test.sh && sudo -k cp ./amalgamate.py /usr/local/bin/
|
||||
|
||||
## Using amalgamate.py
|
||||
|
||||
amalgamate.py [-v] -c path/to/config.json -s path/to/source/dir \
|
||||
[-p path/to/prologue.(c|h)]
|
||||
|
||||
* The `-c, --config` option should specify the path to a JSON config file which
|
||||
lists the source files, include paths and where to write the resulting
|
||||
amalgamation. Have a look at `test/source.c.json` and `test/include.h.json`
|
||||
to see two examples.
|
||||
|
||||
* The `-s, --source` option should specify the path to the source directory.
|
||||
This is useful for supporting separate source and build directories.
|
||||
|
||||
* The `-p, --prologue` option should specify the path to a file which will be
|
||||
added to the beginning of the amalgamation. It is optional.
|
||||
|
||||
299
utils/amalgamate/amalgamate.py
Normal file
299
utils/amalgamate/amalgamate.py
Normal file
@@ -0,0 +1,299 @@
|
||||
#!/usr/bin/env python
|
||||
# coding=utf-8
|
||||
|
||||
# amalgamate.py - Amalgamate C source and header files.
|
||||
# Copyright (c) 2012, Erik Edlund <erik.edlund@32767.se>
|
||||
#
|
||||
# Redistribution and use in source and binary forms, with or without modification,
|
||||
# are permitted provided that the following conditions are met:
|
||||
#
|
||||
# * Redistributions of source code must retain the above copyright notice,
|
||||
# this list of conditions and the following disclaimer.
|
||||
#
|
||||
# * Redistributions in binary form must reproduce the above copyright notice,
|
||||
# this list of conditions and the following disclaimer in the documentation
|
||||
# and/or other materials provided with the distribution.
|
||||
#
|
||||
# * Neither the name of Erik Edlund, nor the names of its contributors may
|
||||
# be used to endorse or promote products derived from this software without
|
||||
# specific prior written permission.
|
||||
#
|
||||
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||||
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||||
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||||
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||||
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||||
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||||
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
|
||||
# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||||
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
from __future__ import division
|
||||
from __future__ import print_function
|
||||
from __future__ import unicode_literals
|
||||
|
||||
import argparse
|
||||
import datetime
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
|
||||
|
||||
class Amalgamation(object):
|
||||
|
||||
# Prepends self.source_path to file_path if needed.
|
||||
def actual_path(self, file_path):
|
||||
if not os.path.isabs(file_path):
|
||||
file_path = os.path.join(self.source_path, file_path)
|
||||
return file_path
|
||||
|
||||
# Search included file_path in self.include_paths and
|
||||
# in source_dir if specified.
|
||||
def find_included_file(self, file_path, source_dir):
|
||||
search_dirs = self.include_paths[:]
|
||||
if source_dir:
|
||||
search_dirs.insert(0, source_dir)
|
||||
|
||||
for search_dir in search_dirs:
|
||||
search_path = os.path.join(search_dir, file_path)
|
||||
if os.path.isfile(self.actual_path(search_path)):
|
||||
return search_path
|
||||
return None
|
||||
|
||||
def __init__(self, args):
|
||||
with open(args.config, 'r') as f:
|
||||
config = json.loads(f.read())
|
||||
for key in config:
|
||||
setattr(self, key, config[key])
|
||||
|
||||
self.verbose = args.verbose == "yes"
|
||||
self.prologue = args.prologue
|
||||
self.source_path = args.source_path
|
||||
self.included_files = []
|
||||
|
||||
# Generate the amalgamation and write it to the target file.
|
||||
def generate(self):
|
||||
amalgamation = ""
|
||||
|
||||
if self.prologue:
|
||||
with open(self.prologue, 'r') as f:
|
||||
amalgamation += datetime.datetime.now().strftime(f.read())
|
||||
|
||||
if self.verbose:
|
||||
print("Config:")
|
||||
print(" target = {0}".format(self.target))
|
||||
print(" working_dir = {0}".format(os.getcwd()))
|
||||
print(" include_paths = {0}".format(self.include_paths))
|
||||
print("Creating amalgamation:")
|
||||
for file_path in self.sources:
|
||||
# Do not check the include paths while processing the source
|
||||
# list, all given source paths must be correct.
|
||||
# actual_path = self.actual_path(file_path)
|
||||
print(" - processing \"{0}\"".format(file_path))
|
||||
t = TranslationUnit(file_path, self, True)
|
||||
amalgamation += t.content
|
||||
|
||||
with open(self.target, 'w') as f:
|
||||
f.write(amalgamation)
|
||||
|
||||
print("...done!\n")
|
||||
if self.verbose:
|
||||
print("Files processed: {0}".format(self.sources))
|
||||
print("Files included: {0}".format(self.included_files))
|
||||
print("")
|
||||
|
||||
|
||||
def _is_within(match, matches):
|
||||
for m in matches:
|
||||
if match.start() > m.start() and \
|
||||
match.end() < m.end():
|
||||
return True
|
||||
return False
|
||||
|
||||
|
||||
class TranslationUnit(object):
|
||||
# // C++ comment.
|
||||
cpp_comment_pattern = re.compile(r"//.*?\n")
|
||||
|
||||
# /* C comment. */
|
||||
c_comment_pattern = re.compile(r"/\*.*?\*/", re.S)
|
||||
|
||||
# "complex \"stri\\\ng\" value".
|
||||
string_pattern = re.compile("[^']" r'".*?(?<=[^\\])"', re.S)
|
||||
|
||||
# Handle simple include directives. Support for advanced
|
||||
# directives where macros and defines needs to expanded is
|
||||
# not a concern right now.
|
||||
include_pattern = re.compile(
|
||||
r'#\s*include\s+(<|")(?P<path>.*?)("|>)', re.S)
|
||||
|
||||
# #pragma once
|
||||
pragma_once_pattern = re.compile(r'#\s*pragma\s+once', re.S)
|
||||
|
||||
# Search for pattern in self.content, add the match to
|
||||
# contexts if found and update the index accordingly.
|
||||
def _search_content(self, index, pattern, contexts):
|
||||
match = pattern.search(self.content, index)
|
||||
if match:
|
||||
contexts.append(match)
|
||||
return match.end()
|
||||
return index + 2
|
||||
|
||||
# Return all the skippable contexts, i.e., comments and strings
|
||||
def _find_skippable_contexts(self):
|
||||
# Find contexts in the content in which a found include
|
||||
# directive should not be processed.
|
||||
skippable_contexts = []
|
||||
|
||||
# Walk through the content char by char, and try to grab
|
||||
# skippable contexts using regular expressions when found.
|
||||
i = 1
|
||||
content_len = len(self.content)
|
||||
while i < content_len:
|
||||
j = i - 1
|
||||
current = self.content[i]
|
||||
previous = self.content[j]
|
||||
|
||||
if current == '"':
|
||||
# String value.
|
||||
i = self._search_content(j, self.string_pattern,
|
||||
skippable_contexts)
|
||||
elif current == '*' and previous == '/':
|
||||
# C style comment.
|
||||
i = self._search_content(j, self.c_comment_pattern,
|
||||
skippable_contexts)
|
||||
elif current == '/' and previous == '/':
|
||||
# C++ style comment.
|
||||
i = self._search_content(j, self.cpp_comment_pattern,
|
||||
skippable_contexts)
|
||||
else:
|
||||
# Skip to the next char.
|
||||
i += 1
|
||||
|
||||
return skippable_contexts
|
||||
|
||||
# Returns True if the match is within list of other matches
|
||||
|
||||
# Removes pragma once from content
|
||||
def _process_pragma_once(self):
|
||||
content_len = len(self.content)
|
||||
if content_len < len("#include <x>"):
|
||||
return 0
|
||||
|
||||
# Find contexts in the content in which a found include
|
||||
# directive should not be processed.
|
||||
skippable_contexts = self._find_skippable_contexts()
|
||||
|
||||
pragmas = []
|
||||
pragma_once_match = self.pragma_once_pattern.search(self.content)
|
||||
while pragma_once_match:
|
||||
if not _is_within(pragma_once_match, skippable_contexts):
|
||||
pragmas.append(pragma_once_match)
|
||||
|
||||
pragma_once_match = self.pragma_once_pattern.search(self.content,
|
||||
pragma_once_match.end())
|
||||
|
||||
# Handle all collected pragma once directives.
|
||||
prev_end = 0
|
||||
tmp_content = ''
|
||||
for pragma_match in pragmas:
|
||||
tmp_content += self.content[prev_end:pragma_match.start()]
|
||||
prev_end = pragma_match.end()
|
||||
tmp_content += self.content[prev_end:]
|
||||
self.content = tmp_content
|
||||
|
||||
# Include all trivial #include directives into self.content.
|
||||
def _process_includes(self):
|
||||
content_len = len(self.content)
|
||||
if content_len < len("#include <x>"):
|
||||
return 0
|
||||
|
||||
# Find contexts in the content in which a found include
|
||||
# directive should not be processed.
|
||||
skippable_contexts = self._find_skippable_contexts()
|
||||
|
||||
# Search for include directives in the content, collect those
|
||||
# which should be included into the content.
|
||||
includes = []
|
||||
include_match = self.include_pattern.search(self.content)
|
||||
while include_match:
|
||||
if not _is_within(include_match, skippable_contexts):
|
||||
include_path = include_match.group("path")
|
||||
search_same_dir = include_match.group(1) == '"'
|
||||
found_included_path = self.amalgamation.find_included_file(
|
||||
include_path, self.file_dir if search_same_dir else None)
|
||||
if found_included_path:
|
||||
includes.append((include_match, found_included_path))
|
||||
|
||||
include_match = self.include_pattern.search(self.content,
|
||||
include_match.end())
|
||||
|
||||
# Handle all collected include directives.
|
||||
prev_end = 0
|
||||
tmp_content = ''
|
||||
for include in includes:
|
||||
include_match, found_included_path = include
|
||||
tmp_content += self.content[prev_end:include_match.start()]
|
||||
tmp_content += "// {0}".format(include_match.group(0))
|
||||
if found_included_path not in self.amalgamation.included_files:
|
||||
t = TranslationUnit(found_included_path, self.amalgamation, False)
|
||||
tmp_content += t.content
|
||||
prev_end = include_match.end()
|
||||
tmp_content += self.content[prev_end:]
|
||||
self.content = tmp_content
|
||||
|
||||
return len(includes)
|
||||
|
||||
# Make all content processing
|
||||
def _process(self):
|
||||
if not self.is_root:
|
||||
self._process_pragma_once()
|
||||
self._process_includes()
|
||||
|
||||
def __init__(self, file_path, amalgamation, is_root):
|
||||
self.file_path = file_path
|
||||
self.file_dir = os.path.dirname(file_path)
|
||||
self.amalgamation = amalgamation
|
||||
self.is_root = is_root
|
||||
|
||||
self.amalgamation.included_files.append(self.file_path)
|
||||
|
||||
actual_path = self.amalgamation.actual_path(file_path)
|
||||
if not os.path.isfile(actual_path):
|
||||
raise IOError("File not found: \"{0}\"".format(file_path))
|
||||
with open(actual_path, 'r') as f:
|
||||
self.content = f.read()
|
||||
self._process()
|
||||
|
||||
|
||||
def main():
|
||||
description = "Amalgamate C source and header files."
|
||||
usage = " ".join([
|
||||
"amalgamate.py",
|
||||
"[-v]",
|
||||
"-c path/to/config.json",
|
||||
"-s path/to/source/dir",
|
||||
"[-p path/to/prologue.(c|h)]"
|
||||
])
|
||||
argsparser = argparse.ArgumentParser(
|
||||
description=description, usage=usage)
|
||||
|
||||
argsparser.add_argument("-v", "--verbose", dest="verbose",
|
||||
choices=["yes", "no"], metavar="", help="be verbose")
|
||||
|
||||
argsparser.add_argument("-c", "--config", dest="config",
|
||||
required=True, metavar="", help="path to a JSON config file")
|
||||
|
||||
argsparser.add_argument("-s", "--source", dest="source_path",
|
||||
required=True, metavar="", help="source code path")
|
||||
|
||||
argsparser.add_argument("-p", "--prologue", dest="prologue",
|
||||
required=False, metavar="", help="path to a C prologue file")
|
||||
|
||||
amalgamation = Amalgamation(argsparser.parse_args())
|
||||
amalgamation.generate()
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
8
utils/amalgamate/config.json
Normal file
8
utils/amalgamate/config.json
Normal file
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"project": "cgame competitive programming for codingame",
|
||||
"target": "AllTrees.cpp",
|
||||
"sources": [
|
||||
"test/gametheory/TreesTest.cpp"
|
||||
],
|
||||
"include_paths": ["include"]
|
||||
}
|
||||
Reference in New Issue
Block a user