class Prism::WhileNode

Represents the use of the ‘while` keyword, either in the block form or the modifier form.

bar while foo
^^^^^^^^^^^^^

while foo do bar end
^^^^^^^^^^^^^^^^^^^^

Attributes

flags[R]

protected attr_reader flags: Integer

predicate[R]

attr_reader predicate: Prism::node

statements[R]

attr_reader statements: StatementsNode?

Public Class Methods

new(source, flags, keyword_loc, closing_loc, predicate, statements, location) click to toggle source

def initialize: (Integer flags, Location keyword_loc, Location? closing_loc, Prism::node predicate, StatementsNode? statements, Location location) -> void

# File lib/prism/node.rb, line 18703
def initialize(source, flags, keyword_loc, closing_loc, predicate, statements, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @closing_loc = closing_loc
  @predicate = predicate
  @statements = statements
end

type() click to toggle source

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 18828
def self.type
  :while_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 lib/prism/node.rb, line 18834
def ===(other)
  other.is_a?(WhileNode) &&
    (flags === other.flags) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (closing_loc.nil? == other.closing_loc.nil?) &&
    (predicate === other.predicate) &&
    (statements === other.statements)
end

accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 18715
def accept(visitor)
  visitor.visit_while_node(self)
end

begin_modifier?() click to toggle source

def begin_modifier?: () -> bool

# File lib/prism/node.rb, line 18785
def begin_modifier?
  flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 18724
def child_nodes
  [predicate, statements]
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

# File lib/prism/node.rb, line 18795
def closing
  closing_loc&.slice
end

closing_loc() click to toggle source

attr_reader closing_loc: Location?

# File lib/prism/node.rb, line 18766
def closing_loc
  location = @closing_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 18737
def comment_targets
  [keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 18729
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << predicate
  compact << statements if statements
  compact
end

copy(flags: self.flags, keyword_loc: self.keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements, location: self.location) click to toggle source

def copy: (?flags: Integer, ?keyword_loc: Location, ?closing_loc: Location?, ?predicate: Prism::node, ?statements: StatementsNode?, ?location: Location) -> WhileNode

# File lib/prism/node.rb, line 18742
def copy(flags: self.flags, keyword_loc: self.keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements, location: self.location)
  WhileNode.new(source, flags, keyword_loc, closing_loc, predicate, statements, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

def deconstruct_keys: (Array keys) -> { flags: Integer, keyword_loc: Location, closing_loc: Location?, predicate: Prism::node, statements: StatementsNode?, location: Location }

# File lib/prism/node.rb, line 18750
def deconstruct_keys(keys)
  { flags: flags, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements, location: location }
end

inspect() click to toggle source

def inspect -> String

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

keyword() click to toggle source

def keyword: () -> String

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

keyword_loc() click to toggle source

attr_reader keyword_loc: Location

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

type() click to toggle source

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 18818
def type
  :while_node
end