class Prism::StringNode

^^^^ ^^^^
“foo #{bar} baz”

^^^
%w[foo]

^^^^^
“foo”
Represents a string literal, a string contained within a ‘%w` list, or plain string content within an interpolated string.

def self.type

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

def self.type
  :string_node
end

def ===(other)

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

def ===(other)
  other.is_a?(StringNode) &&
    (flags === other.flags) &&
    (opening_loc.nil? == other.opening_loc.nil?) &&
    (content_loc.nil? == other.content_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?) &&
    (unescaped === other.unescaped)
end

def accept(visitor)

def accept: (Visitor visitor) -> void

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

def child_nodes

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

def child_nodes
  []
end

def closing

def closing: () -> String?

def closing
  closing_loc&.slice
end

def closing_loc

attr_reader closing_loc: Location?

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

def comment_targets

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

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

def compact_child_nodes

def compact_child_nodes: () -> Array[Node]

def compact_child_nodes
  []
end

def content

def content: () -> String

def content
  content_loc.slice
end

def content_loc

attr_reader content_loc: Location

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

def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?opening_loc: Location?, ?content_loc: Location, ?closing_loc: Location?, ?unescaped: String) -> StringNode

def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
  StringNode.new(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)
end

def deconstruct_keys(keys)

def deconstruct_keys: (Array[Symbol] keys) -> { node_id: Integer, location: Location, opening_loc: Location?, content_loc: Location, closing_loc: Location?, unescaped: String }

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

def forced_binary_encoding?

def forced_binary_encoding?: () -> bool

def forced_binary_encoding?
  flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
end

def forced_utf8_encoding?

def forced_utf8_encoding?: () -> bool

def forced_utf8_encoding?
  flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
end

def frozen?

def frozen?: () -> bool

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

def initialize(source, node_id, location, flags, opening_loc, content_loc, closing_loc, unescaped)

Initialize a new StringNode node.

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

def inspect

def inspect -> String

def inspect
  InspectVisitor.compose(self)
end

def mutable?

def mutable?: () -> bool

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

def opening

def opening: () -> String?

def opening
  opening_loc&.slice
end

def opening_loc

attr_reader opening_loc: Location?

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

def to_interpolated

that there's a consistent interface for working with strings.
Occasionally it's helpful to treat a string as if it were interpolated so

def to_interpolated
  InterpolatedStringNode.new(
    source,
    -1,
    location,
    frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
    opening_loc,
    [copy(location: content_loc, opening_loc: nil, closing_loc: nil)],
    closing_loc
  )
end

def type

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

def type
  :string_node
end

Modules

Classes