Class: Prism::RangeNode

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

Overview

Represents the use of the .. or ... operators.

1..2
^^^^

c if a =~ /left/ ... b =~ /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) ⇒ RangeNode

Initialize a new RangeNode node.



16072
16073
16074
16075
16076
16077
16078
16079
16080
# File 'lib/prism/node.rb', line 16072

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)

The left-hand side of the range, if present. It can be either nil or any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

1...
^

hello...goodbye
^^^^^


16138
16139
16140
# File 'lib/prism/node.rb', line 16138

def left
  @left
end

#rightObject (readonly)

The right-hand side of the range, if present. It can be either nil or any [non-void expression](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression).

..5
  ^

1...foo
    ^^^

If neither right-hand or left-hand side was included, this will be a MissingNode.



16148
16149
16150
# File 'lib/prism/node.rb', line 16148

def right
  @right
end

Class Method Details

.typeObject

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



16179
16180
16181
# File 'lib/prism/node.rb', line 16179

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



16185
16186
16187
16188
16189
16190
16191
# File 'lib/prism/node.rb', line 16185

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



16083
16084
16085
# File 'lib/prism/node.rb', line 16083

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

#child_nodesObject Also known as: deconstruct

def child_nodes: () -> Array



16088
16089
16090
# File 'lib/prism/node.rb', line 16088

def child_nodes
  [left, right]
end

#comment_targetsObject

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



16109
16110
16111
# File 'lib/prism/node.rb', line 16109

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

#compact_child_nodesObject

def compact_child_nodes: () -> Array



16101
16102
16103
16104
16105
16106
# File 'lib/prism/node.rb', line 16101

def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << left if left
  compact << right if right
  compact
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) -> RangeNode



16114
16115
16116
# File 'lib/prism/node.rb', line 16114

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



16122
16123
16124
# File 'lib/prism/node.rb', line 16122

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:



16093
16094
16095
16096
16097
16098
# File 'lib/prism/node.rb', line 16093

def each_child_node
  return to_enum(:each_child_node) unless block_given?

  yield left if left
  yield right if right
end

#exclude_end?Boolean

def exclude_end?: () -> bool



16127
16128
16129
# File 'lib/prism/node.rb', line 16127

def exclude_end?
  flags.anybits?(RangeFlags::EXCLUDE_END)
end

#inspectObject

def inspect -> String



16169
16170
16171
# File 'lib/prism/node.rb', line 16169

def inspect
  InspectVisitor.compose(self)
end

#operatorObject

def operator: () -> String



16164
16165
16166
# File 'lib/prism/node.rb', line 16164

def operator
  operator_loc.slice
end

#operator_locObject

The location of the .. or ... operator.



16151
16152
16153
16154
16155
# File 'lib/prism/node.rb', line 16151

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.



16159
16160
16161
# File 'lib/prism/node.rb', line 16159

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

#typeObject

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



16174
16175
16176
# File 'lib/prism/node.rb', line 16174

def type
  :range_node
end