123456789_123456789_123456789_123456789_123456789_

Class: Prism::YieldNode

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 yield keyword.

yield 1
^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #arguments readonly

    attr_reader arguments: ArgumentsNode?

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, keyword_loc, lparen_loc, arguments, rparen_loc) ⇒ YieldNode

Initialize a new YieldNode node.

[ GitHub ] 

  


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



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


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :yield_node
end


  







Instance Attribute Details



  

    #arguments   (readonly)
  



  

    
attr_reader arguments: ArgumentsNode?

  



  [ GitHub ]


  

  


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



attr_reader :arguments


  







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 16357



def ===(other)
  other.is_a?(YieldNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (lparen_loc.nil? == other.lparen_loc.nil?) &&
    (arguments === other.arguments) &&
    (rparen_loc.nil? == other.rparen_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [arguments]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



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


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << arguments if arguments
  compact
end


  








  

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



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?lparen_loc: Location?, ?arguments: ArgumentsNode?, ?rparen_loc: Location?) -> YieldNode

  



  [ GitHub ]


  

  


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



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


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, lparen_loc: Location?, arguments: ArgumentsNode?, rparen_loc: Location? }

  



  [ GitHub ]


  

  


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



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


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    
def keyword: () -> String

  



  [ GitHub ]


  

  


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



def keyword
  keyword_loc.slice
end


  








  

    #keyword_loc  
  



  

    
attr_reader keyword_loc: Location

  



  [ GitHub ]


  

  


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



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 16331



def lparen
  lparen_loc&.slice
end


  








  

    #lparen_loc  
  



  

    
attr_reader lparen_loc: Location?

  



  [ GitHub ]


  

  


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



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 16336



def rparen
  rparen_loc&.slice
end


  








  

    #rparen_loc  
  



  

    
attr_reader rparen_loc: Location?

  



  [ GitHub ]


  

  


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



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 16346



def type
  :yield_node
end