123456789_123456789_123456789_123456789_123456789_

Class: Prism::BackReferenceReadNode

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 reading a reference to a field in the previous match.

$'
^^

Class Method Summary

Instance Attribute Summary

  • #name readonly

    The name of the back-reference variable, including the leading $.

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, name) ⇒ BackReferenceReadNode

Initialize a new BackReferenceReadNode node.

[ GitHub ] 

  


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



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :back_reference_read_node
end


  







Instance Attribute Details



  

    #name   (readonly)
  



  

    
The name of the back-reference variable, including the leading $.


$& # name {:$&}

$+ # name `:$+`

  



  [ GitHub ]


  

  


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



attr_reader :name


  







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 1241



def ===(other)
  other.is_a?(BackReferenceReadNode) &&
    (name === other.name)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  []
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



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


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  []
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol) -> BackReferenceReadNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name)
  BackReferenceReadNode.new(source, node_id, location, flags, name)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol }

  



  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



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 1230



def type
  :back_reference_read_node
end