1951225 - Make {Async}GetNativeClipboardData() more flexible to use

Status: RESOLVED FIXED

(Core :: DOM: Copy & Paste and Drag & Drop, enhancement)

Description

[Edgar Chen [:edgar]]

Currently, nsIClipboardDataSnapshot.getData{Sync}() retrieves only the first available type of nsITransferable and throws an error if nsITransferable contains a type not in the flavor list. This behavior is primarily due to how each platform implements GetNativeClipboardData(). So when we would like to get data for multiple types, we would need to create a temporary nsITransferable contains only one type for each type that we want to load, e.g. https://searchfox.org/mozilla-central/rev/3b3c7a0c930a5451be3b4088ed795ce01ddf002e/editor/libeditor/EditorBase.cpp#7368-7402.

I think we could try to make nsIClipboardDataSnapshot.getData{Sync}() more flexible to use to support load all available type in nsITransferable and ignore the type if it doesn't in the available flavor list (instead of throwing an error).

In order to support this, we might need to modify the GetNativeClipboardData to make it more flexible to use as well, for example

Result<nsCOMPtr<nsISupports>, nsresult> GetNativeClipboardData(ClipboardType aWhichClipboard, const nsACString& aFlavor);

which takes a MIME type and returns the corresponding data if it is available. Then we could build the behavior we want on the top of it.

Comment 1

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 1: Introduce new {Async}GetNativeClipboardData();

Comment 2

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 2-1: Implement new GetNativeClipboardData() on cocoa widget;

Comment 3

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 2-2: Implement new GetNativeClipboardData() on headless widget;

Comment 4

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 2-3: Implement new GetNativeClipboardData() on gtk widget;

Comment 5

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 2-4: Implement new GetNativeClipboardData() on windows widget;

Depends on D246858

Comment 6

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 2-5: Implement new GetNativeClipboardData() on geckoview;

Comment 7

[Edgar Chen [:edgar]]

Attachment: Bug 1951225 - Part 3: Get rid of old {Async}GetNativeClipboardData() method;

This should not change behavior.

Comment 8

[Edgar Chen [:edgar]]

To minimize the scope, I’m going to focus this bug on re-implementing {Async}GetNativeClipboardData() to make it more flexible to use. This should not change any existing behavior.

The actual changes to nsIClipboardDataSnapshot.getData{Sync}() — which will then support loading multiple types at once — will be moved to a separate bug.

Comment 9

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/1ee8a4635947
Part 1: Introduce new {Async}GetNativeClipboardData(); r=gstoll
https://hg.mozilla.org/integration/autoland/rev/5841957d7906
Part 2-1: Implement new GetNativeClipboardData() on cocoa widget; r=mac-reviewers,bradwerth
https://hg.mozilla.org/integration/autoland/rev/e572e8ae8990
Part 2-2: Implement new GetNativeClipboardData() on headless widget; r=spohl
https://hg.mozilla.org/integration/autoland/rev/3341c9f1f236
Part 2-3: Implement new GetNativeClipboardData() on gtk widget; r=stransky
https://hg.mozilla.org/integration/autoland/rev/df86f6e87596
Part 2-4: Implement new GetNativeClipboardData() on windows widget; r=win-reviewers,gstoll
https://hg.mozilla.org/integration/autoland/rev/d8cd5b882ef9
Part 2-5: Implement new GetNativeClipboardData() on geckoview; r=geckoview-reviewers,m_kato
https://hg.mozilla.org/integration/autoland/rev/ed97f54128e1
Part 3: Get rid of old {Async}GetNativeClipboardData() method; r=gstoll

Comment 10

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/83c2fa1515ec
Revert Bug 1951225 - for causing failures @test_clipboard_cache_chrome.html.

Comment 11

[agoloman]

Backed out for causing failures @test_clipboard_cache_chrome.html.

• Backout link
• Push with failures
• Failure Log

Comment 12

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/mozilla-central/rev/969f19c27623
Part 1: Introduce new {Async}GetNativeClipboardData(); r=gstoll
https://hg.mozilla.org/mozilla-central/rev/faa6ec3fbf52
Part 2-1: Implement new GetNativeClipboardData() on cocoa widget; r=mac-reviewers,bradwerth
https://hg.mozilla.org/mozilla-central/rev/ca1719d6d9f3
Part 2-2: Implement new GetNativeClipboardData() on headless widget; r=spohl
https://hg.mozilla.org/mozilla-central/rev/e510f759b8fa
Part 2-3: Implement new GetNativeClipboardData() on gtk widget; r=stransky
https://hg.mozilla.org/mozilla-central/rev/53dbe1e6b485
Part 2-4: Implement new GetNativeClipboardData() on windows widget; r=win-reviewers,gstoll
https://hg.mozilla.org/mozilla-central/rev/7bc5a6f9ee17
Part 2-5: Implement new GetNativeClipboardData() on geckoview; r=geckoview-reviewers,m_kato
https://hg.mozilla.org/mozilla-central/rev/36d8024d7f3f
Part 3: Get rid of old {Async}GetNativeClipboardData() method; r=gstoll

Comment 13

[agoloman]

https://hg.mozilla.org/mozilla-central/rev/969f19c27623
https://hg.mozilla.org/mozilla-central/rev/faa6ec3fbf52
https://hg.mozilla.org/mozilla-central/rev/ca1719d6d9f3
https://hg.mozilla.org/mozilla-central/rev/e510f759b8fa
https://hg.mozilla.org/mozilla-central/rev/53dbe1e6b485
https://hg.mozilla.org/mozilla-central/rev/7bc5a6f9ee17
https://hg.mozilla.org/mozilla-central/rev/36d8024d7f3f