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

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.

[View source]

10822
10823
10824
10825
10826
10827
10828
10829
10830
 
# File 'lib/prism/node.rb', line 10822

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 | XStringNode]


10895
10896
10897
 
# File 'lib/prism/node.rb', line 10895

def parts
  @parts
end

Class Method Details

.type ⇒ Object

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

[View source]

10937
10938
10939
 
# File 'lib/prism/node.rb', line 10937

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.

[View source]

10943
10944
10945
10946
10947
10948
10949
10950
 
# File 'lib/prism/node.rb', line 10943

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

[View source]

10833
10834
10835
 
# File 'lib/prism/node.rb', line 10833

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

#child_nodes ⇒ Object Also known as: deconstruct

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

[View source]

10838
10839
10840
 
# File 'lib/prism/node.rb', line 10838

def child_nodes
  [*parts]
end

#closing ⇒ Object

def closing: () -> String?

[View source]

10922
10923
10924
 
# File 'lib/prism/node.rb', line 10922

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?

[View source]

10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
 
# File 'lib/prism/node.rb', line 10898

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]

[View source]

10848
10849
10850
 
# File 'lib/prism/node.rb', line 10848

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

[View source]

10843
10844
10845
 
# File 'lib/prism/node.rb', line 10843

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 | XStringNode], ?closing_loc: Location?) -> InterpolatedStringNode

[View source]

10853
10854
10855
 
# File 'lib/prism/node.rb', line 10853

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 | XStringNode], closing_loc: Location? }

[View source]

10861
10862
10863
 
# File 'lib/prism/node.rb', line 10861

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)
[View source]

10866
10867
10868
 
# File 'lib/prism/node.rb', line 10866

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

#inspect ⇒ Object

def inspect -> String

[View source]

10927
10928
10929
 
# File 'lib/prism/node.rb', line 10927

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool

Returns:

  • (Boolean)
[View source]

10871
10872
10873
 
# File 'lib/prism/node.rb', line 10871

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

#newline_flag!(lines) ⇒ Object

:nodoc:

[View source]

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?

[View source]

10917
10918
10919
 
# File 'lib/prism/node.rb', line 10917

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?

[View source]

10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
 
# File 'lib/prism/node.rb', line 10876

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

#save_closing_loc(repository) ⇒ Object

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

[View source]

10912
10913
10914
 
# File 'lib/prism/node.rb', line 10912

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

#save_opening_loc(repository) ⇒ Object

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

[View source]

10890
10891
10892
 
# File 'lib/prism/node.rb', line 10890

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

#type ⇒ Object

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

[View source]

10932
10933
10934
 
# File 'lib/prism/node.rb', line 10932

def type
  :interpolated_string_node
end