class Prism::SymbolNode
Represents a symbol literal or a symbol contained within a ‘%i` list.
:foo ^^^^ %i[foo] ^^^
Attributes
protected attr_reader flags: Integer
attr_reader unescaped: String
Public Class Methods
def initialize: (Integer flags, Location
? opening_loc
, Location
? value_loc
, Location
? closing_loc
, String unescaped, Location
location) -> void
# File prism/node.rb, line 17735 def initialize(source, flags, opening_loc, value_loc, closing_loc, unescaped, location) @source = source @location = location @flags = flags @opening_loc = opening_loc @value_loc = value_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 prism/node.rb, line 17883 def self.type :symbol_node end
Public Instance Methods
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File prism/node.rb, line 17889 def ===(other) other.is_a?(SymbolNode) && (flags === other.flags) && (opening_loc.nil? == other.opening_loc.nil?) && (value_loc.nil? == other.value_loc.nil?) && (closing_loc.nil? == other.closing_loc.nil?) && (unescaped === other.unescaped) end
def accept: (Visitor
visitor) -> void
# File prism/node.rb, line 17746 def accept(visitor) visitor.visit_symbol_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File prism/node.rb, line 17751 def child_nodes [] end
def closing: () -> String?
# File prism/node.rb, line 17850 def closing closing_loc&.slice end
attr_reader closing_loc
: Location
?
# File prism/node.rb, line 17809 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 prism/node.rb, line 17761 def comment_targets [*opening_loc, *value_loc, *closing_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File prism/node.rb, line 17756 def compact_child_nodes [] end
def copy: (?flags: Integer, ?opening_loc: Location
?, ?value_loc: Location
?, ?closing_loc: Location
?, ?unescaped: String, ?location: Location
) -> SymbolNode
# File prism/node.rb, line 17766 def copy(flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped, location: self.location) SymbolNode.new(source, flags, opening_loc, value_loc, closing_loc, unescaped, location) end
def deconstruct_keys
: (Array keys) -> { flags: Integer, opening_loc
: Location
?, value_loc
: Location
?, closing_loc
: Location
?, unescaped: String, location: Location
}
# File prism/node.rb, line 17774 def deconstruct_keys(keys) { flags: flags, opening_loc: opening_loc, value_loc: value_loc, closing_loc: closing_loc, unescaped: unescaped, location: location } end
def forced_binary_encoding?: () -> bool
# File prism/node.rb, line 17830 def forced_binary_encoding? flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING) end
def forced_us_ascii_encoding?: () -> bool
# File prism/node.rb, line 17835 def forced_us_ascii_encoding? flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING) end
def forced_utf8_encoding?: () -> bool
# File prism/node.rb, line 17825 def forced_utf8_encoding? flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING) end
def inspect -> String
# File prism/node.rb, line 17855 def inspect InspectVisitor.compose(self) end
def opening: () -> String?
# File prism/node.rb, line 17840 def opening opening_loc&.slice end
attr_reader opening_loc
: Location
?
# File prism/node.rb, line 17783 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
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 prism/node.rb, line 17873 def type :symbol_node end
def value: () -> String?
# File prism/node.rb, line 17845 def value value_loc&.slice end