Class: Prism::AlternationPatternNode

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

Overview

Represents an alternation pattern in pattern matching.

foo => bar | baz
       ^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(source, node_id, location, flags, left, right, operator_loc) ⇒ AlternationPatternNode

Initialize a new AlternationPatternNode node.



578
579
580
581
582
583
584
585
586
# File 'lib/prism/node.rb', line 578

def initialize(source, node_id, location, flags, left, right, operator_loc)
  @source = source
  @node_id = node_id
  @location = location
  @flags = flags
  @left = left
  @right = right
  @operator_loc = operator_loc
end

Instance Attribute Details

#leftObject (readonly)

Represents the left side of the expression.

foo => bar | baz
       ^^^


633
634
635
# File 'lib/prism/node.rb', line 633

def left
  @left
end

#rightObject (readonly)

Represents the right side of the expression.

foo => bar | baz
             ^^^


639
640
641
# File 'lib/prism/node.rb', line 639

def right
  @right
end

Class Method Details

.typeObject

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



673
674
675
# File 'lib/prism/node.rb', line 673

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



679
680
681
682
683
684
# File 'lib/prism/node.rb', line 679

def ===(other)
  other.is_a?(AlternationPatternNode) &&
    (left === other.left) &&
    (right === other.right) &&
    (operator_loc.nil? == other.operator_loc.nil?)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



589
590
591
# File 'lib/prism/node.rb', line 589

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

#child_nodesObject Also known as: deconstruct

def child_nodes: () -> Array



594
595
596
# File 'lib/prism/node.rb', line 594

def child_nodes
  [left, right]
end

#comment_targetsObject

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



612
613
614
# File 'lib/prism/node.rb', line 612

def comment_targets
  [left, right, operator_loc] #: Array[Prism::node | Location]
end

#compact_child_nodesObject

def compact_child_nodes: () -> Array



607
608
609
# File 'lib/prism/node.rb', line 607

def compact_child_nodes
  [left, right]
end

#copy(node_id: self.node_id, location: self.location, flags: self.flags, left: self.left, right: self.right, operator_loc: self.operator_loc) ⇒ Object

def copy: (?node_id: Integer, ?location: Location, ?flags: Integer, ?left: Prism::node, ?right: Prism::node, ?operator_loc: Location) -> AlternationPatternNode



617
618
619
# File 'lib/prism/node.rb', line 617

def copy(node_id: self.node_id, location: self.location, flags: self.flags, left: self.left, right: self.right, operator_loc: self.operator_loc)
  AlternationPatternNode.new(source, node_id, location, flags, left, right, operator_loc)
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (Array keys) -> { node_id: Integer, location: Location, left: Prism::node, right: Prism::node, operator_loc: Location }



625
626
627
# File 'lib/prism/node.rb', line 625

def deconstruct_keys(keys)
  { node_id: node_id, location: location, left: left, right: right, operator_loc: operator_loc }
end

#each_child_node {|left| ... } ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator

Yields:



599
600
601
602
603
604
# File 'lib/prism/node.rb', line 599

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield left
  yield right
end

#inspectObject

def inspect -> String



663
664
665
# File 'lib/prism/node.rb', line 663

def inspect
  InspectVisitor.compose(self)
end

#operatorObject

def operator: () -> String



658
659
660
# File 'lib/prism/node.rb', line 658

def operator
  operator_loc.slice
end

#operator_locObject

Represents the alternation operator location.

foo => bar | baz
           ^


645
646
647
648
649
# File 'lib/prism/node.rb', line 645

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

#save_operator_loc(repository) ⇒ Object

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



653
654
655
# File 'lib/prism/node.rb', line 653

def save_operator_loc(repository)
  repository.enter(node_id, :operator_loc)
end

#typeObject

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



668
669
670
# File 'lib/prism/node.rb', line 668

def type
  :alternation_pattern_node
end