Module: Prism
Overview
The Prism Ruby parser.
“Parsing Ruby is suddenly manageable!”
- You, hopefully
Constant Summary
-
BACKEND =
# File 'lib/prism.rb', line 103
The FFI backend is used on other Ruby implementations.
:FFI
-
VERSION =
# File 'lib/prism/ffi.rb', line 234
The version constant is set by reading the result of calling pm_version.
LibRubyParser.pm_version.read_string.freeze
Class Method Summary
-
.dump(source, **options)
Mirror the
dumpAPI by using the serialization API. -
.dump_file(filepath, **options)
Mirror the
dump_fileAPI by using the serialization API. -
.lex(code, **options)
Mirror the
lexAPI by using the serialization API. -
.lex_compat(source, **options) ⇒ LexCompat::Result
Returns a parse result whose value is an array of tokens that closely resembles the return value of
Ripper.lex. -
.lex_file(filepath, **options)
Mirror the
lex_fileAPI by using the serialization API. -
.lex_ripper(source) ⇒ Array
This lexes with the Ripper lex.
-
.load(source, serialized, freeze) ⇒ ParseResult
Load the serialized AST using the source as a reference into a tree.
-
.parse(code, **options)
Mirror the
parseAPI by using the serialization API. -
.parse_comments(code, **options)
Mirror the
parse_commentsAPI by using the serialization API. -
.parse_failure?(code, **options) ⇒ Boolean
Mirror the
parse_failure?API by using the serialization API. -
.parse_file(filepath, **options)
Mirror the
parse_fileAPI by using the serialization API. -
.parse_file_comments(filepath, **options)
Mirror the
parse_file_commentsAPI by using the serialization API. -
.parse_file_failure?(filepath, **options) ⇒ Boolean
Mirror the
parse_file_failure?API by using the serialization API. -
.parse_file_success?(filepath, **options) ⇒ Boolean
Mirror the
parse_file_success?API by using the serialization API. -
.parse_lex(code, **options)
Mirror the
parse_lexAPI by using the serialization API. -
.parse_lex_file(filepath, **options)
Mirror the
parse_lex_fileAPI by using the serialization API. -
.parse_stream(stream, **options)
Mirror the
parse_streamAPI by using the serialization API. -
.parse_success?(code, **options) ⇒ Boolean
Mirror the
parse_success?API by using the serialization API. -
.profile(source, **options)
Mirror the
profileAPI by using the serialization API. -
.profile_file(filepath, **options)
Mirror the
profile_fileAPI by using the serialization API. -
.scope(locals: [], forwarding: [])
Create a new scope with the given locals and forwarding options that is suitable for passing into one of the
Prism.*methods that accepts thescopesoption. -
.dump_options(options)
private
Convert the given options into a serialized options string.
-
.dump_options_command_line(options)
private
Return the value that should be dumped for the command_line option.
-
.dump_options_version(version)
private
Return the value that should be dumped for the version option.
- .dump_common(string, options) private Internal use only
- .lex_common(string, code, options) private Internal use only
- .parse_comments_common(string, code, options) private Internal use only
- .parse_common(string, code, options) private Internal use only
- .parse_file_success_common(string, options) private Internal use only
- .parse_lex_common(string, code, options) private Internal use only
Class Method Details
.dump(source, **options)
Mirror the dump API by using the serialization API.
# File 'lib/prism/ffi.rb', line 238
def dump(source, **) LibRubyParser::PrismString.with_string(source) { |string| dump_common(string, ) } end
.dump_common(string, options) (private)
# File 'lib/prism/ffi.rb', line 365
def dump_common(string, ) # :nodoc: LibRubyParser::PrismBuffer.with do |buffer| LibRubyParser.pm_serialize_parse(buffer.pointer, string.pointer, string.length, ()) dumped = buffer.read dumped.freeze if .fetch(:freeze, false) dumped end end
.dump_file(filepath, **options)
Mirror the dump_file API by using the serialization API.
# File 'lib/prism/ffi.rb', line 243
def dump_file(filepath, **) [:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| dump_common(string, ) } end
.dump_options(options) (private)
Convert the given options into a serialized options string.
# File 'lib/prism/ffi.rb', line 447
def () template = +"" values = [] template << "L" if (filepath = [:filepath]) values.push(filepath.bytesize, filepath.b) template << "A*" else values << 0 end template << "l" values << .fetch(:line, 1) template << "L" if (encoding = [:encoding]) name = encoding.is_a?(Encoding) ? encoding.name : encoding values.push(name.bytesize, name.b) template << "A*" else values << 0 end template << "C" values << (.fetch(:frozen_string_literal, false) ? 1 : 0) template << "C" values << () template << "C" values << ([:version]) template << "C" values << ([:encoding] == false ? 1 : 0) template << "C" values << (.fetch(:main_script, false) ? 1 : 0) template << "C" values << (.fetch(:partial_script, false) ? 1 : 0) template << "C" values << (.fetch(:freeze, false) ? 1 : 0) template << "L" if (scopes = [:scopes]) values << scopes.length scopes.each do |scope| locals = nil forwarding = 0 case scope when Array locals = scope when Scope locals = scope.locals scope.forwarding.each do |forward| case forward when :* then forwarding |= 0x1 when :** then forwarding |= 0x2 when :& then forwarding |= 0x4 when :"..." then forwarding |= 0x8 else raise ArgumentError, "invalid forwarding value: #{forward}" end end else raise TypeError, "wrong argument type #{scope.class.inspect} (expected Array or Prism::Scope)" end template << "L" values << locals.length template << "C" values << forwarding locals.each do |local| name = local.name template << "L" values << name.bytesize template << "A*" values << name.b end end else values << 0 end values.pack(template) end
.dump_options_command_line(options) (private)
Return the value that should be dumped for the command_line option.
# File 'lib/prism/ffi.rb', line 407
def () command_line = .fetch(:command_line, "") raise ArgumentError, "command_line must be a string" unless command_line.is_a?(String) command_line.each_char.inject(0) do |value, char| case char when "a" then value | 0b000001 when "e" then value | 0b000010 when "l" then value | 0b000100 when "n" then value | 0b001000 when "p" then value | 0b010000 when "x" then value | 0b100000 else raise ArgumentError, "invalid command_line option: #{char}" end end end
.dump_options_version(version) (private)
Return the value that should be dumped for the version option.
# File 'lib/prism/ffi.rb', line 425
def (version) current = version == "current" case current ? RUBY_VERSION : version when nil, "latest" 0 # Handled in pm_parser_init when /\A3\.3(\.\d+)?\z/ 1 when /\A3\.4(\.\d+)?\z/ 2 when /\A3\.5(\.\d+)?\z/ 3 else if current raise CurrentVersionError, RUBY_VERSION else raise ArgumentError, "invalid version: #{version}" end end end
.lex(code, **options)
Mirror the lex API by using the serialization API.
# File 'lib/prism/ffi.rb', line 249
def lex(code, **) LibRubyParser::PrismString.with_string(code) { |string| lex_common(string, code, ) } end
.lex_common(string, code, options) (private)
# File 'lib/prism/ffi.rb', line 376
def lex_common(string, code, ) # :nodoc: LibRubyParser::PrismBuffer.with do |buffer| LibRubyParser.pm_serialize_lex(buffer.pointer, string.pointer, string.length, ()) Serialize.load_lex(code, buffer.read, .fetch(:freeze, false)) end end
.lex_compat(source, **options) ⇒ LexCompat::Result
Returns a parse result whose value is an array of tokens that closely resembles the return value of Ripper.lex. The main difference is that the :on_sp token is not emitted.
For supported options, see .parse.
.lex_file(filepath, **options)
Mirror the lex_file API by using the serialization API.
# File 'lib/prism/ffi.rb', line 254
def lex_file(filepath, **) [:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| lex_common(string, string.read, ) } end
.lex_ripper(source) ⇒ Array
This lexes with the Ripper lex. It drops any space events but otherwise returns the same tokens. Raises SyntaxError if the syntax in source is invalid.
.load(source, serialized, freeze) ⇒ ParseResult
Load the serialized AST using the source as a reference into a tree.
# File 'lib/prism.rb', line 86
def self.load(source, serialized, freeze = false) Serialize.load_parse(source, serialized, freeze) end
.parse(code, **options)
Mirror the parse API by using the serialization API.
# File 'lib/prism/ffi.rb', line 260
def parse(code, **) LibRubyParser::PrismString.with_string(code) { |string| parse_common(string, code, ) } end
.parse_comments(code, **options)
Mirror the parse_comments API by using the serialization API.
# File 'lib/prism/ffi.rb', line 298
def parse_comments(code, **) LibRubyParser::PrismString.with_string(code) { |string| parse_comments_common(string, code, ) } end
.parse_comments_common(string, code, options) (private)
# File 'lib/prism/ffi.rb', line 388
def parse_comments_common(string, code, ) # :nodoc: LibRubyParser::PrismBuffer.with do |buffer| LibRubyParser.pm_serialize_parse_comments(buffer.pointer, string.pointer, string.length, ()) Serialize.load_parse_comments(code, buffer.read, .fetch(:freeze, false)) end end
.parse_common(string, code, options) (private)
# File 'lib/prism/ffi.rb', line 383
def parse_common(string, code, ) # :nodoc: serialized = dump_common(string, ) Serialize.load_parse(code, serialized, .fetch(:freeze, false)) end
.parse_failure?(code, **options) ⇒ Boolean
Mirror the parse_failure? API by using the serialization API.
# File 'lib/prism/ffi.rb', line 327
def parse_failure?(code, **) !parse_success?(code, **) end
.parse_file(filepath, **options)
Mirror the parse_file API by using the serialization API. This uses native strings instead of Ruby strings because it allows us to use mmap when it is available.
# File 'lib/prism/ffi.rb', line 267
def parse_file(filepath, **) [:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_common(string, string.read, ) } end
.parse_file_comments(filepath, **options)
Mirror the parse_file_comments API by using the serialization API. This uses native strings instead of Ruby strings because it allows us to use mmap when it is available.
# File 'lib/prism/ffi.rb', line 305
def parse_file_comments(filepath, **) [:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_comments_common(string, string.read, ) } end
.parse_file_failure?(filepath, **options) ⇒ Boolean
Mirror the parse_file_failure? API by using the serialization API.
# File 'lib/prism/ffi.rb', line 338
def parse_file_failure?(filepath, **) !parse_file_success?(filepath, **) end
.parse_file_success?(filepath, **options) ⇒ Boolean
Mirror the parse_file_success? API by using the serialization API.
# File 'lib/prism/ffi.rb', line 332
def parse_file_success?(filepath, **) [:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_file_success_common(string, ) } end
.parse_file_success_common(string, options) (private)
# File 'lib/prism/ffi.rb', line 402
def parse_file_success_common(string, ) # :nodoc: LibRubyParser.pm_parse_success_p(string.pointer, string.length, ()) end
.parse_lex(code, **options)
Mirror the parse_lex API by using the serialization API.
# File 'lib/prism/ffi.rb', line 311
def parse_lex(code, **) LibRubyParser::PrismString.with_string(code) { |string| parse_lex_common(string, code, ) } end
.parse_lex_common(string, code, options) (private)
# File 'lib/prism/ffi.rb', line 395
def parse_lex_common(string, code, ) # :nodoc: LibRubyParser::PrismBuffer.with do |buffer| LibRubyParser.pm_serialize_parse_lex(buffer.pointer, string.pointer, string.length, ()) Serialize.load_parse_lex(code, buffer.read, .fetch(:freeze, false)) end end
.parse_lex_file(filepath, **options)
Mirror the parse_lex_file API by using the serialization API.
# File 'lib/prism/ffi.rb', line 316
def parse_lex_file(filepath, **) [:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_lex_common(string, string.read, ) } end
.parse_stream(stream, **options)
Mirror the parse_stream API by using the serialization API.
# File 'lib/prism/ffi.rb', line 273
def parse_stream(stream, **) LibRubyParser::PrismBuffer.with do |buffer| source = +"" callback = -> (string, size, _) { raise "Expected size to be >= 0, got: #{size}" if size <= 0 if !(line = stream.gets(size - 1)).nil? source << line string.write_string("#{line}\x00", line.bytesize + 1) end } eof_callback = -> (_) { stream.eof? } # In the pm_serialize_parse_stream function it accepts a pointer to the # IO object as a void* and then passes it through to the callback as the # third argument, but it never touches it itself. As such, since we have # access to the IO object already through the closure of the lambda, we # can pass a null pointer here and not worry. LibRubyParser.pm_serialize_parse_stream(buffer.pointer, nil, callback, eof_callback, ()) Prism.load(source, buffer.read, .fetch(:freeze, false)) end end
.parse_success?(code, **options) ⇒ Boolean
Mirror the parse_success? API by using the serialization API.
# File 'lib/prism/ffi.rb', line 322
def parse_success?(code, **) LibRubyParser::PrismString.with_string(code) { |string| parse_file_success_common(string, ) } end
.profile(source, **options)
Mirror the profile API by using the serialization API.
# File 'lib/prism/ffi.rb', line 343
def profile(source, **) LibRubyParser::PrismString.with_string(source) do |string| LibRubyParser::PrismBuffer.with do |buffer| LibRubyParser.pm_serialize_parse(buffer.pointer, string.pointer, string.length, ()) nil end end end
.profile_file(filepath, **options)
Mirror the profile_file API by using the serialization API.
# File 'lib/prism/ffi.rb', line 353
def profile_file(filepath, **) LibRubyParser::PrismString.with_file(filepath) do |string| LibRubyParser::PrismBuffer.with do |buffer| [:filepath] = filepath LibRubyParser.pm_serialize_parse(buffer.pointer, string.pointer, string.length, ()) nil end end end
.scope(locals: [], forwarding: [])
Create a new scope with the given locals and forwarding options that is suitable for passing into one of the Prism.* methods that accepts the scopes option.