class Prism::SourceFileNode

Represents the use of the ‘__FILE__` keyword.




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


protected attr_reader flags: Integer

Public Class Methods

new(source, flags, filepath, location) click to toggle source

def initialize: (Integer flags, String filepath, Location location) -> void

# File prism/node.rb, line 17009
def initialize(source, flags, filepath, location)
  @source = source
  @location = location
  @flags = flags
  @filepath = filepath
type() click to toggle source

Similar to type, this method returns a symbol that you can use for splitting on the type of the node without having to do a long === chain. Note that like type, it will still be slower than using == for a single class, but should be faster in a case statement or an array comparison.

def self.type: () -> Symbol

# File prism/node.rb, line 17105
def self.type

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 17111
def ===(other)
  other.is_a?(SourceFileNode) &&
    (flags === other.flags) &&
    (filepath === other.filepath)
accept(visitor) click to toggle source

def accept: (Visitor visitor) -> void

# File prism/node.rb, line 17017
def accept(visitor)
child_nodes() click to toggle source

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

# File prism/node.rb, line 17022
def child_nodes
Also aliased as: deconstruct
comment_targets() click to toggle source

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

# File prism/node.rb, line 17032
def comment_targets
  [] #: Array[Prism::node | Location]
compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

# File prism/node.rb, line 17027
def compact_child_nodes
copy(flags: self.flags, filepath: self.filepath, location: self.location) click to toggle source

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

# File prism/node.rb, line 17037
def copy(flags: self.flags, filepath: self.filepath, location: self.location), flags, filepath, location)

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

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

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

# File prism/node.rb, line 17045
def deconstruct_keys(keys)
  { flags: flags, filepath: filepath, location: location }
forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

# File prism/node.rb, line 17062
def forced_binary_encoding?
forced_utf8_encoding?() click to toggle source

def forced_utf8_encoding?: () -> bool

# File prism/node.rb, line 17057
def forced_utf8_encoding?
frozen?() click to toggle source

def frozen?: () -> bool

# File prism/node.rb, line 17067
def frozen?
inspect() click to toggle source

def inspect -> String

# File prism/node.rb, line 17077
def inspect
mutable?() click to toggle source

def mutable?: () -> bool

# File prism/node.rb, line 17072
def mutable?
type() click to toggle source

Sometimes you want to check an instance of a node against a list of classes to see what kind of behavior to perform. Usually this is done by calling ‘[cls1, cls2].include?(node.class)` or putting the node into a case statement and doing `case node; when cls1; when cls2; end`. Both of these approaches are relatively slow because of the constant lookups, method calls, and/or array allocations.

Instead, you can call type, which will return to you a symbol that you can use for comparison. This is faster than the other approaches because it uses a single integer comparison, but also because if you’re on CRuby you can take advantage of the fact that case statements with all symbol keys will use a jump table.

def type: () -> Symbol

# File prism/node.rb, line 17095
def type