1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* ext/.document: added readline/readline.c.

* ext/readline/readline.c: changed Copyright. added RDoc.

* ext/readline/README.ja: fixed typo.

* ext/readline/README: contents was moved RDoc.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@18420 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
kouji 2008-08-07 15:06:36 +00:00
parent 1504652373
commit fedc035ab8
5 changed files with 422 additions and 66 deletions

View file

@ -1,3 +1,13 @@
Fri Aug 8 00:05:02 2008 TAKAO Kouji <kouji@takao7.net>
* ext/.document: added readline/readline.c.
* ext/readline/readline.c: changed Copyright. added RDoc.
* ext/readline/README.ja: fixed typo.
* ext/readline/README: contents was moved RDoc.
Thu Aug 7 23:43:11 2008 Tanaka Akira <akr@fsij.org>
* transcode_data.h (rb_transcoding): new field "stateful".

View file

@ -8,6 +8,7 @@ iconv/iconv.c
io/wait/wait.c
nkf/lib/kconv.rb
nkf/nkf.c
readline/readline.c
socket/socket.c
stringio/stringio.c
strscan/strscan.c

View file

@ -1,62 +1,10 @@
Extension for GNU Readline Library
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.
Example:
GNU Readline:: http://www.gnu.org/directory/readline.html
libedit:: http://www.thrysoee.dk/editline/
require "readline"
include Readline
line = readline("Prompt> ", true)
[Readline]
<module function>
readline(prompt, add_history=nil)
Reads one line with line editing. The inputted line is added to the
history if add_history is true.
<class methods>
completion_proc = proc
Specifies a Proc object to determine completion behavior. It
should take input-string, and return an array of completion
candidates.
completion_proc
Returns the completion Proc object.
completion_case_fold = bool
Sets whether or not to ignore case on completion.
completion_case_fold
Returns true if completion ignores case.
completion_append_character = char
Specifies a character to be appended on completion.
Nothing will be appended if an empty string ("") or nil is
specified.
completion_append_character
Returns a string containing a character to be appended on
completion. The default is a space (" ").
vi_editing_mode
Specifies VI editing mode.
emacs_editing_mode
Specifies Emacs editing mode.
<class constants>
HISTORY
The history buffer. It behaves just like an array.
See RDoc for Readline module.

View file

@ -309,7 +309,7 @@ Readline.completer_quote_characters = string
ユーザの入力の補完を行う際、スペースなどの単語の区切りを
クオートするための複数の文字で構成される文字列 string を指定します。
回年した矢机の粗では、Readline::completer_word_break_characters=
回年した矢机の粗では、Readline.completer_word_break_characters=
で指定した文字列に含まれる文字も、普通の文字列として扱われます。
サポートしていない環境では、例外 NotImplementedError が発生します。

View file

