clanguml::common::generators::progress_indicator Class Reference

Container for diagram generation progress indicators. More...

Detailed Description

Container for diagram generation progress indicators.

Definition at line 107 of file progress_indicator.h.

#include <progress_indicator.h>

Public Member Functions
	progress_indicator ()
	progress_indicator (std::ostream &ostream)
	~progress_indicator () override=default
void	add_progress_bar (const std::string &name, size_t max, indicators::Color color) override
void	increment (const std::string &name) override
void	stop () override
void	complete (const std::string &name) override
void	fail (const std::string &name) override
Public Member Functions inherited from clanguml::common::generators::progress_indicator_base
virtual	~progress_indicator_base ()=default
virtual void	add_progress_bar (const std::string &name, size_t max, indicators::Color color)=0
virtual void	increment (const std::string &name)=0
virtual void	stop ()=0
virtual void	complete (const std::string &name)=0
virtual void	fail (const std::string &name)=0

Private Attributes
indicators::DynamicProgress< indicators::ProgressBar >	progress_bars_
std::vector< std::shared_ptr< indicators::ProgressBar > >	bars_
std::ostream &	ostream_

Additional Inherited Members
Protected Attributes inherited from clanguml::common::generators::progress_indicator_base
std::map< std::string, progress_state >	progress_bar_index_
std::mutex	progress_bars_mutex_

Constructor & Destructor Documentation

progress_indicator() [1/2]

clanguml::common::generators::progress_indicator::progress_indicator

(

)

Definition at line 26 of file progress_indicator.cc.

    : progress_indicator(std::cout)
{
}

progress_indicator() [2/2]

clanguml::common::generators::progress_indicator::progress_indicator

(

std::ostream &

ostream

)

Definition at line 31 of file progress_indicator.cc.

    : ostream_(ostream)
{
    progress_bars_.set_option(indicators::option::HideBarWhenComplete{false});
}

~progress_indicator()

clanguml::common::generators::progress_indicator::~progress_indicator ( )

overridedefault

Member Function Documentation

add_progress_bar()

void clanguml::common::generators::progress_indicator::add_progress_bar ( const std::string &  name, size_t  max, indicators::Color  color  )

overridevirtual

Add a new progress bar to the indicator set

Parameters

name	Name (prefix) of the progress bar
max	Total number of steps in the progress bar
color	Color of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 56 of file progress_indicator.cc.

{
    auto postfix_text = max > 0 ? fmt::format("{}/{}", 0, max) : std::string{};
 
    const auto kBarWidth = 35U;
    const auto kPrefixTextWidth = 25U;
 
    auto bar = std::make_shared<indicators::ProgressBar>(
        indicators::option::Stream{ostream_},
        indicators::option::BarWidth{kBarWidth},
        indicators::option::ForegroundColor{color},
        indicators::option::ShowElapsedTime{true},
#if _MSC_VER
        indicators::option::Fill{"="}, indicators::option::Lead{">"},
#else
        indicators::option::Fill{"█"}, indicators::option::Lead{"█"},
#endif
        indicators::option::Remainder{"-"},
        indicators::option::PrefixText{
            fmt::format("{:<25}", util::abbreviate(name, kPrefixTextWidth))},
        indicators::option::PostfixText{postfix_text});
 
    progress_bars_mutex_.lock();
 
    progress_bars_.push_back(*bar);
    bars_.push_back(bar);
    auto bar_index = bars_.size() - 1;
    progress_bar_index_.emplace(name, progress_state{bar_index, 0, max});
 
    progress_bars_mutex_.unlock();
}

complete()

void clanguml::common::generators::progress_indicator::complete ( const std::string &  name )

overridevirtual

Set specified progress bar as complete.

Parameters

name	Name of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 175 of file progress_indicator.cc.

{
    const auto kCompleteProgressPercent = 100U;
 
    progress_bars_mutex_.lock();
 
    if (progress_bar_index_.count(name) == 0) {
        progress_bars_mutex_.unlock();
        return;
    }
 
    auto &p = progress_bar_index_.at(name);
    auto &bar = progress_bars_[p.index];
 
    p.progress = p.max;
 
    bar.set_progress(kCompleteProgressPercent);
 
#if _MSC_VER
    const auto postfix_text = fmt::format("{}/{} OK", p.progress, p.max);
#else
    const auto postfix_text = fmt::format("{}/{} ✔", p.progress, p.max);
#endif
    bar.set_option(indicators::option::PostfixText{postfix_text});
    bar.set_option(
        indicators::option::ForegroundColor{indicators::Color::green});
    bar.mark_as_completed();
 
    progress_bars_mutex_.unlock();
}

fail()

void clanguml::common::generators::progress_indicator::fail ( const std::string &  name )

overridevirtual

Set progress bar as failed.

Parameters

name	Name of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 229 of file progress_indicator.cc.

{
    progress_bars_mutex_.lock();
 
    if (progress_bar_index_.count(name) == 0) {
        progress_bars_mutex_.unlock();
        return;
    }
 
    auto &p = progress_bar_index_.at(name);
    auto &bar = progress_bars_[p.index];
 
#if _MSC_VER
    const auto postfix_text = fmt::format("{}/{} FAILED", p.progress, p.max);
#else
    const auto postfix_text = fmt::format("{}/{} ✗", p.progress, p.max);
#endif
    bar.set_option(indicators::option::ForegroundColor{indicators::Color::red});
    bar.set_option(indicators::option::PostfixText{postfix_text});
    bar.mark_as_completed();
 
    progress_bars_mutex_.unlock();
}

increment()

void clanguml::common::generators::progress_indicator::increment ( const std::string &  name )

overridevirtual

Increment specified progress bar.

Parameters

name	Name of the progress bar

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 115 of file progress_indicator.cc.

{
    const auto kASTTraverseProgressPercent = 95U;
 
    progress_bars_mutex_.lock();
 
    if (progress_bar_index_.count(name) == 0) {
        progress_bars_mutex_.unlock();
        return;
    }
 
    auto &p = progress_bar_index_.at(name);
    auto &bar = progress_bars_[p.index];
 
    p.progress++;
 
    bar.set_progress((p.progress * kASTTraverseProgressPercent) / p.max);
    bar.set_option(indicators::option::PostfixText{
        fmt::format("{}/{}", p.progress, p.max)});
 
    progress_bars_mutex_.unlock();
}

stop()

void clanguml::common::generators::progress_indicator::stop ( )

overridevirtual

Stop all the progress bars.

Implements clanguml::common::generators::progress_indicator_base.

Definition at line 138 of file progress_indicator.cc.

{
    progress_bars_mutex_.lock();
 
    for (auto &[name, p] : progress_bar_index_) {
        progress_bars_[p.index].mark_as_completed();
    }
 
    progress_bars_mutex_.unlock();
}

Member Data Documentation

bars_

std::vector<std::shared_ptr<indicators::ProgressBar> > clanguml::common::generators::progress_indicator::bars_

private

Definition at line 128 of file progress_indicator.h.

ostream_

std::ostream& clanguml::common::generators::progress_indicator::ostream_

private

Definition at line 129 of file progress_indicator.h.

progress_bars_

indicators::DynamicProgress<indicators::ProgressBar> clanguml::common::generators::progress_indicator::progress_bars_

private

Definition at line 127 of file progress_indicator.h.

---

The documentation for this class was generated from the following files:

• src/common/generators/progress_indicator.h
• src/common/generators/progress_indicator.cc