class Prism::ParseResult
This represents the result of a call to ::parse or ::parse_file. It contains the AST, any comments that were encounters, and any errors that were encountered.
Attributes
The list of comments that were encountered during parsing.
An optional location that represents the location of the __END__ marker and the rest of the content of the file. This content is loaded into the DATA constant when the file being parsed is the main file being executed.
The list of errors that were generated during parsing.
The list of magic comments that were encountered during parsing.
A Source
instance that represents the source code that was parsed.
The value that was generated by parsing. Normally this holds the AST, but it can sometimes how a list of tokens or other results passed back from the parser.
The list of warnings that were generated during parsing.
Public Class Methods
Create a new parse result object with the given values.
# File lib/prism/parse_result.rb, line 470 def initialize(value, comments, magic_comments, data_loc, errors, warnings, source) @value = value @comments = comments @magic_comments = magic_comments @data_loc = data_loc @errors = errors @warnings = warnings @source = source end
Public Instance Methods
Attach the list of comments to their respective locations in the tree.
# File lib/prism/parse_result/comments.rb, line 190 def attach_comments! Comments.new(self).attach! # steep:ignore end
Implement the hash pattern matching interface for ParseResult
.
# File lib/prism/parse_result.rb, line 481 def deconstruct_keys(keys) { value: value, comments: comments, magic_comments: magic_comments, data_loc: data_loc, errors: errors, warnings: warnings } end
Returns the encoding of the source code that was parsed.
# File lib/prism/parse_result.rb, line 486 def encoding source.encoding end
Returns true if there were errors during parsing and false if there were not.
# File lib/prism/parse_result.rb, line 498 def failure? !success? end
Walk the tree and mark nodes that are on a new line.
# File lib/prism/parse_result/newlines.rb, line 60 def mark_newlines! value = self.value raise "This method should only be called on a parse result that contains a node" unless Node === value value.accept(Newlines.new(Array.new(1 + source.offsets.size, false))) # steep:ignore end
Returns true if there were no errors during parsing and false if there were.
# File lib/prism/parse_result.rb, line 492 def success? errors.empty? end