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 授權。

常數

事件

此陣列包含所有 ripper 事件的名稱。

PARSER_EVENTS

此陣列包含剖析器事件的名稱。

SCANNER_EVENTS

此陣列包含掃描器事件的名稱。

公開類別方法

lex(src, filename = '-', lineno = 1, **kw) 按一下以切換來源

將 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      ]]
# 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
parse(src, filename = '(ripper)', lineno = 1) 按一下以切換來源

剖析從 src 讀取的 Ruby 程式。src 必須是 StringIO,或具有 gets 方法的物件。

# File ext/ripper/lib/ripper/core.rb, line 18
def Ripper.parse(src, filename = '(ripper)', lineno = 1)
  new(src, filename, lineno).parse
end
sexp(src, filename = '-', lineno = 1, raise_errors: false) 按一下以切換來源
實驗性質

剖析 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]]]]
# 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
sexp_raw(src, filename = '-', lineno = 1, raise_errors: false) 按一下以切換來源
實驗性質

剖析 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]]]]
# 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
slice(src, pattern, n = 0) 按一下以切換來源
實驗性質

剖析 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"
# File ext/ripper/lib/ripper/lexer.rb, line 270
def Ripper.slice(src, pattern, n = 0)
  if m = token_match(src, pattern)
  then m.string(n)
  else nil
  end
end
tokenize(src, filename = '-', lineno = 1, **kw) 按一下以切換來源

將 Ruby 程式進行詞法分析,並傳回字串陣列。filenamelineno 參數大多會被忽略,因為傳回值只是經過詞法分析的輸入。預設情況下,此方法不會處理 src 中的語法錯誤,請使用 raise_errors 關鍵字,針對 src 中的錯誤引發 SyntaxError

p Ripper.tokenize("def m(a) nil end")
   # => ["def", " ", "m", "(", "a", ")", " ", "nil", " ", "end"]
# 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

私人實例方法

compile_error(msg) 按一下以切換來源

當解析器找到語法錯誤時,會呼叫此方法。

# File ext/ripper/lib/ripper/core.rb, line 63
def compile_error(msg)
end
warn(fmt, *args) 按一下以切換來源

當解析器產生弱警告時,會呼叫此方法。fmtargs 是 printf 格式。

# File ext/ripper/lib/ripper/core.rb, line 54
def warn(fmt, *args)
end
warning(fmt, *args) 按一下以切換來源

當解析器產生強警告時,會呼叫此方法。fmtargs 是 printf 格式。

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