Add CSS -webkit-appearance property for Apple Pay buttons
[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 #ifndef Pasteboard_h
27 #define Pasteboard_h
28
29 #include "DragImage.h"
30 #include "URL.h"
31 #include <wtf/Noncopyable.h>
32 #include <wtf/Vector.h>
33 #include <wtf/text/WTFString.h>
34
35 #if PLATFORM(IOS)
36 OBJC_CLASS NSArray;
37 OBJC_CLASS NSString;
38 #endif
39
40 #if PLATFORM(WIN)
41 #include "COMPtr.h"
42 #include "WCDataObject.h"
43 #include <objidl.h>
44 #include <windows.h>
45 typedef struct HWND__* HWND;
46 #endif
47
48 // FIXME: This class uses the DOM and makes calls to Editor.
49 // It should be divested of its knowledge of the frame and editor.
50
51 namespace WebCore {
52
53 class DataObjectGtk;
54 class DocumentFragment;
55 class DragData;
56 class Element;
57 class Frame;
58 class Range;
59 class SharedBuffer;
60
61 enum ShouldSerializeSelectedTextForDataTransfer { DefaultSelectedTextType, IncludeImageAltTextForDataTransfer };
62
63 // For writing to the pasteboard. Generally sorted with the richest formats on top.
64
65 struct PasteboardWebContent {
66 #if !(PLATFORM(EFL) || PLATFORM(GTK) || PLATFORM(WIN))
67     WEBCORE_EXPORT PasteboardWebContent();
68     WEBCORE_EXPORT ~PasteboardWebContent();
69     bool canSmartCopyOrDelete;
70     RefPtr<SharedBuffer> dataInWebArchiveFormat;
71     RefPtr<SharedBuffer> dataInRTFDFormat;
72     RefPtr<SharedBuffer> dataInRTFFormat;
73     String dataInStringFormat;
74     Vector<String> clientTypes;
75     Vector<RefPtr<SharedBuffer>> clientData;
76 #endif
77 #if PLATFORM(GTK)
78     bool canSmartCopyOrDelete;
79     String text;
80     String markup;
81 #endif
82 };
83
84 struct PasteboardURL {
85     URL url;
86     String title;
87 #if PLATFORM(MAC)
88     String userVisibleForm;
89 #endif
90 #if PLATFORM(GTK)
91     String markup;
92 #endif
93 };
94
95 struct PasteboardImage {
96     WEBCORE_EXPORT PasteboardImage();
97     WEBCORE_EXPORT ~PasteboardImage();
98     RefPtr<Image> image;
99 #if !(PLATFORM(EFL) || PLATFORM(WIN))
100     PasteboardURL url;
101 #endif
102 #if !(PLATFORM(EFL) || PLATFORM(GTK) || PLATFORM(WIN))
103     RefPtr<SharedBuffer> resourceData;
104     String resourceMIMEType;
105 #endif
106 };
107
108 // For reading from the pasteboard.
109
110 class PasteboardWebContentReader {
111 public:
112     virtual ~PasteboardWebContentReader() { }
113
114 #if !(PLATFORM(EFL) || PLATFORM(GTK) || PLATFORM(WIN))
115     virtual bool readWebArchive(SharedBuffer*) = 0;
116     virtual bool readFilenames(const Vector<String>&) = 0;
117     virtual bool readHTML(const String&) = 0;
118     virtual bool readRTFD(SharedBuffer&) = 0;
119     virtual bool readRTF(SharedBuffer&) = 0;
120     virtual bool readImage(Ref<SharedBuffer>&&, const String& type) = 0;
121     virtual bool readURL(const URL&, const String& title) = 0;
122 #endif
123     virtual bool readPlainText(const String&) = 0;
124 };
125
126 struct PasteboardPlainText {
127     String text;
128 #if PLATFORM(MAC)
129     bool isURL;
130 #endif
131 };
132
133 class Pasteboard {
134     WTF_MAKE_NONCOPYABLE(Pasteboard); WTF_MAKE_FAST_ALLOCATED;
135 public:
136     Pasteboard();
137     ~Pasteboard();
138
139 #if PLATFORM(GTK)
140     explicit Pasteboard(const String& name);
141     explicit Pasteboard(RefPtr<DataObjectGtk>&&);
142 #endif
143
144 #if PLATFORM(WIN)
145     explicit Pasteboard(IDataObject*);
146     explicit Pasteboard(WCDataObject*);
147     explicit Pasteboard(const DragDataMap&);
148 #endif
149
150     WEBCORE_EXPORT static std::unique_ptr<Pasteboard> createForCopyAndPaste();
151     static std::unique_ptr<Pasteboard> createPrivate(); // Temporary pasteboard. Can put data on this and then write to another pasteboard with writePasteboard.
152
153     bool hasData();
154     Vector<String> types();
155     String readString(const String& type);
156
157     void writeString(const String& type, const String& data);
158     void clear();
159     void clear(const String& type);
160
161     void read(PasteboardPlainText&);
162     void read(PasteboardWebContentReader&);
163
164     void write(const PasteboardURL&);
165     void write(const PasteboardImage&);
166     void write(const PasteboardWebContent&);
167
168     Vector<String> readFilenames();
169     bool canSmartReplace();
170
171     void writeMarkup(const String& markup);
172     enum SmartReplaceOption { CanSmartReplace, CannotSmartReplace };
173     WEBCORE_EXPORT void writePlainText(const String&, SmartReplaceOption); // FIXME: Two separate functions would be clearer than one function with an argument.
174     void writePasteboard(const Pasteboard& sourcePasteboard);
175
176 #if ENABLE(DRAG_SUPPORT)
177     static std::unique_ptr<Pasteboard> createForDragAndDrop();
178     static std::unique_ptr<Pasteboard> createForDragAndDrop(const DragData&);
179
180     void setDragImage(DragImageRef, const IntPoint& hotSpot);
181 #endif
182
183 #if PLATFORM(WIN)
184     RefPtr<DocumentFragment> documentFragment(Frame&, Range&, bool allowPlainText, bool& chosePlainText); // FIXME: Layering violation.
185     void writeImage(Element&, const URL&, const String& title); // FIXME: Layering violation.
186     void writeSelection(Range&, bool canSmartCopyOrDelete, Frame&, ShouldSerializeSelectedTextForDataTransfer = DefaultSelectedTextType); // FIXME: Layering violation.
187 #endif
188
189 #if PLATFORM(GTK)
190     const DataObjectGtk& dataObject() const;
191     static std::unique_ptr<Pasteboard> createForGlobalSelection();
192 #endif
193
194 #if PLATFORM(IOS)
195     static NSArray* supportedPasteboardTypes();
196     static String resourceMIMEType(const NSString *mimeType);
197 #endif
198
199 #if PLATFORM(MAC)
200     explicit Pasteboard(const String& pasteboardName);
201
202     const String& name() const { return m_pasteboardName; }
203 #endif
204
205 #if PLATFORM(WIN)
206     COMPtr<IDataObject> dataObject() const { return m_dataObject; }
207     void setExternalDataObject(IDataObject*);
208     const DragDataMap& dragDataMap() const { return m_dragDataMap; }
209     void writeURLToWritableDataObject(const URL&, const String&);
210     COMPtr<WCDataObject> writableDataObject() const { return m_writableDataObject; }
211     void writeImageToDataObject(Element&, const URL&); // FIXME: Layering violation.
212 #endif
213
214 private:
215 #if PLATFORM(WIN)
216     void finishCreatingPasteboard();
217     void writeRangeToDataObject(Range&, Frame&); // FIXME: Layering violation.
218     void writeURLToDataObject(const URL&, const String&);
219     void writePlainTextToDataObject(const String&, SmartReplaceOption);
220 #endif
221
222 #if PLATFORM(GTK)
223     enum class ShouldIncludeSmartPaste { No, Yes };
224     void writeToClipboard(ShouldIncludeSmartPaste = ShouldIncludeSmartPaste::No);
225     void readFromClipboard();
226     RefPtr<DataObjectGtk> m_dataObject;
227     String m_name;
228 #endif
229
230 #if PLATFORM(IOS)
231     long m_changeCount;
232 #endif
233
234 #if PLATFORM(MAC)
235     String m_pasteboardName;
236     long m_changeCount;
237 #endif
238
239 #if PLATFORM(WIN)
240     HWND m_owner;
241     COMPtr<IDataObject> m_dataObject;
242     COMPtr<WCDataObject> m_writableDataObject;
243     DragDataMap m_dragDataMap;
244 #endif
245 };
246
247 #if PLATFORM(IOS)
248 extern NSString *WebArchivePboardType;
249 #endif
250
251 #if PLATFORM(MAC)
252 extern const char* const WebArchivePboardType;
253 extern const char* const WebURLNamePboardType;
254 #endif
255
256 #if !PLATFORM(GTK)
257
258 inline Pasteboard::~Pasteboard()
259 {
260 }
261
262 #endif
263
264 } // namespace WebCore
265
266 #endif // Pasteboard_h