123456789_123456789_123456789_123456789_123456789_

Class: Prism::OptionalParameterNode

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

Overview

Represents an optional parameter to a method, block, or lambda definition.

def a(b = 1)
      ^^^^^
end

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, name, name_loc, operator_loc, value) ⇒ OptionalParameterNode

Initialize a new OptionalParameterNode node.

[ GitHub ] 

  


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



def initialize(source, node_id, location, flags, name, name_loc, operator_loc, value)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
  @value = value
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


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



def self.type
  :optional_parameter_node
end


  







Instance Attribute Details



  

    #name   (readonly)
  



  

    
attr_reader name: Symbol

  



  [ GitHub ]


  

  


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



attr_reader :name


  








  

    #repeated_parameter?  ⇒ Boolean  (readonly)
  



  

    
def repeated_parameter?: () -> bool

  





  


  [ GitHub ]


  

  


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



def repeated_parameter?
  flags.anybits?(ParameterFlags::REPEATED_PARAMETER)
end


  








  

    #value   (readonly)
  



  

    
attr_reader value: Prism.node

  



  [ GitHub ]


  

  


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



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 12383



def ===(other)
  other.is_a?(OptionalParameterNode) &&
    (flags === other.flags) &&
    (name === other.name) &&
    (name_loc.nil? == other.name_loc.nil?) &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (value === other.value)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


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



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


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



def child_nodes
  [value]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


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



def comment_targets
  [name_loc, operator_loc, value] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


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



def compact_child_nodes
  [value]
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, operator_loc: self.operator_loc, value: self.value)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol, ?name_loc: Location, ?operator_loc: Location, ?value: Prism.node) -> OptionalParameterNode

  



  [ GitHub ]


  

  


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



def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, operator_loc: self.operator_loc, value: self.value)
  OptionalParameterNode.new(source, node_id, location, flags, name, name_loc, operator_loc, value)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


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



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, name: Symbol, name_loc: Location, operator_loc: Location, value: Prism.node }

  



  [ GitHub ]


  

  


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



def deconstruct_keys(keys)
  { node_id: node_id, location: location, name: name, name_loc: name_loc, operator_loc: operator_loc, value: value }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


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



def inspect
  InspectVisitor.compose(self)
end


  








  

    #name_loc  
  



  

    
attr_reader name_loc: Location

  



  [ GitHub ]


  

  


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



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


  








  

    #operator  
  



  

    
def operator: () -> String

  



  [ GitHub ]


  

  


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



def operator
  operator_loc.slice
end


  








  

    #operator_loc  
  



  

    
attr_reader operator_loc: Location

  



  [ GitHub ]


  

  


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



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


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


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



def type
  :optional_parameter_node
end