YouPlot/YouPlot/Command.html
2022-05-25 07:07:35 +00:00

765 lines
19 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: YouPlot::Command
&mdash; Documentation by YARD 0.9.27
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "YouPlot::Command";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (C)</a> &raquo;
<span class='title'><span class='object_link'><a href="../YouPlot.html" title="YouPlot (module)">YouPlot</a></span></span>
&raquo;
<span class="title">Command</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: YouPlot::Command
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Object</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">YouPlot::Command</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/youplot/command.rb</dd>
</dl>
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#command-instance_method" title="#command (instance method)">#<strong>command</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute command.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#data-instance_method" title="#data (instance method)">#<strong>data</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute data.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#options-instance_method" title="#options (instance method)">#<strong>options</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute options.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#params-instance_method" title="#params (instance method)">#<strong>params</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute params.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#parser-instance_method" title="#parser (instance method)">#<strong>parser</strong> &#x21d2; Object </a>
</span>
<span class="note title readonly">readonly</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute parser.</p>
</div></span>
</li>
</ul>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(argv = ARGV) &#x21d2; Command </a>
</span>
<span class="note title constructor">constructor</span>
<span class="summary_desc"><div class='inline'>
<p>A new instance of Command.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#run-instance_method" title="#run (instance method)">#<strong>run</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#run_as_executable-instance_method" title="#run_as_executable (instance method)">#<strong>run_as_executable</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<div class="method_details first">
<h3 class="signature first" id="initialize-instance_method">
#<strong>initialize</strong>(argv = ARGV) &#x21d2; <tt><span class='object_link'><a href="" title="YouPlot::Command (class)">Command</a></span></tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Command.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
16
17
18
19
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_argv'>argv</span> <span class='op'>=</span> <span class='const'>ARGV</span><span class='rparen'>)</span>
<span class='ivar'>@argv</span> <span class='op'>=</span> <span class='id identifier rubyid_argv'>argv</span>
<span class='ivar'>@parser</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Parser.html" title="YouPlot::Parser (class)">Parser</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Parser.html#initialize-instance_method" title="YouPlot::Parser#initialize (method)">new</a></span></span>
<span class='ivar'>@command</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@params</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@options</span> <span class='op'>=</span> <span class='kw'>nil</span>
<span class='ivar'>@backend</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../YouPlot.html" title="YouPlot (module)">YouPlot</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Backends.html" title="YouPlot::Backends (module)">Backends</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Backends/UnicodePlot.html" title="YouPlot::Backends::UnicodePlot (module)">UnicodePlot</a></span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="command=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="command-instance_method">
#<strong>command</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute command.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_command'>command</span>
<span class='ivar'>@command</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="data-instance_method">
#<strong>data</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute data.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_data'>data</span>
<span class='ivar'>@data</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="options=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="options-instance_method">
#<strong>options</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute options.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_options'>options</span>
<span class='ivar'>@options</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="params=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="params-instance_method">
#<strong>params</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute params.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 13</span>
<span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
<span class='ivar'>@params</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id=""></span>
<div class="method_details ">
<h3 class="signature " id="parser-instance_method">
#<strong>parser</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute parser.</p>
</div>
</div>
<div class="tags">
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
14
15
16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 14</span>
<span class='kw'>def</span> <span class='id identifier rubyid_parser'>parser</span>
<span class='ivar'>@parser</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="run-instance_method">
#<strong>run</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 30</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run'>run</span>
<span class='id identifier rubyid_parser'>parser</span><span class='period'>.</span><span class='id identifier rubyid_parse_options'>parse_options</span><span class='lparen'>(</span><span class='ivar'>@argv</span><span class='rparen'>)</span>
<span class='ivar'>@command</span> <span class='op'>||=</span> <span class='id identifier rubyid_parser'>parser</span><span class='period'>.</span><span class='id identifier rubyid_command'>command</span>
<span class='ivar'>@options</span> <span class='op'>||=</span> <span class='id identifier rubyid_parser'>parser</span><span class='period'>.</span><span class='id identifier rubyid_options'>options</span>
<span class='ivar'>@params</span> <span class='op'>||=</span> <span class='id identifier rubyid_parser'>parser</span><span class='period'>.</span><span class='id identifier rubyid_params'>params</span>
<span class='comment'># color command
</span> <span class='kw'>if</span> <span class='qsymbols_beg'>%i[</span><span class='tstring_content'>colors</span><span class='words_sep'> </span><span class='tstring_content'>color</span><span class='words_sep'> </span><span class='tstring_content'>colours</span><span class='words_sep'> </span><span class='tstring_content'>colour</span><span class='tstring_end'>]</span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='ivar'>@command</span>
<span class='id identifier rubyid_plot'>plot</span> <span class='op'>=</span> <span class='id identifier rubyid_create_plot'>create_plot</span>
<span class='id identifier rubyid_output_plot'>output_plot</span><span class='lparen'>(</span><span class='id identifier rubyid_plot'>plot</span><span class='rparen'>)</span>
<span class='kw'>return</span>
<span class='kw'>end</span>
<span class='comment'># progressive mode
</span> <span class='kw'>if</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:progressive</span><span class='rbracket'>]</span>
<span class='id identifier rubyid_stop'>stop</span> <span class='op'>=</span> <span class='kw'>false</span>
<span class='const'>Signal</span><span class='period'>.</span><span class='id identifier rubyid_trap'>trap</span><span class='lparen'>(</span><span class='symbol'>:INT</span><span class='rparen'>)</span> <span class='lbrace'>{</span> <span class='id identifier rubyid_stop'>stop</span> <span class='op'>=</span> <span class='kw'>true</span> <span class='rbrace'>}</span>
<span class='comment'># make cursor invisible
</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:output</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\e[?25l</span><span class='tstring_end'>&quot;</span></span>
<span class='comment'># mainloop
</span> <span class='kw'>while</span> <span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='rparen'>)</span>
<span class='id identifier rubyid_n'>n</span> <span class='op'>=</span> <span class='id identifier rubyid_main_progressive'>main_progressive</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>break</span> <span class='kw'>if</span> <span class='id identifier rubyid_stop'>stop</span>
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:output</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\e[</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_n'>n</span><span class='embexpr_end'>}</span><span class='tstring_content'>F</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span>
<span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:output</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\e[0J</span><span class='tstring_end'>&quot;</span></span>
<span class='comment'># make cursor visible
</span> <span class='id identifier rubyid_options'>options</span><span class='lbracket'>[</span><span class='symbol'>:output</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_print'>print</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\e[?25h</span><span class='tstring_end'>&quot;</span></span>
<span class='comment'># normal mode
</span> <span class='kw'>else</span>
<span class='comment'># Sometimes the input file does not end with a newline code.
</span> <span class='kw'>while</span> <span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span> <span class='op'>=</span> <span class='const'>Kernel</span><span class='period'>.</span><span class='id identifier rubyid_gets'>gets</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_main'>main</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="run_as_executable-instance_method">
#<strong>run_as_executable</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
25
26
27
28</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/command.rb', line 25</span>
<span class='kw'>def</span> <span class='id identifier rubyid_run_as_executable'>run_as_executable</span>
<span class='const'><span class='object_link'><a href="../YouPlot.html" title="YouPlot (module)">YouPlot</a></span></span><span class='period'>.</span><span class='id identifier rubyid_run_as_executable'><span class='object_link'><a href="../YouPlot.html#run_as_executable-class_method" title="YouPlot.run_as_executable (method)">run_as_executable</a></span></span> <span class='op'>=</span> <span class='kw'>true</span>
<span class='id identifier rubyid_run'>run</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed May 25 07:07:34 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.1.2).
</div>
</div>
</body>
</html>