Class: Prism::AndNode

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

Overview

Represents the use of the ‘&&` operator or the and keyword.

left and right
^^^^^^^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Initialize a new AndNode node.



693
694
695
696
697
698
699
700
701
# File 'lib/prism/node.rb', line 693

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. It can be any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

left and right
^^^^

1 && 2
^


751
752
753
# File 'lib/prism/node.rb', line 751

def left
  @left
end

#rightObject (readonly)

Represents the right side of the expression.

left && right
        ^^^^^

1 and 2
      ^


760
761
762
# File 'lib/prism/node.rb', line 760

def right
  @right
end

Class Method Details

.typeObject

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



794
795
796
# File 'lib/prism/node.rb', line 794

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



800
801
802
803
804
805
# File 'lib/prism/node.rb', line 800

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



704
705
706
# File 'lib/prism/node.rb', line 704

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

#child_nodesObject Also known as: deconstruct

def child_nodes: () -> Array



709
710
711
# File 'lib/prism/node.rb', line 709

def child_nodes
  [left, right]
end

#comment_targetsObject

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



727
728
729
# File 'lib/prism/node.rb', line 727

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

#compact_child_nodesObject

def compact_child_nodes: () -> Array



722
723
724
# File 'lib/prism/node.rb', line 722

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) -> AndNode



732
733
734
# File 'lib/prism/node.rb', line 732

def copy(node_id: self.node_id, location: self.location, flags: self.flags, left: self.left, right: self.right, operator_loc: self.operator_loc)
  AndNode.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 }



740
741
742
# File 'lib/prism/node.rb', line 740

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:



714
715
716
717
718
719
# File 'lib/prism/node.rb', line 714

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield left
  yield right
end

#inspectObject

def inspect -> String



784
785
786
# File 'lib/prism/node.rb', line 784

def inspect
  InspectVisitor.compose(self)
end

#operatorObject

def operator: () -> String



779
780
781
# File 'lib/prism/node.rb', line 779

def operator
  operator_loc.slice
end

#operator_locObject

The location of the and keyword or the ‘&&` operator.

left and right
     ^^^


766
767
768
769
770
# File 'lib/prism/node.rb', line 766

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.



774
775
776
# File 'lib/prism/node.rb', line 774

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

#typeObject

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



789
790
791
# File 'lib/prism/node.rb', line 789

def type
  :and_node
end