File Coverage

blib/lib/Getopt/Long/Util.pm

Criterion	Covered	Total	%
statement	90	142	63.3
branch	64	102	62.7
condition	27	46	58.7
subroutine	7	10	70.0
pod	5	5	100.0
total	193	305	63.2

package Getopt::Long::Util;

use 5.010001;
use strict;
use warnings;

require Exporter;
our @ISA       = qw(Exporter);
our @EXPORT_OK = qw(
                       parse_getopt_long_opt_spec
                       humanize_getopt_long_opt_spec
                       detect_getopt_long_script
                       gen_getopt_long_spec_from_getopt_std_spec
                       array_getopt_long_spec_to_hash
               );

our $AUTHORITY = 'cpan:PERLANCAR'; # AUTHORITY
our $DATE = '2022-10-12'; # DATE
our $DIST = 'Getopt-Long-Util'; # DIST
our $VERSION = '0.898'; # VERSION

our %SPEC;

$SPEC{parse_getopt_long_opt_spec} = {
    v => 1.1,
    summary => 'Parse a single Getopt::Long option specification',
    description => <<'_',

Will produce a hash with some keys:

* `is_arg` (if true, then option specification is the special `<>` for argument
  callback)
* `opts` (array of option names, in the order specified in the opt spec)
* `type` (string, type name)
* `desttype` (either '', or '@' or '%'),
* `is_neg` (true for `--opt!`)
* `is_inc` (true for `--opt+`)
* `min_vals` (int, usually 0 or 1)
* `max_vals` (int, usually 0 or 1 except for option that requires multiple
  values)

Will return undef if it can't parse the string.

_
    args => {
        optspec => {
            schema => 'str*',
            req => 1,
            pos => 0,
        },
    },
    args_as => 'array',
    result_naked => 1,
    result => {
        schema => 'hash*',
    },
    examples => [
        {
            args => {optspec => 'help|h|?'},
            result => {dash_prefix=>'', opts=>['help', 'h', '?']},
        },
        {
            args => {optspec=>'--foo=s'},
            result => {dash_prefix=>'--', opts=>['foo'], type=>'s', desttype=>''},
        },
    ],
};
# BEGIN_BLOCK: parse_getopt_long_opt_spec
sub parse_getopt_long_opt_spec {
    my $optspec = shift;
    return {is_arg=>1, dash_prefix=>'', opts=>[]}
        if $optspec eq '<>';
    $optspec =~ qr/\A
               (?P-{0,2})
               (?P[A-Za-z0-9_][A-Za-z0-9_-]*)
               (?P (?: \| (?:[^:|!+=:-][^:|!+=:]*) )*)?
               (?:
                   (?P!) |
                   (?P\+) |
                   (?:
                       =
                       (?P[siof])
                       (?P|[%@])?
                       (?:
                           \{
                           (?: (?P\d+), )?
                           (?P\d+)
                           \}
                       )?
                   ) |
                   (?:
                       :
                       (?P[siof])
                       (?P|[%@])?
                   ) |
                   (?:
                       :
                       (?P-?\d+)
                       (?P|[%@])?
                   ) |
                   (?:
                       :
                       (?P\+)
                       (?P|[%@])?
                   )
               )?
               \z/x
                   or return;
    my %res = %+;

    if (defined $res{optnum}) {
        $res{type} = 'i';
    }

    if ($res{aliases}) {
        my @als;
        for my $al (split /\|/, $res{aliases}) {
            next unless length $al;
            next if $al eq $res{name};
            next if grep {$_ eq $al} @als;
            push @als, $al;
        }
        $res{opts} = [$res{name}, @als];
    } else {
        $res{opts} = [$res{name}];
    }
    delete $res{name};
    delete $res{aliases};

    $res{is_neg} = 1 if $res{is_neg};
    $res{is_inc} = 1 if $res{is_inc};

    \%res;
}
# END_BLOCK: parse_getopt_long_opt_spec

