Class: Prism::EmbeddedVariableNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::EmbeddedVariableNode

Defined in:

lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents an interpolated variable.

"foo #@bar"
     ^^^^^

Instance Attribute Summary

• #variable ⇒ Object readonly

  attr_reader variable: InstanceVariableReadNode | ClassVariableReadNode | GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode.

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, operator_loc: self.operator_loc, variable: self.variable) ⇒ Object

  def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?operator_loc: Location, ?variable: InstanceVariableReadNode | ClassVariableReadNode | GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode) -> EmbeddedVariableNode.

• #deconstruct_keys(keys) ⇒ Object

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

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

  Initialize a new EmbeddedVariableNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #operator ⇒ Object

  def operator: () -> String.

• #operator_loc ⇒ Object

  attr_reader operator_loc: Location.

• #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, operator_loc, variable) ⇒ EmbeddedVariableNode

Initialize a new EmbeddedVariableNode node.

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

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

Instance Attribute Details

#variable ⇒ Object (readonly)

attr_reader variable: InstanceVariableReadNode | ClassVariableReadNode | GlobalVariableReadNode | BackReferenceReadNode | NumberedReferenceReadNode

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

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 6668

def self.type
  :embedded_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 6674

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void

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

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array

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

def child_nodes
  [variable]
end

#comment_targets ⇒ Object

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

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

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

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

def compact_child_nodes
  [variable]
end

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

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

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

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

#deconstruct_keys(keys) ⇒ Object

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

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

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

#inspect ⇒ Object

def inspect -> String

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

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String

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

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

attr_reader operator_loc: Location

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

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 6645

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 6663

def type
  :embedded_variable_node
end