@ -1,5 +1,19 @@
/* readline.c -- GNU Readline module
Copyright (C) 1997-2001 Shugo Maeda */
/************************************************
readline.c - GNU Readline module
$Author$
created at: Wed Jan 20 13:59:32 JST 1999
Copyright (C) 1997-2008 Shugo Maeda
Copyright (C) 2008 TAKAO Kouji
$Id$
Contact:
- TAKAO Kouji <kouji at takao7 dot net> (current maintainer)
************************************************/
#ifdef RUBY_EXTCONF_H
#include RUBY_EXTCONF_H
@ -53,6 +67,41 @@ static char **readline_attempted_completion_function(const char *text,
#ifdef HAVE_RL_EVENT_HOOK
#define BUSY_WAIT 0
/*
* Document-class: Readline
*
* 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:: http://www.gnu.org/directory/readline.html
* libedit:: http://www.thrysoee.dk/editline/
*
* Reads one inputted line with line edit by Readline.readline method.
* At this time, the facilitatation completion and the key
* bind like Emacs can be operated like GNU Readline.
*
* 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.
*
* 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>.
*/
static int readline_event(void);
static int
readline_event(void)
@ -70,6 +119,92 @@ readline_event(void)
}
#endif
/*
* call-seq:
* Readline.readline(prompt = "", add_hist = false) -> string or nil
*
* 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 below conditions are satisfied.
* 1. stdin is not tty.
* 2. stdin was closed. (errno is EBADF after called isatty(2).)
*
* This method supports thread. Switchs 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
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_readline(int argc, VALUE *argv, VALUE self)
{
@ -116,6 +251,15 @@ readline_readline(int argc, VALUE *argv, VALUE self)
return result;
}
/*
* call-seq:
* Readline.input = input
*
* Specifies a File object +input+ that is input stream for
* Readline.readline method.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_input(VALUE self, VALUE input)
{
@ -128,6 +272,15 @@ readline_s_set_input(VALUE self, VALUE input)
return input;
}
/*
* call-seq:
* Readline.output = output
*
* Specifies a File object +output+ that is output stream for
* Readline.readline method.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_output(VALUE self, VALUE output)
{
@ -140,6 +293,18 @@ readline_s_set_output(VALUE self, VALUE output)
return output;
}
/*
* call-seq:
* Readline.completion_proc = proc
*
* Specifies a Proc object +proc+ to determine completion behavior. It
* should take input-string, and return an array of completion
* candidates.
*
* Raises ArgumentError exception if +proc+ does not respond to call method.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_completion_proc(VALUE self, VALUE proc)
{
@ -149,6 +314,14 @@ readline_s_set_completion_proc(VALUE self, VALUE proc)
return rb_ivar_set(mReadline, completion_proc, proc);
}
/*
* call-seq:
* Readline.completion_proc -> proc
*
* Returns the completion Proc object.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_completion_proc(VALUE self)
{
@ -156,6 +329,14 @@ readline_s_get_completion_proc(VALUE self)
return rb_attr_get(mReadline, completion_proc);
}
/*
* call-seq:
* Readline.completion_case_fold = bool
*
* Sets whether or not to ignore case on completion.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_completion_case_fold(VALUE self, VALUE val)
{
@ -163,6 +344,22 @@ readline_s_set_completion_case_fold(VALUE self, VALUE val)
return rb_ivar_set(mReadline, completion_case_fold, val);
}
/*
* call-seq:
* Readline.completion_case_fold -> bool
*
* Returns true if completion ignores case. If no, returns false.
*
* NOTE: Returns the same object that is specified by
* Readline.completion_case_fold= method.
*
* require "readline"
*
* Readline.completion_case_fold = "This is a String."
* p Readline.completion_case_fold # => "This is a String."
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_completion_case_fold(VALUE self)
{
@ -234,6 +431,17 @@ readline_attempted_completion_function(const char *text, int start, int end)
return result;
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_vi_editing_mode(VALUE self)
{
@ -247,6 +455,17 @@ readline_s_vi_editing_mode(VALUE self)
#endif /* HAVE_RL_VI_EDITING_MODE */
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_emacs_editing_mode(VALUE self)
{
@ -260,6 +479,44 @@ readline_s_emacs_editing_mode(VALUE self)
#endif /* HAVE_RL_EMACS_EDITING_MODE */
}
/*
* call-seq:
* Readline.completion_append_character = char
*
* 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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_completion_append_character(VALUE self, VALUE str)
{
@ -283,6 +540,17 @@ readline_s_set_completion_append_character(VALUE self, VALUE str)
#endif /* HAVE_RL_COMPLETION_APPEND_CHARACTER */
}
/*
* call-seq:
* Readline.completion_append_character -> char
*
* 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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_completion_append_character(VALUE self)
{
@ -302,6 +570,18 @@ readline_s_get_completion_append_character(VALUE self)
#endif /* HAVE_RL_COMPLETION_APPEND_CHARACTER */
}
/*
* call-seq:
* Readline.basic_word_break_characters = string
*
* 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: "\t\n\"\\'`@$><=;|&{(".
*
* Raises NotImplementedError if the using readline library does not support.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_basic_word_break_characters(VALUE self, VALUE str)
{
@ -328,6 +608,17 @@ readline_s_set_basic_word_break_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_BASIC_WORD_BREAK_CHARACTERS */
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_basic_word_break_characters(VALUE self, VALUE str)
{
@ -342,6 +633,18 @@ readline_s_get_basic_word_break_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_BASIC_WORD_BREAK_CHARACTERS */
}
/*
* call-seq:
* Readline.completer_word_break_characters = string
*
* 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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_completer_word_break_characters(VALUE self, VALUE str)
{
@ -368,6 +671,17 @@ readline_s_set_completer_word_break_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_COMPLETER_WORD_BREAK_CHARACTERS */
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_completer_word_break_characters(VALUE self, VALUE str)
{
@ -382,6 +696,16 @@ readline_s_get_completer_word_break_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_COMPLETER_WORD_BREAK_CHARACTERS */
}
/*
* call-seq:
* Readline.basic_quote_characters = string
*
* Sets a list of quote characters which can cause a word break.
*
* Raises NotImplementedError if the using readline library does not support.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_basic_quote_characters(VALUE self, VALUE str)
{
@ -409,6 +733,16 @@ readline_s_set_basic_quote_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_BASIC_QUOTE_CHARACTERS */
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_basic_quote_characters(VALUE self, VALUE str)
{
@ -423,6 +757,19 @@ readline_s_get_basic_quote_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_BASIC_QUOTE_CHARACTERS */
}
/*
* call-seq:
* Readline.completer_quote_characters = string
*
* 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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_completer_quote_characters(VALUE self, VALUE str)
{
@ -449,6 +796,17 @@ readline_s_set_completer_quote_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_COMPLETER_QUOTE_CHARACTERS */
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_completer_quote_characters(VALUE self, VALUE str)
{
@ -463,6 +821,17 @@ readline_s_get_completer_quote_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_COMPLETER_QUOTE_CHARACTERS */
}
/*
* call-seq:
* Readline.filename_quote_characters = string
*
* 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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_set_filename_quote_characters(VALUE self, VALUE str)
{
@ -489,6 +858,17 @@ readline_s_set_filename_quote_characters(VALUE self, VALUE str)
#endif /* HAVE_RL_FILENAME_QUOTE_CHARACTERS */
}
/*
* call-seq:
* Readline.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.
*
* Raises SecurityError exception if $SAFE is 4.
*/
static VALUE
readline_s_get_filename_quote_characters(VALUE self, VALUE str)
{
@ -747,7 +1127,7 @@ username_completion_proc_call(VALUE self, VALUE str)
void
Init_readline()
{
VALUE history, fcomp, ucomp;
VALUE history, fcomp, ucomp, version;
/* Allow conditional parsing of the ~/.inputrc file. */
rl_readline_name = "Ruby";
@ -816,20 +1196,35 @@ Init_readline()
rb_define_singleton_method(history,"empty?", hist_empty_p, 0);
rb_define_singleton_method(history,"delete_at", hist_delete_at, 1);
rb_define_singleton_method(history,"clear", hist_clear, 0);
/*
* 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[4].
*/
rb_define_const(mReadline, "HISTORY", history);
fcomp = rb_obj_alloc(rb_cObject);
rb_define_singleton_method(fcomp, "call",
filename_completion_proc_call, 1);
/*
* The Object with the call method that is a completion for filename.
* This is sets by Readline.completion_proc= method.
*/
rb_define_const(mReadline, "FILENAME_COMPLETION_PROC", fcomp);
ucomp = rb_obj_alloc(rb_cObject);
rb_define_singleton_method(ucomp, "call",
username_completion_proc_call, 1);
/*
* The Object with the call method that is a completion for usernames.
* This is sets by Readline.completion_proc= method.
*/
rb_define_const(mReadline, "USERNAME_COMPLETION_PROC", ucomp);
history_get_offset_func = history_get_offset_history_base;
#if defined HAVE_RL_LIBRARY_VERSION
rb_define_const(mReadline, "VERSION", rb_str_new2(rl_library_version));
version = rb_str_new2(rl_library_version);
#if defined HAVE_CLEAR_HISTORY
if (strncmp(rl_library_version, EDIT_LINE_LIBRARY_VERSION,
strlen(EDIT_LINE_LIBRARY_VERSION)) == 0) {
@ -841,8 +1236,10 @@ Init_readline()
}
#endif
#else
rb_define_const(mReadline, "VERSION", rb_str_new2("2.0 or prior version"));
version = rb_str_new2("2.0 or prior version");
#endif
/* Version string of GNU Readline or libedit. */
rb_define_const(mReadline, "VERSION", version);
rl_attempted_completion_function = readline_attempted_completion_function;
#ifdef HAVE_RL_EVENT_HOOK