package Data::Unixish::wrap; use 5.010; use strict; use syntax 'each_on_array'; # to support perl < 5.12 use warnings; #use Log::Any '$log'; use Data::Unixish::Util qw(%common_args); use Text::ANSI::Util qw(ta_wrap); use Text::ANSI::WideUtil qw(ta_mbwrap); use Text::WideChar::Util qw(mbwrap); our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY our $DATE = '2025-02-24'; # DATE our $DIST = 'Data-Unixish'; # DIST our $VERSION = '1.574'; # VERSION our %SPEC; $SPEC{wrap} = { v => 1.1, summary => 'Wrap text', args => { %common_args, width => { summary => 'Target column width', schema =>[int => {default=>80, min=>1}], cmdline_aliases => { c=>{} }, pos => 0, }, ansi => { summary => 'Whether to handle ANSI escape codes', schema => ['bool', default => 0], }, mb => { summary => 'Whether to handle wide characters', schema => ['bool', default => 0], }, }, tags => [qw/text itemfunc/], }; sub wrap { my %args = @_; my ($in, $out) = ($args{in}, $args{out}); _wrap_begin(\%args); while (my ($index, $item) = each @$in) { push @$out, _wrap_item($item, \%args); } [200, "OK"]; } sub _wrap_begin { my $args = shift; $args->{width} //= 80; } sub _wrap_item { my ($item, $args) = @_; { last if !defined($item) || ref($item); if ($args->{ansi}) { if ($args->{mb}) { $item = ta_mbwrap($item, $args->{width}); } else { $item = ta_wrap ($item, $args->{width}); } } elsif ($args->{mb}) { $item = mbwrap($item, $args->{width}); } else { $item = Text::WideChar::Util::wrap($item, $args->{width}); } } return $item; } 1; # ABSTRACT: Wrap text __END__ =pod =encoding UTF-8 =head1 NAME Data::Unixish::wrap - Wrap text =head1 VERSION This document describes version 1.574 of Data::Unixish::wrap (from Perl distribution Data-Unixish), released on 2025-02-24. =head1 SYNOPSIS In Perl: use Data::Unixish qw(lduxl); $wrapped = lduxl([wrap => {width=>20}], "xxxx xxxx xxxx xxxx xxxx"); # "xxxx xxxx xxxx xxxx\nxxxx" In command line: % echo -e "xxxx xxxx xxxx xxxx xxxx" | dux wrap -c 20 xxxx xxxx xxxx xxxx xxxx =head1 FUNCTIONS =head2 wrap Usage: wrap(%args) -> [$status_code, $reason, $payload, \%result_meta] Wrap text. This function is not exported. Arguments ('*' denotes required arguments): =over 4 =item * B => I (default: 0) Whether to handle ANSI escape codes. =item * B => I Input stream (e.g. array or filehandle). =item * B => I (default: 0) Whether to handle wide characters. =item * B => I Output stream (e.g. array or filehandle). =item * B => I (default: 80) Target column width. =back Returns an enveloped result (an array). First element ($status_code) is an integer containing HTTP-like status code (200 means OK, 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like "OK" if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how HTTP response headers provide additional metadata. Return value: (any) =head1 HOMEPAGE Please visit the project's homepage at L. =head1 SOURCE Source repository is at L. =head1 SEE ALSO fmt(1) =head1 AUTHOR perlancar =head1 CONTRIBUTING To contribute, you can send patches by email/via RT, or send pull requests on GitHub. Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: % prove -l If you want to build the distribution (e.g. to try to install it locally on your system), you can install L, L, L, and sometimes one or two other Dist::Zilla- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. =head1 COPYRIGHT AND LICENSE This software is copyright (c) 2025 by perlancar . This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. =head1 BUGS Please report any bugs or feature requests on the bugtracker website L 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. =cut