class IRB::ReadlineInputMethod - RDoc Documentation

# class IRB::ReadlineInputMethod

### Public Class Methods

initialize_readline() click to toggle source

    # File lib/irb/input-method.rb, line 180
    def self.initialize_readline
      require "readline"
    rescue LoadError
    else
      include ::Readline
    end

new() click to toggle source

Creates a new input method object using `Readline`

Calls superclass method `IRB::InputMethod::new`

    # File lib/irb/input-method.rb, line 188
    def initialize
      self.class.initialize_readline
      if Readline.respond_to?(:encoding_system_needs)
        IRB.__send__(:set_encoding, Readline.encoding_system_needs.name, override: false)
      end
      super

      @line_no = 0
      @line = []
      @eof = false

      @stdin = IO.open(STDIN.to_i, :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")
      @stdout = IO.open(STDOUT.to_i, 'w', :external_encoding => IRB.conf[:LC_MESSAGES].encoding, :internal_encoding => "-")

      if Readline.respond_to?("basic_word_break_characters=")
        Readline.basic_word_break_characters = IRB::InputCompletor::BASIC_WORD_BREAK_CHARACTERS
      end
      Readline.completion_append_character = nil
      Readline.completion_proc = IRB::InputCompletor::CompletionProc
    end

### Public Instance Methods

encoding() click to toggle source

The external encoding for standard input.

    # File lib/irb/input-method.rb, line 250
    def encoding
      @stdin.external_encoding
    end

eof?() click to toggle source

Whether the end of this input method has been reached, returns `true` if there is no more data to read.

See `IO#eof?` for more information.

    # File lib/irb/input-method.rb, line 228
    def eof?
      @eof
    end

gets() click to toggle source

Reads the next line from this input method.

See `IO#gets` for more information.

    # File lib/irb/input-method.rb, line 212
    def gets
      Readline.input = @stdin
      Readline.output = @stdout
      if l = readline(@prompt, false)
        HISTORY.push(l) if !l.empty?
        @line[@line_no += 1] = l + "\n"
      else
        @eof = true
        l
      end
    end

inspect() click to toggle source

For debug message

    # File lib/irb/input-method.rb, line 255
    def inspect
      readline_impl = (defined?(Reline) && Readline == Reline) ? 'Reline' : 'ext/readline'
      str = "ReadlineInputMethod with #{readline_impl} #{Readline::VERSION}"
      inputrc_path = File.expand_path(ENV['INPUTRC'] || '~/.inputrc')
      str += " and #{inputrc_path}" if File.exist?(inputrc_path)
      str
    end

line(line_no) click to toggle source

Returns the current line number for io.

`line` counts the number of times `gets` is called.

See `IO#lineno` for more information.

    # File lib/irb/input-method.rb, line 245
    def line(line_no)
      @line[line_no]
    end

readable_after_eof?() click to toggle source

Whether this input method is still readable when there is no more data to read.

See `IO#eof` for more information.

    # File lib/irb/input-method.rb, line 236
    def readable_after_eof?
      true
    end