All Downloads are FREE. Search and download functionalities are using the official Maven repository.

jruby.kernel.jruby.generator.rb Maven / Gradle / Ivy

require 'thread'

module JRuby
  class Generator
    include Enumerable

    # Returns true if the generator has not reached the end yet.
    def next?()
      !end?
    end

    # Returns the current index (position) counting from zero.
    def index()
      @index
    end
    alias pos index

    # Construct a new generator; defaults to the threaded impl
    def self.new(*args, &block)
      generator = (self == Generator) ? Threaded : self

      gen = generator.allocate
      gen.send :initialize, *args, &block
      gen
    end

    class Indexed < Generator
      SIMPLE_INDEXER = proc {|ary, i| ary[i]}
      def initialize(ary, &indexer)
        @ary = ary
        @index = 0
        @indexer = indexer || SIMPLE_INDEXER
      end

      def end?
        @index >= @ary.size
      end

      def next
        obj, @index = current, @index + 1
        obj
      end

      def current
        raise EOFError, "no more elements available" if end?
        @indexer.call(@ary, @index)
      end

      def rewind
        @index = 0
      end

      def each
        return enum_for(:each) unless block_given?

        for i in [email protected]
          yield @indexer.call(i)
        end
      end
    end

    class Cursor < Generator
      ENDED = Object.new
      def initialize(start, succ_method, _end)
        @start = start
        @cur = start
        @end = _end
        @succ_method = succ_method
      end

      def end?
        @cur == ENDED
      end

      def next
        if @cur == ENDED
          raise StopIteration.new
        elsif @cur == @end
          obj, @cur = @cur, ENDED
        else
          obj, @cur = @cur, @cur.succ
        end
        obj
      end

      def current
        raise EOFError, "no more elements available" if end?
        @cur
      end

      def rewind
        @cur = @start
      end

      def each
        return enum_for(:each) unless block_given?

        until end?
          yield self.next
        end
      end
    end

    class Threaded < Generator
      # marks the end of enumeration
      END_MARKER = Object.new
      def END_MARKER.inspect ; "END_MARKER" ; end

      # a queue which emulates the producer-side interface of a generator
      class ProducerQueue < SizedQueue
        attr_accessor :error

        def initialize
          super(1)
        end

        alias yield push

        def _run_enum(enum)
          _run { enum.each { |x| push(x) } }
        end

        def _run
          # caller manages thread, to avoid circularity
          Thread.new do
            begin
              yield self
            rescue StopIteration
              self.error = $!
              self.clear
            rescue Exception
              self.error = $!
            ensure
              push(END_MARKER)
            end
          end
        end
      end

      class QueueFinalizer
        attr_accessor :queue

        def initialize
          @queue = nil
        end

        def to_proc
          proc do
            @queue.shutdown! if @queue
          end
        end
      end

      # Creates a new generator either from an Enumerable object or from a
      # block.
      #
      # In the former, block is ignored even if given.
      #
      # In the latter, the given block is called with the generator
      # itself, and expected to call the +yield+ method for each element.
      def initialize(enum = nil, &block)
        warn "Using inefficient threaded enumerator for #{enum.inspect}, consider writing a iterator" if $DEBUG
        @queue_finalizer = QueueFinalizer.new
        ObjectSpace.define_finalizer self, &@queue_finalizer
        _setup(enum, block)
      end

      def _setup(enum, block)
        @queue = ProducerQueue.new
        @queue_finalizer.queue = @queue

        @got_next_element = false
        @next_element = nil
        @index = 0

        @enum = enum
        @block = block
        @thread = nil

        self
      end

      # Yields an element to the generator.
      def yield(value)
        @queue.yield(value)
        self
      end

      # gets the next element; may block
      def _next_element
        unless @got_next_element
          unless @thread
            if @enum
              @thread = @queue._run_enum(@enum)
            else
              @thread = @queue._run(&@block)
            end
          end
          @next_element = @queue.pop
          raise @next_element if Exception === @next_element
          raise @queue.error if @queue.error
          @got_next_element = true
        end
        @next_element
      end

      # Returns true if the generator has reached the end.
      def end?()
        END_MARKER.equal? _next_element
      end

      # Returns the element at the current position and moves forward.
      def next()
        result = current
        @index += 1
        @got_next_element = false
        @next_element = nil
        result
      end

      # Returns the element at the current position.
      def current()
        raise EOFError, "no more elements available" if end?
        _next_element
      end

      # Rewinds the generator.
      def rewind()
        if @index.nonzero?
          @queue.shutdown!
          begin
            @thread.join if @thread
          rescue Exception
          end
          _setup(@enum, @block)
        end
        self
      end

      # Rewinds the generator and enumerates the elements.
      def each(&block)
        return enum_for(:each) unless block_given?

        # if using the block form only, don't "next" for internal iteration
        if @block && !@enum
          @block.call Enumerator::Yielder.new(&block)
        elsif @enum && !@block
          @enum.each(&block)
        else
          rewind

          until end?
            yield self.next
          end
        end

        self
      end
    end

    IS_RUBY_20 = RUBY_VERSION =~ /^2\.0/
    IS_RUBY_19 = RUBY_VERSION =~ /^1\.9/ || IS_RUBY_20

    if IS_RUBY_19
      Enumerator = ::Enumerator
    else
      Enumerator = Enumerable::Enumerator
    end

    module Iterators
      module ClassMethods
        def indexed_iter(method, &block)
          ext_iter_method = :"iter_for_#{method}"

          define_method ext_iter_method do
            Generator::Indexed.new(self, &block)
          end
        end

        def cursor_iter(start_method, succ_method, end_method, method, &block)
          ext_iter_method = :"iter_for_#{method}"

          define_method ext_iter_method do
            Generator::Cursor.new(self.__send__(start_method), succ_method, self.__send__(end_method), &block)
          end
        end
      end
      def self.included(cls)
        cls.extend ClassMethods
      end
    end

    class ::Array
      include Iterators
      indexed_iter(:each)
      indexed_iter(:each_with_index) {|a,i| [ a[i], i ]}
      indexed_iter(:each_index) {|a,i| i}
      indexed_iter(:reverse_each) {|a,i| a[a.size - i - 1]}
    end

    class ::Hash
      include Iterators
      # these are inefficient and need a place to store 'keys'
      indexed_iter(:each) {|h,i| keys = h.keys; [ keys[i], h[keys[i]] ]}
      indexed_iter(:each_with_index) {|h,i| keys = h.keys; [ [ keys[i], h[keys[i]] ], i]}
    end

    class ::Range
      include Iterators
      cursor_iter(:first, :succ, :last, :each)
    end

    #
    # SyncEnumerator creates an Enumerable object from multiple Enumerable
    # objects and enumerates them synchronously.
    #
    # == Example
    #
    #   require 'generator'
    #
    #   s = SyncEnumerator.new([1,2,3], ['a', 'b', 'c'])
    #
    #   # Yields [1, 'a'], [2, 'b'], and [3,'c']
    #   s.each { |row| puts row.join(', ') }
    #
    class SyncEnumerator
      include Enumerable

      # Creates a new SyncEnumerator which enumerates rows of given
      # Enumerable objects.
      def initialize(*enums)
        @gens = enums.map { |e| Generator.new(e) }
      end

      # Returns the number of enumerated Enumerable objects, i.e. the size
      # of each row.
      def size
        @gens.size
      end

      # Returns the number of enumerated Enumerable objects, i.e. the size
      # of each row.
      def length
        @gens.length
      end

      # Returns true if the given nth Enumerable object has reached the
      # end.  If no argument is given, returns true if any of the
      # Enumerable objects has reached the end.
      def end?(i = nil)
        if i.nil?
          @gens.detect { |g| g.end? } ? true : false
        else
          @gens[i].end?
        end
      end

      # Enumerates rows of the Enumerable objects.
      def each
        @gens.each { |g| g.rewind }

        loop do
          count = 0

          ret = @gens.map { |g|
      if g.end?
        count += 1
        nil
      else
        g.next
      end
          }

          if count == @gens.size
      break
          end

          yield ret
        end

        self
      end
    end
  end
end




© 2015 - 2025 Weber Informatics LLC | Privacy Policy