The top level node of any parse tree.
attr_reader statements: StatementsNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13905
def initialize(locals, statements, location)
@locals = locals
@statements = statements
@location = location
end
def initialize: (locals: Array, statements: StatementsNode, location: Location) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13981
def self.type
:program_node
end
Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13912
def accept(visitor)
visitor.visit_program_node(self)
end
def accept: (visitor: Visitor) -> void
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13917
def child_nodes
[statements]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13927
def comment_targets
[statements]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13922
def compact_child_nodes
[statements]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13932
def copy(**params)
ProgramNode.new(
params.fetch(:locals) { locals },
params.fetch(:statements) { statements },
params.fetch(:location) { location },
)
end
def copy: (**params) -> ProgramNode
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13944
def deconstruct_keys(keys)
{ locals: locals, statements: statements, location: location }
end
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13949
def inspect(inspector = NodeInspector.new)
inspector << inspector.header(self)
inspector << "├── locals: #{locals.inspect}\n"
inspector << "└── statements:\n"
inspector << inspector.child_node(statements, " ")
inspector.to_str
end
def inspect(inspector: NodeInspector) -> String
# File tmp/rubies/ruby-3.3.0/lib/prism/node.rb, line 13971
def type
:program_node
end
Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.
Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.
def type: () -> Symbol