class Prism::ProgramNode

The top level node of any parse tree.

Attributes

locals[R]

attr_reader locals: Array

statements[R]

attr_reader statements: StatementsNode

Public Class Methods

new(source, locals, statements, location) click to toggle source

def initialize: (Array locals, StatementsNode statements, Location location) -> void

# File lib/prism/node.rb, line 15292
def initialize(source, locals, statements, location)
  @source = source
  @location = location
  @locals = locals
  @statements = statements
end
type() click to toggle source

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 lib/prism/node.rb, line 15367
def self.type
  :program_node
end

Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

# File lib/prism/node.rb, line 15373
def ===(other)
  other.is_a?(ProgramNode) &&
    (locals.length == other.locals.length) &&
    locals.zip(other.locals).all? { |left, right| left === right } &&
    (statements === other.statements)
end
accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 15300
def accept(visitor)
  visitor.visit_program_node(self)
end
child_nodes() click to toggle source

def child_nodes: () -> Array[nil | Node]

# File lib/prism/node.rb, line 15305
def child_nodes
  [statements]
end
Also aliased as: deconstruct
comment_targets() click to toggle source

def comment_targets: () -> Array[Node | Location]

# File lib/prism/node.rb, line 15315
def comment_targets
  [statements] #: Array[Prism::node | Location]
end
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 15310
def compact_child_nodes
  [statements]
end
copy(locals: self.locals, statements: self.statements, location: self.location) click to toggle source

def copy: (?locals: Array, ?statements: StatementsNode, ?location: Location) -> ProgramNode

# File lib/prism/node.rb, line 15320
def copy(locals: self.locals, statements: self.statements, location: self.location)
  ProgramNode.new(source, locals, statements, location)
end
deconstruct()

def deconstruct: () -> Array[nil | Node]

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { locals: Array, statements: StatementsNode, location: Location }

# File lib/prism/node.rb, line 15328
def deconstruct_keys(keys)
  { locals: locals, statements: statements, location: location }
end
inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 15339
def inspect
  InspectVisitor.compose(self)
end
type() click to toggle source

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

# File lib/prism/node.rb, line 15357
def type
  :program_node
end