Class: Prism::InterpolatedStringNode

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

Overview

Represents a string literal that contains interpolation.

"foo #{bar} baz"
^^^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, opening_loc, parts, closing_loc) ⇒ InterpolatedStringNode

Initialize a new InterpolatedStringNode node.



9634
9635
9636
9637
9638
9639
9640
9641
9642
 
# File 'lib/prism/node.rb', line 9634

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

Instance Attribute Details

#parts ⇒ Object (readonly)

attr_reader parts: Array[StringNode | EmbeddedStatementsNode | EmbeddedVariableNode | InterpolatedStringNode]



9701
9702
9703
 
# File 'lib/prism/node.rb', line 9701

def parts
  @parts
end

Class Method Details

.type ⇒ Object

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



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

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



9743
9744
9745
9746
9747
9748
9749
9750
 
# File 'lib/prism/node.rb', line 9743

def ===(other)
  other.is_a?(InterpolatedStringNode) &&
    (flags === other.flags) &&
    (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) ⇒ Object

def accept: (Visitor visitor) -> void



9645
9646
9647
 
# File 'lib/prism/node.rb', line 9645

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

#child_nodes ⇒ Object Also known as: deconstruct

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



9650
9651
9652
 
# File 'lib/prism/node.rb', line 9650

def child_nodes
  [*parts]
end

#closing ⇒ Object

def closing: () -> String?



9722
9723
9724
 
# File 'lib/prism/node.rb', line 9722

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
 
# File 'lib/prism/node.rb', line 9704

def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#comment_targets ⇒ Object

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



9660
9661
9662
 
# File 'lib/prism/node.rb', line 9660

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



9655
9656
9657
 
# File 'lib/prism/node.rb', line 9655

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) ⇒ Object

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



9665
9666
9667
 
# File 'lib/prism/node.rb', line 9665

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)
  InterpolatedStringNode.new(source, node_id, location, flags, opening_loc, parts, closing_loc)
end

#deconstruct_keys(keys) ⇒ Object

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



9673
9674
9675
 
# File 'lib/prism/node.rb', line 9673

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

#frozen? ⇒ Boolean

def frozen?: () -> bool

Returns:

  • (Boolean) 


9678
9679
9680
 
# File 'lib/prism/node.rb', line 9678

def frozen?
  flags.anybits?(InterpolatedStringNodeFlags::FROZEN)
end

#inspect ⇒ Object

def inspect -> String



9727
9728
9729
 
# File 'lib/prism/node.rb', line 9727

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool

Returns:

  • (Boolean) 


9683
9684
9685
 
# File 'lib/prism/node.rb', line 9683

def mutable?
  flags.anybits?(InterpolatedStringNodeFlags::MUTABLE)
end

#newline_flag!(lines) ⇒ Object

:nodoc:



135
136
137
138
 
# File 'lib/prism/parse_result/newlines.rb', line 135

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

#opening ⇒ Object

def opening: () -> String?



9717
9718
9719
 
# File 'lib/prism/node.rb', line 9717

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
 
# File 'lib/prism/node.rb', line 9688

def opening_loc
  location = @opening_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#type ⇒ Object

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



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

def type
  :interpolated_string_node
end