File Coverage

blib/lib/App/ansicolumn/Border.pm

Criterion	Covered	Total	%
statement	20	53	37.7
branch	1	16	6.2
condition	0	15	0.0
subroutine	7	12	58.3
pod	0	7	0.0
total	28	103	27.1

package App::ansicolumn::Border;

=encoding utf-8

=head1 NAME

App::ansicolumn::Border - App::ansicolumn Border module

=head1 DESCRIPTION

Each item has five elements; C, C, C, C,
C.

C and C items have single string.

C, C and C items can hold string value or list
reference, and string value is equivalent to a list of single item.
If the list has single item, it is used on all positions.  If the
second item exists, it is used on middle position.  Third item is for
bottom position.

Class method C can be used to add new border style.

This is experimental implementation and subject to change.

=cut

use v5.14;
use warnings;
use utf8;
use Data::Dumper;

my %template = (
    __DEFAULT__ => 'space',
    space => {
	top    => '',
	left   => '',
	center => '  ',
	right  => '',
	bottom => '',
    },
    none => {
	top    => '',
	left   => '',
	center => '',
	right  => '',
	bottom => '',
    },
    side  => { right => ' ' , left => ' ' },
    left  => { right => ''  , left => '  ' },
    line => {
	center => "│ ", # "\x{2502} "
    },
    fat_line => {
	center => [ "█ ", "░ " ], # "\x{2588} "
    },
    vbar => {
	center => [ "╷ "  , # "\x{2577} "
		    "│ "  , # "\x{2502} "
		    "╵ " ], # "\x{2575} "
    },
    thick_vbar => {
	center => [ "▗ "  , # "\x{2597} "
		    "▐ "  , # "\x{2590} "
		    "▝ " ], # "\x{259D} "
    },
    fat_vbar => {
	center => [ "▄ "  , # "\x{2584} "
		    "█ "  , # "\x{2588} "
		    "▀ " ], # "\x{2580} "
    },
    hline => {
	top    => "─",
	center => " ",
	bottom => "─",
    },
    bottom_line => {
	center => " ",
	bottom => "─",
    },
    stick => {
	center => [ "╻ "  , # "\x{2577} "
		    "│ "  , # "\x{2502} "
		    "╹ " ], # "\x{2575} "
    },
    ascii_frame => {
	top    => "-",
	left   => [   "+" ,   "|" ],
	center => [ "+ +" , "| |" ],
	right  => [ "+"   , "|"   ],
	bottom => "-",
    },
    ascii_box => {
	top    =>   "-",
	left   => [ "+" , "|" ],
	center => [ "+" , "|" ],
	right  => [ "+" , "|" ],
	bottom =>   "-",
    },
    c_box => {
	top          =>   '*',
	left         => [ '/**',
			  '/* ' ],
	center       => [ '**/ /**',
			  ' */ /* ' ],
	right        => [ '**/',
			  ' */' ],
	bottom       =>   '*',
    },
    c_box2 => {
	top          =>   '*',
	left         => [ '/**',
			  ' * ',
			  ' **' ],
	center       => [ '** /**',
			  ' *  * ',
			  '**/ **' ],
	right        => [ '** ',
			  ' * ',
			  '**/' ],
	bottom       =>   '*',
    },
    box => {
	top    =>     "─",
	left   => [  "┌─"  ,
		     "│ "  ,
		     "└─" ],
	center => [ "┐┌─"  ,
		    "││ "  ,
		    "┘└─" ],
	right  => [ "┐"    ,
		    "│"    ,
		    "┘"   ],
	bottom =>     "─",
    },
    dash_box => {
	top    =>     "╴",
	left   => [  "╷╴"  ,
		     "╷ "  ,
		     "╶╶" ],
	center => [ "╴╷╴"  ,
		    "╵╷ "  ,
		    "╵╶╶" ],
	right  => [ "╴"    ,
		    "╵"    ,
		    "╵"   ],
	bottom =>     "╶",
    },
    round_box => {
	top    =>     "─",
	left   => [  "╭─"  ,
		     "│ "  ,
		     "╰─" ],
	center => [ "╮╭─"  ,
		    "││ "  ,
		    "╯╰─" ],
	right  => [ "╮"    ,
		    "│"    ,
		    "╯"   ],
	bottom =>     "─",
    },
    inner_box => {
	top    =>   "▄",
	left   => [ "▗" ,
		    "▐" ,
		    "▝" ],
	center => [ "▖▗" ,
		    "▌▐" ,
		    "▘▝" ],
	right  => [ "▖"  ,
		    "▌"  ,
		    "▘" ],
	bottom =>   "▀",
    },
    outer_box => {
	top    =>   "▀",
	left   => [ "▛"  ,
		    "▌"  ,
		    "▙" ],
	center => [ "▜▛" ,
		    "▐▌" ,
		    "▟▙" ],
	right  => [ "▜" ,
		    "▐" ,
		    "▟" ],
	bottom =>   "▄",
    },
    frame => {
	top    =>    "─",
	bottom =>    "─",
	left   => [ "┌─"  ,
		    "│ "  ,
		    "└─" ],
	center => [ "┬─"  ,
		    "│ "  ,
		    "┴─" ],
	right  => [ "┐"   ,
		    "│"   ,
		    "┘"  ],
    },
    dash_frame => {
	top    =>     "╴",
	left   => [  "╷╴"  ,
		     "╷ "  ,
		     "╶╶" ],
	center => [  "╴╴"  ,
		     "╵ "  ,
		     "└╶" ],
	right  => [ "╴"    ,
		    "╵"    ,
		    "╵"   ],
	bottom =>   "╶",
    },
    page_frame => {
	top    =>    "─",
	left   => [ "┌─"  ,
		    "│ "  ,
		    "└─" ],
	center => [ "──"  ,
		    "  "  ,
		    "──" ],
	right  => [ "┐"   ,
		    "│"   ,
		    "┘"  ],
	bottom =>    "─",
    },
    thin_shadow => {
	top    =>   "",
	left   => [ " "  ,
		    " "  ,
		    "▝" ],
	center => [ " ▖ " ,
		    " ▌ " ,
		    "▀▘▝" ],
	right  => [ " ▖" ,
		    " ▌" ,
		    "▀▘" ],
	bottom =>   "▀",
    },
    shadow => {
	top    =>   "",
	left   => [ " "  ,
		    " "  ,
		    " " ],
	center => [ " ▄ " ,
		    " █ " ,
		    "▀▀ " ],
	right  => [ " ▄" ,
		    " █" ,
		    "▀▀" ],
	bottom =>   "▀",
    },
    thin_shadow_box => {
	top    =>   "─",
	left   => [ "┌─"  ,
		    "│ "  ,
		    "└▄" ],
	center => [ "─┐ ┌─"  ,
		    " ▐ │ "  ,
		    "▄▟ └▄" ],
	right  => [ "─┐" ,
		    " ▐" ,
		    "▄▟" ],
	bottom =>   "▄",
    },
    shadow_box => {
	top    =>   "─",
	left   => [ "┌─"  ,
		    "│ "  ,
		    "└▄" ],
	center => [ "─┐ ┌─"  ,
		    " ▐▌│ "  ,
		    "▄▟▌└▄" ],
	right  => [ "─┐ " ,
		    " ▐▌" ,
		    "▄▟▌" ],
	bottom =>   "▄",
    },
    fat_box => {
	top    =>   "▀",
	left   => [ "█▀"  ,
		    "█ "  ,
		    "█▄" ],
	center => [ "▀█ █▀"  ,
		    " █ █ "  ,
		    "▄█ █▄" ],
	right  => [ "▀█" ,
		    " █" ,
		    "▄█" ],
	bottom =>   "▄",
    },
    very_fat_box => {
	top    =>   "█",
	left   => [ "███"  ,
		    "██ "  ,
		    "███" ],
	center => [ "███  ███"  ,
		    " ██  ██ "  ,
		    "███  ███" ],
	right  => [ "███" ,
		    " ██" ,
		    "███" ],
	bottom =>   "█",
    },
    fat_frame => {
	top    =>   "▀",
	left   => [ "█▀"  ,
		    "█ "  ,
		    "█▄" ],
	center => [ "▀█▀"  ,
		    " █ "  ,
		    "▄█▄" ],
	right  => [ "▀█" ,
		    " █" ,
		    "▄█" ],
	bottom =>   "▄",
    },
    very_fat_frame => {
	top    =>   "█",
	left   => [ "███"  ,
		    "██ "  ,
		    "███" ],
	center => [ "████"  ,
		    " ██ "  ,
		    "████" ],
	right  => [ "███" ,
		    " ██" ,
		    "███" ],
	bottom =>   "█",
    },
    fat_dash_box => {
	top    => "▘",
	left   => [ "▘", "▘", "▚" ],
	center => [ "▚ ▘", "▗ ▘", "▗ ▚" ],
	right  => [ "▚", "▗", "▗" ],
	bottom => "▗",
    },
    fat_dash_frame => {
	top    => "▘",
	left   => [ "▘", "▘", "▚" ],
	center => [ "▚ ", "▗ ", "▗ " ],
	right  => [ "▚", "▗", "▗" ],
	bottom => "▗",
    },
    zebra_frame => {
	top    => "▘",
	left   => [ "▘", "▘", "▚" ],
	center => [ "▚▘", "▗▘", "▗▚" ],
	right  => [ "▚", "▗", "▗" ],
	bottom => "▗",
    },
    checker_box => {
	top    => "▘",
	left   => [ "▚▘", "▚ ", "▚▗" ],
	center => [ "▚ ▚▘", "▚ ▚ ", "▚ ▚▗" ],
	right  => "▚",
	bottom => "▗",
    },
    checker_frame => {
	top    => "▘",
	left   => [ "▚▘", "▚ ", "▚▗" ],
	center => [ "▚▘", "▚ ", "▚▗" ],
	right  => "▚",
	bottom => "▗",
    },
    comb => {
	top    =>    "─",
	left   => [ "┌─"  ,
		    "│ "  ,
		    "│ " ],
	center => [ "┬─"  ,
		    "│ "  ,
		    "│ " ],
	right  => [ "┐"   ,
		    "│"   ,
		    "│"  ],
    },
    rake => {
	left   => [ "│ "  ,
		    "│ "  ,
		    "└─" ],
	center => [ "│ "  ,
		    "│ "  ,
		    "┴─" ],
	right  => [ "│"   ,
		    "│"   ,
		    "┘"  ],
	bottom =>    "─",
    },
    mesh => {
	left   => [ "│"  ,
		    "│"  ,
		    "├" ],
	center => [ "│"  ,
		    "│"  ,
		    "┼" ],
	right  => [ "│"  ,
		    "│"  ,
		    "┤" ],
	bottom =>   "─",
    },
    hsem => {
	top    =>   "─",
	left   => [ "├"  ,
		    "│"  ,
		    "│" ],
	center => [ "┼"  ,
		    "│"  ,
		    "│" ],
	right  => [ "┤"  ,
		    "│"  ,
		    "│" ],
    },
    dumbbell => {
	center => [ "▄ "  , # "\x{2584} "
		    "│ "  , # "\x{2502} "
		    "▀ " ], # "\x{2580} "
    },
    ribbon => {
	center => [ "┌┐ "  , # "\x{250c}\x{2510}"
		    "││ "  , # "\x{2502}\x{2502}"
		    "└┘ " ], # "\x{2514}\x{2518}"
	left => ' ',
    },
    round_ribbon => {
	center => [ "╭╮ "  , # "\x{256D}\x{256E}"
		    "││ "  , # "\x{2502}\x{2502}"
		    "╰╯ " ], # "\x{2570}\x{256F}"
    },
    double_ribbon => {
	center => [ "╔╗ "  , # "\x{2554}\x{2557}"
		    "║║ "  , # "\x{2551}\x{2551}"
		    "╚╝ " ], # "\x{255A}\x{255D}"
    },
    corner => {
	top    => " ",
	left   => [ "◲", " ", "◳" ],
	center => [ "◱ ◲", "   ", "◰ ◳" ],
	right  => [ "◱", " ", "◰" ],
	bottom => " ",
    },
    );

