class Prism::Node
This represents a node in the tree. It is the parent class of all of the various node types.
Attributes
A pointer to the source that this node was created from.
Public Class Methods
Returns a list of the fields that exist for this node class. Fields describe the structure of the node. This kind of reflection is useful for things like recursively visiting each node and field in the tree.
# File lib/prism/node.rb, line 81 def self.fields # This method should only be called on subclasses of Node, not Node # itself. raise NoMethodError, "undefined method `fields' for #{inspect}" if self == Node Reflection.fields_for(self) end
Public Instance Methods
The end offset of the node in the source. This method is effectively a delegate method to the location object.
# File lib/prism/node.rb, line 34 def end_offset location = @location location.is_a?(Location) ? location.end_offset : ((location >> 32) + (location & 0xFFFFFFFF)) end
A Location
instance that represents the location of this node in the source.
# File lib/prism/node.rb, line 19 def location location = @location return location if location.is_a?(Location) @location = Location.new(source, location >> 32, location & 0xFFFFFFFF) end
Similar to inspect, but respects the current level of indentation given by the pretty print object.
# File lib/prism/node.rb, line 65 def pretty_print(q) q.seplist(inspect.chomp.each_line, -> { q.breakable }) do |line| q.text(line.chomp) end q.current_group.break end
Slice the location of the node from the source.
# File lib/prism/node.rb, line 52 def slice location.slice end
Slice the location of the node from the source, starting at the beginning of the line that the location starts on, ending at the end of the line that the location ends on.
# File lib/prism/node.rb, line 59 def slice_lines location.slice_lines end
The start offset of the node in the source. This method is effectively a delegate method to the location object.
# File lib/prism/node.rb, line 27 def start_offset location = @location location.is_a?(Location) ? location.start_offset : location >> 32 end
Convert this node into a graphviz dot graph string.
# File lib/prism/node.rb, line 73 def to_dot # @type self: node DotVisitor.new.tap { |visitor| accept(visitor) }.to_dot end
Node interface
↑ topPublic Class Methods
Returns the type of the node as a symbol.
# File lib/prism/node.rb, line 133 def self.type raise NoMethodError, "undefined method `type' for #{inspect}" end
Public Instance Methods
Accepts a visitor and calls back into the specialized visit function.
# File lib/prism/node.rb, line 97 def accept(visitor) raise NoMethodError, "undefined method `accept' for #{inspect}" end
Returns an array of child nodes, including ‘nil`s in the place of optional nodes that were not present.
# File lib/prism/node.rb, line 103 def child_nodes raise NoMethodError, "undefined method `child_nodes' for #{inspect}" end
Returns an array of child nodes and locations that could potentially have comments attached to them.
# File lib/prism/node.rb, line 117 def comment_targets raise NoMethodError, "undefined method `comment_targets' for #{inspect}" end
Returns an array of child nodes, excluding any ‘nil`s in the place of optional nodes that were not present.
# File lib/prism/node.rb, line 111 def compact_child_nodes raise NoMethodError, "undefined method `compact_child_nodes' for #{inspect}" end
Returns a string representation of the node.
# File lib/prism/node.rb, line 128 def inspect raise NoMethodError, "undefined method `inspect' for #{inspect}" end
Returns a symbol symbolizing the type of node that this represents. This is particularly useful for case statements and array comparisons.
# File lib/prism/node.rb, line 123 def type raise NoMethodError, "undefined method `type' for #{inspect}" end