| <!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/completions/zsh.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>zsh.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> |
| </pre><pre class="rust"><code><span class="comment">// Std |
| </span><span class="attribute">#[allow(deprecated, unused_imports)] |
| </span><span class="kw">use </span>std::{ascii::AsciiExt, io::Write}; |
| |
| <span class="comment">// Internal |
| </span><span class="kw">use crate</span>::{ |
| app::{parser::Parser, App}, |
| args::{AnyArg, ArgSettings}, |
| completions, INTERNAL_ERROR_MSG, |
| }; |
| |
| <span class="kw">pub struct </span>ZshGen<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> |
| <span class="kw">where |
| </span><span class="lifetime">'a</span>: <span class="lifetime">'b</span>, |
| { |
| p: <span class="kw-2">&</span><span class="lifetime">'b </span>Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>, |
| } |
| |
| <span class="kw">impl</span><<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> ZshGen<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> { |
| <span class="kw">pub fn </span>new(p: <span class="kw-2">&</span><span class="lifetime">'b </span>Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>) -> <span class="self">Self </span>{ |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::new;"</span>); |
| ZshGen { p } |
| } |
| |
| <span class="kw">pub fn </span>generate_to<W: Write>(<span class="kw-2">&</span><span class="self">self</span>, buf: <span class="kw-2">&mut </span>W) { |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::generate_to;"</span>); |
| <span class="macro">w!</span>( |
| buf, |
| <span class="macro">format!</span>( |
| <span class="string">"\ |
| #compdef {name} |
| |
| autoload -U is-at-least |
| |
| _{name}() {{ |
| typeset -A opt_args |
| typeset -a _arguments_options |
| local ret=1 |
| |
| if is-at-least 5.2; then |
| _arguments_options=(-s -S -C) |
| else |
| _arguments_options=(-s -C) |
| fi |
| |
| local context curcontext=\"$curcontext\" state line |
| {initial_args} |
| {subcommands} |
| }} |
| |
| {subcommand_details} |
| |
| _{name} \"$@\""</span>, |
| name = <span class="self">self</span>.p.meta.bin_name.as_ref().unwrap(), |
| initial_args = get_args_of(<span class="self">self</span>.p), |
| subcommands = get_subcommands_of(<span class="self">self</span>.p), |
| subcommand_details = subcommand_details(<span class="self">self</span>.p) |
| ) |
| .as_bytes() |
| ); |
| } |
| } |
| |
| <span class="comment">// Displays the commands of a subcommand |
| // (( $+functions[_[bin_name_underscore]_commands] )) || |
| // _[bin_name_underscore]_commands() { |
| // local commands; commands=( |
| // '[arg_name]:[arg_help]' |
| // ) |
| // _describe -t commands '[bin_name] commands' commands "$@" |
| // |
| // Where the following variables are present: |
| // [bin_name_underscore]: The full space delineated bin_name, where spaces have been replaced by |
| // underscore characters |
| // [arg_name]: The name of the subcommand |
| // [arg_help]: The help message of the subcommand |
| // [bin_name]: The full space delineated bin_name |
| // |
| // Here's a snippet from rustup: |
| // |
| // (( $+functions[_rustup_commands] )) || |
| // _rustup_commands() { |
| // local commands; commands=( |
| // 'show:Show the active and installed toolchains' |
| // 'update:Update Rust toolchains' |
| // # ... snip for brevity |
| // 'help:Prints this message or the help of the given subcommand(s)' |
| // ) |
| // _describe -t commands 'rustup commands' commands "$@" |
| // |
| </span><span class="kw">fn </span>subcommand_details(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::subcommand_details;"</span>); |
| <span class="comment">// First we do ourself |
| </span><span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[<span class="macro">format!</span>( |
| <span class="string">"\ |
| (( $+functions[_{bin_name_underscore}_commands] )) || |
| _{bin_name_underscore}_commands() {{ |
| local commands; commands=( |
| {subcommands_and_args} |
| ) |
| _describe -t commands '{bin_name} commands' commands \"$@\" |
| }}"</span>, |
| bin_name_underscore = p.meta.bin_name.as_ref().unwrap().replace(<span class="string">" "</span>, <span class="string">"__"</span>), |
| bin_name = p.meta.bin_name.as_ref().unwrap(), |
| subcommands_and_args = subcommands_of(p) |
| )]; |
| |
| <span class="comment">// Next we start looping through all the children, grandchildren, etc. |
| </span><span class="kw">let </span><span class="kw-2">mut </span>all_subcommands = completions::all_subcommands(p); |
| all_subcommands.sort(); |
| all_subcommands.dedup(); |
| <span class="kw">for </span><span class="kw-2">&</span>(<span class="kw">_</span>, <span class="kw-2">ref </span>bin_name) <span class="kw">in </span><span class="kw-2">&</span>all_subcommands { |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::subcommand_details:iter: bin_name={}"</span>, bin_name); |
| ret.push(<span class="macro">format!</span>( |
| <span class="string">"\ |
| (( $+functions[_{bin_name_underscore}_commands] )) || |
| _{bin_name_underscore}_commands() {{ |
| local commands; commands=( |
| {subcommands_and_args} |
| ) |
| _describe -t commands '{bin_name} commands' commands \"$@\" |
| }}"</span>, |
| bin_name_underscore = bin_name.replace(<span class="string">" "</span>, <span class="string">"__"</span>), |
| bin_name = bin_name, |
| subcommands_and_args = subcommands_of(parser_of(p, bin_name)) |
| )); |
| } |
| |
| ret.join(<span class="string">"\n"</span>) |
| } |
| |
| <span class="comment">// Generates subcommand completions in form of |
| // |
| // '[arg_name]:[arg_help]' |
| // |
| // Where: |
| // [arg_name]: the subcommand's name |
| // [arg_help]: the help message of the subcommand |
| // |
| // A snippet from rustup: |
| // 'show:Show the active and installed toolchains' |
| // 'update:Update Rust toolchains' |
| </span><span class="kw">fn </span>subcommands_of(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::subcommands_of;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[]; |
| <span class="kw">fn </span>add_sc(sc: <span class="kw-2">&</span>App, n: <span class="kw-2">&</span>str, ret: <span class="kw-2">&mut </span>Vec<String>) { |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::add_sc;"</span>); |
| <span class="kw">let </span>s = <span class="macro">format!</span>( |
| <span class="string">"\"{name}:{help}\" \\"</span>, |
| name = n, |
| help = |
| sc.p.meta |
| .about |
| .unwrap_or(<span class="string">""</span>) |
| .replace(<span class="string">"["</span>, <span class="string">"\\["</span>) |
| .replace(<span class="string">"]"</span>, <span class="string">"\\]"</span>) |
| ); |
| <span class="kw">if </span>!s.is_empty() { |
| ret.push(s); |
| } |
| } |
| |
| <span class="comment">// The subcommands |
| </span><span class="kw">for </span>sc <span class="kw">in </span>p.subcommands() { |
| <span class="macro">debugln!</span>(<span class="string">"ZshGen::subcommands_of:iter: subcommand={}"</span>, sc.p.meta.name); |
| add_sc(sc, <span class="kw-2">&</span>sc.p.meta.name, <span class="kw-2">&mut </span>ret); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>v) = sc.p.meta.aliases { |
| <span class="kw">for </span>alias <span class="kw">in </span>v.iter().filter(|&&(<span class="kw">_</span>, vis)| vis).map(|<span class="kw-2">&</span>(n, <span class="kw">_</span>)| n) { |
| add_sc(sc, alias, <span class="kw-2">&mut </span>ret); |
| } |
| } |
| } |
| |
| ret.join(<span class="string">"\n"</span>) |
| } |
| |
| <span class="comment">// Get's the subcommand section of a completion file |
| // This looks roughly like: |
| // |
| // case $state in |
| // ([bin_name]_args) |
| // curcontext=\"${curcontext%:*:*}:[name_hyphen]-command-$words[1]:\" |
| // case $line[1] in |
| // |
| // ([name]) |
| // _arguments -C -s -S \ |
| // [subcommand_args] |
| // && ret=0 |
| // |
| // [RECURSIVE_CALLS] |
| // |
| // ;;", |
| // |
| // [repeat] |
| // |
| // esac |
| // ;; |
| // esac", |
| // |
| // Where the following variables are present: |
| // [name] = The subcommand name in the form of "install" for "rustup toolchain install" |
| // [bin_name] = The full space delineated bin_name such as "rustup toolchain install" |
| // [name_hyphen] = The full space delineated bin_name, but replace spaces with hyphens |
| // [repeat] = From the same recursive calls, but for all subcommands |
| // [subcommand_args] = The same as zsh::get_args_of |
| </span><span class="kw">fn </span>get_subcommands_of(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"get_subcommands_of;"</span>); |
| |
| <span class="macro">debugln!</span>( |
| <span class="string">"get_subcommands_of: Has subcommands...{:?}"</span>, |
| p.has_subcommands() |
| ); |
| <span class="kw">if </span>!p.has_subcommands() { |
| <span class="kw">return </span>String::new(); |
| } |
| |
| <span class="kw">let </span>sc_names = completions::subcommands_of(p); |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>subcmds = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span><span class="kw-2">&</span>(<span class="kw-2">ref </span>name, <span class="kw-2">ref </span>bin_name) <span class="kw">in </span><span class="kw-2">&</span>sc_names { |
| <span class="kw">let </span><span class="kw-2">mut </span>v = <span class="macro">vec!</span>[<span class="macro">format!</span>(<span class="string">"({})"</span>, name)]; |
| <span class="kw">let </span>subcommand_args = get_args_of(parser_of(p, <span class="kw-2">&*</span>bin_name)); |
| <span class="kw">if </span>!subcommand_args.is_empty() { |
| v.push(subcommand_args); |
| } |
| <span class="kw">let </span>subcommands = get_subcommands_of(parser_of(p, <span class="kw-2">&*</span>bin_name)); |
| <span class="kw">if </span>!subcommands.is_empty() { |
| v.push(subcommands); |
| } |
| v.push(String::from(<span class="string">";;"</span>)); |
| subcmds.push(v.join(<span class="string">"\n"</span>)); |
| } |
| |
| <span class="macro">format!</span>( |
| <span class="string">"case $state in |
| ({name}) |
| words=($line[{pos}] \"${{words[@]}}\") |
| (( CURRENT += 1 )) |
| curcontext=\"${{curcontext%:*:*}}:{name_hyphen}-command-$line[{pos}]:\" |
| case $line[{pos}] in |
| {subcommands} |
| esac |
| ;; |
| esac"</span>, |
| name = p.meta.name, |
| name_hyphen = p.meta.bin_name.as_ref().unwrap().replace(<span class="string">" "</span>, <span class="string">"-"</span>), |
| subcommands = subcmds.join(<span class="string">"\n"</span>), |
| pos = p.positionals().len() + <span class="number">1 |
| </span>) |
| } |
| |
| <span class="kw">fn </span>parser_of<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>(p: <span class="kw-2">&</span><span class="lifetime">'b </span>Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>>, sc: <span class="kw-2">&</span>str) -> <span class="kw-2">&</span><span class="lifetime">'b </span>Parser<<span class="lifetime">'a</span>, <span class="lifetime">'b</span>> { |
| <span class="macro">debugln!</span>(<span class="string">"parser_of: sc={}"</span>, sc); |
| <span class="kw">if </span>sc == p.meta.bin_name.as_ref().unwrap_or(<span class="kw-2">&</span>String::new()) { |
| <span class="kw">return </span>p; |
| } |
| <span class="kw-2">&</span>p.find_subcommand(sc).expect(INTERNAL_ERROR_MSG).p |
| } |
| |
| <span class="comment">// Writes out the args section, which ends up being the flags, opts and postionals, and a jump to |
| // another ZSH function if there are subcommands. |
| // The structer works like this: |
| // ([conflicting_args]) [multiple] arg [takes_value] [[help]] [: :(possible_values)] |
| // ^-- list '-v -h' ^--'*' ^--'+' ^-- list 'one two three' |
| // |
| // An example from the rustup command: |
| // |
| // _arguments -C -s -S \ |
| // '(-h --help --verbose)-v[Enable verbose output]' \ |
| // '(-V -v --version --verbose --help)-h[Prints help information]' \ |
| // # ... snip for brevity |
| // ':: :_rustup_commands' \ # <-- displays subcommands |
| // '*::: :->rustup' \ # <-- displays subcommand args and child subcommands |
| // && ret=0 |
| // |
| // The args used for _arguments are as follows: |
| // -C: modify the $context internal variable |
| // -s: Allow stacking of short args (i.e. -a -b -c => -abc) |
| // -S: Do not complete anything after '--' and treat those as argument values |
| </span><span class="kw">fn </span>get_args_of(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"get_args_of;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[String::from(<span class="string">"_arguments \"${_arguments_options[@]}\" \\"</span>)]; |
| <span class="kw">let </span>opts = write_opts_of(p); |
| <span class="kw">let </span>flags = write_flags_of(p); |
| <span class="kw">let </span>positionals = write_positionals_of(p); |
| <span class="kw">let </span>sc_or_a = <span class="kw">if </span>p.has_subcommands() { |
| <span class="macro">format!</span>( |
| <span class="string">"\":: :_{name}_commands\" \\"</span>, |
| name = p.meta.bin_name.as_ref().unwrap().replace(<span class="string">" "</span>, <span class="string">"__"</span>) |
| ) |
| } <span class="kw">else </span>{ |
| String::new() |
| }; |
| <span class="kw">let </span>sc = <span class="kw">if </span>p.has_subcommands() { |
| <span class="macro">format!</span>(<span class="string">"\"*::: :->{name}\" \\"</span>, name = p.meta.name) |
| } <span class="kw">else </span>{ |
| String::new() |
| }; |
| |
| <span class="kw">if </span>!opts.is_empty() { |
| ret.push(opts); |
| } |
| <span class="kw">if </span>!flags.is_empty() { |
| ret.push(flags); |
| } |
| <span class="kw">if </span>!positionals.is_empty() { |
| ret.push(positionals); |
| } |
| <span class="kw">if </span>!sc_or_a.is_empty() { |
| ret.push(sc_or_a); |
| } |
| <span class="kw">if </span>!sc.is_empty() { |
| ret.push(sc); |
| } |
| ret.push(String::from(<span class="string">"&& ret=0"</span>)); |
| |
| ret.join(<span class="string">"\n"</span>) |
| } |
| |
| <span class="comment">// Escape help string inside single quotes and brackets |
| </span><span class="kw">fn </span>escape_help(string: <span class="kw-2">&</span>str) -> String { |
| string |
| .replace(<span class="string">"\\"</span>, <span class="string">"\\\\"</span>) |
| .replace(<span class="string">"'"</span>, <span class="string">"'\\''"</span>) |
| .replace(<span class="string">"["</span>, <span class="string">"\\["</span>) |
| .replace(<span class="string">"]"</span>, <span class="string">"\\]"</span>) |
| } |
| |
| <span class="comment">// Escape value string inside single quotes and parentheses |
| </span><span class="kw">fn </span>escape_value(string: <span class="kw-2">&</span>str) -> String { |
| string |
| .replace(<span class="string">"\\"</span>, <span class="string">"\\\\"</span>) |
| .replace(<span class="string">"'"</span>, <span class="string">"'\\''"</span>) |
| .replace(<span class="string">"("</span>, <span class="string">"\\("</span>) |
| .replace(<span class="string">")"</span>, <span class="string">"\\)"</span>) |
| .replace(<span class="string">" "</span>, <span class="string">"\\ "</span>) |
| } |
| |
| <span class="kw">fn </span>write_opts_of(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"write_opts_of;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>o <span class="kw">in </span>p.opts() { |
| <span class="macro">debugln!</span>(<span class="string">"write_opts_of:iter: o={}"</span>, o.name()); |
| <span class="kw">let </span>help = o.help().map_or(String::new(), escape_help); |
| <span class="kw">let </span><span class="kw-2">mut </span>conflicts = <span class="macro">get_zsh_arg_conflicts!</span>(p, o, INTERNAL_ERROR_MSG); |
| conflicts = <span class="kw">if </span>conflicts.is_empty() { |
| String::new() |
| } <span class="kw">else </span>{ |
| <span class="macro">format!</span>(<span class="string">"({})"</span>, conflicts) |
| }; |
| |
| <span class="kw">let </span>multiple = <span class="kw">if </span>o.is_set(ArgSettings::Multiple) { |
| <span class="string">"*" |
| </span>} <span class="kw">else </span>{ |
| <span class="string">"" |
| </span>}; |
| <span class="kw">let </span>pv = <span class="kw">if let </span><span class="prelude-val">Some</span>(pv_vec) = o.possible_vals() { |
| <span class="macro">format!</span>( |
| <span class="string">": :({})"</span>, |
| pv_vec |
| .iter() |
| .map(|v| escape_value(<span class="kw-2">*</span>v)) |
| .collect::<Vec<String>>() |
| .join(<span class="string">" "</span>) |
| ) |
| } <span class="kw">else </span>{ |
| String::new() |
| }; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(short) = o.short() { |
| <span class="kw">let </span>s = <span class="macro">format!</span>( |
| <span class="string">"'{conflicts}{multiple}-{arg}+[{help}]{possible_values}' \\"</span>, |
| conflicts = conflicts, |
| multiple = multiple, |
| arg = short, |
| possible_values = pv, |
| help = help |
| ); |
| |
| <span class="macro">debugln!</span>(<span class="string">"write_opts_of:iter: Wrote...{}"</span>, <span class="kw-2">&*</span>s); |
| ret.push(s); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(long) = o.long() { |
| <span class="kw">let </span>l = <span class="macro">format!</span>( |
| <span class="string">"'{conflicts}{multiple}--{arg}=[{help}]{possible_values}' \\"</span>, |
| conflicts = conflicts, |
| multiple = multiple, |
| arg = long, |
| possible_values = pv, |
| help = help |
| ); |
| |
| <span class="macro">debugln!</span>(<span class="string">"write_opts_of:iter: Wrote...{}"</span>, <span class="kw-2">&*</span>l); |
| ret.push(l); |
| } |
| } |
| |
| ret.join(<span class="string">"\n"</span>) |
| } |
| |
| <span class="kw">fn </span>write_flags_of(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"write_flags_of;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>f <span class="kw">in </span>p.flags() { |
| <span class="macro">debugln!</span>(<span class="string">"write_flags_of:iter: f={}"</span>, f.name()); |
| <span class="kw">let </span>help = f.help().map_or(String::new(), escape_help); |
| <span class="kw">let </span><span class="kw-2">mut </span>conflicts = <span class="macro">get_zsh_arg_conflicts!</span>(p, f, INTERNAL_ERROR_MSG); |
| conflicts = <span class="kw">if </span>conflicts.is_empty() { |
| String::new() |
| } <span class="kw">else </span>{ |
| <span class="macro">format!</span>(<span class="string">"({})"</span>, conflicts) |
| }; |
| |
| <span class="kw">let </span>multiple = <span class="kw">if </span>f.is_set(ArgSettings::Multiple) { |
| <span class="string">"*" |
| </span>} <span class="kw">else </span>{ |
| <span class="string">"" |
| </span>}; |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(short) = f.short() { |
| <span class="kw">let </span>s = <span class="macro">format!</span>( |
| <span class="string">"'{conflicts}{multiple}-{arg}[{help}]' \\"</span>, |
| multiple = multiple, |
| conflicts = conflicts, |
| arg = short, |
| help = help |
| ); |
| |
| <span class="macro">debugln!</span>(<span class="string">"write_flags_of:iter: Wrote...{}"</span>, <span class="kw-2">&*</span>s); |
| ret.push(s); |
| } |
| |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(long) = f.long() { |
| <span class="kw">let </span>l = <span class="macro">format!</span>( |
| <span class="string">"'{conflicts}{multiple}--{arg}[{help}]' \\"</span>, |
| conflicts = conflicts, |
| multiple = multiple, |
| arg = long, |
| help = help |
| ); |
| |
| <span class="macro">debugln!</span>(<span class="string">"write_flags_of:iter: Wrote...{}"</span>, <span class="kw-2">&*</span>l); |
| ret.push(l); |
| } |
| } |
| |
| ret.join(<span class="string">"\n"</span>) |
| } |
| |
| <span class="kw">fn </span>write_positionals_of(p: <span class="kw-2">&</span>Parser) -> String { |
| <span class="macro">debugln!</span>(<span class="string">"write_positionals_of;"</span>); |
| <span class="kw">let </span><span class="kw-2">mut </span>ret = <span class="macro">vec!</span>[]; |
| <span class="kw">for </span>arg <span class="kw">in </span>p.positionals() { |
| <span class="macro">debugln!</span>(<span class="string">"write_positionals_of:iter: arg={}"</span>, arg.b.name); |
| <span class="kw">let </span>a = <span class="macro">format!</span>( |
| <span class="string">"'{optional}:{name}{help}:{action}' \\"</span>, |
| optional = <span class="kw">if </span>!arg.b.is_set(ArgSettings::Required) { |
| <span class="string">":" |
| </span>} <span class="kw">else </span>{ |
| <span class="string">"" |
| </span>}, |
| name = arg.b.name, |
| help = arg |
| .b |
| .help |
| .map_or(<span class="string">""</span>.to_owned(), |v| <span class="string">" -- "</span>.to_owned() + v) |
| .replace(<span class="string">"["</span>, <span class="string">"\\["</span>) |
| .replace(<span class="string">"]"</span>, <span class="string">"\\]"</span>), |
| action = arg.possible_vals().map_or(<span class="string">"_files"</span>.to_owned(), |values| { |
| <span class="macro">format!</span>( |
| <span class="string">"({})"</span>, |
| values |
| .iter() |
| .map(|v| escape_value(<span class="kw-2">*</span>v)) |
| .collect::<Vec<String>>() |
| .join(<span class="string">" "</span>) |
| ) |
| }) |
| ); |
| |
| <span class="macro">debugln!</span>(<span class="string">"write_positionals_of:iter: Wrote...{}"</span>, a); |
| ret.push(a); |
| } |
| |
| ret.join(<span class="string">"\n"</span>) |
| } |
| </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> |