class Prism::ArrayNode - prism: Ruby Standard Library Documentation

# class Prism::ArrayNode

Represents an array literal. This can be a regular array using brackets or a special array using % like %w or %i.

    [1, 2, 3]
    ^^^^^^^^^

### Attributes

elements[R]

Represent the list of zero or more [non-void expressions](github.com/ruby/prism/blob/main/docs/parsing_rules.md#non-void-expression) within the array.

### Public Class Methods

new(source, node_id, location, flags, elements, opening_loc, closing_loc) click to toggle source

Initialize a new `ArrayNode` node.

    # File prism/node.rb, line 867
    def initialize(source, node_id, location, flags, elements, opening_loc, closing_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @elements = elements
      @opening_loc = opening_loc
      @closing_loc = closing_loc
    end

type() click to toggle source

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

    # File prism/node.rb, line 987
    def self.type
      :array_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 prism/node.rb, line 993
    def ===(other)
      other.is_a?(ArrayNode) &&
        (flags === other.flags) &&
        (elements.length == other.elements.length) &&
        elements.zip(other.elements).all? { |left, right| left === right } &&
        (opening_loc.nil? == other.opening_loc.nil?) &&
        (closing_loc.nil? == other.closing_loc.nil?)
    end

accept(visitor) click to toggle source

def accept: (`Visitor` visitor) -> void

    # File prism/node.rb, line 878
    def accept(visitor)
      visitor.visit_array_node(self)
    end

child_nodes() click to toggle source

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

    # File prism/node.rb, line 883
    def child_nodes
      [*elements]
    end

Also aliased as: deconstruct
closing() click to toggle source

def closing: () -> String?

    # File prism/node.rb, line 972
    def closing
      closing_loc&.slice
    end

closing_loc() click to toggle source

Represents the optional source location for the closing token.

    [1,2,3]                 # "]"
    %w[foo bar baz]         # "]"
    %I(apple orange banana) # ")"
    foo = 1, 2, 3           # nil

    # File prism/node.rb, line 948
    def closing_loc
      location = @closing_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @closing_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

comment_targets() click to toggle source

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

    # File prism/node.rb, line 893
    def comment_targets
      [*elements, *opening_loc, *closing_loc] #: Array[Prism::node | Location]
    end

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

    # File prism/node.rb, line 888
    def compact_child_nodes
      [*elements]
    end

contains_splat?() click to toggle source

def contains_splat?: () -> bool

    # File prism/node.rb, line 911
    def contains_splat?
      flags.anybits?(ArrayNodeFlags::CONTAINS_SPLAT)
    end

copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc) click to toggle source

def copy: (?node_id: Integer, ?location: `Location`, ?flags: Integer, ?elements: Array, ?opening_loc: `Location`?, ?closing_loc: `Location`?) -> `ArrayNode`

    # File prism/node.rb, line 898
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, elements: self.elements, opening_loc: self.opening_loc, closing_loc: self.closing_loc)
      ArrayNode.new(source, node_id, location, flags, elements, opening_loc, closing_loc)
    end

deconstruct()

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

Alias for: child_nodes
deconstruct_keys(keys) click to toggle source

def `deconstruct_keys`: (Array keys) -> { node_id: Integer, location: `Location`, elements: Array, `opening_loc`: `Location`?, `closing_loc`: `Location`? }

    # File prism/node.rb, line 906
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, elements: elements, opening_loc: opening_loc, closing_loc: closing_loc }
    end

inspect() click to toggle source

def inspect -> String

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

opening() click to toggle source

def opening: () -> String?

    # File prism/node.rb, line 967
    def opening
      opening_loc&.slice
    end

opening_loc() click to toggle source

Represents the optional source location for the opening token.

    [1,2,3]                 # "["
    %w[foo bar baz]         # "%w["
    %I(apple orange banana) # "%I("
    foo = 1, 2, 3           # nil

    # File prism/node.rb, line 924
    def opening_loc
      location = @opening_loc
      case location
      when nil
        nil
      when Location
        location
      else
        @opening_loc = Location.new(source, location >> 32, location & 0xFFFFFFFF)
      end
    end

save_closing_loc(repository) click to toggle source

Save the `closing_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 962
    def save_closing_loc(repository)
      repository.enter(node_id, :closing_loc) unless @closing_loc.nil?
    end

save_opening_loc(repository) click to toggle source

Save the `opening_loc` location using the given saved source so that it can be retrieved later.

    # File prism/node.rb, line 938
    def save_opening_loc(repository)
      repository.enter(node_id, :opening_loc) unless @opening_loc.nil?
    end

type() click to toggle source

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

    # File prism/node.rb, line 982
    def type
      :array_node
    end