Class: Prism::WhenNode

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

Overview

Represents the use of the ‘when` keyword within a case statement.

case true
when true
^^^^^^^^^
end

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, keyword_loc, conditions, then_keyword_loc, statements) ⇒ WhenNode

Initialize a new WhenNode node.



17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
 
# File 'lib/prism/node.rb', line 17851

def initialize(source, node_id, location, flags, keyword_loc, conditions, then_keyword_loc, statements)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @keyword_loc = keyword_loc
  @conditions = conditions
  @then_keyword_loc = then_keyword_loc
  @statements = statements
end

Instance Attribute Details

#conditions ⇒ Object (readonly)

attr_reader conditions: Array



17912
17913
17914
 
# File 'lib/prism/node.rb', line 17912

def conditions
  @conditions
end

#statements ⇒ Object (readonly)

attr_reader statements: StatementsNode?



17934
17935
17936
 
# File 'lib/prism/node.rb', line 17934

def statements
  @statements
end

Class Method Details

.type ⇒ Object

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



17957
17958
17959
 
# File 'lib/prism/node.rb', line 17957

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



17963
17964
17965
17966
17967
17968
17969
17970
 
# File 'lib/prism/node.rb', line 17963

def ===(other)
  other.is_a?(WhenNode) &&
    (keyword_loc.nil? == other.keyword_loc.nil?) &&
    (conditions.length == other.conditions.length) &&
    conditions.zip(other.conditions).all? { |left, right| left === right } &&
    (then_keyword_loc.nil? == other.then_keyword_loc.nil?) &&
    (statements === other.statements)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



17863
17864
17865
 
# File 'lib/prism/node.rb', line 17863

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

#child_nodes ⇒ Object Also known as: deconstruct

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



17868
17869
17870
 
# File 'lib/prism/node.rb', line 17868

def child_nodes
  [*conditions, statements]
end

#comment_targets ⇒ Object

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



17881
17882
17883
 
# File 'lib/prism/node.rb', line 17881

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



17873
17874
17875
17876
17877
17878
 
# File 'lib/prism/node.rb', line 17873

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact.concat(conditions)
  compact << statements if statements
  compact
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, conditions: self.conditions, then_keyword_loc: self.then_keyword_loc, statements: self.statements) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?keyword_loc: Location, ?conditions: Array, ?then_keyword_loc: Location?, ?statements: StatementsNode?) -> WhenNode



17886
17887
17888
 
# File 'lib/prism/node.rb', line 17886

def copy(node_id: self.node_id, location: self.location, flags: self.flags, keyword_loc: self.keyword_loc, conditions: self.conditions, then_keyword_loc: self.then_keyword_loc, statements: self.statements)
  WhenNode.new(source, node_id, location, flags, keyword_loc, conditions, then_keyword_loc, statements)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, keyword_loc: Location, conditions: Array, then_keyword_loc: Location?, statements: StatementsNode? }



17894
17895
17896
 
# File 'lib/prism/node.rb', line 17894

def deconstruct_keys(keys)
  { node_id: node_id, location: location, keyword_loc: keyword_loc, conditions: conditions, then_keyword_loc: then_keyword_loc, statements: statements }
end

#inspect ⇒ Object

def inspect -> String



17947
17948
17949
 
# File 'lib/prism/node.rb', line 17947

def inspect
  InspectVisitor.compose(self)
end

#keyword ⇒ Object

def keyword: () -> String



17937
17938
17939
 
# File 'lib/prism/node.rb', line 17937

def keyword
  keyword_loc.slice
end

#keyword_loc ⇒ Object

attr_reader keyword_loc: Location



17899
17900
17901
17902
17903
 
# File 'lib/prism/node.rb', line 17899

def keyword_loc
  location = @keyword_loc
  return location if location.is_a?(Location)
  @keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

#save_keyword_loc(repository) ⇒ Object

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



17907
17908
17909
 
# File 'lib/prism/node.rb', line 17907

def save_keyword_loc(repository)
  repository.enter(node_id, :keyword_loc)
end

#save_then_keyword_loc(repository) ⇒ Object

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



17929
17930
17931
 
# File 'lib/prism/node.rb', line 17929

def save_then_keyword_loc(repository)
  repository.enter(node_id, :then_keyword_loc) unless @then_keyword_loc.nil?
end

#then_keyword ⇒ Object

def then_keyword: () -> String?



17942
17943
17944
 
# File 'lib/prism/node.rb', line 17942

def then_keyword
  then_keyword_loc&.slice
end

#then_keyword_loc ⇒ Object

attr_reader then_keyword_loc: Location?



17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
 
# File 'lib/prism/node.rb', line 17915

def then_keyword_loc
  location = @then_keyword_loc
  case location
  when nil
    nil
  when Location
    location
  else
    @then_keyword_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
  end
end

#type ⇒ Object

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



17952
17953
17954
 
# File 'lib/prism/node.rb', line 17952

def type
  :when_node
end