class Prism::SymbolNode

Represents a symbol literal or a symbol contained within a ‘%i` list.

:foo
^^^^

%i[foo]
   ^^^

Attributes

flags[R]

protected attr_reader flags: Integer

unescaped[R]

attr_reader unescaped: String

Public Class Methods

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

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

# File lib/prism/node.rb, line 17866
def initialize(source, flags, opening_loc, value_loc, closing_loc, unescaped, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @value_loc = value_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 18015
def self.type
  :symbol_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 18021
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

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 17878
def accept(visitor)
  visitor.visit_symbol_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 17883
def child_nodes
  []
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

attr_reader closing_loc: Location?

# File lib/prism/node.rb, line 17941
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 17893
def comment_targets
  [*opening_loc, *value_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 17888
def compact_child_nodes
  []
end

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) click to toggle source

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

# File lib/prism/node.rb, line 17898
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

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?, value_loc: Location?, closing_loc: Location?, unescaped: String, location: Location }

# File lib/prism/node.rb, line 17906
def deconstruct_keys(keys)
  { flags: flags, opening_loc: opening_loc, value_loc: value_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 17962
def forced_binary_encoding?
  flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING)
end

forced_us_ascii_encoding?() click to toggle source

def forced_us_ascii_encoding?: () -> bool

# File lib/prism/node.rb, line 17967
def forced_us_ascii_encoding?
  flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING)
end

forced_utf8_encoding?() click to toggle source

def forced_utf8_encoding?: () -> bool

# File lib/prism/node.rb, line 17957
def forced_utf8_encoding?
  flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING)
end

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

attr_reader opening_loc: Location?

# File lib/prism/node.rb, line 17915
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

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 18005
def type
  :symbol_node
end

value() click to toggle source

def value: () -> String?

# File lib/prism/node.rb, line 17977
def value
  value_loc&.slice
end

value_loc() click to toggle source

attr_reader value_loc: Location?

# File lib/prism/node.rb, line 17928
def value_loc
  location = @value_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @value_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end