6cede05e2a33287eb2bd6b4a24e5ebd523064bb4
[WebKit-https.git] / Source / WebKit / UIProcess / WebPasteboardProxy.h
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "MessageReceiver.h"
29 #include "SandboxExtension.h"
30 #include "SharedMemory.h"
31 #include <wtf/Forward.h>
32 #include <wtf/HashSet.h>
33
34 namespace WebCore {
35 class Color;
36 struct PasteboardCustomData;
37 struct PasteboardImage;
38 struct PasteboardURL;
39 struct PasteboardWebContent;
40 }
41
42 namespace WebKit {
43
44 class WebFrameProxy;
45 class WebProcessProxy;
46 struct WebSelectionData;
47
48 class WebPasteboardProxy : public IPC::MessageReceiver {
49     WTF_MAKE_NONCOPYABLE(WebPasteboardProxy);
50     friend class LazyNeverDestroyed<WebPasteboardProxy>;
51 public:
52     static WebPasteboardProxy& singleton();
53
54     void addWebProcessProxy(WebProcessProxy&);
55     void removeWebProcessProxy(WebProcessProxy&);
56
57 #if PLATFORM(GTK)
58     void setPrimarySelectionOwner(WebFrameProxy*);
59     void didDestroyFrame(WebFrameProxy*);
60 #endif
61
62 private:
63     WebPasteboardProxy();
64     
65     typedef HashSet<WebProcessProxy*> WebProcessProxyList;
66
67     void didReceiveMessage(IPC::Connection&, IPC::Decoder&) override;
68     void didReceiveSyncMessage(IPC::Connection&, IPC::Decoder&, std::unique_ptr<IPC::Encoder>&) override;
69
70 #if PLATFORM(IOS)
71     void getPasteboardTypesByFidelityForItemAtIndex(uint64_t index, const String& pasteboardName, Vector<String>& types);
72     void writeURLToPasteboard(const WebCore::PasteboardURL&, const String& pasteboardName);
73     void writeWebContentToPasteboard(const WebCore::PasteboardWebContent&, const String& pasteboardName);
74     void writeImageToPasteboard(const WebCore::PasteboardImage&, const String& pasteboardName);
75     void writeStringToPasteboard(const String& pasteboardType, const String&, const String& pasteboardName);
76     void readStringFromPasteboard(uint64_t index, const String& pasteboardType, const String& pasteboardName, WTF::String&);
77     void readURLFromPasteboard(uint64_t index, const String& pasteboardType, const String& pasteboardName, String& url, String& title);
78     void readBufferFromPasteboard(uint64_t index, const String& pasteboardType, const String& pasteboardName, SharedMemory::Handle&, uint64_t& size);
79     void getPasteboardItemsCount(const String& pasteboardName, uint64_t& itemsCount);
80     void getFilenamesForDataInteraction(const String& pasteboardName, Vector<String>& filenames);
81     void updateSupportedTypeIdentifiers(const Vector<String>& identifiers, const String& pasteboardName);
82 #endif
83 #if PLATFORM(COCOA)
84     void getNumberOfFiles(const String& pasteboardName, uint64_t& numberOfFiles);
85     void getPasteboardTypes(const String& pasteboardName, Vector<String>& pasteboardTypes);
86     void getPasteboardPathnamesForType(IPC::Connection&, const String& pasteboardName, const String& pasteboardType, Vector<String>& pathnames, SandboxExtension::HandleArray&);
87     void getPasteboardStringForType(const String& pasteboardName, const String& pasteboardType, String&);
88     void getPasteboardBufferForType(const String& pasteboardName, const String& pasteboardType, SharedMemory::Handle&, uint64_t& size);
89     void pasteboardCopy(const String& fromPasteboard, const String& toPasteboard, uint64_t& newChangeCount);
90     void getPasteboardChangeCount(const String& pasteboardName, uint64_t& changeCount);
91     void getPasteboardUniqueName(String& pasteboardName);
92     void getPasteboardColor(const String& pasteboardName, WebCore::Color&);
93     void getPasteboardURL(const String& pasteboardName, WTF::String&);
94     void addPasteboardTypes(const String& pasteboardName, const Vector<String>& pasteboardTypes, uint64_t& newChangeCount);
95     void setPasteboardTypes(const String& pasteboardName, const Vector<String>& pasteboardTypes, uint64_t& newChangeCount);
96     void setPasteboardPathnamesForType(IPC::Connection&, const String& pasteboardName, const String& pasteboardType, const Vector<String>& pathnames, uint64_t& newChangeCount);
97     void setPasteboardStringForType(const String& pasteboardName, const String& pasteboardType, const String&, uint64_t& newChangeCount);
98     void setPasteboardBufferForType(const String& pasteboardName, const String& pasteboardType, const SharedMemory::Handle&, uint64_t size, uint64_t& newChangeCount);
99 #endif
100
101     void writeCustomData(const WebCore::PasteboardCustomData&, const String& pasteboardName, uint64_t& newChangeCount);
102     void typesSafeForDOMToReadAndWrite(const String& pasteboardName, const String& origin, Vector<String>& types);
103
104 #if PLATFORM(GTK)
105     void writeToClipboard(const String& pasteboardName, const WebSelectionData&);
106     void readFromClipboard(const String& pasteboardName, WebSelectionData&);
107
108     WebFrameProxy* m_primarySelectionOwner { nullptr };
109     WebFrameProxy* m_frameWritingToClipboard { nullptr };
110 #endif // PLATFORM(GTK)
111
112 #if PLATFORM(WPE)
113     void getPasteboardTypes(Vector<String>& pasteboardTypes);
114     void readStringFromPasteboard(uint64_t index, const String& pasteboardType, WTF::String&);
115     void writeWebContentToPasteboard(const WebCore::PasteboardWebContent&);
116     void writeStringToPasteboard(const String& pasteboardType, const String&);
117 #endif
118
119     WebProcessProxyList m_webProcessProxyList;
120 };
121
122 } // namespace WebKit