<!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 `abstutil/src/cli.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>cli.rs - source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg"> <link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"> <link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../abstutil/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button> <a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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> </pre><div class="example-wrap"><pre class="rust "> <span class="kw">use</span> <span class="ident">std</span>::<span class="ident">collections</span>::{<span class="ident">HashMap</span>, <span class="ident">HashSet</span>}; <span class="doccomment">/// Yet another barebones command-line flag parsing library.</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">CmdArgs</span> { <span class="ident">kv</span>: <span class="ident">HashMap</span><span class="op"><</span><span class="ident">String</span>, <span class="ident">String</span><span class="op">></span>, <span class="ident">bits</span>: <span class="ident">HashSet</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">free</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, <span class="ident">used</span>: <span class="ident">HashSet</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>, } <span class="kw">impl</span> <span class="ident">CmdArgs</span> { <span class="doccomment">/// On native, initialize with real flags. On web, transform URL query parameters into flags.</span> <span class="doccomment">///</span> <span class="doccomment">/// Calling this has the side-effect of initializing logging on both native and web. This</span> <span class="doccomment">/// should probably be done independently, but for the moment, every app wants both.</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-</span><span class="op">></span> <span class="ident">CmdArgs</span> { <span class="kw">crate</span>::<span class="ident">logger</span>::<span class="ident">setup</span>(); <span class="kw">if</span> <span class="macro">cfg</span><span class="macro">!</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>) { <span class="kw">let</span> <span class="ident">raw</span> <span class="op">=</span> <span class="kw">match</span> <span class="ident">parse_args</span>() { <span class="prelude-val">Ok</span>(<span class="ident">raw</span>) <span class="op">=</span><span class="op">></span> <span class="ident">raw</span>, <span class="prelude-val">Err</span>(<span class="ident">err</span>) <span class="op">=</span><span class="op">></span> { <span class="ident">log</span>::<span class="macro">warn</span><span class="macro">!</span>(<span class="string">"Didn't parse arguments from URL query params: {}"</span>, <span class="ident">err</span>); <span class="ident">Vec</span>::<span class="ident">new</span>() } }; <span class="ident">CmdArgs</span>::<span class="ident">from_args</span>(<span class="ident">raw</span>) } <span class="kw">else</span> { <span class="ident">CmdArgs</span>::<span class="ident">from_args</span>(<span class="ident">std</span>::<span class="ident">env</span>::<span class="ident">args</span>().<span class="ident">skip</span>(<span class="number">1</span>).<span class="ident">collect</span>()) } } <span class="kw">fn</span> <span class="ident">from_args</span>(<span class="ident">raw</span>: <span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span>) <span class="op">-</span><span class="op">></span> <span class="ident">CmdArgs</span> { <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">args</span> <span class="op">=</span> <span class="ident">CmdArgs</span> { <span class="ident">kv</span>: <span class="ident">HashMap</span>::<span class="ident">new</span>(), <span class="ident">bits</span>: <span class="ident">HashSet</span>::<span class="ident">new</span>(), <span class="ident">free</span>: <span class="ident">Vec</span>::<span class="ident">new</span>(), <span class="ident">used</span>: <span class="ident">HashSet</span>::<span class="ident">new</span>(), }; <span class="kw">for</span> <span class="ident">arg</span> <span class="kw">in</span> <span class="ident">raw</span> { <span class="kw">let</span> <span class="ident">parts</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> <span class="op">=</span> <span class="ident">arg</span>.<span class="ident">split</span>(<span class="string">'='</span>).<span class="ident">collect</span>(); <span class="kw">if</span> <span class="ident">parts</span>.<span class="ident">len</span>() <span class="op">=</span><span class="op">=</span> <span class="number">1</span> { <span class="kw">if</span> <span class="ident">arg</span>.<span class="ident">starts_with</span>(<span class="string">"--"</span>) { <span class="ident">args</span>.<span class="ident">bits</span>.<span class="ident">insert</span>(<span class="ident">arg</span>); } <span class="kw">else</span> { <span class="ident">args</span>.<span class="ident">free</span>.<span class="ident">push</span>(<span class="ident">arg</span>); } } <span class="kw">else</span> <span class="kw">if</span> <span class="ident">parts</span>.<span class="ident">len</span>() <span class="op">=</span><span class="op">=</span> <span class="number">2</span> { <span class="ident">args</span>.<span class="ident">kv</span>.<span class="ident">insert</span>(<span class="ident">parts</span>[<span class="number">0</span>].<span class="ident">to_string</span>(), <span class="ident">parts</span>[<span class="number">1</span>].<span class="ident">to_string</span>()); } <span class="kw">else</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Weird argument {}"</span>, <span class="ident">arg</span>); } } <span class="ident">args</span> } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">required</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> { <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">kv</span>.<span class="ident">remove</span>(<span class="ident">key</span>) { <span class="ident">value</span> } <span class="kw">else</span> { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Missing required arg {}"</span>, <span class="ident">key</span>); } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">optional</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> { <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">value</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">kv</span>.<span class="ident">remove</span>(<span class="ident">key</span>) { <span class="self">self</span>.<span class="ident">used</span>.<span class="ident">insert</span>(<span class="ident">key</span>.<span class="ident">to_string</span>()); <span class="prelude-val">Some</span>(<span class="ident">value</span>) } <span class="kw">else</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">used</span>.<span class="ident">contains</span>(<span class="ident">key</span>) { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"args.optional(\"{}\") called twice!"</span>, <span class="ident">key</span>); } <span class="kw">else</span> { <span class="prelude-val">None</span> } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">optional_parse</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span>, <span class="ident">F</span>: <span class="ident">Fn</span>(<span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">T</span>, <span class="ident">E</span><span class="op">></span><span class="op">></span>( <span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>, <span class="ident">parser</span>: <span class="ident">F</span>, ) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">T</span><span class="op">></span> { <span class="kw">let</span> <span class="ident">value</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">optional</span>(<span class="ident">key</span>)<span class="question-mark">?</span>; <span class="kw">match</span> <span class="ident">parser</span>(<span class="kw-2">&</span><span class="ident">value</span>) { <span class="prelude-val">Ok</span>(<span class="ident">result</span>) <span class="op">=</span><span class="op">></span> <span class="prelude-val">Some</span>(<span class="ident">result</span>), <span class="prelude-val">Err</span>(<span class="kw">_</span>) <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Bad argument {}={}"</span>, <span class="ident">key</span>, <span class="ident">value</span>), } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">true_false</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { <span class="kw">match</span> <span class="self">self</span>.<span class="ident">required</span>(<span class="ident">key</span>).<span class="ident">as_ref</span>() { <span class="string">"true"</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">true</span>, <span class="string">"false"</span> <span class="op">=</span><span class="op">></span> <span class="bool-val">false</span>, <span class="ident">x</span> <span class="op">=</span><span class="op">></span> <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"{}={} is invalid; must be true or false"</span>, <span class="ident">key</span>, <span class="ident">x</span>), } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">enabled</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">key</span>: <span class="kw-2">&</span><span class="ident">str</span>) <span class="op">-</span><span class="op">></span> <span class="ident">bool</span> { <span class="kw">if</span> <span class="self">self</span>.<span class="ident">bits</span>.<span class="ident">remove</span>(<span class="ident">key</span>) { <span class="self">self</span>.<span class="ident">used</span>.<span class="ident">insert</span>(<span class="ident">key</span>.<span class="ident">to_string</span>()); <span class="bool-val">true</span> } <span class="kw">else</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">used</span>.<span class="ident">contains</span>(<span class="ident">key</span>) { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"args.enabled(\"{}\") called twice!"</span>, <span class="ident">key</span>); } <span class="kw">else</span> { <span class="bool-val">false</span> } } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">required_free</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="ident">String</span> { <span class="kw">if</span> <span class="self">self</span>.<span class="ident">free</span>.<span class="ident">is_empty</span>() { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Required free argument not provided"</span>); } <span class="self">self</span>.<span class="ident">free</span>.<span class="ident">remove</span>(<span class="number">0</span>) } <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">optional_free</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) <span class="op">-</span><span class="op">></span> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">String</span><span class="op">></span> { <span class="kw">if</span> <span class="self">self</span>.<span class="ident">free</span>.<span class="ident">is_empty</span>() { <span class="prelude-val">None</span> } <span class="kw">else</span> { <span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="ident">free</span>.<span class="ident">remove</span>(<span class="number">0</span>)) } } <span class="comment">// TODO Drop?</span> <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">done</span>(<span class="kw-2">&</span><span class="kw-2">mut</span> <span class="self">self</span>) { <span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">kv</span>.<span class="ident">is_empty</span>() { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Unused arguments: {:?}"</span>, <span class="self">self</span>.<span class="ident">kv</span>); } <span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">bits</span>.<span class="ident">is_empty</span>() { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Unused arguments: {:?}"</span>, <span class="self">self</span>.<span class="ident">bits</span>); } <span class="kw">if</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">free</span>.<span class="ident">is_empty</span>() { <span class="macro">panic</span><span class="macro">!</span>(<span class="string">"Unused free arguments: {:?}"</span>, <span class="self">self</span>.<span class="ident">free</span>); } } } <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>)]</span> <span class="doccomment">/// Transform the URL query parameters into command-line arguments, by treating & as the separator</span> <span class="doccomment">/// between arguments. So for instance "?--dev&--color_scheme=night%20mode" becomes vec!["--dev",</span> <span class="doccomment">/// "--color_scheme=night mode"].</span> <span class="kw">fn</span> <span class="ident">parse_args</span>() <span class="op">-</span><span class="op">></span> <span class="ident">anyhow</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span> { <span class="kw">use</span> <span class="ident">anyhow</span>::{<span class="ident">anyhow</span>, <span class="ident">bail</span>}; <span class="kw">let</span> <span class="ident">window</span> <span class="op">=</span> <span class="ident">web_sys</span>::<span class="ident">window</span>().<span class="ident">ok_or</span>(<span class="macro">anyhow</span><span class="macro">!</span>(<span class="string">"no window?"</span>))<span class="question-mark">?</span>; <span class="kw">let</span> <span class="ident">url</span> <span class="op">=</span> <span class="ident">window</span>.<span class="ident">location</span>().<span class="ident">href</span>().<span class="ident">map_err</span>(<span class="op">|</span><span class="ident">err</span><span class="op">|</span> { <span class="macro">anyhow</span><span class="macro">!</span>(<span class="ident">err</span> .<span class="ident">as_string</span>() .<span class="ident">unwrap_or</span>(<span class="string">"window.location.href failed"</span>.<span class="ident">to_string</span>())) })<span class="question-mark">?</span>; <span class="comment">// Consider using a proper url parsing crate. This works fine for now, though.</span> <span class="kw">let</span> <span class="ident">url_parts</span> <span class="op">=</span> <span class="ident">url</span>.<span class="ident">split</span>(<span class="string">"?"</span>).<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(); <span class="kw">if</span> <span class="ident">url_parts</span>.<span class="ident">len</span>() <span class="op">!</span><span class="op">=</span> <span class="number">2</span> { <span class="macro">bail</span><span class="macro">!</span>(<span class="string">"URL {} doesn't seem to have query params"</span>); } <span class="kw">let</span> <span class="ident">parts</span> <span class="op">=</span> <span class="ident">url_parts</span>[<span class="number">1</span>] .<span class="ident">split</span>(<span class="string">"&"</span>) .<span class="ident">map</span>(<span class="op">|</span><span class="ident">x</span><span class="op">|</span> <span class="ident">x</span>.<span class="ident">replace</span>(<span class="string">"%20"</span>, <span class="string">" "</span>).<span class="ident">to_string</span>()) .<span class="ident">collect</span>::<span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span><span class="op">></span>(); <span class="prelude-val">Ok</span>(<span class="ident">parts</span>) } <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>))]</span> <span class="kw">fn</span> <span class="ident">parse_args</span>() <span class="op">-</span><span class="op">></span> <span class="ident">anyhow</span>::<span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">Vec</span><span class="op"><</span><span class="ident">String</span><span class="op">></span><span class="op">></span> { <span class="macro">unreachable</span><span class="macro">!</span>() } </pre></div> </section><section id="search" class="content hidden"></section><section class="footer"></section><script>window.rootPath = "../../";window.currentCrate = "abstutil";</script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html>