diff options
Diffstat (limited to 'LCS/DefaultCallbacks.html')
-rw-r--r-- | LCS/DefaultCallbacks.html | 207 |
1 files changed, 207 insertions, 0 deletions
diff --git a/LCS/DefaultCallbacks.html b/LCS/DefaultCallbacks.html new file mode 100644 index 0000000..a63bb94 --- /dev/null +++ b/LCS/DefaultCallbacks.html @@ -0,0 +1,207 @@ +<!DOCTYPE html> + +<html> +<head> +<meta charset="UTF-8"> + +<title>class LCS::SequenceCallbacks - diff-lcs-1.5.0 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">Object +</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-change">::change</a> + <li ><a href="#method-c-discard_a">::discard_a</a> + <li ><a href="#method-c-discard_b">::discard_b</a> + <li ><a href="#method-c-match">::match</a> + </ul> +</div> + + </div> +</nav> + +<main role="main" aria-labelledby="class-LCS::SequenceCallbacks"> + <h1 id="class-LCS::SequenceCallbacks" class="class"> + class LCS::SequenceCallbacks + </h1> + + <section class="description"> + +<p>This callback object implements the default set of callback events, which only returns the event itself. Note that finished_a and finished_b are not implemented – I haven't yet figured out where they would be useful.</p> + +<p>Note that this is intended to be called as is, e.g.,</p> + +<pre class="ruby"><span class="ruby-constant">Diff</span><span class="ruby-operator">::</span><span class="ruby-constant">LCS</span>.<span class="ruby-constant">LCS</span>(<span class="ruby-identifier">seq1</span>, <span class="ruby-identifier">seq2</span>, <span class="ruby-constant">Diff</span><span class="ruby-operator">::</span><span class="ruby-constant">LCS</span><span class="ruby-operator">::</span><span class="ruby-constant">DefaultCallbacks</span>) +</pre> + + </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-change" class="method-detail "> + <div class="method-heading"> + <span class="method-name">change</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + <p>Called when both the old and new values have changed.</p> + + <div class="method-source-code" id="change-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/callbacks.rb, line 32</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">change</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">event</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-c-discard_a" class="method-detail "> + <div class="method-heading"> + <span class="method-name">discard_a</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + <p>Called when the old value is discarded in favour of the new value.</p> + + <div class="method-source-code" id="discard_a-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/callbacks.rb, line 22</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">discard_a</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">event</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-c-discard_b" class="method-detail "> + <div class="method-heading"> + <span class="method-name">discard_b</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + <p>Called when the new value is discarded in favour of the old value.</p> + + <div class="method-source-code" id="discard_b-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/callbacks.rb, line 27</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">discard_b</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">event</span> +<span class="ruby-keyword">end</span></pre> + </div> + </div> + + + </div> + + <div id="method-c-match" class="method-detail "> + <div class="method-heading"> + <span class="method-name">match</span><span + class="method-args">(event)</span> + <span class="method-click-advice">click to toggle source</span> + </div> + + <div class="method-description"> + <p>Called when two items match.</p> + + <div class="method-source-code" id="match-source"> + <pre><span class="ruby-comment"># File lib/diff/lcs/callbacks.rb, line 17</span> +<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">match</span>(<span class="ruby-identifier">event</span>) + <span class="ruby-identifier">event</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.3.3. + <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>. +</footer> + |