Source code

Revision control

Copy as Markdown

Other Tools

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 */
#ifndef mozilla_dom_Clipboard_h_
#define mozilla_dom_Clipboard_h_
#include "nsString.h"
#include "nsStringFwd.h"
#include "mozilla/DOMEventTargetHelper.h"
#include "mozilla/Logging.h"
#include "mozilla/RefPtr.h"
#include "mozilla/UniquePtr.h"
class nsIAsyncGetClipboardData;
namespace mozilla::dom {
class Promise;
class ClipboardItem;
class Clipboard : public DOMEventTargetHelper {
explicit Clipboard(nsPIDOMWindowInner* aWindow);
already_AddRefed<Promise> Read(nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv);
already_AddRefed<Promise> ReadText(nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv);
already_AddRefed<Promise> Write(
const Sequence<OwningNonNull<ClipboardItem>>& aData,
nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv);
already_AddRefed<Promise> WriteText(const nsAString& aData,
nsIPrincipal& aSubjectPrincipal,
ErrorResult& aRv);
static LogModule* GetClipboardLog();
// Check if the Clipboard.readText API should be enabled for this context.
// This API is only enabled for Extension and System contexts, as there is no
// way to request the required permission for web content. If the clipboard
// API testing pref is enabled, ReadText is enabled for web content for
// testing purposes.
static bool ReadTextEnabled(JSContext* aCx, JSObject* aGlobal);
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
enum class ReadRequestType {
// Checks if pref is enabled.
// The aforementioned pref allows automated tests to bypass the security
// checks when writing to
// or reading from the clipboard.
static bool IsTestingPrefEnabled();
static bool IsTestingPrefEnabledOrHasReadPermission(
nsIPrincipal& aSubjectPrincipal);
already_AddRefed<Promise> ReadHelper(nsIPrincipal& aSubjectPrincipal,
ReadRequestType aType, ErrorResult& aRv);
void RequestRead(Promise* aPromise, ReadRequestType aType,
nsPIDOMWindowInner* aOwner, nsIPrincipal& aPrincipal);
void RequestRead(Promise& aPromise, const ReadRequestType& aType,
nsPIDOMWindowInner& aOwner, nsIPrincipal& aSubjectPrincipal,
nsIAsyncGetClipboardData& aRequest);
} // namespace mozilla::dom
#endif // mozilla_dom_Clipboard_h_