Implement DataTransfer and related interfaces (#34205)

* add datatransfer interfaces Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * implement DataTransfer interface implemented Constructor, setter and getter for drop_effect and effect_allowed, Items and SetDragImage Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * implement DataTransferItem interface Implemented Kind, Type, GetAsString, GetAsFile. Marked DataTransfer as weakReferenceable to access its field inside DataTransferItemList and DataTransferItem. Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * implement DataTransferItemList interface implemented Lenght, Getter, Add, Remove, Clear Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * added DataTransfer's old interface Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * DataTransfer: implemented GetData, SetData, SetData Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * set Weakref to DataTransfer in DataTransferItemList and DataTransferItem Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * DataTransfer: implemented Types and Files Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * cleanup get_data, set_data, clear_data Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * fix clippy warning Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * add drag data store Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * fix DataTransfer's Types() behaviour Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * DataTransferItem: use the underlying drag data store Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * fix DataTransferItemList's getter and remove Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * fix clippy warnings Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> * update test expectations Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com> --------- Signed-off-by: Gae24 <96017547+Gae24@users.noreply.github.com>
2025-06-06 16:45:39 +00:00 · 2024-11-25 11:49:04 +01:00 · 2024-11-25 11:49:04 +01:00 · c9e3d3e25e
commit c9e3d3e25e
parent 810a91ecac
19 changed files with 873 additions and 146 deletions
--- a/components/script/dom/datatransferitemlist.rs
+++ b/components/script/dom/datatransferitemlist.rs
@ -0,0 +1,199 @@
+/* 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 https://mozilla.org/MPL/2.0/. */
+
+use std::cell::RefCell;
+use std::rc::Rc;
+
+use dom_struct::dom_struct;
+use js::rust::MutableHandleValue;
+
+use crate::dom::bindings::codegen::Bindings::DataTransferItemListBinding::DataTransferItemListMethods;
+use crate::dom::bindings::error::{Error, Fallible};
+use crate::dom::bindings::frozenarray::CachedFrozenArray;
+use crate::dom::bindings::reflector::{reflect_dom_object, DomObject, Reflector};
+use crate::dom::bindings::root::DomRoot;
+use crate::dom::bindings::str::DOMString;
+use crate::dom::datatransferitem::DataTransferItem;
+use crate::dom::file::File;
+use crate::dom::window::Window;
+use crate::drag_data_store::{Binary, DragDataStore, Kind, Mode, PlainString};
+use crate::script_runtime::JSContext;
+
+#[dom_struct]
+pub struct DataTransferItemList {
+    reflector_: Reflector,
+    #[ignore_malloc_size_of = "Rc"]
+    #[no_trace]
+    data_store: Rc<RefCell<Option<DragDataStore>>>,
+    #[ignore_malloc_size_of = "mozjs"]
+    frozen_types: CachedFrozenArray,
+}
+
+impl DataTransferItemList {
+    fn new_inherited(data_store: Rc<RefCell<Option<DragDataStore>>>) -> DataTransferItemList {
+        DataTransferItemList {
+            reflector_: Reflector::new(),
+            frozen_types: CachedFrozenArray::new(),
+            data_store,
+        }
+    }
+
+    pub fn new(
+        window: &Window,
+        data_store: Rc<RefCell<Option<DragDataStore>>>,
+    ) -> DomRoot<DataTransferItemList> {
+        reflect_dom_object(
+            Box::new(DataTransferItemList::new_inherited(data_store)),
+            window,
+        )
+    }
+
+    pub fn frozen_types(&self, cx: JSContext, retval: MutableHandleValue) {
+        self.frozen_types.get_or_init(
+            || {
+                self.data_store
+                    .borrow()
+                    .as_ref()
+                    .map_or(Vec::new(), |data_store| data_store.types())
+            },
+            cx,
+            retval,
+        );
+    }
+
+    pub fn invalidate_frozen_types(&self) {
+        self.frozen_types.clear();
+    }
+}
+
+impl DataTransferItemListMethods<crate::DomTypeHolder> for DataTransferItemList {
+    /// <https://html.spec.whatwg.org/multipage/#dom-datatransferitemlist-length>
+    fn Length(&self) -> u32 {
+        // Return zero if the object is in the disabled mode;
+        // otherwise it must return the number of items in the drag data store item list.
+        self.data_store
+            .borrow()
+            .as_ref()
+            .map_or(0, |data_store| data_store.list_len() as u32)
+    }
+
+    /// <https://html.spec.whatwg.org/multipage/#dom-datatransferitemlist-item>
+    fn IndexedGetter(&self, index: u32) -> Option<DomRoot<DataTransferItem>> {
+        // Step 1 Return null if it isn't associated with a data store
+        let option = self.data_store.borrow();
+        let data_store = match option.as_ref() {
+            Some(value) => value,
+            _ => return None,
+        };
+
+        // Step 2
+        data_store
+            .get_item(index as usize)
+            .map(|item| DataTransferItem::new(&self.global(), item))
+    }
+
+    /// <https://html.spec.whatwg.org/multipage/#dom-datatransferitemlist-add>
+    fn Add(
+        &self,
+        data: DOMString,
+        mut type_: DOMString,
+    ) -> Fallible<Option<DomRoot<DataTransferItem>>> {
+        // Step 1 If the DataTransferItemList object is not in the read/write mode, return null.
+        let mut option = self.data_store.borrow_mut();
+        let data_store = match option.as_mut() {
+            Some(value) if value.mode() == Mode::ReadWrite => value,
+            _ => return Ok(None),
+        };
+
+        // Add an item to the drag data store item list whose kind is text,
+        // whose type string is equal to the value of the method's second argument, converted to ASCII lowercase,
+        // and whose data is the string given by the method's first argument.
+        type_.make_ascii_lowercase();
+        data_store.add(Kind::Text(PlainString::new(data, type_)))?;
+
+        self.frozen_types.clear();
+
+        // Step 3 Determine the value of the indexed property corresponding to the newly added item,
+        // and return that value (a newly created DataTransferItem object).
+        let index = data_store.list_len() - 1;
+        let item = data_store
+            .get_item(index)
+            .map(|item| DataTransferItem::new(&self.global(), item));
+
+        Ok(item)
+    }
+
+    /// <https://html.spec.whatwg.org/multipage/#dom-datatransferitemlist-add>
+    fn Add_(&self, data: &File) -> Fallible<Option<DomRoot<DataTransferItem>>> {
+        // Step 1 If the DataTransferItemList object is not in the read/write mode, return null.
+        let mut option = self.data_store.borrow_mut();
+        let data_store = match option.as_mut() {
+            Some(value) if value.mode() == Mode::ReadWrite => value,
+            _ => return Ok(None),
+        };
+
+        // Add an item to the drag data store item list whose kind is File,
+        // whose type string is the type of the File, converted to ASCII lowercase,
+        // and whose data is the same as the File's data.
+        let mut type_ = data.file_type();
+        type_.make_ascii_lowercase();
+        let binary = Binary::new(
+            data.file_bytes().unwrap_or_default(),
+            data.name().clone(),
+            type_,
+        );
+
+        data_store.add(Kind::File(binary))?;
+
+        self.frozen_types.clear();
+
+        // Step 3 Determine the value of the indexed property corresponding to the newly added item,
+        // and return that value (a newly created DataTransferItem object).
+        let index = data_store.list_len() - 1;
+        let item = data_store
+            .get_item(index)
+            .map(|item| DataTransferItem::new(&self.global(), item));
+
+        Ok(item)
+    }
+
+    /// <https://html.spec.whatwg.org/multipage/#dom-datatransferitemlist-remove>
+    fn Remove(&self, index: u32) -> Fallible<()> {
+        // Step 1 If the DataTransferItemList object is not in the read/write mode,
+        // throw an "InvalidStateError" DOMException.
+        let mut option = self.data_store.borrow_mut();
+        let data_store = match option.as_mut() {
+            Some(value) if value.mode() == Mode::ReadWrite => value,
+            _ => return Err(Error::InvalidState),
+        };
+
+        let index = index as usize;
+
+        // Step 2 If the drag data store does not contain an indexth item, then return.
+        if index < data_store.list_len() {
+            // Step 3 Remove the indexth item from the drag data store.
+            data_store.remove(index);
+            self.frozen_types.clear();
+        }
+
+        Ok(())
+    }
+
+    /// <https://html.spec.whatwg.org/multipage/#dom-datatransferitemlist-clear>
+    fn Clear(&self) {
+        // If the DataTransferItemList object is in the read/write mode, remove all the items from the drag data store.
+        // Otherwise, it must do nothing.
+        let mut option = self.data_store.borrow_mut();
+        let data_store = match option.as_mut() {
+            Some(value) if value.mode() == Mode::ReadWrite => value,
+            _ => return,
+        };
+
+        // If the item list is empty we don't clear it.
+        if data_store.list_len() > 0 {
+            data_store.clear_list();
+            self.frozen_types.clear();
+        }
+    }
+}