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"
^^^^ ^^^^
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16846
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
Initialize a new StringNode node.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16990
def self.type
:string_node
end
Return a symbol representation of this node type. See ‘Node::type`.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16996
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
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16858
def accept(visitor)
visitor.visit_string_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16863
def child_nodes
[]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16975
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16943
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
attr_reader closing_loc: Location?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16873
def comment_targets
[*opening_loc, content_loc, *closing_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16868
def compact_child_nodes
[]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16970
def content
content_loc.slice
end
def content: () -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16930
def content_loc
location = @content_loc
return location if location.is_a?(Location)
@content_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
attr_reader content_loc: Location
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16878
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
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16886
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 deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location?, content_loc: Location, closing_loc: Location?, unescaped: String }
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16896
def forced_binary_encoding?
flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
end
def forced_binary_encoding?: () -> bool
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16891
def forced_utf8_encoding?
flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
end
def forced_utf8_encoding?: () -> bool
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16901
def frozen?
flags.anybits?(StringFlags::FROZEN)
end
def frozen?: () -> bool
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16980
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16906
def mutable?
flags.anybits?(StringFlags::MUTABLE)
end
def mutable?: () -> bool
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16965
def opening
opening_loc&.slice
end
def opening: () -> String?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16911
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
attr_reader opening_loc: Location?
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16957
def save_closing_loc(repository)
repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end
Save the closing_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16938
def save_content_loc(repository)
repository.enter(node_id, :content_loc)
end
Save the content_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16925
def save_opening_loc(repository)
repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end
Save the opening_loc location using the given saved source so that it can be retrieved later.
# File tmp/rubies/ruby-3.4.1/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
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 tmp/rubies/ruby-3.4.1/lib/prism/node.rb, line 16985
def type
:string_node
end
Return a symbol representation of this node type. See ‘Node#type`.