class Prism::UndefNode - Documentation for Ruby 4.0
Description: class Prism::UndefNode: Represents the use of the `undef` keyword.
Keywords: ruby,class,Prism::UndefNode

🔍

No recent searches

# class Prism::UndefNode

Represents the use of the `undef` keyword.

    undef :foo, :bar, :baz
    ^^^^^^^^^^^^^^^^^^^^^^

### Attributes

names [R]

attr_reader names: Array[SymbolNode | InterpolatedSymbolNode]

### Public Class Methods

new (source, node_id, location, flags, names, keyword_loc)
Source

    # File lib/prism/node.rb, line 18698
    def initialize(source, node_id, location, flags, names, keyword_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @names = names
      @keyword_loc = keyword_loc
    end

Initialize a new `UndefNode` node.

type ()
Source

    # File lib/prism/node.rb, line 18779
    def self.type
      :undef_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 18785
    def ===(other)
      other.is_a?(UndefNode) &&
        (names.length == other.names.length) &&
        names.zip(other.names).all? { |left, right| left === right } &&
        (keyword_loc.nil? == other.keyword_loc.nil?)
    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 18708
    def accept(visitor)
      visitor.visit_undef_node(self)
    end

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 18713
    def child_nodes
      [*names]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 18730
    def comment_targets
      [*names, keyword_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 18725
    def compact_child_nodes
      [*names]
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, names: self.names, keyword_loc: self.keyword_loc)
Source

    # File lib/prism/node.rb, line 18735
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, names: self.names, keyword_loc: self.keyword_loc)
      UndefNode.new(source, node_id, location, flags, names, keyword_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?names: Array[SymbolNode | InterpolatedSymbolNode], ?keyword_loc: `Location`) -> `UndefNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 18743
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, names: names, keyword_loc: keyword_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, names: Array[SymbolNode | InterpolatedSymbolNode], `keyword_loc`: `Location` }

each_child_node () { |node| ... }
Source

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

      names.each { |node| yield node }
    end

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

inspect ()
Source

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

def inspect -> `String`

keyword ()
Source

    # File lib/prism/node.rb, line 18764
    def keyword
      keyword_loc.slice
    end

def keyword: () -> `String`

keyword_loc ()
Source

    # File lib/prism/node.rb, line 18751
    def keyword_loc
      location = @keyword_loc
      return location if location.is_a?(Location)
      @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    end

attr_reader `keyword_loc`: `Location`

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 18759
    def save_keyword_loc(repository)
      repository.enter(node_id, :keyword_loc)
    end

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

type ()
Source

    # File lib/prism/node.rb, line 18774
    def type
      :undef_node
    end

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