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

closing_loc[R]

attr_reader closing_loc: Location?

content_loc[R]

attr_reader content_loc: Location

opening_loc[R]

attr_reader opening_loc: Location?

unescaped[R]

attr_reader unescaped: String

Public Class Methods

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

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

# File lib/prism/node.rb, line 15882
def initialize(flags, opening_loc, content_loc, closing_loc, unescaped, location)
  @flags = flags
  @opening_loc = opening_loc
  @content_loc = content_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
  @location = location
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 15997
def self.type
  :string_node
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File lib/prism/node.rb, line 15892
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 15897
def child_nodes
  []
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

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

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 15907
def comment_targets
  [*opening_loc, content_loc, *closing_loc]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

content() click to toggle source

def content: () -> String

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

copy(**params) click to toggle source

def copy: (**params) -> StringNode

# File lib/prism/node.rb, line 15912
def copy(**params)
  StringNode.new(
    params.fetch(:flags) { flags },
    params.fetch(:opening_loc) { opening_loc },
    params.fetch(:content_loc) { content_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:unescaped) { unescaped },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

inspect(inspector = NodeInspector.new) click to toggle source

def inspect(inspector: NodeInspector) -> String

# File lib/prism/node.rb, line 15962
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  flags = [("forced_utf8_encoding" if forced_utf8_encoding?), ("forced_binary_encoding" if forced_binary_encoding?), ("frozen" if frozen?)].compact
  inspector << "├── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector << "├── opening_loc: #{inspector.location(opening_loc)}\n"
  inspector << "├── content_loc: #{inspector.location(content_loc)}\n"
  inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector << "└── unescaped: #{unescaped.inspect}\n"
  inspector.to_str
end

opening() click to toggle source

def opening: () -> String?

# File lib/prism/node.rb, line 15947
def opening
  opening_loc&.slice
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 15987
def type
  :string_node
end