From 624735dbf1020c98d0b1f1493242c573be861025 Mon Sep 17 00:00:00 2001 From: obourdon Date: Tue, 6 Jan 2015 18:43:53 +0100 Subject: [PATCH 1/3] Error printout replaced by IllegalArgumentException --- .gitignore | 3 + gnu/getopt/Getopt.class | Bin 7366 -> 0 bytes gnu/getopt/Getopt.java | 2301 +++++++++++++++++------------------ gnu/getopt/GetoptDemo.class | Bin 2868 -> 0 bytes gnu/getopt/GetoptDemo.java | 168 ++- gnu/getopt/LongOpt.class | Bin 1658 -> 0 bytes gnu/getopt/LongOpt.java | 286 ++--- 7 files changed, 1294 insertions(+), 1464 deletions(-) create mode 100644 .gitignore delete mode 100644 gnu/getopt/Getopt.class delete mode 100644 gnu/getopt/GetoptDemo.class delete mode 100644 gnu/getopt/LongOpt.class diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..10ef9fc --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +*.class +*.java~ +*.java# 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 - * 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 + * 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 = ResourceBundle.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); + } -/** - * 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; + /**************************************************************************/ + /** + * 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.isEmpty()) { + optstring = " "; + } -/* - * 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; + // 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 = ResourceBundle.getBundle("gnu/getopt/MessagesBundle", + Locale.US); + } -/** - * 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; + // 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 + } + } -/** - * This is the string describing the valid short options. - */ -protected String optstring; + /**************************************************************************/ + /* + * 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.isEmpty()) { + optstring = " "; + } -/** - * This is an array of LongOpt objects which describ the valid long - * options. - */ -protected LongOpt[] long_options; + this.optstring = optstring; + } -/** - * This flag determines whether or not we are parsing only long args - */ -protected boolean long_only; + /**************************************************************************/ + /** + * 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); + } -/** - * Stores the index into the long_options array of the long option found - */ -protected int longind; + /**************************************************************************/ + /** + * 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; + } -/** - * The flag determines whether or not we operate in strict POSIX compliance - */ -protected boolean posixly_correct; + /**************************************************************************/ + /** + * 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; + } -/** - * A flag which communicates whether or not checkLongOption() did all - * necessary processing for the current option - */ -protected boolean longopt_handled; + /**************************************************************************/ + /** + * 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); + } -/** - * The index of the first non-option in argv[] - */ -protected int first_nonopt = 1; + /**************************************************************************/ + /** + * 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; + } -/** - * The index of the last non-option in argv[] - */ -protected int last_nonopt = 1; + /**************************************************************************/ + /** + * 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); + } -/** - * Flag to tell getopt to immediately return -1 the next time it is - * called. - */ -private boolean endparse = false; + /**************************************************************************/ + /** + * Returns the index into the array of long options (NOT argv) representing + * the long option that was found. + */ + public int getLongind() { + return (longind); + } -/** - * Saved argument list passed to the program - */ -protected String[] argv; + /**************************************************************************/ + /** + * 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; + } + } -/** - * Determines whether we permute arguments or not - */ -protected int ordering; + // Update records for the slots the non-options now occupy. -/** - * 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; + first_nonopt += (optind - last_nonopt); + last_nonopt = optind; + } -/** - * The localized strings are kept in a separate file - */ -private ResourceBundle _messages = ResourceBundle.getBundle( - "gnu/getopt/MessagesBundle", Locale.getDefault()); + /**************************************************************************/ + /** + * 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]}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.ambigious"), + msgArgs)); + } -/* - * Constructors - */ + nextchar = ""; + optopt = 0; + ++optind; -/** - * 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); -} + return ('?'); + } -/**************************************************************************/ + if (pfound != null) { + ++optind; -/** - * 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); -} + 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}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.arguments1"), + msgArgs)); + } // +option or -option + else { + Object[] msgArgs = {progname, new Character(argv[optind - 1].charAt(0)).toString(), + pfound.name}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.arguments2"), + msgArgs)); + } + } -/**************************************************************************/ + nextchar = ""; + optopt = pfound.val; -/** - * 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 = ResourceBundle.getBundle("gnu/getopt/MessagesBundle", - Locale.US); - } + 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]}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.requires"), + msgArgs)); + } - // 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 - } -} + nextchar = ""; + optopt = pfound.val; + if (optstring.charAt(0) == ':') { + return (':'); + } else { + return ('?'); + } + } + } // else if (pfound) -/**************************************************************************/ - -/* - * Instance Methods - */ + nextchar = ""; -/** - * 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; -} + if (pfound.flag != null) { + pfound.flag.setLength(0); + pfound.flag.append(pfound.val); -/**************************************************************************/ + return (0); + } -/** - * 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); -} + return (pfound.val); + } // if (pfound != null) -/**************************************************************************/ + longopt_handled = false; -/** - * 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; -} + 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); + } -/** - * 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; -} + if ((nextchar == null) || (nextchar != null && nextchar.isEmpty())) { + // 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; + } -/** - * 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); -} + // Skip any additional non-options + // and extend the range of non-options previously skipped. + while ((optind < argv.length) && (argv[optind] != null && argv[optind].isEmpty() || + (argv[optind].charAt(0) != '-') || "-".equals(argv[optind]))) { + optind++; + } -/**************************************************************************/ + last_nonopt = optind; + } -/** - * 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; -} + // 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) && "--".equals(argv[optind])) { + optind++; + + if ((first_nonopt != last_nonopt) && (last_nonopt != optind)) { + exchange(argv); + } else if (first_nonopt == last_nonopt) { + first_nonopt = optind; + } -/**************************************************************************/ + last_nonopt = argv.length; -/** - * 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); -} + 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; + } -/** - * Returns the index into the array of long options (NOT argv) representing - * the long option that was found. - */ -public int -getLongind() -{ - return(longind); -} + 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] != null && argv[optind].isEmpty() || (argv[optind].charAt(0) != '-') || + "-".equals(argv[optind])) { + if (ordering == REQUIRE_ORDER) { + return (-1); + } -/** - * 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; + optarg = argv[optind++]; + return (1); } - // 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; + + // 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); } - // Exclude the moved top segment from further swapping. - bottom += len; } - } - // Update records for the slots the non-options now occupy. + // Decode the current option-ARGV-element. - first_nonopt += (optind - last_nonopt); - last_nonopt = optind; -} + /* 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. -/** - * 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)); - } + 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". - 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 = ""; + 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); } - 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)); + + // 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}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.unrecognized"), + msgArgs)); + } else { + Object[] msgArgs = {progname, new Character(argv[optind].charAt(0)).toString(), + nextchar}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.unrecognized2"), + 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); -} -/**************************************************************************/ + nextchar = ""; + ++optind; + optopt = 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++; + return ('?'); } - - last_nonopt = optind; + } // 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 = ""; } - // 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); + String temp = null; + if (optstring.indexOf(c) != -1) { + temp = optstring.substring(optstring.indexOf(c)); } - // 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); + if (nextchar != null && nextchar.isEmpty()) { + ++optind; } - - // 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( + 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()}; + throw new IllegalArgumentException(MessageFormat.format( _messages.getString("getopt.illegal"), msgArgs)); - } - else - { - Object[] msgArgs = { progname, new - Character((char)c).toString() }; - System.err.println(MessageFormat.format( + } else { + Object[] msgArgs = {progname, new Character((char) c).toString()}; + throw new IllegalArgumentException(MessageFormat.format( _messages.getString("getopt.invalid"), msgArgs)); + } } - } - optopt = c; + 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; + return ('?'); } - // 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]; - } + // Convenience. Treat POSIX -W foo same as long option --foo + if ((temp.charAt(0) == 'W') && (temp.length() > 1) && (temp.charAt(1) == ';')) { + if (nextchar != null && !nextchar.isEmpty()) { + 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()}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.requires2"), msgArgs)); + } - c = checkLongOption(); + 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]; + } - if (longopt_handled) - return(c); - else - // Let the application handle it - { - nextchar = null; - ++optind; - return('W'); - } - } + c = checkLongOption(); - 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 + if (longopt_handled) { + return (c); + } else // Let the application handle it { - optarg = null; + nextchar = null; + ++optind; + return ('W'); } - - nextchar = null; } - else - { - if (!nextchar.equals("")) - { - optarg = nextchar; - ++optind; - } - else if (optind == argv.length) + + if ((temp.length() > 1) && (temp.charAt(1) == ':')) { + if ((temp.length() > 2) && (temp.charAt(2) == ':')) // This is an option that accepts and argument optionally { - 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)); + if (nextchar != null && !nextchar.isEmpty()) { + optarg = nextchar; + ++optind; + } else { + optarg = null; } - 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)); - } + nextchar = null; + } else { + if (nextchar != null && !nextchar.isEmpty()) { + 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()}; + throw new IllegalArgumentException(MessageFormat.format( + _messages.getString("getopt.requires2"), msgArgs)); + } - optopt = c; - - if (optstring.charAt(0) == ':') - return(':'); - else - return('?'); + 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) && "--".equals(optarg)) { + // 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()}; + throw new IllegalArgumentException(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; + // 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; + nextchar = null; + } } - } - - return(c); -} + return (c); + } } // Class Getopt diff --git a/gnu/getopt/GetoptDemo.class b/gnu/getopt/GetoptDemo.class deleted file mode 100644 index 518218737ebab153a4d2c72c103e2e074bbef12d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 2868 zcmb_e+jA3T6#sp>?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/LongOpt.java b/gnu/getopt/LongOpt.java index 6357085..65f7c08 100644 --- a/gnu/getopt/LongOpt.java +++ b/gnu/getopt/LongOpt.java @@ -18,7 +18,6 @@ /* the Free Software Foundation Inc., 59 Temple Place - Suite 330, /* Boston, MA 02111-1307 USA /**************************************************************************/ - package gnu.getopt; import java.util.Locale; @@ -26,170 +25,141 @@ import java.text.MessageFormat; /**************************************************************************/ - -/** - * 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.5 - * @author Aaron M. Renn (arenn@urbanophile.com) - * - * @see Getopt - */ -public class LongOpt extends Object -{ - -/**************************************************************************/ - -/* - * Class Variables - */ - -/** - * Constant value used for the "has_arg" constructor argument. This - * value indicates that the option takes no argument. - */ -public static final int NO_ARGUMENT = 0; - -/** - * Constant value used for the "has_arg" constructor argument. This - * value indicates that the option takes an argument that is required. - */ -public static final int REQUIRED_ARGUMENT = 1; - -/** - * Constant value used for the "has_arg" constructor argument. This - * value indicates that the option takes an argument that is optional. - */ -public static final int OPTIONAL_ARGUMENT = 2; - -/**************************************************************************/ - -/* - * Instance Variables - */ - -/** - * The name of the long option - */ -protected String name; - -/** - * Indicates whether the option has no argument, a required argument, or - * an optional argument. - */ -protected int has_arg; - -/** - * If this variable is not null, then the value stored in "val" is stored - * here when this long option is encountered. If this is null, the value - * stored in "val" is treated as the name of an equivalent short option. - */ -protected StringBuffer flag; - -/** - * The value to store in "flag" if flag is not null, otherwise the - * equivalent short option character for this long option. - */ -protected int val; - /** - * Localized strings for error messages - */ -private ResourceBundle _messages = ResourceBundle.getBundle( - "gnu/getopt/MessagesBundle", Locale.getDefault()); - -/**************************************************************************/ - -/* - * Constructors + * 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.5 + * @author Aaron M. Renn (arenn@urbanophile.com) + * + * @see Getopt */ - -/** - * 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. - * - * @param name The long option String. - * @param has_arg Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT). - * @param 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. - * @param val The value to return for this long option, or the equivalent single letter option to emulate if flag is null. - * - * @exception IllegalArgumentException If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT. - */ -public -LongOpt(String name, int has_arg, - StringBuffer flag, int val) throws IllegalArgumentException -{ - // Validate has_arg - if ((has_arg != NO_ARGUMENT) && (has_arg != REQUIRED_ARGUMENT) - && (has_arg != OPTIONAL_ARGUMENT)) - { - Object[] msgArgs = { new Integer(has_arg).toString() }; - throw new IllegalArgumentException(MessageFormat.format( +public class LongOpt extends Object { + + /**************************************************************************/ + + /* + * Class Variables + */ + /** + * Constant value used for the "has_arg" constructor argument. This + * value indicates that the option takes no argument. + */ + public static final int NO_ARGUMENT = 0; + /** + * Constant value used for the "has_arg" constructor argument. This + * value indicates that the option takes an argument that is required. + */ + public static final int REQUIRED_ARGUMENT = 1; + /** + * Constant value used for the "has_arg" constructor argument. This + * value indicates that the option takes an argument that is optional. + */ + public static final int OPTIONAL_ARGUMENT = 2; + /**************************************************************************/ + + /* + * Instance Variables + */ + /** + * The name of the long option + */ + protected String name; + /** + * Indicates whether the option has no argument, a required argument, or + * an optional argument. + */ + protected int has_arg; + /** + * If this variable is not null, then the value stored in "val" is stored + * here when this long option is encountered. If this is null, the value + * stored in "val" is treated as the name of an equivalent short option. + */ + protected StringBuffer flag; + /** + * The value to store in "flag" if flag is not null, otherwise the + * equivalent short option character for this long option. + */ + protected int val; + /** + * Localized strings for error messages + */ + private ResourceBundle _messages = ResourceBundle.getBundle( + "gnu/getopt/MessagesBundle", Locale.getDefault()); + + /**************************************************************************/ + + /* + * Constructors + */ + /** + * 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. + * + * @param name The long option String. + * @param has_arg Indicates whether the option has no argument (NO_ARGUMENT), a required argument (REQUIRED_ARGUMENT) or an optional argument (OPTIONAL_ARGUMENT). + * @param 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. + * @param val The value to return for this long option, or the equivalent single letter option to emulate if flag is null. + * + * @exception IllegalArgumentException If the has_arg param is not one of NO_ARGUMENT, REQUIRED_ARGUMENT or OPTIONAL_ARGUMENT. + */ + public LongOpt(String name, int has_arg, + StringBuffer flag, int val) throws IllegalArgumentException { + // Validate has_arg + if ((has_arg != NO_ARGUMENT) && (has_arg != REQUIRED_ARGUMENT) && (has_arg != OPTIONAL_ARGUMENT)) { + Object[] msgArgs = {new Integer(has_arg).toString()}; + throw new IllegalArgumentException(MessageFormat.format( _messages.getString("getopt.invalidValue"), msgArgs)); - } - - // Store off values - this.name = name; - this.has_arg = has_arg; - this.flag = flag; - this.val = val; -} - -/**************************************************************************/ - -/** - * Returns the name of this LongOpt as a String - * - * @return Then name of the long option - */ -public String -getName() -{ - return(name); -} + } -/**************************************************************************/ - -/** - * Returns the value set for the 'has_arg' field for this long option - * - * @return The value of 'has_arg' - */ -public int -getHasArg() -{ - return(has_arg); -} - -/**************************************************************************/ + // Store off values + this.name = name; + this.has_arg = has_arg; + this.flag = flag; + this.val = val; + } -/** - * Returns the value of the 'flag' field for this long option - * - * @return The value of 'flag' - */ -public StringBuffer -getFlag() -{ - return(flag); -} + /**************************************************************************/ + /** + * Returns the name of this LongOpt as a String + * + * @return Then name of the long option + */ + public String getName() { + return (name); + } -/** - * Returns the value of the 'val' field for this long option - * - * @return The value of 'val' - */ -public int -getVal() -{ - return(val); -} + /**************************************************************************/ + /** + * Returns the value set for the 'has_arg' field for this long option + * + * @return The value of 'has_arg' + */ + public int getHasArg() { + return (has_arg); + } -/**************************************************************************/ + /**************************************************************************/ + /** + * Returns the value of the 'flag' field for this long option + * + * @return The value of 'flag' + */ + public StringBuffer getFlag() { + return (flag); + } + /** + * Returns the value of the 'val' field for this long option + * + * @return The value of 'val' + */ + public int getVal() { + return (val); + } + /**************************************************************************/ } // Class LongOpt From 40b0fbf87c94c4c1bce74333bc6b12d7072597f2 Mon Sep 17 00:00:00 2001 From: obourdon Date: Tue, 6 Jan 2015 20:55:14 +0100 Subject: [PATCH 2/3] Maven build integration --- .gitignore | 1 + README.md | 29 +++++++++++++++++++++++++++++ gnu/getopt/ChangeLog | 4 ++++ gnu/getopt/README | 25 +++++++++++++++++++++++++ pom.xml | 41 +++++++++++++++++++++++++++++++++++++++++ 5 files changed, 100 insertions(+) create mode 100644 README.md create mode 100644 pom.xml diff --git a/.gitignore b/.gitignore index 10ef9fc..e095c61 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ *.class *.java~ *.java# +target diff --git a/README.md b/README.md new file mode 100644 index 0000000..1ee980c --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +This is my own fork of the original +https://github.com/arenn/java-getopt +repository. I have therefore added the following lines to the original README file + +If you are using version 1.0.15 which includes the removal of System.err.println error +messages which are now replaced by throw new IllegalArgumentException therefore allowing +to use this library more easily in your code deciding on your own what you do with thrown +exceptions you will also beneficiate from Maven build facility. + +To build the jar type: +mvn clean ; mvn package + +You an then use the jar produced under target/java-getopt-1.0.15.jar + +The other changes I made are both cosmetic (code formating) and also try to comply +with some Java coding best practices like using "constant".compare(object_string) instead +of object_string.compare("constant") and isEmpty() rather than .length() == 0 + +Of course you can ask me to integrate any thing you see fit/missing and depending on +what my sparetime allows me I'll be more than happy to try to comply to your needs. +Feel free also to use +https://github.com/obourdon/java-getopt/issues +to log any issue you would like to be addressed + +Thanks for everything + +Olivier +olivier.bourdon@freesbee.fr +https://github.com/obourdon/java-getopt diff --git a/gnu/getopt/ChangeLog b/gnu/getopt/ChangeLog index 7fed6d2..3f4c0ab 100644 --- a/gnu/getopt/ChangeLog +++ b/gnu/getopt/ChangeLog @@ -1,3 +1,7 @@ +For release 1.0.15 (2015/01/07) + +Olivier Bourdon (olivier.bourdon@freesbee.fr) + For release 1.0.14 (2012/02/08) David Zhang (david290@qq.com) provided Chinese language messages. diff --git a/gnu/getopt/README b/gnu/getopt/README index 48451f7..04ae7d4 100644 --- a/gnu/getopt/README +++ b/gnu/getopt/README @@ -55,3 +55,28 @@ Aaron. arenn@urbanophile.com http://www.urbanophile.com/arenn/ +If you are using version 1.0.15 which includes the removal of System.err.println error +messages which are now replaced by throw new IllegalArgumentException therefore allowing +to use this library more easily in your code deciding on your own what you do with thrown +exceptions you will also beneficiate from Maven build facility. + +To build the jar type: +mvn clean ; mvn package + +You an then use the jar produced under target/java-getopt-1.0.15.jar + +The other changes I made are both cosmetic (code formating) and also try to comply +with some Java coding best practices like using "constant".compare(object_string) instead +of object_string.compare("constant") and isEmpty() rather than .length() == 0 + +Of course you can ask me to integrate any thing you see fit/missing and depending on +what my sparetime allows me I'll be more than happy to try to comply to your needs. +Feel free also to use +https://github.com/obourdon/java-getopt/issues +to log any issue you would like to be addressed + +Thanks for everything + +Olivier +olivier.bourdon@freesbee.fr +https://github.com/obourdon/java-getopt diff --git a/pom.xml b/pom.xml new file mode 100644 index 0000000..41c6a5e --- /dev/null +++ b/pom.xml @@ -0,0 +1,41 @@ + + + 4.0.0 + + gnu.getopt + java-getopt + 1.0.15 + + + . + + + . + + **/*.java + **/*.jar + **/*.tar.gz + target* + pom.xml + .gitignore + + + + + + org.apache.maven.plugins + maven-deploy-plugin + + false + + + + org.apache.maven.plugins + maven-checkstyle-plugin + + + + + From 65fa2d371f561b3e791bdf4218b75dd74766eb85 Mon Sep 17 00:00:00 2001 From: obourdon Date: Tue, 6 Jan 2015 21:02:59 +0100 Subject: [PATCH 3/3] Playing with README.md syntax --- .gitignore | 1 + README.md | 12 ++++++++---- 2 files changed, 9 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index e095c61..6c37e23 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ *.class *.java~ *.java# +.*.swp target diff --git a/README.md b/README.md index 1ee980c..76fd4d5 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ -This is my own fork of the original -https://github.com/arenn/java-getopt -repository. I have therefore added the following lines to the original README file +This is my own fork of the original https://github.com/arenn/java-getopt repository. + +I have therefore added the following lines to the original README file If you are using version 1.0.15 which includes the removal of System.err.println error messages which are now replaced by throw new IllegalArgumentException therefore allowing to use this library more easily in your code deciding on your own what you do with thrown -exceptions you will also beneficiate from Maven build facility. +exceptions. You will also beneficiate from Maven build facility. To build the jar type: mvn clean ; mvn package @@ -19,11 +19,15 @@ of object_string.compare("constant") and isEmpty() rather than .length() == 0 Of course you can ask me to integrate any thing you see fit/missing and depending on what my sparetime allows me I'll be more than happy to try to comply to your needs. Feel free also to use + https://github.com/obourdon/java-getopt/issues + to log any issue you would like to be addressed Thanks for everything Olivier + olivier.bourdon@freesbee.fr + https://github.com/obourdon/java-getopt