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.



15168
15169
15170
15171
15172
15173
15174
15175
15176
 
# File 'lib/prism/node.rb', line 15168

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)

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
^^^^^



15226
15227
15228
 
# File 'lib/prism/node.rb', line 15226

def left
  @left
end

#right ⇒ Object (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.



15236
15237
15238
 
# File 'lib/prism/node.rb', line 15236

def right
  @right
end

Class Method Details

.type ⇒ Object

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



15267
15268
15269
 
# File 'lib/prism/node.rb', line 15267

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.



15273
15274
15275
15276
15277
15278
15279
 
# File 'lib/prism/node.rb', line 15273

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



15179
15180
15181
 
# File 'lib/prism/node.rb', line 15179

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



15184
15185
15186
 
# File 'lib/prism/node.rb', line 15184

def child_nodes
  [left, right]
end

#comment_targets ⇒ Object

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



15197
15198
15199
 
# File 'lib/prism/node.rb', line 15197

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15189
15190
15191
15192
15193
15194
 
# File 'lib/prism/node.rb', line 15189

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



15202
15203
15204
 
# File 'lib/prism/node.rb', line 15202

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 }



15210
15211
15212
 
# File 'lib/prism/node.rb', line 15210

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

#exclude_end? ⇒ Boolean

def exclude_end?: () -> bool

Returns:

  • (Boolean) 


15215
15216
15217
 
# File 'lib/prism/node.rb', line 15215

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

#inspect ⇒ Object

def inspect -> String



15257
15258
15259
 
# File 'lib/prism/node.rb', line 15257

def inspect
  InspectVisitor.compose(self)
end

#operator ⇒ Object

def operator: () -> String



15252
15253
15254
 
# File 'lib/prism/node.rb', line 15252

def operator
  operator_loc.slice
end

#operator_loc ⇒ Object

The location of the ‘..` or `…` operator.



15239
15240
15241
15242
15243
 
# File 'lib/prism/node.rb', line 15239

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.



15247
15248
15249
 
# File 'lib/prism/node.rb', line 15247

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`.



15262
15263
15264
 
# File 'lib/prism/node.rb', line 15262

def type
  :range_node
end