C++ bindings for lib-ruby-parser

Documentation

All classes/methods are defined under lib_ruby_parser namespace. API mostly mirrors Rust version.

Pre-compiled libraries and header files are available on Releases, supported platforms:

• x86_64-apple-darwin
• x86_64-unknown-linux-gnu
• x86_64-pc-windows-msvc

Basic API

// Configure parsing options
lib_ruby_parser::ParserOptions options(
    /* 1. filename */
    lib_ruby_parser::String::Copied("(eval)"),
 
    /* 2. decoder */
    lib_ruby_parser::MaybeDecoder(lib_ruby_parser::Decoder(nullptr)),
 
    /* 3. token_rewriter */
    lib_ruby_parser::MaybeTokenRewriter(lib_ruby_parser::TokenRewriter(nullptr)),
 
    /* 4. record_tokens */
    true);
 
// Setup input to parse
lib_ruby_parser::ByteList input = lib_ruby_parser::ByteList::Copied("2 + 3", 5);
 
lib_ruby_parser::ParserResult result = lib_ruby_parser::parse(
    std::move(input),
    std::move(options));
 
assert_eq(result.ast->tag, lib_ruby_parser::Node::Tag::SEND);
assert_eq(result.tokens.len, 4); // tINT tPLUS tINT EOF
assert_eq(result.comments.len, 0);
assert_eq(result.magic_comments.len, 0);
assert_byte_list(result.input.bytes, "2 + 3");

ParserResult contains the following fields:

1. Node* ast - potentually nullable AST, tagged enum
2. TokenList tokens - list of tokens
3. DiagnosticList diagnostics - list of diagnostics
4. CommentList comments - list of comments
5. MagicCommentList magic_comments - list of magic comments
6. DecodedInput input - decoded input

All node classes fully match node structs of the original Rust implementation. You can check full documentation (nodes module)

Development

• Clone the repo
• Set environment variables:
  • TARGET (e.g. export TARGET=x86_64-apple-darwin, no default value)
  • CXX (e.g. g++)
  • BUILD_ENV (debug or release, debug is the default value)
• run make tests/run to run tests
• run make libruby_parser_cpp.a (or make libruby_parser_cpp.lib for MSVC) to get a static library
• run make lib-ruby-parser.hpp to get a header file

Structure

• Each directory has its own build.mk file that is included my the main Makefile
• Rust parser with basic C++ bindings is located under ruby-parser-cpp.
• Actual C++ bindings are located in *.{hpp, cpp} files in the root directory
• scripts directory contains per-triplet additional configurations for make
• codegen directory is a Rust micro-library that does code generation
• benchmark directory contains a set of scripts to compare performance of Rust vs C++ vs Ripper