class Prism::BlockParameterNode

Represents a block parameter of a method, block, or lambda definition.

def a(&b)
      ^^
end

Public Class Methods

new (source, node_id, location, flags, name, name_loc, operator_loc)

(Source source, Integer node_id, Location location, Integer flags, Symbol? name, Location? name_loc, Location operator_loc) → void

Source

# File lib/prism/node.rb, line 3214
def initialize(source, node_id, location, flags, name, name_loc, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @name = name
  @name_loc = name_loc
  @operator_loc = operator_loc
end

Initialize a new BlockParameterNode node.

Public Instance Methods

name → Symbol | nil

() → Symbol?

Source

# File lib/prism/node.rb, line 3328
def name
  @name
end

The name of the block parameter.

def a(&b) # name `:b`
       ^
end

Flags

Public Instance Methods

repeated_parameter? ()

() → bool

Source

# File lib/prism/node.rb, line 3314
def repeated_parameter?
  flags.anybits?(ParameterFlags::REPEATED_PARAMETER)
end

a parameter name that has been repeated in the method signature

Locations

Public Instance Methods

name_loc → Location | nil

() → Location?

Source

# File lib/prism/node.rb, line 3342
def name_loc
  location = @name_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @name_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

Represents the Location of the block parameter name.

def a(&b)
       ^

operator_loc → Location

() → Location

Source

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

Represents the Location of the & operator.

def a(&b)
      ^
end

Node Interface

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

Public Class Methods

type ()

() → :block_parameter_node

Source

# File lib/prism/node.rb, line 3299
def self.type
  :block_parameter_node
end

See Node.type.

Public Instance Methods

accept (visitor)

(_Visitor visitor) → untyped

Source

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

See Node.accept.

child_nodes ()

() → Array[node?]

Source

# File lib/prism/node.rb, line 3245
def child_nodes
  []
end

See Node.child_nodes.

Also aliased as: deconstruct

comment_targets ()

() → Array[node | Location]

Source

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

See Node.comment_targets.

compact_child_nodes ()

() → Array[node]

Source

# File lib/prism/node.rb, line 3261
def compact_child_nodes
  []
end

See Node.compact_child_nodes.

copy(**fields) → BlockParameterNode

(?node_id: Integer, ?location: Location, ?flags: Integer, ?name: Symbol?, ?name_loc: Location?, ?operator_loc: Location) → BlockParameterNode

Source

# File lib/prism/node.rb, line 3278
def copy(node_id: self.node_id, location: self.location, flags: self.flags, name: self.name, name_loc: self.name_loc, operator_loc: self.operator_loc)
  BlockParameterNode.new(source, node_id, location, flags, name, name_loc, operator_loc)
end

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

deconstruct ()

() → Array[node?]

Alias for: child_nodes

each_child_node (&blk)

() → Enumerator[node, void]
() { (node) → void } → void

Source

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

end

See Node.each_child_node.

type ()

() → :block_parameter_node

Source

# File lib/prism/node.rb, line 3292
def type
  :block_parameter_node
end

See Node#type.

Repository

Methods related to Relocation.

Public Instance Methods

save_name_loc (repository)

(_Repository repository) → Relocation::Entry?

Source

# File lib/prism/node.rb, line 3359
def save_name_loc(repository)
  repository.enter(node_id, :name_loc) unless @name_loc.nil?
end

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

save_operator_loc (repository)

(_Repository repository) → Relocation::Entry

Source

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

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

Slicing

Public Instance Methods

operator → String

() → String

Source

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

Slice the location of operator_loc from the source.