From e9cb3964def1634b7bf256749a50bd3b3f5e2261 Mon Sep 17 00:00:00 2001 From: "Aaron M. Renn" Date: Mon, 11 Sep 2000 12:00:00 +0000 Subject: [PATCH 1/8] Release 1.0.8 Ernst de Haan provided Dutch language messages. --- gnu/getopt/COPYING.LIB | 482 ++++++++ gnu/getopt/ChangeLog | 82 ++ gnu/getopt/Getopt.class | Bin 0 -> 7474 bytes gnu/getopt/Getopt.java | 1338 +++++++++++++++++++++++ gnu/getopt/GetoptDemo.class | Bin 0 -> 2529 bytes gnu/getopt/GetoptDemo.java | 97 ++ gnu/getopt/LongOpt.class | Bin 0 -> 1600 bytes gnu/getopt/LongOpt.java | 196 ++++ gnu/getopt/Makefile | 7 + gnu/getopt/MessagesBundle.properties | 33 + gnu/getopt/MessagesBundle_cs.properties | 33 + gnu/getopt/MessagesBundle_de.properties | 33 + gnu/getopt/MessagesBundle_fr.properties | 35 + gnu/getopt/MessagesBundle_nl.properties | 32 + gnu/getopt/MessagesBundle_no.properties | 32 + gnu/getopt/README | 43 + gnu/getopt/gnu.getopt.Getopt.html | 639 +++++++++++ gnu/getopt/gnu.getopt.LongOpt.html | 210 ++++ 18 files changed, 3292 insertions(+) create mode 100644 gnu/getopt/COPYING.LIB create mode 100644 gnu/getopt/ChangeLog create mode 100644 gnu/getopt/Getopt.class create mode 100644 gnu/getopt/Getopt.java create mode 100644 gnu/getopt/GetoptDemo.class create mode 100644 gnu/getopt/GetoptDemo.java create mode 100644 gnu/getopt/LongOpt.class create mode 100644 gnu/getopt/LongOpt.java create mode 100644 gnu/getopt/Makefile create mode 100644 gnu/getopt/MessagesBundle.properties create mode 100644 gnu/getopt/MessagesBundle_cs.properties create mode 100644 gnu/getopt/MessagesBundle_de.properties create mode 100644 gnu/getopt/MessagesBundle_fr.properties create mode 100644 gnu/getopt/MessagesBundle_nl.properties create mode 100644 gnu/getopt/MessagesBundle_no.properties create mode 100644 gnu/getopt/README create mode 100644 gnu/getopt/gnu.getopt.Getopt.html create mode 100644 gnu/getopt/gnu.getopt.LongOpt.html diff --git a/gnu/getopt/COPYING.LIB b/gnu/getopt/COPYING.LIB new file mode 100644 index 0000000..161a3d1 --- /dev/null +++ b/gnu/getopt/COPYING.LIB @@ -0,0 +1,482 @@ + GNU LIBRARY GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1991 Free Software Foundation, Inc. + 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + +[This is the first released version of the library GPL. It is + numbered 2 because it goes with version 2 of the ordinary GPL.] + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +Licenses are intended to guarantee your freedom to share and change +free software--to make sure the software is free for all its users. + + This license, the Library General Public License, applies to some +specially designated Free Software Foundation software, and to any +other libraries whose authors decide to use it. You can use it for +your libraries, 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 +this service 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 make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if +you distribute copies of the library, or if you modify it. + + For example, if you distribute copies of the library, whether gratis +or for a fee, you must give the recipients all the rights that we gave +you. You must make sure that they, too, receive or can get the source +code. If you link a program with the library, you must provide +complete object files to the recipients so that they can relink them +with the library, after making changes to the library and recompiling +it. And you must show them these terms so they know their rights. + + Our method of protecting your rights has two steps: (1) copyright +the library, and (2) offer you this license which gives you legal +permission to copy, distribute and/or modify the library. + + Also, for each distributor's protection, we want to make certain +that everyone understands that there is no warranty for this free +library. If the library is modified by someone else and passed on, we +want its recipients to know that what they have is not the original +version, so that any problems introduced by others will not reflect on +the original authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that companies distributing free +software will individually obtain patent licenses, thus in effect +transforming the program into proprietary software. To prevent this, +we have made it clear that any patent must be licensed for everyone's +free use or not licensed at all. + + Most GNU software, including some libraries, is covered by the ordinary +GNU General Public License, which was designed for utility programs. This +license, the GNU Library General Public License, applies to certain +designated libraries. This license is quite different from the ordinary +one; be sure to read it in full, and don't assume that anything in it is +the same as in the ordinary license. + + The reason we have a separate public license for some libraries is that +they blur the distinction we usually make between modifying or adding to a +program and simply using it. Linking a program with a library, without +changing the library, is in some sense simply using the library, and is +analogous to running a utility program or application program. However, in +a textual and legal sense, the linked executable is a combined work, a +derivative of the original library, and the ordinary General Public License +treats it as such. + + Because of this blurred distinction, using the ordinary General +Public License for libraries did not effectively promote software +sharing, because most developers did not use the libraries. We +concluded that weaker conditions might promote sharing better. + + However, unrestricted linking of non-free programs would deprive the +users of those programs of all benefit from the free status of the +libraries themselves. This Library General Public License is intended to +permit developers of non-free programs to use free libraries, while +preserving your freedom as a user of such programs to change the free +libraries that are incorporated in them. (We have not seen how to achieve +this as regards changes in header files, but we have achieved it as regards +changes in the actual functions of the Library.) The hope is that this +will lead to faster development of free libraries. + + The precise terms and conditions for copying, distribution and +modification follow. Pay close attention to the difference between a +"work based on the library" and a "work that uses the library". The +former contains code derived from the library, while the latter only +works together with the library. + + Note that it is possible for a library to be covered by the ordinary +General Public License rather than by this special one. + + GNU LIBRARY GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License Agreement applies to any software library which +contains a notice placed by the copyright holder or other authorized +party saying it may be distributed under the terms of this Library +General Public License (also called "this License"). Each licensee is +addressed as "you". + + A "library" means a collection of software functions and/or data +prepared so as to be conveniently linked with application programs +(which use some of those functions and data) to form executables. + + The "Library", below, refers to any such software library or work +which has been distributed under these terms. A "work based on the +Library" means either the Library or any derivative work under +copyright law: that is to say, a work containing the Library or a +portion of it, either verbatim or with modifications and/or translated +straightforwardly into another language. (Hereinafter, translation is +included without limitation in the term "modification".) + + "Source code" for a work means the preferred form of the work for +making modifications to it. For a library, complete source code means +all the source code for all modules it contains, plus any associated +interface definition files, plus the scripts used to control compilation +and installation of the library. + + Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running a program using the Library is not restricted, and output from +such a program is covered only if its contents constitute a work based +on the Library (independent of the use of the Library in a tool for +writing it). Whether that is true depends on what the Library does +and what the program that uses the Library does. + + 1. You may copy and distribute verbatim copies of the Library's +complete source code as you receive it, in any medium, provided that +you conspicuously and appropriately publish on each copy an +appropriate copyright notice and disclaimer of warranty; keep intact +all the notices that refer to this License and to the absence of any +warranty; and distribute a copy of this License along with the +Library. + + You may charge a fee for the physical act of transferring a copy, +and you may at your option offer warranty protection in exchange for a +fee. + + 2. You may modify your copy or copies of the Library or any portion +of it, thus forming a work based on the Library, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) The modified work must itself be a software library. + + b) You must cause the files modified to carry prominent notices + stating that you changed the files and the date of any change. + + c) You must cause the whole of the work to be licensed at no + charge to all third parties under the terms of this License. + + d) If a facility in the modified Library refers to a function or a + table of data to be supplied by an application program that uses + the facility, other than as an argument passed when the facility + is invoked, then you must make a good faith effort to ensure that, + in the event an application does not supply such function or + table, the facility still operates, and performs whatever part of + its purpose remains meaningful. + + (For example, a function in a library to compute square roots has + a purpose that is entirely well-defined independent of the + application. Therefore, Subsection 2d requires that any + application-supplied function or table used by this function must + be optional: if the application does not supply it, the square + root function must still compute square roots.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Library, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Library, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote +it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Library. + +In addition, mere aggregation of another work not based on the Library +with the Library (or with a work based on the Library) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may opt to apply the terms of the ordinary GNU General Public +License instead of this License to a given copy of the Library. To do +this, you must alter all the notices that refer to this License, so +that they refer to the ordinary GNU General Public License, version 2, +instead of to this License. (If a newer version than version 2 of the +ordinary GNU General Public License has appeared, then you can specify +that version instead if you wish.) Do not make any other change in +these notices. + + Once this change is made in a given copy, it is irreversible for +that copy, so the ordinary GNU General Public License applies to all +subsequent copies and derivative works made from that copy. + + This option is useful when you wish to copy part of the code of +the Library into a program that is not a library. + + 4. You may copy and distribute the Library (or a portion or +derivative of it, under Section 2) in object code or executable form +under the terms of Sections 1 and 2 above provided that you accompany +it with the complete corresponding machine-readable source code, which +must be distributed under the terms of Sections 1 and 2 above on a +medium customarily used for software interchange. + + If distribution of object code is made by offering access to copy +from a designated place, then offering equivalent access to copy the +source code from the same place satisfies the requirement to +distribute the source code, even though third parties are not +compelled to copy the source along with the object code. + + 5. A program that contains no derivative of any portion of the +Library, but is designed to work with the Library by being compiled or +linked with it, is called a "work that uses the Library". Such a +work, in isolation, is not a derivative work of the Library, and +therefore falls outside the scope of this License. + + However, linking a "work that uses the Library" with the Library +creates an executable that is a derivative of the Library (because it +contains portions of the Library), rather than a "work that uses the +library". The executable is therefore covered by this License. +Section 6 states terms for distribution of such executables. + + When a "work that uses the Library" uses material from a header file +that is part of the Library, the object code for the work may be a +derivative work of the Library even though the source code is not. +Whether this is true is especially significant if the work can be +linked without the Library, or if the work is itself a library. The +threshold for this to be true is not precisely defined by law. + + If such an object file uses only numerical parameters, data +structure layouts and accessors, and small macros and small inline +functions (ten lines or less in length), then the use of the object +file is unrestricted, regardless of whether it is legally a derivative +work. (Executables containing this object code plus portions of the +Library will still fall under Section 6.) + + Otherwise, if the work is a derivative of the Library, you may +distribute the object code for the work under the terms of Section 6. +Any executables containing that work also fall under Section 6, +whether or not they are linked directly with the Library itself. + + 6. As an exception to the Sections above, you may also compile or +link a "work that uses the Library" with the Library to produce a +work containing portions of the Library, and distribute that work +under terms of your choice, provided that the terms permit +modification of the work for the customer's own use and reverse +engineering for debugging such modifications. + + You must give prominent notice with each copy of the work that the +Library is used in it and that the Library and its use are covered by +this License. You must supply a copy of this License. If the work +during execution displays copyright notices, you must include the +copyright notice for the Library among them, as well as a reference +directing the user to the copy of this License. Also, you must do one +of these things: + + a) Accompany the work with the complete corresponding + machine-readable source code for the Library including whatever + changes were used in the work (which must be distributed under + Sections 1 and 2 above); and, if the work is an executable linked + with the Library, with the complete machine-readable "work that + uses the Library", as object code and/or source code, so that the + user can modify the Library and then relink to produce a modified + executable containing the modified Library. (It is understood + that the user who changes the contents of definitions files in the + Library will not necessarily be able to recompile the application + to use the modified definitions.) + + b) Accompany the work with a written offer, valid for at + least three years, to give the same user the materials + specified in Subsection 6a, above, for a charge no more + than the cost of performing this distribution. + + c) If distribution of the work is made by offering access to copy + from a designated place, offer equivalent access to copy the above + specified materials from the same place. + + d) Verify that the user has already received a copy of these + materials or that you have already sent this user a copy. + + For an executable, the required form of the "work that uses the +Library" must include any data and utility programs needed for +reproducing the executable from it. However, as a special exception, +the source code distributed need not include anything that is normally +distributed (in either source or binary form) with the major +components (compiler, kernel, and so on) of the operating system on +which the executable runs, unless that component itself accompanies +the executable. + + It may happen that this requirement contradicts the license +restrictions of other proprietary libraries that do not normally +accompany the operating system. Such a contradiction means you cannot +use both them and the Library together in an executable that you +distribute. + + 7. You may place library facilities that are a work based on the +Library side-by-side in a single library together with other library +facilities not covered by this License, and distribute such a combined +library, provided that the separate distribution of the work based on +the Library and of the other library facilities is otherwise +permitted, and provided that you do these two things: + + a) Accompany the combined library with a copy of the same work + based on the Library, uncombined with any other library + facilities. This must be distributed under the terms of the + Sections above. + + b) Give prominent notice with the combined library of the fact + that part of it is a work based on the Library, and explaining + where to find the accompanying uncombined form of the same work. + + 8. You may not copy, modify, sublicense, link with, or distribute +the Library except as expressly provided under this License. Any +attempt otherwise to copy, modify, sublicense, link with, or +distribute the Library is void, and will automatically terminate your +rights under this License. However, parties who have received copies, +or rights, from you under this License will not have their licenses +terminated so long as such parties remain in full compliance. + + 9. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Library or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Library (or any work based on the +Library), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Library or works based on it. + + 10. Each time you redistribute the Library (or any work based on the +Library), the recipient automatically receives a license from the +original licensor to copy, distribute, link with or modify the Library +subject to these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 11. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +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 +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Library at all. For example, if a patent +license would not permit royalty-free redistribution of the Library by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Library. + +If any portion of this section is held invalid or unenforceable under any +particular circumstance, the balance of the section is intended to apply, +and the section as a whole is intended to apply in other circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 12. If the distribution and/or use of the Library is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Library under this License may add +an explicit geographical distribution limitation excluding those countries, +so that distribution is permitted only in or among countries not thus +excluded. In such case, this License incorporates the limitation as if +written in the body of this License. + + 13. The Free Software Foundation may publish revised and/or new +versions of the Library 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 Library +specifies a version number of this License which applies to it and +"any later version", you have the option of following the terms and +conditions either of that version or of any later version published by +the Free Software Foundation. If the Library does not specify a +license version number, you may choose any version ever published by +the Free Software Foundation. + + 14. If you wish to incorporate parts of the Library into other free +programs whose distribution conditions are incompatible with these, +write to the author to ask for permission. For software which is +copyrighted by the Free Software Foundation, write to the Free +Software Foundation; we sometimes make exceptions for this. Our +decision will be guided by the two goals of preserving the free status +of all derivatives of our free software and of promoting the sharing +and reuse of software generally. + + NO WARRANTY + + 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO +WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. +EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR +OTHER PARTIES PROVIDE THE LIBRARY "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 +LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME +THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN +WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY +AND/OR REDISTRIBUTE THE LIBRARY 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 +LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF +SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH +DAMAGES. + + END OF TERMS AND CONDITIONS + + Appendix: How to Apply These Terms to Your New Libraries + + If you develop a new library, and you want it to be of the greatest +possible use to the public, we recommend making it free software that +everyone can redistribute and change. You can do so by permitting +redistribution under these terms (or, alternatively, under the terms of the +ordinary General Public License). + + To apply these terms, attach the following notices to the library. It is +safest to attach them to the start of each source file to most effectively +convey 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 library is free software; you can redistribute it and/or + modify it under the terms of the GNU Library General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later version. + + This library 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 + Library General Public License for more details. + + You should have received a copy of the GNU Library General Public + License along with this library; if not, write to the Free + Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, + MA 02111-1307, USA + +Also add information on how to contact you by electronic and paper mail. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the library, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the + library `Frob' (a library for tweaking knobs) written by James Random Hacker. + + , 1 April 1990 + Ty Coon, President of Vice + +That's all there is to it! diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog new file mode 100644 index 0000000..e96218a --- /dev/null +++ b/gnu/getopt/ChangeLog @@ -0,0 +1,82 @@ +For release 1.0.8 (2000/09/11) + +Ernst de Haan provided Dutch language messages. + +For release 1.0.7 (2000/02/02) + +Fixed an obscure POSIX compatibility issue. When an optstring is "o:", +then "-o -- foo" should result in -o having an optarg of "foo", not "--" +as was previously returned. This new parsing behavior is only enabled +in POSIX compatibility mode. Thank to Don Suit (dsuit@fc.hp.com) for +reporting this and help in communicating proper POSIX behavior. + +For release 1.0.6 (1999/06/27) + +Added French language messages. Thanks to Edouard G. Parmelan +(Edouard.Parmelan@quadratec.fr) for this contribution. + +For release 1.0.5 (1999/03/23) + +Fixed bug that caused getopt to throw a StringIndexOutOfBoundsException +when an empty string ("") argument was encountered. Thanks to +Steffen Siebert (siebert@logware.de) for this bug report and a patch. + +For release 1.0.4 + +Added Norwegian language messages. Thanks to Bjørn-Ove Heimsund +(s811@drone.ii.uib.no) for this contribution. + +For release 1.0.3 + +Added German language messages. Thanks to Bernhard Bablok +(bablokb@gmx.net) for this contribution. + +For release 1.0.2 + +Prevent ArrayIndexOutOfBounds exception if "optstring" is null. David Karr +(dkarr@nmo.gtegsc.com) had a problem with this when commenting out options +during debugging, so I have fixed it. + +For release 1.0.1 + +Added Czech language messages. Thanks to Roman Szturc (Roman.Szturc@vsb.cz) +for this contribution. + +For release 1.0 + +No changes. Just increment release number to 1.0 + +For release 0.9.2 + +The sample code has been moved into a separate file called "GetoptDemo.java". +This is so that it can be legally placed into the public domain and not +subsumed into the LGPL as would be the case if it were in Getopt.java. +While I do not encourage anyone to write proprietary software, I feel that +there is no good purpose served in restricting what someone can do with +a short example program. + +Modified the Makefile and various other files to support the change +above. + +For release 0.9.1 + +This release contains only minor fixes. It's always possible it introduces +some bugs though so unless you are keen on internationalization or are +having a line separator problem, there is no need to upgrade from 0.9. + +-- Messages are now internationalized. Thanks to Bill King + (wrking@eng.sun.com) for this. + +-- Changes all print's to println's to avoid system dependent line + separators. + +-- All internal variables are now protected. Several people suggested + doing this in response to my request for comments in the help file. + No one suggested keeping any variables public. + +-- Fixed parts of licensing that mentioned the regular GPL. Getopt is + and always has been licensed under the LPGL. Thanks to Arieh Markel + (arieh.markel@sun.com) for pointing this out. + + + diff --git a/gnu/getopt/Getopt.class b/gnu/getopt/Getopt.class new file mode 100644 index 0000000000000000000000000000000000000000..3d9a87982db0d10aff9448af75d540a85f24bb17 GIT binary patch literal 7474 zcmcgx3w)H-vHzcQ=G)z@3&cQxm>@5~ut`7yq6P?r5D?4D1Vlg#n`8-#o87S4VDM2; zu@y^;&r0GWL9o$^iqr(3pjD$)QPgU+itqOJp>4I*_Fk-X=KFS&1>*1acYpWZALh)Q zIWu!+=FH4Di7$Nf=sp+};O`z>ZU87*v@FJh?|N{H2irVo@!(kxx;%K!gXcZ?g$FNq z@S+DVd2qmkmpypZjaS?_=*BPIc*Bi1-T0LoZ@KZd8^3nr9XH1EnV zFY^V2RwXReB3mO%P{dXVRx8+QSwga`k>w&`4hvQ%OGK8aEcLRil_e%igDi0`2BJ~0 zbz<|yqO?ht^|D+dzFjK%F7u%oSITmgEI0XZFLwIy0PgZ(H@@$~gSg*^J=o;K&#=LV zhp@|s4qWR)C${^r7eDslVYK@22zL1JD6aS6FxkC{8niHA*a8S<@ZASgJ6G@gHQ28 zA3hV>pK*;3f5ne{_#3__%VrCD^|oeQeg1gqnd$1IcEQs@b*#fs6r(T`{S76oicuZsD?GkZ~dyxv|TF#TIa zQ-hljwMpf{hG=7~Iyj>-Qe(&ctX@D|d4X^v@4aPB)xr9Bh^Y!E%(fjED;2_0oM8Rth9bfFjdfMQ*rGsH zm<2MO$c3Wg7IN{#`QBilj#E41_=qYDK91O33JLzyoKQH);qN^w`r37QULY0{OW0iZ z!m{#tix-u#SLJ2rE}m0fR=J>jW?4C#U0$|marykpIrEbgZ-t#=vqIv7UR=TMNnQ2& zZVLT-39Uj}WnHkLAy6xKy8`v~!AK3qH4v*^$NTElfmlhLudZGltiC9b0vuKa5A)Rr zVhwz;E4a2X5N2@`jK$=niNzwdeBxUbiZ#S5Bhd(F5Nll(4%9OLs%We(!22{#EvG#A z$rzs*Toq^x^MP#SvXI!~=FR*-9jg<5PC>S<8@D+Ubo-7Im}g-uS|5zX*E?KJ67jWs zVzZ<>$k;$#Rj4);ZDh+&Op;=?jdj6DykUGVv_gfx3BFJ`9IOq5QwWiDfpCbe?U&$) zaZo}r32O4XB!$)VPcSt`V!`TYZ6tI_kVOadLbaJAjbrPh4WXv+`pW8Pj72y^C#IC< z?1W<(DYV2}DP*M(=Otb`8FcsRKtrV+PB#ZK*tB33+h%`Bj;@3x)&9Pea!v%Q<3WDv z^q#Md)4h%&B?CXOhsz;3<#IId`i6M0PGOME8xJIe79qFL%ROykSYmcDkXlDtX|EN1Zp|YUPZ@aGt9M^Vpfm z!`h1rnDDu!AnHG9tkoDF$evLTO2_BoGu4EwU}&A5TrTX{DcF18Ht z`t$M&l-Y~n5Asf-O=zqWdIHk)cw6Sigv_ZdWAXV3B9leE36;UCXV^kFIYKJNbG(a% zy8L@F)K49l?oXfAff<74%W{U_bRgHC(f?tb_AthEU}Qlj&TN4z!%eS(eg{VR z3p!Bh&tm=}f2P%evobQ&!zg@?jbZV!b_@_*WvpfoMkLgjPK-`3Xv0Zh8VQmi<*bI5Xz_Lk(p*;-#hfvmxH2d^HKi@jDCrB+ELg=L+^#an=LG)8cFhCQs zG>`jwD2D1`IEA5KUx4v?1t#j1I7nJW_ zxK=mdQr(D+dL6FO7vp-~-=NpyHhn3!>&tMDz8rga|1-S-kLoM1pW&1GYCOv}DSUw+ zCLV1fKPEpX(({s0ohwl-?eQc-5<$1Xt#9SmyB+=XHkN%78xk6ZFyw(67KfumGR?^n zmk{-CUO&e*yh>J$NL=RfXLq2a=L#pIo`j|MG3TG~Nq$#ytWXm; z_dRUqevV!KR9?;~mMBi5c5Ke1AvHsCYIfpmUMIQCBzHUV^KvrXD+`M(8|E=fPECza zDthoNt74N|Wx6w6+mF1SNtv!1QCB4D5?V$at!0R#KtQVOp`1+D%Bd{26P_VCJC4Ns zOW8;&vOJXV|25iw_AojDU%nzL{%?{6|w(9Ak^ni=RcrPyaOIe`2Ns1rc*Hx8eh z^K6rvD`hyv6q`xp*BzM5rWI#+Ix%T#j&9>Nz+2Ansb-SZj%wZ&Wm<)u7%y~_(~0kN zVoozRlim)-G-FWWV6NR=CXVYQX{~ zOmD_%))N@K)bM6@#ZqE0ihoK9D~eouAkiF|k=BU`S+0jMwiC1b8L9)t(!pj(@Jon; zUXng-S6-Le+C#`;Iq|I(2l5`m#Af@EirJ@goR&5~6c^{vO1rO3Ygc);UPean0ULES z1KSR&Da>%&ff##~ove0hiizG76WcM{mFm)C7_>A+owU%s7}klo6-%vS)SQr_CgCY_ z%wuQ8MfQZ+u#t61zKz;djA7jPWL>Uuy1ETg)zXE5kb& zZfCgD+^6nlc(1u%-ESUHd(Ce32;=+BL+V-6p$?e6>Y#a4y=5L(pO}5>bF*I^X8arT zw6@H%dYI|bBh7O<-#o9!GCt9~sEf=?dWJcm7nqlIxjCp8n_ueX=1pB?-qLH#+j^aO zM>m=G^yTJ5eWm%BYyX*K2T052`sWXnYn-2JWg0(XE~ky9cQIDng?<7uR42wXtJfGm zgMUhPayt+x!$qQ{^^l~)&9vIEC2@2{E3z211zXYA&cROPwPR!tb#OvmemnZ~YojC2iQB?|8O1U*0l(avSdJ zHn_#9(_&7pcC2G^GNl(fHvc|c4BfqC;Vs$uRWPK-GVETm5Vn$)!q(|)9^%hyON}L9;>BSZslW!|NAJU z7|8c=THMTFn$!@tfzAK#Cdh?HbvYgpb0uuW+1(#&{cHXo7%>0IBkN)GF<+yf`356M zqks%fC&F~Ha5lNIkWRoV@*%=-E%m`=)EAp51K+1iT+i@+>W^1xFy5x2_=<+}Up+>u zfpm&Gnc;96rSfUCnn<~7D*4qc8mG!>f?7cnRgfmBTAHk`r77xGDposan!1Zh)FU)Q zJw~(DOLVq6#P9<;M}1DqbsAluhtUdsCROUG6wouNO3$Lz`a%lnwRDkgqB^~qqWU(f z*R8Zx-%T-n591FoeGjeEPt(QvAj8)gzRB=yYSM=ozEA7*M|6q)BVDRLW&8`;p#MP| zjixJ%o31imy2kXU&E{mf*7z9~&=xa+eq>Ikt)_&oGw0F`W(D17YUyUPmToak)ND4; zZRR?<-Q2+NW`^4sw$L5sc4{^44DVx}-L%6zMLW&Y47(Wqg5isFmwB0fV%}o-9{tpO zOuNi)X*X%wLw)HX8ptq<_R=VNg!1Weno3X5G=?)6mNA@7`{*3nPm35Xqn}eHJxyVH zhN9F(F?xwM&;i;)2kClxjkeM2)Iz_aR(gx>p|@!l9b&2X`Sc@tmpv(*!&Vu?vl)Je;XL}Z2is}W_@W5xBg*`v<_QiTpr8Me-FuXon+;^Mp^}~Tx-0mz&f1=rJwR|ml}8c E3qu-gAOHXW literal 0 HcmV?d00001 diff --git a/gnu/getopt/Getopt.java b/gnu/getopt/Getopt.java new file mode 100644 index 0000000..598a1fa --- /dev/null +++ b/gnu/getopt/Getopt.java @@ -0,0 +1,1338 @@ +/************************************************************************** +/* Getopt.java -- Java port of GNU getopt from glibc 2.0.6 +/* +/* Copyright (c) 1987-1997 Free Software Foundation, Inc. +/* Java Port Copyright (c) 1998 by Aaron M. Renn (arenn@urbanophile.com) +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +package gnu.getopt; + +import java.util.Locale; +import java.util.ResourceBundle; +import java.util.PropertyResourceBundle; +import java.text.MessageFormat; + +/**************************************************************************/ + +/** + * This is a Java port of GNU getopt, a class for parsing command line + * arguments passed to programs. It it based on the C getopt() functions + * in glibc 2.0.6 and should parse options in a 100% compatible manner. + * If it does not, that is a bug. The programmer's interface is also + * very compatible. + *

