Class: Prism::NumberedReferenceReadNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents reading a numbered reference to a capture in the previous match.

$1
^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(number, location) ⇒ NumberedReferenceReadNode

def initialize: (number: Integer, location: Location) -> void



12766
12767
12768
12769
 
# File 'lib/prism/node.rb', line 12766

def initialize(number, location)
  @number = number
  @location = location
end

Instance Attribute Details

#number ⇒ Object (readonly)

attr_reader number: Integer



12763
12764
12765
 
# File 'lib/prism/node.rb', line 12763

def number
  @number
end

Class Method Details

.type ⇒ Object

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. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



12838
12839
12840
 
# File 'lib/prism/node.rb', line 12838

def self.type
  :numbered_reference_read_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12772
12773
12774
 
# File 'lib/prism/node.rb', line 12772

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

#child_nodes ⇒ Object Also known as: deconstruct

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



12777
12778
12779
 
# File 'lib/prism/node.rb', line 12777

def child_nodes
  []
end

#comment_targets ⇒ Object

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



12787
12788
12789
 
# File 'lib/prism/node.rb', line 12787

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



12782
12783
12784
 
# File 'lib/prism/node.rb', line 12782

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> NumberedReferenceReadNode



12792
12793
12794
12795
12796
12797
 
# File 'lib/prism/node.rb', line 12792

def copy(**params)
  NumberedReferenceReadNode.new(
    params.fetch(:number) { number },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



12803
12804
12805
 
# File 'lib/prism/node.rb', line 12803

def deconstruct_keys(keys)
  { number: number, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



12808
12809
12810
12811
12812
 
# File 'lib/prism/node.rb', line 12808

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── number: #{number.inspect}\n"
  inspector.to_str
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



12828
12829
12830
 
# File 'lib/prism/node.rb', line 12828

def type
  :numbered_reference_read_node
end