servo / rust-mozjs

DEPRECATED - moved to servo/mozjs instead.
Mozilla Public License 2.0
293 stars 117 forks source link

String conversion should use linear strings #514

Open jdm opened 4 years ago

jdm commented 4 years ago
diff --git a/src/conversions.rs b/src/conversions.rs
index a3b47a4..86b38e2 100644
--- a/src/conversions.rs
+++ b/src/conversions.rs
@@ -31,8 +31,9 @@ use error::throw_type_error;
 use glue::RUST_JS_NumberValue;
 use jsapi::AssertSameCompartment;
 use jsapi::{ForOfIterator, ForOfIterator_NonIterableBehavior};
-use jsapi::{Heap, JS_DefineElement, JS_GetLatin1StringCharsAndLength};
+use jsapi::{Heap, JS_DefineElement, JS_EnsureLinearString, JS_GetLatin1StringCharsAndLength};
 use jsapi::{JS_GetTwoByteStringCharsAndLength, JS_NewArrayObject1};
+use jsapi::{JS_GetLatin1LinearStringChars, JS_GetTwoByteLinearStringChars};
 use jsapi::{JS_NewUCStringCopyN, JSPROP_ENUMERATE, JS_StringHasLatin1Chars};
 use jsapi::{JSContext, JSObject, JSString, RootedObject, RootedValue};
 use jsval::{BooleanValue, Int32Value, NullValue, UInt32Value, UndefinedValue};
@@ -443,7 +444,12 @@ pub unsafe fn latin1_to_string(cx: *mut JSContext, s: *mut JSString) -> String {
     assert!(JS_StringHasLatin1Chars(s));

     let mut length = 0;
-    let chars = JS_GetLatin1StringCharsAndLength(cx, ptr::null(), s, &mut length);
+    let _ = JS_GetLatin1StringCharsAndLength(cx, ptr::null(), s, &mut length);
+
+    let s = JS_EnsureLinearString(cx, s);
+    assert!(!s.is_null());
+
+    let chars = JS_GetLatin1LinearStringChars(ptr::null(), s);
     assert!(!chars.is_null());

     let chars = slice::from_raw_parts(chars, length as usize);
@@ -459,7 +465,12 @@ pub unsafe fn jsstr_to_string(cx: *mut JSContext, jsstr: *mut JSString) -> Strin
     }

     let mut length = 0;
-    let chars = JS_GetTwoByteStringCharsAndLength(cx, ptr::null(), jsstr, &mut length);
+    let _ = JS_GetTwoByteStringCharsAndLength(cx, ptr::null(), jsstr, &mut length);
+
+    let jsstr = JS_EnsureLinearString(cx, jsstr);
+    assert!(!jsstr.is_null());
+
+    let chars = JS_GetTwoByteLinearStringChars(ptr::null(), jsstr);
     assert!(!chars.is_null());
     let char_vec = slice::from_raw_parts(chars, length as usize);
     String::from_utf16_lossy(char_vec)
jdm commented 4 years ago

This unit test currently passes without this change, so I'm not entirely clear on whether the lack of linear strings is hurting us:

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this file,
 * You can obtain one at http://mozilla.org/MPL/2.0/. */

#[macro_use]
extern crate mozjs;
extern crate mozjs_sys;
extern crate libc;

use mozjs_sys::jsgc::IntoHandle;
use mozjs::conversions::jsstr_to_string;
use mozjs::jsapi::JSAutoRealm;
use mozjs::jsapi::JS_ConcatStrings;
use mozjs::jsapi::JS_NewGlobalObject;
use mozjs::jsapi::JS_NewStringCopyZ;
use mozjs::jsapi::JS_NewUCStringCopyZ;
use mozjs::jsapi::JS_StringHasLatin1Chars;
use mozjs::jsapi::JS_StringIsLinear;
use mozjs::jsapi::OnNewGlobalHookOption;
use mozjs::rust::{JSEngine, RealmOptions, Runtime, SIMPLE_GLOBAL_CLASS};
use std::ptr;

#[test]
fn nonlinear_string() {
    let engine = JSEngine::init().unwrap();
    let runtime = Runtime::new(engine.handle());
    let context = runtime.cx();
    let h_option = OnNewGlobalHookOption::FireOnNewGlobalHook;
    let c_option = RealmOptions::default();

    unsafe {
        let global = JS_NewGlobalObject(context, &SIMPLE_GLOBAL_CLASS, ptr::null_mut(), h_option, &*c_option);
        rooted!(in(context) let global_root = global);
        let global = global_root.handle();
        let _ac = JSAutoRealm::new(context, global.get());
        let s = b"abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz\0";
        rooted!(in(context) let left = JS_NewStringCopyZ(context, s.as_ptr() as *const _));
        assert!(!left.is_null());
        assert!(JS_StringIsLinear(*left));

        rooted!(in(context) let right = JS_NewStringCopyZ(context, s.as_ptr() as *const _));
        assert!(!right.is_null());
        assert!(JS_StringIsLinear(*right));

        rooted!(in(context) let joined = JS_ConcatStrings(context, left.handle().into_handle(), right.handle().into_handle()));
        assert!(!joined.is_null());
        assert!(!JS_StringIsLinear(*joined));

        let rust_str = jsstr_to_string(context, *joined);
        let expected = String::from_utf8(s[..s.len() - 1].to_owned()).unwrap();
        assert_eq!(rust_str, expected.clone() + &expected);

        let s = "abcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxy\u{abcd}\0";
        let utf16_chars: Vec<u16> = s.encode_utf16().collect();
        rooted!(in(context) let left = JS_NewUCStringCopyZ(context, utf16_chars.as_ptr() as *const _));
        assert!(!left.is_null());
        assert!(!JS_StringHasLatin1Chars(*left));
        assert!(JS_StringIsLinear(*left));

        rooted!(in(context) let right = JS_NewUCStringCopyZ(context, utf16_chars.as_ptr() as *const _));
        assert!(!right.is_null());
        assert!(!JS_StringHasLatin1Chars(*right));
        assert!(JS_StringIsLinear(*right));

        rooted!(in(context) let joined = JS_ConcatStrings(context, left.handle().into_handle(), right.handle().into_handle()));
        assert!(!joined.is_null());
        assert!(!JS_StringIsLinear(*joined));

        let rust_str = jsstr_to_string(context, *joined);
        let expected = s[..s.len() - 1].to_owned();
        assert_eq!(rust_str, expected.clone() + &expected);
    }
}