File: C:/Ruby27-x64/share/doc/ruby/html/Gem/StreamUI.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Gem::StreamUI - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="class">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
<div id="parent-class-section" class="nav-section">
<h3>Parent</h3>
<p class="link"><a href="../Object.html">Object</a>
</div>
<div id="extends-section" class="nav-section">
<h3>Extended With Modules</h3>
<ul class="link-list">
<li><a class="extend" href="Deprecate.html">Gem::Deprecate</a>
</ul>
</div>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-c-new">::new</a>
<li ><a href="#method-i-_gets_noecho">#_gets_noecho</a>
<li ><a href="#method-i-alert">#alert</a>
<li ><a href="#method-i-alert_error">#alert_error</a>
<li ><a href="#method-i-alert_warning">#alert_warning</a>
<li ><a href="#method-i-ask">#ask</a>
<li ><a href="#method-i-ask_for_password">#ask_for_password</a>
<li ><a href="#method-i-ask_yes_no">#ask_yes_no</a>
<li ><a href="#method-i-backtrace">#backtrace</a>
<li ><a href="#method-i-choose_from_list">#choose_from_list</a>
<li ><a href="#method-i-close">#close</a>
<li ><a href="#method-i-debug">#debug</a>
<li ><a href="#method-i-download_reporter">#download_reporter</a>
<li ><a href="#method-i-progress_reporter">#progress_reporter</a>
<li ><a href="#method-i-require_io_console">#require_io_console</a>
<li ><a href="#method-i-say">#say</a>
<li ><a href="#method-i-terminate_interaction">#terminate_interaction</a>
<li ><a href="#method-i-tty-3F">#tty?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Gem::StreamUI">
<h1 id="class-Gem::StreamUI" class="class">
class Gem::StreamUI
</h1>
<section class="description">
<p><a href="StreamUI.html"><code>Gem::StreamUI</code></a> implements a simple stream based user interface.</p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="attribute-method-details" class="method-section">
<header>
<h3>Attributes</h3>
</header>
<div id="attribute-i-errs" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">errs</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The error stream</p>
</div>
</div>
<div id="attribute-i-ins" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">ins</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The input stream</p>
</div>
</div>
<div id="attribute-i-outs" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">outs</span><span
class="attribute-access-type">[R]</span>
</div>
<div class="method-description">
<p>The output stream</p>
</div>
</div>
</section>
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-new" class="method-detail ">
<div class="method-heading">
<span class="method-name">new</span><span
class="method-args">(in_stream, out_stream, err_stream=STDERR, usetty=true)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Creates a new <a href="StreamUI.html"><code>StreamUI</code></a> wrapping <code>in_stream</code> for user input, <code>out_stream</code> for standard output, <code>err_stream</code> for error output. If <code>usetty</code> is true then special operations (like asking for passwords) will use the TTY commands to disable character echo.</p>
<div class="method-source-code" id="new-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 200</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">in_stream</span>, <span class="ruby-identifier">out_stream</span>, <span class="ruby-identifier">err_stream</span>=<span class="ruby-constant">STDERR</span>, <span class="ruby-identifier">usetty</span>=<span class="ruby-keyword">true</span>)
<span class="ruby-ivar">@ins</span> = <span class="ruby-identifier">in_stream</span>
<span class="ruby-ivar">@outs</span> = <span class="ruby-identifier">out_stream</span>
<span class="ruby-ivar">@errs</span> = <span class="ruby-identifier">err_stream</span>
<span class="ruby-ivar">@usetty</span> = <span class="ruby-identifier">usetty</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-_gets_noecho" class="method-detail ">
<div class="method-heading">
<span class="method-name">_gets_noecho</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="_gets_noecho-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 324</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">_gets_noecho</span>
<span class="ruby-identifier">require_io_console</span>
<span class="ruby-ivar">@ins</span>.<span class="ruby-identifier">noecho</span> {<span class="ruby-ivar">@ins</span>.<span class="ruby-identifier">gets</span>}
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-alert" class="method-detail ">
<div class="method-heading">
<span class="method-name">alert</span><span
class="method-args">(statement, question=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Display an informational alert. Will ask <code>question</code> if it is not nil.</p>
<div class="method-source-code" id="alert-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 339</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alert</span>(<span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"INFO: #{statement}"</span>
<span class="ruby-identifier">ask</span>(<span class="ruby-identifier">question</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-alert_error" class="method-detail ">
<div class="method-heading">
<span class="method-name">alert_error</span><span
class="method-args">(statement, question=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Display an error message in a location expected to get error messages. Will ask <code>question</code> if it is not nil.</p>
<div class="method-source-code" id="alert_error-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 356</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alert_error</span>(<span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@errs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"ERROR: #{statement}"</span>
<span class="ruby-identifier">ask</span>(<span class="ruby-identifier">question</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-alert_warning" class="method-detail ">
<div class="method-heading">
<span class="method-name">alert_warning</span><span
class="method-args">(statement, question=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Display a warning on stderr. Will ask <code>question</code> if it is not nil.</p>
<div class="method-source-code" id="alert_warning-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 347</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">alert_warning</span>(<span class="ruby-identifier">statement</span>, <span class="ruby-identifier">question</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-ivar">@errs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"WARNING: #{statement}"</span>
<span class="ruby-identifier">ask</span>(<span class="ruby-identifier">question</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">question</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ask" class="method-detail ">
<div class="method-heading">
<span class="method-name">ask</span><span
class="method-args">(question)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ask a question. Returns an answer if connected to a tty, nil otherwise.</p>
<div class="method-source-code" id="ask-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 288</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ask</span>(<span class="ruby-identifier">question</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">tty?</span>
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">question</span> <span class="ruby-operator">+</span> <span class="ruby-string">" "</span>)
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">flush</span>
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@ins</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-identifier">result</span>.<span class="ruby-identifier">chomp!</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">result</span>
<span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ask_for_password" class="method-detail ">
<div class="method-heading">
<span class="method-name">ask_for_password</span><span
class="method-args">(question)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ask for a password. Does not echo response to terminal.</p>
<div class="method-source-code" id="ask_for_password-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 302</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ask_for_password</span>(<span class="ruby-identifier">question</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span> <span class="ruby-keyword">if</span> <span class="ruby-keyword">not</span> <span class="ruby-identifier">tty?</span>
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">print</span>(<span class="ruby-identifier">question</span>, <span class="ruby-string">" "</span>)
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">flush</span>
<span class="ruby-identifier">password</span> = <span class="ruby-identifier">_gets_noecho</span>
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">puts</span>
<span class="ruby-identifier">password</span>.<span class="ruby-identifier">chomp!</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">password</span>
<span class="ruby-identifier">password</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ask_yes_no" class="method-detail ">
<div class="method-heading">
<span class="method-name">ask_yes_no</span><span
class="method-args">(question, default=nil)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Ask a question. Returns a true for yes, false for no. If not connected to a tty, raises an exception if default is nil, otherwise returns default.</p>
<div class="method-source-code" id="ask_yes_no-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 252</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ask_yes_no</span>(<span class="ruby-identifier">question</span>, <span class="ruby-identifier">default</span>=<span class="ruby-keyword">nil</span>)
<span class="ruby-keyword">unless</span> <span class="ruby-identifier">tty?</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">default</span>.<span class="ruby-identifier">nil?</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">OperationNotSupportedError</span>,
<span class="ruby-string">"Not connected to a tty and no default specified"</span>
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">default</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">default_answer</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">default</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span>
<span class="ruby-string">'yn'</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">true</span>
<span class="ruby-string">'Yn'</span>
<span class="ruby-keyword">else</span>
<span class="ruby-string">'yN'</span>
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">while</span> <span class="ruby-identifier">result</span>.<span class="ruby-identifier">nil?</span> <span class="ruby-keyword">do</span>
<span class="ruby-identifier">result</span> = <span class="ruby-keyword">case</span> <span class="ruby-identifier">ask</span> <span class="ruby-node">"#{question} [#{default_answer}]"</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/^y/i</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">true</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/^n/i</span> <span class="ruby-keyword">then</span> <span class="ruby-keyword">false</span>
<span class="ruby-keyword">when</span> <span class="ruby-regexp">/^$/</span> <span class="ruby-keyword">then</span> <span class="ruby-identifier">default</span>
<span class="ruby-keyword">else</span> <span class="ruby-keyword">nil</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-backtrace" class="method-detail ">
<div class="method-heading">
<span class="method-name">backtrace</span><span
class="method-args">(exception)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prints a formatted backtrace to the errors stream if backtraces are enabled.</p>
<div class="method-source-code" id="backtrace-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 218</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">backtrace</span>(<span class="ruby-identifier">exception</span>)
<span class="ruby-keyword">return</span> <span class="ruby-keyword">unless</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">backtrace</span>
<span class="ruby-ivar">@errs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">"\t#{exception.backtrace.join "\n\t"}"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-choose_from_list" class="method-detail ">
<div class="method-heading">
<span class="method-name">choose_from_list</span><span
class="method-args">(question, list)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Choose from a list of options. <code>question</code> is a prompt displayed above the list. <code>list</code> is a list of option strings. Returns the pair [option_name, option_index].</p>
<div class="method-source-code" id="choose_from_list-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 229</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">choose_from_list</span>(<span class="ruby-identifier">question</span>, <span class="ruby-identifier">list</span>)
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">question</span>
<span class="ruby-identifier">list</span>.<span class="ruby-identifier">each_with_index</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">item</span>, <span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-node">" #{index + 1}. #{item}"</span>
<span class="ruby-keyword">end</span>
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">print</span> <span class="ruby-string">"> "</span>
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">flush</span>
<span class="ruby-identifier">result</span> = <span class="ruby-ivar">@ins</span>.<span class="ruby-identifier">gets</span>
<span class="ruby-keyword">return</span> <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">nil</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">result</span>
<span class="ruby-identifier">result</span> = <span class="ruby-identifier">result</span>.<span class="ruby-identifier">strip</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-operator">-</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">return</span> <span class="ruby-identifier">list</span>[<span class="ruby-identifier">result</span>], <span class="ruby-identifier">result</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-close" class="method-detail ">
<div class="method-heading">
<span class="method-name">close</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="close-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 378</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">close</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-debug" class="method-detail ">
<div class="method-heading">
<span class="method-name">debug</span><span
class="method-args">(statement)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Display a debug message on the same location as error messages.</p>
<div class="method-source-code" id="debug-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 364</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">debug</span>(<span class="ruby-identifier">statement</span>)
<span class="ruby-ivar">@errs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">statement</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-download_reporter" class="method-detail ">
<div class="method-heading">
<span class="method-name">download_reporter</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a download reporter object chosen from the current verbosity</p>
<div class="method-source-code" id="download_reporter-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 519</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">download_reporter</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">if</span> [<span class="ruby-keyword">nil</span>, <span class="ruby-keyword">false</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">verbose</span>) <span class="ruby-operator">||</span> <span class="ruby-operator">!</span><span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">tty?</span>
<span class="ruby-constant">SilentDownloadReporter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@outs</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-constant">ThreadedDownloadReporter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@outs</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-progress_reporter" class="method-detail ">
<div class="method-heading">
<span class="method-name">progress_reporter</span><span
class="method-args">(*args)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Return a progress reporter object chosen from the current verbosity.</p>
<div class="method-source-code" id="progress_reporter-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 384</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">progress_reporter</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">case</span> <span class="ruby-constant">Gem</span>.<span class="ruby-identifier">configuration</span>.<span class="ruby-identifier">verbose</span>
<span class="ruby-keyword">when</span> <span class="ruby-keyword">nil</span>, <span class="ruby-keyword">false</span>
<span class="ruby-constant">SilentProgressReporter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@outs</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">when</span> <span class="ruby-keyword">true</span>
<span class="ruby-constant">SimpleProgressReporter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@outs</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-constant">VerboseProgressReporter</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@outs</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-require_io_console" class="method-detail ">
<div class="method-heading">
<span class="method-name">require_io_console</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-source-code" id="require_io_console-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 314</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">require_io_console</span>
<span class="ruby-ivar">@require_io_console</span> <span class="ruby-operator">||=</span> <span class="ruby-keyword">begin</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">'io/console'</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">LoadError</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">true</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-say" class="method-detail ">
<div class="method-heading">
<span class="method-name">say</span><span
class="method-args">(statement="")</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Display a statement.</p>
<div class="method-source-code" id="say-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 332</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">say</span>(<span class="ruby-identifier">statement</span>=<span class="ruby-string">""</span>)
<span class="ruby-ivar">@outs</span>.<span class="ruby-identifier">puts</span> <span class="ruby-identifier">statement</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-terminate_interaction" class="method-detail ">
<div class="method-heading">
<span class="method-name">terminate_interaction</span><span
class="method-args">(status = 0)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Terminate the application with exit code <code>status</code>, running any exit handlers that might have been defined.</p>
<div class="method-source-code" id="terminate_interaction-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 373</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">terminate_interaction</span>(<span class="ruby-identifier">status</span> = <span class="ruby-value">0</span>)
<span class="ruby-identifier">close</span>
<span class="ruby-identifier">raise</span> <span class="ruby-constant">Gem</span><span class="ruby-operator">::</span><span class="ruby-constant">SystemExitException</span>, <span class="ruby-identifier">status</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-tty-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">tty?</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns true if TTY methods should be used on this <a href="StreamUI.html"><code>StreamUI</code></a>.</p>
<div class="method-source-code" id="tty-3F-source">
<pre><span class="ruby-comment"># File lib/rubygems/user_interaction.rb, line 210</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">tty?</span>
<span class="ruby-ivar">@usetty</span> <span class="ruby-operator">&&</span> <span class="ruby-ivar">@ins</span>.<span class="ruby-identifier">tty?</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>