Getopt-Complete-0.26 000755 030216 023421 0 11625061503 14104 5 ustar 00nnutter gsc 000000 000000 Getopt-Complete-0.26/Changes 000444 030216 023421 10050 11625061503 15550 0 ustar 00nnutter gsc 000000 000000 Revision history for Getopt-Complete
0.26 2011-08-23
Minor rewrite to use COMP_WORDS instead of COMP_LINE to resolve bug involving redirection.
Include bin/getopt_complete.sh which can be sourced in Bash to load the completion function.
Updated test case to hopefully not fail for users with an empty home directory.
0.25 2011-03-28
Fixed bug with '<>=s@' not taking multiple values.
Fixed but with single character options.
0.24 2011-03-02
The "version" module makes this difficult to install. Switching to simple text version "0.24".
0.23 2011-01-19
Updated build logic to prevent installation with out a recent version.pm
0.22 2011-01-16
Another atch from Andrei Benea (abenea@github) fixing bug with nonsense argument not generating an error.
0.21 2011-01-12
Patch from Andrei Benea (abenea@github) fixing bug with all bare arguments.
Fix to the demoapp test.
Switch to Build.PL instead of Makefile.PL so we can install on Mac w/o xcode.
0.20 2010-11-24
Updates to cache logic.
Replacement for 0.19 which failed to compile.
0.17 2010-11-04
Fixed bug in parse_completion_request that was preventing detection of boolean options
Support for completing bareargs as files.
Support for completing unknown options as files.
0.16 2010-11-02
Fixed bug in completing paths beginning with ~
Better support for params that are expanded by Bash
0.15 2010-10-24
Fixed a failing test with a bad perl interpreter path for the demoapp.
Fixed a bug with running tests on a machine with a space in the path to the files.
0.14 2010-09-09
Fixed bug that returned completion results even when various errors were encountered.
Added t/demoapp*, a test to validate some basic tab completion results.
0.13 2010-07-23
Added LazyOptions and Cache for improved handling of nested commands.
Refactored for testability.
Added stricter failing when cant read opts file.
0.11 2009-11-01
Removed the pod test which breaks automatic installs via the CPAN shell.
0.10 2009-08-02
Fixed a bug which made file/directory paths at which there is no file "invalid".
(This was bad news for apps which want you to specify an output file.)
0.9 2009-07-27
Fixed a bug in the last release which allowed the app to continue when there are argument errors.
Support for completion values with whitespace.
Updates to error messages to do the right thing when showing lists of possible completions in the message.
Made "lone dash support" disabled by default until it works correctly.
Added OSCON lightning talk to docs.
0.8 2009-07-24
Fixed a bug in the last release causing params to dump to the screen upon execution.
0.7 2009-07-18
Fixed a critical bug in the last release causing %ARGS and $ARGS to not export.
0.6 2009-07-18
Sub-command tree support added.
0.5 2009-07-18
The exported results are now called %ARGS instead of %OPTS.
Correctly handling spaces, quotes, etc. by using bash itself to parse the command line.
Options are no longer shown in the hint list if they have already been used.
Refactored into object-orient structure internally.
0.4 2009-07-15
Handle negative boolean flags (--no-*) iteratively.
Handle other options with dashes in the name correctly.
Switch to unpadded version numbers.
0.03 2009-07-12
No longer need support for 'complete -F' to see the whole command-line. Code removed.
Tons of documentation.
Fixed bugs with completion of file and directory paths.
Support for partial completions.
0.02 2009-07-11
Added support for "complete -F" in addition to "complete -C".
(The app can now examine the entire command-line, not just the option pair currently under consideration.)
0.01 2008-12-19
First version, released on an unsuspecting world.
Getopt-Complete-0.26/MANIFEST 000444 030216 023421 737 11625061503 15361 0 ustar 00nnutter gsc 000000 000000 Changes
doc/getopt-complete.odp
doc/getopt-complete.pdf
INSTALL
lib/Getopt/Complete.pm
lib/Getopt/Complete/Args.pm
lib/Getopt/Complete/Cache.pm
lib/Getopt/Complete/Compgen.pm
lib/Getopt/Complete/LazyOptions.pm
lib/Getopt/Complete/Options.pm
LICENSE
Build.PL
MANIFEST This list of files
META.yml
README
t/00-load.t
t/01-try-many.in
t/01-try-many.t
t/02-boilerplate.t
t/03-demoapp-completion.t
t/04-exercise.t
t/05-bad-arg-name.t
t/demoapp
t/demoapp.opts
t/myprogram
t/mytreeapp
Getopt-Complete-0.26/META.yml 000444 030216 023421 1744 11625061503 15520 0 ustar 00nnutter gsc 000000 000000 ---
abstract: 'programmable shell completion for Perl apps'
author: []
build_requires:
App::Prove: ''
Test::More: 0.86
configure_requires:
Module::Build: 0.36
generated_by: 'Module::Build version 0.3607'
license: perl
meta-spec:
url: http://module-build.sourceforge.net/META-spec-v1.4.html
version: 1.4
name: Getopt-Complete
provides:
Getopt::Complete:
file: lib/Getopt/Complete.pm
version: 0.26
Getopt::Complete::Args:
file: lib/Getopt/Complete/Args.pm
version: 0
Getopt::Complete::Cache:
file: lib/Getopt/Complete/Cache.pm
version: 0
Getopt::Complete::Compgen:
file: lib/Getopt/Complete/Compgen.pm
version: 0
Getopt::Complete::LazyOptions:
file: lib/Getopt/Complete/LazyOptions.pm
version: 0
Getopt::Complete::Options:
file: lib/Getopt/Complete/Options.pm
version: 0
requires:
Carp: ''
Getopt::Long: ''
IPC::Open2: ''
Scalar::Util: ''
perl: v5.8.7
resources:
license: http://dev.perl.org/licenses/
version: 0.26
Getopt-Complete-0.26/INSTALL 000444 030216 023421 62 11625061503 15230 0 ustar 00nnutter gsc 000000 000000 perl Makefile.PL
make
make test
sudo make install
Getopt-Complete-0.26/LICENSE 000444 030216 023421 121302 11625061503 15305 0 ustar 00nnutter gsc 000000 000000 Getopt::Complete is licensed under the same terms as Perl itself, which
means it is dually-licensed under either the Artistic or GPL licenses.
Below are details of the Artistic License and, following it, the GPL.
The "Artistic License"
Preamble
The intent of this document is to state the conditions under which a
Package may be copied, such that the Copyright Holder maintains some
semblance of artistic control over the development of the package,
while giving the users of the package the right to use and distribute
the Package in a more-or-less customary fashion, plus the right to make
reasonable modifications.
Definitions:
"Package" refers to the collection of files distributed by the
Copyright Holder, and derivatives of that collection of files
created through textual modification.
"Standard Version" refers to such a Package if it has not been
modified, or has been modified in accordance with the wishes
of the Copyright Holder as specified below.
"Copyright Holder" is whoever is named in the copyright or
copyrights for the package.
"You" is you, if you're thinking about copying or distributing
this Package.
"Reasonable copying fee" is whatever you can justify on the
basis of media cost, duplication charges, time of people involved,
and so on. (You will not be required to justify it to the
Copyright Holder, but only to the computing community at large
as a market that must bear the fee.)
"Freely Available" means that no fee is charged for the item
itself, though there may be fees involved in handling the item.
It also means that recipients of the item may redistribute it
under the same conditions they received it.
1. You may make and give away verbatim copies of the source form of the
Standard Version of this Package without restriction, provided that you
duplicate all of the original copyright notices and associated disclaimers.
2. You may apply bug fixes, portability fixes and other modifications
derived from the Public Domain or from the Copyright Holder. A Package
modified in such a way shall still be considered the Standard Version.
3. You may otherwise modify your copy of this Package in any way, provided
that you insert a prominent notice in each changed file stating how and
when you changed that file, and provided that you do at least ONE of the
following:
a) place your modifications in the Public Domain or otherwise make them
Freely Available, such as by posting said modifications to Usenet or
an equivalent medium, or placing the modifications on a major archive
site such as uunet.uu.net, or by allowing the Copyright Holder to include
your modifications in the Standard Version of the Package.
b) use the modified Package only within your corporation or organization.
c) rename any non-standard executables so the names do not conflict
with standard executables, which must also be provided, and provide
a separate manual page for each non-standard executable that clearly
documents how it differs from the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
4. You may distribute the programs of this Package in object code or
executable form, provided that you do at least ONE of the following:
a) distribute a Standard Version of the executables and library files,
together with instructions (in the manual page or equivalent) on where
to get the Standard Version.
b) accompany the distribution with the machine-readable source of
the Package with your modifications.
c) give non-standard executables non-standard names, and clearly
document the differences in manual pages (or equivalent), together
with instructions on where to get the Standard Version.
d) make other distribution arrangements with the Copyright Holder.
5. You may charge a reasonable copying fee for any distribution of this
Package. You may charge any fee you choose for support of this
Package. You may not charge a fee for this Package itself. However,
you may distribute this Package in aggregate with other (possibly
commercial) programs as part of a larger (possibly commercial) software
distribution provided that you do not advertise this Package as a
product of your own. You may embed this Package's interpreter within
an executable of yours (by linking); this shall be construed as a mere
form of aggregation, provided that the complete Standard Version of the
interpreter is so embedded.
6. The scripts and library files supplied as input to or produced as
output from the programs of this Package do not automatically fall
under the copyright of this Package, but belong to whoever generated
them, and may be sold commercially, and may be aggregated with this
Package. If such scripts or library files are aggregated with this
Package via the so-called "undump" or "unexec" methods of producing a
binary executable image, then distribution of such an image shall
neither be construed as a distribution of this Package nor shall it
fall under the restrictions of Paragraphs 3 and 4, provided that you do
not represent such an executable image as a Standard Version of this
Package.
7. C subroutines (or comparably compiled subroutines in other
languages) supplied by you and linked into this Package in order to
emulate subroutines and variables of the language defined by this
Package shall not be considered part of this Package, but are the
equivalent of input as in Paragraph 6, provided these subroutines do
not change the language in any way that would cause it to fail the
regression tests for the language.
8. Aggregation of this Package with a commercial distribution is always
permitted provided that the use of this Package is embedded; that is,
when no overt attempt is made to make this Package's interfaces visible
to the end user of the commercial distribution. Such use shall not be
construed as a distribution of this Package.
9. The name of the Copyright Holder may not be used to endorse or promote
products derived from this software without specific prior written permission.
10. THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
The End
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
Copyright (C)
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see .
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
Copyright (C)
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
.
Getopt-Complete-0.26/Build.PL 000444 030216 023421 1130 11625061503 15530 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/env perl
use warnings FATAL => 'all';
use strict;
use Module::Build;
my $build = Module::Build->new(
module_name => 'Getopt::Complete',
license => 'perl',
requires => {
'perl' => 'v5.8.7',
'Getopt::Long' => '',
'Scalar::Util' => '',
'IPC::Open2' => '',
'Carp' => '',
},
build_requires => {
'Test::More' => '0.86',
'App::Prove' => '',
},
cpan_client => 'cpanm',
#script_files => [ 'bin/ur' ],
#test_files => [qw|t/*.t t/*/*.t t/*/*/*.t t/*/*/*/*.t|],
);
$build->create_build_script;
Getopt-Complete-0.26/README 000444 030216 023421 75333 11625061503 15154 0 ustar 00nnutter gsc 000000 000000 NAME
Getopt::Complete - programmable shell completion for Perl apps
VERSION
This document describes Getopt::Complete v0.9.
SYNOPSIS
In the Perl program "myprogram":
use Getopt::Complete (
'frog' => ['ribbit','urp','ugh'],
'fraggle' => sub { return ['rock','roll'] },
'quiet!' => undef,
'name' => undef,
'age=n' => undef,
'outfile=s@' => 'files',
'outdir' => 'directories'
'runthis' => 'commands',
'username' => 'users',
'<>' => 'directories',
);
print "the frog says " . $ARGS{frog} . "\n";
In ~/.bashrc or ~/.bash_profile, or directly in bash:
function _getopt_complete () {
COMPREPLY=($( COMP_CWORD=$COMP_CWORD perl `which ${COMP_WORDS[0]}` ${COMP_WORDS[@]:0} ));
}
complete -F _getopt_complete myprogram
Thereafter in the terminal (after next login, or sourcing the updated
.bashrc):
$ myprogram --f
$ myprogram --fr
$ myprogram --fr
frog fraggle
$ myprogram --fro
$ myprogram --frog
$ myprogram --frog
ribbit urp ugh
$ myprogram --frog r
$ myprogram --frog ribbit
DESCRIPTION
This module makes it easy to add custom command-line completion to Perl
applications. It also does additional validation of arguments, when the
program is actually executed, based on completion lists.
Support is also present for apps which are an entry point for a
hierarchy of sub-commands (in the style of cvs and git).
Getopt::Complete also wraps the standard options processing and exports
it as a %ARGS hash at compile time, making using the arguments
hassle-free.
The completion features currently work with the bash shell, which is the
default on most Linux and Mac systems. Patches for other shells are
welcome.
OPTIONS PROCESSING
Getopt::Complete processes the command-line options at compile time.
The results are avaialble in the %ARGS hash, which is intended as a
companion to the @ARGV array generated natively by Perl.
use Getopt::Complete (
'mydir' => 'd',
'myfile' => 'f',
'<>' = ['monkey', 'taco', 'banana']
);
for $opt (keys %ARGS) {
$val = $ARGS{$opt};
print "$opt has value $val\n";
}
Errors in shell argumentes result in messages to STDERR via warn(), and
cause the program to exit during "use" call. Getopt::Complete verifies
that the option values specified match their own completion list, and
will otherwise add additional errors explaining the problem.
The %ARGS hash is an alias for %Getopt::Complete::ARGS. The alias is not
created in the caller's namespaces if a hash named %ARGS already exists
with data, but the results are always available from
%Getopt::Complete::ARGS.
They keys of the hash are the option names, minus any specifiers like
"=s" or "!". The key is only present if the option was specified on the
command-line.
The values of the hash are the values from the command-line. For
multi-value options the hash value is an arrayref.
OBJECT API
An object $ARGS is also created in the caller's namespace (class
Getopt::Complete::Args) with a more detailed API for argument
interrogation. See the documentation for that module, and also for the
underlying Getopt::Complete::Options module.
It is possible to override any part of the default process, including
doing custom parsing, doing processing at run-time, and and preventing
exit when there are errors.
See OVERRIDING COMPILE-TIME OPTION PARSING for more information.
PROGRAMMABLE COMPLETION BACKGROUND
The bash shell supports smart completion of words when the key is
pressed. By default, after the program name is specified, bash will
presume the word the user is typing a is a file name, and will attempt
to complete the word accordingly. Where completion is ambiguous, the
shell will go as far as it can and beep. Subsequent completion attempts
at that position result in a list being shown of possible completions.
Bash can be configured to run a specific program to handle the
completion task, allowing custom completions to be done for different
appliations. The "complete" built-in bash command instructs the shell
as-to how to handle tab-completion for a given command.
This module allows a program to be its own word-completer. It detects
that the COMP_LINE and COMP_POINT environment variables are set,
indicating that it is being used as a completion program, and responds
by returning completion values suitable for the shell _instead_ of
really running the application.
See the manual page for "bash", the heading "Programmable Completion"
for full details on the general topic.
HOW TO CONFIGURE PROGRAMMABLE COMPLETION
1 Put a "use Getopt::Complete" statement into your app as shown in the
synopsis. The key-value pairs describe the command-line options
available, and their completions.
This should be at the TOP of the app, before any real processing is
done. The only modules used before it should be those needed for
custom callbacks, if there are any. No code should print to standard
output during compile time, or it will confuse bash.
Subsequent code can use %ARGS or the $ARGS object to check on
command-line option values.
Existing apps using Getopt::Long should use their option spec in the
use declaration instead. If they bind variables directly the code
should to be updated to get values from the %ARGS hash instead.
2 Put the following in your .bashrc or .bash_profile:
function _getopt_complete () {
COMPREPLY=($( COMP_CWORD=$COMP_CWORD perl `which ${COMP_WORDS[0]}` ${COMP_WORDS[@]:0} ));
}
complete -F _getopt_complete myprogram
3 New logins will automatically run the above and become aware that
your program has programmable completion. For shells you already
have open, run this to alert bash to your that your program has
custom tab-completion.
source ~/.bashrc
Type the name of your app ("myprogram" in the example), and experiment
with using the key to get various completions to test it. Every
time you hit , bash sets certain environment variables, and then
runs your program. The Getopt::Complete module detects these variables,
responds to the completion request, and then forces the program to exit
before really running your regular application code.
IMPORTANT: Do not do steps #2 and #3 w/o doing step #1, or your
application will actually run "normally" every time you press with
it on the command-line! The module will not be present to detect that
this is not a "real" execution of the program, and you may find your
program is running when it should not.
KEYS IN THE OPTIONS SPECIFICATION
Each key in the list decribes an option which can be completed. Any key
usable in a Getopt:::Long GetOptions specification works here, (except
as noted in BUGS below):
an option name
A normal word is interpreted as an option name. The '=s' specifier
is presumed if no specifier is present.
'p1' => [...]
a complete option specifier
Any specification usable by Getopt::Long is valid as the key. For
example:
'p1=s' => [...] # the same as just 'p1'
'p2=s@' => [...] # expect multiple values
the '<>' symbol for "bare arguments"
This special key specifies how to complete non-option (bare)
arguments. It presumes multiple values are possible (like '=s@'):
Have an explicit list: '<>' = ['value1','value2','value3']
Do normal file completion: '<>' = 'files'
Take arbitrary values with no expectations: '<>' = undef
If there is no '<>' key specified, bare arguments will be treated as
an error.
a sub-command specifier, starting with '>'
When a key in the options specification starts with '>', it
indicates a that word maps to a distinct sub-command with its own
options. The array to the right is itself a full options
specification, following the same format as the one above it,
including possible further sub-commands.
See SUB-COMMAND TREES for more details.
VALUES IN THE OPTIONS SPECIFICATION
Each value describes how the option in question should be completed.
array reference
An array reference expliciitly lists the valid values for the
option.
In the app:
use Getopt::Complete (
'color' => ['red','green','blue'],
);
In the shell:
$ myprogram --color
red green blue
$ myprogram --color blue
(runs with no errors)
The list of value is also used to validate the user's choice after
options are processed:
myprogram --color purple
ERROR: color has invalid value purple: select from red green blue
See below for details on how to permit values which aren't shown in
completions to be used and not generate errors.
undef
An undefined value indicates that the option is not completable. No
completions will be offered by the application, though any value
provided by the user will be considered valid.
Note that this is distinct from returning an empty arrayref from a
callback, which implies that there ARE known completions but the
user has failed to match any of them.
Also note: this is the only valid completion for boolean parameters,
since there is no value to specify on the command-line.
use Getopt::Complete (
'name' => undef, # take --name "anyting"
'perky!' => undef, # take --perky or --no-perky
);
subroutine callback
When the list of valid values must be determined dynamically, a
subroutine reference or name can be specified. If a name is
specified, it should be fully qualified. (If it is not, it will be
presumed to refer to one of the bash builtin completions types. See
BUILTIN COMPLETION TYPES below.)
The subroutine will be called, and is expected to return an arrayref
of possiible matches. The arrayref will be treated as though it were
specified directly in the specification.
As with explicit values, an empty arrayref indicated that there are
no valid matches for this option, given the other params on the
command-line, and the text already typed. An undef value indicates
that any value is valid for this parameter.
Parameters to the callback are described below.
WRITING SUBROUTINE CALLBACKS
A subroutine callback is useful when the list of options to match must
be dynamically generated.
It is also useful when knowing what the user has already typed helps
narrow the search for valid completions, or when iterative completion
needs to occur (see PARTIAL COMPLETIONS below).
The callback is expected to return an arrayref of valid completions. If
it is empty, no completions are considered valid. If an undefined value
is returned, no completions are specified, but ANY arbitrary value
entered is considered valid as far as error checking is concerned.
The callback registerd in the completion specification will receive the
following parameters:
command name
Contains the name of the command for which options are being parsed.
This is $0 in most cases, though hierarchical commands may have a
name "svn commit" or "foo bar baz" etc.
current word
This is the word the user is trying to complete. It may be an empty
string, if the user hits without typing anything first.
option name
This is the name of the option for which we are resolving a value.
It is typically ignored unless you use the same subroutine to
service multiple options.
A value of '<>' indicates an unnamed argument (a.k.a "bare argument"
or "non-option" argument).
other opts
It is the hashref resulting from Getopt::Long processing of all of
the OTHER arguments. This is useful when one option limits the valid
values for another option.
In some cases, the options which should be available change
depending on what other options are present, or the values available
change depending on other options or their values.
The environment variables COMP_LINE and COMP_POINT have the exact text
of the command-line and also the exact character position, if more
detail is needed in raw form than the parameters provide.
The return value is a list of possible matches. The callback is free to
narrow its results by examining the current word, but is not required to
do so. The module will always return only the appropriate matches.
EXAMPLE
This app takes 2 parameters, one of which is dependent on the other:
use Getopt::Complete (
type => ['names','places','things'],
instance => sub {
my ($command, $value, $option, $other_opts) = @_;
if ($other_opts{type} eq 'names') {
return [qw/larry moe curly/],
}
elsif ($other_opts{type} eq 'places') {
return [qw/here there everywhere/],
}
elsif ($other_opts{type} eq 'things') {
return [ query_database_matching("${value}%") ]
}
elsif ($otper_opts{type} eq 'surprsing') {
# no defined list: take anything typed
return undef;
}
else {
# invalid type: no matches
return []
}
}
);
$ myprogram --type people --instance
larry moe curly
$ myprogram --type places --instance
here there everywhere
$ myprogram --type surprising --instance
(no completions appear)
BUILTIN COMPLETIONS
Bash has a list of built-in value types which it knows how to complete.
Any of the default shell completions supported by bash's "compgen" are
supported by this module.
The list of builtin types supported as-of this writing are:
files
directories
commands
users
groups
environment
services
aliases
builtins
To indicate that an argument's valid values are one of the above, use
the exact string after Getopt::Complete:: as the completion callback.
For example:
use Getopt::Complete (
infile => 'Getopt::Complete::files',
outdir => 'Getopt::Complete::directories',
myuser => 'Getopt::Complete::users',
);
The full name is alissed as the single-character compgen parameter name
for convenience. Further, because Getopt::Complete is the default
namespace during processing, it can be ommitted from callback function
names.
The following are all equivalent. They effectively produce the same list
as 'compgen -f':
file1 => \&Getopt::Complete::files
file1 => \&Getopt::Complete::f
file1 => 'Getopt::Complete::files'
file1 => 'Getopt::Complete::f'
file1 => 'files'
file1 => 'f'
See Getopt::Complete::Compgen for specifics on using builtin
completions.
See "man bash", in the Programmable Complete secion, and the "compgen"
builtin command for more details.
UNLISTED VALID VALUES
If there are options which should not be part of completion lists, but
still count as valid if passed-into the app, they can be in a final
sub-array at the end. This list doesn't affect the completion system at
all, just prevents errors in the ERRORS array described above.
use Getopt::Complete (
'color' => ['red','green','blue', ['yellow','orange']],
);
myprogram --color
red green blue
myprogram --color orange
# no errors
myprogram --color purple
# error
PARTIAL COMPLETIONS
BASICS
Any returned value ending in a character ("\t") will be
considered a "partial" completion. This means that the shell will be
instructed to leave the cursor at the end of that word even if there
is no ambiguity in the rest of the returned list.
Partial completions are only usable from callbacks. From a
hard-coded array of values, it would be impossible to ever fuly
complete the partial completion.
BACKGROUND
Sometimes, the entire list of completions is too big to reasonable
resolve and return. The most obvious example is filename completion
at the root of a large filesystem. In these cases, the completion of
is handled in pieces, allowing the user to gradually "drill down" to
the complete value directory by directory. It is even possible to
hit to get one completion, then hit it again and get more
completion, in the case of single-sub-directory directories.
The Getopt::Complete module supports iterative drill-down
completions from any parameter configured with a callback. It is
completely valid to complete "a" with "aa" "ab" and "ac", but then
to complete "ab" with yet more text.
Unless the shell knows, however that your "aa", "ab", and "ac"
completions are in fact only partial completions, an inconvenient
space will be added after the word on the terminal line, as the
shell happily moves on to helping the user enter the next argument.
DETAILS
Because partial completions are indicated in Getopt::Complete by
adding a "\t" tab character to the end of the returned string, an
application can return a mix of partial and full completions, and it
will respect each correctly.
Note: The "\t" is actually stripped-off before going to the shell
and internal hackery is used to force the shell to not put a space
where it isn't needed. This is not part of the bash programmable
completion specification, but is used to simulate features typically
only available with bash for builtin completions like
files/directories.
SUB-COMMAND TREES
It is common for a given appliction to actually be an entry point for
several different tools. Popular exmples are the big version control
suites (cvs,svn,svk,git), which use the form:
cvs SUBCOMMAND [ARGS]
Each sub-command has its own options specification. Those may in turn
have further sub-commands.
Sub-commands are identified by an initial '>' in the options
specification key. The value is interpreted as a complete, isolated
options spec, using the same general syntax. This applies recursively.
EXAMPLE COMMAND TREE SPEC
use Getopt::Complete (
'>animal' => [
'>dog' => [
'>bark' => [
'ferocity' => ['yip','wail','ruf','grrrr'],
'count' => ['1','2','one too many'],
],
'>drool' => [
'buckets=n' => undef,
'lick' => 'users',
],
'list!' => undef,
],
'>cat' => [
'>purr' => [],
'>meow' => [
'volume=n' => undef,
'bass' => ['low','medium','high'],
]
],
],
'>plant' => [
'>taters' => [
'>fry' => [
'greasiness' => ['crispy','drippy'],
'width' => ['fat','thin','frite'],
],
'>bake' => [
'hard!' => undef,
'temp=n' => undef,
],
],
'>dasies' => [
'>pick' => [
'<>' => ['mine','yours','theirs'],
],
'>plant' => [
'season' => ['winter','spring','summer','fall'],
'seeds=n' => undef,
'deep!' => undef,
]
]
]
);
my ($word1,$word2,$word3) = $ARGS->parent_sub_commands;
# (the above is also in $ARGS{'>'} for non-OO access)
# your program probably has something smarter to decide where to go
# for a given command
if ($word1 eq 'animal') {
if ($word2 eq 'dog') {
if ($word3 eq 'bark') {
# work with %ARGS for barking dogs...
# ....
}
}
}
elsif ($path[0] eq 'plant') {
...
}
The above example specifies two sub-commands "animal" and "plant, each
of which has its own two sub-commands, dog/cat and taters/dasies. Each
of those, in turn, have two sub-commands, for a total of 8 complete
commands possible, each with different arguments. Each of the 8 has
thier own options specification.
When the program executes, the %ARGS hash contains option/value pairs
for the specific command chosen. The the series of sub-command choices
in $ARGS{'>'}, separate from the regular bare arguments in '<>'. (The
method name on an $ARGS object for this is "parent_sub_commands", a
companion to the "bare_args" method.
The method to determine the next available sub-commands is just
"sub_commands".)
Note that, since the user can hit at any time, it is possible
that the parent_sub_commands will be a partial drill-down. It isn't
uncommon to have something like this in place:
if (my @next = $ARGS->sub_commands) {
print STDERR "Please select a sub-command:\n";
print STDERR join("\n", @sub_commands),"\n";
exit 1;
}
The above checking is not done automatically, since a sub-command may
have further sub-commands, but still also be used directly, possibly
with other option and bare arguments.
THE LONE DASH
A lone dash is often used to represent using STDIN instead of a file for
applications which otherwise take filenames.
This is supported by all options which complete with the "files"
builtin, though it does not appear in completion hint displays.
To disable this, set $Getopt::Complete::LONE_DASH = 0.
OVERRIDING COMPILE-TIME OPTION PARSING
Getopt::Complete makes a lot of assumptions in order to be easy to use
in the default case. Here is how to override that behavior if it's not
what you want.
OPTION 1: DOING CUSTOM ERROR HANDLING
To prevent Getopt::Complete from exiting at compile time if there
are errors, the EXIT_ON_ERRORS flag should be set to 0 first, at
compile time, before using the Getopt::Complete module as follows:
BEGIN { $Getopt:Complete::EXIT_ON_ERRORS = 0; }
This should not affect completions in any way (it will still exit if
it realizes it is talking to bash, to prevent accidentally running
your program).
Errors are retained in:
$Getopt::Complete::ARGS->errors;
It is then up to the application to not run with invalid parameters.
OPTION 2: RE-PROCESS @ARGV
This module restores @ARGV to its original state after processing,
so independent option processing can be done if necessary. The full
spec imported by Getopt::Complete is stored as:
$Getopt::Complete::ARGS->option_specs;
This is an easy option when upgrading old applications.
Combined with disabling the EXIT_ON_ERROS flag above, set, you can
completely ignore, or partially ignore, the options processing which
happens automatically.
OPTION 3: CHANGING COMPILE-TIME PROCESSING
You can also adjust how option processing happens inside of
Getopt::Complete. Getopt::Complete wraps Getopt::Long to do the
underlying option parsing. It uses GetOptions(\%h, @specification)
to produce the %ARGS hash. Customization of Getopt::Long should
occur in a BEGIN block before using Getopt::Complete.
OPTION 4: USE THE OBJECTS AND WRITE YOUR OWN LOGIC
The logic in import() is very short, and is simple to modify. It is
best to do it in a BEGIN {} block so that bash can use 'perl -c
myprogram' to get completions at compile time.
BEGIN {
my $options = Getopt::Complete::Options->new(
'myfile' => 'f',
'mychoice' => ['small','medium','huge']
);
$options->handle_shell_completion();
my $args = Getopt::Complete::Args->new(
options => $options,
argv => [@ARGV]
);
if (my @errors = $ARGS->errors) {
for my $error ($ARGS->errors) {
chomp $error;
warn __PACKAGE__ . ' ERROR:' . $error . "\n";
}
exit 1;
}
# make the %ARGS available to all of the app
$args->__install_as_default__;
# if you also want %ARGS and $ARGS here when you're finished...
Getopt:Complete->export_aliases(__PACKAGE__);
};
EXTENSIVE USAGE EXAMPLE
Cut-and-paste this into a script called "myprogram" in your path, make
it executable, and then run this in the shell: complete -C myprogram
myprogram. Then try it out. It does one of everything, besides command
trees.
#!/usr/bin/env perl
use strict;
use warnings;
use Getopt::Complete (
# list the explicit values which are valid for this option
'frog' => ['ribbit','urp','ugh'],
# you can add any valid Getopt::Long specification to the key on the left
# ...if you put nothing: "=s" is assumed
'names=s@' => ['eenie','meanie','miney'],
# support for Bash "compgen" builtins is present with some pre-made callbacks
'myfile' => 'Getopt::Complete::Compgen::files',
'mydir' => 'Getopt::Complete::Compgen::directories',
# the plain name or first letter of the compgen builtins also work
'myfile2' => 'files',
'myfile3' => 'f',
# handle unnamed arguments from the command-line ("non-option" arguments) with a special key:
'<>' => ['some','raw','words'],
# CODE callbacks allow a the completion list to be dynamically resolved
'fraggle' => sub { return ['rock','roll','fried fish','fried taters','fries and squid'] },
# callbacks get extra info to help them, including the part of the
# word already typed, and the remainder of the options already processed for context
'type' => ['people','places'],
'instance'=> sub {
my ($command, $partial_word, $option_name, $other_opts_hashref) = @_;
# be lazy and ignore the partial word: bash will compensate
if (my $type = $other_opts_hashref->{type}) {
if ($type eq 'people') {
return [qw/larry moe curly/]
}
elsif ($type eq 'places') {
return [qw/here there everywhere/],
}
}
return [];
},
# undef means we don't know how to complete the value: any value specified will do
# this will result in no shell ompletions, but will still expect a value to be entered
'name=s' => undef,
# boolean values never have a completion list, and will yell if you are that foolish
# this will give you --no-fast for free as well
'fast!' => undef,
);
use Data::Dumper;
print "The arguments are: " . Dumper(\%ARGS);
DEVELOPMENT
Patches are welcome.
http://github.com/sakoht/Getopt--Complete-for-Perl/
git clone git://github.com/sakoht/Getopt--Complete-for-Perl.git
As are complaints. Help us find bugs by sending an email to the address
below, or using CPAN's bug tracking system:
https://rt.cpan.org/
The latest version of this module is always availabe on CPAN:
http://search.cpan.org/search?query=Getopt%3A%3AComplete&mode=all
And is readily installable with the CPAN shell on Mac, Linux, and other
Unix-like systems:
sudo cpan Getopt::Complete
BUGS
Completions with whitespace work, but they do so by escaping whitespace
characters instead of quoting. Support should be present for completing
quoted text. It should also be the default, since it is more attractive.
The logic to "shorten" the completion options shown in some cases is
still in development. This means that filename completion shows full
paths as options instead of just the last word in the file path.
Some uses of Getopt::Long will not work currently: multi-name options
(though standard shortening works), +, :, %.
Currently this module only supports bash, though other shells could be
added easily.
There is logic in development to have the tool possibly auto-update the
user's .bashrc / .bash_profile, but this is incomplete.
SEE ALSO
Getopt::Complete::Args
the object API for the option/value argument set
Getopt::Complete::Options
the object API for the options specification
Getopt::Complete::Compgen
supplies builtin completions like file lists
Getopt::Long
the definitive options parser, wrapped by this module
bash
the manual page for bash has lots of info on how tab-completion
works
COPYRIGHT
Copyright 2009 Scott Smith and Washington University School of Medicine
AUTHORS
Scott Smith (sakoht at cpan .org)
LICENSE
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
The full text of the license can be found in the LICENSE file included
with this module.
Getopt-Complete-0.26/t 000755 030216 023421 0 11625061503 14347 5 ustar 00nnutter gsc 000000 000000 Getopt-Complete-0.26/t/04-exercise.t 000444 030216 023421 325 11625061503 16701 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/env perl
use strict;
use warnings;
use Test::More tests => 1;
use FindBin;
my $path = $FindBin::Bin . '/myprogram';
ok(-e $path, "found the test program ($path)");
$ENV{GETOPT_COMPLETE} = 'bash';
Getopt-Complete-0.26/t/demoapp 000555 030216 023421 150 11625061503 16033 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/env perl
use strict;
use warnings;
use Getopt::Complete::Cache file => __FILE__ . ".opts";
Getopt-Complete-0.26/t/01-try-many.t 000444 030216 023421 135 11625061503 16646 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/perl
use strict;
use warnings;
use Test::More skip_all => 'not functioning yet';
Getopt-Complete-0.26/t/mytreeapp 000555 030216 023421 2444 11625061503 16444 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/env perl
use strict;
use Data::Dumper;
use Getopt::Complete (
'>animal' => [
'>dog' => [
'>bark' => [
'ferocity' => ['yip','wail','ruf','grrrr'],
'count' => ['1','2','one too many'],
],
'>drool' => [
'buckets=n' => undef,
'lick' => 'users',
],
'list!' => undef,
],
'>cat' => [
'>purr' => [],
'>meow' => [
'volume=n' => undef,
'bass' => ['low','medium','high'],
]
],
],
'>plant' => [
'>taters' => [
'>bake' => [
'hard!' => undef,
'temp=n' => undef,
],
'>fry' => [
'greasiness' => ['crispy','drippy'],
'width' => ['fat','thin','frite'],
]
],
'>daisies' => [
'>pick' => [
'<>' => ['mine','yours','theirs'],
],
'>plant' => [
'season' => ['winter','spring','summer','fall'],
'seeds=n' => undef,
'deep!' => undef,
]
]
],
);
print Dumper($ARGS);
1;
Getopt-Complete-0.26/t/demoapp.opts 000444 030216 023421 736 11625061503 17026 0 ustar 00nnutter gsc 000000 000000 $demoapp::OPTS_SPEC = [
'>model',
[
'>build',
[
'filter=s',
'files',
'show=s',
'files',
'noheaders!',
undef,
'style=s',
undef,
'help!',
undef
],
'help!',
undef
],
'>project',
[
'>list',
[
'filter=s',
'files',
'show=s',
'files',
'noheaders!',
undef,
'style=s',
undef,
'help!',
undef
],
'help!',
undef
],
];
Getopt-Complete-0.26/t/05-bad-arg-name.t 000444 030216 023421 452 11625061503 17307 0 ustar 00nnutter gsc 000000 000000 require Getopt::Complete;
use Test::More tests => 1;
my $args = Getopt::Complete::Args->new(
options => Getopt::Complete::Options->new('foo!' => undef),
argv => ['--bar']
);
ok(scalar(grep { /Unknown option: bar/ } $args->errors), "detected an error when a nonsense argumetn is used");
Getopt-Complete-0.26/t/02-boilerplate.t 000555 030216 023421 2326 11625061503 17420 0 ustar 00nnutter gsc 000000 000000 #!perl -T
use strict;
use warnings;
use Test::More tests => 3;
sub not_in_file_ok {
my ($filename, %regex) = @_;
open my $fh, "<", $filename
or die "couldn't open $filename for reading: $!";
my %violated;
while (my $line = <$fh>) {
while (my ($desc, $regex) = each %regex) {
if ($line =~ $regex) {
push @{$violated{$desc}||=[]}, $.;
}
}
}
if (%violated) {
fail("$filename contains boilerplate text");
diag "$_ appears on lines @{$violated{$_}}" for keys %violated;
} else {
pass("$filename contains no boilerplate text");
}
}
not_in_file_ok(README =>
"The README is used..." => qr/The README is used/,
"'version information here'" => qr/to provide version information/,
);
not_in_file_ok(Changes =>
"placeholder date/time" => qr(Date/time)
);
sub module_boilerplate_ok {
my ($module) = @_;
not_in_file_ok($module =>
'the great new $MODULENAME' => qr/ - The great new /,
'boilerplate description' => qr/Quick summary of what the module/,
'stub function definition' => qr/function[12]/,
);
}
module_boilerplate_ok('lib/Getopt/Complete.pm');
Getopt-Complete-0.26/t/00-load.t 000555 030216 023421 236 11625061503 16011 0 ustar 00nnutter gsc 000000 000000 #!perl -T
use Test::More tests => 1;
BEGIN {
use_ok( 'Getopt::Complete' );
}
diag( "Testing Getopt::Complete $Getopt::Complete::VERSION, Perl $], $^X" );
Getopt-Complete-0.26/t/01-try-many.in 000444 030216 023421 643 11625061503 17015 0 ustar 00nnutter gsc 000000 000000 myprogram
myprogram --frog ribbitx
myprogram --frog ribbit
myprogram --type people --instance larry
myprogram x y
myprogram lib/Getopt/
myprogram --myfile d1/
myprogram --myfile d1/ --no-go
myprogram --myfile d1/ --no-fast --go --no-go
myprogram --myfile d1/ --no-fast --go
myprogram --go
myprogram --go --no-go --myfile d1/
myprogram --go --no-go --myfile d1/ "foo bar"
myprogram --go --no-go --myfile d1/ lib/
Getopt-Complete-0.26/t/myprogram 000555 030216 023421 4253 11625061503 16453 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/env perl
use strict;
use Data::Dumper;
use Getopt::Complete (
# list the explicit values which are valid for this option
'frog' => ['ribbit','urp','ugh'],
# you can add any valid Getopt::Long specification to the key
# if you put nothing: "=s" is assumed
'names=s@' => ['eenie','meanie','miney'],
# undef means we don't know how to complete the value: any value specified will do
# this will result in no shell ompletions, but will still expect a value to be entered
# unless it is boolean
'name=s' => undef,
# boolean values never have a completion list, and will yell if you are that foolish
'go!' => undef,
'fast!' => undef,
# handle unnamed arguments from the command-line ("non-option" arguments) with a spcial key:
# you can control completions on these too...
'<>' => 'd',
# CODE callbacks allow a the completion list to be dynamically resolved
'fraggle' => sub { return ['rock','roll','fried fish','fried taters','fries and squid'] },
# support for Bash "compgen" builtins is present with some pre-made callbacks
'myfile' => \&Getopt::Complete::files,
'mydir' => \&Getopt::Complete::directories,
# callbacks get extra info to help them, including the part of the
# word already typed, and the remainder of the options already processed for context
'type' => ['people','places'],
'instance'=> sub {
my ($command, $value, $key, $other_opts) = @_;
if (my $type = $other_opts->{type}) {
if ($type eq 'people') {
return [qw/larry moe curly/]
}
elsif ($type eq 'places') {
return [qw/here there everywhere/],
}
}
return [];
},
# we used-to fail to process these
'dash-key' => ['dancer','prancer','vixen'],
# options with dashes in the values are confusing to the user, but not the app...
'valdash' => [qw/-a -b -bc -bd/],
);
print Dumper($ARGS);
1;
Getopt-Complete-0.26/t/03-demoapp-completion.t 000444 030216 023421 3233 11625061503 20706 0 ustar 00nnutter gsc 000000 000000 #!/usr/bin/env perl
use strict;
use warnings;
use Test::More;
use FindBin;
local $ENV{PATH} = $FindBin::Bin . ':' . $ENV{PATH};
my $path = 'demoapp';
plan tests => 12;
ok(-e $FindBin::Bin . '/' . $path, "found the demo program ($path)");
ok(test_completion("$path model build ") > 0, 'results for valid sub-command');
ok(test_completion("$path model buil") > 0, 'results for valid partial sub-command');
ok(test_completion("$path projectx ") == 0, 'no results for bad sub-command');
ok(test_completion("$path project list --filter name=foo ") > 0, 'results for valid option-space-argument');
ok(test_completion("$path project list --filter=name=foo ") > 0, 'results for valid option-equals-argument');
ok(test_completion("$path model --help foo ") == 0, 'no results for invalid argument');
ok(test_completion("$path model --help foo") == 0, 'no results for non-argument option');
ok(test_completion("$path project list --filter name=foo") == 0, 'no results for option argument');
ok(test_completion("$path project list --fooba") == 0, 'no results for unknown option');
ok(test_completion("$path project list --fooba $FindBin::Bin") > 0, 'file completion for unknown option');
ok(test_completion("$path project list $FindBin::Bin") > 0, 'file completion for bare args');
sub test_completion {
my $line = shift;
my @args = split(' ', $line);
my $COMP_CWORD = $#args;
if($line =~ m/\s$/) { $COMP_CWORD++; } #actually want to complete a new word
my $command = $args[0];
my @results = split("\n", `COMP_CWORD=$COMP_CWORD $command $line`);
print "Found " . scalar(@results) . " fresults for '$line': " . join(', ', @results) . "\n";
return scalar(@results);
}
Getopt-Complete-0.26/doc 000755 030216 023421 0 11625061503 14651 5 ustar 00nnutter gsc 000000 000000 Getopt-Complete-0.26/doc/getopt-complete.odp 000444 030216 023421 45324 11625061503 20652 0 ustar 00nnutter gsc 000000 000000 PK ð¾õ<3&¬¨/ / mimetypeapplication/vnd.oasis.opendocument.presentationPK ð¾õ<