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
private attr_reader flags: Integer
attr_reader unescaped: String
Public Class Methods
def initialize: (Integer
flags, Location
? opening_loc
, Location
content_loc
, Location
? closing_loc
, String
unescaped, Location
location) -> void
# File lib/prism/node.rb, line 17234 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
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 17390 def self.type :string_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 17246 def accept(visitor) visitor.visit_string_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 17251 def child_nodes [] end
def closing: () -> String
?
# File lib/prism/node.rb, line 17350 def closing closing_loc&.slice end
attr_reader closing_loc
: Location
?
# File lib/prism/node.rb, line 17303 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
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 17261 def comment_targets [*opening_loc, content_loc, *closing_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 17256 def compact_child_nodes [] end
def content: () -> String
# File lib/prism/node.rb, line 17345 def content content_loc.slice end
attr_reader content_loc
: Location
# File lib/prism/node.rb, line 17296 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: (?flags: Integer
, ?opening_loc: Location
?, ?content_loc: Location
, ?closing_loc: Location
?, ?unescaped: String
, ?location: Location
) -> StringNode
# File lib/prism/node.rb, line 17266 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
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 17274 def deconstruct_keys(keys) { flags: flags, opening_loc: opening_loc, content_loc: content_loc, closing_loc: closing_loc, unescaped: unescaped, location: location } end
def forced_binary_encoding?: () -> bool
# File lib/prism/node.rb, line 17325 def forced_binary_encoding? flags.anybits?(StringFlags::FORCED_BINARY_ENCODING) end
def forced_utf8_encoding?: () -> bool
# File lib/prism/node.rb, line 17320 def forced_utf8_encoding? flags.anybits?(StringFlags::FORCED_UTF8_ENCODING) end
def frozen?: () -> bool
# File lib/prism/node.rb, line 17330 def frozen? flags.anybits?(StringFlags::FROZEN) end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 17355 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?), ("mutable" if mutable?)].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
def mutable?: () -> bool
# File lib/prism/node.rb, line 17335 def mutable? flags.anybits?(StringFlags::MUTABLE) end
def opening: () -> String
?
# File lib/prism/node.rb, line 17340 def opening opening_loc&.slice end
attr_reader opening_loc
: Location
?
# File lib/prism/node.rb, line 17283 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
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
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 17380 def type :string_node end