Class: Prism::WhileNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
lib/prism/parse_result/newlines.rb,
ext/prism/api_node.c

Overview

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

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

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, keyword_loc, do_keyword_loc, closing_loc, predicate, statements) ⇒ WhileNode

Initialize a new WhileNode node.



17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
 
# File 'lib/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

Instance Attribute Details

#predicate ⇒ Object (readonly)

attr_reader predicate: Prism::node



18087
18088
18089
 
# File 'lib/prism/node.rb', line 18087

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



18090
18091
18092
 
# File 'lib/prism/node.rb', line 18090

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



18118
18119
18120
 
# File 'lib/prism/node.rb', line 18118

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



18124
18125
18126
18127
18128
18129
18130
18131
18132
 
# File 'lib/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) ⇒ Object

def accept: (Visitor visitor) -> void



17995
17996
17997
 
# File 'lib/prism/node.rb', line 17995

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

#begin_modifier? ⇒ Boolean

def begin_modifier?: () -> bool

Returns:

  • (Boolean) 


18031
18032
18033
 
# File 'lib/prism/node.rb', line 18031

def begin_modifier?
  flags.anybits?(LoopFlags::BEGIN_MODIFIER)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



18000
18001
18002
 
# File 'lib/prism/node.rb', line 18000

def child_nodes
  [predicate, statements]
end

#closing ⇒ Object

def closing: () -> String?



18103
18104
18105
 
# File 'lib/prism/node.rb', line 18103

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
 
# File 'lib/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 ⇒ Object

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



18013
18014
18015
 
# File 'lib/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 ⇒ Object

def compact_child_nodes: () -> Array



18005
18006
18007
18008
18009
18010
 
# File 'lib/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) ⇒ Object

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



18018
18019
18020
 
# File 'lib/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_keys(keys) ⇒ Object

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? }



18026
18027
18028
 
# File 'lib/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 ⇒ Object

def do_keyword: () -> String?



18098
18099
18100
 
# File 'lib/prism/node.rb', line 18098

def do_keyword
  do_keyword_loc&.slice
end

#do_keyword_loc ⇒ Object

attr_reader do_keyword_loc: Location?



18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
 
# File 'lib/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 ⇒ Object

def inspect -> String



18108
18109
18110
 
# File 'lib/prism/node.rb', line 18108

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



18093
18094
18095
 
# File 'lib/prism/node.rb', line 18093

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



18036
18037
18038
18039
18040
 
# File 'lib/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

#newline_flag!(lines) ⇒ Object

:nodoc:



109
110
111
 
# File 'lib/prism/parse_result/newlines.rb', line 109

def newline_flag!(lines) # :nodoc:
  predicate.newline_flag!(lines)
end

#save_closing_loc(repository) ⇒ Object

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



18082
18083
18084
 
# File 'lib/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) ⇒ Object

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



18063
18064
18065
 
# File 'lib/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) ⇒ Object

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



18044
18045
18046
 
# File 'lib/prism/node.rb', line 18044

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`.



18113
18114
18115
 
# File 'lib/prism/node.rb', line 18113

def type
  :while_node
end