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.



19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
 
# File 'lib/prism/node.rb', line 19306

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



19419
19420
19421
 
# File 'lib/prism/node.rb', line 19419

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



19422
19423
19424
 
# File 'lib/prism/node.rb', line 19422

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



19450
19451
19452
 
# File 'lib/prism/node.rb', line 19450

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.



19456
19457
19458
19459
19460
19461
19462
19463
19464
 
# File 'lib/prism/node.rb', line 19456

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



19319
19320
19321
 
# File 'lib/prism/node.rb', line 19319

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

#begin_modifier? ⇒ Boolean

def begin_modifier?: () -> bool

Returns:

  • (Boolean) 


19363
19364
19365
 
# File 'lib/prism/node.rb', line 19363

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



19324
19325
19326
 
# File 'lib/prism/node.rb', line 19324

def child_nodes
  [predicate, statements]
end

#closing ⇒ Object

def closing: () -> String?



19435
19436
19437
 
# File 'lib/prism/node.rb', line 19435

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
 
# File 'lib/prism/node.rb', line 19400

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]



19345
19346
19347
 
# File 'lib/prism/node.rb', line 19345

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



19337
19338
19339
19340
19341
19342
 
# File 'lib/prism/node.rb', line 19337

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



19350
19351
19352
 
# File 'lib/prism/node.rb', line 19350

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



19358
19359
19360
 
# File 'lib/prism/node.rb', line 19358

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?



19430
19431
19432
 
# File 'lib/prism/node.rb', line 19430

def do_keyword
  do_keyword_loc&.slice
end

#do_keyword_loc ⇒ Object

attr_reader do_keyword_loc: Location?



19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
 
# File 'lib/prism/node.rb', line 19381

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

#each_child_node {|predicate| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



19329
19330
19331
19332
19333
19334
 
# File 'lib/prism/node.rb', line 19329

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield predicate
  yield statements if statements
end

#inspect ⇒ Object

def inspect -> String



19440
19441
19442
 
# File 'lib/prism/node.rb', line 19440

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



19425
19426
19427
 
# File 'lib/prism/node.rb', line 19425

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



19368
19369
19370
19371
19372
 
# File 'lib/prism/node.rb', line 19368

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:



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

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.



19414
19415
19416
 
# File 'lib/prism/node.rb', line 19414

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.



19395
19396
19397
 
# File 'lib/prism/node.rb', line 19395

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.



19376
19377
19378
 
# File 'lib/prism/node.rb', line 19376

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



19445
19446
19447
 
# File 'lib/prism/node.rb', line 19445

def type
  :while_node
end