mirror of
https://github.com/mistergibson/gxg-framework.git
synced 2026-08-15 03:46:00 -07:00
517 lines
18 KiB
HTML
517 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
|
|
<html>
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
|
|
<title>class GxG::Enumerator - 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">Enumerator
|
|
|
|
</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-each">#each</a>
|
|
|
|
<li ><a href="#method-i-each_with_index">#each_with_index</a>
|
|
|
|
<li ><a href="#method-i-next">#next</a>
|
|
|
|
<li ><a href="#method-i-next_values">#next_values</a>
|
|
|
|
<li ><a href="#method-i-peek">#peek</a>
|
|
|
|
<li ><a href="#method-i-peek_values">#peek_values</a>
|
|
|
|
<li ><a href="#method-i-rewind">#rewind</a>
|
|
|
|
<li ><a href="#method-i-with_index">#with_index</a>
|
|
|
|
<li ><a href="#method-i-with_object">#with_object</a>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</div>
|
|
</nav>
|
|
|
|
<main role="main" aria-labelledby="class-GxG::Enumerator">
|
|
<h1 id="class-GxG::Enumerator" class="class">
|
|
class GxG::Enumerator
|
|
</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-new" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">new</span><span
|
|
class="method-args">(object=nil,method=:each,*args, &block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
<p>this is a bit inefficient, but it gets the job done. It is essentially an each wrapper to do a cooperative pauses for non-blocking goodness. :) TODO: inspiration: what about just leveraging 'super' after a pause operation on all overrides. (thx)</p>
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="new-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 282</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>(<span class="ruby-identifier">object</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-identifier">method</span>=<span class="ruby-value">:each</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-comment"># Without the call to super() it works, but will be uninitialized</span>
|
|
<span class="ruby-comment"># super(object,method,*args)</span>
|
|
<span class="ruby-ivar">@collection</span> = <span class="ruby-identifier">object</span>.<span class="ruby-identifier">stock_to_enum</span>(<span class="ruby-identifier">method</span>,<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>, <span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-comment"># @collection = ::Enumerator.new(object,method,*args,&block)</span>
|
|
<span class="ruby-keyword">self</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-each" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">each</span><span
|
|
class="method-args">(&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="each-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 290</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-comment"># reference = {:object => self, :method => __callee__, :fiber => Fiber.current, :thread => Thread.current}</span>
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-keyword">if</span> <span class="ruby-operator">::</span><span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">EventManager</span><span class="ruby-operator">::</span><span class="ruby-identifier">manager_running?</span>
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-operator">*</span><span class="ruby-identifier">args</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">args</span>)
|
|
<span class="ruby-identifier">pause</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">each</span>(<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-each_with_index" class="method-detail method-alias">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">each_with_index</span><span
|
|
class="method-args">(offset=0,&block)</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="aliases">
|
|
Alias for: <a href="Enumerator.html#method-i-with_index">with_index</a>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-next" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">next</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="next-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 308</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-keyword">next</span>()
|
|
<span class="ruby-identifier ruby-title">pause</span>
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">next</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-next_values" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">next_values</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="next_values-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 313</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">next_values</span>()
|
|
<span class="ruby-identifier">pause</span>
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">next_values</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-peek" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">peek</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="peek-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 318</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">peek</span>()
|
|
<span class="ruby-identifier">pause</span>
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">peek</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-peek_values" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">peek_values</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="peek_values-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 323</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">peek_values</span>()
|
|
<span class="ruby-identifier">pause</span>
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">peek_values</span>()
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-rewind" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">rewind</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="rewind-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 328</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">rewind</span>()
|
|
<span class="ruby-keyword">if</span> <span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:rewind</span>)
|
|
<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">rewind</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">self</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-with_index" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">with_index</span><span
|
|
class="method-args">(offset=0,&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="with_index-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 335</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_index</span>(<span class="ruby-identifier">offset</span>=<span class="ruby-value">0</span>,<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">enumerator</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Enumerator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">with_index</span>(<span class="ruby-identifier">offset</span>))
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-identifier">enumerator</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>,<span class="ruby-identifier">index</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">entry</span>,<span class="ruby-identifier">index</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">enumerator</span>
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-keyword">end</span></pre>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="aliases">
|
|
Also aliased as: <a href="Enumerator.html#method-i-each_with_index">each_with_index</a>
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<div id="method-i-with_object" class="method-detail ">
|
|
|
|
<div class="method-heading">
|
|
<span class="method-name">with_object</span><span
|
|
class="method-args">(an_object=nil,&block)</span>
|
|
|
|
<span class="method-click-advice">click to toggle source</span>
|
|
|
|
</div>
|
|
|
|
|
|
<div class="method-description">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="method-source-code" id="with_object-source">
|
|
<pre><span class="ruby-comment"># File lib/gxg/gxg_elements.rb, line 347</span>
|
|
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">with_object</span>(<span class="ruby-identifier">an_object</span>=<span class="ruby-keyword">nil</span>,<span class="ruby-operator">&</span><span class="ruby-identifier">block</span>)
|
|
<span class="ruby-identifier">enumerator</span> = <span class="ruby-constant">GxG</span><span class="ruby-operator">::</span><span class="ruby-constant">Enumerator</span>.<span class="ruby-identifier">new</span>(<span class="ruby-ivar">@collection</span>.<span class="ruby-identifier">with_object</span>(<span class="ruby-identifier">an_object</span>))
|
|
<span class="ruby-keyword">if</span> <span class="ruby-identifier">block</span>.<span class="ruby-identifier">respond_to?</span>(<span class="ruby-value">:call</span>)
|
|
<span class="ruby-identifier">enumerator</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">entry</span>,<span class="ruby-identifier">the_object</span><span class="ruby-operator">|</span>
|
|
<span class="ruby-identifier">block</span>.<span class="ruby-identifier">call</span>(<span class="ruby-identifier">entry</span>,<span class="ruby-identifier">the_object</span>)
|
|
<span class="ruby-keyword">end</span>
|
|
<span class="ruby-identifier">an_object</span>
|
|
<span class="ruby-keyword">else</span>
|
|
<span class="ruby-identifier">enumerator</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.1.2.
|
|
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
|
|
</footer>
|
|
|