Class: Prism::BlockParameterNode

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

Overview

Represents a block parameter to 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(name, name_loc, operator_loc, location) ⇒ BlockParameterNode

def initialize: (name: Symbol?, name_loc: Location?, operator_loc: Location, location: Location) -> void



1644
1645
1646
1647
1648
1649
 
# File 'lib/prism/node.rb', line 1644

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

Instance Attribute Details

#name ⇒ Object (readonly)

attr_reader name: Symbol?



1635
1636
1637
 
# File 'lib/prism/node.rb', line 1635

def name
  @name
end

#name_loc ⇒ Object (readonly)

attr_reader name_loc: Location?



1638
1639
1640
 
# File 'lib/prism/node.rb', line 1638

def name_loc
  @name_loc
end

#operator_loc ⇒ Object (readonly)

attr_reader operator_loc: Location



1641
1642
1643
 
# File 'lib/prism/node.rb', line 1641

def operator_loc
  @operator_loc
end

Class Method Details

.type ⇒ Object

Similar to #type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like #type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol



1731
1732
1733
 
# File 'lib/prism/node.rb', line 1731

def self.type
  :block_parameter_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



1652
1653
1654
 
# File 'lib/prism/node.rb', line 1652

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

#child_nodes ⇒ Object Also known as: deconstruct

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



1657
1658
1659
 
# File 'lib/prism/node.rb', line 1657

def child_nodes
  []
end

#comment_targets ⇒ Object

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



1667
1668
1669
 
# File 'lib/prism/node.rb', line 1667

def comment_targets
  [*name_loc, operator_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1662
1663
1664
 
# File 'lib/prism/node.rb', line 1662

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> BlockParameterNode



1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/prism/node.rb', line 1672

def copy(**params)
  BlockParameterNode.new(
    params.fetch(:name) { name },
    params.fetch(:name_loc) { name_loc },
    params.fetch(:operator_loc) { operator_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



1685
1686
1687
 
# File 'lib/prism/node.rb', line 1685

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

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
 
# File 'lib/prism/node.rb', line 1695

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (name = self.name).nil?
    inspector << "├── name: ∅\n"
  else
    inspector << "├── name: #{name.inspect}\n"
  end
  inspector << "├── name_loc: #{inspector.location(name_loc)}\n"
  inspector << "└── operator_loc: #{inspector.location(operator_loc)}\n"
  inspector.to_str
end

#operator ⇒ Object

def operator: () -> String



1690
1691
1692
 
# File 'lib/prism/node.rb', line 1690

def operator
  operator_loc.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



1721
1722
1723
 
# File 'lib/prism/node.rb', line 1721

def type
  :block_parameter_node
end