File Coverage

blib/lib/Progress/Any/Output/TermProgressBarColor.pm

Criterion	Covered	Total	%
statement	110	160	68.7
branch	35	86	40.7
condition	18	44	40.9
subroutine	12	19	63.1
pod	3	4	75.0
total	178	313	56.8

package Progress::Any::Output::TermProgressBarColor;

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2020-08-15'; # DATE
our $DIST = 'Progress-Any-Output-TermProgressBarColor'; # DIST
our $VERSION = '0.249'; # VERSION

use 5.010001;
use strict;
use warnings;

use Color::ANSI::Util qw(ansifg ansibg);
require Win32::Console::ANSI if $^O =~ /Win/;

$|++;

sub _patch {
    my $out = shift;

    return if $out->{patch_handle1};

    require Monkey::Patch::Action;
    if (defined &{"Log::Any::Adapter::Screen::hook_before_log"}) {
        $out->{patch_handle1} = Monkey::Patch::Action::patch_package(
            'Log::Any::Adapter::Screen', 'hook_before_log', 'replace',
            sub {
                # we install a hook to clean up progress indicator first before
                # we print log message to the screen.
                $out->cleanup(1);
                $Progress::Any::output_data{"$out"}{force_update} = 1;
            }
        );
    } elsif (defined  &{"Log::ger::Output::Screen::hook_before_log"}) {
        $out->{patch_handle1} = Monkey::Patch::Action::patch_package(
            'Log::ger::Output::Screen', 'hook_before_log', 'replace',
            sub {
                # we install a hook to clean up progress indicator first before
                # we print log message to the screen.
                $out->cleanup(1);
                $Progress::Any::output_data{"$out"}{force_update} = 1;
            }
        );
    }

    if (defined &{"Log::Any::Adapter::Screen::hook_after_log"}) {
        $out->{patch_handle2} = Monkey::Patch::Action::patch_package(
            'Log::Any::Adapter::Screen', 'hook_after_log', 'replace',
            sub {
                my ($self, $msg) = @_;

                # make sure we print a newline after logging so progress bar
                # starts at column 1
                print { $self->{_fh} } "\n" unless $msg =~ /\R\z/;

                # reset show_delay because we have displayed something
                $out->keep_delay_showing if $out->{show_delay};

                # redisplay progress bar if were cleaned up
                print { $self->{_fh} } $out->{_bar} if $out->{_bar};
            }
        );
    } elsif (defined &{"Log::ger::Output::Screen::hook_after_log"}) {
        $out->{patch_handle2} = Monkey::Patch::Action::patch_package(
            'Log::ger::Output::Screen', 'hook_after_log', 'replace',
            sub {
                my ($ctx, $msg) = @_;
                # make sure we print a newline after logging so progress bar
                # starts at column 1
                print { $ctx->{_fh} } "\n" unless $msg =~ /\R\z/;

                # reset show_delay because we have displayed something
                $out->keep_delay_showing if $out->{show_delay};

                # redisplay progress bar if were cleaned up
                print { $ctx->{_fh} } $out->{_bar} if $out->{_bar};
            }
        );
    }
}

sub _unpatch {
    my $self = shift;
    undef $self->{patch_handle1};
    undef $self->{patch_handle2};
}

sub _template_length {
    require Progress::Any; # for $template_regex
    no warnings 'once'; # $Progress::Any::template_regex

    my ($self, $template) = @_;

    my $template_length = length($template);

    while ($template =~ /$Progress::Any::template_regex/g) {
        my ($all, $width, $dot, $prec, $conv) =
            ($1, $2, $3, $4, $5);

        if (defined $template_length) {

            if ($conv eq '%') {
                $width //= 1;
            } elsif ($conv eq 'b' || $conv eq 'B') {
                $width //= $self->{_default_b_width};
            } elsif ($conv eq 'p') {
                $width //= 3;
            } elsif ($conv eq 'e') {
                $width //= -8;
            } elsif ($conv eq 'r') {
                $width //= -8;
            } elsif ($conv eq 'R') {
                $width //= -(8 + 1 + 7);
            }

            if (defined $width) {
                $template_length += abs($width) - length($all);
            } else {
                $template_length = undef;
            }

        }
    }

    $template_length;
}

