From 26a029d407be480d791972afb5975cf62c9360a6 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Fri, 19 Apr 2024 02:47:55 +0200 Subject: Adding upstream version 124.0.1. Signed-off-by: Daniel Baumann --- widget/gtk/nsClipboard.h | 177 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 177 insertions(+) create mode 100644 widget/gtk/nsClipboard.h (limited to 'widget/gtk/nsClipboard.h') diff --git a/widget/gtk/nsClipboard.h b/widget/gtk/nsClipboard.h new file mode 100644 index 0000000000..0ddbb59827 --- /dev/null +++ b/widget/gtk/nsClipboard.h @@ -0,0 +1,177 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* vim:expandtab:shiftwidth=2:tabstop=2: + */ +/* 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/. */ + +#ifndef __nsClipboard_h_ +#define __nsClipboard_h_ + +#include "mozilla/UniquePtr.h" +#include "mozilla/Span.h" +#include "nsBaseClipboard.h" +#include "nsIClipboard.h" +#include "nsIObserver.h" +#include "nsCOMPtr.h" +#include "GUniquePtr.h" +#include + +#ifdef MOZ_LOGGING +# include "mozilla/Logging.h" +# include "nsTArray.h" +# include "Units.h" +extern mozilla::LazyLogModule gClipboardLog; +# define LOGCLIP(...) \ + MOZ_LOG(gClipboardLog, mozilla::LogLevel::Debug, (__VA_ARGS__)) +# define LOGCLIP_ENABLED() \ + MOZ_LOG_TEST(gClipboardLog, mozilla::LogLevel::Debug) +#else +# define LOGCLIP(...) +# define LOGCLIP_ENABLED() false +#endif /* MOZ_LOGGING */ + +class ClipboardTargets { + friend class ClipboardData; + + mozilla::GUniquePtr mTargets; + uint32_t mCount = 0; + + public: + ClipboardTargets() = default; + ClipboardTargets(mozilla::GUniquePtr aTargets, uint32_t aCount) + : mTargets(std::move(aTargets)), mCount(aCount) {} + + void Set(ClipboardTargets); + ClipboardTargets Clone(); + void Clear() { + mTargets = nullptr; + mCount = 0; + }; + + mozilla::Span AsSpan() const { return {mTargets.get(), mCount}; } + explicit operator bool() const { return bool(mTargets); } +}; + +class ClipboardData { + mozilla::GUniquePtr mData; + uint32_t mLength = 0; + + public: + ClipboardData() = default; + + void SetData(mozilla::Span); + void SetText(mozilla::Span); + void SetTargets(ClipboardTargets); + + ClipboardTargets ExtractTargets(); + mozilla::GUniquePtr ExtractText() { + mLength = 0; + return std::move(mData); + } + + mozilla::Span AsSpan() const { return {mData.get(), mLength}; } + explicit operator bool() const { return bool(mData); } +}; + +enum class ClipboardDataType { Data, Text, Targets }; + +class nsRetrievalContext { + public: + // We intentionally use unsafe thread refcount as clipboard is used in + // main thread only. + NS_INLINE_DECL_REFCOUNTING(nsRetrievalContext) + + // Get actual clipboard content (GetClipboardData/GetClipboardText). + virtual ClipboardData GetClipboardData(const char* aMimeType, + int32_t aWhichClipboard) = 0; + virtual mozilla::GUniquePtr GetClipboardText( + int32_t aWhichClipboard) = 0; + + // Get data mime types which can be obtained from clipboard. + ClipboardTargets GetTargets(int32_t aWhichClipboard); + + // Clipboard/Primary selection owner changed. Clear internal cached data. + static void ClearCachedTargetsClipboard(GtkClipboard* aClipboard, + GdkEvent* aEvent, gpointer data); + static void ClearCachedTargetsPrimary(GtkClipboard* aClipboard, + GdkEvent* aEvent, gpointer data); + + nsRetrievalContext() = default; + + protected: + virtual ClipboardTargets GetTargetsImpl(int32_t aWhichClipboard) = 0; + virtual ~nsRetrievalContext(); + + static ClipboardTargets sClipboardTargets; + static ClipboardTargets sPrimaryTargets; +}; + +class nsClipboard : public nsBaseClipboard, public nsIObserver { + public: + nsClipboard(); + + NS_DECL_ISUPPORTS_INHERITED + NS_DECL_NSIOBSERVER + + // Make sure we are initialized, called from the factory + // constructor + nsresult Init(void); + + // Someone requested the selection + void SelectionGetEvent(GtkClipboard* aGtkClipboard, + GtkSelectionData* aSelectionData); + void SelectionClearEvent(GtkClipboard* aGtkClipboard); + + // Clipboard owner changed + void OwnerChangedEvent(GtkClipboard* aGtkClipboard, + GdkEventOwnerChange* aEvent); + + protected: + // Implement the native clipboard behavior. + NS_IMETHOD SetNativeClipboardData(nsITransferable* aTransferable, + int32_t aWhichClipboard) override; + NS_IMETHOD GetNativeClipboardData(nsITransferable* aTransferable, + int32_t aWhichClipboard) override; + void AsyncGetNativeClipboardData(nsITransferable* aTransferable, + int32_t aWhichClipboard, + GetDataCallback&& aCallback) override; + nsresult EmptyNativeClipboardData(int32_t aWhichClipboard) override; + mozilla::Result GetNativeClipboardSequenceNumber( + int32_t aWhichClipboard) override; + mozilla::Result HasNativeClipboardDataMatchingFlavors( + const nsTArray& aFlavorList, int32_t aWhichClipboard) override; + void AsyncHasNativeClipboardDataMatchingFlavors( + const nsTArray& aFlavorList, int32_t aWhichClipboard, + HasMatchingFlavorsCallback&& aCallback) override; + + private: + virtual ~nsClipboard(); + + // Get our hands on the correct transferable, given a specific + // clipboard + nsITransferable* GetTransferable(int32_t aWhichClipboard); + + void ClearTransferable(int32_t aWhichClipboard); + void ClearCachedTargets(int32_t aWhichClipboard); + + bool FilterImportedFlavors(int32_t aWhichClipboard, + nsTArray& aFlavors); + + // Hang on to our transferables so we can transfer data when asked. + nsCOMPtr mSelectionTransferable; + nsCOMPtr mGlobalTransferable; + RefPtr mContext; + + // Sequence number of the system clipboard data. + int32_t mSelectionSequenceNumber = 0; + int32_t mGlobalSequenceNumber = 0; +}; + +extern const int kClipboardTimeout; +extern const int kClipboardFastIterationNum; + +GdkAtom GetSelectionAtom(int32_t aWhichClipboard); +int GetGeckoClipboardType(GtkClipboard* aGtkClipboard); + +#endif /* __nsClipboard_h_ */ -- cgit v1.2.3