class Prism::BreakNode

Represents the use of the ‘break` keyword.

break foo
^^^^^^^^^

Attributes

arguments[R]

The arguments to the break statement, if present. These can be any [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

break foo
      ^^^

Public Class Methods

new(source, node_id, location, flags, arguments, keyword_loc) click to toggle source

Initialize a new BreakNode node.

# File prism/node.rb, line 2275
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

type() click to toggle source

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

# File prism/node.rb, line 2357
def self.type
  :break_node
end

Public Instance Methods

===(other) click to toggle source

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

# File prism/node.rb, line 2363
def ===(other)
  other.is_a?(BreakNode) &&
    (arguments === other.arguments) &&
    (keyword_loc.nil? == other.keyword_loc.nil?)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 2285
def accept(visitor)
  visitor.visit_break_node(self)
end

child_nodes() click to toggle source

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

# File prism/node.rb, line 2290
def child_nodes
  [arguments]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File prism/node.rb, line 2302
def comment_targets
  [*arguments, keyword_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 2295
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) click to toggle source

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

# File prism/node.rb, line 2307
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()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

# File prism/node.rb, line 2315
def deconstruct_keys(keys)
  { node_id: node_id, location: location, arguments: arguments, keyword_loc: keyword_loc }
end

inspect() click to toggle source

def inspect -> String

# File prism/node.rb, line 2347
def inspect
  InspectVisitor.compose(self)
end

keyword() click to toggle source

def keyword: () -> String

# File prism/node.rb, line 2342
def keyword
  keyword_loc.slice
end

keyword_loc() click to toggle source

The location of the ‘break` keyword.

break foo
^^^^^

# File prism/node.rb, line 2329
def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

save_keyword_loc(repository) click to toggle source

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

# File prism/node.rb, line 2337
def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

type() click to toggle source

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

# File prism/node.rb, line 2352
def type
  :break_node
end