Class: Prism::BreakNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::BreakNode

Defined in:

lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘break` keyword.

break foo
^^^^^^^^^

Instance Attribute Summary

• #arguments ⇒ Object readonly

  The arguments to the break statement, if present.

Class Method Summary

• .type ⇒ Object

  Return a symbol representation of this node type.

Instance Method Summary

• #===(other) ⇒ Object

  Implements case-equality for the node.

• #accept(visitor) ⇒ Object

  def accept: (Visitor visitor) -> void.

• #child_nodes ⇒ Object (also: #deconstruct)

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

• #comment_targets ⇒ Object

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

• #compact_child_nodes ⇒ Object

  def compact_child_nodes: () -> Array.

• #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.

• #deconstruct_keys(keys) ⇒ Object

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

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

  Initialize a new BreakNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #keyword ⇒ Object

  def keyword: () -> String.

• #keyword_loc ⇒ Object

  The location of the ‘break` keyword.

• #type ⇒ Object

  Return a symbol representation of this node type.

Constructor Details

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

Initialize a new BreakNode node.

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

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

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

def arguments
  @arguments
end

Class Method Details

.type ⇒ Object

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

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

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.

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

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

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

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

#child_nodes ⇒ Object Also known as: deconstruct

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

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

def child_nodes
  [arguments]
end

#comment_targets ⇒ Object

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

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

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

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

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

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

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 }

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

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

#inspect ⇒ Object

def inspect -> String

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

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String

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

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

The location of the ‘break` keyword.

break foo
^^^^^

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

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

#type ⇒ Object

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

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

def type
  :break_node
end