1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
package Progress::Any::Output;
use 5.010001;
use strict;
use warnings;
require Progress::Any;
our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2022-10-18'; # DATE
our $DIST = 'Progress-Any'; # DIST
our $VERSION = '0.220'; # VERSION
sub import {
my $self = shift;
__PACKAGE__->set(@_) if @_;
}
sub _set_or_add {
my $class = shift;
my $which = shift;
my $opts;
if (@_ && ref($_[0]) eq 'HASH') {
$opts = {%{shift()}}; # shallow copy
} else {
$opts = {};
}
# allow adding options via -name => val syntax, for ease in using via -M in
# one-liners.
while (1) {
last unless @_ && $_[0] =~ /\A-(.+)/;
$opts->{$1} = $_[1];
splice @_, 0, 2;
}
my $output = shift or die "Please specify output name";
$output =~ /\A(?:\w+(::\w+)*)?\z/ or die "Invalid output syntax '$output'";
my $task = $opts->{task} // "";
my $outputo;
unless (ref $outputo) {
(my $outputpm = "$output.pm") =~ s!::!/!g;
require "Progress/Any/Output/$outputpm"; ## no critic: Modules::RequireBarewordIncludes
$outputo = "Progress::Any::Output::$output"->new(@_);
}
if ($which eq 'set') {
$Progress::Any::outputs{$task} = [$outputo];
} else {
$Progress::Any::outputs{$task} //= [];
push @{ $Progress::Any::outputs{$task} }, $outputo;
}
$outputo;
}
sub set {
my $class = shift;
$class->_set_or_add('set', @_);
}
sub add {
my $class = shift;
$class->_set_or_add('add', @_);
}
1;
# ABSTRACT: Assign output to progress indicators
__END__
=pod
=encoding UTF-8
=head1 NAME
Progress::Any::Output - Assign output to progress indicators
=head1 VERSION
This document describes version 0.220 of Progress::Any::Output (from Perl distribution Progress-Any), released on 2022-10-18.
=head1 SYNOPSIS
In your application:
use Progress::Any::Output;
Progress::Any::Output->set('TermProgressBarColor');
or:
use Progress::Any::Output 'TermProgressBarColor';
To give parameters to output:
use Progress::Any::Output;
Progress::Any::Output->set('TermProgressBarColor', width=>50, ...);
or:
use Progress::Any::Output 'TermProgressBarColor', width=>50, ...;
To assign output to a certain (sub)task:
use Progress::Any::Output -task => "main.download", 'TermMessage';
or:
use Progress::Any::Output;
Progress::Any::Output->set({task=>'main.download'}, 'TermMessage');
To add additional output, use C<add()> instead of C<set()>.
=head1 DESCRIPTION
See L<Progress::Any> for overview.
=head1 METHODS
=head2 Progress::Any::Output->set([ \%opts ], $output[, @args]) => obj
Set (or replace) output. Will load and instantiate
C<Progress::Any::Output::$output>. To only set output for a certain (sub)task,
set C<%opts> to C<< { task => $task } >>. C<@args> will be passed to output
module's constructor.
Return the instantiated object.
If C<$output> is an object (a reference, really), it will be used as-is.
=head2 Progress::Any::Output->add([ \%opts ], $output[, @args])
Like set(), but will add output instead of replace existing one(s).
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Progress-Any>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Progress-Any>.
=head1 SEE ALSO
L<Progress::Any>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=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<Dist::Zilla>,
L<Dist::Zilla::PluginBundle::Author::PERLANCAR>,
L<Pod::Weaver::PluginBundle::Author::PERLANCAR>, 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) 2022, 2020, 2018, 2015, 2014, 2013, 2012 by perlancar <perlancar@cpan.org>.
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<https://rt.cpan.org/Public/Dist/Display.html?Name=Progress-Any>
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
|
