14d089b29900eea7b2354be065a9c8c9b9f908dd
[WebKit-https.git] / Source / WebCore / platform / Pasteboard.h
1 /*
2  * Copyright (C) 2006, 2013 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "DragImage.h"
29 #include "URL.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/ListHashSet.h>
32 #include <wtf/Noncopyable.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 #if PLATFORM(IOS)
37 OBJC_CLASS NSString;
38 #endif
39
40 #if PLATFORM(COCOA)
41 OBJC_CLASS NSArray;
42 #endif
43
44 #if PLATFORM(WIN)
45 #include "COMPtr.h"
46 #include "WCDataObject.h"
47 #include <objidl.h>
48 #include <windows.h>
49 typedef struct HWND__* HWND;
50 #endif
51
52 // FIXME: This class uses the DOM and makes calls to Editor.
53 // It should be divested of its knowledge of the frame and editor.
54
55 namespace WebCore {
56
57 class DocumentFragment;
58 class DragData;
59 class Element;
60 class Frame;
61 class PasteboardStrategy;
62 class Range;
63 class SelectionData;
64 class SharedBuffer;
65
66 enum ShouldSerializeSelectedTextForDataTransfer { DefaultSelectedTextType, IncludeImageAltTextForDataTransfer };
67
68 // For writing to the pasteboard. Generally sorted with the richest formats on top.
69
70 struct PasteboardWebContent {
71 #if PLATFORM(COCOA)
72     WEBCORE_EXPORT PasteboardWebContent();
73     WEBCORE_EXPORT ~PasteboardWebContent();
74     bool canSmartCopyOrDelete;
75     RefPtr<SharedBuffer> dataInWebArchiveFormat;
76     RefPtr<SharedBuffer> dataInRTFDFormat;
77     RefPtr<SharedBuffer> dataInRTFFormat;
78     RefPtr<SharedBuffer> dataInAttributedStringFormat;
79     String dataInHTMLFormat;
80     String dataInStringFormat;
81     Vector<String> clientTypes;
82     Vector<RefPtr<SharedBuffer>> clientData;
83 #endif
84 #if PLATFORM(GTK)
85     bool canSmartCopyOrDelete;
86     String text;
87     String markup;
88 #endif
89 #if PLATFORM(WPE)
90     String text;
91     String markup;
92 #endif
93 };
94
95 struct PasteboardURL {
96     URL url;
97     String title;
98 #if PLATFORM(MAC)
99     String userVisibleForm;
100 #endif
101 #if PLATFORM(GTK)
102     String markup;
103 #endif
104 };
105
106 struct PasteboardImage {
107     WEBCORE_EXPORT PasteboardImage();
108     WEBCORE_EXPORT ~PasteboardImage();
109     RefPtr<Image> image;
110 #if PLATFORM(MAC)
111     RefPtr<SharedBuffer> dataInWebArchiveFormat;
112 #endif
113 #if !PLATFORM(WIN)
114     PasteboardURL url;
115 #endif
116 #if !(PLATFORM(GTK) || PLATFORM(WIN))
117     RefPtr<SharedBuffer> resourceData;
118     String resourceMIMEType;
119     Vector<String> clientTypes;
120     Vector<RefPtr<SharedBuffer>> clientData;
121 #endif
122     String suggestedName;
123     FloatSize imageSize;
124 };
125
126 // For reading from the pasteboard.
127
128 class PasteboardWebContentReader {
129 public:
130     virtual ~PasteboardWebContentReader() { }
131
132 #if !(PLATFORM(GTK) || PLATFORM(WIN))
133     virtual bool readWebArchive(SharedBuffer&) = 0;
134     virtual bool readFilenames(const Vector<String>&) = 0;
135     virtual bool readHTML(const String&) = 0;
136     virtual bool readRTFD(SharedBuffer&) = 0;
137     virtual bool readRTF(SharedBuffer&) = 0;
138     virtual bool readImage(Ref<SharedBuffer>&&, const String& type) = 0;
139     virtual bool readURL(const URL&, const String& title) = 0;
140 #endif
141     virtual bool readPlainText(const String&) = 0;
142 };
143
144 struct PasteboardPlainText {
145     String text;
146 #if PLATFORM(COCOA)
147     bool isURL;
148 #endif
149 };
150
151 struct PasteboardFileReader {
152     virtual ~PasteboardFileReader() = default;
153     virtual void readFilename(const String&) = 0;
154     virtual void readBuffer(const String& filename, const String& type, Ref<SharedBuffer>&&) = 0;
155 };
156
157 // FIXME: We need to ensure that the contents of sameOriginCustomData are not accessible across different origins.
158 struct PasteboardCustomData {
159     String origin;
160     Vector<String> orderedTypes;
161     HashMap<String, String> platformData;
162     HashMap<String, String> sameOriginCustomData;
163
164     WEBCORE_EXPORT Ref<SharedBuffer> createSharedBuffer() const;
165     WEBCORE_EXPORT static PasteboardCustomData fromSharedBuffer(const SharedBuffer&);
166
167 #if PLATFORM(COCOA)
168     static const char* cocoaType();
169 #endif
170 };
171
172 class Pasteboard {
173     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
174 public:
175     Pasteboard();
176     virtual ~Pasteboard();
177
178 #if PLATFORM(GTK)
179     explicit Pasteboard(const String& name);
180     explicit Pasteboard(SelectionData&);
181 #endif
182
183 #if PLATFORM(WIN)
184     explicit Pasteboard(IDataObject*);
185     explicit Pasteboard(WCDataObject*);
186     explicit Pasteboard(const DragDataMap&);
187 #endif
188
189     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForCopyAndPaste();
190
191     static bool isSafeTypeForDOMToReadAndWrite(const String&);
192
193     virtual bool isStatic() const { return false; }
194
195     virtual bool hasData();
196     virtual Vector<String> typesSafeForBindings();
197     virtual Vector<String> typesForLegacyUnsafeBindings();
198     virtual String readString(const String& type);
199     virtual String readStringInCustomData(const String& type);
200
201     virtual void writeString(const String& type, const String& data);
202     virtual void clear();
203     virtual void clear(const String& type);
204
205     virtual void read(PasteboardPlainText&);
206     virtual void read(PasteboardWebContentReader&);
207     virtual void read(PasteboardFileReader&);
208
209     virtual void write(const PasteboardURL&);
210     virtual void writeTrustworthyWebURLsPboardType(const PasteboardURL&);
211     virtual void write(const PasteboardImage&);
212     virtual void write(const PasteboardWebContent&);
213
214     virtual bool containsFiles();
215     virtual bool canSmartReplace();
216
217     virtual void writeMarkup(const String& markup);
218     enum SmartReplaceOption { CanSmartReplace, CannotSmartReplace };
219     virtual WEBCORE_EXPORT void writePlainText(const String&, SmartReplaceOption); // FIXME: Two separate functions would be clearer than one function with an argument.
220
221 #if ENABLE(DRAG_SUPPORT)
222     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop();
223     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop(const DragData&);
224
225     virtual void setDragImage(DragImage, const IntPoint& hotSpot);
226 #endif
227
228 #if PLATFORM(WIN)
229     RefPtr<DocumentFragment> documentFragment(Frame&, Range&, bool allowPlainText, bool& chosePlainText); // FIXME: Layering violation.
230     void writeImage(Element&, const URL&, const String& title); // FIXME: Layering violation.
231     void writeSelection(Range&, bool canSmartCopyOrDelete, Frame&, ShouldSerializeSelectedTextForDataTransfer = DefaultSelectedTextType); // FIXME: Layering violation.
232 #endif
233
234 #if PLATFORM(GTK)
235     const SelectionData& selectionData() const;
236     static std::unique_ptr<Pasteboard> createForGlobalSelection();
237 #endif
238
239 #if PLATFORM(IOS)
240     explicit Pasteboard(long changeCount);
241
242     static NSArray *supportedWebContentPasteboardTypes();
243     static String resourceMIMEType(NSString *mimeType);
244 #endif
245
246 #if PLATFORM(COCOA)
247     explicit Pasteboard(const String& pasteboardName);
248
249     static bool shouldTreatCocoaTypeAsFile(const String&);
250     WEBCORE_EXPORT static NSArray *supportedFileUploadPasteboardTypes();
251     const String& name() const { return m_pasteboardName; }
252     long changeCount() const;
253 #endif
254
255 #if PLATFORM(WIN)
256     COMPtr<IDataObject> dataObject() const { return m_dataObject; }
257     void setExternalDataObject(IDataObject*);
258     const DragDataMap& dragDataMap() const { return m_dragDataMap; }
259     void writeURLToWritableDataObject(const URL&, const String&);
260     COMPtr<WCDataObject> writableDataObject() const { return m_writableDataObject; }
261     void writeImageToDataObject(Element&, const URL&); // FIXME: Layering violation.
262 #endif
263
264     void writeCustomData(const PasteboardCustomData&);
265
266 private:
267 #if PLATFORM(IOS)
268     bool respectsUTIFidelities() const;
269     void readRespectingUTIFidelities(PasteboardWebContentReader&);
270 #endif
271
272 #if PLATFORM(WIN)
273     void finishCreatingPasteboard();
274     void writeRangeToDataObject(Range&, Frame&); // FIXME: Layering violation.
275     void writeURLToDataObject(const URL&, const String&);
276     void writePlainTextToDataObject(const String&, SmartReplaceOption);
277 #endif
278
279 #if PLATFORM(COCOA)
280     Vector<String> readFilenames();
281     String readPlatformValueAsString(const String& domType, long changeCount, const String& pasteboardName);
282     static void addHTMLClipboardTypesForCocoaType(ListHashSet<String>& resultTypes, const String& cocoaType);
283     String readStringForPlatformType(const String&);
284     Vector<String> readTypesWithSecurityCheck();
285     RefPtr<SharedBuffer> readBufferForTypeWithSecurityCheck(const String&);
286 #endif
287
288 #if PLATFORM(GTK)
289     void writeToClipboard();
290     void readFromClipboard();
291     Ref<SelectionData> m_selectionData;
292     String m_name;
293 #endif
294
295 #if PLATFORM(COCOA)
296     String m_pasteboardName;
297     long m_changeCount;
298 #endif
299
300 #if PLATFORM(WIN)
301     HWND m_owner;
302     COMPtr<IDataObject> m_dataObject;
303     COMPtr<WCDataObject> m_writableDataObject;
304     DragDataMap m_dragDataMap;
305 #endif
306 };
307
308 #if PLATFORM(IOS)
309 extern NSString *WebArchivePboardType;
310 #endif
311
312 #if PLATFORM(MAC)
313 extern const char* const WebArchivePboardType;
314 extern const char* const WebURLNamePboardType;
315 #endif
316
317 #if !PLATFORM(GTK)
318
319 inline Pasteboard::~Pasteboard()
320 {
321 }
322
323 #endif
324
325 } // namespace WebCore