class Prism::SymbolNode - Documentation for Ruby 4.0
Description: class Prism::SymbolNode: Represents a symbol literal or a symbol contained within a `%i` list.
Keywords: ruby,class,Prism::SymbolNode

🔍

No recent searches

# 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)
Source

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

Initialize a new `SymbolNode` node.

type ()
Source

    # File lib/prism/node.rb, line 18602
    def self.type
      :symbol_node
    end

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

### Public Instance Methods

=== (other)
Source

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

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

accept (visitor)
Source

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

def accept: (`Visitor` visitor) -> void

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
closing ()
Source

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

def closing: () -> `String`?

closing_loc ()
Source

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

comment_targets ()
Source

    # File lib/prism/node.rb, line 18484
    def comment_targets
      [*opening_loc, *value_loc, *closing_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 18479
    def compact_child_nodes
      []
    end

def `compact_child_nodes`: () -> Array

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)
Source

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

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

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

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

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

each_child_node ()
Source

    # File lib/prism/node.rb, line 18473
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

forced_binary_encoding? ()
Source

    # File lib/prism/node.rb, line 18507
    def forced_binary_encoding?
      flags.anybits?(SymbolFlags::FORCED_BINARY_ENCODING)
    end

def forced_binary_encoding?: () -> bool

forced_us_ascii_encoding? ()
Source

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

def forced_us_ascii_encoding?: () -> bool

forced_utf8_encoding? ()
Source

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

def forced_utf8_encoding?: () -> bool

inspect ()
Source

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

def inspect -> `String`

opening ()
Source

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

def opening: () -> `String`?

opening_loc ()
Source

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

save_closing_loc (repository)
Source

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

save_opening_loc (repository)
Source

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

save_value_loc (repository)
Source

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

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

type ()
Source

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

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

value ()
Source

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

def value: () -> `String`?

value_loc ()
Source

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

attr_reader `value_loc`: `Location`?