Class: Prism::UndefNode

Inherits:
PrismNode
  • Object
show all
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 collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new UndefNode node.



18706
18707
18708
18709
18710
18711
18712
18713
 
# File 'lib/prism/node.rb', line 18706

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]



18756
18757
18758
 
# File 'lib/prism/node.rb', line 18756

def names
  @names
end

Class Method Details

.type ⇒ Object

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



18787
18788
18789
 
# File 'lib/prism/node.rb', line 18787

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.



18793
18794
18795
18796
18797
18798
 
# File 'lib/prism/node.rb', line 18793

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



18716
18717
18718
 
# File 'lib/prism/node.rb', line 18716

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



18721
18722
18723
 
# File 'lib/prism/node.rb', line 18721

def child_nodes
  [*names]
end

#comment_targets ⇒ Object

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



18738
18739
18740
 
# File 'lib/prism/node.rb', line 18738

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



18733
18734
18735
 
# File 'lib/prism/node.rb', line 18733

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



18743
18744
18745
 
# File 'lib/prism/node.rb', line 18743

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 }



18751
18752
18753
 
# File 'lib/prism/node.rb', line 18751

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

#each_child_node ⇒ Object

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



18726
18727
18728
18729
18730
 
# File 'lib/prism/node.rb', line 18726

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  names.each { |node| yield node }
end

#inspect ⇒ Object

def inspect -> String



18777
18778
18779
 
# File 'lib/prism/node.rb', line 18777

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



18772
18773
18774
 
# File 'lib/prism/node.rb', line 18772

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



18759
18760
18761
18762
18763
 
# File 'lib/prism/node.rb', line 18759

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.



18767
18768
18769
 
# File 'lib/prism/node.rb', line 18767

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`.



18782
18783
18784
 
# File 'lib/prism/node.rb', line 18782

def type
  :undef_node
end