.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perinci::Sub::Util::Args 3pm"
.TH Perinci::Sub::Util::Args 3pm 2024-05-26 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perinci::Sub::Util::Args \- Utility routines related to Rinci arguments
.SH VERSION
.IX Header "VERSION"
This document describes version 0.472 of Perinci::Sub::Util::Args (from Perl distribution Perinci-Sub-Util), released on 2023\-10\-28.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\& package MyPackage;
\&
\& use Perinci::Sub::Util::Args qw(
\&     args_by_tag
\&     argnames_by_tag
\&     func_args_by_tag
\&     func_argnames_by_tag
\&     call_with_its_args
\& );
\&
\& our %SPEC;
\&
\& my %func1_args;
\&
\& $SPEC{myfunc1} = {
\&     v => 1.1,
\&     summary => \*(AqMy function one\*(Aq,
\&     args => {
\&         %func1_args = (
\&             foo => {tags=>[\*(Aqt1\*(Aq, \*(Aqt2\*(Aq]},
\&             bar => {tags=>[\*(Aqt2\*(Aq, \*(Aqt3\*(Aq]},
\&             baz => {},
\&         ),
\&     },
\& };
\& sub myfunc1 {
\&     my %args = @_;
\& }
\&
\& $SPEC{myfunc2} = {
\&     v => 1.1,
\&     summary => \*(AqMy function two\*(Aq,
\&     args => {
\&         %func1_args,
\&         qux => {tags=>[\*(Aqt3\*(Aq]},
\&     },
\& };
\& sub myfunc2 {
\&     my %args = @_;
\&     my $res = call_with_its_args(\*(Aqmyfunc1\*(Aq, \e%args);
\& }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
.SH FUNCTIONS
.IX Header "FUNCTIONS"
.SS args_by_tag
.IX Subsection "args_by_tag"
Usage:
.PP
.Vb 1
\& my %args = args_by_tag($meta, \e%args0, $tag);
.Ve
.PP
Will select only keypairs from \f(CW%args0\fR arguments which have tag \f(CW$tag\fR.
Examples:
.PP
.Vb 1
\& my %args = args_by_tag($SPEC{myfunc1}, {foo=>1, bar=>2, baz=>3, qux=>4}, \*(Aqt2\*(Aq); # (foo=>1, bar=>2)
.Ve
.SS argnames_by_tag
.IX Subsection "argnames_by_tag"
Usage:
.PP
.Vb 1
\& my @arg_names = argnames_by_tag($meta, $tag);
.Ve
.PP
Will select only argument names which have tag \f(CW$tag\fR.
.SS func_args_by_tag
.IX Subsection "func_args_by_tag"
Usage:
.PP
.Vb 1
\& my %args = func_args_by_tag($func_name, \e%args0, $tag);
.Ve
.PP
Like "args_by_tag" except that instead of supplying Rinci function metadata,
you supply a function name. Rinci metadata will be searched in \f(CW%SPEC\fR
variable.
.SS func_argnames_by_tag
.IX Subsection "func_argnames_by_tag"
Usage:
.PP
.Vb 1
\& my @argnames = func_argnames_by_tag($func_name, $tag);
.Ve
.PP
Like "argnames_by_tag" except that instead of supplying Rinci function
metadata, you supply a function name. Rinci metadata will be searched in
\&\f(CW%SPEC\fR variable.
.SS call_with_its_args
.IX Subsection "call_with_its_args"
Usage:
.PP
.Vb 1
\& my $res = call_with_its_args($func_name, \e%args);
.Ve
.PP
Call function with arguments taken from \f(CW%args\fR. Only arguments which the
function declares it accepts will be passed.
.SH HOMEPAGE
.IX Header "HOMEPAGE"
Please visit the project's homepage at <https://metacpan.org/release/Perinci\-Sub\-Util>.
.SH SOURCE
.IX Header "SOURCE"
Source repository is at <https://github.com/perlancar/perl\-Perinci\-Sub\-Util>.
.SH AUTHOR
.IX Header "AUTHOR"
perlancar <perlancar@cpan.org>
.SH CONTRIBUTING
.IX Header "CONTRIBUTING"
To contribute, you can send patches by email/via RT, or send pull requests on
GitHub.
.PP
Most of the time, you don't need to build the distribution yourself. You can
simply modify the code, then test via:
.PP
.Vb 1
\& % prove \-l
.Ve
.PP
If you want to build the distribution (e.g. to try to install it locally on your
system), you can install Dist::Zilla,
Dist::Zilla::PluginBundle::Author::PERLANCAR,
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.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2023, 2020, 2017, 2016, 2015, 2014 by perlancar <perlancar@cpan.org>.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
.SH BUGS
.IX Header "BUGS"
Please report any bugs or feature requests on the bugtracker website <https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci\-Sub\-Util>
.PP
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.