summaryrefslogtreecommitdiffstats
path: root/widget/tests/clipboard_helper.js
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /widget/tests/clipboard_helper.js
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'widget/tests/clipboard_helper.js')
-rw-r--r--widget/tests/clipboard_helper.js230
1 files changed, 230 insertions, 0 deletions
diff --git a/widget/tests/clipboard_helper.js b/widget/tests/clipboard_helper.js
new file mode 100644
index 0000000000..96787468fb
--- /dev/null
+++ b/widget/tests/clipboard_helper.js
@@ -0,0 +1,230 @@
+/* Any copyright is dedicated to the Public Domain.
+ http://creativecommons.org/publicdomain/zero/1.0/ */
+
+"use strict";
+
+const Cc = SpecialPowers.Cc;
+const Ci = SpecialPowers.Ci;
+const Cr = SpecialPowers.Cr;
+const clipboard = SpecialPowers.Services.clipboard;
+const clipboardTypes = [
+ clipboard.kGlobalClipboard,
+ clipboard.kSelectionClipboard,
+ clipboard.kFindClipboard,
+ clipboard.kSelectionCache,
+];
+
+function emptyClipboardData(aType) {
+ // XXX gtk doesn't support emptying clipboard data which is stored from
+ // other application (bug 1853884). As a workaround, we set dummy data
+ // to the clipboard first to ensure the subsequent emptyClipboard call
+ // works.
+ if (navigator.platform.includes("Linux")) {
+ writeStringToClipboard("foo", "text/plain", aType);
+ }
+
+ clipboard.emptyClipboard(aType);
+}
+
+function cleanupAllClipboard() {
+ clipboardTypes.forEach(function (type) {
+ if (clipboard.isClipboardTypeSupported(type)) {
+ info(`cleanup clipboard ${type}`);
+ emptyClipboardData(type);
+ }
+ });
+}
+
+function generateRandomString() {
+ return "random number: " + Math.random();
+}
+
+function generateNewTransferable(aFlavor, aStr) {
+ let trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
+ Ci.nsITransferable
+ );
+ trans.init(null);
+ trans.addDataFlavor(aFlavor);
+
+ let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
+ Ci.nsISupportsString
+ );
+ supportsStr.data = aStr;
+ trans.setTransferData(aFlavor, supportsStr);
+
+ return trans;
+}
+
+function addStringToTransferable(aFlavor, aStr, aTrans) {
+ aTrans.addDataFlavor(aFlavor);
+
+ let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
+ Ci.nsISupportsString
+ );
+ supportsStr.data = aStr;
+ aTrans.setTransferData(aFlavor, supportsStr);
+}
+
+function updateStringToTransferable(aFlavor, aStr, aTrans) {
+ let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
+ Ci.nsISupportsString
+ );
+ supportsStr.data = aStr;
+ aTrans.setTransferData(aFlavor, supportsStr);
+}
+
+function writeStringToClipboard(
+ aStr,
+ aFlavor,
+ aClipboardType,
+ aClipboardOwner = null,
+ aAsync = false
+) {
+ let trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
+ Ci.nsITransferable
+ );
+ trans.init(null);
+ trans.addDataFlavor(aFlavor);
+
+ let supportsStr = Cc["@mozilla.org/supports-string;1"].createInstance(
+ Ci.nsISupportsString
+ );
+ supportsStr.data = aStr;
+ trans.setTransferData(aFlavor, supportsStr);
+
+ if (aAsync) {
+ let request = clipboard.asyncSetData(aClipboardType);
+ request.setData(trans, aClipboardOwner);
+ return;
+ }
+
+ clipboard.setData(trans, aClipboardOwner, aClipboardType);
+ // XXX gtk doesn't support get empty text data from clipboard, bug 1852983.
+ if (aStr == "" && navigator.platform.includes("Linux")) {
+ todo_is(
+ getClipboardData(aFlavor, aClipboardType),
+ "",
+ `Should get empty string on clipboard type ${aClipboardType}`
+ );
+ } else {
+ is(
+ getClipboardData(aFlavor, aClipboardType),
+ // On Windows, widget adds extra data into HTML clipboard.
+ aFlavor == "text/html" && navigator.platform.includes("Win")
+ ? `<html><body>\n<!--StartFragment-->${aStr}<!--EndFragment-->\n</body>\n</html>`
+ : aStr,
+ "ensure clipboard data is set"
+ );
+ }
+}
+
+function writeRandomStringToClipboard(
+ aFlavor,
+ aClipboardType,
+ aClipboardOwner = null,
+ aAsync = false
+) {
+ let randomString = generateRandomString();
+ writeStringToClipboard(
+ randomString,
+ aFlavor,
+ aClipboardType,
+ aClipboardOwner,
+ aAsync
+ );
+ return randomString;
+}
+
+function getClipboardData(aFlavor, aClipboardType) {
+ var trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
+ Ci.nsITransferable
+ );
+ trans.init(null);
+ trans.addDataFlavor(aFlavor);
+ clipboard.getData(
+ trans,
+ aClipboardType,
+ SpecialPowers.wrap(window).browsingContext.currentWindowContext
+ );
+
+ try {
+ var data = SpecialPowers.createBlankObject();
+ trans.getTransferData(aFlavor, data);
+ return data.value.QueryInterface(SpecialPowers.Ci.nsISupportsString).data;
+ } catch (ex) {
+ // If the clipboard is empty getTransferData will throw.
+ return null;
+ }
+}
+
+function asyncGetClipboardData(aClipboardType) {
+ return new Promise((resolve, reject) => {
+ try {
+ clipboard.asyncGetData(
+ ["text/plain", "text/html", "image/png"],
+ aClipboardType,
+ null,
+ SpecialPowers.Services.scriptSecurityManager.getSystemPrincipal(),
+ {
+ QueryInterface: SpecialPowers.ChromeUtils.generateQI([
+ "nsIAsyncClipboardGetCallback",
+ ]),
+ // nsIAsyncClipboardGetCallback
+ onSuccess: SpecialPowers.wrapCallback(function (
+ aAsyncGetClipboardData
+ ) {
+ resolve(aAsyncGetClipboardData);
+ }),
+ onError: SpecialPowers.wrapCallback(function (aResult) {
+ reject(aResult);
+ }),
+ }
+ );
+ } catch (e) {
+ ok(false, `asyncGetData should not throw`);
+ reject(e);
+ }
+ });
+}
+
+function asyncClipboardRequestGetData(aRequest, aFlavor, aThrows = false) {
+ return new Promise((resolve, reject) => {
+ var trans = Cc["@mozilla.org/widget/transferable;1"].createInstance(
+ Ci.nsITransferable
+ );
+ trans.init(null);
+ trans.addDataFlavor(aFlavor);
+ try {
+ aRequest.getData(trans, aResult => {
+ if (aResult != Cr.NS_OK) {
+ reject(aResult);
+ return;
+ }
+
+ try {
+ var data = SpecialPowers.createBlankObject();
+ trans.getTransferData(aFlavor, data);
+ resolve(data.value.QueryInterface(Ci.nsISupportsString).data);
+ } catch (ex) {
+ // XXX: should widget set empty string to transferable when there no
+ // data in system clipboard?
+ resolve("");
+ }
+ });
+ ok(
+ !aThrows,
+ `nsIAsyncGetClipboardData.getData should ${
+ aThrows ? "throw" : "success"
+ }`
+ );
+ } catch (e) {
+ ok(
+ aThrows,
+ `nsIAsyncGetClipboardData.getData should ${
+ aThrows ? "throw" : "success"
+ }`
+ );
+ reject(e);
+ }
+ });
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-19 19:05:02 +0000