Class: Prism::OrNode

Inherits:

PrismNode

• Object
• PrismNode
• Prism::OrNode

Defined in:

lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘||` operator or the `or` keyword.

left or right
^^^^^^^^^^^^^

Instance Attribute Summary

• #left ⇒ Object readonly

  Represents the left side of the expression.

• #right ⇒ Object readonly

  Represents the right side of the expression.

Class Method Summary

• .type ⇒ Object

  Return a symbol representation of this node type.

Instance Method Summary

• #===(other) ⇒ Object

  Implements case-equality for the node.

• #accept(visitor) ⇒ Object

  def accept: (Visitor visitor) -> void.

• #child_nodes ⇒ Object (also: #deconstruct)

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

• #comment_targets ⇒ Object

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

• #compact_child_nodes ⇒ Object

  def compact_child_nodes: () -> Array.

• #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) -> OrNode.

• #deconstruct_keys(keys) ⇒ Object

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

• #initialize(source, node_id, location, flags, left, right, operator_loc) ⇒ OrNode constructor

  Initialize a new OrNode node.

• #inspect ⇒ Object

  def inspect -> String.

• #operator ⇒ Object

  def operator: () -> String.

• #operator_loc ⇒ Object

  The location of the ‘or` keyword or the `||` operator.

• #type ⇒ Object

  Return a symbol representation of this node type.

Constructor Details

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

Initialize a new OrNode node.

# File 'lib/prism/node.rb', line 12662

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

#left ⇒ Object (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 or right
^^^^

1 || 2
^

# File 'lib/prism/node.rb', line 12712

def left
  @left
end

#right ⇒ Object (readonly)

Represents the right side of the expression.

left || right
        ^^^^^

1 or 2
     ^

# File 'lib/prism/node.rb', line 12721

def right
  @right
end

Class Method Details

.type ⇒ Object

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

# File 'lib/prism/node.rb', line 12749

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

# File 'lib/prism/node.rb', line 12755

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void

# File 'lib/prism/node.rb', line 12673

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

#child_nodes ⇒ Object Also known as: deconstruct

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

# File 'lib/prism/node.rb', line 12678

def child_nodes
  [left, right]
end

#comment_targets ⇒ Object

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

# File 'lib/prism/node.rb', line 12688

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array

# File 'lib/prism/node.rb', line 12683

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

# File 'lib/prism/node.rb', line 12693

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

# File 'lib/prism/node.rb', line 12701

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

#inspect ⇒ Object

def inspect -> String

# File 'lib/prism/node.rb', line 12739

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String

# File 'lib/prism/node.rb', line 12734

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘or` keyword or the `||` operator.

left or right
     ^^

# File 'lib/prism/node.rb', line 12727

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

#type ⇒ Object

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

# File 'lib/prism/node.rb', line 12744

def type
  :or_node
end