Spec-Zone.ru › Ruby 3.2

класс RubyVM::AbstractSyntaxTree::Node

Родитель:
Объект

RubyVM::AbstractSyntaxTree::Node экземпляры создаются методами разбора в RubyVM::AbstractSyntaxTree.

Этот класс специфичен для MRI.

Методы публичного экземпляра

all_tokens → массив Показать исходный код
# File ast.rb, line 206
def all_tokens
  Primitive.ast_node_all_tokens
end

Возвращает все токены для входного скрипта независимо от узла получателя. Возвращает nil если keep_tokens не был включён при вызове метода парсинга.

root = RubyVM::AbstractSyntaxTree.parse("x = 1 + 2", keep_tokens: true)
root.all_tokens # => [[0, :tIDENTIFIER, "x", [1, 0, 1, 1]], [1, :tSP, " ", [1, 1, 1, 2]], ...]
root.children[-1].all_tokens # => [[0, :tIDENTIFIER, "x", [1, 0, 1, 1]], [1, :tSP, " ", [1, 1, 1, 2]], ...]
children → массив Показать исходный код
# File ast.rb, line 217
def children
  Primitive.ast_node_children
end

Возвращает узлы AST под этим узлом. Каждый тип узла имеет разные дочерние узлы, в зависимости от типа узла.

Возвращаемый массив может содержать другие узлы или nil.

first_column → целое число Показать исходный код
# File ast.rb, line 149
def first_column
  Primitive.ast_node_first_column
end

Номер столбца в исходном коде, где начался текст этого узла AST.

first_lineno → целое число Показать исходный код
# File ast.rb, line 141
def first_lineno
  Primitive.ast_node_first_lineno
end

Номер строки в исходном коде, где начался текст этого узла AST.

inspect → строка Показать исходный код
# File ast.rb, line 225
def inspect
  Primitive.ast_node_inspect
end

Возвращает отладочную информацию об этом узле в виде строки.

last_column → целое число Показать исходный код
# File ast.rb, line 165
def last_column
  Primitive.ast_node_last_column
end

Номер столбца в исходном коде, где закончился текст этого узла AST.

last_lineno → целое число Показать исходный код
# File ast.rb, line 157
def last_lineno
  Primitive.ast_node_last_lineno
end

Номер строки в исходном коде, где закончился текст этого узла AST.

node_id → целое число Показать исходный код
# File ast.rb, line 236
def node_id
  Primitive.ast_node_node_id
end

Возвращает внутренний номер node_id. Обратите внимание, что это API предназначено для внутреннего использования в Ruby, отладки и исследований. Не используйте его для других целей. Совместимость не гарантируется.

pretty_print(q) Показать исходный код
# File lib/pp.rb, line 588
def pretty_print(q)
  q.group(1, "(#{type}@#{first_lineno}:#{first_column}-#{last_lineno}:#{last_column}", ")") {
    case type
    when :SCOPE
      pretty_print_children(q, %w"tbl args body")
    when :ARGS
      pretty_print_children(q, %w[pre_num pre_init opt first_post post_num post_init rest kw kwrest block])
    when :DEFN
      pretty_print_children(q, %w[mid body])
    when :ARYPTN
      pretty_print_children(q, %w[const pre rest post])
    when :HSHPTN
      pretty_print_children(q, %w[const kw kwrest])
    else
      pretty_print_children(q)
    end
  }
end
pretty_print_children(q, names = []) Показать исходный код
# File lib/pp.rb, line 575
def pretty_print_children(q, names = [])
  children.zip(names) do |c, n|
    if n
      q.breakable
      q.text "#{n}:"
    end
    q.group(2) do
      q.breakable
      q.pp c
    end
  end
end
script_lines → массив Показать исходный код
# File ast.rb, line 248
def script_lines
  Primitive.ast_node_script_lines
end

Возвращает исходный код в виде массива строк.

Обратите внимание, что это API предназначено для внутреннего использования в Ruby, отладки и исследований. Не используйте его для других целей. Совместимость не гарантируется.

source → строка Показать исходный код
# File ast.rb, line 264
def source
  lines = script_lines
  if lines
    lines = lines[first_lineno - 1 .. last_lineno - 1]
    lines[-1] = lines[-1][0...last_column]
    lines[0] = lines[0][first_column..-1]
    lines.join
  else
    nil
  end
end

Возвращает фрагмент кода, соответствующий этому AST.

Обратите внимание, что это API предназначено для внутреннего использования в Ruby, отладки и исследований. Не используйте его для других целей. Совместимость не гарантируется.

Также обратите внимание, что это API может вернуть неполный фрагмент кода, который не поддаётся парсингу; например, документ here, следующий за выражением, может быть пропущен.

tokens → массив Показать исходный код
# File ast.rb, line 185
def tokens
  return nil unless all_tokens

  all_tokens.each_with_object([]) do |token, a|
    loc = token.last
    if ([first_lineno, first_column] <=> [loc[0], loc[1]]) <= 0 &&
       ([last_lineno, last_column]   <=> [loc[2], loc[3]]) >= 0
       a << token
    end
  end
end

Возвращает токены, соответствующие расположению узла. Возвращает nil если keep_tokens не был включен при вызове метода парсинга.

root = RubyVM::AbstractSyntaxTree.parse("x = 1 + 2", keep_tokens: true)
root.tokens # => [[0, :tIDENTIFIER, "x", [1, 0, 1, 1]], [1, :tSP, " ", [1, 1, 1, 2]], ...]
root.tokens.map{_1[2]}.join # => "x = 1 + 2"

Токен представляет собой массив:

  • id

  • тип токена

  • текст исходного кода

  • расположение [ first_lineno, first_column, last_lineno, last_column ]

type → символ Показать исходный код
# File ast.rb, line 133
def type
  Primitive.ast_node_type
end

Возвращает тип этого узла в виде символа.

root = RubyVM::AbstractSyntaxTree.parse("x = 1 + 2")
root.type # => :SCOPE
lasgn = root.children[2]
lasgn.type # => :LASGN
call = lasgn.children[1]
call.type # => :OPCALL

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API