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

# class Prism::BlockNode

Represents a block of ruby code.

    [1, 2, 3].each { |i| puts x }
                   ^^^^^^^^^^^^^^

### Attributes

body[R]

The body of the block.

    [1, 2, 3].each { |i| puts x }
                         ^^^^^^

locals[R]

The local variables declared in the block.

    [1, 2, 3].each { |i| puts x } # locals: [:i]
                      ^

parameters[R]

The parameters of the block.

    [1, 2, 3].each { |i| puts x }
                     ^^^
    [1, 2, 3].each { puts _1 }
                   ^^^^^^^^^^^
    [1, 2, 3].each { puts it }
                   ^^^^^^^^^^^

### Public Class Methods

new(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc) click to toggle source

Initialize a new `BlockNode` node.

    # File prism/node.rb, line 1831
    def initialize(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @locals = locals
      @parameters = parameters
      @body = body
      @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 1954
    def self.type
      :block_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 1960
    def ===(other)
      other.is_a?(BlockNode) &&
        (locals.length == other.locals.length) &&
        locals.zip(other.locals).all? { |left, right| left === right } &&
        (parameters === other.parameters) &&
        (body === other.body) &&
        (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 1844
    def accept(visitor)
      visitor.visit_block_node(self)
    end

child_nodes() click to toggle source

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

    # File prism/node.rb, line 1849
    def child_nodes
      [parameters, body]
    end

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

def closing: () -> String

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

closing_loc() click to toggle source

Represents the location of the closing ‘|`.

    [1, 2, 3].each { |i| puts x }
                       ^

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

comment_targets() click to toggle source

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

    # File prism/node.rb, line 1862
    def comment_targets
      [*parameters, *body, 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 1854
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << parameters if parameters
      compact << body if body
      compact
    end

copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc) click to toggle source

def copy: (?node_id: Integer, ?location: `Location`, ?flags: Integer, ?locals: Array, ?parameters: `BlockParametersNode` | `NumberedParametersNode` | `ItParametersNode` | nil, ?body: `StatementsNode` | `BeginNode` | nil, ?opening_loc: `Location`, ?closing_loc: `Location`) -> `BlockNode`

    # File prism/node.rb, line 1867
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, locals: self.locals, parameters: self.parameters, body: self.body, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      BlockNode.new(source, node_id, location, flags, locals, parameters, body, 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`, locals: Array, parameters: `BlockParametersNode` | `NumberedParametersNode` | `ItParametersNode` | nil, body: `StatementsNode` | `BeginNode` | nil, `opening_loc`: `Location`, `closing_loc`: `Location` }

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

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String

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

opening_loc() click to toggle source

Represents the location of the opening ‘|`.

    [1, 2, 3].each { |i| puts x }
                     ^

    # File prism/node.rb, line 1905
    def opening_loc
      location = @opening_loc
      return location if location.is_a?(Location)
      @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
    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 1929
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc)
    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 1913
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc)
    end

type() click to toggle source

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

    # File prism/node.rb, line 1949
    def type
      :block_node
    end