$SPEC{humanize_getopt_long_opt_spec} = {
    v => 1.1,
    description => <<'_',

Convert  option specification into a more human-friendly
notation that is suitable for including in help/usage text, for example:

    help|h|?       ->  "--help, -h, -?"
    help|h|?       ->  "--help | -h | -?"               # if you provide 'separator'
    --foo=s        ->  "--foo=s"
    --foo=s        ->  "--foo=somelabel"                # if you provide 'value_label'
    --foo:s        ->  "--foo[=s]"
    --foo=s@       ->  "(--foo=s)+"
    --foo=s%       ->  "(--foo key=value)+"
    --foo=s%       ->  "(--foo somelabel1=somelabel2)+" # if you provide 'key_label' and 'value_label'
    --debug!       ->  "--(no)debug"

It also produces POD-formatted string for use in POD documentation:

    --foo=s        ->  {plaintext=>"--foo=s", pod=>"B<--foo>=I"}
                                                        # if you set 'extended' to true

Will die if can't parse the optspec string.

_
    args => {
        optspec => {
            schema => 'str*',
            req => 1,
            pos => 0,
        },
        separator => {
            schema => 'str*',
            default => ', ',
        },
        key_label => {
            schema => 'str*',
            default => 'key',
        },
        opt_link => {
            schema => 'str*', # XXX url? podlink?
        },
        value_label => {
            schema => 'str*',
        },
        value_label_link => {
            schema => 'str*', # XXX url? podlink?
        },
        extended => {
            summary => 'If set to true, will return a hash of multiple formats instead of a single plaintext format',
            schema => 'bool*',
        },
    },
    args_as => 'array',
    result_naked => 1,
    result => {
        schema => ['any*', {of=>[['str*'], ['hash*', {of=>'str*'}]]}],
    },
};
sub humanize_getopt_long_opt_spec {
    my $opts = {}; $opts = shift if ref $_[0] eq 'HASH';
    my $optspec = shift;

    my $parse = parse_getopt_long_opt_spec($optspec)
        or die "Can't parse opt spec $optspec";

    return "argument" if $parse->{is_arg};

    my $plain_res = '';
    my $pod_res   = '';
    my $i = 0;
    for (@{ $parse->{opts} }) {
        $i++;
        my $opt_plain_res = '';
        my $opt_pod_res   = '';
        if ($parse->{is_neg} && length($_) > 1) {
            $opt_plain_res .= "--(no)$_";
            $opt_pod_res   .= defined($opts->{opt_link}) ? "L<--(no)$_|$opts->{opt_link}>" : "B<--(no)$_>";
        } else {
            if (length($_) > 1) {
                $opt_plain_res .= "--$_";
                $opt_pod_res   .= defined($opts->{opt_link}) ? "L<--$_|$opts->{opt_link}>" : "B<--$_>";
            } else {
                $opt_plain_res .= "-$_";
                $opt_pod_res   .= defined($opts->{opt_link}) ? "L<-$_|$opts->{opt_link}>" : "B<-$_>";
            }
            if ($i==1 && ($parse->{type} || $parse->{opttype})) {
                # show value label
                my $key_label = $opts->{key_label} // 'key';
                my $value_label = $opts->{value_label} //
                    $parse->{type} // $parse->{opttype};

                $opt_plain_res .= "[" if $parse->{opttype};
                $opt_plain_res .= ($parse->{type} && $parse->{desttype} eq '%' ? " " : "=");
                $opt_plain_res .= "$key_label=" if $parse->{desttype} eq '%';
                $opt_plain_res .= $value_label;
                $opt_plain_res .= "]" if $parse->{opttype};

                $opt_pod_res   .= "[" if $parse->{opttype};
                $opt_pod_res   .= ($parse->{type} && $parse->{desttype} eq '%' ? " " : "=");
                $opt_pod_res   .= "I<$key_label>=" if $parse->{desttype} eq '%';
                $opt_pod_res   .= defined $opts->{value_label_link} ? "L<$value_label|$opts->{value_label_link}>" : "I<$value_label>";
                $opt_pod_res   .= "]" if $parse->{opttype};
            }
            $opt_plain_res = "($opt_plain_res)+" if ($parse->{desttype} // '') =~ /@|%/;
            $opt_pod_res   = "($opt_pod_res)+"   if ($parse->{desttype} // '') =~ /@|%/;
        }

        $plain_res .= ($opts->{separator} // ", ") if length($plain_res);
        $pod_res   .= ($opts->{separator} // ", ") if length($pod_res);

        $plain_res .= $opt_plain_res;
        $pod_res   .= $opt_pod_res;
    }

    if ($opts->{extended}) {
        return {
            plaintext => $plain_res,
            pod => $pod_res,
        };
    } else {
        $plain_res;
    }
}

$SPEC{detect_getopt_long_script} = {
    v => 1.1,
    summary => 'Detect whether a file is a Getopt::Long-based CLI script',
    description => <<'_',

The criteria are:

* the file must exist and readable;

* (optional, if `include_noexec` is false) file must have its executable mode
  bit set;

* content must start with a shebang C<#!>;

* either: must be perl script (shebang line contains 'perl') and must contain
  something like `use Getopt::Long`;

_
    args => {
        filename => {
            summary => 'Path to file to be checked',
            schema => 'str*',
            pos => 0,
            cmdline_aliases => {f=>{}},
        },
        string => {
            summary => 'String to be checked',
            schema => 'buf*',
        },
        include_noexec => {
            summary => 'Include scripts that do not have +x mode bit set',
            schema  => 'bool*',
            default => 1,
        },
    },
    args_rels => {
        'req_one' => ['filename', 'string'],
    },
};
sub detect_getopt_long_script {
    my %args = @_;

    (defined($args{filename}) xor defined($args{string}))
        or return [400, "Please specify either filename or string"];
    my $include_noexec  = $args{include_noexec}  // 1;

    my $yesno = 0;
    my $reason = "";
    my %extrameta;

    my $str = $args{string};
  DETECT:
    {
        if (defined $args{filename}) {
            my $fn = $args{filename};
            unless (-f $fn) {
                $reason = "'$fn' is not a file";
                last;
            };
            if (!$include_noexec && !(-x _)) {
                $reason = "'$fn' is not an executable";
                last;
            }
            my $fh;
            unless (open $fh, "<", $fn) {
                $reason = "Can't be read";
                last;
            }
            # for efficiency, we read a bit only here
            read $fh, $str, 2;
            unless ($str eq '#!') {
                $reason = "Does not start with a shebang (#!) sequence";
                last;
            }
            my $shebang = <$fh>;
            unless ($shebang =~ /perl/) {
                $reason = "Does not have 'perl' in the shebang line";
                last;
            }
            seek $fh, 0, 0;
            {
                local $/;
                $str = <$fh>;
            }
            close $fh;
        }
        unless ($str =~ /\A#!/) {
            $reason = "Does not start with a shebang (#!) sequence";
            last;
        }
        unless ($str =~ /\A#!.*perl/) {
            $reason = "Does not have 'perl' in the shebang line";
            last;
        }

        # NOTE: the presence of \s* pattern after ^ causes massive slowdown of
        # the regex when we reach many thousands of lines, so we use split()

        #if ($str =~ /^\s*(use|require)\s+(Getopt::Long(?:::Complete)?)(\s|;)/m) {
        #    $yesno = 1;
        #    $extrameta{'func.module'} = $2;
        #    last DETECT;
        #}

        for (split /^/, $str) {
            if (/^\s*(use|require)\s+(Getopt::Long(?:::Complete|::Less|::EvenLess)?)(\s|;|$)/) {
                $yesno = 1;
                $extrameta{'func.module'} = $2;
                last DETECT;
            }
        }

        $reason = "Can't find any statement requiring Getopt::Long(?::Complete|::Less|::EvenLess)? module";
    } # DETECT

    [200, "OK", $yesno, {"func.reason"=>$reason, %extrameta}];
}

$SPEC{gen_getopt_long_spec_from_getopt_std_spec} = {
    v => 1.1,
    summary => 'Generate Getopt::Long spec from Getopt::Std spec',
    args => {
        spec => {
            summary => 'Getopt::Std spec string',
            schema => 'str*',
            req => 1,
            pos => 0,
        },
        is_getopt => {
            summary => 'Whether to assume spec is for getopt() or getopts()',
            description => <<'_',

By default spec is assumed to be for getopts() instead of getopt(). This means
that for a spec like `abc:`, `a` and `b` don't take argument while `c` does. But
if `is_getopt` is true, the meaning of `:` is reversed: `a` and `b` take
arguments while `c` doesn't.

_
            schema => 'bool',
        },
    },
    result_naked => 1,
    result => {
        schema => 'hash*',
    },
};
sub gen_getopt_long_spec_from_getopt_std_spec {
    my %args = @_;

    my $is_getopt = $args{is_getopt};
    my $spec = {};

    while ($args{spec} =~ /(.)(:?)/g) {
        $spec->{$1 . ($is_getopt ? ($2 ? "" : "=s") : ($2 ? "=s" : ""))} =
            sub {};
    }

    $spec;
}

$SPEC{array_getopt_long_spec_to_hash} = {
    v => 1.1,
    summary => 'Convert array form of Getopt::Long spec to hash',
    description => <<'_',

's `GetOptions` function accepts a list of arguments. The first
optional argument is a hash for option storage. After that, a list of option
specs (e.g. `foo=s`), each optionally followed by a reference to specify
destination (e.g. a reference to scalar, or array, or code).

Die on failure (e.g. invalid option spec).

This routine converts that array into a hash of option specs as keys and
destinations as values. If an option spec does not have a destination, its
destination is set to `undef`. If hash storage is specified then the destination
will fall back to the hash storage's appropriate key when a specific destination
is not specified.

Note that by converting to hash, 1) duplicate option specs are merged; and 2)
order of option specs is not preserved.

_
    args => {
        spec => {
            summary => 'Getopt::Long spec',
            schema => 'array*',
            req => 1,
            pos => 0,
        },
    },
    args_as => 'array',
    result_naked => 1,
    result => {
        schema => 'hash*',
    },
};
sub array_getopt_long_spec_to_hash {
    my $go_spec = [ @_ ];
    my $hash_spec = {};

    my $hash_storage;
    $hash_storage = shift @$go_spec
        if @$go_spec && ref $go_spec->[0] eq 'HASH';

    while (@$go_spec) {
        my $opt_spec = shift @$go_spec;
        my $dest;
        if (@$go_spec && ref $go_spec->[0]) {
            $dest = shift @$go_spec;
        } elsif ($hash_storage) {
            my $res = parse_getopt_long_opt_spec($opt_spec)
                or die "Invalid option spec '$opt_spec'";
            my $name = $res->{opts}[0];
            $hash_storage->{$name} = undef unless exists $hash_storage->{$name};
            $dest = ref $hash_storage->{$name} ?
                $hash_storage->{$name} :
                \($hash_storage->{$name});
        }
        $hash_spec->{$opt_spec} = $dest;
    }

    $hash_spec;
}

1;
# ABSTRACT: Utilities for Getopt::Long

__END__