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, closing_loc, predicate, statements) ⇒ WhileNode

Initialize a new WhileNode node.



16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
 
# File 'lib/prism/node.rb', line 16276

def initialize(source, node_id, location, flags, keyword_loc, closing_loc, predicate, statements)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @closing_loc = closing_loc
  @predicate = predicate
  @statements = statements
end

Instance Attribute Details

#predicate ⇒ Object (readonly)

attr_reader predicate: Prism::node



16349
16350
16351
 
# File 'lib/prism/node.rb', line 16349

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



16352
16353
16354
 
# File 'lib/prism/node.rb', line 16352

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



16375
16376
16377
 
# File 'lib/prism/node.rb', line 16375

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.



16381
16382
16383
16384
16385
16386
16387
16388
 
# File 'lib/prism/node.rb', line 16381

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) ⇒ Object

def accept: (Visitor visitor) -> void



16288
16289
16290
 
# File 'lib/prism/node.rb', line 16288

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

#begin_modifier? ⇒ Boolean

def begin_modifier?: () -> bool

Returns:

  • (Boolean) 


16324
16325
16326
 
# File 'lib/prism/node.rb', line 16324

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16293
16294
16295
 
# File 'lib/prism/node.rb', line 16293

def child_nodes
  [predicate, statements]
end

#closing ⇒ Object

def closing: () -> String?



16360
16361
16362
 
# File 'lib/prism/node.rb', line 16360

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
 
# File 'lib/prism/node.rb', line 16336

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]



16306
16307
16308
 
# File 'lib/prism/node.rb', line 16306

def comment_targets
  [keyword_loc, *closing_loc, predicate, *statements] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16298
16299
16300
16301
16302
16303
 
# File 'lib/prism/node.rb', line 16298

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, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements) ⇒ Object

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



16311
16312
16313
 
# File 'lib/prism/node.rb', line 16311

def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, closing_loc: self.closing_loc, predicate: self.predicate, statements: self.statements)
  WhileNode.new(source, node_id, location, flags, keyword_loc, closing_loc, predicate, statements)
end

#deconstruct_keys(keys) ⇒ Object

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



16319
16320
16321
 
# File 'lib/prism/node.rb', line 16319

def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, closing_loc: closing_loc, predicate: predicate, statements: statements }
end

#inspect ⇒ Object

def inspect -> String



16365
16366
16367
 
# File 'lib/prism/node.rb', line 16365

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



16355
16356
16357
 
# File 'lib/prism/node.rb', line 16355

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



16329
16330
16331
16332
16333
 
# File 'lib/prism/node.rb', line 16329

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

#type ⇒ Object

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



16370
16371
16372
 
# File 'lib/prism/node.rb', line 16370

def type
  :while_node
end