class Prism::BlockArgumentNode

Represents a block argument using ‘&`.

bar(&args)
^^^^^^^^^^

Attributes

expression[R]

The expression that is being passed as a block argument. This can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

foo(&args)
    ^^^^^

Public Class Methods

new(source, node_id, location, flags, expression, operator_loc) click to toggle source

Initialize a new BlockArgumentNode node.

# File prism/node.rb, line 1648
def initialize(source, node_id, location, flags, expression, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @expression = expression
  @operator_loc = operator_loc
end

type() click to toggle source

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

# File prism/node.rb, line 1730
def self.type
  :block_argument_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 1736
def ===(other)
  other.is_a?(BlockArgumentNode) &&
    (expression === other.expression) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

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

child_nodes() click to toggle source

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

# File prism/node.rb, line 1663
def child_nodes
  [expression]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File prism/node.rb, line 1675
def comment_targets
  [*expression, operator_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 1668
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << expression if expression
  compact
end

copy(node_id: self.node_id, location: self.location, flags: self.flags, expression: self.expression, operator_loc: self.operator_loc) click to toggle source

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?expression: Prism::node?, ?operator_loc: Location) -> BlockArgumentNode

# File prism/node.rb, line 1680
def copy(node_id: self.node_id, location: self.location, flags: self.flags, expression: self.expression, operator_loc: self.operator_loc)
  BlockArgumentNode.new(source, node_id, location, flags, expression, operator_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, expression: Prism::node?, operator_loc: Location }

# File prism/node.rb, line 1688
def deconstruct_keys(keys)
  { node_id: node_id, location: location, expression: expression, operator_loc: operator_loc }
end

inspect() click to toggle source

def inspect -> String

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

operator() click to toggle source

def operator: () -> String

# File prism/node.rb, line 1715
def operator
  operator_loc.slice
end

operator_loc() click to toggle source

Represents the location of the ‘&` operator.

foo(&args)
    ^

# File prism/node.rb, line 1702
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

save_operator_loc(repository) click to toggle source

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

# File prism/node.rb, line 1710
def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

type() click to toggle source

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

# File prism/node.rb, line 1725
def type
  :block_argument_node
end