class RubyVM::AbstractSyntaxTree::Node (Ruby 3.3 リファレンスマニュアル)

要約

RubyVM::AbstractSyntaxTree.parse によって作られる抽象構文木を表すクラスです。

このクラスは MRI の実装の詳細を表します。

インスタンスメソッド

all_tokens -> Array | nilRuby 3.2 から[permalink][rdoc][edit]

self を含むスクリプト全体のトークンの配列を返します。各トークンの形式は RubyVM::AbstractSyntaxTree::Node#tokens と同じです。

keep_tokens を有効にしてパースした場合にだけ利用でき、そうでない場合は nil を返します。

root = RubyVM::AbstractSyntaxTree.parse("x = 1", keep_tokens: true)
p root.all_tokens.size # => 5

[SEE_ALSO] RubyVM::AbstractSyntaxTree::Node#tokens

children -> ArrayRuby 2.6.0 から[permalink][rdoc][edit]

self の子ノードを配列で返します。

どのような子ノードが返ってくるかは、そのノードの type によって異なります。

戻り値は、ほかの RubyVM::AbstractSyntaxTree::Node のインスタンスや nil を含みます。

node = RubyVM::AbstractSyntaxTree.parse('1 + 2')
p node.children
# => [[], nil, #<RubyVM::AbstractSyntaxTree::Node:OPCALL@1:0-1:5>]

first_column -> IntegerRuby 2.6.0 から[permalink][rdoc][edit]

ソースコード中で、self を表すテキストが最初に現れる列番号を返します。

列番号は0-originで、バイト単位で表されます。

node = RubyVM::AbstractSyntaxTree.parse('1 + 2')
p node.first_column # => 0

first_lineno -> IntegerRuby 2.6.0 から[permalink][rdoc][edit]

ソースコード中で、self を表すテキストが最初に現れる行番号を返します。

行番号は1-originです。

node = RubyVM::AbstractSyntaxTree.parse('1 + 2')
p node.first_lineno # => 1

inspect -> StringRuby 2.6.0 から[permalink][rdoc][edit]

self のデバッグ用の情報を含んだ文字列を返します。

node = RubyVM::AbstractSyntaxTree.parse('1 + 1')
puts node.inspect
# => #<RubyVM::AbstractSyntaxTree::Node:SCOPE@1:0-1:5>

last_column -> IntegerRuby 2.6.0 から[permalink][rdoc][edit]

ソースコード中で、self を表すテキストが最後に現れる列番号を返します。

列番号は0-originで、バイト単位で表されます。

node = RubyVM::AbstractSyntaxTree.parse('1 + 1')
p node.last_column # => 5

last_lineno -> IntegerRuby 2.6.0 から[permalink][rdoc][edit]

ソースコード中で、self を表すテキストが最後に現れる行番号を返します。

行番号は1-originです。

node = RubyVM::AbstractSyntaxTree.parse('1 + 1')
p node.last_lineno # => 1

node_id -> IntegerRuby 3.1 から[permalink][rdoc][edit]

self に割り当てられた ID を返します。

ID は抽象構文木の中でノードを識別するための整数です。具体的な値は Ruby のバージョンやパーサによって異なります。

node = RubyVM::AbstractSyntaxTree.parse("x = 1 + 2\ny = 3\n")
p node.node_id # => 9

[SEE_ALSO] RubyVM::AbstractSyntaxTree.node_id_for_backtrace_location

script_lines -> Array | nilRuby 3.1 から[permalink][rdoc][edit]

スクリプト全体の各行を要素とする文字列の配列を返します。

keep_script_lines を有効にしてパースした場合にだけ利用でき、そうでない場合は nil を返します。

root = RubyVM::AbstractSyntaxTree.parse("x = 1 + 2\ny = 3\n", keep_script_lines: true)
p root.script_lines # => ["x = 1 + 2\n", "y = 3\n"]

[SEE_ALSO] RubyVM::AbstractSyntaxTree::Node#source, RubyVM::AbstractSyntaxTree.parse

source -> String | nilRuby 3.1 から[permalink][rdoc][edit]

self に対応する部分のソースコードを文字列で返します。

keep_script_lines を有効にしてパースした場合にだけ利用でき、そうでない場合は nil を返します。

root = RubyVM::AbstractSyntaxTree.parse("x = 1 + 2\ny = 3\n", keep_script_lines: true)
p root.source                         # => "x = 1 + 2\ny = 3"
p root.children[2].children[0].source # => "x = 1 + 2"

[SEE_ALSO] RubyVM::AbstractSyntaxTree::Node#script_lines

tokens -> Array | nilRuby 3.2 から[permalink][rdoc][edit]

self に対応する部分のトークンの配列を返します。

各トークンは [id, type, ソース文字列, 位置情報] の 4 要素の配列です。位置情報は [first_lineno, first_column, last_lineno, last_column] の配列です。

keep_tokens を有効にしてパースした場合にだけ利用でき、そうでない場合は nil を返します。

root = RubyVM::AbstractSyntaxTree.parse("x = 1", keep_tokens: true)
pp root.tokens
# => [[0, :tIDENTIFIER, "x", [1, 0, 1, 1]],
#     [1, :tSP, " ", [1, 1, 1, 2]],
#     [2, :"=", "=", [1, 2, 1, 3]],
#     [3, :tSP, " ", [1, 3, 1, 4]],
#     [4, :tINTEGER, "1", [1, 4, 1, 5]]]

[SEE_ALSO] RubyVM::AbstractSyntaxTree::Node#all_tokens, RubyVM::AbstractSyntaxTree.parse

type -> SymbolRuby 2.6.0 から[permalink][rdoc][edit]

self の種類を Symbol で返します。

node = RubyVM::AbstractSyntaxTree.parse('1 + 1')
p node.type # => :SCOPE

要約

目次

インスタンスメソッド