Support File Promise during drag for macOS.
[WebKit-https.git] / Source / WebCore / platform / DragData.h
1 /*
2  * Copyright (C) 2007 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 DragData_h
27 #define DragData_h
28
29 #include "Color.h"
30 #include "DragActions.h"
31 #include "IntPoint.h"
32
33 #include <wtf/Forward.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/Vector.h>
36
37 #if PLATFORM(MAC)
38 #include <wtf/text/WTFString.h>
39
40 #ifdef __OBJC__ 
41 #import <Foundation/Foundation.h>
42 #import <AppKit/NSDragging.h>
43 typedef id <NSDraggingInfo> DragDataRef;
44 #else
45 typedef void* DragDataRef;
46 #endif
47
48 #elif PLATFORM(WIN)
49 typedef struct IDataObject* DragDataRef;
50 #include <wtf/text/WTFString.h>
51 #elif PLATFORM(GTK)
52 namespace WebCore {
53 class SelectionData;
54 }
55 typedef WebCore::SelectionData* DragDataRef;
56 #elif PLATFORM(EFL) || PLATFORM(IOS)
57 typedef void* DragDataRef;
58 #endif
59
60 namespace WebCore {
61
62 class URL;
63
64 enum DragApplicationFlags {
65     DragApplicationNone = 0,
66     DragApplicationIsModal = 1,
67     DragApplicationIsSource = 2,
68     DragApplicationHasAttachedSheet = 4,
69     DragApplicationIsCopyKeyDown = 8
70 };
71
72 #if PLATFORM(WIN)
73 typedef HashMap<unsigned, Vector<String>> DragDataMap;
74 #endif
75
76 class DragData {
77 public:
78     enum FilenameConversionPolicy { DoNotConvertFilenames, ConvertFilenames };
79
80     // clientPosition is taken to be the position of the drag event within the target window, with (0,0) at the top left
81     WEBCORE_EXPORT DragData(DragDataRef, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation, DragApplicationFlags = DragApplicationNone);
82     WEBCORE_EXPORT DragData(const String& dragStorageName, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation, DragApplicationFlags = DragApplicationNone);
83     // This constructor should used only by WebKit2 IPC because DragData
84     // is initialized by the decoder and not in the constructor.
85     DragData() { }
86 #if PLATFORM(WIN)
87     WEBCORE_EXPORT DragData(const DragDataMap&, const IntPoint& clientPosition, const IntPoint& globalPosition, DragOperation sourceOperationMask, DragApplicationFlags = DragApplicationNone);
88     const DragDataMap& dragDataMap();
89     void getDragFileDescriptorData(int& size, String& pathname);
90     void getDragFileContentData(int size, void* dataBlob);
91 #endif
92     const IntPoint& clientPosition() const { return m_clientPosition; }
93     const IntPoint& globalPosition() const { return m_globalPosition; }
94     DragApplicationFlags flags() const { return m_applicationFlags; }
95     DragDataRef platformData() const { return m_platformDragData; }
96     DragOperation draggingSourceOperationMask() const { return m_draggingSourceOperationMask; }
97     bool containsURL(FilenameConversionPolicy = ConvertFilenames) const;
98     bool containsPlainText() const;
99     bool containsCompatibleContent() const;
100     String asURL(FilenameConversionPolicy = ConvertFilenames, String* title = nullptr) const;
101     String asPlainText() const;
102     void asFilenames(Vector<String>&) const;
103     Color asColor() const;
104     bool canSmartReplace() const;
105     bool containsColor() const;
106     bool containsFiles() const;
107     unsigned numberOfFiles() const;
108     void setFileNames(Vector<String>& fileNames) { m_fileNames = WTFMove(fileNames); }
109     const Vector<String>& fileNames() const { return m_fileNames; }
110 #if PLATFORM(MAC)
111     const String& pasteboardName() const { return m_pasteboardName; }
112     bool containsPromise() const;
113 #endif
114
115 #if PLATFORM(GTK)
116
117     DragData& operator =(const DragData& data)
118     {
119         m_clientPosition = data.m_clientPosition;
120         m_globalPosition = data.m_globalPosition;
121         m_platformDragData = data.m_platformDragData;
122         m_draggingSourceOperationMask = data.m_draggingSourceOperationMask;
123         m_applicationFlags = data.m_applicationFlags;
124         return *this;
125     }
126 #endif
127
128 private:
129     IntPoint m_clientPosition;
130     IntPoint m_globalPosition;
131     DragDataRef m_platformDragData;
132     DragOperation m_draggingSourceOperationMask;
133     DragApplicationFlags m_applicationFlags;
134     Vector<String> m_fileNames;
135 #if PLATFORM(MAC)
136     String m_pasteboardName;
137 #endif
138 #if PLATFORM(WIN)
139     DragDataMap m_dragDataMap;
140 #endif
141 };
142     
143 }
144
145 #endif // !DragData_h