blib/lib/App/optex/up.pm

filter: Statementstmt 85.1% 109 / 128 Branchbran 76.0% 70 / 92 Conditioncond 55.5% 55 / 99 MC/DCmcdc 30.0% 15 / 50 Subroutinesub 90.9% 10 / 11 Podpod 0.0% 0 / 6 totaltotal 67.1% 259 / 386 CC 85 SCAR 50.3
CC
85
Cov
73%
finalize
199.7
pdf_size
12.0
less_features
6.1
CRAP 152.6
↑ Summary blib/lib/App/nup.pm »
1 package App::optex::up;
2  
3 74 our $VERSION = "1.18";
4  
5 =encoding utf-8
6  
7 =head1 NAME
8  
9 up - optex module for multi-column paged output
10  
11 =head1 SYNOPSIS
12  
13 optex -Mup command ...
14  
15 optex -Mup -C2 -- command ...
16  
17 optex -Mup -C2,2 -- command ...
18  
19 =head1 DESCRIPTION
20  
21 B<up> is a module for the B<optex> command that pipes the output
22 through L<App::ansicolumn> for multi-column formatting and a pager.
23 The name comes from the printing term "n-up" (2-up, 3-up, etc.) which
24 refers to printing multiple pages on a single sheet.
25  
26 The module automatically calculates the number of columns based on the
27 terminal width divided by the pane width (default 85 characters).
28 The terminal size is taken from the controlling terminal (C</dev/tty>);
29 when it is not available, the C<COLUMNS> environment variable gives the
30 width (default 80), and C<LINES> gives the height (default 24) used
31 when the number of rows is set, as in C<-C2,2>.
32  
33 Both stdout and stderr are merged and passed through the filter, so
34 error messages are also displayed in the multi-column paged output.
35  
36 The pager command is taken from the C<NUP_PAGER> environment variable
37 if set, otherwise defaults to C<less -F +Gg>. When page mode is
38 active, the C<NUP_PAGE_PAGER> environment variable is consulted
39 first.
40 The environment variables are named after the L<nup> command, a
41 wrapper for this module. The C<PAGER> variable is not used to avoid
42 an infinite loop when C<PAGER> is set to C<nup>. Use the C<--pager>
43 option to specify a different pager on the command line.
44  
45 The C<-F> option causes C<less> to exit immediately if the output
46 fits on one screen. C<+Gg> causes C<less> to read all input before
47 displaying, which may take time for large output, but prevents empty
48 trailing pages from being shown.
49 The C<--file-size> option of C<less> 590 (June 2021) and later does
50 the same as C<+Gg>; it is not the default because older versions,
51 such as the C<less> 581 that comes with macOS, do not have it and
52 print an error message for it. Set C<NUP_PAGER> to use it:
53  
54 export NUP_PAGER="less --file-size"
55  
56 =head1 OPTIONS
57  
58 Module options must be specified before C<--> separator.
59  
60 =over 4
61  
62 =item B<-C> I<C>[,I<R>], B<--pane>=I<C>[,I<R>]
63  
64 Set the number of columns (panes) directly, and the number of rows
65 when it is given after a comma. For example, C<-C2> creates 2
66 columns, and C<-C2,3> creates a 2-column, 3-row layout (6-up). The
67 page height is calculated by dividing the terminal height by the
68 number of rows.
69  
70 =item B<-R> I<N>, B<--row>=I<N>
71  
72 Set the number of rows.
73 This option is kept for compatibility and may be removed in the
74 future.
75  
76 =item B<-G> I<CxR>, B<--grid>=I<CxR>
77  
78 Set the grid layout. C<--grid=2x3> or C<--grid=2,3> is equivalent to
79 C<-C2,3>.
80 This option is kept for compatibility and may be removed in the
81 future.
82  
83 =item B<-S> I<N>, B<--pane-width>=I<N>
84  
85 Set the pane width in characters. Default is 85. When B<--pane> is
86 not specified, the number of panes is calculated by dividing the
87 terminal width by this value.
88  
89 =item B<--bs>=I<STYLE>, B<--border-style>=I<STYLE>
90  
91 Set the border style for ansicolumn. Default is C<heavy-box>.
92 See L<App::ansicolumn> for available styles.
93  
94 =item B<--no-paginate>
95  
96 Disable page mode. Without pagination, the entire content is
97 split evenly across columns. Page mode is the default.
98  
99 Note that L<App::ansicolumn> uses parallel layout when multiple
100 files are given, which has no page structure. Specify this option
101 in such cases so that C<NUP_PAGE_PAGER> is not used (the L<nup>
102 command does this automatically).
103  
104 =item B<-A>, B<--auto-paginate>
105  
106 Automatically disable page mode when only one column fits the
107 terminal.
108  
109 =item B<-L>, B<-->[B<no->]B<lateral>
110  
111 Put all the pages in one row, however wide it becomes. The screen
112 shows as many panes as without this option, as many as fit or the
113 number given by C<-C>, and the row goes on to the right: the panes
114 are given to C<ansicolumn> by their width (C<-S>), the width of the
115 screen divided by that number, in a very large output width.
116  
117 When the pager is C<less>, C<< -S --shift=I<N> --rscroll=- >> is
118 added to it, where I<N> is the width of a pane, so that the lines are
119 not wrapped and the arrow keys move by one page. Keys are added to
120 C<LESSKEY_CONTENT> (less 661 or later), after the keys of the user,
121 or those of C<NUP_LESSKEY> in their place, none when it is empty:
122 C<h> and C<l>, C<,> and C<.>, and ESC-( and ESC-), move by one page
123 as the arrow keys, C<H> and C<L> go to the left and the right end,
124 and so do C<g> and C<G>, C<E<lt>> and C<E<gt>>, and space and C<b>
125 move to the right and to the left by the panes on the screen, as do
126 C<j> and C<k> and the down and up arrows. With less 710 or
127 later, C<l>, C<.>, the right arrow and ESC-) stop at the right end.
128 The build of less in tecolicom/tap does more; see
129 L<nup/"LESS INTEGRATION">.
130  
131 With C<--no-paginate>, it is for the files side by side, as the
132 L<nup> command gives it for more than one file: each file is a column
133 of its own, the columns go on to the right, and only C<h>, C<l>, C<,>,
134 C<.>, the arrow keys, ESC-( and ESC-), C<H>, C<L>, C<E<lt>> and
135 C<E<gt>> are put in C<LESSKEY_CONTENT>. One input without pages
136 makes a column of each line.
137  
138 It cannot be used with rows (C<-R>, C<-C2,2>, C<-G>) or PDF output,
139 and C<--auto-paginate> is ignored.
140  
141 =item B<--pager>=I<COMMAND>
142  
143 Set the pager command, overriding the environment variables.
144 Default is C<NUP_PAGE_PAGER> (page mode only), C<NUP_PAGER>, or
145 C<less -F +Gg>.
146  
147 =item B<--no-pager>
148  
149 Disable pager. Output goes directly to stdout.
150  
151 =item B<--device>=I<DEVICE>, B<-T> I<DEVICE>
152  
153 Set the device to show the output on. The default is C<tty>, the
154 terminal. Any other device is a paper, and the output is printed to
155 PDF by C<ansi2pdf>. The name of a paper is the one for the C<-p>
156 option of C<ansi2pdf>, as C<a4> or C<a3>, and C<p> or C<l> after it
157 gives the orientation, as C<a4p> for A4 in portrait. A paper without
158 it is used in landscape. The device C<pdf> is the default paper of
159 C<ansi2pdf>.
160  
161 The size of a sheet of paper in columns and lines, which
162 C<ansi2pdf --geometry> tells, is used in place of the terminal size,
163 and C<ansi2pdf> is used in place of the pager. Each screen is
164 printed on a sheet as it is.
165  
166 =item B<--output>=I<FILE>, B<-o> I<FILE>
167  
168 Write the output to I<FILE>. When the name ends with C<.pdf>, the
169 output is PDF without C<--device> as well. Otherwise, what is shown
170 on the terminal is written to the file as it is, with the ANSI
171 sequences, and the pager is not used.
172  
173 The page height given by C<-P> (C<--page>) is the number of lines of
174 a page here too: a sheet has that many lines for each row. The width
175 given by C<-w> (C<--width>) is the number of columns of a sheet. The
176 font size follows them, and the one that is not given is decided to
177 fill the sheet. The default is 60 lines on a sheet.
178  
179 =item B<--geometry>
180  
181 Print the size of the device in columns and lines and its kind,
182 C<tty> or C<pdf>, as C<206 60 pdf>, and exit without running the
183 command. For a paper, the size is that of a sheet, which follows
184 C<--device>, C<--output>, C<--page>, C<--width>, the number of rows
185 and C<--pdf-opts>. For the terminal, it is the size of the terminal.
186  
187 =item B<--pdf-opts>=I<OPTIONS>
188  
189 Give other options to C<ansi2pdf>, such as C<-l 80> for the number
190 of lines on a sheet and C<-m 15> for the margin. They are given
191 after the paper, so they take precedence.
192  
193 =item B<--highlight>=I<NAME>
194  
195 When the command is C<ansicolumn>, give it the option
196 C<--highlight=>I<NAME>: the files are read through the highlighter of
197 the name, and shown with syntax highlight. The highlighters are the
198 modules of L<IO::Factotum::Highlight>: C<skylighting> (C<sky>) and
199 C<sourcehighlight> (C<gnu>). Nothing is done when the module of the
200 highlighter is not installed.
201  
202 =item Other options
203  
204 Any unrecognized options are passed through to L<App::ansicolumn>.
205 For example, C<--cm> option can be used to set colormap:
206  
207 optex -Mup --cm=BORDER=R -- command
208  
209 See L<App::ansicolumn> for available options.
210  
211 =back
212  
213 =head1 EXAMPLES
214  
215 Display perldoc output in multiple columns:
216  
217 optex -Mup perldoc App::optex::up
218  
219 =begin html
220  
221 <p><img width="750" src="https://raw.githubusercontent.com/tecolicom/App-nup/main/images/nup.png">
222  
223 =end html
224  
225 List files in multiple columns with pager:
226  
227 optex -Mup ls -l
228  
229 Use 2 columns:
230  
231 optex -Mup -C2 -- ls -l
232  
233 Set pane width to 100:
234  
235 optex -Mup -S100 -- ls -l
236  
237 Use 2x2 grid (4-up):
238  
239 optex -Mup -C2,2 -- ls -l
240  
241 No pagination:
242  
243 optex -Mup --no-paginate -- man perl
244  
245 Use a different border style:
246  
247 optex -Mup --bs=round-box -- ls -l
248  
249 Output without pager (useful for piping):
250  
251 optex -Mup --no-pager -C2 -- ls -l | head
252  
253 Truncate long lines:
254  
255 optex -Mup --ls=truncate -- ps aux
256  
257 =head1 INSTALL
258  
259 =head2 Homebrew
260  
261 Use L<tecolicom/tap|https://github.com/tecolicom/homebrew-tap>:
262  
263 brew tap tecolicom/tap
264 brew install app-nup
265  
266 =head2 CPANMINUS
267  
268 cpanm App::nup
269  
270 =head1 SEE ALSO
271  
272 L<App::nup>, L<https://github.com/tecolicom/App-nup>
273  
274 L<App::optex>, L<https://github.com/kaz-utashiro/optex>
275  
276 L<App::ansicolumn>
277  
278 =head1 AUTHOR
279  
280 Kazumasa Utashiro
281  
282 =head1 LICENSE
283  
284 Copyright 2025 Kazumasa Utashiro.
285  
286 This library is free software; you can redistribute it and/or modify
287 it under the same terms as Perl itself.
288  
289 =cut
290  
291 75 ▶use v5.16;
Subroutine BEGIN: called CC=1 SCAR=0.0
292 75 ▶use warnings;
Subroutine BEGIN: called CC=1 SCAR=0.0
293  
294 75 ▶use List::Util qw(max);
Subroutine BEGIN: called CC=1 SCAR=0.0
295 75 ▶use Getopt::EX::Config;
Subroutine BEGIN: called CC=1 SCAR=0.0
296 75 ▶use Term::ReadKey;
Subroutine BEGIN: called CC=1 SCAR=0.0
297  
298 63 ▶sub term_size {
Subroutine term_size: called CC=2 SCAR=7.6
Pod undocumented
299 63 my @size;
300 63 ▶ if (open my $tty, ">", "/dev/tty") {
Branch: 1 branch
BranchTrueFalseTotal
if (open my $tty, ">", "/dev/tty") 0 63 63
301 0 @size = GetTerminalSize $tty, $tty;
302 }
303 63 @size;
304 }
305  
306 215 ▶sub shell_escape {
Subroutine shell_escape: called CC=1 SCAR=0.0
Pod undocumented
307 215 $_[0] =~ s/([<>&|;'"\$`\\ ])/\\$1/gr;
308 }
309  
310 # Take the number given to an option (-X N, -XN, --name N, --name=N) out
311 # of the options for ansicolumn, and return it.
312 7 ▶sub take_option {
Subroutine take_option: called CC=6 SCAR=17.9
Pod undocumented
313 7 my($argv, $short, $long) = @_;
314 7 my $value;
315 7 ▶ for (my $i = 0; $i < @$argv; $i++) {
Branch: 1 branch
BranchTrueFalseTotal
if ($i < @$argv) 15 7 22
316 15 ▶ if ($argv->[$i] =~ /^(?:-$short|--$long)$/
Branch: 2 branches
BranchTrueFalseTotal
if ($argv->[$i] =~ /^(?:-$short|--$long)$/u and $i < $argv->$#* and $$argv[$i + 1] =~ /^\d+$/u) { } 3 12 15
elsif ($argv->[$i] =~ /^(?:-$short|--$long=)(\d+)$/u) { } 2 10 12
Condition83%5/6
$argv->[$i] =~ /^(?:-$short|--$long)$/u and $i < $argv->$#* and $$argv[$i + 1] =~ /^\d+$/u
!ll&&!rl&&r
1203
$argv->[$i] =~ /^(?:-$short|--$long)$/u and $i < $argv->$#*
!ll&&!rl&&r
1113
MC/DC66%2/3
$argv->[$i] =~ /^(?:-$short|--$long)$/u and $i < $argv->$#* and $$argv[$i + 1] =~ /^\d+$/u
$argv->[$i] =~ /^(?:-$short|--$long)$/u $i < $argv->$#* $$argv[$i + 1] =~ /^\d+$/u
Truth table75%3/4
A and B and C
A= $argv->[$i] =~ /^(?:-$short|--$long)$/uB= $i < $argv->$#*C= $$argv[$i + 1] =~ /^\d+$/u
ABCresult
0XX0
10X0
1100
1111
317 and $i < $#$argv and $argv->[$i + 1] =~ /^\d+$/) {
318 3 (undef, $value) = splice @$argv, $i--, 2;
319 }
320 elsif ($argv->[$i] =~ /^(?:-$short|--$long=)(\d+)$/) {
321 2 $value = $1;
322 2 splice @$argv, $i--, 1;
323 }
324 }
325 7 $value;
326 }
327  
328 74 my $config = Getopt::EX::Config->new(
329 'grid' => undef,
330 'pane-width' => 85,
331 'pane' => undef,
332 'row' => undef,
333 'border-style' => 'heavy-box',
334 'paginate' => 1,
335 'auto-paginate' => undef,
336 'lateral' => undef,
337 'pager' => undef,
338 'no-pager' => undef,
339 'device' => undef,
340 'output' => undef,
341 'pdf-opts' => '',
342 'geometry' => undef,
343 'highlight' => undef,
344 );
345  
346 # The number of panes that the row of --lateral has room for.
347 74 our $LATERAL_PANES = 10000;
348  
349 # What the less command knows: its version, and whether it has the
350 # --align-shift option of the build in tecolicom/tap. Both are told by
351 # one run with --version, since an unknown option does not make less
352 # fail, but only gives a message.
353 33 ▶sub less_features {
Subroutine less_features: called CC=6 SCAR=18.1
Pod undocumented
354 33 my $less = shift;
355 33 ▶ my $pid = open(my $fh, '-|') // return (0, 0);
Condition50%1/2
open(my $fh, "-|") // (return 0, 0)
l!l
330
MC/DC0%0/1
open(my $fh, "-|") // (return 0, 0)
open(my $fh, "-|")
Truth table50%1/2
A
A= open(my $fh, "-|")
Aresult
11
00
356 33 ▶ if ($pid == 0) {
Branch: 1 branch
BranchTrueFalseTotal
if ($pid == 0) 17 16 33
357 17 open STDERR, '>&', \*STDOUT;
358 17 open STDIN, '<', '/dev/null';
359 17 ▶ exec $less, '--align-shift', '--version' or exit 1;
Branch: 1 branch
BranchTrueFalseTotal
exec $less, "--align-shift", "--version" or exit 1 0 1 1
360 }
361 16 ▶ my $out = do { local $/; <$fh> } // '';
Condition50%1/2
do { local $/; readline $fh } // ""
l!l
160
MC/DC0%0/1
do { local $/; readline $fh } // ""
do { local $/; readline $fh }
Truth table50%1/2
A
A= do { local $/; readline $fh }
Aresult
11
00
362 16 close $fh;
363 16 ▶ my($version) = $out =~ /^less (\d+)/m or return (0, 0);
Branch: 1 branch
BranchTrueFalseTotal
my($version) = $out =~ /^less (\d+)/mu or return 0, 0 3 13 16
364 3 ($version, $out !~ /There is no -*align-shift option/);
365 }
366  
367 # Size of a sheet of paper in columns and lines, asked to ansi2pdf.
368 0 ▶sub pdf_size {
Subroutine pdf_size: not called CC=3 SCAR=24.8
Pod undocumented
369 0 my $command = shift;
370 0 ▶ my $geometry = qx($command --geometry) // '';
Condition0%0/2
`$command --geometry` // ""
l!l
00
MC/DC0%0/1
`$command --geometry` // ""
`$command --geometry`
Truth table0%0/2
A
A= `$command --geometry`
Aresult
11
00
371 0 ▶ $geometry =~ /^(\d+) (\d+)$/
Branch: 1 branch
BranchTrueFalseTotal
$geometry =~ /^(\d+) (\d+)$/u or die "Failed to get the page geometry from ansi2pdf.\n" 0 0 0
372 or die "Failed to get the page geometry from ansi2pdf.\n";
373 0 ($1, $2);
374 }
375  
376 73 ▶sub finalize {
Subroutine finalize: called CC=72 SCAR=53.0
Pod undocumented
377 73 my($mod, $argv) = @_;
378 73 $config->configure('pass_through')->deal_with($argv,
379 'grid|G=s', 'pane-width|S=i', 'pane|C=s', 'row|R=i',
380 'border-style|bs=s', 'paginate!',
381 'auto-paginate|autopaginate|A',
382 'lateral|L!',
383 'pager:s', 'no-pager|nopager',
384 'device|T=s', 'output|o=s',
385 'pdf-opts=s', 'geometry', 'highlight=s');
386 73 my @passthru = $config->argv;
387  
388 ##
389 ## Panes and rows: -C C[,R] and -G CxR
390 ##
391  
392 73 ▶ if (defined(my $pane = $config->{pane})) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined(my $pane = $config->{"pane"})) 14 59 73
393 14 ▶ my($c, $r) = $pane =~ /^(\d+)(?:,(\d+))?$/
Branch: 1 branch
BranchTrueFalseTotal
() = $pane =~ /^(\d+)(?:,(\d+))?$/u or die "Invalid pane format: $pane (expected C or C,R)\n" 10 4 14
394 or die "Invalid pane format: $pane (expected C or C,R)\n";
395 10 $config->{pane} = $c;
396 10 ▶ $config->{row} //= $r;
Condition100%3/3
$config->{"row"} //= $r
l!l&&r!l&&!r
136
MC/DC100%2/2
$config->{"row"} //= $r
$config->{"row"} $r
Truth table100%3/3
A //= B
A= $config->{"row"}B= $r
ABresult
1X1
011
000
397 }
398  
399 69 ▶ if (my $grid = $config->{grid}) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $grid = $config->{"grid"}) 5 64 69
400 5 ▶ my($c, $r) = $grid =~ /^(\d+)[x,](\d+)$/
Branch: 1 branch
BranchTrueFalseTotal
() = $grid =~ /^(\d+)[x,](\d+)$/u or die "Invalid grid format: $grid (expected CxR or C,R)\n" 4 1 5
401 or die "Invalid grid format: $grid (expected CxR or C,R)\n";
402 4 ▶ $config->{pane} //= $c;
Condition33%1/3
$config->{"pane"} //= $c
l!l&&r!l&&!r
040
MC/DC0%0/2
$config->{"pane"} //= $c
$config->{"pane"} $c
Truth table33%1/3
A //= B
A= $config->{"pane"}B= $c
ABresult
1X1
011
000
403 4 ▶ $config->{row} //= $r;
Condition33%1/3
$config->{"row"} //= $r
l!l&&r!l&&!r
040
MC/DC0%0/2
$config->{"row"} //= $r
$config->{"row"} $r
Truth table33%1/3
A //= B
A= $config->{"row"}B= $r
ABresult
1X1
011
000
404 }
405  
406 ##
407 ## Device: -T and -o
408 ##
409 ## The device is the terminal (tty), or a paper (a4, a4p, ... or
410 ## "pdf" for the default one). For a paper, a sheet takes the
411 ## place of the screen and ansi2pdf that of the pager. A file
412 ## name ending with .pdf chooses PDF by itself.
413 ##
414  
415 68 my $device = $config->{device};
416 68 my $output = $config->{output};
417 68 ▶ $device //= 'pdf' if defined $output and $output =~ /\.pdf$/i;
Branch: 1 branch
BranchTrueFalseTotal
if defined $output and $output =~ /\.pdf$/iu 1 67 68
Condition60%3/5
defined $output and $output =~ /\.pdf$/iu
!ll&&!rl&&r
6701
$device //= "pdf"
l!l
01
MC/DC50%1/2
defined $output and $output =~ /\.pdf$/iu
defined $output $output =~ /\.pdf$/iu
MC/DC0%0/1
$device //= "pdf"
$device
Truth table66%2/3
A and B
A= defined $outputB= $output =~ /\.pdf$/iu
ABresult
0X0
100
111
Truth table50%1/2
A
A= $device
Aresult
11
00
418 68 ▶ $device //= 'tty';
Condition100%2/2
$device //= "tty"
l!l
266
MC/DC100%1/1
$device //= "tty"
$device
Truth table100%2/2
A
A= $device
Aresult
11
00
419  
420 # -o with the terminal: write what would be shown on it
421 68 ▶ if (defined $output and $device eq 'tty' and not $config->{geometry}) {
Branch: 1 branch
BranchTrueFalseTotal
if (defined $output and $device eq "tty" and not $config->{"geometry"}) 0 68 68
Condition50%3/6
defined $output and $device eq "tty" and not $config->{"geometry"}
!ll&&!rl&&r
6800
defined $output and $device eq "tty"
!ll&&!rl&&r
6710
MC/DC0%0/3
defined $output and $device eq "tty" and not $config->{"geometry"}
defined $output $device eq "tty" not $config->{"geometry"}
Truth table50%2/4
A and B and not(C)
A= defined $outputB= $device eq "tty"C= not $config->{"geometry"}
ABCresult
0XX0
10X0
1100
1111
422 0 $config->{pager} = 'cat > ' . shell_escape($output);
423 0 $config->{'no-pager'} = undef;
424 }
425  
426 ##
427 ## --lateral
428 ##
429 ## All the pages are in one row, scrolled sideways by the pager.
430 ## Without pages (--no-paginate), each file is a column of the row.
431 ## There are no rows and no sheet of paper.
432 ##
433  
434 68 my $lateral = $config->{lateral};
435 68 ▶ if ($lateral) {
Branch: 1 branch
BranchTrueFalseTotal
if ($lateral) 39 29 68
436 39 ▶ my $with = defined $config->{row} ? 'the number of rows (-R, -C, -G)'
Branch: 2 branches
BranchTrueFalseTotal
defined $config->{'row'} ? : 3 36 39
$device ne 'tty' ? : 2 34 36
437 : $device ne 'tty' ? 'PDF output (-T, -o)'
438 : undef;
439 39 ▶ die "--lateral cannot be used with $with.\n" if $with;
Branch: 1 branch
BranchTrueFalseTotal
if $with 5 34 39
440 }
441  
442 ##
443 ## ansi2pdf command, for a paper
444 ##
445  
446 63 my $ansi2pdf;
447 63 ▶ if ($device ne 'tty') {
Branch: 1 branch
BranchTrueFalseTotal
if ($device ne "tty") 0 63 63
448 $ansi2pdf = join ' ', 'ansi2pdf -C1 --no-border -L',
449 ($device eq 'pdf' ? () : '-p ' . shell_escape($device)),
450 0 ▶ $config->{'pdf-opts'};
Branch: 1 branch
BranchTrueFalseTotal
$device eq 'pdf' ? : 0 0 0
451  
452 # -P (lines of a page) and -w (columns of a sheet) decide the
453 # size of a sheet; ansi2pdf decides the one not given. They
454 # are among the options of this module, or among the arguments
455 # of ansicolumn in file view mode (nup FILE -w 100).
456 0 ▶ my @lists = (\@passthru,
Branch: 1 branch
BranchTrueFalseTotal
@$argv && $argv->[0] eq 'ansicolumn' ? : 0 0 0
Condition0%0/3
@$argv and $argv->[0] eq "ansicolumn"
!ll&&!rl&&r
000
MC/DC0%0/2
@$argv and $argv->[0] eq "ansicolumn"
@$argv $argv->[0] eq "ansicolumn"
Truth table0%0/3
A and B
A= @$argvB= $argv->[0] eq "ansicolumn"
ABresult
0X0
100
111
457 @$argv && $argv->[0] eq 'ansicolumn' ? $argv : ());
458 0 my($page) = grep defined, reverse map take_option($_, 'P', 'page'), @lists;
459 0 my($width) = grep defined, reverse map take_option($_, 'w', 'width'), @lists;
460 0 ▶ $ansi2pdf .= ' -l ' . $page * ($config->{row} || 1) if $page;
Branch: 1 branch
BranchTrueFalseTotal
if $page 0 0 0
Condition0%0/2
$config->{'row'} || 1
l!l
00
MC/DC0%0/1
$config->{'row'} || 1
$config->{'row'}
Truth table0%0/2
A
A= $config->{'row'}
Aresult
11
00
461 0 ▶ $ansi2pdf .= " -w $width" if $width;
Branch: 1 branch
BranchTrueFalseTotal
if $width 0 0 0
462 }
463  
464 ##
465 ## Size of the screen or the sheet, and the layout in it
466 ##
467  
468 63 ▶ my($term_width, $term_height) = $ansi2pdf ? pdf_size($ansi2pdf) : term_size();
Branch: 1 branch
BranchTrueFalseTotal
$ansi2pdf ? : 0 63 63
469 63 ▶ $term_width ||= $ENV{COLUMNS} || 80;
Condition40%2/5
$term_width ||= $ENV{"COLUMNS"} || 80
l!l&&r!l&&!r
0630
$ENV{'COLUMNS'} || 80
l!l
063
MC/DC0%0/2
$term_width ||= $ENV{"COLUMNS"} || 80
$term_width $ENV{'COLUMNS'}
Truth table0%0/3
A ||= B
A= $term_widthB= $ENV{'COLUMNS'}
ABresult
1X1
011
000
470 63 ▶ $term_height ||= $ENV{LINES} || 24;
Condition40%2/5
$term_height ||= $ENV{"LINES"} || 24
l!l&&r!l&&!r
0630
$ENV{'LINES'} || 24
l!l
063
MC/DC0%0/2
$term_height ||= $ENV{"LINES"} || 24
$term_height $ENV{'LINES'}
Truth table0%0/3
A ||= B
A= $term_heightB= $ENV{'LINES'}
ABresult
1X1
011
000
471  
472 63 my $pane_width = $config->{'pane-width'};
473 63 ▶ my $cols = $config->{pane} // max(1, int($term_width / $pane_width));
Condition66%2/3
$config->{"pane"} // &max(1, int $term_width / $pane_width)
l!l&&r!l&&!r
12510
MC/DC0%0/2
$config->{"pane"} // &max(1, int $term_width / $pane_width)
$config->{"pane"} &max(1, int $term_width / $pane_width)
Truth table66%2/3
A // B
A= $config->{"pane"}B= &max(1, int $term_width / $pane_width)
ABresult
1X1
011
000
474 63 my $rows = $config->{row};
475 63 ▶ my $height = defined $rows ? int(($term_height - 1) / $rows) : undef;
Branch: 1 branch
BranchTrueFalseTotal
defined $rows ? : 7 56 63
476  
477 63 ▶ if ($ansi2pdf) {
Branch: 1 branch
BranchTrueFalseTotal
if ($ansi2pdf) 0 63 63
478 # a sheet has no line for the pager, and the pages fill it
479 0 ▶ $height = int($term_height / ($rows || 1));
Condition0%0/2
$rows || 1
l!l
00
MC/DC0%0/1
$rows || 1
$rows
Truth table0%0/2
A
A= $rows
Aresult
11
00
480 0 ▶ my $lines = $height * ($rows || 1);
Condition0%0/2
$rows || 1
l!l
00
MC/DC0%0/1
$rows || 1
$rows
Truth table0%0/2
A
A= $rows
Aresult
11
00
481 0 ▶ $config->{pager} = "$ansi2pdf -w $term_width -l $lines"
Branch: 1 branch
BranchTrueFalseTotal
defined $output ? : 0 0 0
482 . (defined $output ? ' -o ' . shell_escape($output) : '');
483 0 $config->{'no-pager'} = undef;
484 }
485  
486 ##
487 ## --geometry: print the size and the kind of the device, and exit
488 ##
489  
490 63 ▶ if ($config->{geometry}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($config->{"geometry"}) 3 60 63
491 3 ▶ my $lines = $ansi2pdf ? $height * ($rows || 1) : $term_height;
Branch: 1 branch
BranchTrueFalseTotal
$ansi2pdf ? : 0 3 3
Condition0%0/2
$rows || 1
l!l
00
MC/DC0%0/1
$rows || 1
$rows
Truth table0%0/2
A
A= $rows
Aresult
11
00
492 3 ▶ say join ' ', $term_width, $lines, $ansi2pdf ? 'pdf' : 'tty';
Branch: 1 branch
BranchTrueFalseTotal
$ansi2pdf ? : 0 3 3
493 3 exit 0;
494 }
495  
496 ##
497 ## Pager
498 ##
499  
500 60 my $border_style = $config->{'border-style'};
501 my $no_page = !$config->{paginate}
502 60 ▶ || ($config->{'auto-paginate'} && $cols <= 1 && !$lateral);
Condition44%4/9
!$config->{'paginate'} || $config->{'auto-paginate'} && $cols <= 1 && !$lateral
l!l&&r!l&&!r
5055
$config->{"auto-paginate"} and $cols <= 1 and not $lateral
!ll&&!rl&&r
5500
$config->{"auto-paginate"} and $cols <= 1
!ll&&!rl&&r
5500
MC/DC25%1/4
!$config->{'paginate'} || $config->{'auto-paginate'} && $cols <= 1 && !$lateral
!$config->{'paginate'} $config->{"auto-paginate"} $cols <= 1 not $lateral
Truth table40%2/5
not(A) || B and C and not(D)
A= !$config->{'paginate'}B= $config->{"auto-paginate"}C= $cols <= 1D= not $lateral
ABCDresult
1XXX1
01111
00XX0
010X0
01100
503  
504 # +Gg makes less read all the input first, so that -F and the
505 # percentage work. less 590 has --file-size for this, but the
506 # less 581 of macOS does not: +Gg is the default.
507 my $pager = $config->{pager} //
508 60 ▶ ((!$no_page && $ENV{NUP_PAGE_PAGER}) || $ENV{NUP_PAGER} || 'less -F +Gg');
Condition100%10/10
$config->{"pager"} // (!$no_page && $ENV{"NUP_PAGE_PAGER"} || $ENV{"NUP_PAGER"} || "less -F +Gg")
l!l
357
not $no_page and $ENV{"NUP_PAGE_PAGER"} or $ENV{"NUP_PAGER"} or "less -F +Gg"
l!l
3522
not $no_page and $ENV{"NUP_PAGE_PAGER"} or $ENV{"NUP_PAGER"}
l!l&&r!l&&!r
13422
not $no_page and $ENV{"NUP_PAGE_PAGER"}
!ll&&!rl&&r
5511
MC/DC100%1/1
$config->{"pager"} // (!$no_page && $ENV{"NUP_PAGE_PAGER"} || $ENV{"NUP_PAGER"} || "less -F +Gg")
$config->{"pager"}
Truth table100%2/2
A
A= $config->{"pager"}
Aresult
11
00
509  
510 ##
511 ## --lateral with less: options and keys
512 ##
513 ## less shows the row without wrapping (-S), and shifts it by the
514 ## width of a pane (--shift). --rscroll=- shows the text in the
515 ## last column, where less puts a mark for the lines that go on.
516 ##
517 ## What less can do, by its version:
518 ##
519 ## 661 reads LESSKEY_CONTENT (an older one ignores it, and H is
520 ## the help as usual)
521 ## 710 has right-limit-scroll, which stops at the right end (an
522 ## older one takes the name for an error: use right-scroll)
523 ## tap the build in tecolicom/tap has --align-shift, which keeps
524 ## the shift at the boundaries of the panes
525 ##
526  
527 60 my $lateral_width = max(1, int($term_width / $cols));
528  
529 60 ▶ if ($lateral and $pager =~ m{^\s*((?:\S*/)?less)(?:\s|$)}) {
Branch: 1 branch
BranchTrueFalseTotal
if ($lateral and $pager =~ m[^\s*((?:\S*/)?less)(?:\s|$)]u) 33 27 60
Condition100%3/3
$lateral and $pager =~ m[^\s*((?:\S*/)?less)(?:\s|$)]u
!ll&&!rl&&r
26133
MC/DC100%2/2
$lateral and $pager =~ m[^\s*((?:\S*/)?less)(?:\s|$)]u
$lateral $pager =~ m[^\s*((?:\S*/)?less)(?:\s|$)]u
Truth table100%3/3
A and B
A= $lateralB= $pager =~ m[^\s*((?:\S*/)?less)(?:\s|$)]u
ABresult
0X0
100
111
530 33 my($version, $align_shift) = less_features($1);
531  
532 16 $pager .= " -S --shift=$lateral_width --rscroll=-";
533 16 ▶ $pager .= " --align-shift" if $align_shift;
Branch: 1 branch
BranchTrueFalseTotal
if $align_shift 1 15 16
534  
535 # one page to the right: l, ., the right arrow and ESC-)
536 16 ▶ my $right = $version >= 710 ? 'right-limit-scroll' : 'right-scroll';
Branch: 1 branch
BranchTrueFalseTotal
$version >= 710 ? : 2 14 16
537  
538 # The panes on the screen to the right and to the left: space
539 # and b. With --align-shift, it is a count given to the key;
540 # without, a count would change the shift, so the key is typed
541 # as many times. The key is ESC-) or ESC-(, because the arrow
542 # keys cannot be written in the string of noaction.
543 16 my $n = max(1, int($term_width / $lateral_width));
544 16 ▶ my($fwd, $back) = map { $align_shift ? "$n$_" : $_ x $n } '\e)', '\e(';
Branch: 1 branch
BranchTrueFalseTotal
$align_shift ? : 2 30 32
545  
546 # The right end: G and >. With --align-shift, the count makes
547 # the last screen the same as without --lateral.
548 16 ▶ my $end = $align_shift ? "noaction ${n}L" : 'end-scroll';
Branch: 1 branch
BranchTrueFalseTotal
$align_shift ? : 1 15 16
549  
550 # NUP_LESSKEY gives the keys in place of these; an empty one
551 # gives none.
552 my $keys = $ENV{NUP_LESSKEY} // join ';',
553  
554 # one page: h l , . and the arrows
555 "h left-scroll;l $right;, left-scroll;. $right",
556 "\\kl left-scroll;\\kr $right;\\e( left-scroll;\\e) $right",
557  
558 # the ends of the row
559 "H no-scroll;L end-scroll",
560  
561 $config->{paginate} ? (
562  
563 # with pages: g G < > go to the ends as H and L
564 16 ▶ "g no-scroll;G $end;< no-scroll;> $end",
Branch: 1 branch
BranchTrueFalseTotal
$config->{'paginate'} ? : 10 2 12
Condition100%2/2
$ENV{"NUP_LESSKEY"} // join(";", "h left-scroll;l $right;, left-scroll;. $right", "\\kl left-scroll;\\kr $right;\\e( left-scroll;\\e) $right", "H no-scroll;L end-scroll", $config->{"paginate"} ? ("g no-scroll;G $end;< no-scroll;> $end", "\\ noaction $fwd;b noaction $back", "j noaction $fwd;k noaction $back", "\\kd noaction $fwd;\\ku noaction $back") : "< no-scroll;> end-scroll")
l!l
412
MC/DC100%1/1
$ENV{"NUP_LESSKEY"} // join(";", "h left-scroll;l $right;, left-scroll;. $right", "\\kl left-scroll;\\kr $right;\\e( left-scroll;\\e) $right", "H no-scroll;L end-scroll", $config->{"paginate"} ? ("g no-scroll;G $end;< no-scroll;> $end", "\\ noaction $fwd;b noaction $back", "j noaction $fwd;k noaction $back", "\\kd noaction $fwd;\\ku noaction $back") : "< no-scroll;> end-scroll")
$ENV{"NUP_LESSKEY"}
Truth table100%2/2
A
A= $ENV{"NUP_LESSKEY"}
Aresult
11
00
565  
566 # the panes on the screen: space and b, and the keys
567 # to go down and up, since a page has the height of
568 # the screen and there is nothing below it
569 "\\ noaction $fwd;b noaction $back",
570 "j noaction $fwd;k noaction $back",
571 "\\kd noaction $fwd;\\ku noaction $back",
572  
573 ) : (
574  
575 # without pages: the columns go on downward, and the
576 # keys move up and down as usual. g and G are the
577 # first and the last line; < and > go to the ends.
578 "< no-scroll;> end-scroll",
579  
580 );
581  
582 # The keys go after those of the user, in a #command section
583 # of their own: the later of the same keys wins, and the keys
584 # of ~/.lesskey are read before LESSKEY_CONTENT.
585 16 ▶ if ($keys ne '') {
Branch: 1 branch
BranchTrueFalseTotal
if ($keys ne "") 14 2 16
586 14 ▶ my $user = $ENV{LESSKEY_CONTENT} // '';
Condition100%2/2
$ENV{"LESSKEY_CONTENT"} // ""
l!l
212
MC/DC100%1/1
$ENV{"LESSKEY_CONTENT"} // ""
$ENV{"LESSKEY_CONTENT"}
Truth table100%2/2
A
A= $ENV{"LESSKEY_CONTENT"}
Aresult
11
00
587 14 ▶ $ENV{LESSKEY_CONTENT} = $user eq '' ? $keys : "$user\n#command\n$keys";
Branch: 1 branch
BranchTrueFalseTotal
$user eq '' ? : 12 2 14
588 }
589 }
590  
591 ##
592 ## ansicolumn options
593 ##
594 ## With --lateral, the panes are given by their width in a row
595 ## wide enough for any number of them: ansicolumn puts all the
596 ## pages in one row.
597 ##
598  
599 43 ▶ my @ac_opts = ("--bs=$border_style", "--cm=BORDER=L13", "-DBP",
Branch: 1 branch
BranchTrueFalseTotal
$lateral ? : 17 26 43
600 $lateral ? ("-w" . $lateral_width * $LATERAL_PANES, "-S$lateral_width")
601 : ("-w$term_width", "-C$cols"));
602 43 ▶ push @ac_opts, "--height=$height" if defined $height;
Branch: 1 branch
BranchTrueFalseTotal
if defined $height 7 36 43
603 43 ▶ push @ac_opts, "--no-page" if $no_page;
Branch: 1 branch
BranchTrueFalseTotal
if $no_page 3 40 43
604 43 push @ac_opts, @passthru;
605  
606 ##
607 ## The command is ansicolumn (file view mode of nup): give it the
608 ## options, and filter its output by the pager
609 ##
610  
611 43 ▶ if (@$argv && $argv->[0] eq 'ansicolumn') {
Branch: 1 branch
BranchTrueFalseTotal
if (@$argv and $argv->[0] eq "ansicolumn") 3 40 43
Condition66%2/3
@$argv and $argv->[0] eq "ansicolumn"
!ll&&!rl&&r
0403
MC/DC50%1/2
@$argv and $argv->[0] eq "ansicolumn"
@$argv $argv->[0] eq "ansicolumn"
Truth table66%2/3
A and B
A= @$argvB= $argv->[0] eq "ansicolumn"
ABresult
0X0
100
111
612  
613 # --highlight=NAME: ansicolumn reads the files through the
614 # highlighter (IO::Factotum::Highlight::NAME). Without the
615 # module of the name, ansicolumn fails by the option: look
616 # for it, without loading.
617 3 ▶ if (my $name = $config->{highlight}) {
Branch: 1 branch
BranchTrueFalseTotal
if (my $name = $config->{"highlight"}) 2 1 3
618 2 my $module = "IO/Factotum/Highlight/$name.pm";
619 unshift @ac_opts, "--highlight=$name"
620 if $name =~ /\A\w+\z/
621 2 ▶ and grep { !ref and -f "$_/$module" } @INC;
Branch: 1 branch
BranchTrueFalseTotal
if $name =~ /\A\w+\z/u and grep {not ref $_ and -f "$_/$module";} @INC 2 0 2
Condition50%3/6
$name =~ /\A\w+\z/u and grep {not ref $_ and -f "$_/$module";} @INC
!ll&&!rl&&r
002
!ref($_) && -f "$_/$module"
!ll&&!rl&&r
0204
MC/DC0%0/2
$name =~ /\A\w+\z/u and grep {not ref $_ and -f "$_/$module";} @INC
$name =~ /\A\w+\z/u grep {not ref $_ and -f "$_/$module";} @INC
MC/DC50%1/2
!ref($_) && -f "$_/$module"
!ref($_) -f "$_/$module"
Truth table33%1/3
A and B
A= $name =~ /\A\w+\z/uB= grep {not ref $_ and -f "$_/$module";} @INC
ABresult
0X0
100
111
Truth table66%2/3
not(A) && B
A= !ref($_)B= -f "$_/$module"
ABresult
0X0
100
111
622 }
623  
624 # the options go before those of the user, which win
625 3 splice @$argv, 1, 0, @ac_opts;
626  
627 3 ▶ if ($config->{'no-pager'} || $pager eq '') {
Branch: 1 branch
BranchTrueFalseTotal
if ($config->{"no-pager"} or $pager eq "") 3 0 3
Condition33%1/3
$config->{"no-pager"} or $pager eq ""
l!l&&r!l&&!r
300
MC/DC0%0/2
$config->{"no-pager"} or $pager eq ""
$config->{"no-pager"} $pager eq ""
Truth table33%1/3
A or B
A= $config->{"no-pager"}B= $pager eq ""
ABresult
1X1
011
000
628 3 return; # No filter needed
629 }
630 0 $mod->setopt(default => "-Mutil::filter --of='$pager' --ef='>&1'");
631 0 return;
632 }
633  
634 ##
635 ## Any other command: filter its output by ansicolumn and the pager
636 ##
637  
638 40 my $column = join ' ', 'ansicolumn', map { shell_escape($_) } @ac_opts;
639 40 ▶ my $filter = ($config->{'no-pager'} || $pager eq '') ? $column : "$column|$pager";
Branch: 1 branch
BranchTrueFalseTotal
$config->{'no-pager'} || $pager eq '' ? : 17 23 40
Condition66%2/3
$config->{"no-pager"} or $pager eq ""
l!l&&r!l&&!r
17023
MC/DC50%1/2
$config->{"no-pager"} or $pager eq ""
$config->{"no-pager"} $pager eq ""
Truth table66%2/3
A or B
A= $config->{"no-pager"}B= $pager eq ""
ABresult
1X1
011
000
640 40 $mod->setopt(default => "-Mutil::filter --of='$filter' --ef='>&1'");
641 }
642  
643 74 1;
↑ Summary blib/lib/App/nup.pm »