+ * To use Getopt, create a Getopt object with a argv array passed to the + * main method, then call the getopt() method in a loop. It will return an + * int that contains the value of the option character parsed from the + * command line. When there are no more options to be parsed, it + * returns -1. + *

+ * A command line option can be defined to take an argument. If an + * option has an argument, the value of that argument is stored in an + * instance variable called optarg, which can be accessed using the + * getOptarg() method. If an option that requires an argument is + * found, but there is no argument present, then an error message is + * printed. Normally getopt() returns a '?' in this situation, but + * that can be changed as described below. + *

+ * If an invalid option is encountered, an error message is printed + * to the standard error and getopt() returns a '?'. The value of the + * invalid option encountered is stored in the instance variable optopt + * which can be retrieved using the getOptopt() method. To suppress + * the printing of error messages for this or any other error, set + * the value of the opterr instance variable to false using the + * setOpterr() method. + *

+ * Between calls to getopt(), the instance variable optind is used to + * keep track of where the object is in the parsing process. After all + * options have been returned, optind is the index in argv of the first + * non-option argument. This variable can be accessed with the getOptind() + * method. + *

+ * Note that this object expects command line options to be passed in the + * traditional Unix manner. That is, proceeded by a '-' character. + * Multiple options can follow the '-'. For example "-abc" is equivalent + * to "-a -b -c". If an option takes a required argument, the value + * of the argument can immediately follow the option character or be + * present in the next argv element. For example, "-cfoo" and "-c foo" + * both represent an option character of 'c' with an argument of "foo" + * assuming c takes a required argument. If an option takes an argument + * that is not required, then any argument must immediately follow the + * option character in the same argv element. For example, if c takes + * a non-required argument, then "-cfoo" represents option character 'c' + * with an argument of "foo" while "-c foo" represents the option + * character 'c' with no argument, and a first non-option argv element + * of "foo". + *

+ * The user can stop getopt() from scanning any further into a command line + * by using the special argument "--" by itself. For example: + * "-a -- -d" would return an option character of 'a', then return -1 + * The "--" is discarded and "-d" is pointed to by optind as the first + * non-option argv element. + *

+ * Here is a basic example of using Getopt: + *

+ * 

+  * Getopt g = new Getopt("testprog", argv, "ab:c::d");
+  * //
+  * int c;
+  * String arg;
+  * while ((c = g.getopt()) != -1)
+  *   {
+  *     switch(c)
+  *       {
+  *          case 'a':
+  *          case 'd':
+  *            System.out.print("You picked " + (char)c + "\n");
+  *            break;
+  *            //
+  *          case 'b':
+  *          case 'c':
+  *            arg = g.getOptarg();
+  *            System.out.print("You picked " + (char)c + 
+  *                             " with an argument of " +
+  *                             ((arg != null) ? arg : "null") + "\n");
+  *            break;
+  *            //
+  *          case '?':
+  *            break; // getopt() already printed an error
+  *            //
+  *          default:
+  *            System.out.print("getopt() returned " + c + "\n");
+  *       }
+  *   }
+  *
+ *

+ * In this example, a new Getopt object is created with three params. + * The first param is the program name. This is for printing error + * messages in the form "program: error message". In the C version, this + * value is taken from argv[0], but in Java the program name is not passed + * in that element, thus the need for this parameter. The second param is + * the argument list that was passed to the main() method. The third + * param is the list of valid options. Each character represents a valid + * option. If the character is followed by a single colon, then that + * option has a required argument. If the character is followed by two + * colons, then that option has an argument that is not required. + *

+ * Note in this example that the value returned from getopt() is cast to + * a char prior to printing. This is required in order to make the value + * display correctly as a character instead of an integer. + *

+ * If the first character in the option string is a colon, for example + * ":abc::d", then getopt() will return a ':' instead of a '?' when it + * encounters an option with a missing required argument. This allows the + * caller to distinguish between invalid options and valid options that + * are simply incomplete. + *

+ * In the traditional Unix getopt(), -1 is returned when the first non-option + * charcter is encountered. In GNU getopt(), the default behavior is to + * allow options to appear anywhere on the command line. The getopt() + * method permutes the argument to make it appear to the caller that all + * options were at the beginning of the command line, and all non-options + * were at the end. For example, calling getopt() with command line args + * of "-a foo bar -d" returns options 'a' and 'd', then sets optind to + * point to "foo". The program would read the last two argv elements as + * "foo" and "bar", just as if the user had typed "-a -d foo bar". + *

+ * The user can force getopt() to stop scanning the command line with + * the special argument "--" by itself. Any elements occuring before the + * "--" are scanned and permuted as normal. Any elements after the "--" + * are returned as is as non-option argv elements. For example, + * "foo -a -- bar -d" would return option 'a' then -1. optind would point + * to "foo", "bar" and "-d" as the non-option argv elements. The "--" + * is discarded by getopt(). + *

+ * There are two ways this default behavior can be modified. The first is + * to specify traditional Unix getopt() behavior (which is also POSIX + * behavior) in which scanning stops when the first non-option argument + * encountered. (Thus "-a foo bar -d" would return 'a' as an option and + * have "foo", "bar", and "-d" as non-option elements). The second is to + * allow options anywhere, but to return all elements in the order they + * occur on the command line. When a non-option element is ecountered, + * an integer 1 is returned and the value of the non-option element is + * stored in optarg is if it were the argument to that option. For + * example, "-a foo -d", returns first 'a', then 1 (with optarg set to + * "foo") then 'd' then -1. When this "return in order" functionality + * is enabled, the only way to stop getopt() from scanning all command + * line elements is to use the special "--" string by itself as described + * above. An example is "-a foo -b -- bar", which would return 'a', then + * integer 1 with optarg set to "foo", then 'b', then -1. optind would + * then point to "bar" as the first non-option argv element. The "--" + * is discarded. + *

+ * The POSIX/traditional behavior is enabled by either setting the + * property "gnu.posixly_correct" or by putting a '+' sign as the first + * character of the option string. The difference between the two + * methods is that setting the gnu.posixly_correct property also forces + * certain error messages to be displayed in POSIX format. To enable + * the "return in order" functionality, put a '-' as the first character + * of the option string. Note that after determining the proper + * behavior, Getopt strips this leading '+' or '-', meaning that a ':' + * placed as the second character after one of those two will still cause + * getopt() to return a ':' instead of a '?' if a required option + * argument is missing. + *

+ * In addition to traditional single character options, GNU Getopt also + * supports long options. These are preceeded by a "--" sequence and + * can be as long as desired. Long options provide a more user-friendly + * way of entering command line options. For example, in addition to a + * "-h" for help, a program could support also "--help". + *

+ * Like short options, long options can also take a required or non-required + * argument. Required arguments can either be specified by placing an + * equals sign after the option name, then the argument, or by putting the + * argument in the next argv element. For example: "--outputdir=foo" and + * "--outputdir foo" both represent an option of "outputdir" with an + * argument of "foo", assuming that outputdir takes a required argument. + * If a long option takes a non-required argument, then the equals sign + * form must be used to specify the argument. In this case, + * "--outputdir=foo" would represent option outputdir with an argument of + * "foo" while "--outputdir foo" would represent the option outputdir + * with no argument and a first non-option argv element of "foo". + *

+ * Long options can also be specified using a special POSIX argument + * format (one that I highly discourage). This form of entry is + * enabled by placing a "W;" (yes, 'W' then a semi-colon) in the valid + * option string. This causes getopt to treat the name following the + * "-W" as the name of the long option. For example, "-W outputdir=foo" + * would be equivalent to "--outputdir=foo". The name can immediately + * follow the "-W" like so: "-Woutputdir=foo". Option arguments are + * handled identically to normal long options. If a string follows the + * "-W" that does not represent a valid long option, then getopt() returns + * 'W' and the caller must decide what to do. Otherwise getopt() returns + * a long option value as described below. + *

+ * While long options offer convenience, they can also be tedious to type + * in full. So it is permissible to abbreviate the option name to as + * few characters as required to uniquely identify it. If the name can + * represent multiple long options, then an error message is printed and + * getopt() returns a '?'. + *

+ * If an invalid option is specified or a required option argument is + * missing, getopt() prints an error and returns a '?' or ':' exactly + * as for short options. Note that when an invalid long option is + * encountered, the optopt variable is set to integer 0 and so cannot + * be used to identify the incorrect option the user entered. + *

+ * Long options are defined by LongOpt objects. These objects are created + * with a contructor that takes four params: a String representing the + * object name, a integer specifying what arguments the option takes + * (the value is one of LongOpt.NO_ARGUMENT, LongOpt.REQUIRED_ARGUMENT, + * or LongOpt.OPTIONAL_ARGUMENT), a StringBuffer flag object (described + * below), and an integer value (described below). + *

+ * To enable long option parsing, create an array of LongOpt's representing + * the legal options and pass it to the Getopt() constructor. WARNING: If + * all elements of the array are not populated with LongOpt objects, the + * getopt() method will throw a NullPointerException. + *

+ * When getopt() is called and a long option is encountered, one of two + * things can be returned. If the flag field in the LongOpt object + * representing the long option is non-null, then the integer value field + * is stored there and an integer 0 is returned to the caller. The val + * field can then be retrieved from the flag field. Note that since the + * flag field is a StringBuffer, the appropriate String to integer converions + * must be performed in order to get the actual int value stored there. + * If the flag field in the LongOpt object is null, then the value field + * of the LongOpt is returned. This can be the character of a short option. + * This allows an app to have both a long and short option sequence + * (say, "-h" and "--help") that do the exact same thing. + *

+ * With long options, there is an alternative method of determining + * which option was selected. The method getLongind() will return the + * the index in the long option array (NOT argv) of the long option found. + * So if multiple long options are configured to return the same value, + * the application can use getLongind() to distinguish between them. + *

+ * Here is an expanded Getopt example using long options and various + * techniques described above: + *

+ * 

+  * int c;
+  * String arg;
+  * LongOpt[] longopts = new LongOpt[3];
+  * // 
+  * StringBuffer sb = new StringBuffer();
+  * longopts[0] = new LongOpt("help", LongOpt.NO_ARGUMENT, null, 'h');
+  * longopts[1] = new LongOpt("outputdir", LongOpt.REQUIRED_ARGUMENT, sb, 'o'); 
+  * longopts[2] = new LongOpt("maximum", LongOpt.OPTIONAL_ARGUMENT, null, 2);
+  * // 
+  * Getopt g = new Getopt("testprog", argv, "-:bc::d:hW;", longopts);
+  * g.setOpterr(false); // We'll do our own error handling
+  * //
+  * while ((c = g.getopt()) != -1)
+  *   switch (c)
+  *     {
+  *        case 0:
+  *          arg = g.getOptarg();
+  *          System.out.println("Got long option with value '" +
+  *                             (char)(new Integer(sb.toString())).intValue()
+  *                             + "' with argument " +
+  *                             ((arg != null) ? arg : "null"));
+  *          break;
+  *          //
+  *        case 1:
+  *          System.out.println("I see you have return in order set and that " +
+  *                             "a non-option argv element was just found " +
+  *                             "with the value '" + g.getOptarg() + "'");
+  *          break;
+  *          //
+  *        case 2:
+  *          arg = g.getOptarg();
+  *          System.out.println("I know this, but pretend I didn't");
+  *          System.out.println("We picked option " +
+  *                             longopts[g.getLongind()].getName() +
+  *                           " with value " + 
+  *                           ((arg != null) ? arg : "null"));
+  *          break;
+  *          //
+  *        case 'b':
+  *          System.out.println("You picked plain old option " + (char)c);
+  *          break;
+  *          //
+  *        case 'c':
+  *        case 'd':
+  *          arg = g.getOptarg();
+  *          System.out.println("You picked option '" + (char)c + 
+  *                             "' with argument " +
+  *                             ((arg != null) ? arg : "null"));
+  *          break;
+  *          //
+  *        case 'h':
+  *          System.out.println("I see you asked for help");
+  *          break;
+  *          //
+  *        case 'W':
+  *          System.out.println("Hmmm. You tried a -W with an incorrect long " +
+  *                             "option name");
+  *          break;
+  *          //
+  *        case ':':
+  *          System.out.println("Doh! You need an argument for option " +
+  *                             (char)g.getOptopt());
+  *          break;
+  *          //
+  *        case '?':
+  *          System.out.println("The option '" + (char)g.getOptopt() + 
+  *                           "' is not valid");
+  *          break;
+  *          //
+  *        default:
+  *          System.out.println("getopt() returned " + c);
+  *          break;
+  *     }
+  * //
+  * for (int i = g.getOptind(); i < argv.length ; i++)
+  *   System.out.println("Non option argv element: " + argv[i] + "\n");
+  *
+ *

