模块 Prism
Prism
Ruby 解析器。
“解析 Ruby 突然变得可管理了!”
- You, hopefully
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/compiler.rb.erb
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/dispatcher.rb.erb
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/dsl.rb.erb
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/inspect_visitor.rb.erb
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/mutation_compiler.rb.erb
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/node.rb.erb
这里我们重新打开 prism 模块,以便在不属于模板且旨在作为便利方法提供的节点上提供方法。
typed: ignore
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/reflection.rb.erb
此文件由 templates/template.rb 脚本生成,不应手动修改。 如果您想修改模板,请参阅 templates/lib/prism/visitor.rb.erb
常量
- BACKEND
C 扩展是 CRuby 上的默认后端。
- VERSION
版本常量通过读取调用 pm_version 的结果来设置。
公共类方法
通过使用序列化 API 来镜像 Prism.dump
API。
# File prism/ffi.rb, line 229 def dump(source, **options) LibRubyParser::PrismString.with_string(source) { |string| dump_common(string, options) } end
通过使用序列化 API 来镜像 Prism.dump_file
API。
# File prism/ffi.rb, line 234 def dump_file(filepath, **options) options[:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| dump_common(string, options) } end
通过使用序列化 API 来镜像 Prism.lex
API。
# File prism/ffi.rb, line 240 def lex(code, **options) LibRubyParser::PrismString.with_string(code) { |string| lex_common(string, code, options) } end
返回一个解析结果,其值是一个标记数组,该数组与 Ripper::lex
的返回值非常相似。 主要区别在于不发出 ‘:on_sp` 标记。
有关支持的选项,请参阅 Prism::parse
。
# File prism.rb, line 47 def self.lex_compat(source, **options) LexCompat.new(source, **options).result # steep:ignore end
通过使用序列化 API 来镜像 Prism.lex_file
API。
# File prism/ffi.rb, line 245 def lex_file(filepath, **options) options[:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| lex_common(string, string.read, options) } end
这使用 Ripper
词法分析器进行词法分析。 它会丢弃任何空格事件,否则返回相同的标记。 如果源中的语法无效,则引发 SyntaxError。
# File prism.rb, line 57 def self.lex_ripper(source) LexRipper.new(source).result # steep:ignore end
使用源作为树中的引用加载序列化的 AST。
# File prism.rb, line 65 def self.load(source, serialized) Serialize.load(source, serialized) end
通过使用序列化 API 来镜像 Prism.parse
API。
# File prism/ffi.rb, line 251 def parse(code, **options) LibRubyParser::PrismString.with_string(code) { |string| parse_common(string, code, options) } end
通过使用序列化 API 来镜像 Prism.parse_comments
API。
# File prism/ffi.rb, line 287 def parse_comments(code, **options) LibRubyParser::PrismString.with_string(code) { |string| parse_comments_common(string, code, options) } end
通过使用序列化 API 来镜像 Prism.parse_failure?
API。
# File prism/ffi.rb, line 316 def parse_failure?(code, **options) !parse_success?(code, **options) end
通过使用序列化 API 来镜像 Prism.parse_file
API。 这使用原生字符串而不是 Ruby 字符串,因为它允许我们在可用时使用 mmap。
# File prism/ffi.rb, line 258 def parse_file(filepath, **options) options[:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_common(string, string.read, options) } end
通过使用序列化 API 来镜像 Prism.parse_file_comments
API。 这使用原生字符串而不是 Ruby 字符串,因为它允许我们在可用时使用 mmap。
# File prism/ffi.rb, line 294 def parse_file_comments(filepath, **options) options[:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_comments_common(string, string.read, options) } end
通过使用序列化 API 来镜像 Prism.parse_file_failure?
API。
# File prism/ffi.rb, line 327 def parse_file_failure?(filepath, **options) !parse_file_success?(filepath, **options) end
通过使用序列化 API 来镜像 Prism.parse_file_success?
API。
# File prism/ffi.rb, line 321 def parse_file_success?(filepath, **options) options[:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_file_success_common(string, options) } end
通过使用序列化 API 来镜像 Prism.parse_lex
API。
# File prism/ffi.rb, line 300 def parse_lex(code, **options) LibRubyParser::PrismString.with_string(code) { |string| parse_lex_common(string, code, options) } end
通过使用序列化 API 来镜像 Prism.parse_lex_file
API。
# File prism/ffi.rb, line 305 def parse_lex_file(filepath, **options) options[:filepath] = filepath LibRubyParser::PrismString.with_file(filepath) { |string| parse_lex_common(string, string.read, options) } end
通过使用序列化 API 来镜像 Prism.parse_stream
API。
# File prism/ffi.rb, line 264 def parse_stream(stream, **options) 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 } # 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, dump_options(options)) Prism.load(source, buffer.read) end end
通过使用序列化 API 来镜像 Prism.parse_success?
API。
# File prism/ffi.rb, line 311 def parse_success?(code, **options) LibRubyParser::PrismString.with_string(code) { |string| parse_file_success_common(string, options) } end
通过使用序列化 API 来镜像 Prism.profile
API。
# File prism/ffi.rb, line 332 def profile(source, **options) LibRubyParser::PrismString.with_string(source) do |string| LibRubyParser::PrismBuffer.with do |buffer| LibRubyParser.pm_serialize_parse(buffer.pointer, string.pointer, string.length, dump_options(options)) nil end end end
通过使用序列化 API 来镜像 Prism.profile_file
API。
# File prism/ffi.rb, line 342 def profile_file(filepath, **options) LibRubyParser::PrismString.with_file(filepath) do |string| LibRubyParser::PrismBuffer.with do |buffer| options[:filepath] = filepath LibRubyParser.pm_serialize_parse(buffer.pointer, string.pointer, string.length, dump_options(options)) nil end end end
私有类方法
将给定的选项转换为序列化选项字符串。
# File prism/ffi.rb, line 441 def dump_options(options) template = +"" values = [] template << "L" if (filepath = options[:filepath]) values.push(filepath.bytesize, filepath.b) template << "A*" else values << 0 end template << "l" values << options.fetch(:line, 1) template << "L" if (encoding = options[:encoding]) name = encoding.is_a?(Encoding) ? encoding.name : encoding values.push(name.bytesize, name.b) template << "A*" else values << 0 end template << "C" values << (options.fetch(:frozen_string_literal, false) ? 1 : 0) template << "C" values << dump_options_command_line(options) template << "C" values << dump_options_version(options[:version]) template << "C" values << (options[:encoding] == false ? 1 : 0) template << "C" values << (options.fetch(:main_script, false) ? 1 : 0) template << "C" values << (options.fetch(:partial_script, false) ? 1 : 0) template << "L" if (scopes = options[:scopes]) values << scopes.length scopes.each do |scope| template << "L" values << scope.length scope.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
返回应为 command_line 选项转储的值。
# File prism/ffi.rb, line 409 def dump_options_command_line(options) command_line = options.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
返回应为 version 选项转储的值。
# File prism/ffi.rb, line 427 def dump_options_version(version) case version when nil, "latest" 0 when /\A3\.3(\.\d+)?\z/ 1 when /\A3\.4(\.\d+)?\z/ 0 else raise ArgumentError, "invalid version: #{version}" end end