Class: Prism::BlockNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents a block of ruby code.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, locals, parameters, body, opening_loc, closing_loc) ⇒ BlockNode

Initialize a new BlockNode node.



1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
 
# File 'lib/prism/node.rb', line 1958

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

Instance Attribute Details

#body ⇒ Object (readonly)

The body of the block.

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



2034
2035
2036
 
# File 'lib/prism/node.rb', line 2034

def body
  @body
end

#locals ⇒ Object (readonly)

The local variables declared in the block.

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



2018
2019
2020
 
# File 'lib/prism/node.rb', line 2018

def locals
  @locals
end

#parameters ⇒ Object (readonly)

The parameters of the block.

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



2028
2029
2030
 
# File 'lib/prism/node.rb', line 2028

def parameters
  @parameters
end

Class Method Details

.type ⇒ Object

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



2089
2090
2091
 
# File 'lib/prism/node.rb', line 2089

def self.type
  :block_node
end

Instance Method Details

#===(other) ⇒ Object

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



2095
2096
2097
2098
2099
2100
2101
2102
2103
 
# File 'lib/prism/node.rb', line 2095

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) ⇒ Object

def accept: (Visitor visitor) -> void



1971
1972
1973
 
# File 'lib/prism/node.rb', line 1971

def accept(visitor)
  visitor.visit_block_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



1976
1977
1978
 
# File 'lib/prism/node.rb', line 1976

def child_nodes
  [parameters, body]
end

#closing ⇒ Object

def closing: () -> String



2074
2075
2076
 
# File 'lib/prism/node.rb', line 2074

def closing
  closing_loc.slice
end

#closing_loc ⇒ Object

Represents the location of the closing ‘}` or end.

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



2056
2057
2058
2059
2060
 
# File 'lib/prism/node.rb', line 2056

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 ⇒ Object

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



1997
1998
1999
 
# File 'lib/prism/node.rb', line 1997

def comment_targets
  [*parameters, *body, opening_loc, closing_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1989
1990
1991
1992
1993
1994
 
# File 'lib/prism/node.rb', line 1989

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) ⇒ Object

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



2002
2003
2004
 
# File 'lib/prism/node.rb', line 2002

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_keys(keys) ⇒ Object

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 }



2010
2011
2012
 
# File 'lib/prism/node.rb', line 2010

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

#each_child_node {|parameters| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



1981
1982
1983
1984
1985
1986
 
# File 'lib/prism/node.rb', line 1981

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield parameters if parameters
  yield body if body
end

#inspect ⇒ Object

def inspect -> String



2079
2080
2081
 
# File 'lib/prism/node.rb', line 2079

def inspect
  InspectVisitor.compose(self)
end

#opening ⇒ Object

def opening: () -> String



2069
2070
2071
 
# File 'lib/prism/node.rb', line 2069

def opening
  opening_loc.slice
end

#opening_loc ⇒ Object

Represents the location of the opening ‘{` or do.

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



2040
2041
2042
2043
2044
 
# File 'lib/prism/node.rb', line 2040

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) ⇒ Object

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



2064
2065
2066
 
# File 'lib/prism/node.rb', line 2064

def save_closing_loc(repository)
  repository.enter(node_id, :closing_loc)
end

#save_opening_loc(repository) ⇒ Object

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



2048
2049
2050
 
# File 'lib/prism/node.rb', line 2048

def save_opening_loc(repository)
  repository.enter(node_id, :opening_loc)
end

#type ⇒ Object

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



2084
2085
2086
 
# File 'lib/prism/node.rb', line 2084

def type
  :block_node
end