123456789_123456789_123456789_123456789_123456789_

Class: Prism::DefinedNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the defined? keyword.

defined?(a)
^^^^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #value readonly

    attr_reader value: Prism.node

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc) ⇒ DefinedNode

Initialize a new DefinedNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @lparen_loc = lparen_loc
  @value = value
  @rparen_loc = rparen_loc
  @keyword_loc = keyword_loc
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :defined_node
end


  







Instance Attribute Details



  

    #value   (readonly)
  



  

    
attr_reader value: Prism.node

  



  [ GitHub ]


  

  


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



attr_reader :value


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


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



def ===(other)
  other.is_a?(DefinedNode) &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (value === other.value) &&
    (rparen_loc.nil? == other.rparen_loc.nil?) &&
    (keyword_loc.nil? == other.keyword_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [value]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [*lparen_loc, value, *rparen_loc, keyword_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  [value]
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?lparen_loc: Location?, ?value: Prism.node, ?rparen_loc: Location?, ?keyword_loc: Location) -> DefinedNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc)
  DefinedNode.new(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, lparen_loc: Location?, value: Prism.node, rparen_loc: Location?, keyword_loc: Location }

  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { node_id: node_id, location: location, lparen_loc: lparen_loc, value: value, rparen_loc: rparen_loc, keyword_loc: keyword_loc }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    
def keyword: () -> String

  



  [ GitHub ]


  

  


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



def keyword
  keyword_loc.slice
end


  








  

    #keyword_loc  
  



  

    
attr_reader keyword_loc: Location

  



  [ GitHub ]


  

  


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



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


  








  

    #lparen  
  



  

    
def lparen: () -> String?

  



  [ GitHub ]


  

  


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



def lparen
  lparen_loc&.slice
end


  








  

    #lparen_loc  
  



  

    
attr_reader lparen_loc: Location?

  



  [ GitHub ]


  

  


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



def lparen_loc
  location = @lparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @lparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end


  








  

    #rparen  
  



  

    
def rparen: () -> String?

  



  [ GitHub ]


  

  


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



def rparen
  rparen_loc&.slice
end


  








  

    #rparen_loc  
  



  

    
attr_reader rparen_loc: Location?

  



  [ GitHub ]


  

  


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



def rparen_loc
  location = @rparen_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @rparen_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :defined_node
end