/ 
Perinci-Sub-Complete-0.42
River stage three • 15 direct dependents • 566 total dependents
/ Perinci::Sub::Complete

NAME

Perinci::Sub::Complete - Shell completion routines using Rinci metadata

VERSION

This document describes version 0.42 of Perinci::Sub::Complete (from Perl distribution Perinci-Sub-Complete), released on 2014-06-19.

SYNOPSIS

DESCRIPTION

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.

FUNCTIONS

complete_arg_elem(%args) -> array

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.

    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

    Optional, to perform complete_arg_val to the server.

    See the riap_client argument.

  • riap_uri => str

    Optional, to perform complete_arg_val to the server.

    See the riap_client argument.

  • word => str (default: "")

    Word to be completed.

Return value:

complete_arg_val(%args) -> array

Given argument name and function metadata, complete value.

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.

  • 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.

    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

    Optional, to perform complete_arg_val to the server.

    See the riap_client argument.

  • riap_uri => str

    Optional, to perform complete_arg_val to the server.

    See the riap_client argument.

  • word => str (default: "")

    Word to be completed.

Return value:

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

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.

Arguments ('*' denotes required arguments):

  • ci => bool

  • schema* => any

    Must be normalized.

  • word* => str (default: "")

Return value:

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.

shell_complete_arg(%args) -> array

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.

Algorithm:

  1. If word begins with $, we complete from environment variables and are done.

  2. Call get_args_from_argv() to extract hash arguments from the given words.

  3. 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).

  4. 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.:

    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).

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).

Arguments ('*' denotes required arguments):

  • common_opts => array (default: [["--help", "-?", "-h"]])

    Common options.

    When completing argument name, this list will be added.

  • 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.

    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.

    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 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).

  • 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 shell_complete_arg()), args (hash, parsed function arguments from words) remaining_words (array, slice of words after cword), meta (the Rinci function metadata).

    Code should return an arrayref of completion, or undef to declare declination, on which case completion will resume using the standard builtin routine.

    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.

  • 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 => str

    Optional, to perform complete_arg_val to the server.

    See the riap_client argument.

  • riap_uri => str

    Optional, to perform complete_arg_val to the server.

    See the riap_client argument.

  • words => array

    Command-line, broken as words.

    If unset, will be taken from COMPLINE and COMPPOINT.

Return value:

BUGS/LIMITATIONS/TODOS

Completing --foo=X not yet supported

Unclosed quoted

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.

SEE ALSO

Perinci::CmdLine

Other shell completion modules on CPAN: Getopt::Complete, Bash::Completion.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/sharyanto/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

Steven Haryanto <stevenharyanto@gmail.com>

COPYRIGHT AND LICENSE

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.