132 lines
5.2 KiB
C++
132 lines
5.2 KiB
C++
/*
|
|
* Copyright (C) 2012-2021 Apple Inc. All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
|
|
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
|
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
|
|
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
|
|
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include "DataOwnerType.h"
|
|
#include <wtf/Forward.h>
|
|
#include <wtf/Function.h>
|
|
#include <wtf/RetainPtr.h>
|
|
#include <wtf/Vector.h>
|
|
|
|
#if PLATFORM(MAC)
|
|
OBJC_CLASS NSPasteboard;
|
|
OBJC_CLASS NSPasteboardItem;
|
|
#endif
|
|
|
|
#if PLATFORM(IOS_FAMILY)
|
|
OBJC_CLASS UIPasteboard;
|
|
#endif
|
|
|
|
#if USE(LIBWPE)
|
|
struct wpe_pasteboard;
|
|
#endif
|
|
|
|
namespace WebCore {
|
|
|
|
class Color;
|
|
class PasteboardCustomData;
|
|
class SelectionData;
|
|
class SharedBuffer;
|
|
struct PasteboardImage;
|
|
struct PasteboardItemInfo;
|
|
struct PasteboardURL;
|
|
struct PasteboardWebContent;
|
|
|
|
class PlatformPasteboard {
|
|
public:
|
|
WEBCORE_EXPORT explicit PlatformPasteboard(const String& pasteboardName);
|
|
#if PLATFORM(IOS_FAMILY) || USE(LIBWPE)
|
|
WEBCORE_EXPORT PlatformPasteboard();
|
|
WEBCORE_EXPORT void updateSupportedTypeIdentifiers(const Vector<String>& types);
|
|
#endif
|
|
WEBCORE_EXPORT std::optional<PasteboardItemInfo> informationForItemAtIndex(size_t index, int64_t changeCount);
|
|
WEBCORE_EXPORT std::optional<Vector<PasteboardItemInfo>> allPasteboardItemInfo(int64_t changeCount);
|
|
|
|
WEBCORE_EXPORT static void performAsDataOwner(DataOwnerType, Function<void()>&&);
|
|
|
|
enum class IncludeImageTypes : bool { No, Yes };
|
|
static String platformPasteboardTypeForSafeTypeForDOMToReadAndWrite(const String& domType, IncludeImageTypes = IncludeImageTypes::No);
|
|
|
|
WEBCORE_EXPORT void getTypes(Vector<String>& types);
|
|
WEBCORE_EXPORT RefPtr<SharedBuffer> bufferForType(const String& pasteboardType);
|
|
WEBCORE_EXPORT void getPathnamesForType(Vector<String>& pathnames, const String& pasteboardType) const;
|
|
WEBCORE_EXPORT String stringForType(const String& pasteboardType) const;
|
|
WEBCORE_EXPORT Vector<String> allStringsForType(const String& pasteboardType) const;
|
|
WEBCORE_EXPORT int64_t changeCount() const;
|
|
WEBCORE_EXPORT Color color();
|
|
WEBCORE_EXPORT URL url();
|
|
|
|
// Take ownership of the pasteboard, and return new change count.
|
|
WEBCORE_EXPORT int64_t addTypes(const Vector<String>& pasteboardTypes);
|
|
WEBCORE_EXPORT int64_t setTypes(const Vector<String>& pasteboardTypes);
|
|
|
|
// These methods will return 0 if pasteboard ownership has been taken from us.
|
|
WEBCORE_EXPORT int64_t copy(const String& fromPasteboard);
|
|
WEBCORE_EXPORT int64_t setBufferForType(SharedBuffer*, const String& pasteboardType);
|
|
WEBCORE_EXPORT int64_t setURL(const PasteboardURL&);
|
|
WEBCORE_EXPORT int64_t setColor(const Color&);
|
|
WEBCORE_EXPORT int64_t setStringForType(const String&, const String& pasteboardType);
|
|
WEBCORE_EXPORT void write(const PasteboardWebContent&);
|
|
WEBCORE_EXPORT void write(const PasteboardImage&);
|
|
WEBCORE_EXPORT void write(const String& pasteboardType, const String&);
|
|
WEBCORE_EXPORT void write(const PasteboardURL&);
|
|
WEBCORE_EXPORT RefPtr<SharedBuffer> readBuffer(size_t index, const String& pasteboardType) const;
|
|
WEBCORE_EXPORT String readString(size_t index, const String& pasteboardType) const;
|
|
WEBCORE_EXPORT URL readURL(size_t index, String& title) const;
|
|
WEBCORE_EXPORT int count() const;
|
|
WEBCORE_EXPORT int numberOfFiles() const;
|
|
WEBCORE_EXPORT int64_t write(const Vector<PasteboardCustomData>&);
|
|
WEBCORE_EXPORT int64_t write(const PasteboardCustomData&);
|
|
WEBCORE_EXPORT Vector<String> typesSafeForDOMToReadAndWrite(const String& origin) const;
|
|
WEBCORE_EXPORT bool containsStringSafeForDOMToReadForType(const String&) const;
|
|
|
|
#if PLATFORM(COCOA)
|
|
WEBCORE_EXPORT bool containsURLStringSuitableForLoading();
|
|
WEBCORE_EXPORT String urlStringSuitableForLoading(String& title);
|
|
#endif
|
|
|
|
private:
|
|
#if PLATFORM(IOS_FAMILY)
|
|
bool allowReadingURLAtIndex(const URL&, int index) const;
|
|
#endif
|
|
|
|
#if PLATFORM(MAC)
|
|
NSPasteboardItem *itemAtIndex(size_t index) const;
|
|
#endif
|
|
|
|
#if PLATFORM(MAC)
|
|
RetainPtr<NSPasteboard> m_pasteboard;
|
|
#endif
|
|
#if PLATFORM(IOS_FAMILY)
|
|
RetainPtr<id> m_pasteboard;
|
|
#endif
|
|
#if USE(LIBWPE)
|
|
struct wpe_pasteboard* m_pasteboard;
|
|
#endif
|
|
};
|
|
|
|
} // namespace WebCore
|