Class: Prism::BlockParameterNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a block parameter of a method, block, or lambda definition.

def a(&b)
      ^^
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, name, name_loc, operator_loc) ⇒ BlockParameterNode

Initialize a new BlockParameterNode node.



1990
1991
1992
1993
1994
1995
1996
1997
1998
 
# File 'lib/prism/node.rb', line 1990

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

Instance Attribute Details

#name ⇒ Object (readonly)

The name of the block parameter.

def a(&b) # name `:b`
       ^
end



2043
2044
2045
 
# File 'lib/prism/node.rb', line 2043

def name
  @name
end

Class Method Details

.type ⇒ Object

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



2100
2101
2102
 
# File 'lib/prism/node.rb', line 2100

def self.type
  :block_parameter_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.



2106
2107
2108
2109
2110
2111
2112
 
# File 'lib/prism/node.rb', line 2106

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



2001
2002
2003
 
# File 'lib/prism/node.rb', line 2001

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



2006
2007
2008
 
# File 'lib/prism/node.rb', line 2006

def child_nodes
  []
end

#comment_targets ⇒ Object

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



2016
2017
2018
 
# File 'lib/prism/node.rb', line 2016

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2011
2012
2013
 
# File 'lib/prism/node.rb', line 2011

def compact_child_nodes
  []
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) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol?, ?name_loc: Location?, ?operator_loc: Location) -> BlockParameterNode



2021
2022
2023
 
# File 'lib/prism/node.rb', line 2021

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)
  BlockParameterNode.new(source, node_id, location, flags, name, name_loc, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

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



2029
2030
2031
 
# File 'lib/prism/node.rb', line 2029

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

#inspect ⇒ Object

def inspect -> String



2090
2091
2092
 
# File 'lib/prism/node.rb', line 2090

def inspect
  InspectVisitor.compose(self)
end

#name_loc ⇒ Object

Represents the location of the block parameter name.

def a(&b)
       ^



2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
 
# File 'lib/prism/node.rb', line 2049

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

#operator ⇒ Object

def operator: () -> String



2085
2086
2087
 
# File 'lib/prism/node.rb', line 2085

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

Represents the location of the ‘&` operator.

def a(&b)
      ^
end



2072
2073
2074
2075
2076
 
# File 'lib/prism/node.rb', line 2072

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

#repeated_parameter? ⇒ Boolean

def repeated_parameter?: () -> bool

Returns:

  • (Boolean) 


2034
2035
2036
 
# File 'lib/prism/node.rb', line 2034

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

#save_name_loc(repository) ⇒ Object

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



2063
2064
2065
 
# File 'lib/prism/node.rb', line 2063

def save_name_loc(repository)
  repository.enter(node_id, :name_loc) unless @name_loc.nil?
end

#save_operator_loc(repository) ⇒ Object

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



2080
2081
2082
 
# File 'lib/prism/node.rb', line 2080

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#type ⇒ Object

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



2095
2096
2097
 
# File 'lib/prism/node.rb', line 2095

def type
  :block_parameter_node
end