Class: Prism::Translation::Parser

Inherits:
Parser::Base
  • Object
show all
Defined in:
lib/prism/translation/parser.rb,
lib/prism/translation/parser/lexer.rb,
lib/prism/translation/parser/builder.rb,
lib/prism/translation/parser/compiler.rb

Overview

This class is the entry-point for converting a prism syntax tree into the whitequark/parser gem’s syntax tree. It inherits from the base parser for the parser gem, and overrides the parse* methods to parse with prism and then translate.

Direct Known Subclasses

Parser33, Parser34, Parser35

Defined Under Namespace

Classes: Builder, Compiler, PrismDiagnostic

Constant Summary collapse

Racc_debug_parser =

:nodoc:

false

Instance Method Summary collapse

Constructor Details

#initialize(builder = Prism::Translation::Parser::Builder.new, parser: Prism) ⇒ Parser

The ‘builder` argument is used to create the parser using our custom builder class by default.

By using the ‘:parser` keyword argument, you can translate in a way that is compatible with the Parser gem using any parser.

For example, in RuboCop for Ruby LSP, the following approach can be used to improve performance by reusing a pre-parsed ‘Prism::ParseLexResult`:

class PrismPreparsed
  def initialize(prism_result)
    @prism_result = prism_result
  end

  def parse_lex(source, **options)
    @prism_result
  end
end

prism_preparsed = PrismPreparsed.new(prism_result)

Prism::Translation::Ruby34.new(builder, parser: prism_preparsed)

In an object passed to the ‘:parser` keyword argument, the `parse` and `parse_lex` methods should be implemented as needed.



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/prism/translation/parser.rb', line 67

def initialize(builder = Prism::Translation::Parser::Builder.new, parser: Prism)
  if !builder.is_a?(Prism::Translation::Parser::Builder)
    warn(<<~MSG, uplevel: 1, category: :deprecated)
      [deprecation]: The builder passed to `Prism::Translation::Parser.new` is not a \
      `Prism::Translation::Parser::Builder` subclass. This will raise in the next major version.
    MSG
  end
  @parser = parser

  super(builder)
end

Instance Method Details

#default_encoding ⇒ Object

The default encoding for Ruby files is UTF-8.



84
85
86
 
# File 'lib/prism/translation/parser.rb', line 84

def default_encoding
  Encoding::UTF_8
end

#parse(source_buffer) ⇒ Object

Parses a source buffer and returns the AST.



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/prism/translation/parser.rb', line 92

def parse(source_buffer)
  @source_buffer = source_buffer
  source = source_buffer.source

  offset_cache = build_offset_cache(source)
  result = unwrap(@parser.parse(source, **prism_options), offset_cache)

  build_ast(result.value, offset_cache)
ensure
  @source_buffer = nil
end

#parse_with_comments(source_buffer) ⇒ Object

Parses a source buffer and returns the AST and the source code comments.



105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/prism/translation/parser.rb', line 105

def parse_with_comments(source_buffer)
  @source_buffer = source_buffer
  source = source_buffer.source

  offset_cache = build_offset_cache(source)
  result = unwrap(@parser.parse(source, **prism_options), offset_cache)

  [
    build_ast(result.value, offset_cache),
    build_comments(result.comments, offset_cache)
  ]
ensure
  @source_buffer = nil
end

#tokenize(source_buffer, recover = false) ⇒ Object

Parses a source buffer and returns the AST, the source code comments, and the tokens emitted by the lexer.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/prism/translation/parser.rb', line 122

def tokenize(source_buffer, recover = false)
  @source_buffer = source_buffer
  source = source_buffer.source

  offset_cache = build_offset_cache(source)
  result =
    begin
      unwrap(@parser.parse_lex(source, **prism_options), offset_cache)
    rescue ::Parser::SyntaxError
      raise if !recover
    end

  program, tokens = result.value
  ast = build_ast(program, offset_cache) if result.success?

  [
    ast,
    build_comments(result.comments, offset_cache),
    build_tokens(tokens, offset_cache)
  ]
ensure
  @source_buffer = nil
end

#try_declare_numparam(node) ⇒ Object

Since prism resolves num params for us, we don’t need to support this kind of logic here.



148
149
150
 
# File 'lib/prism/translation/parser.rb', line 148

def try_declare_numparam(node)
  node.children[0].match?(/\A_[1-9]\z/)
end

#version ⇒ Object

:nodoc:



79
80
81
 
# File 'lib/prism/translation/parser.rb', line 79

def version # :nodoc:
  34
end

#yyerror ⇒ Object

:nodoc:



88
89
 
# File 'lib/prism/translation/parser.rb', line 88

def yyerror # :nodoc:
end