Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > library shellwords

library shellwords

要約

UNIX Bourne シェルの単語分割規則に従った文字列割機能と文字列エスケープ 機能を提供します。

Shellwords モジュールは、空白区切りの単語分割を行う shellsplit、 文字列をエスケープする shellescape、文字列エスケープを文字列リストに 対して適用する shelljoin の3つのモジュール関数を提供します。

また、shellwords ライブラリを require すると、組み込みクラス String と Array が拡張され、これらのモジュール関数と同じ機能が String#shellsplit, String#shellescape, Array#shelljoin として使える ようになります。

クラスとモジュール

module Shellwords

UNIX Bourne シェルの単語分割規則に従った文字列分割と文字列エスケープ を行うモジュールです。

追加・再定義されるメソッド

Array#shelljoin -> String [added by shellwords]

配列の各要素である文字列に対して、Bourne シェルのコマンドライン中で安全に 使えるためのエスケープを適用し、空白文字を介してそれらを連結したコマンド ライン文字列を生成します。

array.shelljoin は、Shellwords.shelljoin(array) と等価です。

[RETURN]
エスケープ結果を連結した文字列を返します。

[SEE_ALSO] Shellwords.#shelljoin

String#shellescape -> String [added by shellwords]

文字列を Bourne シェルのコマンドライン中で安全に使えるようにエスケープします。

string.shellescape は、Shellwords.escape(string) と等価です。

[RETURN]
エスケープされた文字列を返します。

[SEE_ALSO] Shellwords.#shellescape

String#shellsplit -> [String] [added by shellwords]

Bourne シェルの単語分割規則に従った空白区切りの単語分割を行い、 単語 (文字列) の配列を返します。

string.shellsplit は、Shellwords.shellsplit(string) と等価です。

[RETURN]
分割結果の各文字列を要素とする配列を返します。
[EXCEPTION] ArgumentError:
引数の中に対でないシングルクォートまたはダブル クォートが現れた場合に発生します。

[SEE_ALSO] Shellwords.#shellsplit

Classes

Sublibraries