+ * There is an alternative form of the constructor used for long options + * above. This takes a trailing boolean flag. If set to false, Getopt + * performs identically to the example, but if the boolean flag is true + * then long options are allowed to start with a single '-' instead of + * "--". If the first character of the option is a valid short option + * character, then the option is treated as if it were the short option. + * Otherwise it behaves as if the option is a long option. Note that + * the name given to this option - long_only - is very counter-intuitive. + * It does not cause only long options to be parsed but instead enables + * the behavior described above. + *

+ * Note that the functionality and variable names used are driven from + * the C lib version as this object is a port of the C code, not a + * new implementation. This should aid in porting existing C/C++ code, + * as well as helping programmers familiar with the glibc version to + * adapt to the Java version even if it seems very non-Java at times. + *

+ * In this release I made all instance variables protected due to + * overwhelming public demand. Any code which relied on optarg, + * opterr, optind, or optopt being public will need to be modified to + * use the appropriate access methods. + *

+ * Please send all bug reports, requests, and comments to + * arenn@urbanophile.com. + * + * @version 1.0.7 + * + * @author Roland McGrath (roland@gnu.ai.mit.edu) + * @author Ulrich Drepper (drepper@cygnus.com) + * @author Aaron M. Renn (arenn@urbanophile.com) + * + * @see LongOpt + */ +public class Getopt extends Object +{ + +/**************************************************************************/ + +/* + * Class Variables + */ + +/** + * Describe how to deal with options that follow non-option ARGV-elements. + * + * If the caller did not specify anything, + * the default is REQUIRE_ORDER if the property + * gnu.posixly_correct is defined, PERMUTE otherwise. + * + * The special argument `--' forces an end of option-scanning regardless + * of the value of `ordering'. In the case of RETURN_IN_ORDER, only + * `--' can cause `getopt' to return -1 with `optind' != ARGC. + * + * REQUIRE_ORDER means don't recognize them as options; + * stop option processing when the first non-option is seen. + * This is what Unix does. + * This mode of operation is selected by either setting the property + * gnu.posixly_correct, or using `+' as the first character + * of the list of option characters. + */ +protected static final int REQUIRE_ORDER = 1; + +/** + * PERMUTE is the default. We permute the contents of ARGV as we scan, + * so that eventually all the non-options are at the end. This allows options + * to be given in any order, even with programs that were not written to + * expect this. + */ +protected static final int PERMUTE = 2; + +/** + * RETURN_IN_ORDER is an option available to programs that were written + * to expect options and other ARGV-elements in any order and that care about + * the ordering of the two. We describe each non-option ARGV-element + * as if it were the argument of an option with character code 1. + * Using `-' as the first character of the list of option characters + * selects this mode of operation. + */ +protected static final int RETURN_IN_ORDER = 3; + +/**************************************************************************/ + +/* + * Instance Variables + */ + +/** + * For communication from `getopt' to the caller. + * When `getopt' finds an option that takes an argument, + * the argument value is returned here. + * Also, when `ordering' is RETURN_IN_ORDER, + * each non-option ARGV-element is returned here. + */ +protected String optarg; + +/** + * Index in ARGV of the next element to be scanned. + * This is used for communication to and from the caller + * and for communication between successive calls to `getopt'. + * + * On entry to `getopt', zero means this is the first call; initialize. + * + * When `getopt' returns -1, this is the index of the first of the + * non-option elements that the caller should itself scan. + * + * Otherwise, `optind' communicates from one call to the next + * how much of ARGV has been scanned so far. + */ +protected int optind = 0; + +/** + * Callers store false here to inhibit the error message + * for unrecognized options. + */ +protected boolean opterr = true; + +/** + * When an unrecognized option is encountered, getopt will return a '?' + * and store the value of the invalid option here. + */ +protected int optopt = '?'; + +/** + * The next char to be scanned in the option-element + * in which the last option character we returned was found. + * This allows us to pick up the scan where we left off. + * + * If this is zero, or a null string, it means resume the scan + * by advancing to the next ARGV-element. + */ +protected String nextchar; + +/** + * This is the string describing the valid short options. + */ +protected String optstring; + +/** + * This is an array of LongOpt objects which describ the valid long + * options. + */ +protected LongOpt[] long_options; + +/** + * This flag determines whether or not we are parsing only long args + */ +protected boolean long_only; + +/** + * Stores the index into the long_options array of the long option found + */ +protected int longind; + +/** + * The flag determines whether or not we operate in strict POSIX compliance + */ +protected boolean posixly_correct; + +/** + * A flag which communicates whether or not checkLongOption() did all + * necessary processing for the current option + */ +protected boolean longopt_handled; + +/** + * The index of the first non-option in argv[] + */ +protected int first_nonopt = 1; + +/** + * The index of the last non-option in argv[] + */ +protected int last_nonopt = 1; + +/** + * Flag to tell getopt to immediately return -1 the next time it is + * called. + */ +private boolean endparse = false; + +/** + * Saved argument list passed to the program + */ +protected String[] argv; + +/** + * Determines whether we permute arguments or not + */ +protected int ordering; + +/** + * Name to print as the program name in error messages. This is necessary + * since Java does not place the program name in argv[0] + */ +protected String progname; + +/** + * The localized strings are kept in a separate file + */ +private ResourceBundle _messages = PropertyResourceBundle.getBundle( + "gnu/getopt/MessagesBundle", Locale.getDefault()); + +/**************************************************************************/ + +/* + * Constructors + */ + +/** + * Construct a basic Getopt instance with the given input data. Note that + * this handles "short" options only. + * + * @param progname The name to display as the program name when printing errors + * @param argv The String array passed as the command line to the program. + * @param optstring A String containing a description of the valid args for this program + */ +public +Getopt(String progname, String[] argv, String optstring) +{ + this(progname, argv, optstring, null, false); +} + +/**************************************************************************/ + +/** + * Construct a Getopt instance with given input data that is capable of + * parsing long options as well as short. + * + * @param progname The name to display as the program name when printing errors + * @param argv The String array passed as the command ilne to the program + * @param optstring A String containing a description of the valid short args for this program + * @param long_options An array of LongOpt objects that describes the valid long args for this program + */ +public +Getopt(String progname, String[] argv, String optstring, + LongOpt[] long_options) +{ + this(progname, argv, optstring, long_options, false); +} + +/**************************************************************************/ + +/** + * Construct a Getopt instance with given input data that is capable of + * parsing long options and short options. Contrary to what you might + * think, the flag 'long_only' does not determine whether or not we + * scan for only long arguments. Instead, a value of true here allows + * long arguments to start with a '-' instead of '--' unless there is a + * conflict with a short option name. + * + * @param progname The name to display as the program name when printing errors + * @param argv The String array passed as the command ilne to the program + * @param optstring A String containing a description of the valid short args for this program + * @param long_options An array of LongOpt objects that describes the valid long args for this program + * @param long_only true if long options that do not conflict with short options can start with a '-' as well as '--' + */ +public +Getopt(String progname, String[] argv, String optstring, + LongOpt[] long_options, boolean long_only) +{ + if (optstring.length() == 0) + optstring = " "; + + // This function is essentially _getopt_initialize from GNU getopt + this.progname = progname; + this.argv = argv; + this.optstring = optstring; + this.long_options = long_options; + this.long_only = long_only; + + // Check for property "gnu.posixly_correct" to determine whether to + // strictly follow the POSIX standard. This replaces the "POSIXLY_CORRECT" + // environment variable in the C version + if (System.getProperty("gnu.posixly_correct", null) == null) + posixly_correct = false; + else + { + posixly_correct = true; + _messages = PropertyResourceBundle.getBundle("gnu/getopt/MessagesBundle", + Locale.US); + } + + // Determine how to handle the ordering of options and non-options + if (optstring.charAt(0) == '-') + { + ordering = RETURN_IN_ORDER; + if (optstring.length() > 1) + this.optstring = optstring.substring(1); + } + else if (optstring.charAt(0) == '+') + { + ordering = REQUIRE_ORDER; + if (optstring.length() > 1) + this.optstring = optstring.substring(1); + } + else if (posixly_correct) + { + ordering = REQUIRE_ORDER; + } + else + { + ordering = PERMUTE; // The normal default case + } +} + +/**************************************************************************/ + +/* + * Instance Methods + */ + +/** + * In GNU getopt, it is possible to change the string containg valid options + * on the fly because it is passed as an argument to getopt() each time. In + * this version we do not pass the string on every call. In order to allow + * dynamic option string changing, this method is provided. + * + * @param optstring The new option string to use + */ +public void +setOptstring(String optstring) +{ + if (optstring.length() == 0) + optstring = " "; + + this.optstring = optstring; +} + +/**************************************************************************/ + +/** + * optind it the index in ARGV of the next element to be scanned. + * This is used for communication to and from the caller + * and for communication between successive calls to `getopt'. + * + * When `getopt' returns -1, this is the index of the first of the + * non-option elements that the caller should itself scan. + * + * Otherwise, `optind' communicates from one call to the next + * how much of ARGV has been scanned so far. + */ +public int +getOptind() +{ + return(optind); +} + +/**************************************************************************/ + +/** + * This method allows the optind index to be set manually. Normally this + * is not necessary (and incorrect usage of this method can lead to serious + * lossage), but optind is a public symbol in GNU getopt, so this method + * was added to allow it to be modified by the caller if desired. + * + * @param optind The new value of optind + */ +public void +setOptind(int optind) +{ + this.optind = optind; +} + +/**************************************************************************/ + +/** + * Since in GNU getopt() the argument vector is passed back in to the + * function every time, the caller can swap out argv on the fly. Since + * passing argv is not required in the Java version, this method allows + * the user to override argv. Note that incorrect use of this method can + * lead to serious lossage. + * + * @param argv New argument list + */ +public void +setArgv(String[] argv) +{ + this.argv = argv; +} + +/**************************************************************************/ + +/** + * For communication from `getopt' to the caller. + * When `getopt' finds an option that takes an argument, + * the argument value is returned here. + * Also, when `ordering' is RETURN_IN_ORDER, + * each non-option ARGV-element is returned here. + * No set method is provided because setting this variable has no effect. + */ +public String +getOptarg() +{ + return(optarg); +} + +/**************************************************************************/ + +/** + * Normally Getopt will print a message to the standard error when an + * invalid option is encountered. This can be suppressed (or re-enabled) + * by calling this method. There is no get method for this variable + * because if you can't remember the state you set this to, why should I? + */ +public void +setOpterr(boolean opterr) +{ + this.opterr = opterr; +} + +/**************************************************************************/ + +/** + * When getopt() encounters an invalid option, it stores the value of that + * option in optopt which can be retrieved with this method. There is + * no corresponding set method because setting this variable has no effect. + */ +public int +getOptopt() +{ + return(optopt); +} + +/**************************************************************************/ + +/** + * Returns the index into the array of long options (NOT argv) representing + * the long option that was found. + */ +public int +getLongind() +{ + return(longind); +} + +/**************************************************************************/ + +/** + * Exchange the shorter segment with the far end of the longer segment. + * That puts the shorter segment into the right place. + * It leaves the longer segment in the right place overall, + * but it consists of two parts that need to be swapped next. + * This method is used by getopt() for argument permutation. + */ +protected void +exchange(String[] argv) +{ + int bottom = first_nonopt; + int middle = last_nonopt; + int top = optind; + String tem; + + while (top > middle && middle > bottom) + { + if (top - middle > middle - bottom) + { + // Bottom segment is the short one. + int len = middle - bottom; + int i; + + // Swap it with the top part of the top segment. + for (i = 0; i < len; i++) + { + tem = argv[bottom + i]; + argv[bottom + i] = argv[top - (middle - bottom) + i]; + argv[top - (middle - bottom) + i] = tem; + } + // Exclude the moved bottom segment from further swapping. + top -= len; + } + else + { + // Top segment is the short one. + int len = top - middle; + int i; + + // Swap it with the bottom part of the bottom segment. + for (i = 0; i < len; i++) + { + tem = argv[bottom + i]; + argv[bottom + i] = argv[middle + i]; + argv[middle + i] = tem; + } + // Exclude the moved top segment from further swapping. + bottom += len; + } + } + + // Update records for the slots the non-options now occupy. + + first_nonopt += (optind - last_nonopt); + last_nonopt = optind; +} + +/**************************************************************************/ + +/** + * Check to see if an option is a valid long option. Called by getopt(). + * Put in a separate method because this needs to be done twice. (The + * C getopt authors just copy-pasted the code!). + * + * @param longind A buffer in which to store the 'val' field of found LongOpt + * + * @return Various things depending on circumstances + */ +protected int +checkLongOption() +{ + LongOpt pfound = null; + int nameend; + boolean ambig; + boolean exact; + + longopt_handled = true; + ambig = false; + exact = false; + longind = -1; + + nameend = nextchar.indexOf("="); + if (nameend == -1) + nameend = nextchar.length(); + + // Test all lnog options for either exact match or abbreviated matches + for (int i = 0; i < long_options.length; i++) + { + if (long_options[i].getName().startsWith(nextchar.substring(0, nameend))) + { + if (long_options[i].getName().equals(nextchar.substring(0, nameend))) + { + // Exact match found + pfound = long_options[i]; + longind = i; + exact = true; + break; + } + else if (pfound == null) + { + // First nonexact match found + pfound = long_options[i]; + longind = i; + } + else + { + // Second or later nonexact match found + ambig = true; + } + } + } // for + + // Print out an error if the option specified was ambiguous + if (ambig && !exact) + { + if (opterr) + { + Object[] msgArgs = { progname, argv[optind] }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.ambigious"), + msgArgs)); + } + + nextchar = ""; + optopt = 0; + ++optind; + + return('?'); + } + + if (pfound != null) + { + ++optind; + + if (nameend != nextchar.length()) + { + if (pfound.has_arg != LongOpt.NO_ARGUMENT) + { + if (nextchar.substring(nameend).length() > 1) + optarg = nextchar.substring(nameend+1); + else + optarg = ""; + } + else + { + if (opterr) + { + // -- option + if (argv[optind - 1].startsWith("--")) + { + Object[] msgArgs = { progname, pfound.name }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.arguments1"), + msgArgs)); + } + // +option or -option + else + { + Object[] msgArgs = { progname, new + Character(argv[optind-1].charAt(0)).toString(), + pfound.name }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.arguments2"), + msgArgs)); + } + } + + nextchar = ""; + optopt = pfound.val; + + return('?'); + } + } // if (nameend) + else if (pfound.has_arg == LongOpt.REQUIRED_ARGUMENT) + { + if (optind < argv.length) + { + optarg = argv[optind]; + ++optind; + } + else + { + if (opterr) + { + Object[] msgArgs = { progname, argv[optind-1] }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.requires"), + msgArgs)); + } + + nextchar = ""; + optopt = pfound.val; + if (optstring.charAt(0) == ':') + return(':'); + else + return('?'); + } + } // else if (pfound) + + nextchar = ""; + + if (pfound.flag != null) + { + pfound.flag.setLength(0); + pfound.flag.append(pfound.val); + + return(0); + } + + return(pfound.val); + } // if (pfound != null) + + longopt_handled = false; + + return(0); +} + +/**************************************************************************/ + +/** + * This method returns a char that is the current option that has been + * parsed from the command line. If the option takes an argument, then + * the internal variable 'optarg' is set which is a String representing + * the the value of the argument. This value can be retrieved by the + * caller using the getOptarg() method. If an invalid option is found, + * an error message is printed and a '?' is returned. The name of the + * invalid option character can be retrieved by calling the getOptopt() + * method. When there are no more options to be scanned, this method + * returns -1. The index of first non-option element in argv can be + * retrieved with the getOptind() method. + * + * @return Various things as described above + */ +public int +getopt() +{ + optarg = null; + + if (endparse == true) + return(-1); + + if ((nextchar == null) || (nextchar.equals(""))) + { + // If we have just processed some options following some non-options, + // exchange them so that the options come first. + if (last_nonopt > optind) + last_nonopt = optind; + if (first_nonopt > optind) + first_nonopt = optind; + + if (ordering == PERMUTE) + { + // If we have just processed some options following some non-options, + // exchange them so that the options come first. + if ((first_nonopt != last_nonopt) && (last_nonopt != optind)) + exchange(argv); + else if (last_nonopt != optind) + first_nonopt = optind; + + // Skip any additional non-options + // and extend the range of non-options previously skipped. + while ((optind < argv.length) && (argv[optind].equals("") || + (argv[optind].charAt(0) != '-') || argv[optind].equals("-"))) + { + optind++; + } + + last_nonopt = optind; + } + + // The special ARGV-element `--' means premature end of options. + // Skip it like a null option, + // then exchange with previous non-options as if it were an option, + // then skip everything else like a non-option. + if ((optind != argv.length) && argv[optind].equals("--")) + { + optind++; + + if ((first_nonopt != last_nonopt) && (last_nonopt != optind)) + exchange (argv); + else if (first_nonopt == last_nonopt) + first_nonopt = optind; + + last_nonopt = argv.length; + + optind = argv.length; + } + + // If we have done all the ARGV-elements, stop the scan + // and back over any non-options that we skipped and permuted. + if (optind == argv.length) + { + // Set the next-arg-index to point at the non-options + // that we previously skipped, so the caller will digest them. + if (first_nonopt != last_nonopt) + optind = first_nonopt; + + return(-1); + } + + // If we have come to a non-option and did not permute it, + // either stop the scan or describe it to the caller and pass it by. + if (argv[optind].equals("") || (argv[optind].charAt(0) != '-') || + argv[optind].equals("-")) + { + if (ordering == REQUIRE_ORDER) + return(-1); + + optarg = argv[optind++]; + return(1); + } + + // We have found another option-ARGV-element. + // Skip the initial punctuation. + if (argv[optind].startsWith("--")) + nextchar = argv[optind].substring(2); + else + nextchar = argv[optind].substring(1); + } + + // Decode the current option-ARGV-element. + + /* Check whether the ARGV-element is a long option. + + If long_only and the ARGV-element has the form "-f", where f is + a valid short option, don't consider it an abbreviated form of + a long option that starts with f. Otherwise there would be no + way to give the -f short option. + + On the other hand, if there's a long option "fubar" and + the ARGV-element is "-fu", do consider that an abbreviation of + the long option, just like "--fu", and not "-f" with arg "u". + + This distinction seems to be the most useful approach. */ + if ((long_options != null) && (argv[optind].startsWith("--") + || (long_only && ((argv[optind].length() > 2) || + (optstring.indexOf(argv[optind].charAt(1)) == -1))))) + { + int c = checkLongOption(); + + if (longopt_handled) + return(c); + + // Can't find it as a long option. If this is not getopt_long_only, + // or the option starts with '--' or is not a valid short + // option, then it's an error. + // Otherwise interpret it as a short option. + if (!long_only || argv[optind].startsWith("--") + || (optstring.indexOf(nextchar.charAt(0)) == -1)) + { + if (opterr) + { + if (argv[optind].startsWith("--")) + { + Object[] msgArgs = { progname, nextchar }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.unrecognized"), + msgArgs)); + } + else + { + Object[] msgArgs = { progname, new + Character(argv[optind].charAt(0)).toString(), + nextchar }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.unrecognized2"), + msgArgs)); + } + } + + nextchar = ""; + ++optind; + optopt = 0; + + return('?'); + } + } // if (longopts) + + // Look at and handle the next short option-character */ + int c = nextchar.charAt(0); //**** Do we need to check for empty str? + if (nextchar.length() > 1) + nextchar = nextchar.substring(1); + else + nextchar = ""; + + String temp = null; + if (optstring.indexOf(c) != -1) + temp = optstring.substring(optstring.indexOf(c)); + + if (nextchar.equals("")) + ++optind; + + if ((temp == null) || (c == ':')) + { + if (opterr) + { + if (posixly_correct) + { + // 1003.2 specifies the format of this message + Object[] msgArgs = { progname, new + Character((char)c).toString() }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.illegal"), msgArgs)); + } + else + { + Object[] msgArgs = { progname, new + Character((char)c).toString() }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.invalid"), msgArgs)); + } + } + + optopt = c; + + return('?'); + } + + // Convenience. Treat POSIX -W foo same as long option --foo + if ((temp.charAt(0) == 'W') && (temp.length() > 1) && (temp.charAt(1) == ';')) + { + if (!nextchar.equals("")) + { + optarg = nextchar; + } + // No further cars in this argv element and no more argv elements + else if (optind == argv.length) + { + if (opterr) + { + // 1003.2 specifies the format of this message. + Object[] msgArgs = { progname, new + Character((char)c).toString() }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.requires2"), msgArgs)); + } + + optopt = c; + if (optstring.charAt(0) == ':') + return(':'); + else + return('?'); + } + else + { + // We already incremented `optind' once; + // increment it again when taking next ARGV-elt as argument. + nextchar = argv[optind]; + optarg = argv[optind]; + } + + c = checkLongOption(); + + if (longopt_handled) + return(c); + else + // Let the application handle it + { + nextchar = null; + ++optind; + return('W'); + } + } + + if ((temp.length() > 1) && (temp.charAt(1) == ':')) + { + if ((temp.length() > 2) && (temp.charAt(2) == ':')) + // This is an option that accepts and argument optionally + { + if (!nextchar.equals("")) + { + optarg = nextchar; + ++optind; + } + else + { + optarg = null; + } + + nextchar = null; + } + else + { + if (!nextchar.equals("")) + { + optarg = nextchar; + ++optind; + } + else if (optind == argv.length) + { + if (opterr) + { + // 1003.2 specifies the format of this message + Object[] msgArgs = { progname, new + Character((char)c).toString() }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.requires2"), msgArgs)); + } + + optopt = c; + + if (optstring.charAt(0) == ':') + return(':'); + else + return('?'); + } + else + { + optarg = argv[optind]; + ++optind; + + // Ok, here's an obscure Posix case. If we have o:, and + // we get -o -- foo, then we're supposed to skip the --, + // end parsing of options, and make foo an operand to -o. + // Only do this in Posix mode. + if ((posixly_correct) && optarg.equals("--")) + { + // If end of argv, error out + if (optind == argv.length) + { + if (opterr) + { + // 1003.2 specifies the format of this message + Object[] msgArgs = { progname, new + Character((char)c).toString() }; + System.err.println(MessageFormat.format( + _messages.getString("getopt.requires2"), msgArgs)); + } + + optopt = c; + + if (optstring.charAt(0) == ':') + return(':'); + else + return('?'); + } + + // Set new optarg and set to end + // Don't permute as we do on -- up above since we + // know we aren't in permute mode because of Posix. + optarg = argv[optind]; + ++optind; + first_nonopt = optind; + last_nonopt = argv.length; + endparse = true; + } + } + + nextchar = null; + } + } + + return(c); +} + +} // Class Getopt + + diff --git a/gnu/getopt/GetoptDemo.class b/gnu/getopt/GetoptDemo.class new file mode 100644 index 0000000000000000000000000000000000000000..659e87c4e66a5c48f99f6646470911793e35464e GIT binary patch literal 2529 zcmaJ@+fP$>9RK_ZZ4X!li>L^02Nfwut@le&P(iT@MTLQQnLE$}JLl9G(*5+C-kJuTT@wm)Fml9?r2vX{;6^E++11ZI=p_xt$Q|N5NSIF$L!o3@Nyx;CTf%6uh87Q!uJvTtQNSp(~6a5*dU3x4JU6E*GXcae7uqGTG9g9X2(d01O;yY%ThSNc_E-Rr6tnISQtfQIE zkQ|UeQ@53DR7b3wYU+AI)l79^DC3r`GPq%xoKNNHn`635WJ&b6X?5#qOQ33z*ez!# z(9pwCrjSSs)mP)3t_5;IcC|mKDOM0sim20V@#bgtr^ux z8re2=H0P)pTX%Fbp~lpNkuaMbfz2^BtLy45R-|R8=v|hP)KeJ&eNmLurgfFJIa@|l zEjyvxv~$>i1l?=AaAD1Gv3~YsTGdm!yR0)>R-Mdc9eU1D+bzyX>cy33fmOYRsmF8a zQQaQYMpI0@wlH7Aid^7IJ6vpCOLIEwdaW@nHKf^w)MIDs;_UV+L8Ed616Ix+)6W>v zV_=XGi;4`neppvC#+a;kVPrLOs>_+wY*@n0q%>K4YKf6g%VgM4M&s(qwKF8)ClPl? zP{CV&#$iJQig#C|cxQ0#9Ch4Fuy6^r6kE;gnCgKia1FetMlfutM7B{kvRvIIc%TjdexQZv40NR@`${f$Ic*?LTz8e z-!=xOf;iXYJOVV{qr9rl+R3sWo zDnXe-9?hi;%VdVTM~->!J?W6wwnM&I>?mokrFLtrj~xgF#e%y#K2hsyefZJ8KYhk& z2{|`BMmu2*yr{)GY~)A4CPcW49sG9a=Q?^Uv%JrI8PiW?;;LzkB*2b92F*x z3kMzIE;_|KI3eC6{($s{ILZC&7N6j>xR0~q3!Gy?ec}<~;#=bH&@aBnCGiUe#AD(= zF)04RuxBkUd#bV3Q;(~jCS3D$5%-~rRr3p{@ZVx(`~+e3-qty&i!JfF%r%4)6nb#| EKX}A`#Q*>R literal 0 HcmV?d00001 diff --git a/gnu/getopt/GetoptDemo.java b/gnu/getopt/GetoptDemo.java new file mode 100644 index 0000000..b57c5a8 --- /dev/null +++ b/gnu/getopt/GetoptDemo.java @@ -0,0 +1,97 @@ +import gnu.getopt.LongOpt; +import gnu.getopt.Getopt; + +/* + * This sample code was written by Aaron M. Renn and is a demonstration + * of how to utilize some of the features of the GNU getopt package. This + * sample code is hereby placed into the public domain by the author and + * may be used without restriction. + */ + +public class GetoptDemo +{ + +public static void +main(String[] argv) +{ + int c; + String arg; + LongOpt[] longopts = new LongOpt[3]; + // + StringBuffer sb = new StringBuffer(); + longopts[0] = new LongOpt("help", LongOpt.NO_ARGUMENT, null, 'h'); + longopts[1] = new LongOpt("outputdir", LongOpt.REQUIRED_ARGUMENT, sb, 'o'); + longopts[2] = new LongOpt("maximum", LongOpt.OPTIONAL_ARGUMENT, null, 2); + // + Getopt g = new Getopt("testprog", argv, "-:bc::d:hW;", longopts); + g.setOpterr(false); // We'll do our own error handling + // + while ((c = g.getopt()) != -1) + switch (c) + { + case 0: + arg = g.getOptarg(); + System.out.println("Got long option with value '" + + (char)(new Integer(sb.toString())).intValue() + + "' with argument " + + ((arg != null) ? arg : "null")); + break; + // + case 1: + System.out.println("I see you have return in order set and that " + + "a non-option argv element was just found " + + "with the value '" + g.getOptarg() + "'"); + break; + // + case 2: + arg = g.getOptarg(); + System.out.println("I know this, but pretend I didn't"); + System.out.println("We picked option " + + longopts[g.getLongind()].getName() + + " with value " + + ((arg != null) ? arg : "null")); + break; + // + case 'b': + System.out.println("You picked plain old option " + (char)c); + break; + // + case 'c': + case 'd': + arg = g.getOptarg(); + System.out.println("You picked option '" + (char)c + + "' with argument " + + ((arg != null) ? arg : "null")); + break; + // + case 'h': + System.out.println("I see you asked for help"); + break; + // + case 'W': + System.out.println("Hmmm. You tried a -W with an incorrect long " + + "option name"); + break; + // + case ':': + System.out.println("Doh! You need an argument for option " + + (char)g.getOptopt()); + break; + // + case '?': + System.out.println("The option '" + (char)g.getOptopt() + + "' is not valid"); + break; + // + default: + System.out.println("getopt() returned " + c); + break; + } + // + for (int i = g.getOptind(); i < argv.length ; i++) + System.out.println("Non option argv element: " + argv[i] + "\n"); +} + +} // Class GetoptDemo + + diff --git a/gnu/getopt/LongOpt.class b/gnu/getopt/LongOpt.class new file mode 100644 index 0000000000000000000000000000000000000000..9427610a37c76b597ca7e289656d7ee311dbc72a GIT binary patch literal 1600 zcmZuxTW=Fb6#gb&d+lW*i6JCT4K0*{V;bD1Z77$f(Kkrf^<~_m#L{ViuQ8%;A!Wd3=d{^F=1y_1@Va0Dbo_$4NJi$ zK+BbsI-5I48yRUN3P^%NguQftv!7EC@>+yP&mo*=KZ(Fpv)av0YulRZcsoG}mm(;> z3I(lh-L?)eU_0)nj{EIXc6 z=`^;i)~eic2}y@S?Ony#0ps39jEBlQP|K0vV%BBLQRIwimYbekz2{$0_bqU!Qr(=b zU0+)+R#pXut2b9m)yix+Y^xP-t(9uUg^z6vQ}h6k#f~5o@`vReF8_hXfk!jyDwd5 zr{B`F?R5&h6F$SBIDt&axZF?gbt3v5+1`{Y-sv}wzT~==EnTM3X;_}WcTH?c2;}*e zZM6i3-q?DtL0~j6`PKu!&=0uSZ$b|odVT_90XX9Mv4vjHfTZ7iU4M+#;uJsl6bDKY z8GMFm2z;!@3v~vchxP;9&xH0dXzH6MR#O8Y(3}u~<^%{hI5w!`fnzUlw2PtaBV5dCk1>^vKgOi?H&Pq1mq>18cX8x7##S!JUqau=Kf_R3 zdybI|J=41w{3n0Di_v_xi{tspE{5|XS{Io=8A0G8, 1996, +/* Edouard G. Parmelan , 1999. +/* These messages are encoded in ISO-8859-1 +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: l'option ''{1}'' est ambiguë +getopt.arguments1={0}: l'option ''--{1}'' ne permet pas de paramètre +getopt.arguments2={0}: l'option ''{1}{2}'' ne permet pas de paramètre +getopt.requires={0}: l'option ''{1}'' requiert un paramètre +getopt.unrecognized={0}: option non reconnue ''--{1}'' +getopt.unrecognized2={0}: option non reconnue ''{1}{2}'' +getopt.illegal={0}: option illégale -- {1} +getopt.invalid={0}: option invalide -- {1} +getopt.requires2={0}: cette option requiert un paramètre -- {1} +getopt.invalidValue=Valeur invalide {0} pour le paramètre 'has_arg' + diff --git a/gnu/getopt/MessagesBundle_nl.properties b/gnu/getopt/MessagesBundle_nl.properties new file mode 100644 index 0000000..c614922 --- /dev/null +++ b/gnu/getopt/MessagesBundle_nl.properties @@ -0,0 +1,32 @@ +/************************************************************************** +/* MessagesBundle_nl.properties -- Dutch language error messages +/* +/* Copyright (c) 1999 by Ernst de Haan (ernst@jollem.com) +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: optie ''{1}'' is ambigue +getopt.arguments1={0}: optie ''--{1}'' staat geen argumenten toe +getopt.arguments2={0}: optie ''{1}{2}'' staat geen argumenten toe +getopt.requires={0}: optie ''{1}'' heeft een argument nodig +getopt.unrecognized={0}: onbekende optie ''--{1}'' +getopt.unrecognized2={0}: onbekende optie ''{1}{2}'' +getopt.illegal={0}: niet-toegestane optie -- {1} +getopt.invalid={0}: onjuiste optie -- {1} +getopt.requires2={0}: optie heeft een argument nodig -- {1} +getopt.invalidValue=Ongeldige waarde {0} voor parameter 'has_arg' + diff --git a/gnu/getopt/MessagesBundle_no.properties b/gnu/getopt/MessagesBundle_no.properties new file mode 100644 index 0000000..bcb8c50 --- /dev/null +++ b/gnu/getopt/MessagesBundle_no.properties @@ -0,0 +1,32 @@ +/************************************************************************** +/* MessagesBundle.properties -- Norwegian language error messages +/* +/* Copyright (c) 1999 by Bjørn-Ove Heimsund (s811@ii.uib.no) +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: flagget ''{1}'' er flertydig +getopt.arguments1={0}: flagget ''--{1}'' tillater ikke et argument +getopt.arguments2={0}: flagget ''{1}{2}'' tillater ikke et argument +getopt.requires={0}: flagget ''{1}'' krever et argument +getopt.unrecognized={0}: ukjent flagg ''--{1}'' +getopt.unrecognized2={0}: ukjent flagg ''{1}{2}'' +getopt.illegal={0}: ugyldig flagg -- {1} +getopt.invalid={0}: ugyldig flagg -- {1} +getopt.requires2={0}: flagget krever et argument -- {1} +getopt.invalidValue=Ugyldig verdi {0} for parameter 'has_arg' + diff --git a/gnu/getopt/README b/gnu/getopt/README new file mode 100644 index 0000000..867fd9b --- /dev/null +++ b/gnu/getopt/README @@ -0,0 +1,43 @@ +This is a Java port of the GNU getopt functions based on the versions +contained in glibc 2.0.6. I have attempted to keep the functionality +and programmer's interface as faithful to the original as possible. +However, due to differences between Java and C, some minor changes +has to me made. (Given the obtuse interface in the clib version, +perhaps some major changes should have been made). This should not +affect the way options appear to be parsed to the end user of program +that uses this Java getopt. The use of these classes are completely +documented in the javadoc comments, so I will not repeat that info here. + +Note that since these objects are part of a package called "gnu.getopt", +they need to be in a subdirectory called gnu/getopt somewhere in your +CLASSPATH. This includes the "MessagesBundle" files. + +I am not aware of any bugs. If you find one though, please send email +to me at arenn@urbanophile.com. The more detailed a bug report the better. +Bug fixes are also welcome at the same address. Please reference +release number "1.0.8". If you use this code, it would be helpful +if you let me know so that I can let you know if anything changes or +if any major bugs have been found/fixed. + +I have included a Makefile for compiling the code. If you do not have +access to make, then you can simply do a "javac *.java" at the OS +command line (or follow your vendor's instructions for compiling a +Java class). To build the documentation, do a "make docs" +or "javadoc -public *.java". Note that the images needed by the html +generated by javadoc are not included. You will need to get those +from some other Java documentation package. + +Note that the Makefile is not compliant with the GNU makefile +standards as I anticipate that at some point a master makefile will +be created for various GNU Java packages. And it is serious overkill +to create a megabloat makefile (kinda like this megabloat README) for +such a simple package. + +There is sample code showing how to use getopt available in the +GetoptDemo.java file. + +Happy hacking, + +Aaron. +arenn@urbanophile.com +http://www.urbanophile.com/arenn/ diff --git a/gnu/getopt/gnu.getopt.Getopt.html b/gnu/getopt/gnu.getopt.Getopt.html new file mode 100644 index 0000000..425de42 --- /dev/null +++ b/gnu/getopt/gnu.getopt.Getopt.html @@ -0,0 +1,639 @@ + + + + + + + Class gnu.getopt.Getopt + + + + +

+All Packages  Class Hierarchy  This Package  Previous  Next  Index
+
+

+ Class gnu.getopt.Getopt +

+
+java.lang.Object
+   |
+   +----gnu.getopt.Getopt
+
+
+
+
public class Getopt +
extends Object +
+This is a Java port of GNU getopt, a class for parsing command line + arguments passed to programs. It it based on the C getopt() functions + in glibc 2.0.6 and should parse options in a 100% compatible manner. + If it does not, that is a bug. The programmer's interface is also + very compatible. +

+ To use Getopt, create a Getopt object with a argv array passed to the + main method, then call the getopt() method in a loop. It will return an + int that contains the value of the option character parsed from the + command line. When there are no more options to be parsed, it + returns -1. +

+ A command line option can be defined to take an argument. If an + option has an argument, the value of that argument is stored in an + instance variable called optarg, which can be accessed using the + getOptarg() method. If an option that requires an argument is + found, but there is no argument present, then an error message is + printed. Normally getopt() returns a '?' in this situation, but + that can be changed as described below. +

+ If an invalid option is encountered, an error message is printed + to the standard error and getopt() returns a '?'. The value of the + invalid option encountered is stored in the instance variable optopt + which can be retrieved using the getOptopt() method. To suppress + the printing of error messages for this or any other error, set + the value of the opterr instance variable to false using the + setOpterr() method. +

+ Between calls to getopt(), the instance variable optind is used to + keep track of where the object is in the parsing process. After all + options have been returned, optind is the index in argv of the first + non-option argument. This variable can be accessed with the getOptind() + method. +

+ Note that this object expects command line options to be passed in the + traditional Unix manner. That is, proceeded by a '-' character. + Multiple options can follow the '-'. For example "-abc" is equivalent + to "-a -b -c". If an option takes a required argument, the value + of the argument can immediately follow the option character or be + present in the next argv element. For example, "-cfoo" and "-c foo" + both represent an option character of 'c' with an argument of "foo" + assuming c takes a required argument. If an option takes an argument + that is not required, then any argument must immediately follow the + option character in the same argv element. For example, if c takes + a non-required argument, then "-cfoo" represents option character 'c' + with an argument of "foo" while "-c foo" represents the option + character 'c' with no argument, and a first non-option argv element + of "foo". +

+ The user can stop getopt() from scanning any further into a command line + by using the special argument "--" by itself. For example: + "-a -- -d" would return an option character of 'a', then return -1 + The "--" is discarded and "-d" is pointed to by optind as the first + non-option argv element. +

+ Here is a basic example of using Getopt: +

+ 

+ Getopt g = new Getopt("testprog", argv, "ab:c::d");
+ //
+ int c;
+ String arg;
+ while ((c = g.getopt()) != -1)
+   {
+     switch(c)
+       {
+          case 'a':
+          case 'd':
+            System.out.print("You picked " + (char)c + "\n");
+            break;
+            //
+          case 'b':
+          case 'c':
+            arg = g.getOptarg();
+            System.out.print("You picked " + (char)c + 
+                             " with an argument of " +
+                             ((arg != null) ? arg : "null") + "\n");
+            break;
+            //
+          case '?':
+            break; // getopt() already printed an error
+            //
+          default:
+            System.out.print("getopt() returned " + c + "\n");
+       }
+   }
+
+

+ In this example, a new Getopt object is created with three params. + The first param is the program name. This is for printing error + messages in the form "program: error message". In the C version, this + value is taken from argv[0], but in Java the program name is not passed + in that element, thus the need for this parameter. The second param is + the argument list that was passed to the main() method. The third + param is the list of valid options. Each character represents a valid + option. If the character is followed by a single colon, then that + option has a required argument. If the character is followed by two + colons, then that option has an argument that is not required. +

+ Note in this example that the value returned from getopt() is cast to + a char prior to printing. This is required in order to make the value + display correctly as a character instead of an integer. +

+ If the first character in the option string is a colon, for example + ":abc::d", then getopt() will return a ':' instead of a '?' when it + encounters an option with a missing required argument. This allows the + caller to distinguish between invalid options and valid options that + are simply incomplete. +

+ In the traditional Unix getopt(), -1 is returned when the first non-option + charcter is encountered. In GNU getopt(), the default behavior is to + allow options to appear anywhere on the command line. The getopt() + method permutes the argument to make it appear to the caller that all + options were at the beginning of the command line, and all non-options + were at the end. For example, calling getopt() with command line args + of "-a foo bar -d" returns options 'a' and 'd', then sets optind to + point to "foo". The program would read the last two argv elements as + "foo" and "bar", just as if the user had typed "-a -d foo bar". +

+ The user can force getopt() to stop scanning the command line with + the special argument "--" by itself. Any elements occuring before the + "--" are scanned and permuted as normal. Any elements after the "--" + are returned as is as non-option argv elements. For example, + "foo -a -- bar -d" would return option 'a' then -1. optind would point + to "foo", "bar" and "-d" as the non-option argv elements. The "--" + is discarded by getopt(). +

+ There are two ways this default behavior can be modified. The first is + to specify traditional Unix getopt() behavior (which is also POSIX + behavior) in which scanning stops when the first non-option argument + encountered. (Thus "-a foo bar -d" would return 'a' as an option and + have "foo", "bar", and "-d" as non-option elements). The second is to + allow options anywhere, but to return all elements in the order they + occur on the command line. When a non-option element is ecountered, + an integer 1 is returned and the value of the non-option element is + stored in optarg is if it were the argument to that option. For + example, "-a foo -d", returns first 'a', then 1 (with optarg set to + "foo") then 'd' then -1. When this "return in order" functionality + is enabled, the only way to stop getopt() from scanning all command + line elements is to use the special "--" string by itself as described + above. An example is "-a foo -b -- bar", which would return 'a', then + integer 1 with optarg set to "foo", then 'b', then -1. optind would + then point to "bar" as the first non-option argv element. The "--" + is discarded. +

+ The POSIX/traditional behavior is enabled by either setting the + property "gnu.posixly_correct" or by putting a '+' sign as the first + character of the option string. The difference between the two + methods is that setting the gnu.posixly_correct property also forces + certain error messages to be displayed in POSIX format. To enable + the "return in order" functionality, put a '-' as the first character + of the option string. Note that after determining the proper + behavior, Getopt strips this leading '+' or '-', meaning that a ':' + placed as the second character after one of those two will still cause + getopt() to return a ':' instead of a '?' if a required option + argument is missing. +

+ In addition to traditional single character options, GNU Getopt also + supports long options. These are preceeded by a "--" sequence and + can be as long as desired. Long options provide a more user-friendly + way of entering command line options. For example, in addition to a + "-h" for help, a program could support also "--help". +

+ Like short options, long options can also take a required or non-required + argument. Required arguments can either be specified by placing an + equals sign after the option name, then the argument, or by putting the + argument in the next argv element. For example: "--outputdir=foo" and + "--outputdir foo" both represent an option of "outputdir" with an + argument of "foo", assuming that outputdir takes a required argument. + If a long option takes a non-required argument, then the equals sign + form must be used to specify the argument. In this case, + "--outputdir=foo" would represent option outputdir with an argument of + "foo" while "--outputdir foo" would represent the option outputdir + with no argument and a first non-option argv element of "foo". +

+ Long options can also be specified using a special POSIX argument + format (one that I highly discourage). This form of entry is + enabled by placing a "W;" (yes, 'W' then a semi-colon) in the valid + option string. This causes getopt to treat the name following the + "-W" as the name of the long option. For example, "-W outputdir=foo" + would be equivalent to "--outputdir=foo". The name can immediately + follow the "-W" like so: "-Woutputdir=foo". Option arguments are + handled identically to normal long options. If a string follows the + "-W" that does not represent a valid long option, then getopt() returns + 'W' and the caller must decide what to do. Otherwise getopt() returns + a long option value as described below. +

+ While long options offer convenience, they can also be tedious to type + in full. So it is permissible to abbreviate the option name to as + few characters as required to uniquely identify it. If the name can + represent multiple long options, then an error message is printed and + getopt() returns a '?'. +

+ If an invalid option is specified or a required option argument is + missing, getopt() prints an error and returns a '?' or ':' exactly + as for short options. Note that when an invalid long option is + encountered, the optopt variable is set to integer 0 and so cannot + be used to identify the incorrect option the user entered. +

+ Long options are defined by LongOpt objects. These objects are created + with a contructor that takes four params: a String representing the + object name, a integer specifying what arguments the option takes + (the value is one of LongOpt.NO_ARGUMENT, LongOpt.REQUIRED_ARGUMENT, + or LongOpt.OPTIONAL_ARGUMENT), a StringBuffer flag object (described + below), and an integer value (described below). +

+ To enable long option parsing, create an array of LongOpt's representing + the legal options and pass it to the Getopt() constructor. WARNING: If + all elements of the array are not populated with LongOpt objects, the + getopt() method will throw a NullPointerException. +

+ When getopt() is called and a long option is encountered, one of two + things can be returned. If the flag field in the LongOpt object + representing the long option is non-null, then the integer value field + is stored there and an integer 0 is returned to the caller. The val + field can then be retrieved from the flag field. Note that since the + flag field is a StringBuffer, the appropriate String to integer converions + must be performed in order to get the actual int value stored there. + If the flag field in the LongOpt object is null, then the value field + of the LongOpt is returned. This can be the character of a short option. + This allows an app to have both a long and short option sequence + (say, "-h" and "--help") that do the exact same thing. +

+ With long options, there is an alternative method of determining + which option was selected. The method getLongind() will return the + the index in the long option array (NOT argv) of the long option found. + So if multiple long options are configured to return the same value, + the application can use getLongind() to distinguish between them. +

+ Here is an expanded Getopt example using long options and various + techniques described above: +

+ 

+ int c;
+ String arg;
+ LongOpt[] longopts = new LongOpt[3];
+ // 
+ StringBuffer sb = new StringBuffer();
+ longopts[0] = new LongOpt("help", LongOpt.NO_ARGUMENT, null, 'h');
+ longopts[1] = new LongOpt("outputdir", LongOpt.REQUIRED_ARGUMENT, sb, 'o'); 
+ longopts[2] = new LongOpt("maximum", LongOpt.OPTIONAL_ARGUMENT, null, 2);
+ // 
+ Getopt g = new Getopt("testprog", argv, "-:bc::d:hW;", longopts);
+ g.setOpterr(false); // We'll do our own error handling
+ //
+ while ((c = g.getopt()) != -1)
+   switch (c)
+     {
+        case 0:
+          arg = g.getOptarg();
+          System.out.println("Got long option with value '" +
+                             (char)(new Integer(sb.toString())).intValue()
+                             + "' with argument " +
+                             ((arg != null) ? arg : "null"));
+          break;
+          //
+        case 1:
+          System.out.println("I see you have return in order set and that " +
+                             "a non-option argv element was just found " +
+                             "with the value '" + g.getOptarg() + "'");
+          break;
+          //
+        case 2:
+          arg = g.getOptarg();
+          System.out.println("I know this, but pretend I didn't");
+          System.out.println("We picked option " +
+                             longopts[g.getLongind()].getName() +
+                           " with value " + 
+                           ((arg != null) ? arg : "null"));
+          break;
+          //
+        case 'b':
+          System.out.println("You picked plain old option " + (char)c);
+          break;
+          //
+        case 'c':
+        case 'd':
+          arg = g.getOptarg();
+          System.out.println("You picked option '" + (char)c + 
+                             "' with argument " +
+                             ((arg != null) ? arg : "null"));
+          break;
+          //
+        case 'h':
+          System.out.println("I see you asked for help");
+          break;
+          //
+        case 'W':
+          System.out.println("Hmmm. You tried a -W with an incorrect long " +
+                             "option name");
+          break;
+          //
+        case ':':
+          System.out.println("Doh! You need an argument for option " +
+                             (char)g.getOptopt());
+          break;
+          //
+        case '?':
+          System.out.println("The option '" + (char)g.getOptopt() + 
+                           "' is not valid");
+          break;
+          //
+        default:
+          System.out.println("getopt() returned " + c);
+          break;
+     }
+ //
+ for (int i = g.getOptind(); i < argv.length ; i++)
+   System.out.println("Non option argv element: " + argv[i] + "\n");
+
+

+ There is an alternative form of the constructor used for long options + above. This takes a trailing boolean flag. If set to false, Getopt + performs identically to the example, but if the boolean flag is true + then long options are allowed to start with a single '-' instead of + "--". If the first character of the option is a valid short option + character, then the option is treated as if it were the short option. + Otherwise it behaves as if the option is a long option. Note that + the name given to this option - long_only - is very counter-intuitive. + It does not cause only long options to be parsed but instead enables + the behavior described above. +

+ Note that the functionality and variable names used are driven from + the C lib version as this object is a port of the C code, not a + new implementation. This should aid in porting existing C/C++ code, + as well as helping programmers familiar with the glibc version to + adapt to the Java version even if it seems very non-Java at times. +

+ In this release I made all instance variables protected due to + overwhelming public demand. Any code which relied on optarg, + opterr, optind, or optopt being public will need to be modified to + use the appropriate access methods. +

+ Please send all bug reports, requests, and comments to + arenn@urbanophile.com. +

+

+
Version: +
1.0.3 +
Author: +
Roland McGrath (roland@gnu.ai.mit.edu), Ulrich Drepper (drepper@cygnus.com), Aaron M. Renn (arenn@urbanophile.com) +
See Also: +
LongOpt +
+
+ +

+ Constructor Index +

+
+
o + Getopt(String, String[], String) +
Construct a basic Getopt instance with the given input data. +
o + Getopt(String, String[], String, LongOpt[]) +
Construct a Getopt instance with given input data that is capable of + parsing long options as well as short. +
o + Getopt(String, String[], String, LongOpt[], boolean) +
Construct a Getopt instance with given input data that is capable of + parsing long options and short options. +
+

+ Method Index +

+
+
o + getLongind() +
Returns the index into the array of long options (NOT argv) representing + the long option that was found. +
o + getopt() +
This method returns a char that is the current option that has been + parsed from the command line. +
o + getOptarg() +
+ For communication from `getopt' to the caller. +
o + getOptind() +
optind it the index in ARGV of the next element to be scanned. +
o + getOptopt() +
When getopt() encounters an invalid option, it stores the value of that + option in optopt which can be retrieved with this method. +
o + setArgv(String[]) +
Since in GNU getopt() the argument vector is passed back in to the + function every time, the caller can swap out argv on the fly. +
o + setOpterr(boolean) +
Normally Getopt will print a message to the standard error when an + invalid option is encountered. +
o + setOptind(int) +
This method allows the optind index to be set manually. +
o + setOptstring(String) +
In GNU getopt, it is possible to change the string containg valid options + on the fly because it is passed as an argument to getopt() each time. +
+ +

+ Constructors +

+ + o +Getopt +
+ public Getopt(String progname,
+               String argv[],
+               String optstring)
+
+
+
Construct a basic Getopt instance with the given input data. Note that + this handles "short" options only. +

+

+
Parameters: +
progname - The name to display as the program name when printing errors +
argv - The String array passed as the command line to the program. +
optstring - A String containing a description of the valid args for this program +
+
+ o +Getopt +
+ public Getopt(String progname,
+               String argv[],
+               String optstring,
+               LongOpt long_options[])
+
+
+
Construct a Getopt instance with given input data that is capable of + parsing long options as well as short. +

+

+
Parameters: +
progname - The name to display as the program name when printing errors +
argv - The String array passed as the command ilne to the program +
optstring - A String containing a description of the valid short args for this program +
long_options - An array of LongOpt objects that describes the valid long args for this program +
+
+ o +Getopt +
+ public Getopt(String progname,
+               String argv[],
+               String optstring,
+               LongOpt long_options[],
+               boolean long_only)
+
+
+
Construct a Getopt instance with given input data that is capable of + parsing long options and short options. Contrary to what you might + think, the flag 'long_only' does not determine whether or not we + scan for only long arguments. Instead, a value of true here allows + long arguments to start with a '-' instead of '--' unless there is a + conflict with a short option name. +

+

+
Parameters: +
progname - The name to display as the program name when printing errors +
argv - The String array passed as the command ilne to the program +
optstring - A String containing a description of the valid short args for this program +
long_options - An array of LongOpt objects that describes the valid long args for this program +
long_only - true if long options that do not conflict with short options can start with a '-' as well as '--' +
+
+ +

+ Methods +

+ o +setOptstring +
+ public void setOptstring(String optstring)
+
+
+
In GNU getopt, it is possible to change the string containg valid options + on the fly because it is passed as an argument to getopt() each time. In + this version we do not pass the string on every call. In order to allow + dynamic option string changing, this method is provided. +

+

+
Parameters: +
optstring - The new option string to use +
+
+ o +getOptind +
+ public int getOptind()
+
+
+
optind it the index in ARGV of the next element to be scanned. + This is used for communication to and from the caller + and for communication between successive calls to `getopt'. + When `getopt' returns -1, this is the index of the first of the + non-option elements that the caller should itself scan. + Otherwise, `optind' communicates from one call to the next + how much of ARGV has been scanned so far. +

+

+ o +setOptind +
+ public void setOptind(int optind)
+
+
+
This method allows the optind index to be set manually. Normally this + is not necessary (and incorrect usage of this method can lead to serious + lossage), but optind is a public symbol in GNU getopt, so this method + was added to allow it to be modified by the caller if desired. +

+

+
Parameters: +
optind - The new value of optind +
+
+ o +setArgv +
+ public void setArgv(String argv[])
+
+
+
Since in GNU getopt() the argument vector is passed back in to the + function every time, the caller can swap out argv on the fly. Since + passing argv is not required in the Java version, this method allows + the user to override argv. Note that incorrect use of this method can + lead to serious lossage. +

+

+
Parameters: +
argv - New argument list +
+
+ o +getOptarg +
+ public String getOptarg()
+
+
+
For communication from `getopt' to the caller. + When `getopt' finds an option that takes an argument, + the argument value is returned here. + Also, when `ordering' is RETURN_IN_ORDER, + each non-option ARGV-element is returned here. + No set method is provided because setting this variable has no effect. +

+

+ o +setOpterr +
+ public void setOpterr(boolean opterr)
+
+
+
Normally Getopt will print a message to the standard error when an + invalid option is encountered. This can be suppressed (or re-enabled) + by calling this method. There is no get method for this variable + because if you can't remember the state you set this to, why should I? +

+

+ o +getOptopt +
+ public int getOptopt()
+
+
+
When getopt() encounters an invalid option, it stores the value of that + option in optopt which can be retrieved with this method. There is + no corresponding set method because setting this variable has no effect. +

+

+ o +getLongind +
+ public int getLongind()
+
+
+
Returns the index into the array of long options (NOT argv) representing + the long option that was found. +

+

+ o +getopt +
+ public int getopt()
+
+
+
This method returns a char that is the current option that has been + parsed from the command line. If the option takes an argument, then + the internal variable 'optarg' is set which is a String representing + the the value of the argument. This value can be retrieved by the + caller using the getOptarg() method. If an invalid option is found, + an error message is printed and a '?' is returned. The name of the + invalid option character can be retrieved by calling the getOptopt() + method. When there are no more options to be scanned, this method + returns -1. The index of first non-option element in argv can be + retrieved with the getOptind() method. +

+

+
Returns: +
Various things as described above +
+
+
+
+All Packages  Class Hierarchy  This Package  Previous  Next  Index
+ + diff --git a/gnu/getopt/gnu.getopt.LongOpt.html b/gnu/getopt/gnu.getopt.LongOpt.html new file mode 100644 index 0000000..ddc1186 --- /dev/null +++ b/gnu/getopt/gnu.getopt.LongOpt.html @@ -0,0 +1,210 @@ + + + + + + + Class gnu.getopt.LongOpt + + + + +
+All Packages  Class Hierarchy  This Package  Previous  Next  Index
+
+

+ Class gnu.getopt.LongOpt +

+
+java.lang.Object
+   |
+   +----gnu.getopt.LongOpt
+
+
+
+
public class LongOpt +
extends Object +
+This object represents the definition of a long option in the Java port + of GNU getopt. An array of LongOpt objects is passed to the Getopt + object to define the list of valid long options for a given parsing + session. Refer to the getopt documentation for details on the + format of long options. +

+

+
Version: +
1.0.3 +
Author: +
Aaron M. Renn (arenn@urbanophile.com) +
See Also: +
Getopt +
+
+ +

+ Variable Index +

+
+
o + NO_ARGUMENT +
Constant value used for the "has_arg" constructor argument. +
o + OPTIONAL_ARGUMENT +
Constant value used for the "has_arg" constructor argument. +
o + REQUIRED_ARGUMENT +
+ Constant value used for the "has_arg" constructor argument. +
+

+ Constructor Index +

+
+
o + LongOpt(String, int, StringBuffer, int) +
Create a new LongOpt object with the given parameter values. +
+

+ Method Index +

+
+
o + getFlag() +
Returns the value of the 'flag' field for this long option + + +
o + getHasArg() +
Returns the value set for the 'has_arg' field for this long option + + +
o + getName() +
Returns the name of this LongOpt as a String + + +
o + getVal() +
Returns the value of the 'val' field for this long option + + +
+ +

+ Variables +

+ o +NO_ARGUMENT +
+ public static final int NO_ARGUMENT
+
+
+
Constant value used for the "has_arg" constructor argument. This + value indicates that the option takes no argument.

+

+ o +REQUIRED_ARGUMENT +
+ public static final int REQUIRED_ARGUMENT
+
+
+
Constant value used for the "has_arg" constructor argument. This + value indicates that the option takes an argument that is required.

+

+ o +OPTIONAL_ARGUMENT +
+ public static final int OPTIONAL_ARGUMENT
+
+
+
Constant value used for the "has_arg" constructor argument. This + value indicates that the option takes an argument that is optional.

+

+ +

+ Constructors +

+ + o +LongOpt +
+ public LongOpt(String name,
+                int has_arg,
+                StringBuffer flag,
+                int val) throws IllegalArgumentException
+
+
+
Create a new LongOpt object with the given parameter values. If the + value passed as has_arg is not valid, then an exception is thrown. +

+

+
Parameters: +
name - The long option String. +
has_arg - Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT). +
flag - If non-null, this is a location to store the value of "val" when this option is encountered, otherwise "val" is treated as the equivalent short option character. +
val - The value to return for this long option, or the equivalent single letter option to emulate if flag is null. +
Throws: IllegalArgumentException +
If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT. +
+
+ +

+ Methods +

+ o +getName +
+ public String getName()
+
+
+
Returns the name of this LongOpt as a String +

+

+
Returns: +
Then name of the long option +
+
+ o +getHasArg +
+ public int getHasArg()
+
+
+
Returns the value set for the 'has_arg' field for this long option +

+

+
Returns: +
The value of 'has_arg' +
+
+ o +getFlag +
+ public StringBuffer getFlag()
+
+
+
Returns the value of the 'flag' field for this long option +

+

+
Returns: +
The value of 'flag' +
+
+ o +getVal +
+ public int getVal()
+
+
+
Returns the value of the 'val' field for this long option +

+

+
Returns: +
The value of 'val' +
+
+
+
+All Packages  Class Hierarchy  This Package  Previous  Next  Index
+ + From 32e6ffba49767e6506f795604530c27986304250 Mon Sep 17 00:00:00 2001 From: "Aaron M. Renn" Date: Wed, 16 Jan 2002 12:00:00 +0000 Subject: [PATCH 2/8] Release 1.0.9 Yasuoka Masahiko provided Japanese langauge messages. Csom Gyula provided Hungarian languag messages. Guillaume Rousse supplied the ant build file and documentation. --- gnu/getopt/ChangeLog | 9 ++++ gnu/getopt/MessagesBundle_hu.properties | 32 ++++++++++++ gnu/getopt/MessagesBundle_ja.properties | 32 ++++++++++++ gnu/getopt/README | 14 +++++ gnu/getopt/buildx.xml | 68 +++++++++++++++++++++++++ 5 files changed, 155 insertions(+) create mode 100644 gnu/getopt/MessagesBundle_hu.properties create mode 100644 gnu/getopt/MessagesBundle_ja.properties create mode 100644 gnu/getopt/buildx.xml diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog index e96218a..d454b20 100644 --- a/gnu/getopt/ChangeLog +++ b/gnu/getopt/ChangeLog @@ -1,3 +1,12 @@ +For release 1.9.9 (2002/01/16) + +Yasuoka Masahiko provided Japanese langauge messages. + +Csom Gyula provided Hungarian languag messages. + +Guillaume Rousse supplied the ant build file +and documentation. + For release 1.0.8 (2000/09/11) Ernst de Haan provided Dutch language messages. diff --git a/gnu/getopt/MessagesBundle_hu.properties b/gnu/getopt/MessagesBundle_hu.properties new file mode 100644 index 0000000..f7af03b --- /dev/null +++ b/gnu/getopt/MessagesBundle_hu.properties @@ -0,0 +1,32 @@ +/************************************************************************** +/* MessagesBundle.properties -- Hungarian language error messages +/* +/* Copyright (c) 2001 by Gyula Csom (csom@informix.hu) +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: opció ''{1}'' félreérthetõ +getopt.arguments1={0}: opció ''--{1}'' nem enged meg argumentumot +getopt.arguments2={0}: opció ''{1}{2}'' nem enged meg argumentumot +getopt.requires={0}: opció ''{1}'' argumentumot igényel +getopt.unrecognized={0}: ismeretlen opció ''--{1}'' +getopt.unrecognized2={0}: ismeretlen opció ''{1}{2}'' +getopt.illegal={0}: illegális opció -- {1} +getopt.invalid={0}: érvénytelen opció -- {1} +getopt.requires2={0}: az opció argumentumot igényel -- {1} +getopt.invalidValue=Érvénytelen érték {0} a következõ paraméterhez 'has_arg' + diff --git a/gnu/getopt/MessagesBundle_ja.properties b/gnu/getopt/MessagesBundle_ja.properties new file mode 100644 index 0000000..5578972 --- /dev/null +++ b/gnu/getopt/MessagesBundle_ja.properties @@ -0,0 +1,32 @@ +/************************************************************************** +/* MessagesBundle.properties -- Japanese language error messages +/* +/* Copyright (c) 2001 by Yasuoka Masahiko (yasuoka@yasuoka.net) +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: ''{1}'' \u30aa\u30d7\u30b7\u30e7\u30f3\u306f\u66d6\u6627\u3067\u3059\u3002 +getopt.arguments1={0}: ''--{1}'' \u30aa\u30d7\u30b7\u30e7\u30f3\u306f\u30d1\u30e9\u30e1\u30fc\u30bf\u3092\u3082\u3061\u307e\u305b\u3093\u3002 +getopt.arguments2={0}: ''{1}{2}'' \u30aa\u30d7\u30b7\u30e7\u30f3\u306f\u30d1\u30e9\u30e1\u30fc\u30bf\u3092\u3082\u3061\u307e\u305b\u3093\u3002 +getopt.requires={0}: ''{1}'' \u30aa\u30d7\u30b7\u30e7\u30f3\u306b\u306f\u30d1\u30e9\u30e1\u30fc\u30bf\u304c\u5fc5\u8981\u3067\u3059\u3002 +getopt.unrecognized={0}: ''--{1}'' \u306f\u7121\u52b9\u306a\u30aa\u30d7\u30b7\u30e7\u30f3\u3067\u3059\u3002 +getopt.unrecognized2={0}: ''{1}{2}'' \u306f\u7121\u52b9\u306a\u30aa\u30d7\u30b7\u30e7\u30f3\u3067\u3059\u3002 +getopt.illegal={0}: -- {1} \u306f\u4e0d\u6b63\u306a\u30aa\u30d7\u30b7\u30e7\u30f3\u3067\u3059\u3002 +getopt.invalid={0}: -- {1} \u30aa\u30d7\u30b7\u30e7\u30f3\u306f\u6b63\u3057\u304f\u3042\u308a\u307e\u305b\u3093\u3002 +getopt.requires2={0}: -- {1} \u30aa\u30d7\u30b7\u30e7\u30f3\u306b\u306f\u30d1\u30e9\u30e1\u30fc\u30bf\u304c\u5fc5\u8981\u3067\u3059\u3002 +getopt.invalidValue={0} \u306f\u3001'has_arg' \u30d1\u30e9\u30e1\u30fc\u30bf\u3068\u3057\u3066\u4e0d\u6b63\u306a\u5024\u3067\u3059\u3002 + diff --git a/gnu/getopt/README b/gnu/getopt/README index 867fd9b..3382be4 100644 --- a/gnu/getopt/README +++ b/gnu/getopt/README @@ -36,8 +36,22 @@ such a simple package. There is sample code showing how to use getopt available in the GetoptDemo.java file. +NEW: A support file for the "ant" build process was contributed. Here are +some brief things you can do with it. Note that I have not ever used this +so it is doubly AS IS. + +Get ant from jakarta project (see jakarta.apache.org/ant), and run it with +one of these target (all is default target): +ant prepare: create the needed directories +ant classes: compile the java classes +ant jar: create the jar archive +ant javadoc: create the javadoc +ant all: create jar and javadoc +ant clean: clean everything + Happy hacking, Aaron. arenn@urbanophile.com http://www.urbanophile.com/arenn/ + diff --git a/gnu/getopt/buildx.xml b/gnu/getopt/buildx.xml new file mode 100644 index 0000000..ad51e8f --- /dev/null +++ b/gnu/getopt/buildx.xml @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From 0da7366fa82ef041a6600c78142bb5eb63705e14 Mon Sep 17 00:00:00 2001 From: "Aaron M. Renn" Date: Sun, 12 Sep 2004 12:00:00 +0000 Subject: [PATCH 3/8] Release 1.0.10 Marian-Nicolae V. Ion (mion@neocom.fr) provided Romanian language messages. --- gnu/getopt/ChangeLog | 8 ++++-- gnu/getopt/MessagesBundle_ro.properties | 34 +++++++++++++++++++++++++ gnu/getopt/README | 2 +- 3 files changed, 41 insertions(+), 3 deletions(-) create mode 100644 gnu/getopt/MessagesBundle_ro.properties diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog index d454b20..b552c2f 100644 --- a/gnu/getopt/ChangeLog +++ b/gnu/getopt/ChangeLog @@ -1,8 +1,12 @@ -For release 1.9.9 (2002/01/16) +For release 1.0.10 (2004/09/12) + +Marian-Nicolae V. Ion (mion@neocom.fr) provided Romanian language messages. + +For release 1.0.9 (2002/01/16) Yasuoka Masahiko provided Japanese langauge messages. -Csom Gyula provided Hungarian languag messages. +Csom Gyula provided Hungarian language messages. Guillaume Rousse supplied the ant build file and documentation. diff --git a/gnu/getopt/MessagesBundle_ro.properties b/gnu/getopt/MessagesBundle_ro.properties new file mode 100644 index 0000000..3c0b08b --- /dev/null +++ b/gnu/getopt/MessagesBundle_ro.properties @@ -0,0 +1,34 @@ +/************************************************************************** +/* MessagesBundle_fr.properties -- Romanian language error messages +/* +/* Copyright (c) 1999 Free Software Foundation, Inc. +/* Marian-Nicolae Ion , 2004, +/* These messages are encoded in ISO-8859-2 +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 of the License or +/* (at your optiunea) 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: opÅ£iunea ''{1}'' este ambiguă +getopt.arguments1={0}: opÅ£iunea ''--{1}'' nu acceptă parametru +getopt.arguments2={0}: opÅ£iunea ''{1}{2}'' nu acceptă parametru +getopt.requires={0}: opÅ£iunea ''{1}'' cere un parametru +getopt.unrecognized={0}: opÅ£iune necunoscută ''--{1}'' +getopt.unrecognized2={0}: opÅ£iune necunoscută ''{1}{2}'' +getopt.illegal={0}: opÅ£iune ilegală -- {1} +getopt.invalid={0}: opÅ£iune invalidă -- {1} +getopt.requires2={0}: această opÅ£iune cere un parametru -- {1} +getopt.invalidValue=Valoare invalidă {0} pentru parametrul 'has_arg' + diff --git a/gnu/getopt/README b/gnu/getopt/README index 3382be4..74cf0a8 100644 --- a/gnu/getopt/README +++ b/gnu/getopt/README @@ -15,7 +15,7 @@ CLASSPATH. This includes the "MessagesBundle" files. I am not aware of any bugs. If you find one though, please send email to me at arenn@urbanophile.com. The more detailed a bug report the better. Bug fixes are also welcome at the same address. Please reference -release number "1.0.8". If you use this code, it would be helpful +release number "1.0.10". If you use this code, it would be helpful if you let me know so that I can let you know if anything changes or if any major bugs have been found/fixed. From 45dfc62d58791be86aa39766fcbfaff297bf21b8 Mon Sep 17 00:00:00 2001 From: "Aaron M. Renn" Date: Sat, 19 Feb 2005 12:00:00 +0000 Subject: [PATCH 4/8] Release 1.0.11 Daniel Perez Alvarez (dondani@gmail.com) provided Spanish language messages. --- gnu/getopt/ChangeLog | 5 ++++ gnu/getopt/MessagesBundle_es.properties | 33 +++++++++++++++++++++++++ gnu/getopt/README | 2 +- 3 files changed, 39 insertions(+), 1 deletion(-) create mode 100644 gnu/getopt/MessagesBundle_es.properties diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog index b552c2f..38131d0 100644 --- a/gnu/getopt/ChangeLog +++ b/gnu/getopt/ChangeLog @@ -1,3 +1,8 @@ +For release 1.0.11 (2005/02/19) + +Daniel Perez Alvarez (dondani@gmail.com) provided Spanish language +messages. + For release 1.0.10 (2004/09/12) Marian-Nicolae V. Ion (mion@neocom.fr) provided Romanian language messages. diff --git a/gnu/getopt/MessagesBundle_es.properties b/gnu/getopt/MessagesBundle_es.properties new file mode 100644 index 0000000..ef358f4 --- /dev/null +++ b/gnu/getopt/MessagesBundle_es.properties @@ -0,0 +1,33 @@ +/************************************************************************** +/* MessagesBundle_es.properties -- Spanish language error messages +/* +/* Spanish Messages Copyright (c) 2004 by Daniel Pérez (dondani@gmail.com) +/* These messages are encoded in ISO-8859-1 +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: la opción ''{1}'' es ambigua +getopt.arguments1={0}: la opción ''--{1}'' no permite un argumento +getopt.arguments2={0}: la opción ''{1}{2}'' no permite un argumento +getopt.requires={0}: la opción ''{1}'' requiere un argumento +getopt.unrecognized={0}: opción no reconocida ''--{1}'' +getopt.unrecognized2={0}: opción no reconocida ''{1}{2}'' +getopt.illegal={0}: opción ilegal -- {1} +getopt.invalid={0}: opción no válida -- {1} +getopt.requires2={0}: la opción requiere un argumento -- {1} +getopt.invalidValue=Valor no válido {0} para el parámetro 'has_arg' + diff --git a/gnu/getopt/README b/gnu/getopt/README index 74cf0a8..967f2af 100644 --- a/gnu/getopt/README +++ b/gnu/getopt/README @@ -15,7 +15,7 @@ CLASSPATH. This includes the "MessagesBundle" files. I am not aware of any bugs. If you find one though, please send email to me at arenn@urbanophile.com. The more detailed a bug report the better. Bug fixes are also welcome at the same address. Please reference -release number "1.0.10". If you use this code, it would be helpful +release number "1.0.11". If you use this code, it would be helpful if you let me know so that I can let you know if anything changes or if any major bugs have been found/fixed. From 56a1b73a7c6926e4ea0e224a6ffe22250c9b09bc Mon Sep 17 00:00:00 2001 From: "Aaron M. Renn" Date: Sat, 12 Nov 2005 12:00:00 +0000 Subject: [PATCH 5/8] Release 1.0.12 Sandro Tossi (matrixhasu@gmail.com) provided Italian language messages. --- gnu/getopt/ChangeLog | 4 ++++ gnu/getopt/MessagesBundle_it.properties | 32 +++++++++++++++++++++++++ gnu/getopt/README | 2 +- 3 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 gnu/getopt/MessagesBundle_it.properties diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog index 38131d0..1ffb648 100644 --- a/gnu/getopt/ChangeLog +++ b/gnu/getopt/ChangeLog @@ -1,3 +1,7 @@ +For release 1.0.12 (2005/11/12) + +Sandro Tossi (matrixhasu@gmail.com) provided Italian language messages. + For release 1.0.11 (2005/02/19) Daniel Perez Alvarez (dondani@gmail.com) provided Spanish language diff --git a/gnu/getopt/MessagesBundle_it.properties b/gnu/getopt/MessagesBundle_it.properties new file mode 100644 index 0000000..c596c26 --- /dev/null +++ b/gnu/getopt/MessagesBundle_it.properties @@ -0,0 +1,32 @@ +/************************************************************************** +/* MessagesBundle.properties -- Italian language error messages +/* +/* Copyright (c) 2005 by Sandro Tosi (matrixhasu@gmail.com) +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + +getopt.ambigious={0}: l'opzione ''{1}'' è ambigua +getopt.arguments1={0}: l'opzione ''--{1}'' non ammette un argomento +getopt.arguments2={0}: l'opzione ''{1}{2}'' non ammette un argomento +getopt.requires={0}: l'opzione ''{1}'' richiede un argomento +getopt.unrecognized={0}: opzione non riconosciuta ''--{1}'' +getopt.unrecognized2={0}: opzione non riconosciuta ''{1}{2}'' +getopt.illegal={0}: opzione illegale -- {1} +getopt.invalid={0}: opzione invalida -- {1} +getopt.requires2={0}: l'opzione richiede un argomento -- {1} +getopt.invalidValue=Valore non valido {0} per il parametro 'has_arg' + diff --git a/gnu/getopt/README b/gnu/getopt/README index 967f2af..da3ed98 100644 --- a/gnu/getopt/README +++ b/gnu/getopt/README @@ -15,7 +15,7 @@ CLASSPATH. This includes the "MessagesBundle" files. I am not aware of any bugs. If you find one though, please send email to me at arenn@urbanophile.com. The more detailed a bug report the better. Bug fixes are also welcome at the same address. Please reference -release number "1.0.11". If you use this code, it would be helpful +release number "1.0.12". If you use this code, it would be helpful if you let me know so that I can let you know if anything changes or if any major bugs have been found/fixed. From f621c86a15f1e842fb81c484bdbac3c065515b81 Mon Sep 17 00:00:00 2001 From: "Aaron M. Renn" Date: Tue, 29 Aug 2006 12:00:00 +0000 Subject: [PATCH 6/8] Release 1.0.13 Krzysztof Szymanski (sirch.s@gmail.com) provided Polish language messages. --- gnu/getopt/ChangeLog | 4 +++ gnu/getopt/LANGUAGES | 22 +++++++++++++++ gnu/getopt/MessagesBundle_pl.properties | 36 +++++++++++++++++++++++++ gnu/getopt/README | 2 +- 4 files changed, 63 insertions(+), 1 deletion(-) create mode 100644 gnu/getopt/LANGUAGES create mode 100644 gnu/getopt/MessagesBundle_pl.properties diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog index 1ffb648..366ffd2 100644 --- a/gnu/getopt/ChangeLog +++ b/gnu/getopt/ChangeLog @@ -1,3 +1,7 @@ +For release 1.0.13 (2006/08/29) + +Krzysztof Szymanski (sirch.s@gmail.com) provided Polish language messages. + For release 1.0.12 (2005/11/12) Sandro Tossi (matrixhasu@gmail.com) provided Italian language messages. diff --git a/gnu/getopt/LANGUAGES b/gnu/getopt/LANGUAGES new file mode 100644 index 0000000..6820424 --- /dev/null +++ b/gnu/getopt/LANGUAGES @@ -0,0 +1,22 @@ +Getopt supports error messages in the following languages: + +English (default) +Czech +Dutch +French +German +Hungarian +Italian +Japanese +Norwegian +Polish +Romanian +Spanish + +Anyone can create a translation without knowing how to program Java. +Simply supply me with a MessagesBundle file for your locale and I'm happy +to include it. See MessagesBundle.properties as an example with reference +English messages. + +Aaron (arenn@urbanophile.com) + diff --git a/gnu/getopt/MessagesBundle_pl.properties b/gnu/getopt/MessagesBundle_pl.properties new file mode 100644 index 0000000..9580853 --- /dev/null +++ b/gnu/getopt/MessagesBundle_pl.properties @@ -0,0 +1,36 @@ +/************************************************************************** +/* MessagesBundle_pl.properties -- Polish language error messages +/* +/* Polish Messages Copyright (c) 2006 by Krzysztof Szyma?ski (sirch.s@gmail.com) +/* These messages are encoded in ISO-8859-2 +/* +/* This program is free software; you can redistribute it and/or modify +/* it under the terms of the GNU Library General Public License as published +/* by the Free Software Foundation; either version 2 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 Library General Public License for more details. +/* +/* You should have received a copy of the GNU Library General Public License +/* along with this program; see the file COPYING.LIB. If not, write to +/* the Free Software Foundation Inc., 59 Temple Place - Suite 330, +/* Boston, MA 02111-1307 USA +/**************************************************************************/ + + +getopt.ambigious={0}: opcja ''{1}''jest wieloznaczna +getopt.arguments1={0}: opcja ''--{1}'' nie akceptuje argumentu +getopt.arguments2={0}: opcja ''{1}{2}'' nie akceptuje argumentu +getopt.requires={0}: opcja ''{1}'' wymaga argumentu +getopt.unrecognized={0}: nierozpoznana opcja ''--{1}'' +getopt.unrecognized2={0}: nierozpoznana opcja ''{1}{2}'' +getopt.illegal={0}: nie dopuszczalna opcja --{1} +getopt.invalid={0}: b??dna opcja --{1} +getopt.requires2={0}: opcja --{1} oczekuje argumentu +getopt.invalidValue=Nie poprawna warto?? {0} argument 'has_arg' + + + diff --git a/gnu/getopt/README b/gnu/getopt/README index da3ed98..48451f7 100644 --- a/gnu/getopt/README +++ b/gnu/getopt/README @@ -15,7 +15,7 @@ CLASSPATH. This includes the "MessagesBundle" files. I am not aware of any bugs. If you find one though, please send email to me at arenn@urbanophile.com. The more detailed a bug report the better. Bug fixes are also welcome at the same address. Please reference -release number "1.0.12". If you use this code, it would be helpful +release number "1.0.13". If you use this code, it would be helpful if you let me know so that I can let you know if anything changes or if any major bugs have been found/fixed. From 3569f4e5c2ceb3f783397e777d693c09135d4832 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Sch=C3=A4fer?= Date: Sat, 23 May 2015 15:50:05 +0200 Subject: [PATCH 7/8] Remove Javadoc and class files, move non-source-files to the root directory The class files and javadoc can be regenerated easily with ant or make (make all, make docs, ant classes, ant javadoc). Slight adaptions were made to the make file to ensure its functionality. Make is generating class files into a ./bin/ directory, javadoc files into a ./javadoc/ directory. Ant is generating all its files into the subdirectories of a ./build/ directory. --- .gitignore | 5 + gnu/getopt/ChangeLog => CHANGELOG.md | 0 gnu/getopt/LANGUAGES => LANGUAGES.md | 0 gnu/getopt/COPYING.LIB => LICENSE | 0 Makefile | 8 + gnu/getopt/README => README.md | 2 +- gnu/getopt/buildx.xml => build.xml | 0 gnu/getopt/Getopt.class | Bin 7366 -> 0 bytes gnu/getopt/GetoptDemo.class | Bin 2868 -> 0 bytes gnu/getopt/LongOpt.class | Bin 1658 -> 0 bytes gnu/getopt/Makefile | 7 - gnu/getopt/gnu.getopt.Getopt.html | 639 --------------------------- gnu/getopt/gnu.getopt.LongOpt.html | 210 --------- 13 files changed, 14 insertions(+), 857 deletions(-) create mode 100644 .gitignore rename gnu/getopt/ChangeLog => CHANGELOG.md (100%) rename gnu/getopt/LANGUAGES => LANGUAGES.md (100%) rename gnu/getopt/COPYING.LIB => LICENSE (100%) create mode 100644 Makefile rename gnu/getopt/README => README.md (97%) rename gnu/getopt/buildx.xml => build.xml (100%) delete mode 100644 gnu/getopt/Getopt.class delete mode 100644 gnu/getopt/GetoptDemo.class delete mode 100644 gnu/getopt/LongOpt.class delete mode 100644 gnu/getopt/Makefile delete mode 100644 gnu/getopt/gnu.getopt.Getopt.html delete mode 100644 gnu/getopt/gnu.getopt.LongOpt.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8d8f515 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +/build +/gnu/getopt/*.class +/javadoc +/bin + diff --git a/gnu/getopt/ChangeLog b/CHANGELOG.md similarity index 100% rename from gnu/getopt/ChangeLog rename to CHANGELOG.md diff --git a/gnu/getopt/LANGUAGES b/LANGUAGES.md similarity index 100% rename from gnu/getopt/LANGUAGES rename to LANGUAGES.md diff --git a/gnu/getopt/COPYING.LIB b/LICENSE similarity index 100% rename from gnu/getopt/COPYING.LIB rename to LICENSE diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..a828395 --- /dev/null +++ b/Makefile @@ -0,0 +1,8 @@ +# Makefile for Java port of GNU getopt + +all: + mkdir -p bin + javac -d ./bin/ gnu/getopt/**.java + +docs: + javadoc -author -version -public -d ./javadoc/ gnu/getopt/Getopt.java gnu/getopt/LongOpt.java diff --git a/gnu/getopt/README b/README.md similarity index 97% rename from gnu/getopt/README rename to README.md index 48451f7..598a92e 100644 --- a/gnu/getopt/README +++ b/README.md @@ -15,7 +15,7 @@ CLASSPATH. This includes the "MessagesBundle" files. I am not aware of any bugs. If you find one though, please send email to me at arenn@urbanophile.com. The more detailed a bug report the better. Bug fixes are also welcome at the same address. Please reference -release number "1.0.13". If you use this code, it would be helpful +release number "1.0.14". If you use this code, it would be helpful if you let me know so that I can let you know if anything changes or if any major bugs have been found/fixed. diff --git a/gnu/getopt/buildx.xml b/build.xml similarity index 100% rename from gnu/getopt/buildx.xml rename to build.xml diff --git a/gnu/getopt/Getopt.class b/gnu/getopt/Getopt.class deleted file mode 100644 index 735a7f1b16f8604e9cb9d33e36933c4d2349e9fe..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 7366 zcmcgw3s{urm43g=KQ~8#5mdrOgBo!FF^D!n@rIYUi()`y#Tp!7z%j!N4ud6Et!plB z?rv%WF)LMDlEySQK~o!TZe|;kji#F>P21Eq*>1MoHfy%c+K}p=^Zzq2;G|D?pLQP} zzRUT~{X6IVK6v%~ca8xlLB9(N@f8;)W4n`9f5*cP9&Y8~HXd&0;SL9Oy72e7(}lZm zH&gC$;a=S5!2P`0#lt`F@Bj~Abn>RlNx~1Y$R6H4%&ULo)m|RDdH6aH z`yANM-wwF&4SbVVJv=IBu0vYQnn?voz&HgBniYw_`Rcn-#J1w?Q@OpBV z*QTYE)^J;(BY1sXLpT!gH;|PS{zjs88-1b1pr5>PHw7YX(YjDLL}Y;xL0`ho;SV*o z`XX(90Zox@5g5HLS!|AQq|wiDQXH+3aC6AlLL$z(7Jpltuh~zIUt)>1M+3p)YJXd} zJ<{M`*v>w1YUTt&f#_U;viys+Coy<2)6{Fo!-{YtSxu=7g#0VoTk8FhRlfQlQL6s0 zT9YQ5O|ATkYOH0IBWt3*hU=F5T1}^^JncAX$9g+f(HXV*qjb*kn#f3EomDugEQrlK zdX+zwirHxiniQSCjG632T3{aKnEWKEP0(YOa(e#Mi?cnT*eqk6Zw3&vZdQ?tJmKOr z4LkfDRM(+qKAVP({)X%L3;P)k+3^~kzE#Zvt{Sr}mIV0FMl3aJd>VI>8}(@B;dM8b zW04yxQ02x-UajS!mWOqy639&Gj^(l9v&zhle|F;yoU-Gz8*kzVZft;$a_q*xpp|-Y zf*WZaV{zcQ(Z(nl^oN?G8{?i@x6AcyQGW|{3wgRS5^nWJ zqI3gX@wvtlucV}nEmzkJ++RZjwejV&fD*w#Qo#_=UO$LP%aUrd69D)-s+#EHO5zeD zl${)3Vcr&F@|Pu7;-c#~5^Y-(;MkMu;d_({(ih|#GSQILLbIn5gEFxy!^(LeT)dL5 zt0O7&@?~ppS0maTgg`*xuCS zk5Kqy2JyfWwZ2$5Ul}Vqo3FK%-U9+zQ~;l^i_2pfE~PiuWO^25AR84}1cAl;cES?c zFHP8AMf+t5`@ex^+$3JjP;btJ_U250Z_Wgy=1eGU&IHuvOjvEs1i9u+z--QhzUEAK zg*nr8L9^r=!`u_(n=>J|InzC0ey0n9=27H(JsN0iq}^q(k!OI*TToae)M1FHXeZ!j z8tH^Afm6;fWtw6#Q%J_3?;}_yQzsKz1eaWF3N>3o;x;G}15SGnLwZ#&lvnpcdsFB2 z!r-Ni2Rnapcs&jUbu_;FtQ6a&!`pNf?lL}3wx33E$T&@H3 z2r^zFk4St>57JrJ7*g{z#>UjBK8#B(>PEKL){9Kmst;g^w@CNl64KU#vLchEfLTa7 z&N4B9WvurQ#&nVu{@z1=lI={+mo)Qr3&zv37FxUrr}#cbi8qig&LdMQ#;&MV3pj6^)djz3}TaP!4?_8HW|gOvK@EJE$EaT*e`Fu zBl1Q(DR07ea9&K#*}P>`CJH%ilKv>+5a z$Z~R=ju@#0@g!GrlG6r5@^Ep;PS|A^o#-B<$cIfc3c^K7!f1`D%AuKz&`}DwFx{~$e zFjvkH)0fe4k!o^94_EzLQvDHeUY|5dV|bMP#Ck(g*6d-d%1&veXNBd3SWS)LAU}^& z?rh~W*ynNB>qz;4>_QM2)NH3tXO0`#ecIHoGhD$IucJW_?A9?Pab zYfH|-d7d&UME*H&is`LprC6ONGNF&$Au73fbJSc)uUGa`uOC9LXM7(flxNFsYHiw5 zGnA`YMh4fi=h!|p@tk3l^x;zetg`!%*N2InSeo?1q)sqUutcQ^PuZGsjtK>?5H1a& z_rTC|cNlauyK_3RDnoania2y9rW?;;@>0K#e$+SPUFP(j?N zLfEP{<8~Fned^2DMZ6EHo2gf};t}-~Jg>InEpjvYuqapEVx`(A8r6Q$p}r|@RNoShsmH}}^^AB~9TKmrK5SbA~UX^9)q+F<8lU3?K(a7y(>G^Pvy<(jNGn%VfJz{MqfZa4D;f;nR*)djQ%&(kE(R>DU3N|=Q;YZs2>%n zMKg0`9$#d)#M|4k%WQYpioJr5{16;e6NWrUtK1XxXrReMcif~-@g}Y9^s5d~uk*}r zju@g1k{IAJjc(i(`()pXOj??Pdoju^us&SbLvM@$YFu3$9Jv%1(Pyg?P4iu5?^*=2 zgy=oOkPu@jV-IOF(84_z`VxG!>U%F52PLQpNup*@f~A*w1d zOhn4%cijM&^=`|hz2}6;7$BRt)P)ivjPArA2j~QG#(uLj(gtXxVq70)6YRg`?Zcco z^nqa5$YNJWc*+1{Oer5WOXu?0S%Q0LONeswP*#H0;SiHsvpkO6lVW~yRD7e+YuCfs%Z(+j2Tn^=EGKGO7RR#}qj??Q zQ`Y%gtaUJQu*?ciz?qdw0N6p_DgFRW^e`?R5;a47)~;9tE8@}5BiD=K(O>>&2+SW8 z;0GgvexcbsYr1i~(2DGEA)jUH>~1_h;Bc4Kr@2&IJ=j9zcuB9ceExH6FBoQ2D=EjNpw<XF!?)9{i`$7wwl zKhnAQL{FgqPvnU)dZM^gPZEWCvMAM4M7f?Smgs4sT9=6RdWP`pnW9;jiHCH#*ste` zZ|M2rS-n6U)l0-{dZ{?0mx;5wR$ig6mF0SaT%>(+iEfsg^(NV&gL0=1$vrwOpU@Hc zv~HI_(;f0-eTzJ&w<@W(DZAdTT>5r3THm2^^-fi!?^HAN-D;-3M=j9zs;l+=YQ5g2 zn)L%}v)-*b^n+@ven@rcht=bHuXKAobzpNwrq~5Au(|74N^!@s@eo()uyYvtBUj4RyRKKGS z>YwOi`aOM0|D0Cu>ksJXto~4cqJOQ=>yHeVK5KaN$HsX5JEK5?KTb2h88FV{R;GI)0B${DHJK?66^(OrG#>ElWdc1liir?w%`px zQ1FI2j!(`o;|mWy>1gWM5l0__i9X@DX3SJ#Gs8;8wwEv~VU7wz zRgiF5!WBxE!8>MH*_e7v6Nu}MtEQ1L2i3IEBOra)gC`mM3Ec`N?5*ICp(jQ&CWZZH z%mHg^O3f0jq?*bI&leeL49m<|W?Un^lvXZlX)Dc8UxrtV$RL|)&dg+u1Ve2g6pe*K z@lbN2PvE@d!^?QZhgWgchu3gT!gU{B#|?&!l^nEGT#(pu+%S2HxN^!zGju+unMppY zq%4)U`*0I)5RDb@ux_deHS5EhxF$m0^5M3Kb`x(g)U_AAm2ARFtGdZ4N8L)LsDwVe zjav+AnCDcLUokA6RAyD4RZT0ab4}+)mgvx?$rU}$&7?vLt{ZxwM2j$IxtdaK+&Lx3 zr>&gHrwog%ZOUd+U82pv+8J8Hd`36s2usU#^QdL=424t4KFs4Act_;(F0L{7%8NmziV*FRbtXkE#f{XmAH({x?GkBXv1uh^B`4xc8Cfn4p5dtz z>2$h>3peUT+ERF6qEtaqlbDgss)gJDY_5u;VNY@ zPL)|9w6>jVIjXEFs-?w6)7lN&(OEhT0u<+Y$A|ZYd(#LtMU_Jc(djZT&Be+nPzS7Z z%4l?&$WvLW3>`z`LZcDvsGQ|+g{nAeePJ=> zqg6braI3)Rt4dWM)=;~SW=u6JhPmUMP%6Q>e+luU-Ym?2Olp~?^gmObg@D4WJoO&hDZ5`CE}d`8SZb$iE=M}bKh zaT+Olt$Ha(ae$iOB+eVlgFCkpgkVB)1p_r3JAl_VqS z?wSYtoE9`bbobcGTKY8X!+u(mscR52B=Vo~d<)0O0-TX~xI(Uga{-Qs-|b{|$$5Cj z0xtVmay7Z?3|ry06|$ST#p42MB7Sd|zcw%rU&!6$cIL6B$(_gA$N|S)_OSUgBJmY* z@X{rI5xNA$Pv~;c^*vo7Qt2cQk-S54f@F+jl%$6wt=V>x@sdoEJS&2%8~y@y3#cdV ze*gMB8WzwPX>#SUVICXv*z{o@P5#ZK@BR@|_dU4%&GeARmOQrJD@>L-KSp{Rk);3e zGNZlAar~UT%3NB=Dj;^Z?aE`j@Y_MRYLOOyD|2flqh>*@L}T&i|Wua=tYO!iyxzv*6ZP>e?M!n0gquLg4l$9Y{oE} zF-A>%k+fe^li$ZS{EjyKiB7f^-Hap1+R)2-u#-jUpM;8i>?-!N>o~}6p`U$;!)zXd z>^mG~Ki~v=fRpSe46|P_%6`RZM?J1Xq&tEb!H5jXSM{1*G-XvLYWZhAt}@Fl)du%_W_+>sH#(U8Ik4JVP*@HXDj@Gg=h zn4T6o9Udst7ZJm;{X+aLe_Y;ZiA=vSPa}n9jmv?lRMmp0bJwCSyBzgEh@){YYJjwS z`utfk+z1d?k1G9)GaVHKM59cRv?sc_)7SOQyY(RoQQ62XRcErOj;fu{ygHwmG zdgtYGK&(4G0`-aCtM=fZnhf|hvr0^j(q#n1F@Z58>4G>$UI@p@AMf!e$e----$F!^ zPS}X#-CK!zZzc9=4M|r?`}gJi~=l z^ckiiuMk@czl5@u+ClsU2C7%0FQKmK&k;==c>!%Ax{JXb9Q{{6zl|Y1wT)qYY8xYZ zl7c1v^zxr0tJ9qcJfbS=7{+6&^?SO3f4~xcL=iusf}cswzu+!@MVgRfV6W*gsvx64 zX9~_U+I^p%2=$@TGlglgvX>LI%F`%SHS`C)FvyfKZ}SP+EIuH67&`p>A?R-e`jD#X ahmIVM`WJyd3XGaK9Q74JFH)uuK7Iq%AbJb{ diff --git a/gnu/getopt/Makefile b/gnu/getopt/Makefile deleted file mode 100644 index 6ff789c..0000000 --- a/gnu/getopt/Makefile +++ /dev/null @@ -1,7 +0,0 @@ -# Makefile for Java port of GNU getopt - -all: - javac LongOpt.java Getopt.java GetoptDemo.java - -docs: - javadoc -author -version -public Getopt.java LongOpt.java diff --git a/gnu/getopt/gnu.getopt.Getopt.html b/gnu/getopt/gnu.getopt.Getopt.html deleted file mode 100644 index 425de42..0000000 --- a/gnu/getopt/gnu.getopt.Getopt.html +++ /dev/null @@ -1,639 +0,0 @@ - - - - - - - Class gnu.getopt.Getopt - - - - -
-All Packages  Class Hierarchy  This Package  Previous  Next  Index
-
-

- Class gnu.getopt.Getopt -

-
-java.lang.Object
-   |
-   +----gnu.getopt.Getopt
-
-
-
-
public class Getopt -
extends Object -
-This is a Java port of GNU getopt, a class for parsing command line - arguments passed to programs. It it based on the C getopt() functions - in glibc 2.0.6 and should parse options in a 100% compatible manner. - If it does not, that is a bug. The programmer's interface is also - very compatible. -

- To use Getopt, create a Getopt object with a argv array passed to the - main method, then call the getopt() method in a loop. It will return an - int that contains the value of the option character parsed from the - command line. When there are no more options to be parsed, it - returns -1. -

- A command line option can be defined to take an argument. If an - option has an argument, the value of that argument is stored in an - instance variable called optarg, which can be accessed using the - getOptarg() method. If an option that requires an argument is - found, but there is no argument present, then an error message is - printed. Normally getopt() returns a '?' in this situation, but - that can be changed as described below. -

- If an invalid option is encountered, an error message is printed - to the standard error and getopt() returns a '?'. The value of the - invalid option encountered is stored in the instance variable optopt - which can be retrieved using the getOptopt() method. To suppress - the printing of error messages for this or any other error, set - the value of the opterr instance variable to false using the - setOpterr() method. -

- Between calls to getopt(), the instance variable optind is used to - keep track of where the object is in the parsing process. After all - options have been returned, optind is the index in argv of the first - non-option argument. This variable can be accessed with the getOptind() - method. -

- Note that this object expects command line options to be passed in the - traditional Unix manner. That is, proceeded by a '-' character. - Multiple options can follow the '-'. For example "-abc" is equivalent - to "-a -b -c". If an option takes a required argument, the value - of the argument can immediately follow the option character or be - present in the next argv element. For example, "-cfoo" and "-c foo" - both represent an option character of 'c' with an argument of "foo" - assuming c takes a required argument. If an option takes an argument - that is not required, then any argument must immediately follow the - option character in the same argv element. For example, if c takes - a non-required argument, then "-cfoo" represents option character 'c' - with an argument of "foo" while "-c foo" represents the option - character 'c' with no argument, and a first non-option argv element - of "foo". -

- The user can stop getopt() from scanning any further into a command line - by using the special argument "--" by itself. For example: - "-a -- -d" would return an option character of 'a', then return -1 - The "--" is discarded and "-d" is pointed to by optind as the first - non-option argv element. -

- Here is a basic example of using Getopt: -

- 

- Getopt g = new Getopt("testprog", argv, "ab:c::d");
- //
- int c;
- String arg;
- while ((c = g.getopt()) != -1)
-   {
-     switch(c)
-       {
-          case 'a':
-          case 'd':
-            System.out.print("You picked " + (char)c + "\n");
-            break;
-            //
-          case 'b':
-          case 'c':
-            arg = g.getOptarg();
-            System.out.print("You picked " + (char)c + 
-                             " with an argument of " +
-                             ((arg != null) ? arg : "null") + "\n");
-            break;
-            //
-          case '?':
-            break; // getopt() already printed an error
-            //
-          default:
-            System.out.print("getopt() returned " + c + "\n");
-       }
-   }
-
-

- In this example, a new Getopt object is created with three params. - The first param is the program name. This is for printing error - messages in the form "program: error message". In the C version, this - value is taken from argv[0], but in Java the program name is not passed - in that element, thus the need for this parameter. The second param is - the argument list that was passed to the main() method. The third - param is the list of valid options. Each character represents a valid - option. If the character is followed by a single colon, then that - option has a required argument. If the character is followed by two - colons, then that option has an argument that is not required. -

- Note in this example that the value returned from getopt() is cast to - a char prior to printing. This is required in order to make the value - display correctly as a character instead of an integer. -

- If the first character in the option string is a colon, for example - ":abc::d", then getopt() will return a ':' instead of a '?' when it - encounters an option with a missing required argument. This allows the - caller to distinguish between invalid options and valid options that - are simply incomplete. -

- In the traditional Unix getopt(), -1 is returned when the first non-option - charcter is encountered. In GNU getopt(), the default behavior is to - allow options to appear anywhere on the command line. The getopt() - method permutes the argument to make it appear to the caller that all - options were at the beginning of the command line, and all non-options - were at the end. For example, calling getopt() with command line args - of "-a foo bar -d" returns options 'a' and 'd', then sets optind to - point to "foo". The program would read the last two argv elements as - "foo" and "bar", just as if the user had typed "-a -d foo bar". -

- The user can force getopt() to stop scanning the command line with - the special argument "--" by itself. Any elements occuring before the - "--" are scanned and permuted as normal. Any elements after the "--" - are returned as is as non-option argv elements. For example, - "foo -a -- bar -d" would return option 'a' then -1. optind would point - to "foo", "bar" and "-d" as the non-option argv elements. The "--" - is discarded by getopt(). -

- There are two ways this default behavior can be modified. The first is - to specify traditional Unix getopt() behavior (which is also POSIX - behavior) in which scanning stops when the first non-option argument - encountered. (Thus "-a foo bar -d" would return 'a' as an option and - have "foo", "bar", and "-d" as non-option elements). The second is to - allow options anywhere, but to return all elements in the order they - occur on the command line. When a non-option element is ecountered, - an integer 1 is returned and the value of the non-option element is - stored in optarg is if it were the argument to that option. For - example, "-a foo -d", returns first 'a', then 1 (with optarg set to - "foo") then 'd' then -1. When this "return in order" functionality - is enabled, the only way to stop getopt() from scanning all command - line elements is to use the special "--" string by itself as described - above. An example is "-a foo -b -- bar", which would return 'a', then - integer 1 with optarg set to "foo", then 'b', then -1. optind would - then point to "bar" as the first non-option argv element. The "--" - is discarded. -

- The POSIX/traditional behavior is enabled by either setting the - property "gnu.posixly_correct" or by putting a '+' sign as the first - character of the option string. The difference between the two - methods is that setting the gnu.posixly_correct property also forces - certain error messages to be displayed in POSIX format. To enable - the "return in order" functionality, put a '-' as the first character - of the option string. Note that after determining the proper - behavior, Getopt strips this leading '+' or '-', meaning that a ':' - placed as the second character after one of those two will still cause - getopt() to return a ':' instead of a '?' if a required option - argument is missing. -

- In addition to traditional single character options, GNU Getopt also - supports long options. These are preceeded by a "--" sequence and - can be as long as desired. Long options provide a more user-friendly - way of entering command line options. For example, in addition to a - "-h" for help, a program could support also "--help". -

- Like short options, long options can also take a required or non-required - argument. Required arguments can either be specified by placing an - equals sign after the option name, then the argument, or by putting the - argument in the next argv element. For example: "--outputdir=foo" and - "--outputdir foo" both represent an option of "outputdir" with an - argument of "foo", assuming that outputdir takes a required argument. - If a long option takes a non-required argument, then the equals sign - form must be used to specify the argument. In this case, - "--outputdir=foo" would represent option outputdir with an argument of - "foo" while "--outputdir foo" would represent the option outputdir - with no argument and a first non-option argv element of "foo". -

- Long options can also be specified using a special POSIX argument - format (one that I highly discourage). This form of entry is - enabled by placing a "W;" (yes, 'W' then a semi-colon) in the valid - option string. This causes getopt to treat the name following the - "-W" as the name of the long option. For example, "-W outputdir=foo" - would be equivalent to "--outputdir=foo". The name can immediately - follow the "-W" like so: "-Woutputdir=foo". Option arguments are - handled identically to normal long options. If a string follows the - "-W" that does not represent a valid long option, then getopt() returns - 'W' and the caller must decide what to do. Otherwise getopt() returns - a long option value as described below. -

- While long options offer convenience, they can also be tedious to type - in full. So it is permissible to abbreviate the option name to as - few characters as required to uniquely identify it. If the name can - represent multiple long options, then an error message is printed and - getopt() returns a '?'. -

- If an invalid option is specified or a required option argument is - missing, getopt() prints an error and returns a '?' or ':' exactly - as for short options. Note that when an invalid long option is - encountered, the optopt variable is set to integer 0 and so cannot - be used to identify the incorrect option the user entered. -

- Long options are defined by LongOpt objects. These objects are created - with a contructor that takes four params: a String representing the - object name, a integer specifying what arguments the option takes - (the value is one of LongOpt.NO_ARGUMENT, LongOpt.REQUIRED_ARGUMENT, - or LongOpt.OPTIONAL_ARGUMENT), a StringBuffer flag object (described - below), and an integer value (described below). -

- To enable long option parsing, create an array of LongOpt's representing - the legal options and pass it to the Getopt() constructor. WARNING: If - all elements of the array are not populated with LongOpt objects, the - getopt() method will throw a NullPointerException. -

- When getopt() is called and a long option is encountered, one of two - things can be returned. If the flag field in the LongOpt object - representing the long option is non-null, then the integer value field - is stored there and an integer 0 is returned to the caller. The val - field can then be retrieved from the flag field. Note that since the - flag field is a StringBuffer, the appropriate String to integer converions - must be performed in order to get the actual int value stored there. - If the flag field in the LongOpt object is null, then the value field - of the LongOpt is returned. This can be the character of a short option. - This allows an app to have both a long and short option sequence - (say, "-h" and "--help") that do the exact same thing. -

- With long options, there is an alternative method of determining - which option was selected. The method getLongind() will return the - the index in the long option array (NOT argv) of the long option found. - So if multiple long options are configured to return the same value, - the application can use getLongind() to distinguish between them. -

- Here is an expanded Getopt example using long options and various - techniques described above: -

- 

- int c;
- String arg;
- LongOpt[] longopts = new LongOpt[3];
- // 
- StringBuffer sb = new StringBuffer();
- longopts[0] = new LongOpt("help", LongOpt.NO_ARGUMENT, null, 'h');
- longopts[1] = new LongOpt("outputdir", LongOpt.REQUIRED_ARGUMENT, sb, 'o'); 
- longopts[2] = new LongOpt("maximum", LongOpt.OPTIONAL_ARGUMENT, null, 2);
- // 
- Getopt g = new Getopt("testprog", argv, "-:bc::d:hW;", longopts);
- g.setOpterr(false); // We'll do our own error handling
- //
- while ((c = g.getopt()) != -1)
-   switch (c)
-     {
-        case 0:
-          arg = g.getOptarg();
-          System.out.println("Got long option with value '" +
-                             (char)(new Integer(sb.toString())).intValue()
-                             + "' with argument " +
-                             ((arg != null) ? arg : "null"));
-          break;
-          //
-        case 1:
-          System.out.println("I see you have return in order set and that " +
-                             "a non-option argv element was just found " +
-                             "with the value '" + g.getOptarg() + "'");
-          break;
-          //
-        case 2:
-          arg = g.getOptarg();
-          System.out.println("I know this, but pretend I didn't");
-          System.out.println("We picked option " +
-                             longopts[g.getLongind()].getName() +
-                           " with value " + 
-                           ((arg != null) ? arg : "null"));
-          break;
-          //
-        case 'b':
-          System.out.println("You picked plain old option " + (char)c);
-          break;
-          //
-        case 'c':
-        case 'd':
-          arg = g.getOptarg();
-          System.out.println("You picked option '" + (char)c + 
-                             "' with argument " +
-                             ((arg != null) ? arg : "null"));
-          break;
-          //
-        case 'h':
-          System.out.println("I see you asked for help");
-          break;
-          //
-        case 'W':
-          System.out.println("Hmmm. You tried a -W with an incorrect long " +
-                             "option name");
-          break;
-          //
-        case ':':
-          System.out.println("Doh! You need an argument for option " +
-                             (char)g.getOptopt());
-          break;
-          //
-        case '?':
-          System.out.println("The option '" + (char)g.getOptopt() + 
-                           "' is not valid");
-          break;
-          //
-        default:
-          System.out.println("getopt() returned " + c);
-          break;
-     }
- //
- for (int i = g.getOptind(); i < argv.length ; i++)
-   System.out.println("Non option argv element: " + argv[i] + "\n");
-
-

- There is an alternative form of the constructor used for long options - above. This takes a trailing boolean flag. If set to false, Getopt - performs identically to the example, but if the boolean flag is true - then long options are allowed to start with a single '-' instead of - "--". If the first character of the option is a valid short option - character, then the option is treated as if it were the short option. - Otherwise it behaves as if the option is a long option. Note that - the name given to this option - long_only - is very counter-intuitive. - It does not cause only long options to be parsed but instead enables - the behavior described above. -

- Note that the functionality and variable names used are driven from - the C lib version as this object is a port of the C code, not a - new implementation. This should aid in porting existing C/C++ code, - as well as helping programmers familiar with the glibc version to - adapt to the Java version even if it seems very non-Java at times. -

- In this release I made all instance variables protected due to - overwhelming public demand. Any code which relied on optarg, - opterr, optind, or optopt being public will need to be modified to - use the appropriate access methods. -

- Please send all bug reports, requests, and comments to - arenn@urbanophile.com. -

-

-
Version: -
1.0.3 -
Author: -
Roland McGrath (roland@gnu.ai.mit.edu), Ulrich Drepper (drepper@cygnus.com), Aaron M. Renn (arenn@urbanophile.com) -
See Also: -
LongOpt -
-
- -

- Constructor Index -

-
-
o - Getopt(String, String[], String) -
Construct a basic Getopt instance with the given input data. -
o - Getopt(String, String[], String, LongOpt[]) -
Construct a Getopt instance with given input data that is capable of - parsing long options as well as short. -
o - Getopt(String, String[], String, LongOpt[], boolean) -
Construct a Getopt instance with given input data that is capable of - parsing long options and short options. -
-

- Method Index -

-
-
o - getLongind() -
Returns the index into the array of long options (NOT argv) representing - the long option that was found. -
o - getopt() -
This method returns a char that is the current option that has been - parsed from the command line. -
o - getOptarg() -
- For communication from `getopt' to the caller. -
o - getOptind() -
optind it the index in ARGV of the next element to be scanned. -
o - getOptopt() -
When getopt() encounters an invalid option, it stores the value of that - option in optopt which can be retrieved with this method. -
o - setArgv(String[]) -
Since in GNU getopt() the argument vector is passed back in to the - function every time, the caller can swap out argv on the fly. -
o - setOpterr(boolean) -
Normally Getopt will print a message to the standard error when an - invalid option is encountered. -
o - setOptind(int) -
This method allows the optind index to be set manually. -
o - setOptstring(String) -
In GNU getopt, it is possible to change the string containg valid options - on the fly because it is passed as an argument to getopt() each time. -
- -

- Constructors -

- - o -Getopt -
- public Getopt(String progname,
-               String argv[],
-               String optstring)
-
-
-
Construct a basic Getopt instance with the given input data. Note that - this handles "short" options only. -

-

-
Parameters: -
progname - The name to display as the program name when printing errors -
argv - The String array passed as the command line to the program. -
optstring - A String containing a description of the valid args for this program -
-
- o -Getopt -
- public Getopt(String progname,
-               String argv[],
-               String optstring,
-               LongOpt long_options[])
-
-
-
Construct a Getopt instance with given input data that is capable of - parsing long options as well as short. -

-

-
Parameters: -
progname - The name to display as the program name when printing errors -
argv - The String array passed as the command ilne to the program -
optstring - A String containing a description of the valid short args for this program -
long_options - An array of LongOpt objects that describes the valid long args for this program -
-
- o -Getopt -
- public Getopt(String progname,
-               String argv[],
-               String optstring,
-               LongOpt long_options[],
-               boolean long_only)
-
-
-
Construct a Getopt instance with given input data that is capable of - parsing long options and short options. Contrary to what you might - think, the flag 'long_only' does not determine whether or not we - scan for only long arguments. Instead, a value of true here allows - long arguments to start with a '-' instead of '--' unless there is a - conflict with a short option name. -

-

-
Parameters: -
progname - The name to display as the program name when printing errors -
argv - The String array passed as the command ilne to the program -
optstring - A String containing a description of the valid short args for this program -
long_options - An array of LongOpt objects that describes the valid long args for this program -
long_only - true if long options that do not conflict with short options can start with a '-' as well as '--' -
-
- -

- Methods -

- o -setOptstring -
- public void setOptstring(String optstring)
-
-
-
In GNU getopt, it is possible to change the string containg valid options - on the fly because it is passed as an argument to getopt() each time. In - this version we do not pass the string on every call. In order to allow - dynamic option string changing, this method is provided. -

-

-
Parameters: -
optstring - The new option string to use -
-
- o -getOptind -
- public int getOptind()
-
-
-
optind it the index in ARGV of the next element to be scanned. - This is used for communication to and from the caller - and for communication between successive calls to `getopt'. - When `getopt' returns -1, this is the index of the first of the - non-option elements that the caller should itself scan. - Otherwise, `optind' communicates from one call to the next - how much of ARGV has been scanned so far. -

-

- o -setOptind -
- public void setOptind(int optind)
-
-
-
This method allows the optind index to be set manually. Normally this - is not necessary (and incorrect usage of this method can lead to serious - lossage), but optind is a public symbol in GNU getopt, so this method - was added to allow it to be modified by the caller if desired. -

-

-
Parameters: -
optind - The new value of optind -
-
- o -setArgv -
- public void setArgv(String argv[])
-
-
-
Since in GNU getopt() the argument vector is passed back in to the - function every time, the caller can swap out argv on the fly. Since - passing argv is not required in the Java version, this method allows - the user to override argv. Note that incorrect use of this method can - lead to serious lossage. -

-

-
Parameters: -
argv - New argument list -
-
- o -getOptarg -
- public String getOptarg()
-
-
-
For communication from `getopt' to the caller. - When `getopt' finds an option that takes an argument, - the argument value is returned here. - Also, when `ordering' is RETURN_IN_ORDER, - each non-option ARGV-element is returned here. - No set method is provided because setting this variable has no effect. -

-

- o -setOpterr -
- public void setOpterr(boolean opterr)
-
-
-
Normally Getopt will print a message to the standard error when an - invalid option is encountered. This can be suppressed (or re-enabled) - by calling this method. There is no get method for this variable - because if you can't remember the state you set this to, why should I? -

-

- o -getOptopt -
- public int getOptopt()
-
-
-
When getopt() encounters an invalid option, it stores the value of that - option in optopt which can be retrieved with this method. There is - no corresponding set method because setting this variable has no effect. -

-

- o -getLongind -
- public int getLongind()
-
-
-
Returns the index into the array of long options (NOT argv) representing - the long option that was found. -

-

- o -getopt -
- public int getopt()
-
-
-
This method returns a char that is the current option that has been - parsed from the command line. If the option takes an argument, then - the internal variable 'optarg' is set which is a String representing - the the value of the argument. This value can be retrieved by the - caller using the getOptarg() method. If an invalid option is found, - an error message is printed and a '?' is returned. The name of the - invalid option character can be retrieved by calling the getOptopt() - method. When there are no more options to be scanned, this method - returns -1. The index of first non-option element in argv can be - retrieved with the getOptind() method. -

-

-
Returns: -
Various things as described above -
-
-
-
-All Packages  Class Hierarchy  This Package  Previous  Next  Index
- - diff --git a/gnu/getopt/gnu.getopt.LongOpt.html b/gnu/getopt/gnu.getopt.LongOpt.html deleted file mode 100644 index ddc1186..0000000 --- a/gnu/getopt/gnu.getopt.LongOpt.html +++ /dev/null @@ -1,210 +0,0 @@ - - - - - - - Class gnu.getopt.LongOpt - - - - -
-All Packages  Class Hierarchy  This Package  Previous  Next  Index
-
-

- Class gnu.getopt.LongOpt -

-
-java.lang.Object
-   |
-   +----gnu.getopt.LongOpt
-
-
-
-
public class LongOpt -
extends Object -
-This object represents the definition of a long option in the Java port - of GNU getopt. An array of LongOpt objects is passed to the Getopt - object to define the list of valid long options for a given parsing - session. Refer to the getopt documentation for details on the - format of long options. -

-

-
Version: -
1.0.3 -
Author: -
Aaron M. Renn (arenn@urbanophile.com) -
See Also: -
Getopt -
-
- -

- Variable Index -

-
-
o - NO_ARGUMENT -
Constant value used for the "has_arg" constructor argument. -
o - OPTIONAL_ARGUMENT -
Constant value used for the "has_arg" constructor argument. -
o - REQUIRED_ARGUMENT -
- Constant value used for the "has_arg" constructor argument. -
-

- Constructor Index -

-
-
o - LongOpt(String, int, StringBuffer, int) -
Create a new LongOpt object with the given parameter values. -
-

- Method Index -

-
-
o - getFlag() -
Returns the value of the 'flag' field for this long option - - -
o - getHasArg() -
Returns the value set for the 'has_arg' field for this long option - - -
o - getName() -
Returns the name of this LongOpt as a String - - -
o - getVal() -
Returns the value of the 'val' field for this long option - - -
- -

- Variables -

- o -NO_ARGUMENT -
- public static final int NO_ARGUMENT
-
-
-
Constant value used for the "has_arg" constructor argument. This - value indicates that the option takes no argument.

-

- o -REQUIRED_ARGUMENT -
- public static final int REQUIRED_ARGUMENT
-
-
-
Constant value used for the "has_arg" constructor argument. This - value indicates that the option takes an argument that is required.

-

- o -OPTIONAL_ARGUMENT -
- public static final int OPTIONAL_ARGUMENT
-
-
-
Constant value used for the "has_arg" constructor argument. This - value indicates that the option takes an argument that is optional.

-

- -

- Constructors -

- - o -LongOpt -
- public LongOpt(String name,
-                int has_arg,
-                StringBuffer flag,
-                int val) throws IllegalArgumentException
-
-
-
Create a new LongOpt object with the given parameter values. If the - value passed as has_arg is not valid, then an exception is thrown. -

-

-
Parameters: -
name - The long option String. -
has_arg - Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT). -
flag - If non-null, this is a location to store the value of "val" when this option is encountered, otherwise "val" is treated as the equivalent short option character. -
val - The value to return for this long option, or the equivalent single letter option to emulate if flag is null. -
Throws: IllegalArgumentException -
If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT. -
-
- -

- Methods -

- o -getName -
- public String getName()
-
-
-
Returns the name of this LongOpt as a String -

-

-
Returns: -
Then name of the long option -
-
- o -getHasArg -
- public int getHasArg()
-
-
-
Returns the value set for the 'has_arg' field for this long option -

-

-
Returns: -
The value of 'has_arg' -
-
- o -getFlag -
- public StringBuffer getFlag()
-
-
-
Returns the value of the 'flag' field for this long option -

-

-
Returns: -
The value of 'flag' -
-
- o -getVal -
- public int getVal()
-
-
-
Returns the value of the 'val' field for this long option -

-

-
Returns: -
The value of 'val' -
-
-
-
-All Packages  Class Hierarchy  This Package  Previous  Next  Index
- - From 8bde08e518ad2298650b4e77e16c407c198f3036 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Sch=C3=A4fer?= Date: Sat, 23 May 2015 16:12:59 +0200 Subject: [PATCH 8/8] Update the license to LGPLv3 The LGPLv3 is a successor of the Library General Public License used previously. See also arenn/java-getopt#8 for discussion about it. --- LICENSE | 637 ++++++++++++++------------------------------------------ 1 file changed, 160 insertions(+), 477 deletions(-) diff --git a/LICENSE b/LICENSE index 161a3d1..65c5ca8 100644 --- a/LICENSE +++ b/LICENSE @@ -1,482 +1,165 @@ - GNU LIBRARY GENERAL PUBLIC LICENSE - Version 2, June 1991 + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 - Copyright (C) 1991 Free Software Foundation, Inc. - 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA + 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. -[This is the first released version of the library GPL. It is - numbered 2 because it goes with version 2 of the ordinary GPL.] - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Library General Public License, applies to some -specially designated Free Software Foundation software, and to any -other libraries whose authors decide to use it. You can use it for -your libraries, 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 -this service 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 make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if -you distribute copies of the library, or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link a program with the library, you must provide -complete object files to the recipients so that they can relink them -with the library, after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - Our method of protecting your rights has two steps: (1) copyright -the library, and (2) offer you this license which gives you legal -permission to copy, distribute and/or modify the library. - - Also, for each distributor's protection, we want to make certain -that everyone understands that there is no warranty for this free -library. If the library is modified by someone else and passed on, we -want its recipients to know that what they have is not the original -version, so that any problems introduced by others will not reflect on -the original authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that companies distributing free -software will individually obtain patent licenses, thus in effect -transforming the program into proprietary software. To prevent this, -we have made it clear that any patent must be licensed for everyone's -free use or not licensed at all. - - Most GNU software, including some libraries, is covered by the ordinary -GNU General Public License, which was designed for utility programs. This -license, the GNU Library General Public License, applies to certain -designated libraries. This license is quite different from the ordinary -one; be sure to read it in full, and don't assume that anything in it is -the same as in the ordinary license. - - The reason we have a separate public license for some libraries is that -they blur the distinction we usually make between modifying or adding to a -program and simply using it. Linking a program with a library, without -changing the library, is in some sense simply using the library, and is -analogous to running a utility program or application program. However, in -a textual and legal sense, the linked executable is a combined work, a -derivative of the original library, and the ordinary General Public License -treats it as such. - - Because of this blurred distinction, using the ordinary General -Public License for libraries did not effectively promote software -sharing, because most developers did not use the libraries. We -concluded that weaker conditions might promote sharing better. - - However, unrestricted linking of non-free programs would deprive the -users of those programs of all benefit from the free status of the -libraries themselves. This Library General Public License is intended to -permit developers of non-free programs to use free libraries, while -preserving your freedom as a user of such programs to change the free -libraries that are incorporated in them. (We have not seen how to achieve -this as regards changes in header files, but we have achieved it as regards -changes in the actual functions of the Library.) The hope is that this -will lead to faster development of free libraries. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, while the latter only -works together with the library. - - Note that it is possible for a library to be covered by the ordinary -General Public License rather than by this special one. - - GNU LIBRARY GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library which -contains a notice placed by the copyright holder or other authorized -party saying it may be distributed under the terms of this Library -General Public License (also called "this License"). Each licensee is -addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also compile or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - c) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - d) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the source code distributed need not include anything that is normally -distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Library 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 Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "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 -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY 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 -LIBRARY (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 LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS - - Appendix: How to Apply These Terms to Your New Libraries - - If you develop a new library, and you want it to be of the greatest -possible use to the public, we recommend making it free software that -everyone can redistribute and change. You can do so by permitting -redistribution under these terms (or, alternatively, under the terms of the -ordinary General Public License). - - To apply these terms, attach the following notices to the library. It is -safest to attach them to the start of each source file to most effectively -convey 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 library is free software; you can redistribute it and/or - modify it under the terms of the GNU Library General Public - License as published by the Free Software Foundation; either - version 2 of the License, or (at your option) any later version. - - This library 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 - Library General Public License for more details. - - You should have received a copy of the GNU Library General Public - License along with this library; if not, write to the Free - Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, - MA 02111-1307, USA - -Also add information on how to contact you by electronic and paper mail. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the library, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the - library `Frob' (a library for tweaking knobs) written by James Random Hacker. - - , 1 April 1990 - Ty Coon, President of Vice - -That's all there is to it! + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library.