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

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

Initialize a new `SourceFileNode` node.

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

type() click to toggle source

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

    # File prism/node.rb, line 16584
    def self.type
      :source_file_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 16590
    def ===(other)
      other.is_a?(SourceFileNode) &&
        (flags === other.flags) &&
        (filepath === other.filepath)
    end

accept(visitor) click to toggle source

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

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

child_nodes() click to toggle source

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

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

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

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

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

compact_child_nodes() click to toggle source

def `compact_child_nodes`: () -> Array

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

copy(node_id: self.node_id, location: self.location, flags: self.flags, filepath: self.filepath) click to toggle source

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

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

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`, filepath: String }

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

forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

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

forced_utf8_encoding?() click to toggle source

def forced_utf8_encoding?: () -> bool

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

frozen?() click to toggle source

def frozen?: () -> bool

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

inspect() click to toggle source

def inspect -> String

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

mutable?() click to toggle source

def mutable?: () -> bool

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

type() click to toggle source

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

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