class Prism::SymbolNode - prism: Ruby Standard Library Documentation

# class Prism::SymbolNode

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

    :foo
    ^^^^

    %i[foo]
       ^^^

### Attributes

unescaped[R]

attr_reader unescaped: String

### Public Class Methods

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

Initialize a new `SymbolNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 17316
    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 prism/node.rb, line 17322
    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 prism/node.rb, line 17183
    def accept(visitor)
      visitor.visit_symbol_node(self)
    end

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`?

    # File prism/node.rb, line 17269
    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 prism/node.rb, line 17198
    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 prism/node.rb, line 17193
    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) click to toggle source

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

    # File prism/node.rb, line 17203
    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()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

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

forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

    # File prism/node.rb, line 17221
    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 prism/node.rb, line 17226
    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 prism/node.rb, line 17216
    def forced_utf8_encoding?
      flags.anybits?(SymbolFlags::FORCED_UTF8_ENCODING)
    end

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

attr_reader `opening_loc`: `Location`?

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

save_closing_loc(repository) click to toggle source

Save the `closing_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 17283
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

save_opening_loc(repository) click to toggle source

Save the `opening_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 17245
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

save_value_loc(repository) click to toggle source

Save the `value_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 17264
    def save_value_loc(repository)
      repository.enter(node_id, :value_loc) unless @value_loc.nil?
    end

type() click to toggle source

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

    # File prism/node.rb, line 17311
    def type
      :symbol_node
    end

value() click to toggle source

def value: () -> String?

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

value_loc() click to toggle source

attr_reader `value_loc`: `Location`?

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