123456789_123456789_123456789_123456789_123456789_

Class: Prism::ProgramNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

The top level node of any parse tree.

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, locals, statements) ⇒ ProgramNode

Initialize a new ProgramNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 13144



def initialize(source, node_id, location, flags, locals, statements)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @locals = locals
  @statements = statements
end


  







Class Method Details



  

    .type  
  



  

    
Return a symbol representation of this node type. See Node::type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13201



def self.type
  :program_node
end


  







Instance Attribute Details



  

    #locals   (readonly)
  



  

    
attr_reader locals: Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13187



attr_reader :locals


  








  

    #statements   (readonly)
  



  

    
attr_reader statements: StatementsNode

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13189



attr_reader :statements


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13207



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13154



def accept(visitor)
  visitor.visit_program_node(self)
end


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13159



def child_nodes
  [statements]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13169



def comment_targets
  [statements] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13164



def compact_child_nodes
  [statements]
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, statements: self.statements)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13174



def copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, statements: self.statements)
  ProgramNode.new(source, node_id, location, flags, locals, statements)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13179



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13182



def deconstruct_keys(keys)
  { node_id: node_id, location: location, locals: locals, statements: statements }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13191



def inspect
  InspectVisitor.compose(self)
end


  








  

    #type  
  



  

    
Return a symbol representation of this node type. See Node#type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 13196



def type
  :program_node
end