Class: Prism::UntilNode

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 ‘until` keyword, either in the block form or the modifier form.

bar until foo
^^^^^^^^^^^^^

until 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) ⇒ UntilNode

Initialize a new UntilNode node.



17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
 
# File 'lib/prism/node.rb', line 17690

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



17795
17796
17797
 
# File 'lib/prism/node.rb', line 17795

def predicate
  @predicate
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



17798
17799
17800
 
# File 'lib/prism/node.rb', line 17798

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



17826
17827
17828
 
# File 'lib/prism/node.rb', line 17826

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



17832
17833
17834
17835
17836
17837
17838
17839
17840
 
# File 'lib/prism/node.rb', line 17832

def ===(other)
  other.is_a?(UntilNode) &&
    (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



17703
17704
17705
 
# File 'lib/prism/node.rb', line 17703

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

#begin_modifier? ⇒ Boolean

def begin_modifier?: () -> bool

Returns:

  • (Boolean) 


17739
17740
17741
 
# File 'lib/prism/node.rb', line 17739

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

#child_nodes ⇒ Object Also known as: deconstruct

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



17708
17709
17710
 
# File 'lib/prism/node.rb', line 17708

def child_nodes
  [predicate, statements]
end

#closing ⇒ Object

def closing: () -> String?



17811
17812
17813
 
# File 'lib/prism/node.rb', line 17811

def closing
  closing_loc&.slice
end

#closing_loc ⇒ Object

attr_reader closing_loc: Location?



17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
 
# File 'lib/prism/node.rb', line 17776

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]



17721
17722
17723
 
# File 'lib/prism/node.rb', line 17721

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



17713
17714
17715
17716
17717
17718
 
# File 'lib/prism/node.rb', line 17713

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?) -> UntilNode



17726
17727
17728
 
# File 'lib/prism/node.rb', line 17726

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)
  UntilNode.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? }



17734
17735
17736
 
# File 'lib/prism/node.rb', line 17734

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?



17806
17807
17808
 
# File 'lib/prism/node.rb', line 17806

def do_keyword
  do_keyword_loc&.slice
end

#do_keyword_loc ⇒ Object

attr_reader do_keyword_loc: Location?



17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
 
# File 'lib/prism/node.rb', line 17757

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



17816
17817
17818
 
# File 'lib/prism/node.rb', line 17816

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



17801
17802
17803
 
# File 'lib/prism/node.rb', line 17801

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



17744
17745
17746
17747
17748
 
# File 'lib/prism/node.rb', line 17744

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:



103
104
105
 
# File 'lib/prism/parse_result/newlines.rb', line 103

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.



17790
17791
17792
 
# File 'lib/prism/node.rb', line 17790

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.



17771
17772
17773
 
# File 'lib/prism/node.rb', line 17771

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.



17752
17753
17754
 
# File 'lib/prism/node.rb', line 17752

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



17821
17822
17823
 
# File 'lib/prism/node.rb', line 17821

def type
  :until_node
end