class Prism::DefinedNode - Documentation for Ruby 4.1
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)
    ^^^^^^^^^^^

### Public Class Methods

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

    # File lib/prism/node.rb, line 10318
    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.

### Public Instance Methods

value → Node
Source

    # File lib/prism/node.rb, line 10449
    def value
      @value
    end

Returns the `value` attribute.

## Locations

### Public Instance Methods

keyword_loc → Location
Source

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

Returns the `Location` represented by `keyword_loc`.

lparen_loc → Location | nil
Source

    # File lib/prism/node.rb, line 10423
    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

Returns the `Location` represented by `lparen_loc`.

rparen_loc → Location | nil
Source

    # File lib/prism/node.rb, line 10460
    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

Returns the `Location` represented by `rparen_loc`.

## Node Interface

These methods are present on all subclasses of `Node`. Read the node interface docs for more information.

### Public Class Methods

type ()
Source

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

See `Node.type`.

### Public Instance Methods

accept (visitor)
Source

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

See `Node.accept`.

child_nodes ()
Source

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

See `Node.child_nodes`.

Also aliased as: deconstruct
comment_targets ()
Source

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

See `Node.comment_targets`.

compact_child_nodes ()
Source

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

See `Node.compact_child_nodes`.

copy(**fields) → DefinedNode
Source

    # File lib/prism/node.rb, line 10384
    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

Creates a copy of self with the given fields, using self as the template.

deconstruct ()
Alias for: child_nodes
each_child_node () { |value| ... }
Source

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

      yield value
    end

See `Node.each_child_node`.

type ()
Source

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

See `Node#type`.

## Repository

Methods related to `Relocation`.

### Public Instance Methods

save_keyword_loc (repository)
Source

    # File lib/prism/node.rb, line 10498
    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 10440
    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 10477
    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.

## Slicing

### Public Instance Methods

keyword → String
Source

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

Slice the location of `keyword_loc` from the source.

lparen → String | nil
Source

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

Slice the location of `lparen_loc` from the source.

rparen → String | nil
Source

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

Slice the location of `rparen_loc` from the source.