class YARP::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

closing_loc[R]

attr_reader closing_loc: Location?

keyword_loc[R]

attr_reader keyword_loc: Location

predicate[R]

attr_reader predicate: Node

statements[R]

attr_reader statements: StatementsNode?

Public Class Methods

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

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

# File yarp/node.rb, line 10671
def initialize(keyword_loc, closing_loc, predicate, statements, flags, location)
  @keyword_loc = keyword_loc
  @closing_loc = closing_loc
  @predicate = predicate
  @statements = statements
  @flags = flags
  @location = location
end

Public Instance Methods

accept(visitor) click to toggle source

def accept: (visitor: Visitor) -> void

# File yarp/node.rb, line 10681
def accept(visitor)
  visitor.visit_while_node(self)
end

begin_modifier?() click to toggle source

def begin_modifier?: () -> bool

# File yarp/node.rb, line 10730
def begin_modifier?
  flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end

child_nodes() click to toggle source

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

# File yarp/node.rb, line 10690
def child_nodes
  [predicate, statements]
end

Also aliased as: deconstruct

closing() click to toggle source

def closing: () -> String?

# File yarp/node.rb, line 10725
def closing
  closing_loc&.slice
end

comment_targets() click to toggle source

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

# File yarp/node.rb, line 10695
def comment_targets
  [keyword_loc, *closing_loc, predicate, *statements]
end

copy(**params) click to toggle source

def copy: (**params) -> WhileNode

# File yarp/node.rb, line 10700
def copy(**params)
  WhileNode.new(
    params.fetch(:keyword_loc) { keyword_loc },
    params.fetch(:closing_loc) { closing_loc },
    params.fetch(:predicate) { predicate },
    params.fetch(:statements) { statements },
    params.fetch(:flags) { flags },
    params.fetch(:location) { location },
  )
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

inspect(inspector = NodeInspector.new) click to toggle source

# File yarp/node.rb, line 10734
def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "├── keyword_loc: #{inspector.location(keyword_loc)}\n"
  inspector << "├── closing_loc: #{inspector.location(closing_loc)}\n"
  inspector << "├── predicate:\n"
  inspector << inspector.child_node(predicate, "│   ")
  if (statements = self.statements).nil?
    inspector << "├── statements: ∅\n"
  else
    inspector << "├── statements:\n"
    inspector << statements.inspect(inspector.child_inspector("│   ")).delete_prefix(inspector.prefix)
  end
  flags = [("begin_modifier" if begin_modifier?)].compact
  inspector << "└── flags: #{flags.empty? ? "∅" : flags.join(", ")}\n"
  inspector.to_str
end

keyword() click to toggle source

def keyword: () -> String

# File yarp/node.rb, line 10720
def keyword
  keyword_loc.slice
end

set_newline_flag(newline_marked) click to toggle source

# File yarp/node.rb, line 10685
def set_newline_flag(newline_marked)
  predicate.set_newline_flag(newline_marked)
end