| 1 |
<?xml version="1.0" encoding="iso-8859-1"?> |
| 2 |
<!DOCTYPE html |
| 3 |
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 4 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 5 |
|
| 6 |
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| 7 |
<head> |
| 8 |
<title>Class: CommandOptionParser</title> |
| 9 |
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
| 10 |
<meta http-equiv="Content-Script-Type" content="text/javascript" /> |
| 11 |
<link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" /> |
| 12 |
<script type="text/javascript"> |
| 13 |
// <![CDATA[ |
| 14 |
|
| 15 |
function popupCode( url ) { |
| 16 |
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400") |
| 17 |
} |
| 18 |
|
| 19 |
function toggleCode( id ) { |
| 20 |
if ( document.getElementById ) |
| 21 |
elem = document.getElementById( id ); |
| 22 |
else if ( document.all ) |
| 23 |
elem = eval( "document.all." + id ); |
| 24 |
else |
| 25 |
return false; |
| 26 |
|
| 27 |
elemStyle = elem.style; |
| 28 |
|
| 29 |
if ( elemStyle.display != "block" ) { |
| 30 |
elemStyle.display = "block" |
| 31 |
} else { |
| 32 |
elemStyle.display = "none" |
| 33 |
} |
| 34 |
|
| 35 |
return true; |
| 36 |
} |
| 37 |
|
| 38 |
// Make codeblocks hidden by default |
| 39 |
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" ) |
| 40 |
|
| 41 |
// ]]> |
| 42 |
</script> |
| 43 |
|
| 44 |
</head> |
| 45 |
<body> |
| 46 |
|
| 47 |
|
| 48 |
|
| 49 |
<div id="classHeader"> |
| 50 |
<table class="header-table"> |
| 51 |
<tr class="top-aligned-row"> |
| 52 |
<td><strong>Class</strong></td> |
| 53 |
<td class="class-name-in-header">CommandOptionParser</td> |
| 54 |
</tr> |
| 55 |
<tr class="top-aligned-row"> |
| 56 |
<td><strong>In:</strong></td> |
| 57 |
<td> |
| 58 |
<a href="../files/kwalify/util/option-parser_rb.html"> |
| 59 |
kwalify/util/option-parser.rb |
| 60 |
</a> |
| 61 |
<br /> |
| 62 |
</td> |
| 63 |
</tr> |
| 64 |
|
| 65 |
<tr class="top-aligned-row"> |
| 66 |
<td><strong>Parent:</strong></td> |
| 67 |
<td> |
| 68 |
Object |
| 69 |
</td> |
| 70 |
</tr> |
| 71 |
</table> |
| 72 |
</div> |
| 73 |
<!-- banner header --> |
| 74 |
|
| 75 |
<div id="bodyContent"> |
| 76 |
|
| 77 |
|
| 78 |
|
| 79 |
<div id="contextContent"> |
| 80 |
|
| 81 |
<div id="description"> |
| 82 |
<p> |
| 83 |
ex. |
| 84 |
</p> |
| 85 |
<pre> |
| 86 |
## create parser |
| 87 |
arg_none = "hv" # ex. -h -v |
| 88 |
arg_required = "xf" # ex. -x suffix -f filename |
| 89 |
arg_optional = "i" # ex. -i (or -i10) |
| 90 |
parser = CommandOptionParser.new(arg_none, arg_required, arg_optional) |
| 91 |
|
| 92 |
## parse options |
| 93 |
argv = %w[-h -v -f filename -i 10 aaa bbb] |
| 94 |
options, properties = parser.parse(argv) |
| 95 |
p options #=> { ?h=>true, ?v=>true, ?f=>"filename", ?i=>true } |
| 96 |
p argv #=> ["10", "aaa", "bbb"] |
| 97 |
|
| 98 |
## parse options #2 |
| 99 |
argv = %w[-hvx.txt -ffilename -i10 aaa bbb] |
| 100 |
options, properties = parser.parse(argv) |
| 101 |
p options #=> { ?h=>true, ?v=>true, ?x=>".txt", ?f=>"filename", ?i=>10 } |
| 102 |
p argv #=> ["aaa", "bbb"] |
| 103 |
|
| 104 |
## parse properties |
| 105 |
argv = %w[-hi --index=10 --user-name=foo --help] |
| 106 |
options, properties = parser.parse(argv) |
| 107 |
p options #=> {?h=>true, ?i=>true} |
| 108 |
p properties #=> {"index"=>"10", "user-name"=>"foo", "help"=>nil} |
| 109 |
|
| 110 |
## parse properties with auto-convert |
| 111 |
argv = %w[-hi --index=10 --user-name=foo --help] |
| 112 |
options, properties = parser.parse(argv, true) |
| 113 |
p options #=> {?h=>true, ?i=>true} |
| 114 |
p properties #=> {:index=>10, :user_name=>foo, :help=>true} |
| 115 |
|
| 116 |
## -a: unknown option. |
| 117 |
argv = %w[-abc] |
| 118 |
begin |
| 119 |
options, properties = parser.parse(argv) |
| 120 |
rescue CommandOptionError => ex |
| 121 |
$stderr.puts ex.message # -a: unknown option. |
| 122 |
end |
| 123 |
|
| 124 |
## -f: argument required. |
| 125 |
argv = %w[-f] |
| 126 |
begin |
| 127 |
options, properties = parser.parse(argv) |
| 128 |
rescue CommandOptionError => ex |
| 129 |
$stderr.puts ex.message # -f: argument required. |
| 130 |
end |
| 131 |
|
| 132 |
## --@prop=10: invalid property. |
| 133 |
argv = %w[--@prop=10] |
| 134 |
begin |
| 135 |
options, properties = parser.parse(argv) |
| 136 |
rescue CommandOptionError => ex |
| 137 |
$stderr.puts ex.message # --@prop=10: invalid property. |
| 138 |
end |
| 139 |
</pre> |
| 140 |
|
| 141 |
</div> |
| 142 |
|
| 143 |
|
| 144 |
</div> |
| 145 |
|
| 146 |
<div id="method-list"> |
| 147 |
<h3 class="section-bar">Methods</h3> |
| 148 |
|
| 149 |
<div class="name-list"> |
| 150 |
<a href="#M000001">new</a> |
| 151 |
<a href="#M000003">parse</a> |
| 152 |
<a href="#M000002">to_value</a> |
| 153 |
</div> |
| 154 |
</div> |
| 155 |
|
| 156 |
</div> |
| 157 |
|
| 158 |
|
| 159 |
<!-- if includes --> |
| 160 |
|
| 161 |
<div id="section"> |
| 162 |
|
| 163 |
|
| 164 |
|
| 165 |
|
| 166 |
|
| 167 |
|
| 168 |
|
| 169 |
|
| 170 |
<!-- if method_list --> |
| 171 |
<div id="methods"> |
| 172 |
<h3 class="section-bar">Public Class methods</h3> |
| 173 |
|
| 174 |
<div id="method-M000001" class="method-detail"> |
| 175 |
<a name="M000001"></a> |
| 176 |
|
| 177 |
<div class="method-heading"> |
| 178 |
<a href="#M000001" class="method-signature"> |
| 179 |
<span class="method-name">new</span><span class="method-args">(arg_none=nil, arg_required=nil, arg_optional=nil)</span> |
| 180 |
</a> |
| 181 |
</div> |
| 182 |
|
| 183 |
<div class="method-description"> |
| 184 |
<p> |
| 185 |
arg_none: option string which takes no argument arg_required: option string |
| 186 |
which takes argument arg_otpional: option string which may takes argument |
| 187 |
optionally |
| 188 |
</p> |
| 189 |
<p><a class="source-toggle" href="#" |
| 190 |
onclick="toggleCode('M000001-source');return false;">[Source]</a></p> |
| 191 |
<div class="method-source-code" id="M000001-source"> |
| 192 |
<pre> |
| 193 |
<span class="ruby-comment cmt"># File kwalify/util/option-parser.rb, line 92</span> |
| 194 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">arg_none</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">arg_required</span>=<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">arg_optional</span>=<span class="ruby-keyword kw">nil</span>) |
| 195 |
<span class="ruby-ivar">@arg_none</span> = <span class="ruby-identifier">arg_none</span> <span class="ruby-operator">||</span> <span class="ruby-value str">""</span> |
| 196 |
<span class="ruby-ivar">@arg_required</span> = <span class="ruby-identifier">arg_required</span> <span class="ruby-operator">||</span> <span class="ruby-value str">""</span> |
| 197 |
<span class="ruby-ivar">@arg_optional</span> = <span class="ruby-identifier">arg_optional</span> <span class="ruby-operator">||</span> <span class="ruby-value str">""</span> |
| 198 |
<span class="ruby-keyword kw">end</span> |
| 199 |
</pre> |
| 200 |
</div> |
| 201 |
</div> |
| 202 |
</div> |
| 203 |
|
| 204 |
<div id="method-M000002" class="method-detail"> |
| 205 |
<a name="M000002"></a> |
| 206 |
|
| 207 |
<div class="method-heading"> |
| 208 |
<a href="#M000002" class="method-signature"> |
| 209 |
<span class="method-name">to_value</span><span class="method-args">(str)</span> |
| 210 |
</a> |
| 211 |
</div> |
| 212 |
|
| 213 |
<div class="method-description"> |
| 214 |
<p><a class="source-toggle" href="#" |
| 215 |
onclick="toggleCode('M000002-source');return false;">[Source]</a></p> |
| 216 |
<div class="method-source-code" id="M000002-source"> |
| 217 |
<pre> |
| 218 |
<span class="ruby-comment cmt"># File kwalify/util/option-parser.rb, line 99</span> |
| 219 |
<span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">to_value</span>(<span class="ruby-identifier">str</span>) |
| 220 |
<span class="ruby-keyword kw">case</span> <span class="ruby-identifier">str</span> |
| 221 |
<span class="ruby-keyword kw">when</span> <span class="ruby-keyword kw">nil</span>, <span class="ruby-value str">"null"</span>, <span class="ruby-value str">"nil"</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">nil</span> |
| 222 |
<span class="ruby-keyword kw">when</span> <span class="ruby-value str">"true"</span>, <span class="ruby-value str">"yes"</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">true</span> |
| 223 |
<span class="ruby-keyword kw">when</span> <span class="ruby-value str">"false"</span>, <span class="ruby-value str">"no"</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-keyword kw">false</span> |
| 224 |
<span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\A\d+\z/</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">to_i</span> |
| 225 |
<span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\A\d+\.\d+\z/</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">str</span>.<span class="ruby-identifier">to_f</span> |
| 226 |
<span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\/(.*)\//</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-constant">Regexp</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">$1</span>) |
| 227 |
<span class="ruby-keyword kw">when</span> <span class="ruby-regexp re">/\A'.*'\z/</span>, <span class="ruby-regexp re">/\A".*"\z/</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">eval</span>(<span class="ruby-identifier">str</span>) |
| 228 |
<span class="ruby-keyword kw">else</span> ; <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">str</span> |
| 229 |
<span class="ruby-keyword kw">end</span> |
| 230 |
<span class="ruby-keyword kw">end</span> |
| 231 |
</pre> |
| 232 |
</div> |
| 233 |
</div> |
| 234 |
</div> |
| 235 |
|
| 236 |
<h3 class="section-bar">Public Instance methods</h3> |
| 237 |
|
| 238 |
<div id="method-M000003" class="method-detail"> |
| 239 |
<a name="M000003"></a> |
| 240 |
|
| 241 |
<div class="method-heading"> |
| 242 |
<a href="#M000003" class="method-signature"> |
| 243 |
<span class="method-name">parse</span><span class="method-args">(argv, auto_convert=false)</span> |
| 244 |
</a> |
| 245 |
</div> |
| 246 |
|
| 247 |
<div class="method-description"> |
| 248 |
<table> |
| 249 |
<tr><td valign="top">argv:</td><td>array of string |
| 250 |
|
| 251 |
</td></tr> |
| 252 |
<tr><td valign="top">auto_convert:</td><td>if true, convert properties value to int, boolean, string, regexp, … |
| 253 |
(default false) |
| 254 |
|
| 255 |
</td></tr> |
| 256 |
</table> |
| 257 |
<p><a class="source-toggle" href="#" |
| 258 |
onclick="toggleCode('M000003-source');return false;">[Source]</a></p> |
| 259 |
<div class="method-source-code" id="M000003-source"> |
| 260 |
<pre> |
| 261 |
<span class="ruby-comment cmt"># File kwalify/util/option-parser.rb, line 115</span> |
| 262 |
<span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-identifier">argv</span>, <span class="ruby-identifier">auto_convert</span>=<span class="ruby-keyword kw">false</span>) |
| 263 |
<span class="ruby-identifier">options</span> = {} |
| 264 |
<span class="ruby-identifier">properties</span> = {} |
| 265 |
<span class="ruby-keyword kw">while</span> <span class="ruby-identifier">argv</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">&&</span> <span class="ruby-identifier">argv</span>[<span class="ruby-value">0</span>][<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?-</span> |
| 266 |
<span class="ruby-identifier">optstr</span> = <span class="ruby-identifier">argv</span>.<span class="ruby-identifier">shift</span> |
| 267 |
<span class="ruby-identifier">optstr</span> = <span class="ruby-identifier">optstr</span>[<span class="ruby-value">1</span>, <span class="ruby-identifier">optstr</span>.<span class="ruby-identifier">length</span><span class="ruby-operator">-</span><span class="ruby-value">1</span>] |
| 268 |
<span class="ruby-comment cmt">#</span> |
| 269 |
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">optstr</span>[<span class="ruby-value">0</span>] <span class="ruby-operator">==</span> <span class="ruby-value">?-</span> <span class="ruby-comment cmt">## property</span> |
| 270 |
<span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">optstr</span> <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/\A\-([-\w]+)(?:=(.*))?/</span> |
| 271 |
<span class="ruby-identifier">raise</span> <span class="ruby-constant">CommandOptionError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">optstr</span>, <span class="ruby-identifier">:invalid_property</span>) |
| 272 |
<span class="ruby-keyword kw">end</span> |
| 273 |
<span class="ruby-identifier">prop_name</span> = <span class="ruby-identifier">$1</span>; <span class="ruby-identifier">prop_value</span> = <span class="ruby-identifier">$2</span> |
| 274 |
<span class="ruby-keyword kw">if</span> <span class="ruby-identifier">auto_convert</span> |
| 275 |
<span class="ruby-identifier">key</span> = <span class="ruby-identifier">prop_name</span>.<span class="ruby-identifier">gsub</span>(<span class="ruby-regexp re">/-/</span>, <span class="ruby-value str">'_'</span>).<span class="ruby-identifier">intern</span> |
| 276 |
<span class="ruby-identifier">value</span> = <span class="ruby-identifier">prop_value</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-constant">CommandOptionParser</span>.<span class="ruby-identifier">to_value</span>(<span class="ruby-identifier">prop_value</span>) |
| 277 |
<span class="ruby-identifier">properties</span>[<span class="ruby-identifier">key</span>] = <span class="ruby-identifier">value</span> |
| 278 |
<span class="ruby-keyword kw">else</span> |
| 279 |
<span class="ruby-identifier">properties</span>[<span class="ruby-identifier">prop_name</span>] = <span class="ruby-identifier">prop_value</span> |
| 280 |
<span class="ruby-keyword kw">end</span> |
| 281 |
<span class="ruby-comment cmt">#</span> |
| 282 |
<span class="ruby-keyword kw">else</span> <span class="ruby-comment cmt">## options</span> |
| 283 |
<span class="ruby-keyword kw">while</span> <span class="ruby-identifier">optstr</span> <span class="ruby-operator">&&</span> <span class="ruby-operator">!</span><span class="ruby-identifier">optstr</span>.<span class="ruby-identifier">empty?</span> |
| 284 |
<span class="ruby-identifier">optchar</span> = <span class="ruby-identifier">optstr</span>[<span class="ruby-value">0</span>] |
| 285 |
<span class="ruby-identifier">optstr</span>[<span class="ruby-value">0</span>,<span class="ruby-value">1</span>] = <span class="ruby-value str">""</span> |
| 286 |
<span class="ruby-comment cmt">#puts "*** debug: optchar=#{optchar.chr}, optstr=#{optstr.inspect}"</span> |
| 287 |
<span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@arg_none</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">optchar</span>) |
| 288 |
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">optchar</span>] = <span class="ruby-keyword kw">true</span> |
| 289 |
<span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@arg_required</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">optchar</span>) |
| 290 |
<span class="ruby-identifier">arg</span> = <span class="ruby-identifier">optstr</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-identifier">argv</span>.<span class="ruby-identifier">shift</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">optstr</span> |
| 291 |
<span class="ruby-identifier">raise</span> <span class="ruby-constant">CommandOptionError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">optchar</span>.<span class="ruby-identifier">chr</span>, <span class="ruby-identifier">:no_argument</span>) <span class="ruby-keyword kw">unless</span> <span class="ruby-identifier">arg</span> |
| 292 |
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">optchar</span>] = <span class="ruby-identifier">arg</span> |
| 293 |
<span class="ruby-identifier">optstr</span> = <span class="ruby-keyword kw">nil</span> |
| 294 |
<span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@arg_optional</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">optchar</span>) |
| 295 |
<span class="ruby-identifier">arg</span> = <span class="ruby-identifier">optstr</span>.<span class="ruby-identifier">empty?</span> <span class="ruby-value">? </span><span class="ruby-keyword kw">true</span> <span class="ruby-operator">:</span> <span class="ruby-identifier">optstr</span> |
| 296 |
<span class="ruby-identifier">options</span>[<span class="ruby-identifier">optchar</span>] = <span class="ruby-identifier">arg</span> |
| 297 |
<span class="ruby-identifier">optstr</span> = <span class="ruby-keyword kw">nil</span> |
| 298 |
<span class="ruby-keyword kw">else</span> |
| 299 |
<span class="ruby-identifier">raise</span> <span class="ruby-constant">CommandOptionError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">optchar</span>.<span class="ruby-identifier">chr</span>, <span class="ruby-identifier">:unknown_option</span>) |
| 300 |
<span class="ruby-keyword kw">end</span> |
| 301 |
<span class="ruby-keyword kw">end</span> |
| 302 |
<span class="ruby-keyword kw">end</span> |
| 303 |
<span class="ruby-comment cmt">#</span> |
| 304 |
<span class="ruby-keyword kw">end</span> <span class="ruby-comment cmt"># end of while</span> |
| 305 |
|
| 306 |
<span class="ruby-keyword kw">return</span> <span class="ruby-identifier">options</span>, <span class="ruby-identifier">properties</span> |
| 307 |
<span class="ruby-keyword kw">end</span> |
| 308 |
</pre> |
| 309 |
</div> |
| 310 |
</div> |
| 311 |
</div> |
| 312 |
|
| 313 |
|
| 314 |
</div> |
| 315 |
|
| 316 |
|
| 317 |
</div> |
| 318 |
|
| 319 |
|
| 320 |
<div id="validator-badges"> |
| 321 |
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p> |
| 322 |
</div> |
| 323 |
|
| 324 |
</body> |
| 325 |
</html> |