use Clone qw(clone);

for my $style (qw(line vbar hline bottom_line box dash_box shadow_box frame dash_frame page_frame comb rake mesh
		  dumbbell ribbon)) {
    $template{$style} // next;
    my $new = $template{"heavy_$style"} = clone $template{$style};
    while (my($k, $v) = each %$new) {
	for (ref $v ? @$v : $new->{$k}) {
	    $_ = heavy($_);
	}
    }
}

sub heavy {
    $_[0] =~ tr[─│┌┐└┘├┤┬┴┼╴╵╶╷][━┃┏┓┗┛┣┫┳┻╋╸╹╺╻]r;
}

# handle alias styles
for my $style (keys %template) {
    while (not ref (my $alias = $template{$style})) {
	($template{$style} = $template{$alias}) // last;
    }
}

sub new {
    my $class = shift;
    my $style = @_ ? shift : '__DEFAULT__';
    (bless { %template }, $class)->style($style);
}

sub styles {
    my $obj = shift;
    grep { $_ !~ /^__/ } sort keys %$obj;
}

sub style {
    my $obj = shift;
    my $style = do {
	if (@_) {
	    my $s = shift;
	    if ($s =~ /^random$/i) {
		my @styles = $obj->styles;
		$styles[rand @styles];
	    } else {
		$obj->{__STYLE__} = $s =~ tr[-][_]r;
	    }
	} else {
	    return $obj->{__STYLE__};
	}
    };
    $obj->{$style} or return undef;
    $obj->{__CURRENT__} //= {};
    # %{$obj->{__CURRENT__}} = %{$obj->{$style}}
    %{$obj->{__CURRENT__}} =
	map { $_ => $obj->{$style}->{$_} } keys %{$obj->{$style}};
    $obj;
}

sub get {
    my $obj = shift;
    $obj->get_by_style('__CURRENT__', @_) // $obj->get_by_style('__DEFAULT__', @_)
	// die;
}

sub add_style {
    my $obj = shift;
    die if @_ % 2;
    while (my($name, $style) = splice @_, 0, 2) {
	$template{$name} = $style;
    }
    $obj;
}

sub get_by_style ($ $$;$$) {
    my $obj = shift;
    my($style, $place, $position, $page) = (shift, shift, shift//0, shift//0);
    my $hash = $obj->{$style} // return undef;
    my $entry = $hash->{$place} // return undef;
    if (not ref $entry) {
	return $entry;
    } elsif (@$entry == 0) {
	return undef;
    } else {
	my $target = ref $entry->[0] ? $entry->[$page / @$entry] : $entry;
	return $target->[$position % @$target];
    }
}

1;