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(source, node_id, location, flags, filepath) ⇒ SourceFileNode

Initialize a new SourceFileNode node.



16509
16510
16511
16512
16513
16514
16515
 
# File 'lib/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

Instance Attribute Details

#filepath ⇒ Object (readonly)

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



16571
16572
16573
 
# File 'lib/prism/node.rb', line 16571

def filepath
  @filepath
end

Class Method Details

.type ⇒ Object

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



16584
16585
16586
 
# File 'lib/prism/node.rb', line 16584

def self.type
  :source_file_node
end

Instance Method Details

#===(other) ⇒ Object

Implements case-equality for the node. This is effectively == but without comparing the value of locations. Locations are checked only for presence.



16590
16591
16592
16593
16594
 
# File 'lib/prism/node.rb', line 16590

def ===(other)
  other.is_a?(SourceFileNode) &&
    (flags === other.flags) &&
    (filepath === other.filepath)
end

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



16518
16519
16520
 
# File 'lib/prism/node.rb', line 16518

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

#child_nodes ⇒ Object Also known as: deconstruct

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



16523
16524
16525
 
# File 'lib/prism/node.rb', line 16523

def child_nodes
  []
end

#comment_targets ⇒ Object

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



16533
16534
16535
 
# File 'lib/prism/node.rb', line 16533

def comment_targets
  [] #: Array[Prism::node | Location]
end

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16528
16529
16530
 
# File 'lib/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) ⇒ Object

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



16538
16539
16540
 
# File 'lib/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_keys(keys) ⇒ Object

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



16546
16547
16548
 
# File 'lib/prism/node.rb', line 16546

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


16556
16557
16558
 
# File 'lib/prism/node.rb', line 16556

def forced_binary_encoding?
  flags.anybits?(StringFlags::FORCED_BINARY_ENCODING)
end

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


16551
16552
16553
 
# File 'lib/prism/node.rb', line 16551

def forced_utf8_encoding?
  flags.anybits?(StringFlags::FORCED_UTF8_ENCODING)
end

#frozen? ⇒ Boolean

def frozen?: () -> bool

Returns:

  • (Boolean) 


16561
16562
16563
 
# File 'lib/prism/node.rb', line 16561

def frozen?
  flags.anybits?(StringFlags::FROZEN)
end

#inspect ⇒ Object

def inspect -> String



16574
16575
16576
 
# File 'lib/prism/node.rb', line 16574

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool

Returns:

  • (Boolean) 


16566
16567
16568
 
# File 'lib/prism/node.rb', line 16566

def mutable?
  flags.anybits?(StringFlags::MUTABLE)
end

#type ⇒ Object

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



16579
16580
16581
 
# File 'lib/prism/node.rb', line 16579

def type
  :source_file_node
end