class Prism::BlockParametersNode

Represents a block’s parameters declaration.

-> (a, b = 1; local) { }
   ^^^^^^^^^^^^^^^^^

foo do |a, b = 1; local|
       ^^^^^^^^^^^^^^^^^
end

Attributes

locals [R]

Represents the local variables of the block.

-> (a, b = 1; local) { }
              ^^^^^

foo do |a, b = 1; local|
                  ^^^^^
end

parameters [R]

Represents the parameters of the block.

-> (a, b = 1; local) { }
    ^^^^^^^^

foo do |a, b = 1; local|
        ^^^^^^^^
end

Public Class Methods

new (source, node_id, location, flags, parameters, locals, opening_loc, closing_loc)

Source

# File lib/prism/node.rb, line 2113
def initialize(source, node_id, location, flags, parameters, locals, opening_loc, closing_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @parameters = parameters
  @locals = locals
  @opening_loc = opening_loc
  @closing_loc = closing_loc
end

Initialize a new BlockParametersNode node.

type ()

Source

# File lib/prism/node.rb, line 2253
def self.type
  :block_parameters_node
end

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

Public Instance Methods

=== (other)

Source

# File lib/prism/node.rb, line 2259
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.

accept (visitor)

Source

# File lib/prism/node.rb, line 2125
def accept(visitor)
  visitor.visit_block_parameters_node(self)
end

def accept: (Visitor visitor) -> void

child_nodes ()

Source

# File lib/prism/node.rb, line 2130
def child_nodes
  [parameters, *locals]
end

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

Also aliased as: deconstruct

closing ()

Source

# File lib/prism/node.rb, line 2238
def closing
  closing_loc&.slice
end

def closing: () -> String?

closing_loc ()

Source

# File lib/prism/node.rb, line 2214
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

Represents the closing location of the block parameters.

-> (a, b = 1; local) { }
                   ^

foo do |a, b = 1; local|
                       ^
end

comment_targets ()

Source

# File lib/prism/node.rb, line 2143
def comment_targets
  [*parameters, *locals, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
end

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

compact_child_nodes ()

Source

# File lib/prism/node.rb, line 2135
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << parameters if parameters
  compact.concat(locals)
  compact
end

def compact_child_nodes: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, parameters: self.parameters, locals: self.locals, opening_loc: self.opening_loc, closing_loc: self.closing_loc)

Source

# File lib/prism/node.rb, line 2148
def copy(node_id: self.node_id, location: self.location, flags: self.flags, parameters: self.parameters, locals: self.locals, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
  BlockParametersNode.new(source, node_id, location, flags, parameters, locals, opening_loc, closing_loc)
end

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?parameters: ParametersNode?, ?locals: Array, ?opening_loc: Location?, ?closing_loc: Location?) -> BlockParametersNode

deconstruct ()

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

Alias for: child_nodes

deconstruct_keys (keys)

Source

# File lib/prism/node.rb, line 2156
def deconstruct_keys(keys)
  { node_id: node_id, location: location, parameters: parameters, locals: locals, opening_loc: opening_loc, closing_loc: closing_loc }
end

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, parameters: ParametersNode?, locals: Array, opening_loc: Location?, closing_loc: Location? }

inspect ()

Source

# File lib/prism/node.rb, line 2243
def inspect
  InspectVisitor.compose(self)
end

def inspect -> String

opening ()

Source

# File lib/prism/node.rb, line 2233
def opening
  opening_loc&.slice
end

def opening: () -> String?

opening_loc ()

Source

# File lib/prism/node.rb, line 2188
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

Represents the opening location of the block parameters.

-> (a, b = 1; local) { }
   ^

foo do |a, b = 1; local|
       ^
end

save_closing_loc (repository)

Source

# File lib/prism/node.rb, line 2228
def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
end

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

save_opening_loc (repository)

Source

# File lib/prism/node.rb, line 2202
def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
end

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

type ()

Source

# File lib/prism/node.rb, line 2248
def type
  :block_parameters_node
end

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