Class: Prism::OrNode

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 or keyword.

left or 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) ⇒ OrNode

Initialize a new OrNode node.



15066
15067
15068
15069
15070
15071
15072
15073
15074
 
# File 'lib/prism/node.rb', line 15066

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
^



15124
15125
15126
 
# File 'lib/prism/node.rb', line 15124

def left
  @left
end

#right ⇒ Object (readonly)

Represents the right side of the expression.

left || right
        ^^^^^

1 or 2
     ^



15133
15134
15135
 
# File 'lib/prism/node.rb', line 15133

def right
  @right
end

Class Method Details

.type ⇒ Object

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



15167
15168
15169
 
# File 'lib/prism/node.rb', line 15167

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.



15173
15174
15175
15176
15177
15178
 
# File 'lib/prism/node.rb', line 15173

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



15077
15078
15079
 
# File 'lib/prism/node.rb', line 15077

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



15082
15083
15084
 
# File 'lib/prism/node.rb', line 15082

def child_nodes
  [left, right]
end

#comment_targets ⇒ Object

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



15100
15101
15102
 
# File 'lib/prism/node.rb', line 15100

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15095
15096
15097
 
# File 'lib/prism/node.rb', line 15095

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



15105
15106
15107
 
# File 'lib/prism/node.rb', line 15105

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 }



15113
15114
15115
 
# File 'lib/prism/node.rb', line 15113

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:



15087
15088
15089
15090
15091
15092
 
# File 'lib/prism/node.rb', line 15087

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield left
  yield right
end

#inspect ⇒ Object

def inspect -> String



15157
15158
15159
 
# File 'lib/prism/node.rb', line 15157

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String



15152
15153
15154
 
# File 'lib/prism/node.rb', line 15152

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

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

left or right
     ^^



15139
15140
15141
15142
15143
 
# File 'lib/prism/node.rb', line 15139

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.



15147
15148
15149
 
# File 'lib/prism/node.rb', line 15147

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

#type ⇒ Object

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



15162
15163
15164
 
# File 'lib/prism/node.rb', line 15162

def type
  :or_node
end