The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.
 / 
Complete-Util-0.13
River stage three • 106 direct dependents • 990 total dependents
/ Complete::Util

NAME

Complete::Util - General completion routines

VERSION

This document describes version 0.13 of Complete::Util (from Perl distribution Complete-Util), released on 2014-07-13.

DESCRIPTION

FUNCTIONS

complete_array_elem(%args) -> array

Complete from array.

Arguments ('*' denotes required arguments):

  • array* => array

  • ci => bool (default: 0)

  • word => str (default: "")

Return value:

complete_env(%args) -> array

Complete from environment variables.

On Windows, environment variable names are all converted to uppercase. You can use case-insensitive option (ci) to match against original casing.

Arguments ('*' denotes required arguments):

  • ci => bool (default: 0)

  • word => str (default: "")

Return value:

complete_file(%args) -> array

Complete file and directory from local filesystem.

Arguments ('*' denotes required arguments):

  • filter => code|str

    Only return items matching this filter.

    Filter can either be a string or a code.

    For string filter, you can specify a pipe-separated groups of sequences of these characters: f, d, r, w, x. Dash can appear anywhere in the sequence to mean not/negate. An example: f means to only show regular files, -f means only show non-regular files, drwx means to show only directories which are readable, writable, and executable (cd-able). wf|wd means writable regular files or writable directories.

    For code filter, you supply a coderef. The coderef will be called for each item with these arguments: $name. It should return true if it wants the item to be included.

  • word => str (default: "")

Return value:

complete_hash_key(%args) -> array

Complete from hash keys.

Arguments ('*' denotes required arguments):

  • ci => bool (default: 0)

  • hash* => hash

  • word => str (default: "")

Return value:

complete_program(%args) -> array

Complete program name found in PATH.

Windows is supported, on Windows PATH will be split using /;/ instead of /:/.

Arguments ('*' denotes required arguments):

  • word => str (default: "")

Return value:

SEE ALSO

Complete

If you want to do bash tab completion with Perl, take a look at Complete::Bash and Complete::BashGen.

Other Complete::* modules.

HOMEPAGE

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

SOURCE

Source repository is at https://github.com/sharyanto/perl-SHARYANTO-Complete-Util.

BUGS

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

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.