Ruby 1.9.2 リファレンスマニュアル > ライブラリ一覧 > ripperライブラリ > Ripperクラス

class Ripper

クラスの継承リスト: Ripper < Object < Kernel < BasicObject

Abstract

以下を参照して下さい。

Ruby プログラムをテキストとして扱いたい場合、 例えばソース色付けを行いたい場合は、 Ripper::Filter クラスを使うとよいでしょう。

特異メソッド

new(src, filename = "(ripper)", lineno = 1)

Ripper オブジェクトを作成します。

第一引数 src には Ruby プログラム (文字列)、 第二引数 filename には src のファイル名、 第三引数 lineno には src の開始行番号を、それぞれ与えます。

parse(src, filename = '(ripper)', lineno = 1)
yydebug
yydebug=

インスタンスメソッド

column
end_seen?
lineno
parse

privateメソッド

compile_error(msg)
warn(fmt, *args)
warning(fmt, *args)

定数

EVENTS

PARSER_EVENTS + SCANNER_EVENTS

PARSER_EVENTS

パーサイベントのイベント ID (シンボル) のリストを返します。

PARSER_EVENT_TABLE
SCANNER_EVENTS

スキャナイベントのイベント ID (シンボル) のリストを返します。

SCANNER_EVENT_TABLE
Version

追加されるメソッド

lex(src, filename = '-', lineno = 1) [added by ripper/lexer]

Ruby プログラム str をトークンに分割し、そのリストを返します。 ただし Ripper.tokenize と違い、トークンの種類と位置情報も付属します。

使用例 

require 'ripper'
require 'pp'

pp Ripper.lex("def m(a) nil end")
    #=> [[[1, 0], :on_kw, "def"],
         [[1, 3], :on_sp, " "],
         [[1, 4], :on_ident, "m"],
         [[1, 5], :on_lparen, "("],
         [[1, 6], :on_ident, "a"],
         [[1, 7], :on_rparen, ")"],
         [[1, 8], :on_sp, " "],
         [[1, 9], :on_kw, "nil"],
         [[1, 12], :on_sp, " "],
         [[1, 13], :on_kw, "end"]]

Ripper.lex は分割したトークンを詳しい情報とともに返します。 返り値の配列の要素は 3 要素の配列 (概念的にはタプル) です。 その内訳を以下に示します。

:位置情報 (Integer,Integer) 

トークンが置かれている行 (1-origin) と桁 (0-origin) の 2 要素の配列です。

:種類 (Symbol) 

トークンの種類が「:on_XXX」の形式のシンボルで渡されます。

:トークン (String) 

トークン文字列です。
sexp(src, filename = '-', lineno = 1) [added by ripper/sexp]
sexp_raw(src, filename = '-', lineno = 1) [added by ripper/sexp]
slice(src, pattern, n = 0) [added by ripper/lexer]

Ruby プログラム src のうち、 パターン pattern の n 番目の括弧にマッチする文字列を取り出します。 ただし、n が 0 のときは pattern 全体を意味します。

pattern は Ripper のイベント ID のリストを文字列で記述します。 また pattern には Ruby の正規表現と同じメタ文字も使えます。 ただし「.」は任意のトークン 1 つにマッチし、 その他のメタ文字もすべて文字単位ではなくトークン単位で動作します。

使用例 

p Ripper.slice(%(<<HERE\nstring\#{nil}\nHERE),
               "heredoc_beg .*? nl $(.*?) heredoc_end", 1)
    # => "string\#{nil}\n"
token_match(src, pattern) [added by ripper/lexer]

Ruby プログラム src に対してパターン pattern をマッチし、 マッチデータを返します。

tokenize(src, filename = '-', lineno = 1) [added by ripper/lexer]

Ruby プログラム str をトークンに分割し、そのリストを返します。

使用例 

require 'ripper'
p Ripper.tokenize("def m(a) nil end")
    #=> ["def", " ", "m", "(", "a", ")", " ", "nil", " ", "end"]

Ripper.tokenize は空白やコメントも含め、 元の文字列にある文字は 1 バイトも残さずに分割します。 ただし、ごく僅かな例外として、__END__ 以降の文字列は黙って捨てられます。 これは現在のところ仕様と考えてください。

Methods

Classes