class Ripper

Ripper 是一个 Ruby 脚本解析器。

您可以通过基于事件的风格从解析器获取信息。信息包括抽象语法树或 Ruby 程序的简单词法分析。

用法¶ ↑

Ripper 提供了一个简单的接口，可以将您的程序解析为符号表达式树（或 S-表达式）。

理解解析器的输出可能是一个挑战，建议您使用 PP 来格式化输出以提高可读性。

require 'ripper'
require 'pp'

pp Ripper.sexp('def hello(world) "Hello, #{world}!"; end')
  #=> [:program,
       [[:def,
         [:@ident, "hello", [1, 4]],
         [:paren,
          [:params, [[:@ident, "world", [1, 10]]], nil, nil, nil, nil, nil, nil]],
         [:bodystmt,
          [[:string_literal,
            [:string_content,
             [:@tstring_content, "Hello, ", [1, 18]],
             [:string_embexpr, [[:var_ref, [:@ident, "world", [1, 27]]]]],
             [:@tstring_content, "!", [1, 33]]]]],
          nil,
          nil,
          nil]]]]

您可以在上面的示例中看到，表达式以 :program 开始。

接下来是 :def 处的方法定义，后跟方法的标识符 :@ident。在方法的标识符之后是括号 :paren 和 :params 下的方法参数。

接下来是方法体，从 :bodystmt 开始（stmt 表示语句），其中包含方法的完整定义。

在我们的例子中，我们只是返回一个 String，所以接下来我们有 :string_literal 表达式。

在我们的 :string_literal 中，您会注意到两个 @tstring_content，这是 Hello, 和 ! 的字面部分。在两个 @tstring_content 语句之间是一个 :string_embexpr，其中 embexpr 是一个嵌入式表达式。我们的表达式由一个局部变量或 var_ref 组成，其标识符 (@ident) 为 world。

资源¶ ↑

Ruby Inside

要求¶ ↑

ruby 1.9（仅支持 CVS HEAD）
bison 1.28 或更高版本（其他 yaccs 不起作用）

许可证¶ ↑

Ruby 许可证。

Minero Aoki
aamine@loveruby.net
i.loveruby.net

常量

EVENTS: 此数组包含所有 ripper 事件的名称。
PARSER_EVENTS: 此数组包含解析器事件的名称。
SCANNER_EVENTS: 此数组包含扫描器事件的名称。

公共类方法

lex (src, filename = '-', lineno = 1, **kw)

来源

# File ext/ripper/lib/ripper/lexer.rb, line 51
def Ripper.lex(src, filename = '-', lineno = 1, **kw)
  Lexer.new(src, filename, lineno).lex(**kw)
end

将 Ruby 程序标记化，并返回一个数组的数组，其格式为 [[lineno, column], type, token, state]。filename 参数大多被忽略。默认情况下，此方法不处理 src 中的语法错误，请使用 raise_errors 关键字为 src 中的错误引发 SyntaxError。

require 'ripper'
require 'pp'

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

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

来源

# File ext/ripper/lib/ripper/core.rb, line 18
def Ripper.parse(src, filename = '(ripper)', lineno = 1)
  new(src, filename, lineno).parse
end

解析从 src 读取的给定 Ruby 程序。 src 必须是 String 或 IO 或具有 gets 方法的对象。

sexp (src, filename = '-', lineno = 1, raise_errors: false)

来源

# File ext/ripper/lib/ripper/sexp.rb, line 35
def Ripper.sexp(src, filename = '-', lineno = 1, raise_errors: false)
  builder = SexpBuilderPP.new(src, filename, lineno)
  sexp = builder.parse
  if builder.error?
    if raise_errors
      raise SyntaxError, builder.error
    end
  else
    sexp
  end
end

实验性

解析 src 并创建 S-exp 树。返回比 Ripper.sexp_raw 更具可读性的树。此方法主要供开发人员使用。filename 参数大多被忽略。默认情况下，此方法不处理 src 中的语法错误，在这种情况下返回 nil。使用 raise_errors 关键字为 src 中的错误引发 SyntaxError。

require 'ripper'
require 'pp'

pp Ripper.sexp("def m(a) nil end")
  #=> [:program,
       [[:def,
        [:@ident, "m", [1, 4]],
        [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil, nil, nil, nil]],
        [:bodystmt, [[:var_ref, [:@kw, "nil", [1, 9]]]], nil, nil, nil]]]]

sexp_raw (src, filename = '-', lineno = 1, raise_errors: false)

来源

# File ext/ripper/lib/ripper/sexp.rb, line 71
def Ripper.sexp_raw(src, filename = '-', lineno = 1, raise_errors: false)
  builder = SexpBuilder.new(src, filename, lineno)
  sexp = builder.parse
  if builder.error?
    if raise_errors
      raise SyntaxError, builder.error
    end
  else
    sexp
  end
end

实验性

解析 src 并创建 S-exp 树。此方法主要供开发人员使用。filename 参数大多被忽略。默认情况下，此方法不处理 src 中的语法错误，在这种情况下返回 nil。使用 raise_errors 关键字为 src 中的错误引发 SyntaxError。

require 'ripper'
require 'pp'

pp Ripper.sexp_raw("def m(a) nil end")
  #=> [:program,
       [:stmts_add,
        [:stmts_new],
        [:def,
         [:@ident, "m", [1, 4]],
         [:paren, [:params, [[:@ident, "a", [1, 6]]], nil, nil, nil]],
         [:bodystmt,
          [:stmts_add, [:stmts_new], [:var_ref, [:@kw, "nil", [1, 9]]]],
          nil,
          nil,
          nil]]]]

slice (src, pattern, n = 0)

来源

# File ext/ripper/lib/ripper/lexer.rb, line 277
def Ripper.slice(src, pattern, n = 0)
  if m = token_match(src, pattern)
  then m.string(n)
  else nil
  end
end

实验性

解析 src 并返回与 pattern 匹配的字符串。pattern 应描述为 Regexp。

require 'ripper'

p Ripper.slice('def m(a) nil end', 'ident')                   #=> "m"
p Ripper.slice('def m(a) nil end', '[ident lparen rparen]+')  #=> "m(a)"
p Ripper.slice("<<EOS\nstring\nEOS",
               'heredoc_beg nl $(tstring_content*) heredoc_end', 1)
    #=> "string\n"

tokenize (src, filename = '-', lineno = 1, **kw)

来源

# File ext/ripper/lib/ripper/lexer.rb, line 25
def Ripper.tokenize(src, filename = '-', lineno = 1, **kw)
  Lexer.new(src, filename, lineno).tokenize(**kw)
end

将 Ruby 程序标记化，并返回一个字符串数组。 filename 和 lineno 参数大多被忽略，因为返回值只是标记化的输入。默认情况下，此方法不处理 src 中的语法错误，请使用 raise_errors 关键字为 src 中的错误引发 SyntaxError。

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

私有实例方法

compile_error (msg)

来源

# File ext/ripper/lib/ripper/core.rb, line 63
def compile_error(msg)
end

当解析器发现语法错误时，会调用此方法。

warn (fmt, *args)

来源

# File ext/ripper/lib/ripper/core.rb, line 54
def warn(fmt, *args)
end

当解析器产生弱警告时，会调用此方法。 fmt 和 args 是 printf 样式。

warning (fmt, *args)

来源

# File ext/ripper/lib/ripper/core.rb, line 59
def warning(fmt, *args)
end

当解析器产生强警告时，会调用此方法。 fmt 和 args 是 printf 样式。