From cdb47510b31bfea09231fd451e568f554f63a722 Mon Sep 17 00:00:00 2001
From: Hans Larsen <hans@larsen.online>
Date: Mon, 9 Sep 2024 09:11:16 -0700
Subject: [PATCH] Add an "iter()" method to Js*Array for convenience (#3986)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* Allow dead code for code that is newly detected as unused

* Fix compile errors with nightly rust

* Add missing SAFETY section

* Increase safety of `FutexWaiters`

* Add an "iter()" method to Js*Array for convenience

It might be optimizable, and in either case it should be but this at
least let people use an easy API and enjoy future improvements.

* Fix clippies

---------

Co-authored-by: Theo Paris <theo@tinted.dev>
Co-authored-by: José Julián Espina <julian.espina@canonical.com>
---
 .../src/object/builtins/jstypedarray.rs       | 56 ++++++++++++++++++-
 core/engine/src/value/mod.rs                  |  5 ++
 2 files changed, 60 insertions(+), 1 deletion(-)

diff --git a/core/engine/src/object/builtins/jstypedarray.rs b/core/engine/src/object/builtins/jstypedarray.rs
index d043b47363..e694e2d086 100644
--- a/core/engine/src/object/builtins/jstypedarray.rs
+++ b/core/engine/src/object/builtins/jstypedarray.rs
@@ -542,7 +542,7 @@ impl JsTypedArray {
 
     /// Iterates the typed array in reverse order and returns the value of
     /// the first element that satisfies the provided testing function.
-    /// If no elements satisfy the testing function, `JsResult::Ok(None)` is returned.  
+    /// If no elements satisfy the testing function, `JsResult::Ok(None)` is returned.
     ///
     /// Calls `TypedArray.prototype.findLast()`.
     ///
@@ -927,6 +927,7 @@ macro_rules! JsTypedArrayType {
         $constructor_function:ident,
         $checker_function:ident,
         $constructor_object:ident,
+        $value_to_elem:ident,
         $element:ty
     ) => {
 
@@ -1017,6 +1018,21 @@ macro_rules! JsTypedArrayType {
                     },
                 })
             }
+
+            /// Create an iterator over the typed array's elements.
+            pub fn iter<'a>(&'a self, context: &'a mut Context) -> impl Iterator<Item = $element> + 'a {
+                let length = self.length(context).unwrap_or(0);
+                let mut index = 0;
+                std::iter::from_fn(move || {
+                    if index < length {
+                        let value = self.get(index, context).ok()?;
+                        index += 1;
+                        value.$value_to_elem(context).ok()
+                    } else {
+                        None
+                    }
+                })
+            }
         }
 
         impl From<$name> for JsObject {
@@ -1066,6 +1082,7 @@ JsTypedArrayType!(
     Uint8Array,
     is_typed_uint8_array,
     typed_uint8_array,
+    to_uint8,
     u8
 );
 JsTypedArrayType!(
@@ -1073,6 +1090,7 @@ JsTypedArrayType!(
     Int8Array,
     is_typed_int8_array,
     typed_int8_array,
+    to_int8,
     i8
 );
 JsTypedArrayType!(
@@ -1080,6 +1098,7 @@ JsTypedArrayType!(
     Uint16Array,
     is_typed_uint16_array,
     typed_uint16_array,
+    to_uint16,
     u16
 );
 JsTypedArrayType!(
@@ -1087,6 +1106,7 @@ JsTypedArrayType!(
     Int16Array,
     is_typed_int16_array,
     typed_int16_array,
+    to_int16,
     i16
 );
 JsTypedArrayType!(
@@ -1094,6 +1114,7 @@ JsTypedArrayType!(
     Uint32Array,
     is_typed_uint32_array,
     typed_uint32_array,
+    to_u32,
     u32
 );
 JsTypedArrayType!(
@@ -1101,6 +1122,7 @@ JsTypedArrayType!(
     Int32Array,
     is_typed_int32_array,
     typed_int32_array,
+    to_i32,
     i32
 );
 JsTypedArrayType!(
@@ -1108,6 +1130,7 @@ JsTypedArrayType!(
     Float32Array,
     is_typed_float32_array,
     typed_float32_array,
+    to_f32,
     f32
 );
 JsTypedArrayType!(
@@ -1115,5 +1138,36 @@ JsTypedArrayType!(
     Float64Array,
     is_typed_float64_array,
     typed_float64_array,
+    to_number,
     f64
 );
+
+#[test]
+fn typed_iterators_uint8() {
+    let context = &mut Context::default();
+    let vec = vec![1u8, 2, 3, 4, 5, 6, 7, 8];
+
+    let array = JsUint8Array::from_iter(vec.clone(), context).unwrap();
+    let vec2 = array.iter(context).collect::<Vec<_>>();
+    assert_eq!(vec, vec2);
+}
+
+#[test]
+fn typed_iterators_uint32() {
+    let context = &mut Context::default();
+    let vec = vec![1u32, 2, 0xFFFF, 4, 0xFF12_3456, 6, 7, 8];
+
+    let array = JsUint32Array::from_iter(vec.clone(), context).unwrap();
+    let vec2 = array.iter(context).collect::<Vec<_>>();
+    assert_eq!(vec, vec2);
+}
+
+#[test]
+fn typed_iterators_f32() {
+    let context = &mut Context::default();
+    let vec = vec![0.1f32, 0.2, 0.3, 0.4, 1.1, 9.99999];
+
+    let array = JsFloat32Array::from_iter(vec.clone(), context).unwrap();
+    let vec2 = array.iter(context).collect::<Vec<_>>();
+    assert_eq!(vec, vec2);
+}
diff --git a/core/engine/src/value/mod.rs b/core/engine/src/value/mod.rs
index 59f8703d4e..a715b98a2b 100644
--- a/core/engine/src/value/mod.rs
+++ b/core/engine/src/value/mod.rs
@@ -927,6 +927,11 @@ impl JsValue {
         }
     }
 
+    /// Converts a value to a 32 bit floating point.
+    pub fn to_f32(&self, context: &mut Context) -> JsResult<f32> {
+        self.to_number(context).map(|n| n as f32)
+    }
+
     /// This is a more specialized version of `to_numeric`, including `BigInt`.
     ///
     /// This function is equivalent to `Number(value)` in JavaScript