File: C:/Ruby27-x64/share/doc/ruby/html/IRB/OutputMethod.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class IRB::OutputMethod - 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>
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
<h3>Methods</h3>
<ul class="link-list" role="directory">
<li ><a href="#method-i-parse_printf_format">#parse_printf_format</a>
<li ><a href="#method-i-pp">#pp</a>
<li ><a href="#method-i-ppx">#ppx</a>
<li ><a href="#method-i-print">#print</a>
<li ><a href="#method-i-printf">#printf</a>
<li ><a href="#method-i-printn">#printn</a>
<li ><a href="#method-i-puts">#puts</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-IRB::OutputMethod">
<h1 id="class-IRB::OutputMethod" class="class">
class IRB::OutputMethod
</h1>
<section class="description">
<p>An abstract output class for <a href="../IO.html"><code>IO</code></a> in irb. This is mainly used internally by <a href="Notifier.html"><code>IRB::Notifier</code></a>. You can define your own output method to use with <a href="Irb.html#method-c-new"><code>Irb.new</code></a>, or <a href="Context.html#method-c-new"><code>Context.new</code></a></p>
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Instance Methods</h3>
</header>
<div id="method-i-parse_printf_format" class="method-detail ">
<div class="method-heading">
<span class="method-name">parse_printf_format</span><span
class="method-args">(format, opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Returns an array of the given <code>format</code> and <code>opts</code> to be used by <a href="../Kernel.html#method-i-sprintf"><code>Kernel#sprintf</code></a>, if there was a successful <a href="../Regexp.html"><code>Regexp</code></a> match in the given <code>format</code> from <a href="OutputMethod.html#method-i-printf"><code>printf</code></a></p>
<pre>%
<flag> [#0- +]
<minimum field width> (\*|\*[1-9][0-9]*\$|[1-9][0-9]*)
<precision>.(\*|\*[1-9][0-9]*\$|[1-9][0-9]*|)?
#<length modifier>(hh|h|l|ll|L|q|j|z|t)
<conversion specifier>[diouxXeEfgGcsb%]</pre>
<div class="method-source-code" id="parse_printf_format-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 54</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">parse_printf_format</span>(<span class="ruby-identifier">format</span>, <span class="ruby-identifier">opts</span>)
<span class="ruby-keyword">return</span> <span class="ruby-identifier">format</span>, <span class="ruby-identifier">opts</span> <span class="ruby-keyword">if</span> <span class="ruby-node">$1</span>.<span class="ruby-identifier">size</span> <span class="ruby-operator">%</span> <span class="ruby-value">2</span> <span class="ruby-operator">==</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-pp" class="method-detail ">
<div class="method-heading">
<span class="method-name">pp</span><span
class="method-args">(*objs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prints the given <code>objs</code> calling <a href="../Object.html#method-i-inspect"><code>Object#inspect</code></a> on each.</p>
<p>See <a href="OutputMethod.html#method-i-puts"><code>puts</code></a> for more detail.</p>
<div class="method-source-code" id="pp-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 70</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">pp</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>)
<span class="ruby-identifier">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">obj</span><span class="ruby-operator">|</span> <span class="ruby-identifier">obj</span>.<span class="ruby-identifier">inspect</span>})
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-ppx" class="method-detail ">
<div class="method-heading">
<span class="method-name">ppx</span><span
class="method-args">(prefix, *objs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prints the given <code>objs</code> calling <a href="../Object.html#method-i-inspect"><code>Object#inspect</code></a> on each and appending the given <code>prefix</code>.</p>
<p>See <a href="OutputMethod.html#method-i-puts"><code>puts</code></a> for more detail.</p>
<div class="method-source-code" id="ppx-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 78</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">ppx</span>(<span class="ruby-identifier">prefix</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>)
<span class="ruby-identifier">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>.<span class="ruby-identifier">collect</span>{<span class="ruby-operator">|</span><span class="ruby-identifier">obj</span><span class="ruby-operator">|</span> <span class="ruby-identifier">prefix</span><span class="ruby-operator">+</span><span class="ruby-identifier">obj</span>.<span class="ruby-identifier">inspect</span>})
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-print" class="method-detail ">
<div class="method-heading">
<span class="method-name">print</span><span
class="method-args">(*opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Open this method to implement your own output method, raises a <a href="OutputMethod/NotImplementedError.html"><code>NotImplementedError</code></a> if you don't define <a href="OutputMethod.html#method-i-print"><code>print</code></a> in your own class.</p>
<div class="method-source-code" id="print-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 26</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">print</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>)
<span class="ruby-identifier">raise</span> <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-string">"print"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-printf" class="method-detail ">
<div class="method-heading">
<span class="method-name">printf</span><span
class="method-args">(format, *opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Extends <a href="../IO.html#method-i-printf"><code>IO#printf</code></a> to format the given <code>opts</code> for <a href="../Kernel.html#method-i-sprintf"><code>Kernel#sprintf</code></a> using <a href="OutputMethod.html#method-i-parse_printf_format"><code>parse_printf_format</code></a></p>
<div class="method-source-code" id="printf-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">printf</span>(<span class="ruby-identifier">format</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>)
<span class="ruby-keyword">if</span> <span class="ruby-regexp">/(%*)%I/</span> <span class="ruby-operator">=~</span> <span class="ruby-identifier">format</span>
<span class="ruby-identifier">format</span>, <span class="ruby-identifier">opts</span> = <span class="ruby-identifier">parse_printf_format</span>(<span class="ruby-identifier">format</span>, <span class="ruby-identifier">opts</span>)
<span class="ruby-keyword">end</span>
<span class="ruby-identifier">print</span> <span class="ruby-identifier">sprintf</span>(<span class="ruby-identifier">format</span>, <span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-printn" class="method-detail ">
<div class="method-heading">
<span class="method-name">printn</span><span
class="method-args">(*opts)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Prints the given <code>opts</code>, with a newline delimiter.</p>
<div class="method-source-code" id="printn-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 31</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">printn</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">opts</span>)
<span class="ruby-identifier">print</span> <span class="ruby-identifier">opts</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">" "</span>), <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-puts" class="method-detail ">
<div class="method-heading">
<span class="method-name">puts</span><span
class="method-args">(*objs)</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Calls <a href="OutputMethod.html#method-i-print"><code>print</code></a> on each element in the given <code>objs</code>, followed by a newline character.</p>
<div class="method-source-code" id="puts-source">
<pre><span class="ruby-comment"># File lib/irb/output-method.rb, line 60</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">puts</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">objs</span>)
<span class="ruby-keyword">for</span> <span class="ruby-identifier">obj</span> <span class="ruby-keyword">in</span> <span class="ruby-identifier">objs</span>
<span class="ruby-identifier">print</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">obj</span>)
<span class="ruby-identifier">print</span> <span class="ruby-string">"\n"</span>
<span class="ruby-keyword">end</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>