class Prism::CaseMatchNode - prism: Ruby Standard Library Documentation

# class Prism::CaseMatchNode

Represents the use of a case statement for pattern matching.

    case true
    in false
    end
    ^^^^^^^^^

### Attributes

conditions[R]

Represents the conditions of the case match.

    case true; in false; end
               ^^^^^^^^

else_clause[R]

Represents the else clause of the case match.

    case true; in false; else; end
                         ^^^^

predicate[R]

Represents the predicate of the case match. 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; in false; end
    ^^^^

### Public Class Methods

new(source, node_id, location, flags, predicate, conditions, else_clause, case_keyword_loc, end_keyword_loc) click to toggle source

Initialize a new `CaseMatchNode` node.

    # File prism/node.rb, line 3526
    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

type() click to toggle source

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

    # File prism/node.rb, line 3646
    def self.type
      :case_match_node
    end

### Public Instance Methods

===(other) click to toggle source

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

    # File prism/node.rb, line 3652
    def ===(other)
      other.is_a?(CaseMatchNode) &&
        (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) click to toggle source

def accept: (`Visitor` visitor) -> void

    # File prism/node.rb, line 3539
    def accept(visitor)
      visitor.visit_case_match_node(self)
    end

case_keyword() click to toggle source

def `case_keyword`: () -> String

    # File prism/node.rb, line 3626
    def case_keyword
      case_keyword_loc.slice
    end

case_keyword_loc() click to toggle source

Represents the location of the ‘case` keyword.

    case true; in false; end
    ^^^^

    # File prism/node.rb, line 3597
    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() click to toggle source

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

    # File prism/node.rb, line 3544
    def child_nodes
      [predicate, *conditions, else_clause]
    end

Also aliased as: deconstruct
comment_targets() click to toggle source

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

    # File prism/node.rb, line 3558
    def comment_targets
      [*predicate, *conditions, *else_clause, case_keyword_loc, end_keyword_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File prism/node.rb, line 3549
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << predicate if predicate
      compact.concat(conditions)
      compact << else_clause if else_clause
      compact
    end

consequent() click to toggle source

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

    # File prism/node_ext.rb, line 467
    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) click to toggle source

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`) -> `CaseMatchNode`

    # File prism/node.rb, line 3563
    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)
      CaseMatchNode.new(source, node_id, location, flags, predicate, conditions, else_clause, case_keyword_loc, end_keyword_loc)
    end

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

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

    # File prism/node.rb, line 3571
    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() click to toggle source

def `end_keyword`: () -> String

    # File prism/node.rb, line 3631
    def end_keyword
      end_keyword_loc.slice
    end

end_keyword_loc() click to toggle source

Represents the location of the ‘end` keyword.

    case true; in false; end
                         ^^^

    # File prism/node.rb, line 3613
    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() click to toggle source

def inspect -> String

    # File prism/node.rb, line 3636
    def inspect
      InspectVisitor.compose(self)
    end

save_case_keyword_loc(repository) click to toggle source

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

    # File prism/node.rb, line 3605
    def save_case_keyword_loc(repository)
      repository.enter(node_id, :case_keyword_loc)
    end

save_end_keyword_loc(repository) click to toggle source

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

    # File prism/node.rb, line 3621
    def save_end_keyword_loc(repository)
      repository.enter(node_id, :end_keyword_loc)
    end

type() click to toggle source

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

    # File prism/node.rb, line 3641
    def type
      :case_match_node
    end