123456789_123456789_123456789_123456789_123456789_

Class: Prism::BlockNode

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

Represents a block of ruby code.

[1, 2, 3].each { |i| puts x }
               ^^^^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc) ⇒ BlockNode

Initialize a new BlockNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @locals = locals
  @parameters = parameters
  @body = body
  @opening_loc = opening_loc
  @closing_loc = closing_loc
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :block_node
end


  







Instance Attribute Details



  

    #body   (readonly)
  



  

    
attr_reader body: Prism.node?

  



  [ GitHub ]


  

  


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



attr_reader :body


  








  

    #locals   (readonly)
  



  

    
attr_reader locals: Array

  



  [ GitHub ]


  

  


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



attr_reader :locals


  








  

    #parameters   (readonly)
  



  

    
attr_reader parameters: Prism.node?

  



  [ GitHub ]


  

  


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



attr_reader :parameters


  







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 1645



def ===(other)
  other.is_a?(BlockNode) &&
    (locals.length == other.locals.length) &&
    locals.zip(other.locals).all? { |left, right| left === right } &&
    (parameters === other.parameters) &&
    (body === other.body) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [parameters, body]
end


  








  

    #closing  
  



  

    
def closing: () -> String

  



  [ GitHub ]


  

  


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



def closing
  closing_loc.slice
end


  








  

    #closing_loc  
  



  

    
attr_reader closing_loc: Location

  



  [ GitHub ]


  

  


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



def closing_loc
  location = @closing_loc
  return location if location.is_a?(Location)
  @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [*parameters, *body, opening_loc, closing_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << parameters if parameters
  compact << body if body
  compact
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?locals: Array, ?parameters: Prism.node?, ?body: Prism.node?, ?opening_loc: Location, ?closing_loc: Location) -> BlockNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  BlockNode.new(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, locals: Array, parameters: Prism.node?, body: Prism.node?, opening_loc: Location, closing_loc: Location }

  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { node_id: node_id, location: location, locals: locals, parameters: parameters, body: body, opening_loc: opening_loc, closing_loc: closing_loc }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    
def opening: () -> String

  



  [ GitHub ]


  

  


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



def opening
  opening_loc.slice
end


  








  

    #opening_loc  
  



  

    
attr_reader opening_loc: Location

  



  [ GitHub ]


  

  


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



def opening_loc
  location = @opening_loc
  return location if location.is_a?(Location)
  @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :block_node
end