Class: Prism::BreakNode

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

Overview

Represents the use of the ‘break` keyword.

break foo
^^^^^^^^^

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(arguments, keyword_loc, location) ⇒ BreakNode

def initialize: (arguments: ArgumentsNode?, keyword_loc: Location, location: Location) -> void



1651
1652
1653
1654
1655
 
# File 'lib/prism/node.rb', line 1651

def initialize(arguments, keyword_loc, location)
  @arguments = arguments
  @keyword_loc = keyword_loc
  @location = location
end

Instance Attribute Details

#arguments ⇒ Object (readonly)

attr_reader arguments: ArgumentsNode?



1645
1646
1647
 
# File 'lib/prism/node.rb', line 1645

def arguments
  @arguments
end

#keyword_loc ⇒ Object (readonly)

attr_reader keyword_loc: Location



1648
1649
1650
 
# File 'lib/prism/node.rb', line 1648

def keyword_loc
  @keyword_loc
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



1658
1659
1660
 
# File 'lib/prism/node.rb', line 1658

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

#child_nodes ⇒ Object Also known as: deconstruct

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



1663
1664
1665
 
# File 'lib/prism/node.rb', line 1663

def child_nodes
  [arguments]
end

#comment_targets ⇒ Object

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



1675
1676
1677
 
# File 'lib/prism/node.rb', line 1675

def comment_targets
  [*arguments, keyword_loc]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



1668
1669
1670
1671
1672
 
# File 'lib/prism/node.rb', line 1668

def compact_child_nodes
  compact = []
  compact << arguments if arguments
  compact
end

#copy(**params) ⇒ Object

def copy: (**params) -> BreakNode



1680
1681
1682
1683
1684
1685
1686
 
# File 'lib/prism/node.rb', line 1680

def copy(**params)
  BreakNode.new(
    params.fetch(:arguments) { arguments },
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



1692
1693
1694
 
# File 'lib/prism/node.rb', line 1692

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

#inspect(inspector = NodeInspector.new) ⇒ Object 



1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'lib/prism/node.rb', line 1701

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  if (arguments = self.arguments).nil?
    inspector << "├── arguments: ∅\n"
  else
    inspector << "├── arguments:\n"
    inspector << arguments.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  inspector << "└── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector.to_str
end

#keyword ⇒ Object

def keyword: () -> String



1697
1698
1699
 
# File 'lib/prism/node.rb', line 1697

def keyword
  keyword_loc.slice
end

#type ⇒ Object

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call #type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol



1727
1728
1729
 
# File 'lib/prism/node.rb', line 1727

def type
  :break_node
end