class Prism::BlockParametersNode - prism: Ruby Standard Library Documentation

# 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) click to toggle source

Initialize a new `BlockParametersNode` node.

    # File 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

type() click to toggle source

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

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

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File 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

accept(visitor) click to toggle source

def accept: (`Visitor` visitor) -> void

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

Represents the closing location of the block parameters.

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

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

    # File 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

comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

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) click to toggle source

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

    # File 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

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

    # File 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

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

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

opening_loc() click to toggle source

Represents the opening location of the block parameters.

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

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

    # File 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

save_closing_loc(repository) click to toggle source

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

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

save_opening_loc(repository) click to toggle source

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

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

type() click to toggle source

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

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