class Prism::BlockParametersNode - Documentation for Ruby 4.1
Description: class Prism::BlockParametersNode: Represents a block's parameters declaration.
Keywords: ruby,class,Prism::BlockParametersNode

🔍

No recent searches

# class Prism::BlockParametersNode

Represents a block’s parameters declaration.

    -> (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 3429
    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.

### Public Instance Methods

locals → Array[BlockLocalVariableNode]
Source

    # File lib/prism/node.rb, line 3561
    def locals
      @locals
    end

Represents the local variables of the block.

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

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

parameters → ParametersNode | nil
Source

    # File lib/prism/node.rb, line 3544
    def parameters
      @parameters
    end

Represents the parameters of the block.

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

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

## Locations

### Public Instance Methods

closing_loc → Location | nil
Source

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

opening_loc → Location | nil
Source

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

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

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

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → BlockParametersNode
Source

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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |parameters| ... }
Source

    # File lib/prism/node.rb, line 3469
    def each_child_node(&blk)
      return to_enum(:each_child_node) unless block_given?

      if (parameters = self.parameters); yield parameters; end
      locals.each { |node| yield node }
    end

See `Node.each_child_node`.

type ()
Source

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

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_closing_loc (repository)
Source

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

## Slicing

### Public Instance Methods

closing → String | nil
Source

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

Slice the location of `closing_loc` from the source.

opening → String | nil
Source

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

Slice the location of `opening_loc` from the source.