Perinci::Sub::Complete - Complete command-line argument using Rinci metadata
This document describes version 0.81 of Perinci::Sub::Complete (from Perl distribution Perinci-Sub-Complete), released on 2015-09-03.
See Perinci::CmdLine or Perinci::CmdLine::Lite or App::riap which use this module.
Given argument name and function metadata, complete array element.
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
complete_arg_elem
element_completion
complete_from_schema
Completion routine will get %args, with the following keys:
%args
word (str, the word to be completed)
word
ci (bool, whether string matching should be case-insensitive)
ci
arg (str, the argument name which value is currently being completed)
arg
index (int, only for thecomplete_arg_elem` function, the index in the argument array that is currently being completed, starts from 0)
index (int, only for the
args (hash, the argument hash to the function, so far)
args
as well as extra keys from extras (but these won't overwrite the above standard keys).
extras
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.
Complete
Arguments ('*' denotes required arguments):
arg* => str
Argument name.
args => hash
Collected arguments so far, will be passed to completion routines.
ci => bool
Whether to be case-insensitive.
extras => hash
Add extra arguments to completion routine.
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.
cword
index => int
Index of element to complete.
meta* => hash
Rinci function metadata, must be normalized.
riap_client => obj
Optional, to perform complete_arg_val to the server.
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
complete_arg_val
riap_server_url => str
See the riap_client argument.
riap_client
riap_uri => str
word => str (default: "")
Word to be completed.
Return value: (array)
Given argument name and function metadata, complete value.
Complete command-line argument using Rinci function metadata.
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.
Perinci::Sub::GetArgs::Argv
Getopt::Long
Complete::Getopt::Long
common_opts => hash
Common options.
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:
getopt
handler
get_args_from_argv()
{ help => { getopt => 'help|h|?', handler => sub { ... }, summary => 'Display help and exit', }, version => { getopt => 'version|v', handler => sub { ... }, summary => 'Display version and exit', }, }
completion => code
Supply custom completion routine.
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)
index
cword* => int
On which argument cursor is located (zero-based).
func_arg_starts_at => int (default: 0)
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.
cmd --verbose subcmd arg0 arg1 ...
words
Rinci function metadata.
per_arg_json => bool
Will be passed to Perinci::Sub::GetArgs::Argv.
per_arg_yaml => bool
words* => array[str]
Command-line arguments.
Return value: (hash)
You can use format_completion function in Complete::Bash module to format the result of this function for bash.
format_completion
Complete::Bash
Complete a value from schema.
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.
[str => in => [qw/new open resolved rejected/]]
in
[int => between => [1, 20]]
schema* => any
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)
Complete, Complete::Getopt::Long
Perinci::CmdLine, Perinci::CmdLine::Lite, App::riap
Please visit the project's homepage at https://metacpan.org/release/Perinci-Sub-Complete.
Source repository is at https://github.com/perlancar/perl-Perinci-Sub-Complete.
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 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 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.