package Data::Unixish::rpad;
use 5.010;
use locale;
use strict;
use syntax 'each_on_array'; # to support perl < 5.12
use warnings;
#use Log::Any '$log';
use Data::Unixish::_pad;
use Data::Unixish::Util qw(%common_args);
our $VERSION = '1.42'; # VERSION
our %SPEC;
$SPEC{rpad} = {
v => 1.1,
summary => 'Pad text to the right until a certain column width',
description => <<'_',
This function can handle text containing wide characters and ANSI escape codes.
Note: to pad to a certain character length instead of column width (note that
wide characters like Chinese can have width of more than 1 column in terminal),
you can turn of `mb` option even when your text contains wide characters.
_
args => {
%common_args,
width => {
schema => ['int*', min => 0],
req => 1,
cmdline_aliases => { w => {} },
},
ansi => {
summary => 'Whether to handle ANSI escape codes',
schema => ['bool', default => 0],
},
mb => {
summary => 'Whether to handle wide characters',
schema => ['bool', default => 0],
},
char => {
summary => 'Character to use for padding',
schema => ['str*', len=>1, default=>' '],
description => <<'_',
Character should have column width of 1. The default is space (ASCII 32).
_
cmdline_aliases => { c => {} },
},
trunc => {
summary => 'Whether to truncate text wider than specified width',
schema => ['bool', default => 0],
},
},
tags => [qw/format/],
};
sub rpad {
my %args = @_;
Data::Unixish::_pad::_pad("r", %args);
}
1;
# ABSTRACT: Pad text to the right until a certain column width
__END__
=pod
=encoding utf-8
=head1 NAME
Data::Unixish::rpad - Pad text to the right until a certain column width
=head1 VERSION
version 1.42
=head1 SYNOPSIS
In Perl:
use Data::Unixish::List qw(dux);
my @res = dux([rpad => {width=>6}],"123", "1234");
# => ("123 ", "1234 ")
In command line:
% echo -e "123\n1234" | dux rpad -w 6 -c x --format=text-simple
123xxx
1234xx
=head1 DESCRIPTION
=head1 FUNCTIONS
None are exported by default, but they are exportable.
=head2 rpad(%args) -> [status, msg, result, meta]
This function can handle text containing wide characters and ANSI escape codes.
Note: to pad to a certain character length instead of column width (note that
wide characters like Chinese can have width of more than 1 column in terminal),
you can turn of C<mb> option even when your text contains wide characters.
Arguments ('*' denotes required arguments):
=over 4
=item * B<ansi> => I<bool> (default: 0)
Whether to handle ANSI escape codes.
=item * B<char> => I<str> (default: " ")
Character to use for padding.
Character should have column width of 1. The default is space (ASCII 32).
=item * B<in> => I<any>
Input stream (e.g. array or filehandle).
=item * B<mb> => I<bool> (default: 0)
Whether to handle wide characters.
=item * B<out> => I<any>
Output stream (e.g. array or filehandle).
=item * B<trunc> => I<bool> (default: 0)
Whether to truncate text wider than specified width.
=item * B<width>* => I<int>
=back
Return value:
Returns an enveloped result (an array). First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Data-Unixish>.
=head1 SOURCE
Source repository is at L<https://github.com/sharyanto/perl-Data-Unixish>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website
L<https://rt.cpan.org/Public/Dist/Display.html?Name=Data-Unixish>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 AUTHOR
Steven Haryanto <stevenharyanto@gmail.com>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2013 by Steven Haryanto.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut