File: C:/Ruby27-x64/share/doc/ruby/html/Bundler/Thor/LineEditor/Readline.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>class Bundler::Thor::LineEditor::Readline - 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="Basic.html">Bundler::Thor::LineEditor::Basic</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-c-available-3F">::available?</a>
<li ><a href="#method-i-add_to_history-3F">#add_to_history?</a>
<li ><a href="#method-i-completion_options">#completion_options</a>
<li ><a href="#method-i-completion_proc">#completion_proc</a>
<li class="calls-super" ><a href="#method-i-readline">#readline</a>
<li ><a href="#method-i-use_path_completion-3F">#use_path_completion?</a>
</ul>
</div>
</div>
</nav>
<main role="main" aria-labelledby="class-Bundler::Thor::LineEditor::Readline">
<h1 id="class-Bundler::Thor::LineEditor::Readline" class="class">
class Bundler::Thor::LineEditor::Readline
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section id="public-class-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Public Class Methods</h3>
</header>
<div id="method-c-available-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">available?</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="available-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb, line 4</span>
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier ruby-title">available?</span>
<span class="ruby-keyword">begin</span>
<span class="ruby-identifier">require</span> <span class="ruby-string">"readline"</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">LoadError</span>
<span class="ruby-keyword">end</span>
<span class="ruby-constant">Object</span>.<span class="ruby-identifier">const_defined?</span>(<span class="ruby-value">:Readline</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-readline" class="method-detail ">
<div class="method-heading">
<span class="method-name">readline</span><span
class="method-args">()</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<div class="method-calls-super">
Calls superclass method
<a href="Basic.html#method-i-readline"><code>Bundler::Thor::LineEditor::Basic#readline</code></a>
</div>
<div class="method-source-code" id="readline-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb, line 13</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">readline</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">echo?</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Readline</span>.<span class="ruby-identifier">completion_append_character</span> = <span class="ruby-keyword">nil</span>
<span class="ruby-comment"># rb-readline does not allow Readline.completion_proc= to receive nil.</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">complete</span> = <span class="ruby-identifier">completion_proc</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Readline</span>.<span class="ruby-identifier">completion_proc</span> = <span class="ruby-identifier">complete</span>
<span class="ruby-keyword">end</span>
<span class="ruby-operator">::</span><span class="ruby-constant">Readline</span>.<span class="ruby-identifier">readline</span>(<span class="ruby-identifier">prompt</span>, <span class="ruby-identifier">add_to_history?</span>)
<span class="ruby-keyword">else</span>
<span class="ruby-keyword">super</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
</section>
<section id="private-instance-5Buntitled-5D-method-details" class="method-section">
<header>
<h3>Private Instance Methods</h3>
</header>
<div id="method-i-add_to_history-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">add_to_history?</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="add_to_history-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb, line 28</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">add_to_history?</span>
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:add_to_history</span>, <span class="ruby-keyword">true</span>)
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-completion_options" class="method-detail ">
<div class="method-heading">
<span class="method-name">completion_options</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="completion_options-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb, line 42</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">completion_options</span>
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:limited_to</span>, [])
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-completion_proc" class="method-detail ">
<div class="method-heading">
<span class="method-name">completion_proc</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="completion_proc-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb, line 32</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">completion_proc</span>
<span class="ruby-keyword">if</span> <span class="ruby-identifier">use_path_completion?</span>
<span class="ruby-identifier">proc</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">text</span><span class="ruby-operator">|</span> <span class="ruby-constant">PathCompletion</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">text</span>).<span class="ruby-identifier">matches</span> }
<span class="ruby-keyword">elsif</span> <span class="ruby-identifier">completion_options</span>.<span class="ruby-identifier">any?</span>
<span class="ruby-identifier">proc</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">text</span><span class="ruby-operator">|</span>
<span class="ruby-identifier">completion_options</span>.<span class="ruby-identifier">select</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">option</span><span class="ruby-operator">|</span> <span class="ruby-identifier">option</span>.<span class="ruby-identifier">start_with?</span>(<span class="ruby-identifier">text</span>) }
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div>
</div>
</div>
<div id="method-i-use_path_completion-3F" class="method-detail ">
<div class="method-heading">
<span class="method-name">use_path_completion?</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="use_path_completion-3F-source">
<pre><span class="ruby-comment"># File lib/bundler/vendor/thor/lib/thor/line_editor/readline.rb, line 46</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">use_path_completion?</span>
<span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:path</span>, <span class="ruby-keyword">false</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>