class Prism::StringNode

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

"foo"
^^^^^

%w[foo]
   ^^^

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

Attributes

unescaped[R]

attr_reader unescaped: String

Public Class Methods

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

Initialize a new StringNode node.

# File lib/prism/node.rb, line 15004
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

type() click to toggle source

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

# File lib/prism/node.rb, line 15129
def self.type
  :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 lib/prism/node.rb, line 15135
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

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 15016
def accept(visitor)
  visitor.visit_string_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 15021
def child_nodes
  []
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

attr_reader closing_loc: Location?

# File lib/prism/node.rb, line 15089
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 lib/prism/node.rb, line 15031
def comment_targets
  [*opening_loc, content_loc, *closing_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 15026
def compact_child_nodes
  []
end

content() click to toggle source

def content: () -> String

# File lib/prism/node.rb, line 15109
def content
  content_loc.slice
end

content_loc() click to toggle source

attr_reader content_loc: Location

# File lib/prism/node.rb, line 15082
def content_loc
  location = @content_loc
  return location if location.is_a?(Location)
  @content_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

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

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

# File lib/prism/node.rb, line 15036
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

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?, content_loc: Location, closing_loc: Location?, unescaped: String }

# File lib/prism/node.rb, line 15044
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

forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

# File lib/prism/node.rb, line 15054
def forced_binary_encoding?
  flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
end

forced_utf8_encoding?() click to toggle source

def forced_utf8_encoding?: () -> bool

# File lib/prism/node.rb, line 15049
def forced_utf8_encoding?
  flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
end

frozen?() click to toggle source

def frozen?: () -> bool

# File lib/prism/node.rb, line 15059
def frozen?
  flags.anybits?(StringFlags::FROZEN)
end

inspect() click to toggle source

def inspect -> String

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

mutable?() click to toggle source

def mutable?: () -> bool

# File lib/prism/node.rb, line 15064
def mutable?
  flags.anybits?(StringFlags::MUTABLE)
end

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

attr_reader opening_loc: Location?

# File lib/prism/node.rb, line 15069
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

to_interpolated() click to toggle source

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

# File lib/prism/node_ext.rb, line 72
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

type() click to toggle source

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

# File lib/prism/node.rb, line 15124
def type
  :string_node
end