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

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, arguments, keyword_loc) ⇒ BreakNode

Initialize a new BreakNode node.



2424
2425
2426
2427
2428
2429
2430
2431
 
# File 'lib/prism/node.rb', line 2424

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

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
      ^^^



2479
2480
2481
 
# File 'lib/prism/node.rb', line 2479

def arguments
  @arguments
end

Class Method Details

.type ⇒ Object

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



2513
2514
2515
 
# File 'lib/prism/node.rb', line 2513

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



2519
2520
2521
2522
2523
 
# File 'lib/prism/node.rb', line 2519

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



2434
2435
2436
 
# File 'lib/prism/node.rb', line 2434

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



2439
2440
2441
 
# File 'lib/prism/node.rb', line 2439

def child_nodes
  [arguments]
end

#comment_targets ⇒ Object

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



2458
2459
2460
 
# File 'lib/prism/node.rb', line 2458

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



2451
2452
2453
2454
2455
 
# File 'lib/prism/node.rb', line 2451

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) ⇒ Object

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



2463
2464
2465
 
# File 'lib/prism/node.rb', line 2463

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_keys(keys) ⇒ Object

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



2471
2472
2473
 
# File 'lib/prism/node.rb', line 2471

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

#each_child_node {|arguments| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



2444
2445
2446
2447
2448
 
# File 'lib/prism/node.rb', line 2444

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield arguments if arguments
end

#inspect ⇒ Object

def inspect -> String



2503
2504
2505
 
# File 'lib/prism/node.rb', line 2503

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



2498
2499
2500
 
# File 'lib/prism/node.rb', line 2498

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

The location of the break keyword.

break foo
^^^^^



2485
2486
2487
2488
2489
 
# File 'lib/prism/node.rb', line 2485

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) ⇒ Object

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



2493
2494
2495
 
# File 'lib/prism/node.rb', line 2493

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

#type ⇒ Object

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



2508
2509
2510
 
# File 'lib/prism/node.rb', line 2508

def type
  :break_node
end