class Prism::RangeNode

Represents the use of the ‘..` or `…` operators.

1..2
^^^^

c if a =~ /left/ ... b =~ /right/
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Attributes

flags[R]

protected attr_reader flags: Integer

left[R]

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

right[R]

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.

Public Class Methods

new(source, flags, left, right, operator_loc, location) click to toggle source

def initialize: (Integer flags, Prism::node? left, Prism::node? right, Location operator_loc, Location location) -> void

# File lib/prism/node.rb, line 15393
def initialize(source, flags, left, right, operator_loc, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @left = left
  @right = right
  @operator_loc = operator_loc
end

type() click to toggle source

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

# File lib/prism/node.rb, line 15508
def self.type
  :range_node
end

Public Instance Methods

===(other) click to toggle source

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 15514
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) click to toggle source

def accept: (Visitor visitor) -> void

# File lib/prism/node.rb, line 15404
def accept(visitor)
  visitor.visit_range_node(self)
end

child_nodes() click to toggle source

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

# File lib/prism/node.rb, line 15409
def child_nodes
  [left, right]
end

Also aliased as: deconstruct

comment_targets() click to toggle source

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

# File lib/prism/node.rb, line 15422
def comment_targets
  [*left, *right, operator_loc] #: Array[Prism::node | Location]
end

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File lib/prism/node.rb, line 15414
def compact_child_nodes
  compact = [] #: Array[Prism::node]
  compact << left if left
  compact << right if right
  compact
end

copy(flags: self.flags, left: self.left, right: self.right, operator_loc: self.operator_loc, location: self.location) click to toggle source

def copy: (?flags: Integer, ?left: Prism::node?, ?right: Prism::node?, ?operator_loc: Location, ?location: Location) -> RangeNode

# File lib/prism/node.rb, line 15427
def copy(flags: self.flags, left: self.left, right: self.right, operator_loc: self.operator_loc, location: self.location)
  RangeNode.new(source, flags, left, right, operator_loc, location)
end

deconstruct()

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

Alias for: child_nodes

deconstruct_keys(keys) click to toggle source

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

# File lib/prism/node.rb, line 15435
def deconstruct_keys(keys)
  { flags: flags, left: left, right: right, operator_loc: operator_loc, location: location }
end

exclude_end?() click to toggle source

def exclude_end?: () -> bool

# File lib/prism/node.rb, line 15470
def exclude_end?
  flags.anybits?(RangeFlags::EXCLUDE_END)
end

inspect() click to toggle source

def inspect -> String

# File lib/prism/node.rb, line 15480
def inspect
  InspectVisitor.compose(self)
end

operator() click to toggle source

def operator: () -> String

# File lib/prism/node.rb, line 15475
def operator
  operator_loc.slice
end

operator_loc() click to toggle source

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

# File lib/prism/node.rb, line 15463
def operator_loc
  location = @operator_loc
  return location if location.is_a?(Location)
  @operator_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
end

type() click to toggle source

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol

# File lib/prism/node.rb, line 15498
def type
  :range_node
end