123456789_123456789_123456789_123456789_123456789_

Class: Prism::BlockNode

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

Overview

Represents a block of ruby code.

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

Class Method Summary

Node - Inherited

.fields

Returns a list of the fields that exist for this node class.
.type

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.

Instance Attribute Summary

  • #body readonly

    The body of the block.

  • #locals readonly

    The local variables declared in the block.

  • #parameters readonly

    The parameters of the block.

Node - Inherited

#newline?

Returns true if the node has the newline flag set.
#node_id

A unique identifier for this node.
#static_literal?

Returns true if the node has the static literal flag set.
#flags

An bitset of flags for this node.
#source

A pointer to the source that this node was created from.
#newline_flag?

Instance Method Summary

Node - Inherited

#accept

Accepts a visitor and calls back into the specialized visit function.
#breadth_first_search

Returns the first node that matches the given block when visited in a depth-first search.
#cached_end_code_units_column

Delegates to the cached_end_code_units_column of the associated location object.
#cached_end_code_units_offset

Delegates to the cached_end_code_units_offset of the associated location object.
#cached_start_code_units_column

Delegates to the cached_start_code_units_column of the associated location object.
#cached_start_code_units_offset

Delegates to the cached_start_code_units_offset of the associated location object.
#child_nodes

Returns an array of child nodes, including nils in the place of optional nodes that were not present.
#comment_targets

Returns an array of child nodes and locations that could potentially have comments attached to them.
#comments

Delegates to the comments of the associated location object.
#compact_child_nodes

Returns an array of child nodes, excluding any nils in the place of optional nodes that were not present.
#deconstruct

Alias for Node#child_nodes.
#each_child_node

With a block given, yields each child node.
#end_character_column

Delegates to the end_character_column of the associated location object.
#end_character_offset

Delegates to the end_character_offset of the associated location object.
#end_column

Delegates to the end_column of the associated location object.
#end_line

Delegates to the end_line of the associated location object.
#end_offset

The end offset of the node in the source.
#inspect

Returns a string representation of the node.
#leading_comments

Delegates to the leading_comments of the associated location object.
#location

A Location instance that represents the location of this node in the source.
#pretty_print

Similar to inspect, but respects the current level of indentation given by the pretty print object.
#save

Save this node using a saved source so that it can be retrieved later.
#save_location

Save the location using a saved source so that it can be retrieved later.
#script_lines

Alias for Node#source_lines.
#slice

Slice the location of the node from the source.
#slice_lines

Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
#source_lines

Returns all of the lines of the source code associated with this node.
#start_character_column

Delegates to the start_character_column of the associated location object.
#start_character_offset

Delegates to the start_character_offset of the associated location object.
#start_column

Delegates to the start_column of the associated location object.
#start_line

Delegates to the start_line of the associated location object.
#start_offset

The start offset of the node in the source.
#to_dot

Convert this node into a graphviz dot graph string.
#trailing_comments

Delegates to the trailing_comments of the associated location object.
#tunnel

Returns a list of nodes that are descendants of this node that contain the given line and column.
#type

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform.
#deprecated, #newline_flag!

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 1939



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 2070



def self.type
  :block_node
end


  







Instance Attribute Details



  

    #body   (readonly)
  



  

    

The body of the block.



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


  



  [ GitHub ]


  

  


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



attr_reader :body


  








  

    #locals   (readonly)
  



  

    

The local variables declared in the block.



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


  



  [ GitHub ]


  

  


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



attr_reader :locals


  








  

    #parameters   (readonly)
  



  

    

The parameters of the block.



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


  



  [ GitHub ]


  

  


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



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 2076



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 1952



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

    

def child_nodes: () -> Array


  



  [ GitHub ]


  

  


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



def child_nodes
  [parameters, body]
end


  








  

    #closing  
  



  

    

def closing: () -> String


  



  [ GitHub ]


  

  


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



def closing
  closing_loc.slice
end


  








  

    #closing_loc  
  



  

    

Represents the location of the closing ‘}` or end.



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


  



  [ GitHub ]


  

  


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



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 1978



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 1970



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: BlockParametersNode | NumberedParametersNode | ItParametersNode | nil, ?body: StatementsNode | BeginNode | nil, ?opening_loc: Location, ?closing_loc: Location) -> BlockNode


  



  [ GitHub ]


  

  


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



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 1988



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, locals: Array, parameters: BlockParametersNode | NumberedParametersNode | ItParametersNode | nil, body: StatementsNode | BeginNode | nil, opening_loc: Location, closing_loc: Location }


  



  [ GitHub ]


  

  


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



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


  








  

    #each_child_node {|parameters| ... } 
  



  

    

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator


  





  
Yields:





  [ GitHub ]


  

  


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



def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield parameters if parameters
  yield body if body
end


  








  

    #inspect  
  



  

    

def inspect -> String


  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    

def opening: () -> String


  



  [ GitHub ]


  

  


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



def opening
  opening_loc.slice
end


  








  

    #opening_loc  
  



  

    

Represents the location of the opening ‘or {do.



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


  



  [ GitHub ]


  

  


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



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


  








  

    #save_closing_loc(repository)  
  



  

    

Save the closing_loc location using the given saved source so that it can be retrieved later.


  



  [ GitHub ]


  

  


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



def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end


  








  

    #save_opening_loc(repository)  
  



  

    

Save the opening_loc location using the given saved source so that it can be retrieved later.


  



  [ GitHub ]


  

  


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



def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end


  








  

    #type  
  



  

    

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


  



  [ GitHub ]


  

  


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



def type
  :block_node
end