Module: Bond::Readline

Defined in:
lib/bond/readline.rb

Overview

This is the default readline plugin for Bond. A valid plugin must be a module that defines methods setup and line_buffer as described below.

Constant Summary

DefaultBreakCharacters = 
" \t\n\"\\'`><=;|&{("

Instance Method Summary (collapse)

Instance Method Details

- (Object) line_buffer

Returns full line of what the user has typed. 



31
32
33
 
# File 'lib/bond/readline.rb', line 31

def line_buffer
  ::Readline.line_buffer
end

- (Object) load_extension 



24
25
26
27
28
 
# File 'lib/bond/readline.rb', line 24

def load_extension
  require 'readline_line_buffer'
rescue LoadError
  $stderr.puts "Bond Error: Failed to load readline_line_buffer.bundle. Ensure that it exists and was built correctly."
end

- (Object) setup(agent)

Loads the readline-like library and sets the completion_proc to the given agent. 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/bond/readline.rb', line 8

def setup(agent)
  require 'readline'
  load_extension unless ::Readline.respond_to?(:line_buffer)

  # Reinforcing irb defaults
  ::Readline.completion_append_character = nil
  if ::Readline.respond_to?("basic_word_break_characters=")
    ::Readline.basic_word_break_characters = DefaultBreakCharacters
  end

  ::Readline.completion_proc = agent
  if (::Readline::VERSION rescue nil).to_s[/editline/i]
    puts "Bond has detected EditLine and may not work with it. See the README's Limitations section."
  end
end