Class: Prism::SourceFileNode

Inherits:
PrismNode
  • Object
show all
Defined in:
lib/prism/node.rb,
ext/prism/api_node.c

Overview

Represents the use of the ‘__FILE__` keyword.

__FILE__
^^^^^^^^

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filepath, location) ⇒ SourceFileNode

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



15507
15508
15509
15510
 
# File 'lib/prism/node.rb', line 15507

def initialize(filepath, location)
  @filepath = filepath
  @location = location
end

Instance Attribute Details

#filepath ⇒ Object (readonly)

attr_reader filepath: String



15504
15505
15506
 
# File 'lib/prism/node.rb', line 15504

def filepath
  @filepath
end

Class Method Details

.type ⇒ Object

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



15579
15580
15581
 
# File 'lib/prism/node.rb', line 15579

def self.type
  :source_file_node
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



15513
15514
15515
 
# File 'lib/prism/node.rb', line 15513

def accept(visitor)
  visitor.visit_source_file_node(self)
end

#child_nodes ⇒ Object Also known as: deconstruct

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



15518
15519
15520
 
# File 'lib/prism/node.rb', line 15518

def child_nodes
  []
end

#comment_targets ⇒ Object

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



15528
15529
15530
 
# File 'lib/prism/node.rb', line 15528

def comment_targets
  []
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



15523
15524
15525
 
# File 'lib/prism/node.rb', line 15523

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> SourceFileNode



15533
15534
15535
15536
15537
15538
 
# File 'lib/prism/node.rb', line 15533

def copy(**params)
  SourceFileNode.new(
    params.fetch(:filepath) { filepath },
    params.fetch(:location) { location },
  )
end

#deconstruct_keys(keys) ⇒ Object

def deconstruct_keys: (keys: Array) -> Hash[Symbol, nil | Node | Array | String | Token | Array | Location]



15544
15545
15546
 
# File 'lib/prism/node.rb', line 15544

def deconstruct_keys(keys)
  { filepath: filepath, location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object

def inspect(inspector: NodeInspector) -> String



15549
15550
15551
15552
15553
 
# File 'lib/prism/node.rb', line 15549

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector << "└── filepath: #{filepath.inspect}\n"
  inspector.to_str
end

#type ⇒ Object

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



15569
15570
15571
 
# File 'lib/prism/node.rb', line 15569

def type
  :source_file_node
end