123456789_123456789_123456789_123456789_123456789_

Class: Prism::FindPatternNode

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

Overview

Represents a find pattern in pattern matching.

foo in *bar, baz, *qux
       ^^^^^^^^^^^^^^^

foo in [*bar, baz, *qux]
       ^^^^^^^^^^^^^^^^^

foo in Foo(*bar, baz, *qux)
       ^^^^^^^^^^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc) ⇒ FindPatternNode

Initialize a new FindPatternNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @constant = constant
  @left = left
  @requireds = requireds
  @right = right
  @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 5923



def self.type
  :find_pattern_node
end


  







Instance Attribute Details



  

    #constant   (readonly)
  



  

    
attr_reader constant: Prism.node?

  



  [ GitHub ]


  

  


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



attr_reader :constant


  








  

    #left   (readonly)
  



  

    
attr_reader left: Prism.node

  



  [ GitHub ]


  

  


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



attr_reader :left


  








  

    #requireds   (readonly)
  



  

    
attr_reader requireds: Array

  



  [ GitHub ]


  

  


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



attr_reader :requireds


  








  

    #right   (readonly)
  



  

    
attr_reader right: Prism.node

  



  [ GitHub ]


  

  


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



attr_reader :right


  







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 5929



def ===(other)
  other.is_a?(FindPatternNode) &&
    (constant === other.constant) &&
    (left === other.left) &&
    (requireds.length == other.requireds.length) &&
    requireds.zip(other.requireds).all? { |left, right| left === right } &&
    (right === other.right) &&
    (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 5831



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [constant, left, *requireds, right]
end


  








  

    #closing  
  



  

    
def closing: () -> String?

  



  [ GitHub ]


  

  


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



def closing
  closing_loc&.slice
end


  








  

    #closing_loc  
  



  

    
attr_reader closing_loc: Location?

  



  [ GitHub ]


  

  


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



def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [*constant, left, *requireds, right, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << constant if constant
  compact << left
  compact.concat(requireds)
  compact << right
  compact
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, left: self.left, requireds: self.requireds, right: self.right, opening_loc: self.opening_loc, closing_loc: self.closing_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?constant: Prism.node?, ?left: Prism.node, ?requireds: Array, ?right: Prism.node, ?opening_loc: Location?, ?closing_loc: Location?) -> FindPatternNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, left: self.left, requireds: self.requireds, right: self.right, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  FindPatternNode.new(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, constant: Prism.node?, left: Prism.node, requireds: Array, right: Prism.node, opening_loc: Location?, closing_loc: Location? }

  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { node_id: node_id, location: location, constant: constant, left: left, requireds: requireds, right: right, opening_loc: opening_loc, closing_loc: closing_loc }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    
def opening: () -> String?

  



  [ GitHub ]


  

  


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



def opening
  opening_loc&.slice
end


  








  

    #opening_loc  
  



  

    
attr_reader opening_loc: Location?

  



  [ GitHub ]


  

  


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



def opening_loc
  location = @opening_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :find_pattern_node
end