| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/clap-2.34.0/src/app/usage.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>usage.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../../normalize.css"><link rel="stylesheet" href="../../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../../ayu.css" disabled><link rel="stylesheet" href="../../../dark.css" disabled><link rel="stylesheet" href="../../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../../storage.js"></script><script defer src="../../../source-script.js"></script><script defer src="../../../source-files.js"></script><script defer src="../../../main.js"></script><noscript><link rel="stylesheet" href="../../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../../clap/index.html"><div class="logo-container"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../clap/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| <span id="192">192</span> |
| <span id="193">193</span> |
| <span id="194">194</span> |
| <span id="195">195</span> |
| <span id="196">196</span> |
| <span id="197">197</span> |
| <span id="198">198</span> |
| <span id="199">199</span> |
| <span id="200">200</span> |
| <span id="201">201</span> |
| <span id="202">202</span> |
| <span id="203">203</span> |
| <span id="204">204</span> |
| <span id="205">205</span> |
| <span id="206">206</span> |
| <span id="207">207</span> |
| <span id="208">208</span> |
| <span id="209">209</span> |
| <span id="210">210</span> |
| <span id="211">211</span> |
| <span id="212">212</span> |
| <span id="213">213</span> |
| <span id="214">214</span> |
| <span id="215">215</span> |
| <span id="216">216</span> |
| <span id="217">217</span> |
| <span id="218">218</span> |
| <span id="219">219</span> |
| <span id="220">220</span> |
| <span id="221">221</span> |
| <span id="222">222</span> |
| <span id="223">223</span> |
| <span id="224">224</span> |
| <span id="225">225</span> |
| <span id="226">226</span> |
| <span id="227">227</span> |
| <span id="228">228</span> |
| <span id="229">229</span> |
| <span id="230">230</span> |
| <span id="231">231</span> |
| <span id="232">232</span> |
| <span id="233">233</span> |
| <span id="234">234</span> |
| <span id="235">235</span> |
| <span id="236">236</span> |
| <span id="237">237</span> |
| <span id="238">238</span> |
| <span id="239">239</span> |
| <span id="240">240</span> |
| <span id="241">241</span> |
| <span id="242">242</span> |
| <span id="243">243</span> |
| <span id="244">244</span> |
| <span id="245">245</span> |
| <span id="246">246</span> |
| <span id="247">247</span> |
| <span id="248">248</span> |
| <span id="249">249</span> |
| <span id="250">250</span> |
| <span id="251">251</span> |
| <span id="252">252</span> |
| <span id="253">253</span> |
| <span id="254">254</span> |
| <span id="255">255</span> |
| <span id="256">256</span> |
| <span id="257">257</span> |
| <span id="258">258</span> |
| <span id="259">259</span> |
| <span id="260">260</span> |
| <span id="261">261</span> |
| <span id="262">262</span> |
| <span id="263">263</span> |
| <span id="264">264</span> |
| <span id="265">265</span> |
| <span id="266">266</span> |
| <span id="267">267</span> |
| <span id="268">268</span> |
| <span id="269">269</span> |
| <span id="270">270</span> |
| <span id="271">271</span> |
| <span id="272">272</span> |
| <span id="273">273</span> |
| <span id="274">274</span> |
| <span id="275">275</span> |
| <span id="276">276</span> |
| <span id="277">277</span> |
| <span id="278">278</span> |
| <span id="279">279</span> |
| <span id="280">280</span> |
| <span id="281">281</span> |
| <span id="282">282</span> |
| <span id="283">283</span> |
| <span id="284">284</span> |
| <span id="285">285</span> |
| <span id="286">286</span> |
| <span id="287">287</span> |
| <span id="288">288</span> |
| <span id="289">289</span> |
| <span id="290">290</span> |
| <span id="291">291</span> |
| <span id="292">292</span> |
| <span id="293">293</span> |
| <span id="294">294</span> |
| <span id="295">295</span> |
| <span id="296">296</span> |
| <span id="297">297</span> |
| <span id="298">298</span> |
| <span id="299">299</span> |
| <span id="300">300</span> |
| <span id="301">301</span> |
| <span id="302">302</span> |
| <span id="303">303</span> |
| <span id="304">304</span> |
| <span id="305">305</span> |
| <span id="306">306</span> |
| <span id="307">307</span> |
| <span id="308">308</span> |
| <span id="309">309</span> |
| <span id="310">310</span> |
| <span id="311">311</span> |
| <span id="312">312</span> |
| <span id="313">313</span> |
| <span id="314">314</span> |
| <span id="315">315</span> |
| <span id="316">316</span> |
| <span id="317">317</span> |
| <span id="318">318</span> |
| <span id="319">319</span> |
| <span id="320">320</span> |
| <span id="321">321</span> |
| <span id="322">322</span> |
| <span id="323">323</span> |
| <span id="324">324</span> |
| <span id="325">325</span> |
| <span id="326">326</span> |
| <span id="327">327</span> |
| <span id="328">328</span> |
| <span id="329">329</span> |
| <span id="330">330</span> |
| <span id="331">331</span> |
| <span id="332">332</span> |
| <span id="333">333</span> |
| <span id="334">334</span> |
| <span id="335">335</span> |
| <span id="336">336</span> |
| <span id="337">337</span> |
| <span id="338">338</span> |
| <span id="339">339</span> |
| <span id="340">340</span> |
| <span id="341">341</span> |
| <span id="342">342</span> |
| <span id="343">343</span> |
| <span id="344">344</span> |
| <span id="345">345</span> |
| <span id="346">346</span> |
| <span id="347">347</span> |
| <span id="348">348</span> |
| <span id="349">349</span> |
| <span id="350">350</span> |
| <span id="351">351</span> |
| <span id="352">352</span> |
| <span id="353">353</span> |
| <span id="354">354</span> |
| <span id="355">355</span> |
| <span id="356">356</span> |
| <span id="357">357</span> |
| <span id="358">358</span> |
| <span id="359">359</span> |
| <span id="360">360</span> |
| <span id="361">361</span> |
| <span id="362">362</span> |
| <span id="363">363</span> |
| <span id="364">364</span> |
| <span id="365">365</span> |
| <span id="366">366</span> |
| <span id="367">367</span> |
| <span id="368">368</span> |
| <span id="369">369</span> |
| <span id="370">370</span> |
| <span id="371">371</span> |
| <span id="372">372</span> |
| <span id="373">373</span> |
| <span id="374">374</span> |
| <span id="375">375</span> |
| <span id="376">376</span> |
| <span id="377">377</span> |
| <span id="378">378</span> |
| <span id="379">379</span> |
| <span id="380">380</span> |
| <span id="381">381</span> |
| <span id="382">382</span> |
| <span id="383">383</span> |
| <span id="384">384</span> |
| <span id="385">385</span> |
| <span id="386">386</span> |
| <span id="387">387</span> |
| <span id="388">388</span> |
| <span id="389">389</span> |
| <span id="390">390</span> |
| <span id="391">391</span> |
| <span id="392">392</span> |
| <span id="393">393</span> |
| <span id="394">394</span> |
| <span id="395">395</span> |
| <span id="396">396</span> |
| <span id="397">397</span> |
| <span id="398">398</span> |
| <span id="399">399</span> |
| <span id="400">400</span> |
| <span id="401">401</span> |
| <span id="402">402</span> |
| <span id="403">403</span> |
| <span id="404">404</span> |
| <span id="405">405</span> |
| <span id="406">406</span> |
| <span id="407">407</span> |
| <span id="408">408</span> |
| <span id="409">409</span> |
| <span id="410">410</span> |
| <span id="411">411</span> |
| <span id="412">412</span> |
| <span id="413">413</span> |
| <span id="414">414</span> |
| <span id="415">415</span> |
| <span id="416">416</span> |
| <span id="417">417</span> |
| <span id="418">418</span> |
| <span id="419">419</span> |
| <span id="420">420</span> |
| <span id="421">421</span> |
| <span id="422">422</span> |
| <span id="423">423</span> |
| <span id="424">424</span> |
| <span id="425">425</span> |
| <span id="426">426</span> |
| <span id="427">427</span> |
| <span id="428">428</span> |
| <span id="429">429</span> |
| <span id="430">430</span> |
| <span id="431">431</span> |
| <span id="432">432</span> |
| <span id="433">433</span> |
| <span id="434">434</span> |
| <span id="435">435</span> |
| <span id="436">436</span> |
| <span id="437">437</span> |
| <span id="438">438</span> |
| <span id="439">439</span> |
| <span id="440">440</span> |
| <span id="441">441</span> |
| <span id="442">442</span> |
| <span id="443">443</span> |
| <span id="444">444</span> |
| <span id="445">445</span> |
| <span id="446">446</span> |
| <span id="447">447</span> |
| <span id="448">448</span> |
| <span id="449">449</span> |
| <span id="450">450</span> |
| <span id="451">451</span> |
| <span id="452">452</span> |
| <span id="453">453</span> |
| <span id="454">454</span> |
| <span id="455">455</span> |
| <span id="456">456</span> |
| <span id="457">457</span> |
| <span id="458">458</span> |
| <span id="459">459</span> |
| <span id="460">460</span> |
| <span id="461">461</span> |
| <span id="462">462</span> |
| <span id="463">463</span> |
| <span id="464">464</span> |
| <span id="465">465</span> |
| <span id="466">466</span> |
| <span id="467">467</span> |
| <span id="468">468</span> |
| <span id="469">469</span> |
| <span id="470">470</span> |
| <span id="471">471</span> |
| <span id="472">472</span> |
| <span id="473">473</span> |
| <span id="474">474</span> |
| <span id="475">475</span> |
| <span id="476">476</span> |
| <span id="477">477</span> |
| <span id="478">478</span> |
| <span id="479">479</span> |
| <span id="480">480</span> |
| <span id="481">481</span> |
| <span id="482">482</span> |
| <span id="483">483</span> |
| <span id="484">484</span> |
| <span id="485">485</span> |
| <span id="486">486</span> |
| <span id="487">487</span> |
| <span id="488">488</span> |
| <span id="489">489</span> |
| <span id="490">490</span> |
| <span id="491">491</span> |
| <span id="492">492</span> |
| <span id="493">493</span> |
| </pre><pre class="rust"><code><span class="comment">// std |
| </span><span class="kw">use </span>std::collections::{BTreeMap, VecDeque}; |
| |
| <span class="comment">// Internal |
| </span><span class="kw">use crate</span>::{ |
| app::{parser::Parser, settings::AppSettings <span class="kw">as </span>AS}, |
| args::{settings::ArgSettings, AnyArg, ArgMatcher, PosBuilder}, |
| INTERNAL_ERROR_MSG, |
| }; |
| |
| <span class="comment">// Creates a usage string for display. This happens just after all arguments were parsed, but before |
| // any subcommands have been parsed (so as to give subcommands their own usage recursively) |
| </span><span class="kw">pub fn </span>create_usage_with_title(p: <span class="kw-2">&</span>Parser, used: <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"usage::create_usage_with_title;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>usage = String::with_capacity(<span class="number">75</span>); |
| usage.push_str(<span class="string">"USAGE:\n "</span>); |
| usage.push_str(<span class="kw-2">&*</span>create_usage_no_title(p, used)); |
| usage |
| } |
| |
| <span class="comment">// Creates a usage string to be used in error message (i.e. one with currently used args) |
| </span><span class="kw">pub fn </span>create_error_usage<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>( |
| p: <span class="kw-2">&</span>Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>, |
| matcher: <span class="kw-2">&</span><span class="lifetime">'b </span>ArgMatcher<<span class="lifetime">'a</span>>, |
| extra: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| ) -> String { |
| <span class="kw">let </span><span class="kw-2">mut </span>args: Vec<<span class="kw">_</span>> = matcher |
| .arg_names() |
| .iter() |
| .filter(|n| { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(o) = <span class="macro">find_by_name!</span>(p, <span class="kw-2">**</span>n, opts, iter) { |
| !o.b.is_set(ArgSettings::Required) && !o.b.is_set(ArgSettings::Hidden) |
| } <span class="kw">else if let </span><span class="prelude-val">Some</span>(p) = <span class="macro">find_by_name!</span>(p, <span class="kw-2">**</span>n, positionals, values) { |
| !p.b.is_set(ArgSettings::Required) && p.b.is_set(ArgSettings::Hidden) |
| } <span class="kw">else </span>{ |
| <span class="bool-val">true </span><span class="comment">// flags can't be required, so they're always true |
| </span>} |
| }) |
| .copied() |
| .collect(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(r) = extra { |
| args.push(r); |
| } |
| create_usage_with_title(p, <span class="kw-2">&*</span>args) |
| } |
| |
| <span class="comment">// Creates a usage string (*without title*) if one was not provided by the user manually. |
| </span><span class="kw">pub fn </span>create_usage_no_title(p: <span class="kw-2">&</span>Parser, used: <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"usage::create_usage_no_title;"</span>); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(u) = p.meta.usage_str { |
| String::from(<span class="kw-2">&*</span>u) |
| } <span class="kw">else if </span>used.is_empty() { |
| create_help_usage(p, <span class="bool-val">true</span>) |
| } <span class="kw">else </span>{ |
| create_smart_usage(p, used) |
| } |
| } |
| |
| <span class="comment">// Creates a usage string for display in help messages (i.e. not for errors) |
| </span><span class="kw">pub fn </span>create_help_usage(p: <span class="kw-2">&</span>Parser, incl_reqs: bool) -> String { |
| <span class="kw">let </span><span class="kw-2">mut </span>usage = String::with_capacity(<span class="number">75</span>); |
| <span class="kw">let </span>name = p |
| .meta |
| .usage |
| .as_ref() |
| .unwrap_or_else(|| p.meta.bin_name.as_ref().unwrap_or(<span class="kw-2">&</span>p.meta.name)); |
| usage.push_str(<span class="kw-2">&*</span>name); |
| <span class="kw">let </span>req_string = <span class="kw">if </span>incl_reqs { |
| <span class="kw">let </span><span class="kw-2">mut </span>reqs: Vec<<span class="kw-2">&</span>str> = p.required().map(|r| <span class="kw-2">&**</span>r).collect(); |
| reqs.sort_unstable(); |
| reqs.dedup(); |
| get_required_usage_from(p, <span class="kw-2">&</span>reqs, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="bool-val">false</span>) |
| .iter() |
| .fold(String::new(), |a, s| a + <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">" {}"</span>, s)[..]) |
| } <span class="kw">else </span>{ |
| String::new() |
| }; |
| |
| <span class="kw">let </span>flags = needs_flags_tag(p); |
| <span class="kw">if </span>flags && !p.is_set(AS::UnifiedHelpMessage) { |
| usage.push_str(<span class="string">" [FLAGS]"</span>); |
| } <span class="kw">else if </span>flags { |
| usage.push_str(<span class="string">" [OPTIONS]"</span>); |
| } |
| <span class="kw">if </span>!p.is_set(AS::UnifiedHelpMessage) |
| && p.opts |
| .iter() |
| .any(|o| !o.is_set(ArgSettings::Required) && !o.is_set(ArgSettings::Hidden)) |
| { |
| usage.push_str(<span class="string">" [OPTIONS]"</span>); |
| } |
| |
| usage.push_str(<span class="kw-2">&</span>req_string[..]); |
| |
| <span class="kw">let </span>has_last = p.positionals.values().any(|p| p.is_set(ArgSettings::Last)); |
| <span class="comment">// places a '--' in the usage string if there are args and options |
| // supporting multiple values |
| </span><span class="kw">if </span>p.opts.iter().any(|o| o.is_set(ArgSettings::Multiple)) |
| && p.positionals |
| .values() |
| .any(|p| !p.is_set(ArgSettings::Required)) |
| && !(p.has_visible_subcommands() || p.is_set(AS::AllowExternalSubcommands)) |
| && !has_last |
| { |
| usage.push_str(<span class="string">" [--]"</span>); |
| } |
| <span class="kw">let </span>not_req_or_hidden = |p: <span class="kw-2">&</span>PosBuilder| { |
| (!p.is_set(ArgSettings::Required) || p.is_set(ArgSettings::Last)) |
| && !p.is_set(ArgSettings::Hidden) |
| }; |
| <span class="kw">if </span>p.has_positionals() && p.positionals.values().any(not_req_or_hidden) { |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(args_tag) = get_args_tag(p, incl_reqs) { |
| usage.push_str(<span class="kw-2">&*</span>args_tag); |
| } <span class="kw">else </span>{ |
| usage.push_str(<span class="string">" [ARGS]"</span>); |
| } |
| <span class="kw">if </span>has_last && incl_reqs { |
| <span class="kw">let </span>pos = p |
| .positionals |
| .values() |
| .find(|p| p.b.is_set(ArgSettings::Last)) |
| .expect(INTERNAL_ERROR_MSG); |
| <span class="macro">debugln!</span>(<span class="string">"usage::create_help_usage: '{}' has .last(true)"</span>, pos.name()); |
| <span class="kw">let </span>req = pos.is_set(ArgSettings::Required); |
| <span class="kw">if </span>req |
| && p.positionals |
| .values() |
| .any(|p| !p.is_set(ArgSettings::Required)) |
| { |
| usage.push_str(<span class="string">" -- <"</span>); |
| } <span class="kw">else if </span>req { |
| usage.push_str(<span class="string">" [--] <"</span>); |
| } <span class="kw">else </span>{ |
| usage.push_str(<span class="string">" [-- <"</span>); |
| } |
| usage.push_str(<span class="kw-2">&*</span>pos.name_no_brackets()); |
| usage.push(<span class="string">'>'</span>); |
| usage.push_str(pos.multiple_str()); |
| <span class="kw">if </span>!req { |
| usage.push(<span class="string">']'</span>); |
| } |
| } |
| } |
| |
| <span class="comment">// incl_reqs is only false when this function is called recursively |
| </span><span class="kw">if </span>p.has_visible_subcommands() && incl_reqs || p.is_set(AS::AllowExternalSubcommands) { |
| <span class="kw">if </span>p.is_set(AS::SubcommandsNegateReqs) || p.is_set(AS::ArgsNegateSubcommands) { |
| usage.push_str(<span class="string">"\n "</span>); |
| <span class="kw">if </span>!p.is_set(AS::ArgsNegateSubcommands) { |
| usage.push_str(<span class="kw-2">&*</span>create_help_usage(p, <span class="bool-val">false</span>)); |
| } <span class="kw">else </span>{ |
| usage.push_str(<span class="kw-2">&*</span>name); |
| } |
| usage.push_str(<span class="string">" <SUBCOMMAND>"</span>); |
| } <span class="kw">else if </span>p.is_set(AS::SubcommandRequired) || p.is_set(AS::SubcommandRequiredElseHelp) { |
| usage.push_str(<span class="string">" <SUBCOMMAND>"</span>); |
| } <span class="kw">else </span>{ |
| usage.push_str(<span class="string">" [SUBCOMMAND]"</span>); |
| } |
| } |
| usage.shrink_to_fit(); |
| <span class="macro">debugln!</span>(<span class="string">"usage::create_help_usage: usage={}"</span>, usage); |
| usage |
| } |
| |
| <span class="comment">// Creates a context aware usage string, or "smart usage" from currently used |
| // args, and requirements |
| </span><span class="kw">fn </span>create_smart_usage(p: <span class="kw-2">&</span>Parser, used: <span class="kw-2">&</span>[<span class="kw-2">&</span>str]) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"usage::smart_usage;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>usage = String::with_capacity(<span class="number">75</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>hs: Vec<<span class="kw-2">&</span>str> = p.required().map(|s| <span class="kw-2">&**</span>s).collect(); |
| hs.extend_from_slice(used); |
| |
| <span class="kw">let </span>r_string = get_required_usage_from(p, <span class="kw-2">&</span>hs, <span class="prelude-val">None</span>, <span class="prelude-val">None</span>, <span class="bool-val">false</span>) |
| .iter() |
| .fold(String::new(), |acc, s| acc + <span class="kw-2">&</span><span class="macro">format!</span>(<span class="string">" {}"</span>, s)[..]); |
| |
| usage.push_str( |
| <span class="kw-2">&</span>p.meta |
| .usage |
| .as_ref() |
| .unwrap_or_else(|| p.meta.bin_name.as_ref().unwrap_or(<span class="kw-2">&</span>p.meta.name))[..], |
| ); |
| usage.push_str(<span class="kw-2">&*</span>r_string); |
| <span class="kw">if </span>p.is_set(AS::SubcommandRequired) { |
| usage.push_str(<span class="string">" <SUBCOMMAND>"</span>); |
| } |
| usage.shrink_to_fit(); |
| usage |
| } |
| |
| <span class="comment">// Gets the `[ARGS]` tag for the usage string |
| </span><span class="kw">fn </span>get_args_tag(p: <span class="kw-2">&</span>Parser, incl_reqs: bool) -> <span class="prelude-ty">Option</span><String> { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_args_tag;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>count = <span class="number">0</span>; |
| <span class="lifetime">'outer</span>: <span class="kw">for </span>pos <span class="kw">in </span>p |
| .positionals |
| .values() |
| .filter(|pos| !pos.is_set(ArgSettings::Required)) |
| .filter(|pos| !pos.is_set(ArgSettings::Hidden)) |
| .filter(|pos| !pos.is_set(ArgSettings::Last)) |
| { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_args_tag:iter:{}:"</span>, pos.b.name); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(g_vec) = p.groups_for_arg(pos.b.name) { |
| <span class="kw">for </span>grp_s <span class="kw">in </span><span class="kw-2">&</span>g_vec { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_args_tag:iter:{}:iter:{};"</span>, pos.b.name, grp_s); |
| <span class="comment">// if it's part of a required group we don't want to count it |
| </span><span class="kw">if </span>p.groups.iter().any(|g| g.required && (<span class="kw-2">&</span>g.name == grp_s)) { |
| <span class="kw">continue </span><span class="lifetime">'outer</span>; |
| } |
| } |
| } |
| count += <span class="number">1</span>; |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_args_tag:iter: {} Args not required or hidden"</span>, |
| count |
| ); |
| } |
| <span class="kw">if </span>!p.is_set(AS::DontCollapseArgsInUsage) && count > <span class="number">1 </span>{ |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_args_tag:iter: More than one, returning [ARGS]"</span>); |
| <span class="kw">return </span><span class="prelude-val">None</span>; <span class="comment">// [ARGS] |
| </span>} <span class="kw">else if </span>count == <span class="number">1 </span>&& incl_reqs { |
| <span class="kw">let </span>pos = p |
| .positionals |
| .values() |
| .find(|pos| { |
| !pos.is_set(ArgSettings::Required) |
| && !pos.is_set(ArgSettings::Hidden) |
| && !pos.is_set(ArgSettings::Last) |
| }) |
| .expect(INTERNAL_ERROR_MSG); |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_args_tag:iter: Exactly one, returning '{}'"</span>, |
| pos.name() |
| ); |
| <span class="kw">return </span><span class="prelude-val">Some</span>(<span class="macro">format!</span>( |
| <span class="string">" [{}]{}"</span>, |
| pos.name_no_brackets(), |
| pos.multiple_str() |
| )); |
| } <span class="kw">else if </span>p.is_set(AS::DontCollapseArgsInUsage) && !p.positionals.is_empty() && incl_reqs { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_args_tag:iter: Don't collapse returning all"</span>); |
| <span class="kw">return </span><span class="prelude-val">Some</span>( |
| p.positionals |
| .values() |
| .filter(|pos| !pos.is_set(ArgSettings::Required)) |
| .filter(|pos| !pos.is_set(ArgSettings::Hidden)) |
| .filter(|pos| !pos.is_set(ArgSettings::Last)) |
| .map(|pos| <span class="macro">format!</span>(<span class="string">" [{}]{}"</span>, pos.name_no_brackets(), pos.multiple_str())) |
| .collect::<Vec<<span class="kw">_</span>>>() |
| .join(<span class="string">""</span>), |
| ); |
| } <span class="kw">else if </span>!incl_reqs { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_args_tag:iter: incl_reqs=false, building secondary usage string"</span>); |
| <span class="kw">let </span>highest_req_pos = p |
| .positionals |
| .iter() |
| .filter_map(|(idx, pos)| { |
| <span class="kw">if </span>pos.b.is_set(ArgSettings::Required) && !pos.b.is_set(ArgSettings::Last) { |
| <span class="prelude-val">Some</span>(idx) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| }) |
| .max() |
| .unwrap_or_else(|| p.positionals.len()); |
| <span class="kw">return </span><span class="prelude-val">Some</span>( |
| p.positionals |
| .iter() |
| .filter_map(|(idx, pos)| { |
| <span class="kw">if </span>idx <= highest_req_pos { |
| <span class="prelude-val">Some</span>(pos) |
| } <span class="kw">else </span>{ |
| <span class="prelude-val">None |
| </span>} |
| }) |
| .filter(|pos| !pos.is_set(ArgSettings::Required)) |
| .filter(|pos| !pos.is_set(ArgSettings::Hidden)) |
| .filter(|pos| !pos.is_set(ArgSettings::Last)) |
| .map(|pos| <span class="macro">format!</span>(<span class="string">" [{}]{}"</span>, pos.name_no_brackets(), pos.multiple_str())) |
| .collect::<Vec<<span class="kw">_</span>>>() |
| .join(<span class="string">""</span>), |
| ); |
| } |
| <span class="prelude-val">Some</span>(<span class="string">""</span>.into()) |
| } |
| |
| <span class="comment">// Determines if we need the `[FLAGS]` tag in the usage string |
| </span><span class="kw">fn </span>needs_flags_tag(p: <span class="kw-2">&</span>Parser) -> bool { |
| <span class="macro">debugln!</span>(<span class="string">"usage::needs_flags_tag;"</span>); |
| <span class="lifetime">'outer</span>: <span class="kw">for </span>f <span class="kw">in </span><span class="kw-2">&</span>p.flags { |
| <span class="macro">debugln!</span>(<span class="string">"usage::needs_flags_tag:iter: f={};"</span>, f.b.name); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(l) = f.s.long { |
| <span class="kw">if </span>l == <span class="string">"help" </span>|| l == <span class="string">"version" </span>{ |
| <span class="comment">// Don't print `[FLAGS]` just for help or version |
| </span><span class="kw">continue</span>; |
| } |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(g_vec) = p.groups_for_arg(f.b.name) { |
| <span class="kw">for </span>grp_s <span class="kw">in </span><span class="kw-2">&</span>g_vec { |
| <span class="macro">debugln!</span>(<span class="string">"usage::needs_flags_tag:iter:iter: grp_s={};"</span>, grp_s); |
| <span class="kw">if </span>p.groups.iter().any(|g| <span class="kw-2">&</span>g.name == grp_s && g.required) { |
| <span class="macro">debugln!</span>(<span class="string">"usage::needs_flags_tag:iter:iter: Group is required"</span>); |
| <span class="kw">continue </span><span class="lifetime">'outer</span>; |
| } |
| } |
| } |
| <span class="kw">if </span>f.is_set(ArgSettings::Hidden) { |
| <span class="kw">continue</span>; |
| } |
| <span class="macro">debugln!</span>(<span class="string">"usage::needs_flags_tag:iter: [FLAGS] required"</span>); |
| <span class="kw">return </span><span class="bool-val">true</span>; |
| } |
| |
| <span class="macro">debugln!</span>(<span class="string">"usage::needs_flags_tag: [FLAGS] not required"</span>); |
| <span class="bool-val">false |
| </span>} |
| |
| <span class="comment">// Returns the required args in usage string form by fully unrolling all groups |
| </span><span class="kw">pub fn </span>get_required_usage_from<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>( |
| p: <span class="kw-2">&</span>Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>, |
| reqs: <span class="kw-2">&</span>[<span class="kw-2">&</span><span class="lifetime">'a </span>str], |
| matcher: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>ArgMatcher<<span class="lifetime">'a</span>>>, |
| extra: <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str>, |
| incl_last: bool, |
| ) -> VecDeque<String> { |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from: reqs={:?}, extra={:?}"</span>, |
| reqs, |
| extra |
| ); |
| <span class="kw">let </span><span class="kw-2">mut </span>desc_reqs: Vec<<span class="kw-2">&</span>str> = <span class="macro">vec!</span>[]; |
| desc_reqs.extend(extra); |
| <span class="kw">let </span><span class="kw-2">mut </span>new_reqs: Vec<<span class="kw-2">&</span>str> = <span class="macro">vec!</span>[]; |
| <span class="macro">macro_rules! </span>get_requires { |
| (@group <span class="macro-nonterminal">$a</span>: ident, <span class="macro-nonterminal">$v</span>:ident, <span class="macro-nonterminal">$p</span>:ident) => {{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(rl) = p |
| .groups |
| .iter() |
| .filter(|g| g.requires.is_some()) |
| .find(|g| <span class="kw-2">&</span>g.name == <span class="macro-nonterminal">$a</span>) |
| .map(|g| g.requires.as_ref().unwrap()) |
| { |
| <span class="kw">for </span>r <span class="kw">in </span>rl { |
| <span class="kw">if </span>!<span class="macro-nonterminal">$p</span>.contains(<span class="kw-2">&</span>r) { |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from:iter:{}: adding group req={:?}"</span>, |
| <span class="macro-nonterminal">$a</span>, |
| r |
| ); |
| <span class="macro-nonterminal">$v</span>.push(r); |
| } |
| } |
| } |
| }}; |
| (<span class="macro-nonterminal">$a</span>:ident, <span class="macro-nonterminal">$what</span>:ident, <span class="macro-nonterminal">$how</span>:ident, <span class="macro-nonterminal">$v</span>:ident, <span class="macro-nonterminal">$p</span>:ident) => {{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(rl) = p |
| .<span class="macro-nonterminal">$what |
| </span>.<span class="macro-nonterminal">$how</span>() |
| .filter(|a| a.b.requires.is_some()) |
| .find(|arg| <span class="kw-2">&</span>arg.b.name == <span class="macro-nonterminal">$a</span>) |
| .map(|a| a.b.requires.as_ref().unwrap()) |
| { |
| <span class="kw">for </span><span class="kw-2">&</span>(<span class="kw">_</span>, r) <span class="kw">in </span>rl.iter() { |
| <span class="kw">if </span>!<span class="macro-nonterminal">$p</span>.contains(<span class="kw-2">&</span>r) { |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from:iter:{}: adding arg req={:?}"</span>, |
| <span class="macro-nonterminal">$a</span>, |
| r |
| ); |
| <span class="macro-nonterminal">$v</span>.push(r); |
| } |
| } |
| } |
| }}; |
| } |
| <span class="comment">// initialize new_reqs |
| </span><span class="kw">for </span>a <span class="kw">in </span>reqs { |
| <span class="macro">get_requires!</span>(a, flags, iter, new_reqs, reqs); |
| <span class="macro">get_requires!</span>(a, opts, iter, new_reqs, reqs); |
| <span class="macro">get_requires!</span>(a, positionals, values, new_reqs, reqs); |
| <span class="macro">get_requires!</span>(@group a, new_reqs, reqs); |
| } |
| desc_reqs.extend_from_slice(<span class="kw-2">&*</span>new_reqs); |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from: after init desc_reqs={:?}"</span>, |
| desc_reqs |
| ); |
| <span class="kw">loop </span>{ |
| <span class="kw">let </span><span class="kw-2">mut </span>tmp = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>a <span class="kw">in </span><span class="kw-2">&</span>new_reqs { |
| <span class="macro">get_requires!</span>(a, flags, iter, tmp, desc_reqs); |
| <span class="macro">get_requires!</span>(a, opts, iter, tmp, desc_reqs); |
| <span class="macro">get_requires!</span>(a, positionals, values, tmp, desc_reqs); |
| <span class="macro">get_requires!</span>(@group a, tmp, desc_reqs); |
| } |
| <span class="kw">if </span>tmp.is_empty() { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_required_usage_from: no more children"</span>); |
| <span class="kw">break</span>; |
| } <span class="kw">else </span>{ |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_required_usage_from: after iter tmp={:?}"</span>, tmp); |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from: after iter new_reqs={:?}"</span>, |
| new_reqs |
| ); |
| desc_reqs.extend_from_slice(<span class="kw-2">&*</span>new_reqs); |
| new_reqs.clear(); |
| new_reqs.extend_from_slice(<span class="kw-2">&*</span>tmp); |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from: after iter desc_reqs={:?}"</span>, |
| desc_reqs |
| ); |
| } |
| } |
| desc_reqs.extend_from_slice(reqs); |
| desc_reqs.sort_unstable(); |
| desc_reqs.dedup(); |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from: final desc_reqs={:?}"</span>, |
| desc_reqs |
| ); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret_val = VecDeque::new(); |
| <span class="kw">let </span>args_in_groups = p |
| .groups |
| .iter() |
| .filter(|gn| desc_reqs.contains(<span class="kw-2">&</span>gn.name)) |
| .flat_map(|g| p.arg_names_in_group(g.name)) |
| .collect::<Vec<<span class="kw">_</span>>>(); |
| |
| <span class="kw">let </span>pmap = <span class="kw">if let </span><span class="prelude-val">Some</span>(m) = matcher { |
| desc_reqs |
| .iter() |
| .filter(|a| p.positionals.values().any(|p| &&p.b.name == a)) |
| .filter(|<span class="kw-2">&</span>pos| !m.contains(pos)) |
| .filter_map(|pos| p.positionals.values().find(|x| <span class="kw-2">&</span>x.b.name == pos)) |
| .filter(|<span class="kw-2">&</span>pos| incl_last || !pos.is_set(ArgSettings::Last)) |
| .filter(|pos| !args_in_groups.contains(<span class="kw-2">&</span>pos.b.name)) |
| .map(|pos| (pos.index, pos)) |
| .collect::<BTreeMap<u64, <span class="kw-2">&</span>PosBuilder>>() <span class="comment">// sort by index |
| </span>} <span class="kw">else </span>{ |
| desc_reqs |
| .iter() |
| .filter(|a| p.positionals.values().any(|pos| &&pos.b.name == a)) |
| .filter_map(|pos| p.positionals.values().find(|x| <span class="kw-2">&</span>x.b.name == pos)) |
| .filter(|<span class="kw-2">&</span>pos| incl_last || !pos.is_set(ArgSettings::Last)) |
| .filter(|pos| !args_in_groups.contains(<span class="kw-2">&</span>pos.b.name)) |
| .map(|pos| (pos.index, pos)) |
| .collect::<BTreeMap<u64, <span class="kw-2">&</span>PosBuilder>>() <span class="comment">// sort by index |
| </span>}; |
| <span class="macro">debugln!</span>( |
| <span class="string">"usage::get_required_usage_from: args_in_groups={:?}"</span>, |
| args_in_groups |
| ); |
| <span class="kw">for </span><span class="kw-2">&</span>p <span class="kw">in </span>pmap.values() { |
| <span class="kw">let </span>s = p.to_string(); |
| <span class="kw">if </span>args_in_groups.is_empty() || !args_in_groups.contains(&&<span class="kw-2">*</span>s) { |
| ret_val.push_back(s); |
| } |
| } |
| <span class="kw">for </span>a <span class="kw">in </span>desc_reqs |
| .iter() |
| .filter(|name| !p.positionals.values().any(|p| &&p.b.name == name)) |
| .filter(|name| !p.groups.iter().any(|g| &&g.name == name)) |
| .filter(|name| !args_in_groups.contains(name)) |
| .filter(|name| !(matcher.is_some() && matcher.as_ref().unwrap().contains(name))) |
| { |
| <span class="macro">debugln!</span>(<span class="string">"usage::get_required_usage_from:iter:{}:"</span>, a); |
| <span class="kw">let </span>arg = <span class="macro">find_by_name!</span>(p, <span class="kw-2">*</span>a, flags, iter) |
| .map(|f| f.to_string()) |
| .unwrap_or_else(|| { |
| <span class="macro">find_by_name!</span>(p, <span class="kw-2">*</span>a, opts, iter) |
| .map(|o| o.to_string()) |
| .expect(INTERNAL_ERROR_MSG) |
| }); |
| ret_val.push_back(arg); |
| } |
| <span class="kw">let </span><span class="kw-2">mut </span>g_vec: Vec<String> = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>g <span class="kw">in </span>desc_reqs |
| .iter() |
| .filter(|n| p.groups.iter().any(|g| &&g.name == n)) |
| { |
| <span class="kw">let </span>g_string = p.args_in_group(g).join(<span class="string">"|"</span>); |
| <span class="kw">let </span>elem = <span class="macro">format!</span>(<span class="string">"<{}>"</span>, <span class="kw-2">&</span>g_string[..g_string.len()]); |
| <span class="kw">if </span>!g_vec.contains(<span class="kw-2">&</span>elem) { |
| g_vec.push(elem); |
| } |
| } |
| <span class="kw">for </span>g <span class="kw">in </span>g_vec { |
| ret_val.push_back(g); |
| } |
| |
| ret_val |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../../" data-current-crate="clap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
