Represents a block’s parameters declaration.
-> (a, b = 1; local) { }
^^^^^^^^^^^^^^^^^
foo do |a, b = 1; local|
^^^^^^^^^^^^^^^^^
end
attr_reader parameters: ParametersNode?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2011
def initialize(source, parameters, locals, opening_loc, closing_loc, location)
@source = source
@location = location
@parameters = parameters
@locals = locals
@opening_loc = opening_loc
@closing_loc = closing_loc
end
def initialize: (ParametersNode? parameters, Array locals, Location? opening_loc, Location? closing_loc, Location location) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2127
def self.type
:block_parameters_node
end
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
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2133
def ===(other)
other.is_a?(BlockParametersNode) &&
(parameters === other.parameters) &&
(locals.length == other.locals.length) &&
locals.zip(other.locals).all? { |left, right| left === right } &&
(opening_loc.nil? == other.opening_loc.nil?) &&
(closing_loc.nil? == other.closing_loc.nil?)
end
Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2021
def accept(visitor)
visitor.visit_block_parameters_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2026
def child_nodes
[parameters, *locals]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2094
def closing
closing_loc&.slice
end
def closing: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2076
def closing_loc
location = @closing_loc
case location
when nil
nil
when Location
location
else
@closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader closing_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2039
def comment_targets
[*parameters, *locals, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2031
def compact_child_nodes
compact = [] #: Array[Prism::node]
compact << parameters if parameters
compact.concat(locals)
compact
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2044
def copy(parameters: self.parameters, locals: self.locals, opening_loc: self.opening_loc, closing_loc: self.closing_loc, location: self.location)
BlockParametersNode.new(source, parameters, locals, opening_loc, closing_loc, location)
end
def copy: (?parameters: ParametersNode?, ?locals: Array, ?opening_loc: Location?, ?closing_loc: Location?, ?location: Location) -> BlockParametersNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2052
def deconstruct_keys(keys)
{ parameters: parameters, locals: locals, opening_loc: opening_loc, closing_loc: closing_loc, location: location }
end
def deconstruct_keys: (Array keys) -> { parameters: ParametersNode?, locals: Array, opening_loc: Location?, closing_loc: Location?, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2099
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2089
def opening
opening_loc&.slice
end
def opening: () -> String?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2063
def opening_loc
location = @opening_loc
case location
when nil
nil
when Location
location
else
@opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end
end
attr_reader opening_loc: Location?
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 2117
def type
:block_parameters_node
end
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