Class: Prism::RescueNode

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

Overview

Represents a rescue statement.

begin
rescue Foo, *splat, Bar => ex
  foo
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
end

‘Foo, *splat, Bar` are in the `exceptions` field. `ex` is in the `reference` field.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, keyword_loc, exceptions, operator_loc, reference, then_keyword_loc, statements, subsequent) ⇒ RescueNode

Initialize a new RescueNode node.



15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
 
# File 'lib/prism/node.rb', line 15718

def initialize(source, node_id, location, flags, keyword_loc, exceptions, operator_loc, reference, then_keyword_loc, statements, subsequent)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @exceptions = exceptions
  @operator_loc = operator_loc
  @reference = reference
  @then_keyword_loc = then_keyword_loc
  @statements = statements
  @subsequent = subsequent
end

Instance Attribute Details

#exceptions ⇒ Object (readonly)

attr_reader exceptions: Array



15784
15785
15786
 
# File 'lib/prism/node.rb', line 15784

def exceptions
  @exceptions
end

#reference ⇒ Object (readonly)

attr_reader reference: LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | BackReferenceReadNode | NumberedReferenceReadNode | MissingNode | nil



15806
15807
15808
 
# File 'lib/prism/node.rb', line 15806

def reference
  @reference
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



15828
15829
15830
 
# File 'lib/prism/node.rb', line 15828

def statements
  @statements
end

#subsequent ⇒ Object (readonly)

attr_reader subsequent: RescueNode?



15831
15832
15833
 
# File 'lib/prism/node.rb', line 15831

def subsequent
  @subsequent
end

Class Method Details

.type ⇒ Object

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



15859
15860
15861
 
# File 'lib/prism/node.rb', line 15859

def self.type
  :rescue_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.



15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
 
# File 'lib/prism/node.rb', line 15865

def ===(other)
  other.is_a?(RescueNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (exceptions.length == other.exceptions.length) &&
    exceptions.zip(other.exceptions).all? { |left, right| left === right } &&
    (operator_loc.nil? == other.operator_loc.nil?) &&
    (reference === other.reference) &&
    (then_keyword_loc.nil? == other.then_keyword_loc.nil?) &&
    (statements === other.statements) &&
    (subsequent === other.subsequent)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



15733
15734
15735
 
# File 'lib/prism/node.rb', line 15733

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

#child_nodes ⇒ Object Also known as: deconstruct

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



15738
15739
15740
 
# File 'lib/prism/node.rb', line 15738

def child_nodes
  [*exceptions, reference, statements, subsequent]
end

#comment_targets ⇒ Object

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



15753
15754
15755
 
# File 'lib/prism/node.rb', line 15753

def comment_targets
  [keyword_loc, *exceptions, *operator_loc, *reference, *then_keyword_loc, *statements, *subsequent] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15743
15744
15745
15746
15747
15748
15749
15750
 
# File 'lib/prism/node.rb', line 15743

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact.concat(exceptions)
  compact << reference if reference
  compact << statements if statements
  compact << subsequent if subsequent
  compact
end

#consequent ⇒ Object

Returns the subsequent rescue clause of the rescue node. This method is deprecated in favor of #subsequent.



494
495
496
497
 
# File 'lib/prism/node_ext.rb', line 494

def consequent
  deprecated("subsequent")
  subsequent
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, exceptions: self.exceptions, operator_loc: self.operator_loc, reference: self.reference, then_keyword_loc: self.then_keyword_loc, statements: self.statements, subsequent: self.subsequent) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?exceptions: Array, ?operator_loc: Location?, ?reference: LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | BackReferenceReadNode | NumberedReferenceReadNode | MissingNode | nil, ?then_keyword_loc: Location?, ?statements: StatementsNode?, ?subsequent: RescueNode?) -> RescueNode



15758
15759
15760
 
# File 'lib/prism/node.rb', line 15758

def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, exceptions: self.exceptions, operator_loc: self.operator_loc, reference: self.reference, then_keyword_loc: self.then_keyword_loc, statements: self.statements, subsequent: self.subsequent)
  RescueNode.new(source, node_id, location, flags, keyword_loc, exceptions, operator_loc, reference, then_keyword_loc, statements, subsequent)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, exceptions: Array, operator_loc: Location?, reference: LocalVariableTargetNode | InstanceVariableTargetNode | ClassVariableTargetNode | GlobalVariableTargetNode | ConstantTargetNode | ConstantPathTargetNode | CallTargetNode | IndexTargetNode | BackReferenceReadNode | NumberedReferenceReadNode | MissingNode | nil, then_keyword_loc: Location?, statements: StatementsNode?, subsequent: RescueNode? }



15766
15767
15768
 
# File 'lib/prism/node.rb', line 15766

def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, exceptions: exceptions, operator_loc: operator_loc, reference: reference, then_keyword_loc: then_keyword_loc, statements: statements, subsequent: subsequent }
end

#inspect ⇒ Object

def inspect -> String



15849
15850
15851
 
# File 'lib/prism/node.rb', line 15849

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



15834
15835
15836
 
# File 'lib/prism/node.rb', line 15834

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



15771
15772
15773
15774
15775
 
# File 'lib/prism/node.rb', line 15771

def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#operator ⇒ Object

def operator: () -> String?



15839
15840
15841
 
# File 'lib/prism/node.rb', line 15839

def operator
  operator_loc&.slice
end

#operator_loc ⇒ Object

attr_reader operator_loc: Location?



15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
 
# File 'lib/prism/node.rb', line 15787

def operator_loc
  location = @operator_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#save_keyword_loc(repository) ⇒ Object

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



15779
15780
15781
 
# File 'lib/prism/node.rb', line 15779

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#save_operator_loc(repository) ⇒ Object

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



15801
15802
15803
 
# File 'lib/prism/node.rb', line 15801

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc) unless @operator_loc.nil?
end

#save_then_keyword_loc(repository) ⇒ Object

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



15823
15824
15825
 
# File 'lib/prism/node.rb', line 15823

def save_then_keyword_loc(repository)
  repository.enter(node_id, :then_keyword_loc) unless @then_keyword_loc.nil?
end

#then_keyword ⇒ Object

def then_keyword: () -> String?



15844
15845
15846
 
# File 'lib/prism/node.rb', line 15844

def then_keyword
  then_keyword_loc&.slice
end

#then_keyword_loc ⇒ Object

attr_reader then_keyword_loc: Location?



15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
 
# File 'lib/prism/node.rb', line 15809

def then_keyword_loc
  location = @then_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @then_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#type ⇒ Object

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



15854
15855
15856
 
# File 'lib/prism/node.rb', line 15854

def type
  :rescue_node
end