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>
This commit is contained in:
Gae24 2024-11-25 11:49:04 +01:00 committed by GitHub
parent 810a91ecac
commit c9e3d3e25e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 873 additions and 146 deletions

View file

@ -0,0 +1,252 @@
/* 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::{HandleObject, MutableHandleValue};
use crate::dom::bindings::cell::DomRefCell;
use crate::dom::bindings::codegen::Bindings::DataTransferBinding::DataTransferMethods;
use crate::dom::bindings::inheritance::Castable;
use crate::dom::bindings::reflector::{reflect_dom_object_with_proto, DomObject, Reflector};
use crate::dom::bindings::root::{Dom, DomRoot};
use crate::dom::bindings::str::DOMString;
use crate::dom::datatransferitemlist::DataTransferItemList;
use crate::dom::element::Element;
use crate::dom::filelist::FileList;
use crate::dom::htmlimageelement::HTMLImageElement;
use crate::dom::window::Window;
use crate::drag_data_store::{DragDataStore, Mode};
use crate::script_runtime::{CanGc, JSContext};
const VALID_DROP_EFFECTS: [&str; 4] = ["none", "copy", "link", "move"];
const VALID_EFFECTS_ALLOWED: [&str; 9] = [
"none",
"copy",
"copyLink",
"copyMove",
"link",
"linkMove",
"move",
"all",
"uninitialized",
];
#[dom_struct]
pub struct DataTransfer {
reflector_: Reflector,
drop_effect: DomRefCell<DOMString>,
effect_allowed: DomRefCell<DOMString>,
items: Dom<DataTransferItemList>,
#[ignore_malloc_size_of = "Rc"]
#[no_trace]
data_store: Rc<RefCell<Option<DragDataStore>>>,
}
impl DataTransfer {
fn new_inherited(
data_store: Rc<RefCell<Option<DragDataStore>>>,
item_list: &DataTransferItemList,
) -> DataTransfer {
DataTransfer {
reflector_: Reflector::new(),
drop_effect: DomRefCell::new(DOMString::from("none")),
effect_allowed: DomRefCell::new(DOMString::from("none")),
items: Dom::from_ref(item_list),
data_store,
}
}
pub fn new_with_proto(
window: &Window,
proto: Option<HandleObject>,
can_gc: CanGc,
) -> DomRoot<DataTransfer> {
let mut drag_data_store = DragDataStore::new();
drag_data_store.set_mode(Mode::ReadWrite);
let data_store = Rc::new(RefCell::new(Some(drag_data_store)));
let item_list = DataTransferItemList::new(window, Rc::clone(&data_store));
reflect_dom_object_with_proto(
Box::new(DataTransfer::new_inherited(data_store, &item_list)),
window,
proto,
can_gc,
)
}
}
impl DataTransferMethods<crate::DomTypeHolder> for DataTransfer {
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer>
fn Constructor(
window: &Window,
proto: Option<HandleObject>,
can_gc: CanGc,
) -> DomRoot<DataTransfer> {
DataTransfer::new_with_proto(window, proto, can_gc)
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-dropeffect>
fn DropEffect(&self) -> DOMString {
self.drop_effect.borrow().clone()
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-dropeffect>
fn SetDropEffect(&self, value: DOMString) {
if VALID_DROP_EFFECTS.contains(&value.as_ref()) {
*self.drop_effect.borrow_mut() = value;
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-effectallowed>
fn EffectAllowed(&self) -> DOMString {
self.effect_allowed.borrow().clone()
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-effectallowed>
fn SetEffectAllowed(&self, value: DOMString) {
if self
.data_store
.borrow()
.as_ref()
.is_some_and(|data_store| data_store.mode() == Mode::ReadWrite) &&
VALID_EFFECTS_ALLOWED.contains(&value.as_ref())
{
*self.drop_effect.borrow_mut() = value;
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-items>
fn Items(&self) -> DomRoot<DataTransferItemList> {
DomRoot::from_ref(&self.items)
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-setdragimage>
fn SetDragImage(&self, image: &Element, x: i32, y: i32) {
// Step 1 If the DataTransfer is no longer associated with a data store, return.
let mut option = self.data_store.borrow_mut();
let data_store = match option.as_mut() {
Some(value) => value,
None => return,
};
// Step 2 If the data store's mode is not the read/write mode, return.
if data_store.mode() != Mode::ReadWrite {
return;
}
// Step 3
if let Some(image) = image.downcast::<HTMLImageElement>() {
data_store.set_bitmap(image.image_data(), x, y);
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-types>
fn Types(&self, cx: JSContext, retval: MutableHandleValue) {
self.items.frozen_types(cx, retval);
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-getdata>
fn GetData(&self, mut format: DOMString) -> DOMString {
// Step 1 If the DataTransfer object is not associated with a drag data store, then return the empty string.
let option = self.data_store.borrow();
let data_store = match option.as_ref() {
Some(value) => value,
None => return DOMString::new(),
};
// Step 2 If the drag data store's mode is the protected mode, then return the empty string.
if data_store.mode() == Mode::Protected {
return DOMString::new();
}
// Step 3 Let format be the first argument, converted to ASCII lowercase.
format.make_ascii_lowercase();
// Step 4 Let convert-to-URL be false.
let mut convert_to_url = false;
let type_ = match format.as_ref() {
// Step 5 If format equals "text", change it to "text/plain".
"text" => DOMString::from("text/plain"),
// Step 6 If format equals "url", change it to "text/uri-list" and set convert-to-URL to true.
"url" => {
convert_to_url = true;
DOMString::from("text/uri-list")
},
_ => format,
};
let data = data_store.find_matching_text(&type_);
// Step 8
if let Some(result) = data {
// Step 9 If convert-to-URL is true, then parse result as appropriate for text/uri-list data,
// and then set result to the first URL from the list, if any, or the empty string otherwise.
if convert_to_url {
//TODO parse uri-list as [RFC2483]
}
// Step 10 Return result.
result
} else {
// Step 7 If there is no item in the drag data store item list
// whose kind is text and whose type string is equal to format, return the empty string.
DOMString::new()
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-setdata>
fn SetData(&self, format: DOMString, data: DOMString) {
// Step 1 If the DataTransfer object is no longer associated with a drag data store, return. Nothing happens.
let mut option = self.data_store.borrow_mut();
let data_store = match option.as_mut() {
Some(value) => value,
None => return,
};
// Step 2 If the drag data store's mode is not the read/write mode, return. Nothing happens.
if data_store.mode() != Mode::ReadWrite {
return;
}
data_store.set_data(format, data);
self.items.invalidate_frozen_types();
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-cleardata>
fn ClearData(&self, format: Option<DOMString>) {
// Step 1 If the DataTransfer is not associated with a data store, return.
let mut option = self.data_store.borrow_mut();
let data_store = match option.as_mut() {
Some(value) => value,
None => return,
};
// Step 2 If the data store is not in the read/write mode, return.
if data_store.mode() != Mode::ReadWrite {
return;
}
if data_store.clear_data(format) {
self.items.invalidate_frozen_types();
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransfer-files>
fn Files(&self) -> DomRoot<FileList> {
// Step 1 Start with an empty list.
let mut files = Vec::new();
// Step 2 If the DataTransfer is not associated with a data store return the empty list.
if let Some(data_store) = self.data_store.borrow().as_ref() {
data_store.files(&self.global(), &mut files);
}
// Step 5
FileList::new(self.global().as_window(), files)
}
}

View file

@ -0,0 +1,66 @@
/* 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::rc::Rc;
use dom_struct::dom_struct;
use crate::dom::bindings::callback::ExceptionHandling;
use crate::dom::bindings::codegen::Bindings::DataTransferItemBinding::{
DataTransferItemMethods, FunctionStringCallback,
};
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::file::File;
use crate::dom::globalscope::GlobalScope;
use crate::drag_data_store::Kind;
#[dom_struct]
pub struct DataTransferItem {
reflector_: Reflector,
#[ignore_malloc_size_of = "TODO"]
#[no_trace]
item: Kind,
}
impl DataTransferItem {
fn new_inherited(item: Kind) -> DataTransferItem {
DataTransferItem {
reflector_: Reflector::new(),
item,
}
}
pub fn new(global: &GlobalScope, item: Kind) -> DomRoot<DataTransferItem> {
reflect_dom_object(Box::new(DataTransferItem::new_inherited(item)), global)
}
}
impl DataTransferItemMethods<crate::DomTypeHolder> for DataTransferItem {
/// <https://html.spec.whatwg.org/multipage/#dom-datatransferitem-kind>
fn Kind(&self) -> DOMString {
match self.item {
Kind::Text(_) => DOMString::from("string"),
Kind::File(_) => DOMString::from("file"),
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransferitem-type>
fn Type(&self) -> DOMString {
self.item.type_()
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransferitem-getasstring>
fn GetAsString(&self, callback: Option<Rc<FunctionStringCallback>>) {
if let (Some(callback), Some(data)) = (callback, self.item.as_string()) {
let _ = callback.Call__(data, ExceptionHandling::Report);
}
}
/// <https://html.spec.whatwg.org/multipage/#dom-datatransferitem-getasfile>
fn GetAsFile(&self) -> Option<DomRoot<File>> {
self.item.as_file(&self.global())
}
}

View file

@ -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();
}
}
}

View file

@ -97,9 +97,17 @@ impl File {
)
}
pub fn file_bytes(&self) -> Result<Vec<u8>, ()> {
self.blob.get_bytes()
}
pub fn name(&self) -> &DOMString {
&self.name
}
pub fn file_type(&self) -> String {
self.blob.type_string()
}
}
impl FileMethods<crate::DomTypeHolder> for File {

View file

@ -200,6 +200,10 @@ impl HTMLImageElement {
State::PartiallyAvailable | State::Unavailable => Ok(false),
}
}
pub fn image_data(&self) -> Option<Arc<Image>> {
self.current_request.borrow().image.clone()
}
}
/// The context required for asynchronously loading an external image.

View file

@ -278,6 +278,9 @@ pub mod cssstylevalue;
pub mod csssupportsrule;
pub mod customelementregistry;
pub mod customevent;
pub mod datatransfer;
pub mod datatransferitem;
pub mod datatransferitemlist;
pub mod dedicatedworkerglobalscope;
pub mod dissimilaroriginlocation;
pub mod dissimilaroriginwindow;

View file

@ -0,0 +1,24 @@
/* 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/. */
// https://html.spec.whatwg.org/multipage/#datatransfer
[Exposed=Window]
interface DataTransfer {
constructor();
attribute DOMString dropEffect;
attribute DOMString effectAllowed;
[SameObject] readonly attribute DataTransferItemList items;
undefined setDragImage(Element image, long x, long y);
/* old interface */
readonly attribute /* FrozenArray<DOMString> */ any types;
DOMString getData(DOMString format);
undefined setData(DOMString format, DOMString data);
undefined clearData(optional DOMString format);
[SameObject] readonly attribute FileList files;
};

View file

@ -0,0 +1,15 @@
/* 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/. */
// https://html.spec.whatwg.org/multipage/#datatransferitem
[Exposed=Window]
interface DataTransferItem {
readonly attribute DOMString kind;
readonly attribute DOMString type;
undefined getAsString(FunctionStringCallback? _callback);
File? getAsFile();
};
callback FunctionStringCallback = undefined (DOMString data);

View file

@ -0,0 +1,15 @@
/* 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/. */
// https://html.spec.whatwg.org/multipage/#datatransferitemlist
[Exposed=Window]
interface DataTransferItemList {
readonly attribute unsigned long length;
getter DataTransferItem (unsigned long index);
[Throws] DataTransferItem? add(DOMString data, DOMString type);
[Throws] DataTransferItem? add(File data);
[Throws] undefined remove(unsigned long index);
undefined clear();
};