RubyVM::AbstractSyntaxTree::Node

node.children → array

#

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 131
def children
  Primitive.ast_node_children
end

Returns AST nodes under this one. Each kind of node has different children, depending on what kind of node it is.

The returned array may contain other nodes or nil.

node.first_column → integer

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 104
def first_column
  Primitive.ast_node_first_column
end

The column number in the source code where this AST’s text began.

node.first_lineno → integer

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 96
def first_lineno
  Primitive.ast_node_first_lineno
end

The line number in the source code where this AST’s text began.

node.inspect → string

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 139
def inspect
  Primitive.ast_node_inspect
end

Returns debugging information about this node as a string.

node.last_column → integer

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 120
def last_column
  Primitive.ast_node_last_column
end

The column number in the source code where this AST’s text ended.

node.last_lineno → integer

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 112
def last_lineno
  Primitive.ast_node_last_lineno
end

The line number in the source code where this AST’s text ended.

node.node_id → integer

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 150
def node_id
  Primitive.ast_node_node_id
end

Returns an internal node_id number. Note that this is an API for ruby internal use, debugging, and research. Do not use this for any other purpose. The compatibility is not guaranteed.

pretty_print(q)

#

lib/pp.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/lib/pp.rb, line 568
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

No documentation available

pretty_print_children(q, names = [])

#

lib/pp.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/lib/pp.rb, line 555
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

No documentation available

node.script_lines → array

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 162
def script_lines
  Primitive.ast_node_script_lines
end

Returns the original source code as an array of lines.

Note that this is an API for ruby internal use, debugging, and research. Do not use this for any other purpose. The compatibility is not guaranteed.

node.source → string

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 178
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

Returns the code fragment that corresponds to this AST.

Note that this is an API for ruby internal use, debugging, and research. Do not use this for any other purpose. The compatibility is not guaranteed.

Also note that this API may return an incomplete code fragment that does not parse; for example, a here document following an expression may be dropped.

node.type → symbol

#

ast.rb View on GitHub

          
            # File tmp/rubies/ruby-3.1.3/ast.rb, line 88
def type
  Primitive.ast_node_type
end

Returns the type of this node as a symbol.

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