<!DOCTYPE html> <html>
<head> <meta charset="utf-8">
<meta name=“viewport” content=“width=device-width, initial-scale=1.0”> <title>
Class: RubyText::Settings — Documentation by YARD 0.9.24
</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 = "RubyText::Settings"; 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 (S)</a> » <span class='title'><span class='object_link'><a href="../RubyText.html" title="RubyText (module)">RubyText</a></span></span> » <span class="title">Settings</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: RubyText::Settings
</h1> <div class=“box_info”>
<dl> <dt>Inherits:</dt> <dd> <span class="inheritName">Object</span> <ul class="fullTree"> <li>Object</li> <li class="next">RubyText::Settings</li> </ul> <a href="#" class="inheritanceTree">show all</a> </dd> </dl> <dl> <dt>Defined in:</dt> <dd>settings.rb</dd> </dl>
</div>
<h2>Overview</h2><div class=“docstring”>
<div class="discussion">
<p>Hmm, all these are module-level…?</p>
</div>
</div> <div class=“tags”>
</div>
<h2> Constant Summary <small><a href="#" class="constants_summary_toggle">collapse</a></small> </h2> <dl class="constants"> <dt id="ValidArgs-constant" class="">ValidArgs = </dt> <dd><pre class="code"><span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='comma'>,</span> <span class='symbol'>:_raw</span><span class='comma'>,</span> <span class='symbol'>:echo</span><span class='comma'>,</span> <span class='symbol'>:_echo</span><span class='comma'>,</span> <span class='symbol'>:cbreak</span><span class='comma'>,</span> <span class='symbol'>:_cbreak</span><span class='comma'>,</span>
<span class='symbol'>:keypad</span><span class='comma'>,</span> <span class='symbol'>:_keypad</span><span class='comma'>,</span> <span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='symbol'>:_cursor</span><span class='rbracket'>]</span></pre></dd>
</dl> <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> ⇒ Settings </a> </span> <span class="note title constructor">constructor</span> <span class="summary_desc"><div class='inline'>
<p>A new instance of Settings.</p> </div></span>
</li>
<li class="public "> <span class="summary_signature"> <a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public "> <span class="summary_signature"> <a href="#reset_boolean-instance_method" title="#reset_boolean (instance method)">#<strong>reset_boolean</strong> ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public "> <span class="summary_signature"> <a href="#set-instance_method" title="#set (instance method)">#<strong>set</strong>(*syms) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public "> <span class="summary_signature"> <a href="#set_boolean-instance_method" title="#set_boolean (instance method)">#<strong>set_boolean</strong>(raw: nil, echo: nil, cbreak: nil, keypad: nil, cursor: nil) ⇒ Object </a> </span> <span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public "> <span class="summary_signature"> <a href="#set_curses-instance_method" title="#set_curses (instance method)">#<strong>set_curses</strong>(**hash) ⇒ 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> ⇒ <tt><span class='object_link'><a href="" title="RubyText::Settings (class)">Settings</a></span></tt>
</h3><div class=“docstring”>
<div class="discussion">
<p>Returns a new instance of Settings.</p>
</div>
</div> <div class=“tags”>
</div><table class=“source_code”>
<tr> <td> <pre class="lines">
7 8 9 10 11 12 13 14</pre>
</td> <td> <pre class="code"><span class="info file"># File 'settings.rb', line 7</span>
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span>
<span class='ivar'>@defaults</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>raw:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>echo:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>cbreak:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>keypad:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>true</span><span class='rbrace'>}</span> <span class='ivar'>@current</span> <span class='op'>=</span> <span class='ivar'>@defaults</span><span class='period'>.</span><span class='id identifier rubyid_dup'>dup</span> <span class='ivar'>@stack</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='ivar'>@current</span> <span class='comment'># Note: Never let stack be empty
</span> <span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='ivar'>@current</span><span class='rparen'>)</span> <span class='comment'># Set them for real </span> <span class='comment'># FIXME To be continued… </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="reset-instance_method"> #<strong>reset</strong> ⇒ <tt>Object</tt>
</h3><table class=“source_code”>
<tr> <td> <pre class="lines">
64 65 66</pre>
</td> <td> <pre class="code"><span class="info file"># File 'settings.rb', line 64</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reset'>reset</span>
<span class='comment'># FIXME - call reset_boolean
</span><span class='kw'>end</span></pre>
</td> </tr>
</table> </div>
<div class="method_details "> <h3 class="signature " id="reset_boolean-instance_method"> #<strong>reset_boolean</strong> ⇒ <tt>Object</tt>
</h3><table class=“source_code”>
<tr> <td> <pre class="lines">
45 46 47 48</pre>
</td> <td> <pre class="code"><span class="info file"># File 'settings.rb', line 45</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reset_boolean'>reset_boolean</span>
<span class='ivar'>@current</span> <span class='op'>=</span> <span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_pop'>pop</span> <span class='kw'>rescue</span> <span class='ivar'>@stack</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='ivar'>@current</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td> </tr>
</table> </div>
<div class="method_details "> <h3 class="signature " id="set-instance_method"> #<strong>set</strong>(*syms) ⇒ <tt>Object</tt>
</h3><div class=“docstring”>
<div class="discussion"> </div>
</div> <div class=“tags”>
<p class=“tag_title”>Raises:</p> <ul class=“raise”>
<li> <span class='type'>(<tt>ArgumentError</tt>)</span> </li>
</ul>
</div><table class=“source_code”>
<tr> <td> <pre class="lines">
50 51 52 53 54 55 56 57 58 59 60 61 62</pre>
</td> <td> <pre class="code"><span class="info file"># File 'settings.rb', line 50</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set'>set</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_syms'>syms</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'>ArgumentError</span> <span class='kw'>unless</span> <span class='id identifier rubyid_syms'>syms</span> <span class='op'>-</span> <span class='const'><span class='object_link'><a href="#ValidArgs-constant" title="RubyText::Settings::ValidArgs (constant)">ValidArgs</a></span></span> <span class='op'>==</span> <span class='lbracket'>[</span><span class='rbracket'>]</span> <span class='comment'># FIXME - call set_boolean
</span> <span class='id identifier rubyid_list'>list</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
<span class='id identifier rubyid_syms'>syms</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='op'>|</span> <span class='id identifier rubyid_str'>str</span> <span class='op'>=</span> <span class='id identifier rubyid_sym'>sym</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='id identifier rubyid_val'>val</span> <span class='op'>=</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span> <span class='op'>!=</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>_</span><span class='tstring_end'>"</span></span> <span class='id identifier rubyid_sym0'>sym0</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span> <span class='op'>?</span> <span class='id identifier rubyid_sym'>sym</span> <span class='op'>:</span> <span class='id identifier rubyid_str'>str</span><span class='lbracket'>[</span><span class='int'>1</span><span class='op'>..</span><span class='op'>-</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_sym'>to_sym</span> <span class='id identifier rubyid_list'>list</span><span class='lbracket'>[</span><span class='id identifier rubyid_sym0'>sym0</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_val'>val</span> <span class='kw'>end</span> <span class='id identifier rubyid_set_boolean'>set_boolean</span><span class='lparen'>(</span><span class='id identifier rubyid_list'>list</span><span class='rparen'>)</span> <span class='comment'># allow a block here?
</span><span class='kw'>end</span></pre>
</td> </tr>
</table> </div>
<div class="method_details "> <h3 class="signature " id="set_boolean-instance_method"> #<strong>set_boolean</strong>(raw: nil, echo: nil, cbreak: nil, keypad: nil, cursor: nil) ⇒ <tt>Object</tt>
</h3><table class=“source_code”>
<tr> <td> <pre class="lines">
34 35 36 37 38 39 40 41 42 43</pre>
</td> <td> <pre class="code"><span class="info file"># File 'settings.rb', line 34</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_boolean'>set_boolean</span><span class='lparen'>(</span><span class='label'>raw:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>echo:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cbreak:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>keypad:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_raw'>raw</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='rbracket'>]</span> <span class='id identifier rubyid_echo'>echo</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:echo</span><span class='rbracket'>]</span> <span class='id identifier rubyid_cbreak'>cbreak</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:cbreak</span><span class='rbracket'>]</span> <span class='id identifier rubyid_keypad'>keypad</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:keypad</span><span class='rbracket'>]</span> <span class='id identifier rubyid_cursor'>cursor</span> <span class='op'>||=</span> <span class='ivar'>@current</span><span class='lbracket'>[</span><span class='symbol'>:cursor</span><span class='rbracket'>]</span> <span class='ivar'>@stack</span><span class='period'>.</span><span class='id identifier rubyid_push'>push</span> <span class='ivar'>@current</span> <span class='ivar'>@current</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='label'>raw:</span> <span class='id identifier rubyid_raw'>raw</span><span class='comma'>,</span> <span class='label'>echo:</span> <span class='id identifier rubyid_echo'>echo</span><span class='comma'>,</span> <span class='label'>cbreak:</span> <span class='id identifier rubyid_cbreak'>cbreak</span><span class='comma'>,</span> <span class='label'>keypad:</span> <span class='id identifier rubyid_keypad'>keypad</span><span class='comma'>,</span> <span class='label'>cursor:</span> <span class='id identifier rubyid_cursor'>cursor</span><span class='rbrace'>}</span> <span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='ivar'>@current</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td> </tr>
</table> </div>
<div class="method_details "> <h3 class="signature " id="set_curses-instance_method"> #<strong>set_curses</strong>(**hash) ⇒ <tt>Object</tt>
</h3><table class=“source_code”>
<tr> <td> <pre class="lines">
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32</pre>
</td> <td> <pre class="code"><span class="info file"># File 'settings.rb', line 16</span>
<span class='kw'>def</span> <span class='id identifier rubyid_set_curses'>set_curses</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='comment'># Later: check for bad keys
</span> <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_each_pair'>each_pair</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='op'>|</span>
<span class='kw'>case</span> <span class='lbracket'>[</span><span class='id identifier rubyid_sym'>sym</span><span class='comma'>,</span> <span class='id identifier rubyid_val'>val</span><span class='rbracket'>]</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cbreak</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_cbreak'>cbreak</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cbreak</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_nocbreak'>nocbreak</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_raw'>raw</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:raw</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_noraw'>noraw</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:echo</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_echo'>echo</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:echo</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_noecho'>noecho</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:keypad</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_stdscr'>stdscr</span><span class='period'>.</span><span class='id identifier rubyid_keypad'>keypad</span><span class='lparen'>(</span><span class='kw'>true</span><span class='rparen'>)</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:keypad</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_stdscr'>stdscr</span><span class='period'>.</span><span class='id identifier rubyid_keypad'>keypad</span><span class='lparen'>(</span><span class='kw'>false</span><span class='rparen'>)</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='kw'>true</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_curs_set'>curs_set</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='kw'>when</span> <span class='lbracket'>[</span><span class='symbol'>:cursor</span><span class='comma'>,</span> <span class='kw'>false</span><span class='rbracket'>]</span><span class='semicolon'>;</span> <span class='const'>Curses</span><span class='period'>.</span><span class='id identifier rubyid_curs_set'>curs_set</span><span class='lparen'>(</span><span class='int'>0</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>
</div>
<div id="footer"> Generated on Sat Feb 8 04:24:00 2020 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.24 (ruby-2.4.2).
</div>
</div> </body>
</html>