[ruby-list:24522] (RDP) readline

新井です。

フォーマットをどうするかは別にしてマニュアルは書き続けます:-)。
変換なんていくらでもできるから。

readline ライブラリです。

# 入力補完に関して詳細を知らないので、言葉を濁しています。協
# 力者募集


=begin
= Readline

GNU Readline によるコマンドライン入力インタフェースを提供するモジュー
ルです。

== 使い方
(({ }))
  require "readline"

  while buf = Readline.readline("> ", true)
      print "-> ", buf, "\n"
  end

== モジュール関数

--- Readline.readline([prompt, [add_hist]])
    ユーザからのキー入力を求め、入力した文字列を返します。EOF(UNIX で
    は ^D)を入力すると nil を返します。

    入力時には行内編集が可能で、vi モードと Emacs モードが用意されています。
    (((<Readline.vi_editing_mode>))、((<Readline.emacs_editing_mode>))
    を参照)。デフォルトは Emacs モードです。

    文字列 ((|prompt|)) を指定するとカーソルの前にこの文字列を表示します。

    ((|add_hist|)) が真ならば、入力した文字列はヒストリに記録されます。
    Emacs モードなら ^P を入力することで前に入力した文字列を呼び出した
    り、((<Readline::HISTORY>)) モジュールによりヒストリの内容を操作す
    ることができます。このデフォルト値は nil です。

    : 注意
      入力待ちの状態で ^C すると ruby インタプリタもろとも終了し端末状
      態を復帰しません。これを回避するには、

        stty_save = `stty -g`.chomp
        begin
          while buf = Readline.readline
              p buf
          end
        rescue Interrupt
          system("stty", stty_save)
        end

      または、

        stty_save = `stty -g`.chomp
        trap("INT") { system "stty", stty_save }

        while buf = Readline.readline
          p buf
        end

      などとします。

== モジュールメソッド

--- Readline.completion_proc= proc
--- Readline.completion_proc
    入力補完を行う方法を定義します。
    デフォルトでは、ファイル名の補完とユーザ名の補完が定義されています。

--- Readline.completion_case_fold=(bool)
--- Readline.completion_case_fold
    入力補完時に大文字／小文字の区別をするかどうかを決定します。
    ((|bool|)) が真ならば区別しません。

--- Readline.vi_editing_mode
    編集モードを vi モードにします。詳細は、GNU Readline のマニュアル
    を参照してください。

--- Readline.emacs_editing_mode
    編集モードを Emacs モードにします。デフォルトは Emacs モードです。
    詳細は、GNU Readline のマニュアルを参照してください。

== 定数
--- Readline::FILENAME_COMPLETION_PROC
--- Readline::USERNAME_COMPLETION_PROC

== 備考
* Readline.readline メソッドはスレッドに対応しています。
  入力待ち状態のときはスレッドコンテキストの切替えが発生します。

= Readline::HISTORY

Readlineモジュールで入力した内容は入力履歴として記録されます(有効にし
ていればですが。((<Readline.readline>)) を参照)

このモジュールにより、入力履歴の内容にアクセスすることができます。おお
よそ、((<Array>)) クラスのインスタンスのように振舞います。

  while buf = Readline.readline("> ", true)
    p Readline::HISTORY.to_a
    print "-> ", buf, "\n"
  end

空行や直前の入力と同じ内容は入力履歴に残したくないと思うかも知れません。
この場合、以下のようにします。

  while buf = Readline.readline("> ", true)
    # p Readline::HISTORY.to_a
    Readline::HISTORY.pop if /^\s*$/ =~ buf

    begin
      Readline::HISTORY.pop if Readline::HISTORY[Readline::HISTORY.length-2] == buf
    rescue IndexError
    end

    # p Readline::HISTORY.collect
    print "-> ", buf, "\n"
  end

== インクルードしているモジュール

((<Enumerable>))

== モジュールメソッド:

Readline::HISTORY モジュールには、Array オブジェクトのように振舞うため
に以下のモジュールメソッドが定義されています。

--- Readline::HISTORY.[]
--- Readline::HISTORY.[]=
--- Readline::HISTORY.<<
--- Readline::HISTORY.push(*str)
--- Readline::HISTORY.pop
--- Readline::HISTORY.shift
--- Readline::HISTORY.each
--- Readline::HISTORY.length
--- Readline::HISTORY.empty?
--- Readline::HISTORY.delete_at(index)
    詳細は ((<Array>)) クラスを参照してください。
=end