| <!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/fish.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>fish.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> |
| </pre><pre class="rust"><code><span class="comment">// Std |
| </span><span class="kw">use </span>std::io::Write; |
| |
| <span class="comment">// Internal |
| </span><span class="kw">use </span><span class="kw">crate</span>::app::parser::Parser; |
| |
| <span class="kw">pub struct </span>FishGen<<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>> FishGen<<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>{ |
| FishGen { 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="kw">let </span>command = <span class="self">self</span>.p.meta.bin_name.as_ref().unwrap(); |
| <span class="kw">let </span><span class="kw-2">mut </span>buffer = String::new(); |
| gen_fish_inner(command, <span class="self">self</span>, command, <span class="kw-2">&mut </span>buffer); |
| <span class="macro">w!</span>(buf, buffer.as_bytes()); |
| } |
| } |
| |
| <span class="comment">// Escape string inside single quotes |
| </span><span class="kw">fn </span>escape_string(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>) |
| } |
| |
| <span class="kw">fn </span>gen_fish_inner(root_command: <span class="kw-2">&</span>str, comp_gen: <span class="kw-2">&</span>FishGen, subcommand: <span class="kw-2">&</span>str, buffer: <span class="kw-2">&mut </span>String) { |
| <span class="macro">debugln!</span>(<span class="string">"FishGen::gen_fish_inner;"</span>); |
| <span class="comment">// example : |
| // |
| // complete |
| // -c {command} |
| // -d "{description}" |
| // -s {short} |
| // -l {long} |
| // -a "{possible_arguments}" |
| // -r # if require parameter |
| // -f # don't use file completion |
| // -n "__fish_use_subcommand" # complete for command "myprog" |
| // -n "__fish_seen_subcommand_from subcmd1" # complete for command "myprog subcmd1" |
| |
| </span><span class="kw">let </span><span class="kw-2">mut </span>basic_template = <span class="macro">format!</span>(<span class="string">"complete -c {} -n "</span>, root_command); |
| <span class="kw">if </span>root_command == subcommand { |
| basic_template.push_str(<span class="string">"\"__fish_use_subcommand\""</span>); |
| } <span class="kw">else </span>{ |
| basic_template.push_str(<span class="macro">format!</span>(<span class="string">"\"__fish_seen_subcommand_from {}\""</span>, subcommand).as_str()); |
| } |
| |
| <span class="kw">for </span>option <span class="kw">in </span>comp_gen.p.opts() { |
| <span class="kw">let </span><span class="kw-2">mut </span>template = basic_template.clone(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = option.s.short { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -s {}"</span>, data).as_str()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = option.s.long { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -l {}"</span>, data).as_str()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = option.b.help { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -d '{}'"</span>, escape_string(data)).as_str()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">ref </span>data) = option.v.possible_vals { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -r -f -a \"{}\""</span>, data.join(<span class="string">" "</span>)).as_str()); |
| } |
| buffer.push_str(template.as_str()); |
| buffer.push(<span class="string">'\n'</span>); |
| } |
| |
| <span class="kw">for </span>flag <span class="kw">in </span>comp_gen.p.flags() { |
| <span class="kw">let </span><span class="kw-2">mut </span>template = basic_template.clone(); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = flag.s.short { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -s {}"</span>, data).as_str()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = flag.s.long { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -l {}"</span>, data).as_str()); |
| } |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = flag.b.help { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -d '{}'"</span>, escape_string(data)).as_str()); |
| } |
| buffer.push_str(template.as_str()); |
| buffer.push(<span class="string">'\n'</span>); |
| } |
| |
| <span class="kw">for </span>subcommand <span class="kw">in </span><span class="kw-2">&</span>comp_gen.p.subcommands { |
| <span class="kw">let </span><span class="kw-2">mut </span>template = basic_template.clone(); |
| template.push_str(<span class="string">" -f"</span>); |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -a \"{}\""</span>, <span class="kw-2">&</span>subcommand.p.meta.name).as_str()); |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(data) = subcommand.p.meta.about { |
| template.push_str(<span class="macro">format!</span>(<span class="string">" -d '{}'"</span>, escape_string(data)).as_str()) |
| } |
| buffer.push_str(template.as_str()); |
| buffer.push(<span class="string">'\n'</span>); |
| } |
| |
| <span class="comment">// generate options of subcommands |
| </span><span class="kw">for </span>subcommand <span class="kw">in </span><span class="kw-2">&</span>comp_gen.p.subcommands { |
| <span class="kw">let </span>sub_comp_gen = FishGen::new(<span class="kw-2">&</span>subcommand.p); |
| gen_fish_inner(root_command, <span class="kw-2">&</span>sub_comp_gen, <span class="kw-2">&</span>subcommand.to_string(), buffer); |
| } |
| } |
| </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> |
