class Prism::BreakNode
Represents the use of the ‘break` keyword.
break foo ^^^^^^^^^
Attributes
attr_reader arguments: ArgumentsNode
?
Public Class Methods
def initialize: (ArgumentsNode
? arguments, Location
keyword_loc
, Location
location) -> void
# File lib/prism/node.rb, line 2091 def initialize(source, arguments, keyword_loc, location) @source = source @newline = false @location = location @arguments = arguments @keyword_loc = keyword_loc end
Similar to type
, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type
, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.
def self.type: () -> Symbol
# File lib/prism/node.rb, line 2187 def self.type :break_node end
Public Instance Methods
def accept: (Visitor
visitor) -> void
# File lib/prism/node.rb, line 2100 def accept(visitor) visitor.visit_break_node(self) end
def child_nodes
: () -> Array[nil | Node]
# File lib/prism/node.rb, line 2105 def child_nodes [arguments] end
def comment_targets
: () -> Array[Node | Location]
# File lib/prism/node.rb, line 2117 def comment_targets [*arguments, keyword_loc] #: Array[Prism::node | Location] end
def compact_child_nodes
: () -> Array
# File lib/prism/node.rb, line 2110 def compact_child_nodes compact = [] #: Array[Prism::node] compact << arguments if arguments compact end
def copy: (?arguments: ArgumentsNode
?, ?keyword_loc: Location
, ?location: Location
) -> BreakNode
# File lib/prism/node.rb, line 2122 def copy(arguments: self.arguments, keyword_loc: self.keyword_loc, location: self.location) BreakNode.new(source, arguments, keyword_loc, location) end
def deconstruct_keys
: (Array keys) -> { arguments: ArgumentsNode
?, keyword_loc
: Location
, location: Location
}
# File lib/prism/node.rb, line 2130 def deconstruct_keys(keys) { arguments: arguments, keyword_loc: keyword_loc, location: location } end
def inspect(NodeInspector inspector) -> String
# File lib/prism/node.rb, line 2151 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
def keyword: () -> String
# File lib/prism/node.rb, line 2146 def keyword keyword_loc.slice end
attr_reader keyword_loc
: Location
# File lib/prism/node.rb, line 2138 def keyword_loc location = @keyword_loc return location if location.is_a?(Location) @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
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
# File lib/prism/node.rb, line 2177 def type :break_node end