script_bindings/
str.rs

1/* This Source Code Form is subject to the terms of the Mozilla Public
2 * License, v. 2.0. If a copy of the MPL was not distributed with this
3 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
4
5//! The `ByteString` struct.
6use std::borrow::ToOwned;
7use std::default::Default;
8use std::hash::{Hash, Hasher};
9use std::ops::Deref;
10use std::str::FromStr;
11use std::{fmt, ops, slice, str};
12
13use js::gc::{HandleObject, HandleValue};
14use js::rust::wrappers::ToJSON;
15
16pub use crate::domstring::DOMString;
17use crate::error::Error;
18use crate::script_runtime::JSContext;
19
20/// Encapsulates the IDL `ByteString` type.
21#[derive(Clone, Debug, Default, Eq, JSTraceable, MallocSizeOf, PartialEq)]
22pub struct ByteString(Vec<u8>);
23
24impl ByteString {
25    /// Creates a new `ByteString`.
26    pub fn new(value: Vec<u8>) -> ByteString {
27        ByteString(value)
28    }
29
30    /// Returns `self` as a string, if it encodes valid UTF-8, and `None`
31    /// otherwise.
32    pub fn as_str(&self) -> Option<&str> {
33        str::from_utf8(&self.0).ok()
34    }
35
36    /// Returns the length.
37    pub fn len(&self) -> usize {
38        self.0.len()
39    }
40
41    /// Checks if the ByteString is empty.
42    pub fn is_empty(&self) -> bool {
43        self.0.is_empty()
44    }
45
46    /// Returns `self` with A–Z replaced by a–z.
47    pub fn to_lower(&self) -> ByteString {
48        ByteString::new(self.0.to_ascii_lowercase())
49    }
50}
51
52impl From<ByteString> for Vec<u8> {
53    fn from(byte_string: ByteString) -> Vec<u8> {
54        byte_string.0
55    }
56}
57
58impl Hash for ByteString {
59    fn hash<H: Hasher>(&self, state: &mut H) {
60        self.0.hash(state);
61    }
62}
63
64impl FromStr for ByteString {
65    type Err = ();
66    fn from_str(s: &str) -> Result<ByteString, ()> {
67        Ok(ByteString::new(s.to_owned().into_bytes()))
68    }
69}
70
71impl ops::Deref for ByteString {
72    type Target = [u8];
73    fn deref(&self) -> &[u8] {
74        &self.0
75    }
76}
77
78/// A string that is constructed from a UCS-2 buffer by replacing invalid code
79/// points with the replacement character.
80#[derive(Clone, Debug, Default, Eq, Hash, MallocSizeOf, Ord, PartialEq, PartialOrd)]
81pub struct USVString(pub String);
82
83impl Deref for USVString {
84    type Target = str;
85
86    #[inline]
87    fn deref(&self) -> &str {
88        &self.0
89    }
90}
91
92impl AsRef<str> for USVString {
93    fn as_ref(&self) -> &str {
94        &self.0
95    }
96}
97
98impl fmt::Display for USVString {
99    #[inline]
100    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
101        fmt::Display::fmt(&self.0, f)
102    }
103}
104
105impl PartialEq<str> for USVString {
106    fn eq(&self, other: &str) -> bool {
107        self.0 == other
108    }
109}
110
111impl<'a> PartialEq<&'a str> for USVString {
112    fn eq(&self, other: &&'a str) -> bool {
113        self.0 == *other
114    }
115}
116
117impl From<String> for USVString {
118    fn from(contents: String) -> USVString {
119        USVString(contents)
120    }
121}
122
123impl From<USVString> for String {
124    fn from(value: USVString) -> Self {
125        value.0
126    }
127}
128
129impl From<USVString> for DOMString {
130    fn from(value: USVString) -> Self {
131        DOMString::from_string(value.0)
132    }
133}
134
135/// Returns whether `s` is a `token`, as defined by
136/// [RFC 2616](http://tools.ietf.org/html/rfc2616#page-17).
137pub fn is_token(s: &[u8]) -> bool {
138    if s.is_empty() {
139        return false; // A token must be at least a single character
140    }
141    s.iter().all(|&x| {
142        // http://tools.ietf.org/html/rfc2616#section-2.2
143        match x {
144            0..=31 | 127 => false, // CTLs
145            40 | 41 | 60 | 62 | 64 | 44 | 59 | 58 | 92 | 34 | 47 | 91 | 93 | 63 | 61 | 123 |
146            125 | 32 => false, // separators
147            x if x > 127 => false, // non-CHARs
148            _ => true,
149        }
150    })
151}
152
153/// Because this converts to a DOMString it becomes UTF-8 encoded which is closer to
154/// the spec definition of <https://infra.spec.whatwg.org/#serialize-a-javascript-value-to-json-bytes>
155/// but we generally do not operate on anything that is truly a WTF-16 string.
156///
157/// <https://infra.spec.whatwg.org/#serialize-a-javascript-value-to-a-json-string>
158pub fn serialize_jsval_to_json_utf8(cx: JSContext, data: HandleValue) -> Result<DOMString, Error> {
159    #[repr(C)]
160    struct ToJSONCallbackData {
161        string: Option<String>,
162    }
163
164    let mut out_str = ToJSONCallbackData { string: None };
165
166    #[expect(unsafe_code)]
167    unsafe extern "C" fn write_callback(
168        string: *const u16,
169        len: u32,
170        data: *mut std::ffi::c_void,
171    ) -> bool {
172        let data = data as *mut ToJSONCallbackData;
173        let string_chars = unsafe { slice::from_raw_parts(string, len as usize) };
174        unsafe { &mut *data }
175            .string
176            .get_or_insert_with(Default::default)
177            .push_str(&String::from_utf16_lossy(string_chars));
178        true
179    }
180
181    // 1. Let result be ? Call(%JSON.stringify%, undefined, « value »).
182    unsafe {
183        let stringify_result = ToJSON(
184            *cx,
185            data,
186            HandleObject::null(),
187            HandleValue::null(),
188            Some(write_callback),
189            &mut out_str as *mut ToJSONCallbackData as *mut _,
190        );
191        // Note: ToJSON returns false when a JS error is thrown, so we need to return
192        // JSFailed to propagate the raised exception
193        if !stringify_result {
194            return Err(Error::JSFailed);
195        }
196    }
197
198    // 2. If result is undefined, then throw a TypeError.
199    // Note: ToJSON will not call the callback if the data cannot be serialized.
200    // 3. Assert: result is a string.
201    // 4. Return result.
202    out_str
203        .string
204        .map(Into::into)
205        .ok_or_else(|| Error::Type("unable to serialize JSON".to_owned()))
206}
script_bindings/str.rs

script_bindings/
str.rs