sub new {
    my ($class, %args0) = @_;

    my %args;

    $args{width} = delete($args0{width});
    if (!defined($args{width})) {
        my ($cols, $rows);
        if ($ENV{COLUMNS}) {
            $cols = $ENV{COLUMNS};
        } elsif (eval { require Term::Size; 1 }) {
            ($cols, $rows) = Term::Size::chars(*STDOUT{IO});
        }
        $cols //= 80;
        # on windows if we print at rightmost column, cursor will move to the
        # next line, so we try to avoid that
        $args{width} = $^O =~ /Win/ ? $cols-1 : $cols;
    }

    $args{fh} = delete($args0{fh});
    $args{fh} //= \*STDERR;

    $args{show_delay} = delete($args0{show_delay});

    $args{freq} = delete($args0{freq});

    $args{wide} = delete($args0{wide});

    $args{rownum} = delete($args0{rownum});
    $args{rownum} //= 0;

    $args{template} = delete($args0{template}) //
        '%p%% [%B]%R';

    keys(%args0) and die "Unknown output parameter(s): ".
        join(", ", keys(%args0));

    $args{_last_hide_time} = time();

    require Text::ANSI::Util;
    if ($args{wide}) {
        require Text::ANSI::WideUtil;
    }

    my $self = bless \%args, $class;

    # determine the default width for %b and %B
    {
        $self->{_default_b_width} = 0;
        (my $template = $args{template}) =~ s!|!!g;
        my $len = $self->_template_length($template) // 16;
        $self->{_default_b_width} = $args{width} - $len;
    }

    # render color in template
    ($self->{_template} = $self->{template}) =~ s!|<(/)color>!$1 ? ansifg($1) : "\e[0m"!eg;

    $self;
}

sub _handle_unknown_conversion {
    my %args = @_;

    my $conv = $args{conv};
    return () unless $conv eq 'b' || $conv eq 'B';

    my $p = $args{indicator};
    my $self = $args{self};

    my $tottgt = $p->total_target;
    my $totpos = $p->total_pos;

    my $bar_bar = '';
    my $bwidth = abs($args{width} // $self->{_default_b_width});

    if ($tottgt) {
        my $bfilled = int($totpos / $tottgt * $bwidth);
        $bfilled = $bwidth if $bfilled > $bwidth;
        $bar_bar = ("=" x $bfilled) . (" " x ($bwidth-$bfilled));
    } else {
        # display 15% width of bar just moving right
        my $bfilled = int(0.15 * $bwidth);
        $bfilled = 1 if $bfilled < 1;
        $self->{_x}++;
        if ($self->{_x} > $bwidth-$bfilled) {
            $self->{_x} = 0;
        }
        $bar_bar = (" " x $self->{_x}) . ("=" x $bfilled) .
            (" " x ($bwidth-$self->{_x}-$bfilled));
    }

    my $msg = $args{args}{'message.alt.output.TermProgressBarColor'} //
        $args{args}{message};
    if ($conv eq 'B' && defined $msg) {
        if ($msg =~ m!
            require String::Elide::Parts;
            $msg = String::Elide::Parts::elide($msg, $bwidth);
        }
        my $mwidth;
        if ($self->{wide}) {
            $msg = Text::ANSI::WideUtil::ta_mbtrunc($msg, $bwidth);
            $mwidth = Text::ANSI::WideUtil::ta_mbswidth($msg);
        } else {
            $msg = Text::ANSI::Util::ta_trunc($msg, $bwidth);
            $mwidth = Text::ANSI::Util::ta_length($msg);
        }
        $bar_bar = $msg . substr($bar_bar, $mwidth);
    }

    return ("%s", $bar_bar);
}

sub update {
    my ($self, %args) = @_;

    return unless $ENV{PROGRESS_TERM_BAR} // $ENV{PROGRESS} // (-t $self->{fh});

    my $now = time();

    # if there is show_delay, don't display until we've surpassed it
    if (defined $self->{show_delay}) {
        return if $now - $self->{show_delay} < $self->{_last_hide_time};
    }

    $self->_patch;

    $self->cleanup;

    my $p = $args{indicator};
    my $is_finished = $p->{state} eq 'finished';
    if ($is_finished) {
        if ($self->{_lastlen}) {
            $self->{_last_hide_time} = $now;
        }
        return;
    }

    my $bar = $p->fill_template(
        {
            template => $self->{_template},
            handle_unknown_conversion => sub {
                _handle_unknown_conversion(
                    self => $self,
                    @_,
                );
            },
        },
        %args,
    );

    my $len = Text::ANSI::Util::ta_length($bar);
    $self->{_bar} = join(
        "",
        "\n" x $self->{rownum},
        $bar,
        ("\b" x $len),
        $self->{rownum} > 0 ? "\e[$self->{rownum}A" : "", # up N lines
    );
    print { $self->{fh} } $self->{_bar};
    $self->{_lastlen} = $len;
}

sub cleanup {
    my ($self, $dont_reset_lastlen) = @_;

    # sometimes (e.g. when a subtask's target is undefined) we don't get
    # state=finished at the end. but we need to cleanup anyway at the end of
    # app, so this method is provided and will be called by e.g.
    # Perinci::CmdLine

    my $ll = $self->{_lastlen};
    return unless $ll;
    my $clean_str = join(
        "",
        "\n" x $self->{rownum},
        " " x $ll,
        "\b" x $ll,
        $self->{rownum} > 0 ? "\e[$self->{rownum}A" : "", # up N lines
    );
    print { $self->{fh} } $clean_str;
    undef $self->{_lastlen} unless $dont_reset_lastlen;
}

sub keep_delay_showing {
    my $self = shift;

    $self->{_last_hide_time} = time();
}

sub DESTROY {
    my $self = shift;
    $self->_unpatch;
}

1;
# ABSTRACT: Output progress to terminal as color bar

__END__