123456789_123456789_123456789_123456789_123456789_

Class: Prism::SymbolNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

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

:foo
^^^^

%i[foo]
   ^^^

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped) ⇒ SymbolNode

Initialize a new SymbolNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 15290



def initialize(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @opening_loc = opening_loc
  @value_loc = value_loc
  @closing_loc = closing_loc
  @unescaped = unescaped
end


  







Class Method Details



  

    .type  
  



  

    
Return a symbol representation of this node type. See Node::type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15416



def self.type
  :symbol_node
end


  







Instance Attribute Details



  

    #forced_binary_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_binary_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15340



def forced_binary_encoding?
  flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING)
end


  








  

    #forced_us_ascii_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_us_ascii_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15345



def forced_us_ascii_encoding?
  flags.anybits?(SymbolFlags::FORCED_US_ASCII_ENCODING)
end


  








  

    #forced_utf8_encoding?  ⇒ Boolean  (readonly)
  



  

    
def forced_utf8_encoding?: () -> bool

  





  


  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15335



def forced_utf8_encoding?
  flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING)
end


  








  

    #unescaped   (readonly)
  



  

    
attr_reader unescaped: String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15389



attr_reader :unescaped


  







Instance Method Details



  

    #===(other)  
  



  

    
Implements case-equality for the node. This is effectively == but without
comparing the value of locations. Locations are checked only for presence.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15422



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)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15302



def accept(visitor)
  visitor.visit_symbol_node(self)
end


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15307



def child_nodes
  []
end


  








  

    #closing  
  



  

    
def closing: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15401



def closing
  closing_loc&.slice
end


  








  

    #closing_loc  
  



  

    
attr_reader closing_loc: Location?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15376



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  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15317



def comment_targets
  [*opening_loc, *value_loc, *closing_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15312



def compact_child_nodes
  []
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15322



def copy(node_id: self.node_id, location: self.location, flags: self.flags, opening_loc: self.opening_loc, value_loc: self.value_loc, closing_loc: self.closing_loc, unescaped: self.unescaped)
  SymbolNode.new(source, node_id, location, flags, opening_loc, value_loc, closing_loc, unescaped)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15327



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, opening_loc: Location?, value_loc: Location?, closing_loc: Location?, unescaped: String }

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15330



def deconstruct_keys(keys)
  { node_id: node_id, location: location, opening_loc: opening_loc, value_loc: value_loc, closing_loc: closing_loc, unescaped: unescaped }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15406



def inspect
  InspectVisitor.compose(self)
end


  








  

    #opening  
  



  

    
def opening: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15391



def opening
  opening_loc&.slice
end


  








  

    #opening_loc  
  



  

    
attr_reader opening_loc: Location?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15350



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  
  



  

    
Return a symbol representation of this node type. See Node#type.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15411



def type
  :symbol_node
end


  








  

    #value  
  



  

    
def value: () -> String?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15396



def value
  value_loc&.slice
end


  








  

    #value_loc  
  



  

    
attr_reader value_loc: Location?

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 15363



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