—package
ShellCompleter::Util;
use
5.010001;
use
strict;
use
warnings;
our
$AUTHORITY
=
'cpan:PERLANCAR'
;
# AUTHORITY
our
$DATE
=
'2024-07-09'
;
# DATE
our
$DIST
=
'ShellCompleter-Util'
;
# DIST
our
$VERSION
=
'0.032'
;
# VERSION
our
@EXPORT_OK
=
qw(
run_shell_completer_for_getopt_long_app
)
;
sub
_complete {
my
(
$comp0
,
$args
) =
@_
;
my
$comp
;
if
(
ref
(
$comp0
) eq
'HASH'
) {
$comp
=
$comp0
->{completion};
}
else
{
$comp
=
$comp0
;
}
if
(
ref
(
$comp
) eq
'ARRAY'
) {
return
Complete::Util::complete_array_elem(
array
=>
$comp
,
word
=>
$args
->{word},
);
}
elsif
(
ref
(
$comp
) eq
'CODE'
) {
return
$comp
->(
%$args
);
}
else
{
return
;
}
}
sub
run_shell_completer_for_getopt_long_app {
my
%f_args
=
@_
;
unless
(
$ENV
{GETOPT_LONG_DUMP} ||
$ENV
{COMP_LINE} ||
$ENV
{COMMAND_LINE}) {
die
"Please run the script under shell completion\n"
;
}
Getopt::Long::Complete::GetOptionsWithCompletion(
sub
{
my
%c_args
=
@_
;
my
$word
=
$c_args
{word};
my
$type
=
$c_args
{type};
if
(
$type
eq
'arg'
) {
return
_complete(
$f_args
{
'{arg}'
}, \
%c_args
);
}
elsif
(
$type
eq
'optval'
) {
return
unless
$c_args
{ospec};
return
_complete(
$f_args
{
$c_args
{ospec} }, \
%c_args
);
}
undef
;
},
map
{
$_
=>
sub
{}}
grep
{
$_
ne
'{arg}'
}
keys
%f_args
,
);
}
1;
# ABSTRACT: Utility routines for App::ShellCompleter::*
__END__
=pod
=encoding UTF-8
=head1 NAME
ShellCompleter::Util - Utility routines for App::ShellCompleter::*
=head1 VERSION
This document describes version 0.032 of ShellCompleter::Util (from Perl distribution ShellCompleter-Util), released on 2024-07-09.
=head1 SYNOPSIS
=head1 DESCRIPTION
B<This module will be replaced by the newer Shell::Completer when it is ready.>
This module provides utility routines for C<App::ShellCompleter::*>
applications.
=head1 FUNCTIONS
=head2 run_shell_completer_for_getopt_long_app(%go_spec)
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/ShellCompleter-Util>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-ShellCompleter-Util>.
=head1 SEE ALSO
C<App::ShellCompleter::*> modules which use this module, e.g.
L<App::ShellCompleter::mpv>.
L<Getopt::Long::Complete>
=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) 2024, 2018, 2016, 2015 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=ShellCompleter-Util>
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