class Prism::SourceFileNode - Documentation for Ruby 4.0
Description: class Prism::SourceFileNode: Represents the use of the `__FILE__` keyword.
Keywords: ruby,class,Prism::SourceFileNode

🔍

No recent searches

# class Prism::SourceFileNode

Represents the use of the `__FILE__` keyword.

    __FILE__
    ^^^^^^^^

### Attributes

filepath [R]

Represents the file path being parsed. This corresponds directly to the `filepath` option given to the various `Prism::parse*` APIs.

### Public Class Methods

new (source, node_id, location, flags, filepath)
Source

    # File lib/prism/node.rb, line 17747
    def initialize(source, node_id, location, flags, filepath)
      @source = source
      @node_id = node_id
      @location = location
      @flags = flags
      @filepath = filepath
    end

Initialize a new `SourceFileNode` node.

type ()
Source

    # File lib/prism/node.rb, line 17828
    def self.type
      :source_file_node
    end

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

### Public Instance Methods

=== (other)
Source

    # File lib/prism/node.rb, line 17834
    def ===(other)
      other.is_a?(SourceFileNode) &&
        (flags === other.flags) &&
        (filepath === other.filepath)
    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 17756
    def accept(visitor)
      visitor.visit_source_file_node(self)
    end

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

child_nodes ()
Source

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

def `child_nodes`: () -> Array

Also aliased as: deconstruct
comment_targets ()
Source

    # File lib/prism/node.rb, line 17777
    def comment_targets
      [] #: Array[Prism::node | Location]
    end

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

compact_child_nodes ()
Source

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

def `compact_child_nodes`: () -> Array

copy (node_id: self.node_id, location: self.location, flags: self.flags, filepath: self.filepath)
Source

    # File lib/prism/node.rb, line 17782
    def copy(node_id: self.node_id, location: self.location, flags: self.flags, filepath: self.filepath)
      SourceFileNode.new(source, node_id, location, flags, filepath)
    end

def copy: (?node_id: `Integer`, ?location: `Location`, ?flags: `Integer`, ?filepath: `String`) -> `SourceFileNode`

deconstruct ()

def deconstruct: () -> Array

Alias for: child_nodes
deconstruct_keys (keys)
Source

    # File lib/prism/node.rb, line 17790
    def deconstruct_keys(keys)
      { node_id: node_id, location: location, filepath: filepath }
    end

def `deconstruct_keys`: (Array keys) -> { node_id: `Integer`, location: `Location`, filepath: `String` }

each_child_node ()
Source

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

    end

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

forced_binary_encoding? ()
Source

    # File lib/prism/node.rb, line 17800
    def forced_binary_encoding?
      flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
    end

def forced_binary_encoding?: () -> bool

forced_utf8_encoding? ()
Source

    # File lib/prism/node.rb, line 17795
    def forced_utf8_encoding?
      flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
    end

def forced_utf8_encoding?: () -> bool

frozen? ()
Source

    # File lib/prism/node.rb, line 17805
    def frozen?
      flags.anybits?(StringFlags::FROZEN)
    end

def frozen?: () -> bool

inspect ()
Source

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

def inspect -> `String`

mutable? ()
Source

    # File lib/prism/node.rb, line 17810
    def mutable?
      flags.anybits?(StringFlags::MUTABLE)
    end

def mutable?: () -> bool

type ()
Source

    # File lib/prism/node.rb, line 17823
    def type
      :source_file_node
    end

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