Class: Prism::PinnedVariableNode

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

Overview

Represents the use of the ‘^` operator for pinning a variable in a pattern matching expression.

foo in ^bar
       ^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, variable, operator_loc) ⇒ PinnedVariableNode

Initialize a new PinnedVariableNode node.



14683
14684
14685
14686
14687
14688
14689
14690
 
# File 'lib/prism/node.rb', line 14683

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

Instance Attribute Details

#variable ⇒ Object (readonly)

The variable used in the pinned expression

foo in ^bar
        ^^^



14729
14730
14731
 
# File 'lib/prism/node.rb', line 14729

def variable
  @variable
end

Class Method Details

.type ⇒ Object

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



14763
14764
14765
 
# File 'lib/prism/node.rb', line 14763

def self.type
  :pinned_variable_node
end

Instance Method Details

#===(other) ⇒ Object

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.



14769
14770
14771
14772
14773
 
# File 'lib/prism/node.rb', line 14769

def ===(other)
  other.is_a?(PinnedVariableNode) &&
    (variable === other.variable) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



14693
14694
14695
 
# File 'lib/prism/node.rb', line 14693

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



14698
14699
14700
 
# File 'lib/prism/node.rb', line 14698

def child_nodes
  [variable]
end

#comment_targets ⇒ Object

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



14708
14709
14710
 
# File 'lib/prism/node.rb', line 14708

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



14703
14704
14705
 
# File 'lib/prism/node.rb', line 14703

def compact_child_nodes
  [variable]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, variable: self.variable, operator_loc: self.operator_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?variable: LocalVariableReadNode | InstanceVariableReadNode | ClassVariableReadNode | GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode | ItLocalVariableReadNode | MissingNode, ?operator_loc: Location) -> PinnedVariableNode



14713
14714
14715
 
# File 'lib/prism/node.rb', line 14713

def copy(node_id: self.node_id, location: self.location, flags: self.flags, variable: self.variable, operator_loc: self.operator_loc)
  PinnedVariableNode.new(source, node_id, location, flags, variable, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, variable: LocalVariableReadNode | InstanceVariableReadNode | ClassVariableReadNode | GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode | ItLocalVariableReadNode | MissingNode, operator_loc: Location }



14721
14722
14723
 
# File 'lib/prism/node.rb', line 14721

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

#inspect ⇒ Object

def inspect -> String



14753
14754
14755
 
# File 'lib/prism/node.rb', line 14753

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String



14748
14749
14750
 
# File 'lib/prism/node.rb', line 14748

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘^` operator

foo in ^bar
       ^



14735
14736
14737
14738
14739
 
# File 'lib/prism/node.rb', line 14735

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

#save_operator_loc(repository) ⇒ Object

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



14743
14744
14745
 
# File 'lib/prism/node.rb', line 14743

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#type ⇒ Object

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



14758
14759
14760
 
# File 'lib/prism/node.rb', line 14758

def type
  :pinned_variable_node
end