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

# class Prism::FindPatternNode

Represents a find pattern in pattern matching.

    foo in *bar, baz, *qux
           ^^^^^^^^^^^^^^^

    foo in [*bar, baz, *qux]
           ^^^^^^^^^^^^^^^^^

    foo in Foo(*bar, baz, *qux)
           ^^^^^^^^^^^^^^^^^^^^

### Attributes

constant[R]

attr_reader constant: `ConstantReadNode` | `ConstantPathNode` | nil

left[R]

attr_reader left: `SplatNode`

requireds[R]

attr_reader requireds: Array

right[R]

attr_reader right: `SplatNode` | `MissingNode`

### Public Class Methods

new(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc) click to toggle source

Initialize a new `FindPatternNode` node.

    # File prism/node.rb, line 6818
    def initialize(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @constant = constant
      @left = left
      @requireds = requireds
      @right = right
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

type() click to toggle source

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

    # File prism/node.rb, line 6940
    def self.type
      :find_pattern_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 6946
    def ===(other)
      other.is_a?(FindPatternNode) &&
        (constant === other.constant) &&
        (left === other.left) &&
        (requireds.length == other.requireds.length) &&
        requireds.zip(other.requireds).all? { |left, right| left === right } &&
        (right === other.right) &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (closing_loc.nil? == other.closing_loc.nil?)
    end

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

    # File prism/node.rb, line 6837
    def child_nodes
      [constant, left, *requireds, right]
    end

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

def closing: () -> String?

    # File prism/node.rb, line 6925
    def closing
      closing_loc&.slice
    end

closing_loc() click to toggle source

attr_reader `closing_loc`: `Location`?

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

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

    # File prism/node.rb, line 6852
    def comment_targets
      [*constant, left, *requireds, right, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File prism/node.rb, line 6842
    def compact_child_nodes
      compact = [] #: Array[Prism::node]
      compact << constant if constant
      compact << left
      compact.concat(requireds)
      compact << right
      compact
    end

copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, left: self.left, requireds: self.requireds, right: self.right, opening_loc: self.opening_loc, closing_loc: self.closing_loc) click to toggle source

def copy: (?node_id: Integer, ?location: `Location`, ?flags: Integer, ?constant: `ConstantReadNode` | `ConstantPathNode` | nil, ?left: `SplatNode`, ?requireds: Array, ?right: `SplatNode` | `MissingNode`, ?opening_loc: `Location`?, ?closing_loc: `Location`?) -> `FindPatternNode`

    # File prism/node.rb, line 6857
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, constant: self.constant, left: self.left, requireds: self.requireds, right: self.right, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      FindPatternNode.new(source, node_id, location, flags, constant, left, requireds, right, opening_loc, closing_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`, constant: `ConstantReadNode` | `ConstantPathNode` | nil, left: `SplatNode`, requireds: Array, right: `SplatNode` | `MissingNode`, `opening_loc`: `Location`?, `closing_loc`: `Location`? }

    # File prism/node.rb, line 6865
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, constant: constant, left: left, requireds: requireds, right: right, opening_loc: opening_loc, closing_loc: closing_loc }
    end

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

    # File prism/node.rb, line 6920
    def opening
      opening_loc&.slice
    end

opening_loc() click to toggle source

attr_reader `opening_loc`: `Location`?

    # File prism/node.rb, line 6882
    def opening_loc
      location = @opening_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

save_closing_loc(repository) click to toggle source

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

    # File prism/node.rb, line 6915
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

save_opening_loc(repository) click to toggle source

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

    # File prism/node.rb, line 6896
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

type() click to toggle source

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

    # File prism/node.rb, line 6935
    def type
      :find_pattern_node
    end