NAME

Perinci::Sub::Complete - Complete command-line argument using Rinci metadata

VERSION

This document describes version 0.71 of Perinci::Sub::Complete (from Perl distribution Perinci-Sub-Complete), released on 2015-01-09.

SYNOPSIS

See Perinci::CmdLine or Perinci::CmdLine::Lite or App::riap which use this module.

DESCRIPTION

FUNCTIONS

complete_arg_elem(%args) -> array

{en_US Given argument name and function metadata, complete array element}.

{en_US Will attempt to complete using the completion routine specified in the argument specification (the completion property, or in the case of complete_arg_elem function, the element_completion property), or if that is not specified, from argument's schema using complete_from_schema.

Completion routine will get %args, with the following keys:

word (str, the word to be completed)
ci (bool, whether string matching should be case-insensitive)
arg (str, the argument name which value is currently being completed)
index (int, only for thecomplete_arg_elem` function, the index in the argument array that is currently being completed, starts from 0)
args (hash, the argument hash to the function, so far)

as well as extra keys from extras (but these won't overwrite the above standard keys).

Completion routine should return a completion answer structure (described in Complete) which is either a hash or an array. The simplest form of answer is just to return an array of strings. Completion routine can also return undef to express declination. }

Arguments ('*' denotes required arguments):

arg* => str

{en_US Argument name}.
args => hash

{en_US Collected arguments so far, will be passed to completion routines}.
ci => bool (default: 0)

{en_US Whether to be case-insensitive}.
extras => hash

{en_US Add extra arguments to completion routine}.

{en_US The keys from this extras hash will be merged into the final %args passed to completion routines. Note that standard keys like word, cword, ci, and so on as described in the function description will not be overwritten by this. }
index => int

{en_US Index of element to complete}.
meta* => hash

{en_US Rinci function metadata, must be normalized}.
riap_client => obj

{en_US Optional, to perform complete_arg_val to the server}.

{en_US When the argument spec in the Rinci metadata contains completion key, this means there is custom completion code for that argument. However, if retrieved from a remote server, sometimes the completion key no longer contains the code (it has been cleansed into a string). Moreover, the completion code needs to run on the server.

If supplied this argument and te riap_server_url argument, the function will try to request to the server (via Riap request complete_arg_val). Otherwise, the function will just give up/decline completing. }
riap_server_url => str

{en_US Optional, to perform complete_arg_val to the server}.

{en_US See the riap_client argument. }
riap_uri => str

{en_US Optional, to perform complete_arg_val to the server}.

{en_US See the riap_client argument. }
word => str (default: "")

{en_US Word to be completed}.

Return value: (array)

complete_arg_val(%args) -> array

{en_US Given argument name and function metadata, complete value}.

Completion routine will get %args, with the following keys:

word (str, the word to be completed)
ci (bool, whether string matching should be case-insensitive)
arg (str, the argument name which value is currently being completed)
index (int, only for thecomplete_arg_elem` function, the index in the argument array that is currently being completed, starts from 0)
args (hash, the argument hash to the function, so far)

as well as extra keys from extras (but these won't overwrite the above standard keys).

Arguments ('*' denotes required arguments):

arg* => str

{en_US Argument name}.
args => hash

{en_US Collected arguments so far, will be passed to completion routines}.
ci => bool (default: 0)

{en_US Whether to be case-insensitive}.
extras => hash

{en_US Add extra arguments to completion routine}.

{en_US The keys from this extras hash will be merged into the final %args passed to completion routines. Note that standard keys like word, cword, ci, and so on as described in the function description will not be overwritten by this. }
meta* => hash

{en_US Rinci function metadata, must be normalized}.
riap_client => obj

{en_US Optional, to perform complete_arg_val to the server}.

{en_US When the argument spec in the Rinci metadata contains completion key, this means there is custom completion code for that argument. However, if retrieved from a remote server, sometimes the completion key no longer contains the code (it has been cleansed into a string). Moreover, the completion code needs to run on the server.

If supplied this argument and te riap_server_url argument, the function will try to request to the server (via Riap request complete_arg_val). Otherwise, the function will just give up/decline completing. }
riap_server_url => str

{en_US Optional, to perform complete_arg_val to the server}.

{en_US See the riap_client argument. }
riap_uri => str

{en_US Optional, to perform complete_arg_val to the server}.

{en_US See the riap_client argument. }
word => str (default: "")

{en_US Word to be completed}.

Return value: (array)

complete_cli_arg(%args) -> hash

{en_US Complete command-line argument using Rinci function metadata}.

{en_US This routine uses Perinci::Sub::GetArgs::Argv to generate Getopt::Long specification from arguments list in Rinci function metadata and common options. Then, it will use Complete::Getopt::Long to complete option names, option values, as well as arguments. }

Arguments ('*' denotes required arguments):

common_opts => hash

{en_US Common options}.

{en_US A hash where the values are hashes containing these keys: getopt (Getopt::Long option specification), handler (Getopt::Long handler). Will be passed to get_args_from_argv(). Example:

 {
     help => {
         getopt  => 'help|h|?',
         handler => sub { ... },
         summary => 'Display help and exit',
     },
     version => {
         getopt  => 'version|v',
         handler => sub { ... },
         summary => 'Display version and exit',
     },
 }

}

completion => code

{en_US Supply custom completion routine}.

{en_US If supplied, instead of the default completion routine, this code will be called instead. Will receive all arguments that Complete::Getopt::Long will pass, and additionally:
- arg (str, the name of function argument)
- args (hash, the function arguments formed so far)
- index (int, if completing argument element value) }
cword* => int

{en_US On which argument cursor is located (zero-based)}.
extras => hash

{en_US Add extra arguments to completion routine}.

{en_US The keys from this extras hash will be merged into the final %args passed to completion routines. Note that standard keys like word, cword, ci, and so on as described in the function description will not be overwritten by this. }
func_arg_starts_at => int (default: 0)

{en_US This is a (temporary?) workaround for Perinci::CmdLine. In an application with subcommands (e.g. cmd --verbose subcmd arg0 arg1 ...), then words will still contain the subcommand name. Positional function arguments then start at 1 not 0. This option allows offsetting function arguments. }
meta* => hash

{en_US Rinci function metadata}.
per_arg_json => bool

{en_US Will be passed to Perinci::Sub::GetArgs::Argv}.
per_arg_yaml => bool

{en_US Will be passed to Perinci::Sub::GetArgs::Argv}.
riap_client => obj

{en_US Optional, to perform complete_arg_val to the server}.

{en_US When the argument spec in the Rinci metadata contains completion key, this means there is custom completion code for that argument. However, if retrieved from a remote server, sometimes the completion key no longer contains the code (it has been cleansed into a string). Moreover, the completion code needs to run on the server.

If supplied this argument and te riap_server_url argument, the function will try to request to the server (via Riap request complete_arg_val). Otherwise, the function will just give up/decline completing. }
riap_server_url => str

{en_US Optional, to perform complete_arg_val to the server}.

{en_US See the riap_client argument. }
riap_uri => str

{en_US Optional, to perform complete_arg_val to the server}.

{en_US See the riap_client argument. }
words* => array[str]

{en_US Command-line arguments}.

Return value: (hash)

{en_US You can use format_completion function in Complete::Bash module to format the result of this function for bash. }

complete_from_schema(%args) -> [status, msg, result, meta]

{en_US Complete a value from schema}.

{en_US Employ some heuristics to complete a value from Sah schema. For example, if schema is [str => in => [qw/new open resolved rejected/]], then we can complete from the in clause. Or for something like [int => between => [1, 20]] we can complete using values from 1 to 20. }

Arguments ('*' denotes required arguments):

ci => bool
schema* => any

{en_US Must be normalized}.
word* => str (default: "")

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)

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Perinci-Sub-Complete.

SOURCE

Source repository is at https://github.com/perlancar/perl-Perinci-Sub-Complete.

BUGS

Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Perinci-Sub-Complete

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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

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 Perinci::Sub::Complete, copy and paste the appropriate command in to your terminal.

cpanm

cpanm Perinci::Sub::Complete

CPAN shell

perl -MCPAN -e shell
install Perinci::Sub::Complete

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)

NAME

VERSION

SYNOPSIS

DESCRIPTION

FUNCTIONS

complete_arg_elem(%args) -> array

complete_arg_val(%args) -> array

complete_cli_arg(%args) -> hash

complete_from_schema(%args) -> [status, msg, result, meta]

SEE ALSO

HOMEPAGE

SOURCE

BUGS

AUTHOR

COPYRIGHT AND LICENSE

Module Install Instructions