Module: Readline
- Defined in:
- readline.c
Constant Summary collapse
- 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.
history
- FILENAME_COMPLETION_PROC =
The Object with the call method that is a completion for filename. This is sets by Readline.completion_proc= method.
fcomp
- USERNAME_COMPLETION_PROC =
The Object with the call method that is a completion for usernames. This is sets by Readline.completion_proc= method.
ucomp
- VERSION =
Version string of GNU Readline or libedit.
version
Class Method Summary collapse
-
.basic_quote_characters ⇒ String
Gets a list of quote characters which can cause a word break.
-
.basic_quote_characters=(string) ⇒ Object
Sets a list of quote characters which can cause a word break.
-
.basic_word_break_characters ⇒ String
Gets the basic list of characters that signal a break between words for the completer routine.
-
.basic_word_break_characters=(string) ⇒ Object
Sets the basic list of characters that signal a break between words for the completer routine.
-
.completer_quote_characters ⇒ String
Gets a list of characters which can be used to quote a substring of the line.
-
.completer_quote_characters=(string) ⇒ Object
Sets a list of characters which can be used to quote a substring of the line.
-
.completer_word_break_characters ⇒ String
Gets the basic list of characters that signal a break between words for rl_complete_internal().
-
.completer_word_break_characters=(string) ⇒ Object
Sets the basic list of characters that signal a break between words for rl_complete_internal().
-
.completion_append_character ⇒ String
Returns a string containing a character to be appended on completion.
-
.completion_append_character=(char) ⇒ Object
Specifies a character to be appended on completion.
-
.completion_case_fold ⇒ Boolean
Returns true if completion ignores case.
-
.completion_case_fold=(bool) ⇒ Object
Sets whether or not to ignore case on completion.
-
.completion_proc ⇒ Proc
Returns the completion Proc object.
-
.completion_proc=(proc) ⇒ Object
Specifies a Proc object
proc
to determine completion behavior. -
.delete_text ⇒ Object
Delete text between start and end in the current line.
-
.emacs_editing_mode ⇒ nil
Specifies Emacs editing mode.
-
.emacs_editing_mode? ⇒ Boolean
Returns true if emacs mode is active.
-
.filename_quote_characters ⇒ String
Gets a list of characters that cause a filename to be quoted by the completer when they appear in a completed filename.
-
.filename_quote_characters=(string) ⇒ Object
Sets a list of characters that cause a filename to be quoted by the completer when they appear in a completed filename.
-
.get_screen_size ⇒ Array
Returns the terminal’s rows and columns.
-
.input=(input) ⇒ Object
Specifies a File object
input
that is input stream for Readline.readline method. -
.insert_text(string) ⇒ self
Insert text into the line at the current cursor position.
-
.line_buffer ⇒ String
Returns the full line that is being edited.
-
.output=(output) ⇒ Object
Specifies a File object
output
that is output stream for Readline.readline method. -
.point ⇒ Integer
Returns the index of the current cursor position in
Readline.line_buffer
. -
.point=(int) ⇒ Object
Set the index of the current cursor position in
Readline.line_buffer
. -
.pre_input_hook ⇒ Proc
Returns a Proc object
proc
to call after the first prompt has been printed and just before readline starts reading input characters. -
.pre_input_hook=(proc) ⇒ Object
Specifies a Proc object
proc
to call after the first prompt has been printed and just before readline starts reading input characters. -
.readline(prompt = "", add_hist = false) ⇒ String?
Shows the
prompt
and reads the inputted line with line editing. -
.redisplay ⇒ self
Change what’s displayed on the screen to reflect the current contents.
-
.refresh_line ⇒ nil
Clear the current input line.
-
.set_screen_size(rows, columns) ⇒ self
Set terminal size to
rows
andcolumns
. -
.special_prefixes ⇒ String
Gets the list of characters that are word break characters, but should be left in text when it is passed to the completion function.
-
.special_prefixes=(string) ⇒ Object
Sets the list of characters that are word break characters, but should be left in text when it is passed to the completion function.
-
.vi_editing_mode ⇒ nil
Specifies VI editing mode.
-
.vi_editing_mode? ⇒ Boolean
Returns true if vi mode is active.
Class Method Details
.basic_quote_characters ⇒ String
Gets a list of quote characters which can cause a word break.
Raises NotImplementedError if the using readline library does not support.
1426 1427 1428 1429 1430 1431 1432 |
# File 'readline.c', line 1426
static VALUE
readline_s_get_basic_quote_characters(VALUE self, VALUE str)
{
if (rl_basic_quote_characters == NULL)
return Qnil;
return rb_locale_str_new_cstr(rl_basic_quote_characters);
}
|
.basic_quote_characters=(string) ⇒ Object
Sets a list of quote characters which can cause a word break.
Raises NotImplementedError if the using readline library does not support.
1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 |
# File 'readline.c', line 1393
static VALUE
readline_s_set_basic_quote_characters(VALUE self, VALUE str)
{
static char *basic_quote_characters = NULL;
OutputStringValue(str);
if (basic_quote_characters == NULL) {
basic_quote_characters =
ALLOC_N(char, RSTRING_LEN(str) + 1);
}
else {
REALLOC_N(basic_quote_characters, char, RSTRING_LEN(str) + 1);
}
strncpy(basic_quote_characters,
RSTRING_PTR(str), RSTRING_LEN(str));
basic_quote_characters[RSTRING_LEN(str)] = '\0';
rl_basic_quote_characters = basic_quote_characters;
return self;
}
|
.basic_word_break_characters ⇒ String
Gets the basic list of characters that signal a break between words for the completer routine.
Raises NotImplementedError if the using readline library does not support.
1256 1257 1258 1259 1260 1261 1262 |
# File 'readline.c', line 1256
static VALUE
readline_s_get_basic_word_break_characters(VALUE self, VALUE str)
{
if (rl_basic_word_break_characters == NULL)
return Qnil;
return rb_locale_str_new_cstr(rl_basic_word_break_characters);
}
|
.basic_word_break_characters=(string) ⇒ Object
Sets the basic list of characters that signal a break between words for the completer routine. The default is the characters which break words for completion in Bash: “ tn"\‘`@$><=;|&{(”.
Raises NotImplementedError if the using readline library does not support.
1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 |
# File 'readline.c', line 1223
static VALUE
readline_s_set_basic_word_break_characters(VALUE self, VALUE str)
{
static char *basic_word_break_characters = NULL;
OutputStringValue(str);
if (basic_word_break_characters == NULL) {
basic_word_break_characters =
ALLOC_N(char, RSTRING_LEN(str) + 1);
}
else {
REALLOC_N(basic_word_break_characters, char, RSTRING_LEN(str) + 1);
}
strncpy(basic_word_break_characters,
RSTRING_PTR(str), RSTRING_LEN(str));
basic_word_break_characters[RSTRING_LEN(str)] = '\0';
rl_basic_word_break_characters = basic_word_break_characters;
return self;
}
|
.completer_quote_characters ⇒ String
Gets a list of characters which can be used to quote a substring of the line.
Raises NotImplementedError if the using readline library does not support.
1482 1483 1484 1485 1486 1487 1488 |
# File 'readline.c', line 1482
static VALUE
readline_s_get_completer_quote_characters(VALUE self, VALUE str)
{
if (rl_completer_quote_characters == NULL)
return Qnil;
return rb_locale_str_new_cstr(rl_completer_quote_characters);
}
|
.completer_quote_characters=(string) ⇒ Object
Sets a list of characters which can be used to quote a substring of the line. Completion occurs on the entire substring, and within the substring Readline.completer_word_break_characters are treated as any other character, unless they also appear within this list.
Raises NotImplementedError if the using readline library does not support.
1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 |
# File 'readline.c', line 1449
static VALUE
readline_s_set_completer_quote_characters(VALUE self, VALUE str)
{
static char *completer_quote_characters = NULL;
OutputStringValue(str);
if (completer_quote_characters == NULL) {
completer_quote_characters =
ALLOC_N(char, RSTRING_LEN(str) + 1);
}
else {
REALLOC_N(completer_quote_characters, char, RSTRING_LEN(str) + 1);
}
strncpy(completer_quote_characters, RSTRING_PTR(str), RSTRING_LEN(str));
completer_quote_characters[RSTRING_LEN(str)] = '\0';
rl_completer_quote_characters = completer_quote_characters;
return self;
}
|
.completer_word_break_characters ⇒ String
Gets the basic list of characters that signal a break between words for rl_complete_internal().
Raises NotImplementedError if the using readline library does not support.
1311 1312 1313 1314 1315 1316 1317 |
# File 'readline.c', line 1311
static VALUE
readline_s_get_completer_word_break_characters(VALUE self, VALUE str)
{
if (rl_completer_word_break_characters == NULL)
return Qnil;
return rb_locale_str_new_cstr(rl_completer_word_break_characters);
}
|
.completer_word_break_characters=(string) ⇒ Object
Sets the basic list of characters that signal a break between words for rl_complete_internal(). The default is the value of Readline.basic_word_break_characters.
Raises NotImplementedError if the using readline library does not support.
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 |
# File 'readline.c', line 1278
static VALUE
readline_s_set_completer_word_break_characters(VALUE self, VALUE str)
{
static char *completer_word_break_characters = NULL;
OutputStringValue(str);
if (completer_word_break_characters == NULL) {
completer_word_break_characters =
ALLOC_N(char, RSTRING_LEN(str) + 1);
}
else {
REALLOC_N(completer_word_break_characters, char, RSTRING_LEN(str) + 1);
}
strncpy(completer_word_break_characters,
RSTRING_PTR(str), RSTRING_LEN(str));
completer_word_break_characters[RSTRING_LEN(str)] = '\0';
rl_completer_word_break_characters = completer_word_break_characters;
return self;
}
|
.completion_append_character ⇒ String
Returns a string containing a character to be appended on completion. The default is a space (“ ”).
Raises NotImplementedError if the using readline library does not support.
1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 |
# File 'readline.c', line 1197
static VALUE
readline_s_get_completion_append_character(VALUE self)
{
char buf[1];
if (rl_completion_append_character == '\0')
return Qnil;
buf[0] = (char) rl_completion_append_character;
return rb_locale_str_new(buf, 1);
}
|
.completion_append_character=(char) ⇒ Object
Specifies a character to be appended on completion. Nothing will be appended if an empty string (“”) or nil is specified.
For example:
require "readline"
Readline.readline("> ", true)
Readline.completion_append_character = " "
Result:
>
Input "/var/li".
> /var/li
Press TAB key.
> /var/lib
Completes "b" and appends " ". So, you can continuously input "/usr".
> /var/lib /usr
NOTE: Only one character can be specified. When “string” is specified, sets only “s” that is the first.
require "readline"
Readline.completion_append_character = "string"
p Readline.completion_append_character # => "s"
Raises NotImplementedError if the using readline library does not support.
1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 |
# File 'readline.c', line 1167
static VALUE
readline_s_set_completion_append_character(VALUE self, VALUE str)
{
if (NIL_P(str)) {
rl_completion_append_character = '\0';
}
else {
OutputStringValue(str);
if (RSTRING_LEN(str) == 0) {
rl_completion_append_character = '\0';
} else {
rl_completion_append_character = RSTRING_PTR(str)[0];
}
}
return self;
}
|
.completion_case_fold ⇒ Boolean
857 858 859 860 861 |
# File 'readline.c', line 857
static VALUE
readline_s_get_completion_case_fold(VALUE self)
{
return rb_attr_get(mReadline, completion_case_fold);
}
|
.completion_case_fold=(bool) ⇒ Object
Sets whether or not to ignore case on completion.
837 838 839 840 841 |
# File 'readline.c', line 837
static VALUE
readline_s_set_completion_case_fold(VALUE self, VALUE val)
{
return rb_ivar_set(mReadline, completion_case_fold, val);
}
|
.completion_proc ⇒ Proc
Returns the completion Proc object.
825 826 827 828 829 |
# File 'readline.c', line 825
static VALUE
readline_s_get_completion_proc(VALUE self)
{
return rb_attr_get(mReadline, completion_proc);
}
|
.completion_proc=(proc) ⇒ Object
Specifies a Proc object proc
to determine completion behavior. It should take input string and return an array of completion candidates.
The default completion is used if proc
is nil.
The String that is passed to the Proc depends on the Readline.completer_word_break_characters property. By default the word under the cursor is passed to the Proc. For example, if the input is “foo bar” then only “bar” would be passed to the completion Proc.
Upon successful completion the Readline.completion_append_character will be appended to the input so the user can start working on their next argument.
Examples
Completion for a Static List
require 'readline'
LIST = [
'search', 'download', 'open',
'help', 'history', 'quit',
'url', 'next', 'clear',
'prev', 'past'
].sort
comp = proc { |s| LIST.grep(/^#{Regexp.escape(s)}/) }
Readline.completion_append_character = " "
Readline.completion_proc = comp
while line = Readline.readline('> ', true)
p line
end
Completion For Directory Contents
require 'readline'
Readline.completion_append_character = " "
Readline.completion_proc = Proc.new do |str|
Dir[str+'*'].grep(/^#{Regexp.escape(str)}/)
end
while line = Readline.readline('> ', true)
p line
end
Autocomplete strategies
When working with auto-complete there are some strategies that work well. To get some ideas you can take a look at the completion.rb file for irb.
The common strategy is to take a list of possible completions and filter it down to those completions that start with the user input. In the above examples Enumerator.grep is used. The input is escaped to prevent Regexp special characters from interfering with the matching.
It may also be helpful to use the Abbrev library to generate completions.
Raises ArgumentError if proc
does not respond to the call method.
811 812 813 814 815 816 817 |
# File 'readline.c', line 811
static VALUE
readline_s_set_completion_proc(VALUE self, VALUE proc)
{
if (!NIL_P(proc) && !rb_respond_to(proc, rb_intern("call")))
rb_raise(rb_eArgError, "argument must respond to `call'");
return rb_ivar_set(mReadline, completion_proc, proc);
}
|
.delete_text([start[, length]]) ⇒ self .delete_text(start..end) ⇒ self .delete_text ⇒ self
Delete text between start and end in the current line.
See GNU Readline’s rl_delete_text function.
Raises NotImplementedError if the using readline library does not support.
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 |
# File 'readline.c', line 683
static VALUE
readline_s_delete_text(int argc, VALUE *argv, VALUE self)
{
rb_check_arity(argc, 0, 2);
if (rl_line_buffer) {
char *p, *ptr = rl_line_buffer;
long beg = 0, len = strlen(rl_line_buffer);
struct RString fakestr;
VALUE str = (VALUE)&fakestr;
fakestr.basic.flags = T_STRING | RSTRING_NOEMBED;
fakestr.as.heap.ptr = ptr;
fakestr.as.heap.len = len;
rb_enc_associate(str, rb_locale_encoding());
OBJ_FREEZE(str);
if (argc == 2) {
beg = NUM2LONG(argv[0]);
len = NUM2LONG(argv[1]);
num_pos:
p = rb_str_subpos(str, beg, &len);
if (!p) rb_raise(rb_eArgError, "invalid index");
beg = p - ptr;
}
else if (argc == 1) {
len = rb_str_strlen(str);
if (!rb_range_beg_len(argv[0], &beg, &len, len, 1)) {
beg = NUM2LONG(argv[0]);
goto num_pos;
}
}
rl_delete_text(rb_long2int(beg), rb_long2int(beg + len));
}
return self;
}
|
.emacs_editing_mode ⇒ nil
Specifies Emacs editing mode. The default is this mode. See the manual of GNU Readline for details of Emacs editing mode.
Raises NotImplementedError if the using readline library does not support.
1102 1103 1104 1105 1106 1107 |
# File 'readline.c', line 1102
static VALUE
readline_s_emacs_editing_mode(VALUE self)
{
rl_emacs_editing_mode(1,0);
return Qnil;
}
|
.emacs_editing_mode? ⇒ Boolean
Returns true if emacs mode is active. Returns false if not.
Raises NotImplementedError if the using readline library does not support.
1121 1122 1123 1124 1125 |
# File 'readline.c', line 1121
static VALUE
readline_s_emacs_editing_mode_p(VALUE self)
{
return rl_editing_mode == 1 ? Qtrue : Qfalse;
}
|
.filename_quote_characters ⇒ String
Gets a list of characters that cause a filename to be quoted by the completer when they appear in a completed filename.
Raises NotImplementedError if the using readline library does not support.
1536 1537 1538 1539 1540 1541 1542 |
# File 'readline.c', line 1536
static VALUE
readline_s_get_filename_quote_characters(VALUE self, VALUE str)
{
if (rl_filename_quote_characters == NULL)
return Qnil;
return rb_locale_str_new_cstr(rl_filename_quote_characters);
}
|
.filename_quote_characters=(string) ⇒ Object
Sets a list of characters that cause a filename to be quoted by the completer when they appear in a completed filename. The default is nil.
Raises NotImplementedError if the using readline library does not support.
1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 |
# File 'readline.c', line 1503
static VALUE
readline_s_set_filename_quote_characters(VALUE self, VALUE str)
{
static char *filename_quote_characters = NULL;
OutputStringValue(str);
if (filename_quote_characters == NULL) {
filename_quote_characters =
ALLOC_N(char, RSTRING_LEN(str) + 1);
}
else {
REALLOC_N(filename_quote_characters, char, RSTRING_LEN(str) + 1);
}
strncpy(filename_quote_characters, RSTRING_PTR(str), RSTRING_LEN(str));
filename_quote_characters[RSTRING_LEN(str)] = '\0';
rl_filename_quote_characters = filename_quote_characters;
return self;
}
|
.get_screen_size ⇒ Array
Returns the terminal’s rows and columns.
See GNU Readline’s rl_get_screen_size function.
Raises NotImplementedError if the using readline library does not support.
1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 |
# File 'readline.c', line 1038
static VALUE
readline_s_get_screen_size(VALUE self)
{
int rows, columns;
VALUE res;
rl_get_screen_size(&rows, &columns);
res = rb_ary_new();
rb_ary_push(res, INT2NUM(rows));
rb_ary_push(res, INT2NUM(columns));
return res;
}
|
.input=(input) ⇒ Object
Specifies a File object input
that is input stream for Readline.readline method.
527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 |
# File 'readline.c', line 527
static VALUE
readline_s_set_input(VALUE self, VALUE input)
{
rb_io_t *ifp;
int fd;
FILE *f;
if (NIL_P(input)) {
clear_rl_instream();
}
else {
Check_Type(input, T_FILE);
GetOpenFile(input, ifp);
clear_rl_instream();
fd = rb_cloexec_dup(ifp->fd);
if (fd == -1)
rb_sys_fail("dup");
f = fdopen(fd, "r");
if (f == NULL) {
int save_errno = errno;
close(fd);
errno = save_errno;
rb_sys_fail("fdopen");
}
rl_instream = readline_rl_instream = f;
readline_instream = input;
}
return input;
}
|
.insert_text(string) ⇒ self
Insert text into the line at the current cursor position.
See GNU Readline’s rl_insert_text function.
Raises NotImplementedError if the using readline library does not support.
659 660 661 662 663 664 665 |
# File 'readline.c', line 659
static VALUE
readline_s_insert_text(VALUE self, VALUE str)
{
OutputStringValue(str);
rl_insert_text(RSTRING_PTR(str));
return self;
}
|
.line_buffer ⇒ String
Returns the full line that is being edited. This is useful from within the complete_proc for determining the context of the completion request.
The length of Readline.line_buffer
and GNU Readline’s rl_end are same.
Raises NotImplementedError if the using readline library does not support.
877 878 879 880 881 882 883 |
# File 'readline.c', line 877
static VALUE
readline_s_get_line_buffer(VALUE self)
{
if (rl_line_buffer == NULL)
return Qnil;
return rb_locale_str_new_cstr(rl_line_buffer);
}
|
.output=(output) ⇒ Object
Specifies a File object output
that is output stream for Readline.readline method.
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 |
# File 'readline.c', line 564
static VALUE
readline_s_set_output(VALUE self, VALUE output)
{
rb_io_t *ofp;
int fd;
FILE *f;
if (NIL_P(output)) {
clear_rl_outstream();
}
else {
Check_Type(output, T_FILE);
GetOpenFile(output, ofp);
clear_rl_outstream();
fd = rb_cloexec_dup(ofp->fd);
if (fd == -1)
rb_sys_fail("dup");
f = fdopen(fd, "w");
if (f == NULL) {
int save_errno = errno;
close(fd);
errno = save_errno;
rb_sys_fail("fdopen");
}
rl_outstream = readline_rl_outstream = f;
readline_outstream = output;
}
return output;
}
|
.point ⇒ Integer
Returns the index of the current cursor position in Readline.line_buffer
.
The index in Readline.line_buffer
which matches the start of input-string passed to completion_proc is computed by subtracting the length of input-string from Readline.point
.
start = (the length of input-string) - Readline.point
Raises NotImplementedError if the using readline library does not support.
904 905 906 907 908 |
# File 'readline.c', line 904
static VALUE
readline_s_get_point(VALUE self)
{
return INT2NUM(rl_point);
}
|
.point=(int) ⇒ Object
Set the index of the current cursor position in Readline.line_buffer
.
Raises NotImplementedError if the using readline library does not support.
See Readline.point
.
921 922 923 924 925 926 |
# File 'readline.c', line 921
static VALUE
readline_s_set_point(VALUE self, VALUE pos)
{
rl_point = NUM2INT(pos);
return pos;
}
|
.pre_input_hook ⇒ Proc
Returns a Proc object proc
to call after the first prompt has been printed and just before readline starts reading input characters. The default is nil.
Raises NotImplementedError if the using readline library does not support.
627 628 629 630 631 |
# File 'readline.c', line 627
static VALUE
readline_s_get_pre_input_hook(VALUE self)
{
return rb_attr_get(mReadline, id_pre_input_hook);
}
|
.pre_input_hook=(proc) ⇒ Object
Specifies a Proc object proc
to call after the first prompt has been printed and just before readline starts reading input characters.
See GNU Readline’s rl_pre_input_hook variable.
Raises ArgumentError if proc
does not respond to the call method.
Raises NotImplementedError if the using readline library does not support.
609 610 611 612 613 614 615 |
# File 'readline.c', line 609
static VALUE
readline_s_set_pre_input_hook(VALUE self, VALUE proc)
{
if (!NIL_P(proc) && !rb_respond_to(proc, rb_intern("call")))
rb_raise(rb_eArgError, "argument must respond to `call'");
return rb_ivar_set(mReadline, id_pre_input_hook, proc);
}
|
.readline(prompt = "", add_hist = false) ⇒ String?
Shows the prompt
and reads the inputted line with line editing. The inputted line is added to the history if add_hist
is true.
Returns nil when the inputted line is empty and user inputs EOF (Presses ^D on UNIX).
Raises IOError exception if one of below conditions are satisfied.
-
stdin was closed.
-
stdout was closed.
This method supports thread. Switches the thread context when waits inputting line.
Supports line edit when inputs line. Provides VI and Emacs editing mode. Default is Emacs editing mode.
NOTE: Terminates ruby interpreter and does not return the terminal status after user pressed ‘^C’ when wait inputting line. Give 3 examples that avoid it.
-
Catches the Interrupt exception by pressed ^C after returns terminal status:
require "readline" stty_save = `stty -g`.chomp begin while buf = Readline.readline p buf end rescue Interrupt system("stty", stty_save) exit end end end
-
Catches the INT signal by pressed ^C after returns terminal status:
require "readline" stty_save = `stty -g`.chomp trap("INT") { system "stty", stty_save; exit } while buf = Readline.readline p buf end
-
Ignores pressing ^C:
require "readline" trap("INT", "SIG_IGN") while buf = Readline.readline p buf end
Can make as follows with Readline::HISTORY constant. It does not record to the history if the inputted line is empty or the same it as last one.
require "readline"
while buf = Readline.readline("> ", true)
# p Readline::HISTORY.to_a
Readline::HISTORY.pop if /^\s*$/ =~ buf
begin
if Readline::HISTORY[Readline::HISTORY.length-2] == buf
Readline::HISTORY.pop
end
rescue IndexError
end
# p Readline::HISTORY.to_a
print "-> ", buf, "\n"
end
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 |
# File 'readline.c', line 446
static VALUE
readline_readline(int argc, VALUE *argv, VALUE self)
{
VALUE tmp, add_hist, result;
char *prompt = NULL;
char *buff;
int status;
if (rb_scan_args(argc, argv, "02", &tmp, &add_hist) > 0) {
OutputStringValue(tmp);
#if USE_INSERT_IGNORE_ESCAPE
tmp = insert_ignore_escape(self, tmp);
rb_str_locktmp(tmp);
#endif
prompt = RSTRING_PTR(tmp);
}
if (readline_instream) {
rb_io_t *ifp;
rb_io_check_initialized(ifp = RFILE(rb_io_taint_check(readline_instream))->fptr);
if (ifp->fd < 0) {
clear_rl_instream();
rb_raise(rb_eIOError, "closed readline input");
}
}
if (readline_outstream) {
rb_io_t *ofp;
rb_io_check_initialized(ofp = RFILE(rb_io_taint_check(readline_outstream))->fptr);
if (ofp->fd < 0) {
clear_rl_outstream();
rb_raise(rb_eIOError, "closed readline output");
}
}
#ifdef _WIN32
rl_prep_terminal(1);
#endif
buff = (char*)rb_protect(readline_get, (VALUE)prompt, &status);
#if USE_INSERT_IGNORE_ESCAPE
if (prompt) {
rb_str_unlocktmp(tmp);
}
#endif
if (status) {
#if defined HAVE_RL_CLEANUP_AFTER_SIGNAL
/* restore terminal mode and signal handler*/
#if defined HAVE_RL_FREE_LINE_STATE
rl_free_line_state();
#endif
rl_cleanup_after_signal();
#elif defined HAVE_RL_DEPREP_TERM_FUNCTION
/* restore terminal mode */
if (rl_deprep_term_function != NULL) /* NULL in libedit. [ruby-dev:29116] */
(*rl_deprep_term_function)();
else
#else
rl_deprep_terminal();
#endif
rb_jump_tag(status);
}
if (RTEST(add_hist) && buff) {
add_history(buff);
}
if (buff) {
result = rb_locale_str_new_cstr(buff);
}
else
result = Qnil;
if (buff) free(buff);
return result;
}
|
.redisplay ⇒ self
Change what’s displayed on the screen to reflect the current contents.
See GNU Readline’s rl_redisplay function.
Raises NotImplementedError if the using readline library does not support.
733 734 735 736 737 738 |
# File 'readline.c', line 733
static VALUE
readline_s_redisplay(VALUE self)
{
rl_redisplay();
return self;
}
|
.refresh_line ⇒ nil
Clear the current input line.
1554 1555 1556 1557 1558 1559 |
# File 'readline.c', line 1554
static VALUE
readline_s_refresh_line(VALUE self)
{
rl_refresh_line(0, 0);
return Qnil;
}
|
.set_screen_size(rows, columns) ⇒ self
Set terminal size to rows
and columns
.
See GNU Readline’s rl_set_screen_size function.
Raises NotImplementedError if the using readline library does not support.
1017 1018 1019 1020 1021 1022 |
# File 'readline.c', line 1017
static VALUE
readline_s_set_screen_size(VALUE self, VALUE rows, VALUE columns)
{
rl_set_screen_size(NUM2INT(rows), NUM2INT(columns));
return self;
}
|
.special_prefixes ⇒ String
Gets the list of characters that are word break characters, but should be left in text when it is passed to the completion function.
See GNU Readline’s rl_special_prefixes variable.
Raises NotImplementedError if the using readline library does not support.
1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 |
# File 'readline.c', line 1367
static VALUE
readline_s_get_special_prefixes(VALUE self)
{
VALUE str;
if (rl_special_prefixes == NULL) return Qnil;
str = rb_ivar_get(mReadline, id_special_prefixes);
if (!NIL_P(str)) {
str = rb_str_dup_frozen(str);
rb_obj_reveal(str, rb_cString);
}
return str;
}
|
.special_prefixes=(string) ⇒ Object
Sets the list of characters that are word break characters, but should be left in text when it is passed to the completion function. Programs can use this to help determine what kind of completing to do. For instance, Bash sets this variable to “$@” so that it can complete shell variables and hostnames.
See GNU Readline’s rl_special_prefixes variable.
Raises NotImplementedError if the using readline library does not support.
1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 |
# File 'readline.c', line 1337
static VALUE
readline_s_set_special_prefixes(VALUE self, VALUE str)
{
if (!NIL_P(str)) {
OutputStringValue(str);
str = rb_str_dup_frozen(str);
rb_obj_hide(str);
}
rb_ivar_set(mReadline, id_special_prefixes, str);
if (NIL_P(str)) {
rl_special_prefixes = NULL;
}
else {
rl_special_prefixes = RSTRING_PTR(str);
}
return self;
}
|
.vi_editing_mode ⇒ nil
Specifies VI editing mode. See the manual of GNU Readline for details of VI editing mode.
Raises NotImplementedError if the using readline library does not support.
1064 1065 1066 1067 1068 1069 |
# File 'readline.c', line 1064
static VALUE
readline_s_vi_editing_mode(VALUE self)
{
rl_vi_editing_mode(1,0);
return Qnil;
}
|
.vi_editing_mode? ⇒ Boolean
Returns true if vi mode is active. Returns false if not.
Raises NotImplementedError if the using readline library does not support.
1083 1084 1085 1086 1087 |
# File 'readline.c', line 1083
static VALUE
readline_s_vi_editing_mode_p(VALUE self)
{
return rl_editing_mode == 0 ? Qtrue : Qfalse;
}
|