123456789_123456789_123456789_123456789_123456789_

Class: Prism::InterpolatedXStringNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, HeredocQuery, PrismNode
Inherits: PrismNode
  • ::Object
Defined in: lib/prism/node.rb,
ext/prism/api_node.c,
lib/prism/node_ext.rb,
lib/prism/parse_result/newlines.rb

Overview

Represents an xstring literal that contains interpolation.

`foo #{bar} baz`
^^^^^^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

HeredocQuery - Included

#heredoc?

Returns true if this node was represented as a heredoc in the source code.

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, opening_loc, parts, closing_loc) ⇒ InterpolatedXStringNode

Initialize a new InterpolatedXStringNode node.

[ GitHub ]

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

def initialize(source, node_id, location, flags, opening_loc, parts, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @parts = parts
  @closing_loc = closing_loc
end

Class Method Details

.type

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

[ GitHub ]

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

def self.type
  :interpolated_x_string_node
end

Instance Attribute Details

#parts (readonly)

attr_reader parts: Array[StringNode | EmbeddedStatementsNode | EmbeddedVariableNode]

[ GitHub ]

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

attr_reader :parts

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 9781

def ===(other)
  other.is_a?(InterpolatedXStringNode) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (parts.length == other.parts.length) &&
    parts.zip(other.parts).all? { |left, right| left === right } &&
    (closing_loc.nil? == other.closing_loc.nil?)
end

#accept(visitor)

def accept: (Visitor visitor) -> void

[ GitHub ]

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

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

#child_nodes Also known as: #deconstruct

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

[ GitHub ]

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

def child_nodes
  [*parts]
end

#closing

def closing: () -> String

[ GitHub ]

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

def closing
  closing_loc.slice
end

#closing_loc

attr_reader closing_loc: Location

[ GitHub ]

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

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

#comment_targets

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

[ GitHub ]

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

def comment_targets
  [opening_loc, *parts, closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes

def compact_child_nodes: () -> Array

[ GitHub ]

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

def compact_child_nodes
  [*parts]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, parts: self.parts, closing_loc: self.closing_loc)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location, ?parts: Array[StringNode | EmbeddedStatementsNode | EmbeddedVariableNode], ?closing_loc: Location) -> InterpolatedXStringNode

[ GitHub ]

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

def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, parts: self.parts, closing_loc: self.closing_loc)
  InterpolatedXStringNode.new(source, node_id, location, flags, opening_loc, parts, closing_loc)
end

#deconstruct

Alias for #child_nodes.

[ GitHub ]

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

alias deconstruct child_nodes

#deconstruct_keys(keys)

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location, parts: Array[StringNode | EmbeddedStatementsNode | EmbeddedVariableNode], closing_loc: Location }

[ GitHub ]

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

def deconstruct_keys(keys)
  { node_id: node_id, location: location, opening_loc: opening_loc, parts: parts, closing_loc: closing_loc }
end

#inspect

def inspect -> String

[ GitHub ]

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

def inspect
  InspectVisitor.compose(self)
end

#newline_flag!(lines)

This method is for internal use only.
[ GitHub ]

  
# File 'lib/prism/parse_result/newlines.rb', line 150

def newline_flag!(lines) # :nodoc:
  first = parts.first
  first.newline_flag!(lines) if first
end

#opening

def opening: () -> String

[ GitHub ]

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

def opening
  opening_loc.slice
end

#opening_loc

attr_reader opening_loc: Location

[ GitHub ]

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

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

#type

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

[ GitHub ]

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

def type
  :interpolated_x_string_node
end