Getopt::Long::Util - Utilities for Getopt::Long
This document describes version 0.84 of Getopt::Long::Util (from Perl distribution Getopt-Long-Util), released on 2016-01-08.
Getopt::Long
Getopt::Long::Spec, which can also parse Getopt::Long spec into hash as well as transform back the hash to Getopt::Long spec. OO interface. I should've found this module first before writing my own parse_getopt_long_opt_spec(). But at least currently parse_getopt_long_opt_spec() is at least about 30-100+% faster than Getopt::Long::Spec::Parser, has a much simpler implementation (a single regex match), and can handle valid Getopt::Long specs that Getopt::Long::Spec::Parser fails to parse, e.g. foo|f=s@.
parse_getopt_long_opt_spec()
foo|f=s@
Detect whether a file is a Getopt::Long-based CLI script.
The criteria are:
the file must exist and readable;
(optional, if include_noexec is false) file must have its executable mode bit set;
include_noexec
content must start with a shebang #!;
#!
either: must be perl script (shebang line contains 'perl') and must contain something like use Getopt::Long;
use Getopt::Long
This function is not exported by default, but exportable.
Arguments ('*' denotes required arguments):
filename => str
Path to file to be checked.
Either filename or string must be specified.
filename
string
include_noexec => bool (default: 1)
Include scripts that do not have +x mode bit set.
string => buf
Either file or string must be specified.
file
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.
Return value: (any)
Convert Getopt::Long option specification like help|h|? or --foo=s or debug! into, respectively, --help, -h, -? or --foo=s or --(no)debug. Will die if can't parse the string. The output is suitable for including in help/usage text.
help|h|?
--foo=s
debug!
--help, -h, -?
--(no)debug
optspec* => str
Return value: (str)
Parse a single Getopt::Long option specification.
Examples:
Example #1:
parse_getopt_long_opt_spec( optspec => "help|h|?"); # -> { dash_prefix => "", opts => ["help", "h", "?"] }
Example #2:
parse_getopt_long_opt_spec( optspec => "--foo=s");
Result:
{ dash_prefix => "--", desttype => "", opts => ["foo"], type => "s" }
Will produce a hash with some keys:
is_arg (if true, then option specification is the special <> for argument callback)
is_arg
<>
opts (array of option names, in the order specified in the opt spec)
opts
type (string, type name)
type
desttype (either '', or '@' or '%'),
desttype
is_neg (true for --opt!)
is_neg
--opt!
is_inc (true for --opt+)
is_inc
--opt+
min_vals (int, usually 0 or 1)
min_vals
max_vals (int, usually 0 or 1 except for option that requires multiple values)
max_vals
Will return undef if it can't parse the string.
Return value: (hash)
Please visit the project's homepage at https://metacpan.org/release/Getopt-Long-Util.
Source repository is at https://github.com/perlancar/perl-Getopt-Long-Util.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Getopt-Long-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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2016 by 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.
To install Getopt::Long::Util, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Getopt::Long::Util
CPAN shell
perl -MCPAN -e shell install Getopt::Long::Util
For more information on module installation, please visit the detailed CPAN module installation guide.