Represents the use of the ‘__FILE__` keyword.
__FILE__ ^^^^^^^^
Represents the file path being parsed. This corresponds directly to the ‘filepath` option given to the various `Prism::parse*` APIs.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17009
def initialize(source, flags, filepath, location)
@source = source
@location = location
@flags = flags
@filepath = filepath
end
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17105
def self.type
:source_file_node
end
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 tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17111
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.
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17017
def accept(visitor)
visitor.visit_source_file_node(self)
end
def accept: (Visitor visitor) -> void
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17022
def child_nodes
[]
end
def child_nodes: () -> Array[nil | Node]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17032
def comment_targets
[] #: Array[Prism::node | Location]
end
def comment_targets: () -> Array[Node | Location]
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17027
def compact_child_nodes
[]
end
def compact_child_nodes: () -> Array
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17037
def copy(flags: self.flags, filepath: self.filepath, location: self.location)
SourceFileNode.new(source, flags, filepath, location)
end
def copy: (?flags: Integer, ?filepath: String, ?location: Location) -> SourceFileNode
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17045
def deconstruct_keys(keys)
{ flags: flags, filepath: filepath, location: location }
end
def deconstruct_keys: (Array keys) -> { flags: Integer, filepath: String, location: Location }
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17062
def forced_binary_encoding?
flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
end
def forced_binary_encoding?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17057
def forced_utf8_encoding?
flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
end
def forced_utf8_encoding?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17067
def frozen?
flags.anybits?(StringFlags::FROZEN)
end
def frozen?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17077
def inspect
InspectVisitor.compose(self)
end
def inspect -> String
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17072
def mutable?
flags.anybits?(StringFlags::MUTABLE)
end
def mutable?: () -> bool
# File tmp/rubies/ruby-3.4.0-preview1/lib/prism/node.rb, line 17095
def type
:source_file_node
end
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