Class: IRB::ReadlineInputMethod

Inherits:
StdioInputMethod show all
Includes:
HistorySavingAbility
Defined in:
lib/irb/input-method.rb

Constant Summary

Constants inherited from InputMethod

InputMethod::BASIC_WORD_BREAK_CHARACTERS

Instance Attribute Summary

Attributes inherited from InputMethod

#prompt

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HistorySavingAbility

#load_history, #reset_history_counter, #save_history, #support_history_saving?

Methods inherited from StdioInputMethod

#encoding, #line, #readable_after_eof?

Methods inherited from InputMethod

#readable_after_eof?, #support_history_saving?, #winsize

Constructor Details

#initialize ⇒ ReadlineInputMethod

Creates a new input method object using Readline



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/irb/input-method.rb', line 186

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

  @eof = false
  @completor = RegexpCompletor.new

  if Readline.respond_to?("basic_word_break_characters=")
    Readline.basic_word_break_characters = BASIC_WORD_BREAK_CHARACTERS
  end
  Readline.completion_append_character = nil
  Readline.completion_proc = ->(target) {
    bind = IRB.conf[:MAIN_CONTEXT].workspace.binding
    @completor.completion_candidates('', target, '', bind: bind)
  }
end

Class Method Details

.initialize_readline ⇒ Object 



175
176
177
178
179
180
 
# File 'lib/irb/input-method.rb', line 175

def initialize_readline
  require "readline"
rescue LoadError
else
  include ::Readline
end

Instance Method Details

#completion_info ⇒ Object 



207
208
209
 
# File 'lib/irb/input-method.rb', line 207

def completion_info
  'RegexpCompletor'
end

#eof? ⇒ Boolean

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.

Returns:

  • (Boolean) 


230
231
232
 
# File 'lib/irb/input-method.rb', line 230

def eof?
  @eof
end

#gets ⇒ Object

Reads the next line from this input method.

See IO#gets for more information.



214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/irb/input-method.rb', line 214

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 ⇒ Object

For debug message



239
240
241
242
243
244
245
 
# File 'lib/irb/input-method.rb', line 239

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

#prompting? ⇒ Boolean

Returns:

  • (Boolean) 


234
235
236
 
# File 'lib/irb/input-method.rb', line 234

def prompting?
  true
end