Type:
Module
Constants:
HISTORY : history

The history buffer. It extends Enumerable module, so it behaves just like an array. For example, gets the fifth content that the user input by HISTORY.

FILENAME_COMPLETION_PROC : fcomp

The Object with the call method that is a completion for filename. This is sets by ::completion_proc= method.

USERNAME_COMPLETION_PROC : ucomp

The Object with the call method that is a completion for usernames. This is sets by ::completion_proc= method.

VERSION : version

Version string of GNU Readline or libedit.

The Readline module provides interface for GNU Readline. This module defines a number of methods to facilitate completion and accesses input history from the Ruby interpreter. This module supported Edit Line(libedit) too. libedit is compatible with GNU Readline.

GNU Readline

www.gnu.org/directory/readline.html

libedit

www.thrysoee.dk/editline/

Reads one inputted line with line edit by ::readline method. At this time, the facilitatation completion and the key bind like Emacs can be operated like GNU Readline.

1
2
3
4
require "readline"
while buf = Readline.readline("> ", true)
  p buf
end

The content that the user input can be recorded to the history. The history can be accessed by Readline::HISTORY constant.

1
2
3
4
5
require "readline"
while buf = Readline.readline("> ", true)
  p Readline::HISTORY.to_a
  print("-> ", buf, "\n")
end

Most of methods raise SecurityError exception if $SAFE is 4.

Documented by TAKAO Kouji <kouji at takao7 dot net>.

completion_proc
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.completion_proc â proc Class Public methods Returns the completion

2025-01-10 15:47:30
completion_proc=
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.completion_proc = proc Class Public methods Specifies a

2025-01-10 15:47:30
get_screen_size
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.get_screen_size â [rows, columns] Class Public methods Returns the

2025-01-10 15:47:30
refresh_line
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.refresh_line â nil Class Public methods Clear the current input line

2025-01-10 15:47:30
emacs_editing_mode
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.emacs_editing_mode â nil Class Public methods Specifies Emacs editing

2025-01-10 15:47:30
basic_quote_characters
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.basic_quote_characters â string Class Public methods Gets a list of

2025-01-10 15:47:30
basic_word_break_characters=
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.basic_word_break_characters = string Class Public methods Sets the

2025-01-10 15:47:30
vi_editing_mode
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.vi_editing_mode â nil Class Public methods Specifies VI editing mode

2025-01-10 15:47:30
completion_case_fold
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.completion_case_fold â bool Class Public methods Returns true if completion

2025-01-10 15:47:30
readline
  • References/Ruby on Rails/Ruby/Classes/Readline

Readline.readline(prompt = "", add_hist = false) â string or nil Class Public methods Shows

2025-01-10 15:47:30