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

flags[R]

protected attr_reader flags: Integer

unescaped[R]

attr_reader unescaped: String

Public Class Methods

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

def initialize: (Integer flags, Location? opening_loc, Location content_loc, Location? closing_loc, String unescaped, Location location) -> void

# File lib/prism/node.rb, line 17538
def initialize(source, flags, opening_loc, content_loc, closing_loc, unescaped, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @content_loc = content_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
end

type() click to toggle source

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

# File lib/prism/node.rb, line 17686
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 17692
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 17550
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 17555
def child_nodes
  []
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

attr_reader closing_loc: Location?

# File lib/prism/node.rb, line 17607
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 17565
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 17560
def compact_child_nodes
  []
end

content() click to toggle source

def content: () -> String

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

content_loc() click to toggle source

attr_reader content_loc: Location

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

copy(flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped, location: self.location) click to toggle source

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

# File lib/prism/node.rb, line 17570
def copy(flags: self.flags, opening_loc: self.opening_loc, content_loc: self.content_loc, closing_loc: self.closing_loc, unescaped: self.unescaped, location: self.location)
  StringNode.new(source, flags, opening_loc, content_loc, closing_loc, unescaped, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

# File lib/prism/node.rb, line 17578
def deconstruct_keys(keys)
  { flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location }
end

forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

# File lib/prism/node.rb, line 17628
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 17623
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 17633
def frozen?
  flags.anybits?(StringFlags::FROZEN)
end

inspect() click to toggle source

def inspect -> String

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

mutable?() click to toggle source

def mutable?: () -> bool

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

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

attr_reader opening_loc: Location?

# File lib/prism/node.rb, line 17587
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 55
def to_interpolated
  InterpolatedStringNode.new(
    source,
    frozen? ? InterpolatedStringNodeFlags::FROZEN : 0,
    opening_loc,
    [copy(opening_loc: nil, closing_loc: nil, location: content_loc)],
    closing_loc,
    location
  )
end

type() click to toggle source

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol

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