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.



17755
17756
17757
17758
17759
17760
17761
 
# File 'lib/prism/node.rb', line 17755

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.



17823
17824
17825
 
# File 'lib/prism/node.rb', line 17823

def filepath
  @filepath
end

Class Method Details

.type ⇒ Object

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



17836
17837
17838
 
# File 'lib/prism/node.rb', line 17836

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.



17842
17843
17844
17845
17846
 
# File 'lib/prism/node.rb', line 17842

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

#accept(visitor) ⇒ Object

def accept: (Visitor visitor) -> void



17764
17765
17766
 
# File 'lib/prism/node.rb', line 17764

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

#child_nodes ⇒ Object Also known as: deconstruct

def child_nodes: () -> Array



17769
17770
17771
 
# File 'lib/prism/node.rb', line 17769

def child_nodes
  []
end

#comment_targets ⇒ Object

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



17785
17786
17787
 
# File 'lib/prism/node.rb', line 17785

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

#compact_child_nodes ⇒ Object

def compact_child_nodes: () -> Array



17780
17781
17782
 
# File 'lib/prism/node.rb', line 17780

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



17790
17791
17792
 
# File 'lib/prism/node.rb', line 17790

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 }



17798
17799
17800
 
# File 'lib/prism/node.rb', line 17798

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

#each_child_node ⇒ Object

def each_child_node: () { (Prism::node) -> void } -> void | () -> Enumerator



17774
17775
17776
17777
 
# File 'lib/prism/node.rb', line 17774

def each_child_node
  return to_enum(:each_child_node) unless block_given?

end

#forced_binary_encoding? ⇒ Boolean

def forced_binary_encoding?: () -> bool



17808
17809
17810
 
# File 'lib/prism/node.rb', line 17808

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

#forced_utf8_encoding? ⇒ Boolean

def forced_utf8_encoding?: () -> bool



17803
17804
17805
 
# File 'lib/prism/node.rb', line 17803

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

#frozen? ⇒ Boolean

def frozen?: () -> bool



17813
17814
17815
 
# File 'lib/prism/node.rb', line 17813

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

#inspect ⇒ Object

def inspect -> String



17826
17827
17828
 
# File 'lib/prism/node.rb', line 17826

def inspect
  InspectVisitor.compose(self)
end

#mutable? ⇒ Boolean

def mutable?: () -> bool



17818
17819
17820
 
# File 'lib/prism/node.rb', line 17818

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

#type ⇒ Object

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



17831
17832
17833
 
# File 'lib/prism/node.rb', line 17831

def type
  :source_file_node
end