class Prism::DefinedNode - Documentation for Ruby 4.0
Description: class Prism::DefinedNode: Represents the use of the `defined?` keyword.
Keywords: ruby,class,Prism::DefinedNode

🔍

No recent searches

# class Prism::DefinedNode

Represents the use of the `defined?` keyword.

    defined?(a)
    ^^^^^^^^^^^

### Attributes

value [R]

attr_reader value: Prism::node

### Public Class Methods

new (source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc)
Source

    # File lib/prism/node.rb, line 6559
    def initialize(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @lparen_loc = lparen_loc
      @value = value
      @rparen_loc = rparen_loc
      @keyword_loc = keyword_loc
    end

Initialize a new `DefinedNode` node.

type ()
Source

    # File lib/prism/node.rb, line 6690
    def self.type
      :defined_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 6696
    def ===(other)
      other.is_a?(DefinedNode) &&
        (lparen_loc.nil? == other.lparen_loc.nil?) &&
        (value === other.value) &&
        (rparen_loc.nil? == other.rparen_loc.nil?) &&
        (keyword_loc.nil? == other.keyword_loc.nil?)
    end

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.

accept (visitor)
Source

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

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

child_nodes ()
Source

    # File lib/prism/node.rb, line 6576
    def child_nodes
      [value]
    end

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 6593
    def comment_targets
      [*lparen_loc, value, *rparen_loc, keyword_loc] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

    # File lib/prism/node.rb, line 6588
    def compact_child_nodes
      [value]
    end

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc)
Source

    # File lib/prism/node.rb, line 6598
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, lparen_loc: self.lparen_loc, value: self.value, rparen_loc: self.rparen_loc, keyword_loc: self.keyword_loc)
      DefinedNode.new(source, node_id, location, flags, lparen_loc, value, rparen_loc, keyword_loc)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?lparen_loc: `Location`?, ?value: Prism::node, ?rparen_loc: `Location`?, ?keyword_loc: `Location`) -> `DefinedNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 6606
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, lparen_loc: lparen_loc, value: value, rparen_loc: rparen_loc, keyword_loc: keyword_loc }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, `lparen_loc`: `Location`?, value: Prism::node, `rparen_loc`: `Location`?, `keyword_loc`: `Location` }

each_child_node () { |value| ... }
Source

    # File lib/prism/node.rb, line 6581
    def each_child_node
      return to_enum(:each_child_node) unless block_given?

      yield value
    end

def `each_child_node`: () { (Prism::node) -> void } -> void | () -> Enumerator

inspect ()
Source

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

def inspect -> `String`

keyword ()
Source

    # File lib/prism/node.rb, line 6675
    def keyword
      keyword_loc.slice
    end

def keyword: () -> `String`

keyword_loc ()
Source

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

attr_reader `keyword_loc`: `Location`

lparen ()
Source

    # File lib/prism/node.rb, line 6665
    def lparen
      lparen_loc&.slice
    end

def lparen: () -> `String`?

lparen_loc ()
Source

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

attr_reader `lparen_loc`: `Location`?

rparen ()
Source

    # File lib/prism/node.rb, line 6670
    def rparen
      rparen_loc&.slice
    end

def rparen: () -> `String`?

rparen_loc ()
Source

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

attr_reader `rparen_loc`: `Location`?

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 6660
    def save_keyword_loc(repository)
      repository.enter(node_id, :keyword_loc)
    end

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

save_lparen_loc (repository)
Source

    # File lib/prism/node.rb, line 6625
    def save_lparen_loc(repository)
      repository.enter(node_id, :lparen_loc) unless @lparen_loc.nil?
    end

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

save_rparen_loc (repository)
Source

    # File lib/prism/node.rb, line 6647
    def save_rparen_loc(repository)
      repository.enter(node_id, :rparen_loc) unless @rparen_loc.nil?
    end

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

type ()
Source

    # File lib/prism/node.rb, line 6685
    def type
      :defined_node
    end

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