Terminal: ProgressBar

Author: MorganCaron

README.md

@@ -46,7 +46,7 @@ The [unit tests](tests) serve as examples of how to use these functions.
 
 ## Getting Started
 
-A C++23 compliant compiler with std module support and XMake is needed to build CppUtils
+A C++26 compliant compiler with std module support and XMake is needed to build CppUtils
 
 This library is used in my C++ projects, but you can also use it in your projects.
 Just follow the installation steps and consult the documentation for each feature you need.

modules/Terminal/ProgressBar.mpp

@@ -10,17 +10,24 @@ export namespace CppUtils::Terminal
 	class ProgressBar final
 	{
 	public:
-		inline ProgressBar():
-			m_canvas{Container::Size2d<>{getTerminalSize().x, 3}}
+		inline ProgressBar(std::string name = ""):
+			m_name{std::move(name)},
+			m_canvas{Container::Size2d<>{getTerminalSize().x, 1}}
 		{
 			setPercent(0);
 		}
 
-		inline auto setPercent([[maybe_unused]] std::size_t percent) -> void
+		inline auto setPercent(std::size_t percent) -> void
 		{
+			auto width = m_canvas.getSize().x - std::size(m_name) - 9;
+			auto progress = percent * width / 100;
+			auto string = std::format("{} [{}{}] {:>3}% ", m_name, std::string(progress, '#'), std::string(width - progress, '.'), percent);
+			m_canvas.print(Container::Size2d<>{0, 0}, string);
+			m_canvas.update();
 		}
 
 	private:
+		std::string m_name;
 		Canvas m_canvas;
 	};
 }

tests/Terminal/Canvas.mpp

@@ -14,29 +14,29 @@ export namespace CppUtils::UnitTest::Terminal::Canvas
 				auto canvas = CppUtils::Terminal::Canvas{CppUtils::Container::Size2d<>{10, 5}};
 				canvas.fill('/');
 				canvas.update();
-				std::this_thread::sleep_for(500ms);
+				std::this_thread::sleep_for(300ms);
 			}
 			{
 				auto canvas = CppUtils::Terminal::Canvas{CppUtils::Container::Size2d<>{16, 9}};
 				canvas.fill('.');
 				canvas.update();
-				std::this_thread::sleep_for(500ms);
+				std::this_thread::sleep_for(300ms);
 			}
 			{
 				auto canvas = CppUtils::Terminal::Canvas{};
 				canvas.fill('#');
 				canvas.update();
-				std::this_thread::sleep_for(500ms);
+				std::this_thread::sleep_for(300ms);
 			}
 		});
 
 		suite.addTest("Fill", [&] {
 			auto canvas = CppUtils::Terminal::Canvas{CppUtils::Container::Size2d<>{10, 5}};
-			const auto chars = "-\\||/"sv;
+			const auto chars = "-\\|/"sv;
 			for (auto i = 0uz; i < 5; ++i)
 				for (auto c : chars)
 				{
-					std::this_thread::sleep_for(75ms);
+					std::this_thread::sleep_for(100ms);
 					canvas.fill(c);
 					canvas.update();
 				}
@@ -50,7 +50,12 @@ export namespace CppUtils::UnitTest::Terminal::Canvas
 		});
 
 		suite.addTest("Progress bar", [&] {
-			std::this_thread::sleep_for(3s);
+			auto progressBar = CppUtils::Terminal::ProgressBar{"Progress bar"};
+			for (auto i = 0uz; i <= 100; ++i)
+			{
+				progressBar.setPercent(i);
+				std::this_thread::sleep_for(20ms);
+			}
 		});
 
 		suite.addTest("Bouncing ball", [&] {