class Prism::WhileNode - prism: Ruby Standard Library Documentation

# 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

predicate[R]

attr_reader predicate: Prism::node

statements[R]

attr_reader statements: `StatementsNode`?

### Public Class Methods

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

Initialize a new `WhileNode` node.

    # File prism/node.rb, line 17982
    def initialize(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @keyword_loc = keyword_loc
      @do_keyword_loc = do_keyword_loc
      @closing_loc = closing_loc
      @predicate = predicate
      @statements = statements
    end

type() click to toggle source

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

    # File prism/node.rb, line 18118
    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 prism/node.rb, line 18124
    def ===(other)
      other.is_a?(WhileNode) &&
        (flags === other.flags) &&
        (keyword_loc.nil? == other.keyword_loc.nil?) &&
        (do_keyword_loc.nil? == other.do_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 prism/node.rb, line 17995
    def accept(visitor)
      visitor.visit_while_node(self)
    end

begin_modifier?() click to toggle source

def begin_modifier?: () -> bool

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

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String?

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

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`?

    # File prism/node.rb, line 18068
    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 prism/node.rb, line 18013
    def comment_targets
      [keyword_loc, *do_keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

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

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

    # File prism/node.rb, line 18018
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, do_keyword_loc: self.do_keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements)
      WhileNode.new(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements)
    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`, `keyword_loc`: `Location`, `do_keyword_loc`: `Location`?, `closing_loc`: `Location`?, predicate: Prism::node, statements: `StatementsNode`? }

    # File prism/node.rb, line 18026
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, keyword_loc: keyword_loc, do_keyword_loc: do_keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements }
    end

do_keyword() click to toggle source

def `do_keyword`: () -> String?

    # File prism/node.rb, line 18098
    def do_keyword
      do_keyword_loc&.slice
    end

do_keyword_loc() click to toggle source

attr_reader `do_keyword_loc`: `Location`?

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

inspect() click to toggle source

def inspect -> String

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

keyword() click to toggle source

def keyword: () -> String

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

keyword_loc() click to toggle source

attr_reader `keyword_loc`: `Location`

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

save_closing_loc(repository) click to toggle source

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

    # File prism/node.rb, line 18082
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

save_do_keyword_loc(repository) click to toggle source

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

    # File prism/node.rb, line 18063
    def save_do_keyword_loc(repository)
      repository.enter(node_id, :do_keyword_loc) unless @do_keyword_loc.nil?
    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 18044
    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 18113
    def type
      :while_node
    end