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.



10924
10925
10926
10927
10928
10929
10930
10931
10932
 
# File 'lib/prism/node.rb', line 10924

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]



10997
10998
10999
 
# File 'lib/prism/node.rb', line 10997

def parts
  @parts
end

Class Method Details

.type ⇒ Object

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



11039
11040
11041
 
# File 'lib/prism/node.rb', line 11039

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.



11045
11046
11047
11048
11049
11050
11051
11052
 
# File 'lib/prism/node.rb', line 11045

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



10935
10936
10937
 
# File 'lib/prism/node.rb', line 10935

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



10940
10941
10942
 
# File 'lib/prism/node.rb', line 10940

def child_nodes
  [*parts]
end

#closing ⇒ Object

def closing: () -> String?



11024
11025
11026
 
# File 'lib/prism/node.rb', line 11024

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
 
# File 'lib/prism/node.rb', line 11000

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]



10950
10951
10952
 
# File 'lib/prism/node.rb', line 10950

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



10945
10946
10947
 
# File 'lib/prism/node.rb', line 10945

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



10955
10956
10957
 
# File 'lib/prism/node.rb', line 10955

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? }



10963
10964
10965
 
# File 'lib/prism/node.rb', line 10963

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) 


10968
10969
10970
 
# File 'lib/prism/node.rb', line 10968

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

#inspect ⇒ Object

def inspect -> String



11029
11030
11031
 
# File 'lib/prism/node.rb', line 11029

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool

Returns:

  • (Boolean) 


10973
10974
10975
 
# File 'lib/prism/node.rb', line 10973

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

#newline_flag!(lines) ⇒ Object

:nodoc:



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

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

#opening ⇒ Object

def opening: () -> String?



11019
11020
11021
 
# File 'lib/prism/node.rb', line 11019

def opening
  opening_loc&.slice
end

#opening_loc ⇒ Object

attr_reader opening_loc: Location?



10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
 
# File 'lib/prism/node.rb', line 10978

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.



11014
11015
11016
 
# File 'lib/prism/node.rb', line 11014

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.



10992
10993
10994
 
# File 'lib/prism/node.rb', line 10992

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



11034
11035
11036
 
# File 'lib/prism/node.rb', line 11034

def type
  :interpolated_string_node
end