gecko-dev/js/rust
Jan de Mooij 6febd292ea Bug 1586683 - Remove flat strings from JSAPI. r=jwalden,bzbarsky
We want to remove flat strings (JSFlatString). With this patch we only expose
linear strings (JSLinearString) to API consumers.

This is very mechanical for the most part, because code typically only cares
about linear strings and not the null-termination aspect.

CTypes's Library.cpp has some Windows-specific code where we relied on null-terminated
strings. This patch adds JS_CopyStringCharsZ for that use case.

Differential Revision: https://phabricator.services.mozilla.com/D48314

--HG--
extra : moz-landing-system : lando
2019-10-14 09:32:07 +00:00
..
etc
src Bug 1586683 - Remove flat strings from JSAPI. r=jwalden,bzbarsky 2019-10-14 09:32:07 +00:00
tests Bug 1573844 - Remove js::Class definition and alias JSClass to it r=tcampbell,mccr8 2019-08-15 08:32:22 +00:00
.gitignore
build.rs Bug 1586683 - Remove flat strings from JSAPI. r=jwalden,bzbarsky 2019-10-14 09:32:07 +00:00
Cargo.toml Bug 1587368 - Stop using -oldsyn bindgen version now that we pull newer syn and proc_macro versions anyway. 2019-10-09 13:42:36 +02:00
CMakeLists.txt
README.md

The js Crate: Rust Bindings to SpiderMonkey

User Documentation

Building

To build a release version of SpiderMonkey and the Rust code with optimizations enabled:

$ cargo build --release

To build with SpiderMonkey's DEBUG checks and assertions:

$ cargo build --features debugmozjs

Raw FFI bindings to JSAPI are machine generated with rust-lang-nursery/rust-bindgen, and requires libclang >= 3.9. See ./build.rs for details.

Cargo Features

  • debugmozjs: Create a DEBUG build of SpiderMonkey with many extra assertions enabled. This is decoupled from whether the crate and its Rust code is built in debug or release mode.

  • promises: Enable SpiderMonkey native promises.

  • nonzero: Leverage the unstable NonZero type. Requires nightly Rust.

Testing

Make sure to test both with and without the debugmozjs feature because various structures have different sizes and get passed through functions differently at the ABI level! At minimum, you should test with debugmozjs to get extra assertions and checking.

$ cargo test
$ cargo test --features debugmozjs