123456789_123456789_123456789_123456789_123456789_

Class: Prism::BreakNode

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, PrismNode
Instance Chain:
self, PrismNode
Inherits: PrismNode
Defined in: lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the break keyword.

break foo
^^^^^^^^^

Class Method Summary

Instance Attribute Summary

  • #arguments readonly

    The arguments to the break statement, if present.

Instance Method Summary

Constructor Details

.new(source, node_id, location, flags, arguments, keyword_loc) ⇒ BreakNode

Initialize a new BreakNode node.

[ GitHub ] 

  


# File 'lib/prism/node.rb', line 1894



def initialize(source, node_id, location, flags, arguments, keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @arguments = arguments
  @keyword_loc = keyword_loc
end


  







Class Method Details



  

    .type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1969



def self.type
  :break_node
end


  







Instance Attribute Details



  

    #arguments   (readonly)
  



  

    
The arguments to the break statement, if present. These can be anynon-void expressions.


break foo
      ^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1942



attr_reader :arguments


  







Instance Method Details



  

    #===(other)  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1975



def ===(other)
  other.is_a?(BreakNode) &&
    (arguments === other.arguments) &&
    (keyword_loc.nil? == other.keyword_loc.nil?)
end


  








  

    #accept(visitor)  
  



  

    
def accept: (Visitor visitor) -> void

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1904



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


  








  

    #child_nodes  
    Also known as: #deconstruct
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1909



def child_nodes
  [arguments]
end


  








  

    #comment_targets  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1921



def comment_targets
  [*arguments, keyword_loc] #: Array[Prism::node | Location]
end


  








  

    #compact_child_nodes  
  



  

    
def compact_child_nodes: () -> Array

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1914



def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << arguments if arguments
  compact
end


  








  

    #copy(node_id: self.node_id, location: self.location, flags: self.flags, arguments: self.arguments, keyword_loc: self.keyword_loc)  
  



  

    
def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?arguments: ArgumentsNode?, ?keyword_loc: Location) -> BreakNode

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1926



def copy(node_id: self.node_id, location: self.location, flags: self.flags, arguments: self.arguments, keyword_loc: self.keyword_loc)
  BreakNode.new(source, node_id, location, flags, arguments, keyword_loc)
end


  








  

    #deconstruct  
  



  

    
Alias for #child_nodes.

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1931



alias deconstruct child_nodes


  








  

    #deconstruct_keys(keys)  
  



  

    
def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, arguments: ArgumentsNode?, keyword_loc: Location }

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1934



def deconstruct_keys(keys)
  { node_id: node_id, location: location, arguments: arguments, keyword_loc: keyword_loc }
end


  








  

    #inspect  
  



  

    
def inspect -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1959



def inspect
  InspectVisitor.compose(self)
end


  








  

    #keyword  
  



  

    
def keyword: () -> String

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1954



def keyword
  keyword_loc.slice
end


  








  

    #keyword_loc  
  



  

    
The location of the break keyword.


break foo
^^^^^

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1947



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


  








  

    #type  
  



  

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

  



  [ GitHub ]


  

  


# File 'lib/prism/node.rb', line 1964



def type
  :break_node
end