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.

flags[R]

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 lib/prism/node.rb, line 17134
def initialize(source, flags, filepath, location)
  @source = source
  @newline = false
  @location = location
  @flags = flags
  @filepath = filepath
end

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 lib/prism/node.rb, line 17231
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 lib/prism/node.rb, line 17237
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 lib/prism/node.rb, line 17143
def accept(visitor)
  visitor.visit_source_file_node(self)
end

child_nodes() click to toggle source

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

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

Also aliased as: deconstruct

comment_targets() click to toggle source

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

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

compact_child_nodes() click to toggle source

def compact_child_nodes: () -> Array

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

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

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

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

deconstruct()

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 lib/prism/node.rb, line 17171
def deconstruct_keys(keys)
  { flags: flags, filepath: filepath, location: location }
end

forced_binary_encoding?() click to toggle source

def forced_binary_encoding?: () -> bool

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

forced_utf8_encoding?() click to toggle source

def forced_utf8_encoding?: () -> bool

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

frozen?() click to toggle source

def frozen?: () -> bool

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

inspect() click to toggle source

def inspect -> String

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

mutable?() click to toggle source

def mutable?: () -> bool

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

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 lib/prism/node.rb, line 17221
def type
  :source_file_node
end