Use "= default" to denote default constructor or destructor
[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     String contentOrigin;
75     bool canSmartCopyOrDelete;
76     RefPtr<SharedBuffer> dataInWebArchiveFormat;
77     RefPtr<SharedBuffer> dataInRTFDFormat;
78     RefPtr<SharedBuffer> dataInRTFFormat;
79     RefPtr<SharedBuffer> dataInAttributedStringFormat;
80     String dataInHTMLFormat;
81     String dataInStringFormat;
82     Vector<String> clientTypes;
83     Vector<RefPtr<SharedBuffer>> clientData;
84 #endif
85 #if PLATFORM(GTK)
86     bool canSmartCopyOrDelete;
87     String text;
88     String markup;
89 #endif
90 #if PLATFORM(WPE)
91     String text;
92     String markup;
93 #endif
94 };
95
96 struct PasteboardURL {
97     URL url;
98     String title;
99 #if PLATFORM(MAC)
100     String userVisibleForm;
101 #endif
102 #if PLATFORM(GTK)
103     String markup;
104 #endif
105 };
106
107 struct PasteboardImage {
108     WEBCORE_EXPORT PasteboardImage();
109     WEBCORE_EXPORT ~PasteboardImage();
110     RefPtr<Image> image;
111 #if PLATFORM(MAC)
112     RefPtr<SharedBuffer> dataInWebArchiveFormat;
113 #endif
114 #if !PLATFORM(WIN)
115     PasteboardURL url;
116 #endif
117 #if !(PLATFORM(GTK) || PLATFORM(WIN))
118     RefPtr<SharedBuffer> resourceData;
119     String resourceMIMEType;
120     Vector<String> clientTypes;
121     Vector<RefPtr<SharedBuffer>> clientData;
122 #endif
123     String suggestedName;
124     FloatSize imageSize;
125 };
126
127 // For reading from the pasteboard.
128
129 class PasteboardWebContentReader {
130 public:
131     String contentOrigin;
132
133     virtual ~PasteboardWebContentReader() = default;
134
135 #if PLATFORM(COCOA)
136     virtual bool readWebArchive(SharedBuffer&) = 0;
137     virtual bool readFilenames(const Vector<String>&) = 0;
138     virtual bool readHTML(const String&) = 0;
139     virtual bool readRTFD(SharedBuffer&) = 0;
140     virtual bool readRTF(SharedBuffer&) = 0;
141     virtual bool readImage(Ref<SharedBuffer>&&, const String& type) = 0;
142     virtual bool readURL(const URL&, const String& title) = 0;
143 #endif
144     virtual bool readPlainText(const String&) = 0;
145 };
146
147 struct PasteboardPlainText {
148     String text;
149 #if PLATFORM(COCOA)
150     bool isURL;
151 #endif
152 };
153
154 struct PasteboardFileReader {
155     virtual ~PasteboardFileReader() = default;
156     virtual void readFilename(const String&) = 0;
157     virtual void readBuffer(const String& filename, const String& type, Ref<SharedBuffer>&&) = 0;
158 };
159
160 // FIXME: We need to ensure that the contents of sameOriginCustomData are not accessible across different origins.
161 struct PasteboardCustomData {
162     String origin;
163     Vector<String> orderedTypes;
164     HashMap<String, String> platformData;
165     HashMap<String, String> sameOriginCustomData;
166
167     WEBCORE_EXPORT Ref<SharedBuffer> createSharedBuffer() const;
168     WEBCORE_EXPORT static PasteboardCustomData fromSharedBuffer(const SharedBuffer&);
169
170 #if PLATFORM(COCOA)
171     static const char* cocoaType();
172 #endif
173 };
174
175 class Pasteboard {
176     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
177 public:
178     Pasteboard();
179     virtual ~Pasteboard();
180
181 #if PLATFORM(GTK)
182     explicit Pasteboard(const String& name);
183     explicit Pasteboard(SelectionData&);
184 #endif
185
186 #if PLATFORM(WIN)
187     explicit Pasteboard(IDataObject*);
188     explicit Pasteboard(WCDataObject*);
189     explicit Pasteboard(const DragDataMap&);
190 #endif
191
192     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForCopyAndPaste();
193
194     static bool isSafeTypeForDOMToReadAndWrite(const String&);
195     static bool canExposeURLToDOMWhenPasteboardContainsFiles(const String&);
196
197     virtual bool isStatic() const { return false; }
198
199     virtual bool hasData();
200     virtual Vector<String> typesSafeForBindings(const String& origin);
201     virtual Vector<String> typesForLegacyUnsafeBindings();
202     virtual String readOrigin();
203     virtual String readString(const String& type);
204     virtual String readStringInCustomData(const String& type);
205
206     virtual void writeString(const String& type, const String& data);
207     virtual void clear();
208     virtual void clear(const String& type);
209
210     virtual void read(PasteboardPlainText&);
211     virtual void read(PasteboardWebContentReader&);
212     virtual void read(PasteboardFileReader&);
213
214     virtual void write(const PasteboardURL&);
215     virtual void writeTrustworthyWebURLsPboardType(const PasteboardURL&);
216     virtual void write(const PasteboardImage&);
217     virtual void write(const PasteboardWebContent&);
218
219     virtual void writeCustomData(const PasteboardCustomData&);
220
221     virtual bool containsFiles();
222     virtual bool canSmartReplace();
223
224     virtual void writeMarkup(const String& markup);
225     enum SmartReplaceOption { CanSmartReplace, CannotSmartReplace };
226     virtual WEBCORE_EXPORT void writePlainText(const String&, SmartReplaceOption); // FIXME: Two separate functions would be clearer than one function with an argument.
227
228 #if ENABLE(DRAG_SUPPORT)
229     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop();
230     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForDragAndDrop(const DragData&);
231
232     virtual void setDragImage(DragImage, const IntPoint& hotSpot);
233 #endif
234
235 #if PLATFORM(WIN)
236     RefPtr<DocumentFragment> documentFragment(Frame&, Range&, bool allowPlainText, bool& chosePlainText); // FIXME: Layering violation.
237     void writeImage(Element&, const URL&, const String& title); // FIXME: Layering violation.
238     void writeSelection(Range&, bool canSmartCopyOrDelete, Frame&, ShouldSerializeSelectedTextForDataTransfer = DefaultSelectedTextType); // FIXME: Layering violation.
239 #endif
240
241 #if PLATFORM(GTK)
242     const SelectionData& selectionData() const;
243     static std::unique_ptr<Pasteboard> createForGlobalSelection();
244 #endif
245
246 #if PLATFORM(IOS)
247     explicit Pasteboard(long changeCount);
248
249     static NSArray *supportedWebContentPasteboardTypes();
250     static String resourceMIMEType(NSString *mimeType);
251 #endif
252
253 #if PLATFORM(COCOA)
254     explicit Pasteboard(const String& pasteboardName);
255
256     static bool shouldTreatCocoaTypeAsFile(const String&);
257     WEBCORE_EXPORT static NSArray *supportedFileUploadPasteboardTypes();
258     const String& name() const { return m_pasteboardName; }
259     long changeCount() const;
260     const PasteboardCustomData& readCustomData();
261 #endif
262
263 #if PLATFORM(WIN)
264     COMPtr<IDataObject> dataObject() const { return m_dataObject; }
265     void setExternalDataObject(IDataObject*);
266     const DragDataMap& dragDataMap() const { return m_dragDataMap; }
267     void writeURLToWritableDataObject(const URL&, const String&);
268     COMPtr<WCDataObject> writableDataObject() const { return m_writableDataObject; }
269     void writeImageToDataObject(Element&, const URL&); // FIXME: Layering violation.
270 #endif
271
272 private:
273 #if PLATFORM(IOS)
274     bool respectsUTIFidelities() const;
275     void readRespectingUTIFidelities(PasteboardWebContentReader&);
276
277     enum class ReaderResult {
278         ReadType,
279         DidNotReadType,
280         PasteboardWasChangedExternally
281     };
282     ReaderResult readPasteboardWebContentDataForType(PasteboardWebContentReader&, PasteboardStrategy&, NSString *type, int itemIndex);
283 #endif
284
285 #if PLATFORM(WIN)
286     void finishCreatingPasteboard();
287     void writeRangeToDataObject(Range&, Frame&); // FIXME: Layering violation.
288     void writeURLToDataObject(const URL&, const String&);
289     void writePlainTextToDataObject(const String&, SmartReplaceOption);
290 #endif
291
292 #if PLATFORM(COCOA)
293     Vector<String> readFilenames();
294     String readPlatformValueAsString(const String& domType, long changeCount, const String& pasteboardName);
295     static void addHTMLClipboardTypesForCocoaType(ListHashSet<String>& resultTypes, const String& cocoaType);
296     String readStringForPlatformType(const String&);
297     Vector<String> readTypesWithSecurityCheck();
298     RefPtr<SharedBuffer> readBufferForTypeWithSecurityCheck(const String&);
299 #endif
300
301 #if PLATFORM(GTK)
302     void writeToClipboard();
303     void readFromClipboard();
304     Ref<SelectionData> m_selectionData;
305     String m_name;
306 #endif
307
308 #if PLATFORM(COCOA)
309     String m_pasteboardName;
310     long m_changeCount;
311     std::optional<PasteboardCustomData> m_customDataCache;
312 #endif
313
314 #if PLATFORM(WIN)
315     HWND m_owner;
316     COMPtr<IDataObject> m_dataObject;
317     COMPtr<WCDataObject> m_writableDataObject;
318     DragDataMap m_dragDataMap;
319 #endif
320 };
321
322 #if PLATFORM(IOS)
323 extern NSString *WebArchivePboardType;
324 #endif
325
326 #if PLATFORM(MAC)
327 extern const char* const WebArchivePboardType;
328 extern const char* const WebURLNamePboardType;
329 #endif
330
331 #if !PLATFORM(GTK)
332
333 inline Pasteboard::~Pasteboard()
334 {
335 }
336
337 #endif
338
339 } // namespace WebCore