progress.h

Go to the documentation of this file.

 
/*
Copyright (c) 2026 MrXie1109
 
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 <chrono>
#include <iostream>
#include <iterator>
#include <string>
 
#include "../core/csexc.h"
 
namespace console {
    template <class CharT = char, class Traits = std::char_traits<CharT>>
    struct BasicProgressConfig {
        using string_type  = std::basic_string<CharT, Traits>;
        using ostream_type = std::basic_ostream<CharT, Traits>;
 
        ostream_type &os;           
        int           width;        
        string_type   fill_char;    
        string_type   empty_char;   
        string_type   prefix;       
        string_type   suffix;       
        bool          show_percent; 

        BasicProgressConfig(ostream_type &o,
            int                           w   = 50,
            string_type                   fc  = string_type{1, CharT('#')},
            string_type                   ec  = string_type{1, CharT('.')},
            string_type                   pre = string_type{1, CharT('[')},
            string_type                   suf = string_type{1, CharT(']')},
            bool                          sp  = true) :
            os(o), width(w), fill_char(std::move(fc)),
            empty_char(std::move(ec)), prefix(std::move(pre)),
            suffix(std::move(suf)), show_percent(sp) {}
    };

    using ProgressConfig = BasicProgressConfig<char>;

    using WProgressConfig = BasicProgressConfig<wchar_t>;

    template <class CharT, class Traits, class Iter>
    class BasicProgress {
    public:
        using config_type = BasicProgressConfig<CharT, Traits>;

        class iterator {
            const config_type                    *config_;
            size_t                                current_;
            size_t                                total_;
            Iter                                  it_;
            std::chrono::steady_clock::time_point last_draw_;
 
            void draw() {
                if (!config_) return;
                auto now = std::chrono::steady_clock::now();
                if (current_ < total_
                    && (now - last_draw_) < std::chrono::milliseconds{50}) {
                    return;
                }
                int percent = current_ * 100 / total_;
                int filled  = percent * config_->width / 100;
                config_->os << CharT('\r') << config_->prefix;
                for (int i = 0; i < filled; ++i)
                    config_->os << config_->fill_char;
                for (int i = filled; i < config_->width; ++i)
                    config_->os << config_->empty_char;
                config_->os << config_->suffix;
                if (config_->show_percent) {
                    config_->os.width(4);
                    config_->os << percent << CharT('%');
                }
                config_->os.flush();
                last_draw_ = now;
            }
 
        public:
            iterator(const config_type *config,
                size_t                  current,
                size_t                  total,
                Iter                    it) :
                config_(config), current_(current), total_(total), it_(it),
                last_draw_(std::chrono::steady_clock::now()) {}
 
            iterator &operator++() {
                if (current_ < total_) {
                    ++current_;
                    ++it_;
                    draw();
                }
                return *this;
            }
 
            iterator operator++(int) {
                iterator tmp = *this;
                ++(*this);
                return tmp;
            }
 
            bool operator==(const iterator &other) {
                return current_ == other.current_;
            }
 
            bool operator!=(const iterator &other) {
                return current_ != other.current_;
            }
 
            decltype(*it_) operator*() { return *it_; }
        };
 
        template <typename Cont>
        BasicProgress(const Cont &cont, const config_type &config) :
            config_(config),
            total_(std::distance(std::begin(cont), std::end(cont))),
            begin_(std::begin(cont)), end_(std::end(cont)) {}
 
        template <typename Cont>
        BasicProgress(Cont &cont, const config_type &config) :
            config_(config),
            total_(std::distance(std::begin(cont), std::end(cont))),
            begin_(std::begin(cont)), end_(std::end(cont)) {}
 
        ~BasicProgress() { config_.os << std::endl; }
 
        iterator begin() { return iterator(&config_, 0, total_, begin_); }
        iterator end() { return iterator(&config_, total_, total_, end_); }
 
    private:
        config_type config_;
        size_t      total_;
        Iter        begin_;
        Iter        end_;
    };

    template <class Iter>
    using Progress = BasicProgress<char, std::char_traits<char>, Iter>;

    template <class Iter>
    using WProgress = BasicProgress<wchar_t, std::char_traits<wchar_t>, Iter>;
 
    namespace ProgressStyle {
        inline const BasicProgressConfig<> &normal() {
            static BasicProgressConfig<> cfg{std::cout};
            return cfg;
        }
 
        inline const BasicProgressConfig<> &simple() {
            static BasicProgressConfig<> cfg{//
                std::cout,
                50,
                std::string(1, '='),
                std::string(1, '-'),
                std::string{},
                std::string{},
                false};
            return cfg;
        }
 
        inline const BasicProgressConfig<> &beautiful() {
            static BasicProgressConfig<> cfg{//
                std::cout,
                50,
                std::string("\u2588"),
                std::string("\u2591"),
                std::string("\u2595"),
                std::string("\u258F"),
                true};
            return cfg;
        }
    }

    template <class CharT = char,
        class Traits      = std::char_traits<CharT>,
        class Cont>
    inline auto
    progress(Cont &&cont, const BasicProgressConfig<CharT, Traits> &pc)
        -> BasicProgress<CharT, Traits, decltype(std::begin(cont))> {
        return {std::forward<Cont>(cont), pc};
    }
}