Class: Prism::CaseNode

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

Overview

Represents the use of a case statement.

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, predicate, conditions, else_clause, case_keyword_loc, end_keyword_loc) ⇒ CaseNode

Initialize a new CaseNode node.



3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
 
# File 'lib/prism/node.rb', line 3671

def initialize(source, node_id, location, flags, predicate, conditions, else_clause, case_keyword_loc, end_keyword_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @predicate = predicate
  @conditions = conditions
  @else_clause = else_clause
  @case_keyword_loc = case_keyword_loc
  @end_keyword_loc = end_keyword_loc
end

Instance Attribute Details

#conditions ⇒ Object (readonly)

Represents the conditions of the case statement.

case true; when false; end
           ^^^^^^^^^^



3730
3731
3732
 
# File 'lib/prism/node.rb', line 3730

def conditions
  @conditions
end

#else_clause ⇒ Object (readonly)

Represents the else clause of the case statement.

case true; when false; else; end
                       ^^^^



3736
3737
3738
 
# File 'lib/prism/node.rb', line 3736

def else_clause
  @else_clause
end

#predicate ⇒ Object (readonly)

Represents the predicate of the case statement. This can be either ‘nil` or any [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

case true; when false; end
^^^^



3724
3725
3726
 
# File 'lib/prism/node.rb', line 3724

def predicate
  @predicate
end

Class Method Details

.type ⇒ Object

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



3791
3792
3793
 
# File 'lib/prism/node.rb', line 3791

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



3797
3798
3799
3800
3801
3802
3803
3804
3805
 
# File 'lib/prism/node.rb', line 3797

def ===(other)
  other.is_a?(CaseNode) &&
    (predicate === other.predicate) &&
    (conditions.length == other.conditions.length) &&
    conditions.zip(other.conditions).all? { |left, right| left === right } &&
    (else_clause === other.else_clause) &&
    (case_keyword_loc.nil? == other.case_keyword_loc.nil?) &&
    (end_keyword_loc.nil? == other.end_keyword_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



3684
3685
3686
 
# File 'lib/prism/node.rb', line 3684

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

#case_keyword ⇒ Object

def case_keyword: () -> String



3771
3772
3773
 
# File 'lib/prism/node.rb', line 3771

def case_keyword
  case_keyword_loc.slice
end

#case_keyword_loc ⇒ Object

Represents the location of the ‘case` keyword.

case true; when false; end
^^^^



3742
3743
3744
3745
3746
 
# File 'lib/prism/node.rb', line 3742

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

#child_nodes ⇒ Object Also known as: deconstruct

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



3689
3690
3691
 
# File 'lib/prism/node.rb', line 3689

def child_nodes
  [predicate, *conditions, else_clause]
end

#comment_targets ⇒ Object

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



3703
3704
3705
 
# File 'lib/prism/node.rb', line 3703

def comment_targets
  [*predicate, *conditions, *else_clause, case_keyword_loc, end_keyword_loc] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



3694
3695
3696
3697
3698
3699
3700
 
# File 'lib/prism/node.rb', line 3694

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

#consequent ⇒ Object

Returns the else clause of the case node. This method is deprecated in favor of #else_clause.



476
477
478
479
 
# File 'lib/prism/node_ext.rb', line 476

def consequent
  deprecated("else_clause")
  else_clause
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, predicate: self.predicate, conditions: self.conditions, else_clause: self.else_clause, case_keyword_loc: self.case_keyword_loc, end_keyword_loc: self.end_keyword_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?predicate: Prism::node?, ?conditions: Array, ?else_clause: ElseNode?, ?case_keyword_loc: Location, ?end_keyword_loc: Location) -> CaseNode



3708
3709
3710
 
# File 'lib/prism/node.rb', line 3708

def copy(node_id: self.node_id, location: self.location, flags: self.flags, predicate: self.predicate, conditions: self.conditions, else_clause: self.else_clause, case_keyword_loc: self.case_keyword_loc, end_keyword_loc: self.end_keyword_loc)
  CaseNode.new(source, node_id, location, flags, predicate, conditions, else_clause, case_keyword_loc, end_keyword_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, predicate: Prism::node?, conditions: Array, else_clause: ElseNode?, case_keyword_loc: Location, end_keyword_loc: Location }



3716
3717
3718
 
# File 'lib/prism/node.rb', line 3716

def deconstruct_keys(keys)
  { node_id: node_id, location: location, predicate: predicate, conditions: conditions, else_clause: else_clause, case_keyword_loc: case_keyword_loc, end_keyword_loc: end_keyword_loc }
end

#end_keyword ⇒ Object

def end_keyword: () -> String



3776
3777
3778
 
# File 'lib/prism/node.rb', line 3776

def end_keyword
  end_keyword_loc.slice
end

#end_keyword_loc ⇒ Object

Represents the location of the ‘end` keyword.

case true; when false; end
                       ^^^



3758
3759
3760
3761
3762
 
# File 'lib/prism/node.rb', line 3758

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

#inspect ⇒ Object

def inspect -> String



3781
3782
3783
 
# File 'lib/prism/node.rb', line 3781

def inspect
  InspectVisitor.compose(self)
end

#save_case_keyword_loc(repository) ⇒ Object

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



3750
3751
3752
 
# File 'lib/prism/node.rb', line 3750

def save_case_keyword_loc(repository)
  repository.enter(node_id, :case_keyword_loc)
end

#save_end_keyword_loc(repository) ⇒ Object

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



3766
3767
3768
 
# File 'lib/prism/node.rb', line 3766

def save_end_keyword_loc(repository)
  repository.enter(node_id, :end_keyword_loc)
end

#type ⇒ Object

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



3786
3787
3788
 
# File 'lib/prism/node.rb', line 3786

def type
  :case_node
end