class Prism::InterpolatedStringNode - prism: Ruby Standard Library Documentation

# class Prism::InterpolatedStringNode

Represents a string literal that contains interpolation.

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

### Attributes

parts[R]

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

### Public Class Methods

new(source, node_id, location, flags, opening_loc, parts, closing_loc) click to toggle source

Initialize a new `InterpolatedStringNode` node.

    # File 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

type() click to toggle source

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

    # File prism/node.rb, line 10937
    def self.type
      :interpolated_string_node
    end

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File 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) click to toggle source

def accept: (`Visitor` visitor) -> void

    # File prism/node.rb, line 10833
    def accept(visitor)
      visitor.visit_interpolated_string_node(self)
    end

child_nodes() click to toggle source

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

    # File prism/node.rb, line 10838
    def child_nodes
      [*parts]
    end

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String?

    # File prism/node.rb, line 10922
    def closing
      closing_loc&.slice
    end

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`?

    # File 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() click to toggle source

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

    # File prism/node.rb, line 10848
    def comment_targets
      [*opening_loc, *parts, *closing_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File 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) click to toggle source

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

    # File 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()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

    # File 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?() click to toggle source

def frozen?: () -> bool

    # File prism/node.rb, line 10866
    def frozen?
      flags.anybits?(InterpolatedStringNodeFlags::FROZEN)
    end

inspect() click to toggle source

def inspect -> String

    # File prism/node.rb, line 10927
    def inspect
      InspectVisitor.compose(self)
    end

mutable?() click to toggle source

def mutable?: () -> bool

    # File prism/node.rb, line 10871
    def mutable?
      flags.anybits?(InterpolatedStringNodeFlags::MUTABLE)
    end

opening() click to toggle source

def opening: () -> String?

    # File prism/node.rb, line 10917
    def opening
      opening_loc&.slice
    end

opening_loc() click to toggle source

attr_reader `opening_loc`: `Location`?

    # File 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) click to toggle source

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

    # File 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) click to toggle source

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

    # File prism/node.rb, line 10890
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

type() click to toggle source

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

    # File prism/node.rb, line 10932
    def type
      :interpolated_string_node
    end