Perinci::Sub::Complete - Shell completion routines using Rinci metadata
This document describes version 0.57 of Perinci::Sub::Complete (from Perl distribution Perinci-Sub-Complete), released on 2014-07-19.
This module provides functionality for doing shell completion. It is meant to be used by Perinci::CmdLine and other Rinci/Riap-based CLI shell like App::riap.
Given argument name and function metadata, complete array element.
Arguments ('*' denotes required arguments):
arg* => str
Argument name.
args => hash
Collected arguments so far, will be passed to completion routines.
ci => bool (default: 0)
Whether to be case-insensitive.
index => int
Index of element to complete.
meta* => hash
Rinci function metadata, must be normalized.
parent_args => hash
To pass parent arguments to completion routines.
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.
completion
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:
Given argument name and function metadata, complete value.
Complete command-line argument using Rinci function metadata.
Assuming that command-line like:
foo a b c
is executing some function, and the command-line arguments will be parsed using Perinci::Sub::GetArgs::Argv, then try to complete command-line arguments using information from Rinci metadata.
Perinci::Sub::GetArgs::Argv
Algorithm:
If word begins with $, we complete from environment variables and are done.
$
Call get_args_from_argv() to extract hash arguments from the given words.
get_args_from_argv()
words
Determine whether we need to complete argument name (e.g. --arg<tab>) or argument value (e.g. --arg1 <tab> or <tab> at 1st word where there is an argument specified at pos=0) or an element for an array argument (e.g. a <tab> where there is an argument with spec pos=0 and greedy=1, which means we are trying to complete the value of the second element (index=1) of that argument).
--arg<tab
--arg1 <tab
<tab
a <tab
Call custom_completer if defined. If a list of words is returned, we're done. This can be used for, e.g. nested function call, e.g.:
custom_completer
somecmd --opt-for-cmd ... subcmd --opt-for-subcmd ...
5a. If we are completing argument name, then supply a list of possible argument names, or fallback to completing filenames.
5b. If we are completing argument value, first check if custom_arg_completer is defined. If yes, call that routine. If a list of words is returned, we're done. Fallback to completing argument values from information in Rinci metadata (using complete_arg_val() function).
custom_arg_completer
complete_arg_val()
5c. If we are completing value for an element, first check if custom_arg_element_completer is defined. If yes, call that routine. If a list of words is returned, we're done. Fallback to completing argument values from information in Rinci metadata (using complete_arg_val() function).
custom_arg_element_completer
common_opts => hash
Common options.
A hash of Getopt::Long option specifications and handlers. Will be passed to get_args_from_argv().
custom_arg_completer => code|hash
Supply custom argument value completion routines.
Either code or a hash of argument names and codes.
If supplied, instead of the default completion routine, this code will be called instead when trying to complete argument value. Refer to function description to see when this routine is called.
Code will be called with hash arguments containing these keys: word (string, the word to be completed), arg (string, the argument name that we are completing the value of), args (hash, the arguments that have been collected so far), parent_args.
word
arg
args
parent_args
A use-case for using this option: getting argument value from Riap client using the complete_arg_val action. This allows getting completion from remote server.
custom_arg_element_completer => code|hash
Supply custom argument element completion routines.
If supplied, instead of the default completion routine, this code will be called instead when trying to complete argument element. Refer to function description to see when this routine is called.
Code will be called with hash arguments containing these keys: word (string, the word to be completed), arg (string, the argument name that we are completing the value of), args (hash, the arguments that have been collected so far), parent_args, idx (the element index that we are are trying to complete, starts from 0).
idx
custom_completer => code
Supply custom completion routine.
If supplied, instead of the default completion routine, this code will be called instead. Refer to function description to see when this routine is called.
Code will be called with a hash argument, with these keys: which (a string with value name or value depending on whether we should complete argument name or value), words (an array, the command line split into words), cword (int, position of word in words), word (the word to be completed), parent_args (hash, arguments given to complete_cli_arg()), args (hash, parsed function arguments from words) remaining_words (array, slice of words after cword), meta (the Rinci function metadata).
which
name
value
cword
complete_cli_arg()
remaining_words
meta
Code should return an arrayref of completion, or a hashref containing completion in completion key and other hints in other keys, or undef to declare declination, on which case completion will resume using the standard builtin routine.
undef
A use-case of using this option: XXX.
cword => int
On which word cursor is located (zero-based).
If unset, will be taken from COMPLINE and COMPPOINT.
extra_completer_args => hash
Arguments to pass to custom completion routines.
Completion routines will get this from their parent_args argument.
words => array
Command-line, broken as words.
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
[int =
ci => bool
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.
--foo=X
Due to parsing limitation (invokes subshell), can't complete unclosed quotes, e.g.
foo "bar <tab>
while shell function can complete this because they are provided COMP_WORDS and COMP_CWORD by bash.
COMP_WORDS
COMP_CWORD
Complete
Perinci::CmdLine
Please visit the project's homepage at https://metacpan.org/release/Perinci-Sub-Complete.
Source repository is at https://github.com/sharyanto/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.
Steven Haryanto <stevenharyanto@gmail.com>
This software is copyright (c) 2014 by Steven Haryanto.
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.