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.



16749
16750
16751
16752
16753
16754
16755
 
# File 'lib/prism/node.rb', line 16749

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.



16811
16812
16813
 
# File 'lib/prism/node.rb', line 16811

def filepath
  @filepath
end

Class Method Details

.type ⇒ Object

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



16824
16825
16826
 
# File 'lib/prism/node.rb', line 16824

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.



16830
16831
16832
16833
16834
 
# File 'lib/prism/node.rb', line 16830

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



16758
16759
16760
 
# File 'lib/prism/node.rb', line 16758

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



16763
16764
16765
 
# File 'lib/prism/node.rb', line 16763

def child_nodes
  []
end

#comment_targets ⇒ Object

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



16773
16774
16775
 
# File 'lib/prism/node.rb', line 16773

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



16768
16769
16770
 
# File 'lib/prism/node.rb', line 16768

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



16778
16779
16780
 
# File 'lib/prism/node.rb', line 16778

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 }



16786
16787
16788
 
# File 'lib/prism/node.rb', line 16786

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

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool

Returns:

  • (Boolean) 


16796
16797
16798
 
# File 'lib/prism/node.rb', line 16796

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool

Returns:

  • (Boolean) 


16791
16792
16793
 
# File 'lib/prism/node.rb', line 16791

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

#frozen? ⇒ Boolean

def frozen?: () -> bool

Returns:

  • (Boolean) 


16801
16802
16803
 
# File 'lib/prism/node.rb', line 16801

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

#inspect ⇒ Object

def inspect -> String



16814
16815
16816
 
# File 'lib/prism/node.rb', line 16814

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool

Returns:

  • (Boolean) 


16806
16807
16808
 
# File 'lib/prism/node.rb', line 16806

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

#type ⇒ Object

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



16819
16820
16821
 
# File 'lib/prism/node.rb', line 16819

def type
  :source_file_node
end