The C extension is the default backend on CRuby.
The version of the prism library.
static VALUE
dump(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
#ifdef PRISM_BUILD_DEBUG
size_t length = pm_string_length(&input);
char* dup = xmalloc(length);
memcpy(dup, pm_string_source(&input), length);
pm_string_constant_init(&input, dup, length);
#endif
VALUE value = dump_input(&input, &options);
if (options.freeze) rb_obj_freeze(value);
#ifdef PRISM_BUILD_DEBUG
xfree_sized(dup, length);
#endif
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Dump the AST corresponding to the given string to a string. For supported options, see Prism.parse.
static VALUE
dump_file(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
VALUE value = dump_input(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Dump the AST corresponding to the given file to a string. For supported options, see Prism.parse.
static VALUE
lex(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
VALUE result = parse_lex_input(&input, &options, false);
pm_string_free(&input);
pm_options_free(&options);
return result;
}
Return a LexResult instance that contains an array of Token instances corresponding to the given string. For supported options, see Prism.parse.
# File tmp/rubies/ruby-master/lib/prism.rb, line 70
def self.lex_compat(source, **options)
LexCompat.new(source, **options).result # steep:ignore
end
Returns a parse result whose value is an array of tokens that closely resembles the return value of Ripper.lex.
For supported options, see Prism.parse.
static VALUE
lex_file(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
VALUE value = parse_lex_input(&input, &options, false);
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Return a LexResult instance that contains an array of Token instances corresponding to the given file. For supported options, see Prism.parse.
# File tmp/rubies/ruby-master/lib/prism.rb, line 80
def self.load(source, serialized, freeze = false)
Serialize.load_parse(source, serialized, freeze)
end
Load the serialized AST using the source as a reference into a tree.
static VALUE
parse(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
#ifdef PRISM_BUILD_DEBUG
size_t length = pm_string_length(&input);
char* dup = xmalloc(length);
memcpy(dup, pm_string_source(&input), length);
pm_string_constant_init(&input, dup, length);
#endif
VALUE value = parse_input(&input, &options);
#ifdef PRISM_BUILD_DEBUG
xfree_sized(dup, length);
#endif
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Parse the given string and return a ParseResult instance. The options that are supported are:
-
command_line- either nil or a string of the various options that were set on the command line. Valid values are combinations of “a”, “l”, “n”, “p”, and “x”. -
encoding- the encoding of the source being parsed. This should be an encoding or nil. -
filepath- the filepath of the source being parsed. This should be a string or nil. -
freeze- whether or not to deeply freeze the AST. This should be a boolean or nil. -
frozen_string_literal- whether or not the frozen string literal pragma has been set. This should be a boolean or nil. -
line- the line number that the parse starts on. This should be an integer or nil. Note that this is 1-indexed. -
main_script- a boolean indicating whether or not the source being parsed is the main script being run by the interpreter. This controls whether or not shebangs are parsed for additional flags and whether or not the parser will attempt to find a matching shebang if the first one does not contain the word “ruby”. -
partial_script- when the file being parsed is considered a “partial” script, jumps will not be marked as errors if they are not contained within loops/blocks. This is used in the case that you’re parsing a script that you know will be embedded inside another script later, but you do not have that context yet. For example, when parsing anERBtemplate that will be evaluated inside another script. -
scopes- the locals that are in scope surrounding the code that is being parsed. This should be an array of arrays of symbols or nil. Scopes are ordered from the outermost scope to the innermost one. -
version- the version ofRubysyntax that prism should used to parseRubycode. By default prism assumes you want to parse with the latest version ofRubysyntax (which you can trigger withnilor"latest"). You may also restrict the syntax to a specific version ofRuby, e.g., with"3.3.0". To parse with the same syntax version that the currentRubyis running useversion: "current". To parse with the nearest version to the currentRubythat is running, useversion: "nearest". RaisesArgumentErrorif the version is not currently supported byPrism.
static VALUE
parse_comments(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
VALUE result = parse_input_comments(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return result;
}
Parse the given string and return an array of Comment objects. For supported options, see Prism.parse.
static VALUE
parse_failure_p(int argc, VALUE *argv, VALUE self) {
return RTEST(parse_success_p(argc, argv, self)) ? Qfalse : Qtrue;
}
Parse the given string and return true if it parses with errors. For supported options, see Prism.parse.
static VALUE
parse_file(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
VALUE value = parse_input(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Parse the given file and return a ParseResult instance. For supported options, see Prism.parse.
static VALUE
parse_file_comments(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
VALUE value = parse_input_comments(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Parse the given file and return an array of Comment objects. For supported options, see Prism.parse.
static VALUE
parse_file_failure_p(int argc, VALUE *argv, VALUE self) {
return RTEST(parse_file_success_p(argc, argv, self)) ? Qfalse : Qtrue;
}
Parse the given file and return true if it parses with errors. For supported options, see Prism.parse.
static VALUE
parse_file_success_p(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
VALUE result = parse_input_success_p(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return result;
}
Parse the given file and return true if it parses without errors. For supported options, see Prism.parse.
static VALUE
parse_lex(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
VALUE value = parse_lex_input(&input, &options, true);
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Parse the given string and return a ParseLexResult instance that contains a 2-element array, where the first element is the AST and the second element is an array of Token instances.
This API is only meant to be used in the case where you need both the AST and the tokens. If you only need one or the other, use either Prism.parse or Prism.lex.
For supported options, see Prism.parse.
static VALUE
parse_lex_file(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
VALUE value = parse_lex_input(&input, &options, true);
pm_string_free(&input);
pm_options_free(&options);
return value;
}
Parse the given file and return a ParseLexResult instance that contains a 2-element array, where the first element is the AST and the second element is an array of Token instances.
This API is only meant to be used in the case where you need both the AST and the tokens. If you only need one or the other, use either Prism.parse_file or Prism.lex_file.
For supported options, see Prism.parse.
static VALUE
parse_stream(int argc, VALUE *argv, VALUE self) {
VALUE stream;
VALUE keywords;
rb_scan_args(argc, argv, "1:", &stream, &keywords);
pm_options_t options = { 0 };
extract_options(&options, Qnil, keywords);
pm_arena_t arena = { 0 };
pm_parser_t parser;
pm_buffer_t buffer;
pm_node_t *node = pm_parse_stream(&arena, &parser, &buffer, (void *) stream, parse_stream_fgets, parse_stream_eof, &options);
rb_encoding *encoding = rb_enc_find(parser.encoding->name);
VALUE source = pm_source_new(&parser, encoding, options.freeze);
VALUE value = pm_ast_new(&parser, node, encoding, source, options.freeze);
VALUE result = parse_result_create(rb_cPrismParseResult, &parser, value, encoding, source, options.freeze);
pm_buffer_free(&buffer);
pm_parser_free(&parser);
pm_arena_free(&arena);
return result;
}
Parse the given object that responds to gets and return a ParseResult instance. The options that are supported are the same as Prism.parse.
static VALUE
parse_success_p(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
VALUE result = parse_input_success_p(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return result;
}
Parse the given string and return true if it parses without errors. For supported options, see Prism.parse.
static VALUE
profile(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
string_options(argc, argv, &input, &options);
profile_input(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return Qnil;
}
Parse the given string and return nothing. This method is meant to allow profilers to avoid the overhead of reifying the AST to Ruby. For supported options, see Prism.parse.
static VALUE
profile_file(int argc, VALUE *argv, VALUE self) {
pm_string_t input;
pm_options_t options = { 0 };
VALUE encoded_filepath;
file_options(argc, argv, &input, &options, &encoded_filepath);
profile_input(&input, &options);
pm_string_free(&input);
pm_options_free(&options);
return Qnil;
}
Parse the given file and return nothing. This method is meant to allow profilers to avoid the overhead of reifying the AST to Ruby. For supported options, see Prism.parse.
# File tmp/rubies/ruby-master/lib/prism/parse_result.rb, line 1183
def self.scope(locals: [], forwarding: [])
Scope.new(locals, forwarding)
end
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.