Class: Prism::PinnedVariableNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::PinnedVariableNode

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

• #variable ⇒ Object readonly

  The variable used in the pinned expression.

Class Method Summary

• .type ⇒ Object

  Return a symbol representation of this node type.

Instance Method Summary

• #===(other) ⇒ Object

  Implements case-equality for the node.

• #accept(visitor) ⇒ Object

  def accept: (Visitor visitor) -> void.

• #child_nodes ⇒ Object (also: #deconstruct)

  def child_nodes: () -> Array.

• #comment_targets ⇒ Object

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

• #compact_child_nodes ⇒ Object

  def compact_child_nodes: () -> Array.

• #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.

• #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 }.

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

  Initialize a new PinnedVariableNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #operator ⇒ Object

  def operator: () -> String.

• #operator_loc ⇒ Object

  The location of the ‘^` operator.

• #save_operator_loc(repository) ⇒ Object

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

• #type ⇒ Object

  Return a symbol representation of this node type.

Constructor Details

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

Initialize a new PinnedVariableNode node.

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

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
        ^^^

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

def variable
  @variable
end

Class Method Details

.type ⇒ Object

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

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

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.

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

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

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

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array

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

def child_nodes
  [variable]
end

#comment_targets ⇒ Object

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

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

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

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

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

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

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 }

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

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

#inspect ⇒ Object

def inspect -> String

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

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String

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

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘^` operator

foo in ^bar
       ^

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

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.

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

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`.

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

def type
  :pinned_variable_node
end