класс Ripper

Родительский класс:: Object

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 или новее (другие yacc не работают)

Лицензия

Лицензия 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

Разбирает указанную программу Ruby, прочитанную из src. 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-выражений. Возвращает более удобочитаемое дерево, чем 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-выражений. Этот метод предназначен главным образом для разработчиков. Аргумент 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.

Ruby Core © 1993–2025 Yukihiro Matsumoto
Licensed under the Ruby License.
Ruby Standard Library © contributors
Licensed under their own licenses.