Google Git
Sign in
apache / xalan-site / baed2198e564a4221346ce9823f7f57830a0d758 / . / docs / xalan / xalan-j / apidocs / src-html / org / apache / xalan / xsltc / cmdline / getopt / GetOpt.Option.html
blob: 0252a2e22372aea75d981b461855b64a6835e64f [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: GetOpt.java 1225436 2011-12-29 05:09:31Z mrglavas $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> <a name="line.21"></a>
<FONT color="green">022</FONT> package org.apache.xalan.xsltc.cmdline.getopt; <a name="line.22"></a>
<FONT color="green">023</FONT> <a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.ArrayList;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.List;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.ListIterator;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> import org.apache.xalan.xsltc.compiler.util.ErrorMsg;<a name="line.28"></a>
<FONT color="green">029</FONT> <a name="line.29"></a>
<FONT color="green">030</FONT> <a name="line.30"></a>
<FONT color="green">031</FONT> /**<a name="line.31"></a>
<FONT color="green">032</FONT> * GetOpt is a Java equivalent to the C getopt() library function<a name="line.32"></a>
<FONT color="green">033</FONT> * discussed in man page getopt(3C). It provides command line<a name="line.33"></a>
<FONT color="green">034</FONT> * parsing for Java applications. It supports the most rules of the<a name="line.34"></a>
<FONT color="green">035</FONT> * command line standard (see man page intro(1)) including stacked<a name="line.35"></a>
<FONT color="green">036</FONT> * options such as '-sxm' (which is equivalent to -s -x -m); it<a name="line.36"></a>
<FONT color="green">037</FONT> * handles special '--' option that signifies the end of options.<a name="line.37"></a>
<FONT color="green">038</FONT> * Additionally this implementation of getopt will check for<a name="line.38"></a>
<FONT color="green">039</FONT> * mandatory arguments to options such as in the case of<a name="line.39"></a>
<FONT color="green">040</FONT> * '-d &lt;file&gt;' it will throw a MissingOptArgException if the <a name="line.40"></a>
<FONT color="green">041</FONT> * option argument '&lt;file&gt;' is not included on the commandline.<a name="line.41"></a>
<FONT color="green">042</FONT> * getopt(3C) does not check for this. <a name="line.42"></a>
<FONT color="green">043</FONT> * @author G Todd Miller <a name="line.43"></a>
<FONT color="green">044</FONT> */<a name="line.44"></a>
<FONT color="green">045</FONT> public class GetOpt{<a name="line.45"></a>
<FONT color="green">046</FONT> public GetOpt(String[] args, String optString){<a name="line.46"></a>
<FONT color="green">047</FONT> theOptions = new ArrayList(); <a name="line.47"></a>
<FONT color="green">048</FONT> int currOptIndex = 0; <a name="line.48"></a>
<FONT color="green">049</FONT> theCmdArgs = new ArrayList(); <a name="line.49"></a>
<FONT color="green">050</FONT> theOptionMatcher = new OptionMatcher(optString);<a name="line.50"></a>
<FONT color="green">051</FONT> // fill in the options list<a name="line.51"></a>
<FONT color="green">052</FONT> for(int i=0; i&lt;args.length; i++){<a name="line.52"></a>
<FONT color="green">053</FONT> String token = args[i];<a name="line.53"></a>
<FONT color="green">054</FONT> int tokenLength = token.length();<a name="line.54"></a>
<FONT color="green">055</FONT> if(token.equals("--")){ // end of opts<a name="line.55"></a>
<FONT color="green">056</FONT> currOptIndex = i+1; // set index of first operand<a name="line.56"></a>
<FONT color="green">057</FONT> break; // end of options<a name="line.57"></a>
<FONT color="green">058</FONT> }<a name="line.58"></a>
<FONT color="green">059</FONT> else if(token.startsWith("-") &amp;&amp; tokenLength == 2){ <a name="line.59"></a>
<FONT color="green">060</FONT> // simple option token such as '-s' found<a name="line.60"></a>
<FONT color="green">061</FONT> theOptions.add(new Option(token.charAt(1))); <a name="line.61"></a>
<FONT color="green">062</FONT> }<a name="line.62"></a>
<FONT color="green">063</FONT> else if(token.startsWith("-") &amp;&amp; tokenLength &gt; 2){<a name="line.63"></a>
<FONT color="green">064</FONT> // stacked options found, such as '-shm'<a name="line.64"></a>
<FONT color="green">065</FONT> // iterate thru the tokens after the dash and<a name="line.65"></a>
<FONT color="green">066</FONT> // add them to theOptions list<a name="line.66"></a>
<FONT color="green">067</FONT> for(int j=1; j&lt;tokenLength; j++){<a name="line.67"></a>
<FONT color="green">068</FONT> theOptions.add(new Option(token.charAt(j)));<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> } <a name="line.70"></a>
<FONT color="green">071</FONT> else if(!token.startsWith("-")){<a name="line.71"></a>
<FONT color="green">072</FONT> // case 1- there are not options stored yet therefore<a name="line.72"></a>
<FONT color="green">073</FONT> // this must be an command argument, not an option argument<a name="line.73"></a>
<FONT color="green">074</FONT> if(theOptions.size() == 0){<a name="line.74"></a>
<FONT color="green">075</FONT> currOptIndex = i;<a name="line.75"></a>
<FONT color="green">076</FONT> break; // stop processing options<a name="line.76"></a>
<FONT color="green">077</FONT> }<a name="line.77"></a>
<FONT color="green">078</FONT> else {<a name="line.78"></a>
<FONT color="green">079</FONT> // case 2- <a name="line.79"></a>
<FONT color="green">080</FONT> // there are options stored, check to see if<a name="line.80"></a>
<FONT color="green">081</FONT> // this arg belong to the last arg stored <a name="line.81"></a>
<FONT color="green">082</FONT> int indexoflast=0;<a name="line.82"></a>
<FONT color="green">083</FONT> indexoflast = theOptions.size()-1;<a name="line.83"></a>
<FONT color="green">084</FONT> Option op = (Option)theOptions.get(indexoflast);<a name="line.84"></a>
<FONT color="green">085</FONT> char opLetter = op.getArgLetter();<a name="line.85"></a>
<FONT color="green">086</FONT> if(!op.hasArg() &amp;&amp; theOptionMatcher.hasArg(opLetter)){<a name="line.86"></a>
<FONT color="green">087</FONT> op.setArg(token);<a name="line.87"></a>
<FONT color="green">088</FONT> }<a name="line.88"></a>
<FONT color="green">089</FONT> else{<a name="line.89"></a>
<FONT color="green">090</FONT> // case 3 - <a name="line.90"></a>
<FONT color="green">091</FONT> // the last option stored does not take<a name="line.91"></a>
<FONT color="green">092</FONT> // an argument, so again, this argument<a name="line.92"></a>
<FONT color="green">093</FONT> // must be a command argument, not <a name="line.93"></a>
<FONT color="green">094</FONT> // an option argument<a name="line.94"></a>
<FONT color="green">095</FONT> currOptIndex = i;<a name="line.95"></a>
<FONT color="green">096</FONT> break; // end of options <a name="line.96"></a>
<FONT color="green">097</FONT> }<a name="line.97"></a>
<FONT color="green">098</FONT> }<a name="line.98"></a>
<FONT color="green">099</FONT> }// end option does not start with "-"<a name="line.99"></a>
<FONT color="green">100</FONT> } // end for args loop<a name="line.100"></a>
<FONT color="green">101</FONT> <a name="line.101"></a>
<FONT color="green">102</FONT> // attach an iterator to list of options <a name="line.102"></a>
<FONT color="green">103</FONT> theOptionsIterator = theOptions.listIterator();<a name="line.103"></a>
<FONT color="green">104</FONT> <a name="line.104"></a>
<FONT color="green">105</FONT> // options are done, now fill out cmd arg list with remaining args<a name="line.105"></a>
<FONT color="green">106</FONT> for(int i=currOptIndex; i&lt;args.length; i++){<a name="line.106"></a>
<FONT color="green">107</FONT> String token = args[i];<a name="line.107"></a>
<FONT color="green">108</FONT> theCmdArgs.add(token);<a name="line.108"></a>
<FONT color="green">109</FONT> }<a name="line.109"></a>
<FONT color="green">110</FONT> }<a name="line.110"></a>
<FONT color="green">111</FONT> <a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> /**<a name="line.113"></a>
<FONT color="green">114</FONT> * debugging routine to print out all options collected<a name="line.114"></a>
<FONT color="green">115</FONT> */<a name="line.115"></a>
<FONT color="green">116</FONT> public void printOptions(){<a name="line.116"></a>
<FONT color="green">117</FONT> for(ListIterator it=theOptions.listIterator(); it.hasNext();){<a name="line.117"></a>
<FONT color="green">118</FONT> Option opt = (Option)it.next();<a name="line.118"></a>
<FONT color="green">119</FONT> System.out.print("OPT =" + opt.getArgLetter());<a name="line.119"></a>
<FONT color="green">120</FONT> String arg = opt.getArgument();<a name="line.120"></a>
<FONT color="green">121</FONT> if(arg != null){<a name="line.121"></a>
<FONT color="green">122</FONT> System.out.print(" " + arg);<a name="line.122"></a>
<FONT color="green">123</FONT> }<a name="line.123"></a>
<FONT color="green">124</FONT> System.out.println();<a name="line.124"></a>
<FONT color="green">125</FONT> }<a name="line.125"></a>
<FONT color="green">126</FONT> }<a name="line.126"></a>
<FONT color="green">127</FONT> <a name="line.127"></a>
<FONT color="green">128</FONT> /**<a name="line.128"></a>
<FONT color="green">129</FONT> * gets the next option found in the commandline. Distinguishes<a name="line.129"></a>
<FONT color="green">130</FONT> * between two bad cases, one case is when an illegal option<a name="line.130"></a>
<FONT color="green">131</FONT> * is found, and then other case is when an option takes an<a name="line.131"></a>
<FONT color="green">132</FONT> * argument but no argument was found for that option.<a name="line.132"></a>
<FONT color="green">133</FONT> * If the option found was not declared in the optString, then <a name="line.133"></a>
<FONT color="green">134</FONT> * an IllegalArgumentException will be thrown (case 1). <a name="line.134"></a>
<FONT color="green">135</FONT> * If the next option found has been declared to take an argument, <a name="line.135"></a>
<FONT color="green">136</FONT> * and no such argument exists, then a MissingOptArgException<a name="line.136"></a>
<FONT color="green">137</FONT> * is thrown (case 2).<a name="line.137"></a>
<FONT color="green">138</FONT> * @return int - the next option found.<a name="line.138"></a>
<FONT color="green">139</FONT> * @throws IllegalArgumentException, MissingOptArgException. <a name="line.139"></a>
<FONT color="green">140</FONT> */<a name="line.140"></a>
<FONT color="green">141</FONT> public int getNextOption() throws IllegalArgumentException, <a name="line.141"></a>
<FONT color="green">142</FONT> MissingOptArgException<a name="line.142"></a>
<FONT color="green">143</FONT> {<a name="line.143"></a>
<FONT color="green">144</FONT> int retval = -1;<a name="line.144"></a>
<FONT color="green">145</FONT> if(theOptionsIterator.hasNext()){<a name="line.145"></a>
<FONT color="green">146</FONT> theCurrentOption = (Option)theOptionsIterator.next();<a name="line.146"></a>
<FONT color="green">147</FONT> char c = theCurrentOption.getArgLetter();<a name="line.147"></a>
<FONT color="green">148</FONT> boolean shouldHaveArg = theOptionMatcher.hasArg(c);<a name="line.148"></a>
<FONT color="green">149</FONT> String arg = theCurrentOption.getArgument();<a name="line.149"></a>
<FONT color="green">150</FONT> if(!theOptionMatcher.match(c)) {<a name="line.150"></a>
<FONT color="green">151</FONT> ErrorMsg msg = new ErrorMsg(ErrorMsg.ILLEGAL_CMDLINE_OPTION_ERR,<a name="line.151"></a>
<FONT color="green">152</FONT> new Character(c));<a name="line.152"></a>
<FONT color="green">153</FONT> throw (new IllegalArgumentException(msg.toString()));<a name="line.153"></a>
<FONT color="green">154</FONT> }<a name="line.154"></a>
<FONT color="green">155</FONT> else if(shouldHaveArg &amp;&amp; (arg == null)) {<a name="line.155"></a>
<FONT color="green">156</FONT> ErrorMsg msg = new ErrorMsg(ErrorMsg.CMDLINE_OPT_MISSING_ARG_ERR,<a name="line.156"></a>
<FONT color="green">157</FONT> new Character(c));<a name="line.157"></a>
<FONT color="green">158</FONT> throw (new MissingOptArgException(msg.toString()));<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> retval = c;<a name="line.160"></a>
<FONT color="green">161</FONT> }<a name="line.161"></a>
<FONT color="green">162</FONT> return retval;<a name="line.162"></a>
<FONT color="green">163</FONT> }<a name="line.163"></a>
<FONT color="green">164</FONT> <a name="line.164"></a>
<FONT color="green">165</FONT> /**<a name="line.165"></a>
<FONT color="green">166</FONT> * gets the argument for the current parsed option. For example,<a name="line.166"></a>
<FONT color="green">167</FONT> * in case of '-d &lt;file&gt;', if current option parsed is 'd' then<a name="line.167"></a>
<FONT color="green">168</FONT> * getOptionArg() would return '&lt;file&gt;'.<a name="line.168"></a>
<FONT color="green">169</FONT> * @return String - argument for current parsed option.<a name="line.169"></a>
<FONT color="green">170</FONT> */<a name="line.170"></a>
<FONT color="green">171</FONT> public String getOptionArg(){<a name="line.171"></a>
<FONT color="green">172</FONT> String retval = null;<a name="line.172"></a>
<FONT color="green">173</FONT> String tmp = theCurrentOption.getArgument();<a name="line.173"></a>
<FONT color="green">174</FONT> char c = theCurrentOption.getArgLetter();<a name="line.174"></a>
<FONT color="green">175</FONT> if(theOptionMatcher.hasArg(c)){<a name="line.175"></a>
<FONT color="green">176</FONT> retval = tmp;<a name="line.176"></a>
<FONT color="green">177</FONT> }<a name="line.177"></a>
<FONT color="green">178</FONT> return retval; <a name="line.178"></a>
<FONT color="green">179</FONT> }<a name="line.179"></a>
<FONT color="green">180</FONT> <a name="line.180"></a>
<FONT color="green">181</FONT> /**<a name="line.181"></a>
<FONT color="green">182</FONT> * gets list of the commandline arguments. For example, in command<a name="line.182"></a>
<FONT color="green">183</FONT> * such as 'cmd -s -d file file2 file3 file4' with the usage<a name="line.183"></a>
<FONT color="green">184</FONT> * 'cmd [-s] [-d &lt;file&gt;] &lt;file&gt;...', getCmdArgs() would return<a name="line.184"></a>
<FONT color="green">185</FONT> * the list {file2, file3, file4}.<a name="line.185"></a>
<FONT color="green">186</FONT> * @return String[] - list of command arguments that may appear<a name="line.186"></a>
<FONT color="green">187</FONT> * after options and option arguments.<a name="line.187"></a>
<FONT color="green">188</FONT> */<a name="line.188"></a>
<FONT color="green">189</FONT> public String[] getCmdArgs(){<a name="line.189"></a>
<FONT color="green">190</FONT> String[] retval = new String[theCmdArgs.size()];<a name="line.190"></a>
<FONT color="green">191</FONT> int i=0;<a name="line.191"></a>
<FONT color="green">192</FONT> for(ListIterator it=theCmdArgs.listIterator(); it.hasNext();){<a name="line.192"></a>
<FONT color="green">193</FONT> retval[i++] = (String)it.next();<a name="line.193"></a>
<FONT color="green">194</FONT> }<a name="line.194"></a>
<FONT color="green">195</FONT> return retval;<a name="line.195"></a>
<FONT color="green">196</FONT> }<a name="line.196"></a>
<FONT color="green">197</FONT> <a name="line.197"></a>
<FONT color="green">198</FONT> <a name="line.198"></a>
<FONT color="green">199</FONT> private Option theCurrentOption = null;<a name="line.199"></a>
<FONT color="green">200</FONT> private ListIterator theOptionsIterator; <a name="line.200"></a>
<FONT color="green">201</FONT> private List theOptions = null;<a name="line.201"></a>
<FONT color="green">202</FONT> private List theCmdArgs = null;<a name="line.202"></a>
<FONT color="green">203</FONT> private OptionMatcher theOptionMatcher = null;<a name="line.203"></a>
<FONT color="green">204</FONT> <a name="line.204"></a>
<FONT color="green">205</FONT> ///////////////////////////////////////////////////////////<a name="line.205"></a>
<FONT color="green">206</FONT> //<a name="line.206"></a>
<FONT color="green">207</FONT> // Inner Classes<a name="line.207"></a>
<FONT color="green">208</FONT> //<a name="line.208"></a>
<FONT color="green">209</FONT> ///////////////////////////////////////////////////////////<a name="line.209"></a>
<FONT color="green">210</FONT> <a name="line.210"></a>
<FONT color="green">211</FONT> // inner class to model an option<a name="line.211"></a>
<FONT color="green">212</FONT> static class Option{<a name="line.212"></a>
<FONT color="green">213</FONT> private char theArgLetter;<a name="line.213"></a>
<FONT color="green">214</FONT> private String theArgument = null;<a name="line.214"></a>
<FONT color="green">215</FONT> public Option(char argLetter) { theArgLetter = argLetter; }<a name="line.215"></a>
<FONT color="green">216</FONT> public void setArg(String arg) { <a name="line.216"></a>
<FONT color="green">217</FONT> theArgument = arg;<a name="line.217"></a>
<FONT color="green">218</FONT> }<a name="line.218"></a>
<FONT color="green">219</FONT> public boolean hasArg() { return (theArgument != null); } <a name="line.219"></a>
<FONT color="green">220</FONT> public char getArgLetter() { return theArgLetter; }<a name="line.220"></a>
<FONT color="green">221</FONT> public String getArgument() { return theArgument; }<a name="line.221"></a>
<FONT color="green">222</FONT> } // end class Option<a name="line.222"></a>
<FONT color="green">223</FONT> <a name="line.223"></a>
<FONT color="green">224</FONT> <a name="line.224"></a>
<FONT color="green">225</FONT> // inner class to query optString for a possible option match,<a name="line.225"></a>
<FONT color="green">226</FONT> // and whether or not a given legal option takes an argument. <a name="line.226"></a>
<FONT color="green">227</FONT> // <a name="line.227"></a>
<FONT color="green">228</FONT> static class OptionMatcher{<a name="line.228"></a>
<FONT color="green">229</FONT> public OptionMatcher(String optString){<a name="line.229"></a>
<FONT color="green">230</FONT> theOptString = optString; <a name="line.230"></a>
<FONT color="green">231</FONT> }<a name="line.231"></a>
<FONT color="green">232</FONT> public boolean match(char c){<a name="line.232"></a>
<FONT color="green">233</FONT> boolean retval = false;<a name="line.233"></a>
<FONT color="green">234</FONT> if(theOptString.indexOf(c) != -1){<a name="line.234"></a>
<FONT color="green">235</FONT> retval = true;<a name="line.235"></a>
<FONT color="green">236</FONT> }<a name="line.236"></a>
<FONT color="green">237</FONT> return retval; <a name="line.237"></a>
<FONT color="green">238</FONT> }<a name="line.238"></a>
<FONT color="green">239</FONT> public boolean hasArg(char c){<a name="line.239"></a>
<FONT color="green">240</FONT> boolean retval = false;<a name="line.240"></a>
<FONT color="green">241</FONT> int index = theOptString.indexOf(c)+1; <a name="line.241"></a>
<FONT color="green">242</FONT> if (index == theOptString.length()){<a name="line.242"></a>
<FONT color="green">243</FONT> // reached end of theOptString<a name="line.243"></a>
<FONT color="green">244</FONT> retval = false;<a name="line.244"></a>
<FONT color="green">245</FONT> }<a name="line.245"></a>
<FONT color="green">246</FONT> else if(theOptString.charAt(index) == ':'){<a name="line.246"></a>
<FONT color="green">247</FONT> retval = true;<a name="line.247"></a>
<FONT color="green">248</FONT> }<a name="line.248"></a>
<FONT color="green">249</FONT> return retval;<a name="line.249"></a>
<FONT color="green">250</FONT> }<a name="line.250"></a>
<FONT color="green">251</FONT> private String theOptString = null;<a name="line.251"></a>
<FONT color="green">252</FONT> } // end class OptionMatcher<a name="line.252"></a>
<FONT color="green">253</FONT> }// end class GetOpt<a name="line.253"></a>
<FONT color="green">254</FONT> <a name="line.254"></a>
</PRE>
</BODY>
</HTML>