Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Don't fail when terminal says 0 columns #167

Merged
merged 1 commit into from
Nov 8, 2019
Merged

Don't fail when terminal says 0 columns #167

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 55 additions & 15 deletions perl/lib/NeedRestart/UI.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ package NeedRestart::UI;

use strict;
use warnings;
use Text::Wrap qw(wrap $columns);
use Text::Wrap qw(wrap);
use Term::ReadKey;

sub new {
Expand All @@ -39,6 +39,36 @@ sub new {
}, $class;
}

# my $nb_columns = _get_terminal_columns(FILEHANDLE);
# e.g.: my $nb_columns = _get_terminal_columns(\*STDOUT);
# => 103
#
# This is a wrapper for GetTerminalSize to cope with Debian
# Bug#824564.
sub _get_terminal_columns {
my ($filehandle) = @_;
# workaround Debian Bug#824564 in Term::ReadKey: pass filehandle
# twice
my ($columns) = GetTerminalSize($filehandle, $filehandle);
return $columns;
}

# my $columns = &_get_columns();
#
# Return the number of columns to use for output.
sub _get_columns {
my $default_columns = 80; # Sane default
if (-t *STDOUT) {
my ($columns) = _get_terminal_columns(\*STDOUT);

# Cope with 0-width terminals (see Debian bug #942759).
return $columns == 0? $default_columns: $columns;
}
else {
return $default_columns;
}
}

sub wprint {
my $self = shift;
my $fh = shift;
Expand All @@ -48,9 +78,8 @@ sub wprint {

# only wrap output if it is a terminal
if (-t $fh) {
# workaround Debian Bug#824564 in Term::ReadKey: pass filehandle twice
my ($cols) = GetTerminalSize($fh, $fh);
$columns = $cols if($cols);
my ($cols) = _get_terminal_columns($fh, $fh);
$Text::Wrap::columns = $cols? $cols: 80;

print $fh wrap($sp1, $sp2, $message);
}
Expand Down Expand Up @@ -129,26 +158,37 @@ sub _progress_inc {

sub _progress_out {
my $self = shift;
my $columns = 80;

($columns) = GetTerminalSize(\*STDOUT) if (-t *STDOUT);

$columns -= 3;
my $wmsg = int($columns * 0.7);
$wmsg = length($self->{progress}->{msg}) if(length($self->{progress}->{msg}) < $wmsg);
my $wbar = $columns - $wmsg - 1;
my $msg = $self->{progress}->{msg};
my $max = $self->{progress}->{max};
my $count = $self->{progress}->{count};

# The line looks like this:
# my message [==== ]
# <- wmsg ->..<---- wbar -------->.

# 3 columns are preassigned (the space and the square brackets);
# we need to split the remaining space between the message and the
# bar itself.
my $remaining_space = _get_columns() - 3;

printf("%-${wmsg}s [%-${wbar}s]\r", substr($self->{progress}->{msg}, 0, $wmsg), '=' x ($wbar*( $self->{progress}->{max} > 0 ? $self->{progress}->{count}/$self->{progress}->{max} : 0 )));
# We use 70% max of the remaining space.
my $wmsg = int($remaining_space * 0.7);
# Shrink if the message is actually shorter.
$wmsg = length($msg) if(length($msg) < $wmsg);

my $wbar = $remaining_space - $wmsg;

my $bar = '=' x ($wbar*( $max > 0 ? $count/$max : 0 ));
printf("%-${wmsg}s [%-${wbar}s]\r", substr($msg, 0, $wmsg), $bar);
}

sub _progress_fin {
my $self = shift;
my $columns = 80;
my $columns = _get_columns;

$self->{progress}->{count} = 0;

($columns) = GetTerminalSize(\*STDOUT) if (-t *STDOUT);

print $self->{progress}->{msg}, ' ' x ($columns - length($self->{progress}->{msg})), "\n";
}

Expand Down