Class: Prism::SourceLineNode

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

Overview

Represents the use of the ‘__LINE__` keyword.

__LINE__
^^^^^^^^

Instance Method Summary collapse

Constructor Details

#initialize(location) ⇒ SourceLineNode

def initialize: (location: Location) -> void



12923
12924
12925
# File 'lib/prism/node.rb', line 12923

def initialize(location)
  @location = location
end

Instance Method Details

#accept(visitor) ⇒ Object

def accept: (visitor: Visitor) -> void



12928
12929
12930
# File 'lib/prism/node.rb', line 12928

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

#child_nodesObject Also known as: deconstruct

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



12933
12934
12935
# File 'lib/prism/node.rb', line 12933

def child_nodes
  []
end

#comment_targetsObject

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



12943
12944
12945
# File 'lib/prism/node.rb', line 12943

def comment_targets
  []
end

#compact_child_nodesObject

def compact_child_nodes: () -> Array



12938
12939
12940
# File 'lib/prism/node.rb', line 12938

def compact_child_nodes
  []
end

#copy(**params) ⇒ Object

def copy: (**params) -> SourceLineNode



12948
12949
12950
12951
12952
# File 'lib/prism/node.rb', line 12948

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

#deconstruct_keys(keys) ⇒ Object

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



12958
12959
12960
# File 'lib/prism/node.rb', line 12958

def deconstruct_keys(keys)
  { location: location }
end

#inspect(inspector = NodeInspector.new) ⇒ Object



12962
12963
12964
12965
# File 'lib/prism/node.rb', line 12962

def inspect(inspector = NodeInspector.new)
  inspector << inspector.header(self)
  inspector.to_str
end

#typeObject

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



12981
12982
12983
# File 'lib/prism/node.rb', line 12981

def type
  :source_line_node
end