Class: Prism::UndefNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::UndefNode

Defined in:

lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘undef` keyword.

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

Instance Attribute Summary

• #names ⇒ Object readonly

  attr_reader names: Array[SymbolNode | InterpolatedSymbolNode].

Class Method Summary

• .type ⇒ Object

  Return a symbol representation of this node type.

Instance Method Summary

• #===(other) ⇒ Object

  Implements case-equality for the node.

• #accept(visitor) ⇒ Object

  def accept: (Visitor visitor) -> void.

• #child_nodes ⇒ Object (also: #deconstruct)

  def child_nodes: () -> Array.

• #comment_targets ⇒ Object

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

• #compact_child_nodes ⇒ Object

  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) ⇒ Object

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

• #deconstruct_keys(keys) ⇒ Object

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

• #initialize(source, node_id, location, flags, names, keyword_loc) ⇒ UndefNode constructor

  Initialize a new UndefNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #keyword ⇒ Object

  def keyword: () -> String.

• #keyword_loc ⇒ Object

  attr_reader keyword_loc: Location.

• #save_keyword_loc(repository) ⇒ Object

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

• #type ⇒ Object

  Return a symbol representation of this node type.

Constructor Details

#initialize(source, node_id, location, flags, names, keyword_loc) ⇒ UndefNode

Initialize a new UndefNode node.

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

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

Instance Attribute Details

#names ⇒ Object (readonly)

attr_reader names: Array[SymbolNode | InterpolatedSymbolNode]

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

def names
  @names
end

Class Method Details

.type ⇒ Object

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

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

def self.type
  :undef_node
end

Instance Method Details

#===(other) ⇒ Object

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 17728

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void

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

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array

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

def child_nodes
  [*names]
end

#comment_targets ⇒ Object

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

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

def comment_targets
  [*names, keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

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

def compact_child_nodes
  [*names]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, names: self.names, keyword_loc: self.keyword_loc) ⇒ Object

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

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

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

#deconstruct_keys(keys) ⇒ Object

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

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

def deconstruct_keys(keys)
  { node_id: node_id, location: location, names: names, keyword_loc: keyword_loc }
end

#inspect ⇒ Object

def inspect -> String

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

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String

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

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location

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

def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_keyword_loc(repository) ⇒ Object

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

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

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#type ⇒ Object

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

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

def type
  :undef_node
end