Refactor drag start codepaths to plumb a DragItem to client layers
[WebKit-https.git] / Source / WebCore / platform / PasteboardWriterData.h
1 /*
2  * Copyright (C) 2017 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 "URL.h"
29 #include <wtf/Optional.h>
30 #include <wtf/text/WTFString.h>
31
32 namespace WebCore {
33
34 class SharedBuffer;
35
36 class PasteboardWriterData final {
37 public:
38     WEBCORE_EXPORT PasteboardWriterData();
39     WEBCORE_EXPORT ~PasteboardWriterData();
40
41     WEBCORE_EXPORT bool isEmpty() const;
42
43     struct PlainText {
44         bool canSmartCopyOrDelete;
45         String text;
46     };
47
48     struct WebContent {
49         WebContent();
50         ~WebContent();
51
52 #if PLATFORM(COCOA)
53         bool canSmartCopyOrDelete;
54         RefPtr<SharedBuffer> dataInWebArchiveFormat;
55         RefPtr<SharedBuffer> dataInRTFDFormat;
56         RefPtr<SharedBuffer> dataInRTFFormat;
57         RefPtr<SharedBuffer> dataInAttributedStringFormat;
58         // FIXME: Why don't we want this on iOS?
59 #if PLATFORM(MAC)
60         String dataInHTMLFormat;
61 #endif
62         String dataInStringFormat;
63         Vector<String> clientTypes;
64         Vector<RefPtr<SharedBuffer>> clientData;
65 #endif
66     };
67
68     const std::optional<PlainText>& plainText() const { return m_plainText; }
69     void setPlainText(PlainText);
70
71     struct URL {
72         WebCore::URL url;
73         String title;
74 #if PLATFORM(MAC)
75         String userVisibleForm;
76 #elif PLATFORM(GTK)
77         String markup;
78 #endif
79     };
80
81     const std::optional<URL>& url() const { return m_url; }
82     void setURL(URL);
83
84     const std::optional<WebContent>& webContent() const { return m_webContent; }
85     void setWebContent(WebContent);
86
87 private:
88     std::optional<PlainText> m_plainText;
89     std::optional<URL> m_url;
90     std::optional<WebContent> m_webContent;
91 };
92
93 }