Move URL from WebCore to WTF
[WebKit-https.git] / Source / WebCore / page / DragController.h
1 /*
2  * Copyright (C) 2007, 2009 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 "DragActions.h"
29 #include "DragImage.h"
30 #include "IntPoint.h"
31 #include "IntRect.h"
32 #include <wtf/URL.h>
33
34 namespace WebCore {
35
36 class DataTransfer;
37 class Document;
38 class DragClient;
39 class DragData;
40 class Element;
41 class Frame;
42 class FrameSelection;
43 class HTMLInputElement;
44 class IntRect;
45 class Page;
46 class PlatformMouseEvent;
47
48 struct DragItem;
49 struct DragState;
50 struct PromisedAttachmentInfo;
51
52     class DragController {
53         WTF_MAKE_NONCOPYABLE(DragController); WTF_MAKE_FAST_ALLOCATED;
54     public:
55         DragController(Page&, DragClient&);
56         ~DragController();
57
58         static std::unique_ptr<DragController> create(Page&, DragClient&);
59         static DragOperation platformGenericDragOperation();
60
61         DragClient& client() const { return m_client; }
62
63         WEBCORE_EXPORT DragOperation dragEntered(const DragData&);
64         WEBCORE_EXPORT void dragExited(const DragData&);
65         WEBCORE_EXPORT DragOperation dragUpdated(const DragData&);
66         WEBCORE_EXPORT bool performDragOperation(const DragData&);
67         WEBCORE_EXPORT void dragCancelled();
68
69         bool mouseIsOverFileInput() const { return m_fileInputElementUnderMouse; }
70         unsigned numberOfItemsToBeAccepted() const { return m_numberOfItemsToBeAccepted; }
71
72         // FIXME: It should be possible to remove a number of these accessors once all
73         // drag logic is in WebCore.
74         void setDidInitiateDrag(bool initiated) { m_didInitiateDrag = initiated; } 
75         bool didInitiateDrag() const { return m_didInitiateDrag; }
76         DragOperation sourceDragOperation() const { return m_sourceDragOperation; }
77         const URL& draggingImageURL() const { return m_draggingImageURL; }
78         void setDragOffset(const IntPoint& offset) { m_dragOffset = offset; }
79         const IntPoint& dragOffset() const { return m_dragOffset; }
80         DragSourceAction dragSourceAction() const { return m_dragSourceAction; }
81
82         enum class DragHandlingMethod { None, EditPlainText, EditRichText, UploadFile, PageLoad, SetColor, NonDefault };
83         Document* documentUnderMouse() const { return m_documentUnderMouse.get(); }
84         DragDestinationAction dragDestinationAction() const { return m_dragDestinationAction; }
85         DragSourceAction delegateDragSourceAction(const IntPoint& rootViewPoint);
86         
87         Element* draggableElement(const Frame*, Element* start, const IntPoint&, DragState&) const;
88         WEBCORE_EXPORT void dragEnded();
89         
90         WEBCORE_EXPORT void placeDragCaret(const IntPoint&);
91         
92         bool startDrag(Frame& src, const DragState&, DragOperation srcOp, const PlatformMouseEvent& dragEvent, const IntPoint& dragOrigin, HasNonDefaultPasteboardData);
93         static const IntSize& maxDragImageSize();
94         
95         static const int MaxOriginalImageArea;
96         static const int DragIconRightInset;
97         static const int DragIconBottomInset;        
98         static const float DragImageAlpha;
99
100     private:
101         void updateSupportedTypeIdentifiersForDragHandlingMethod(DragHandlingMethod, const DragData&) const;
102         bool dispatchTextInputEventFor(Frame*, const DragData&);
103         bool canProcessDrag(const DragData&);
104         bool concludeEditDrag(const DragData&);
105         DragOperation dragEnteredOrUpdated(const DragData&);
106         DragOperation operationForLoad(const DragData&);
107         DragHandlingMethod tryDocumentDrag(const DragData&, DragDestinationAction, DragOperation&);
108         bool tryDHTMLDrag(const DragData&, DragOperation&);
109         DragOperation dragOperation(const DragData&);
110         void clearDragCaret();
111         bool dragIsMove(FrameSelection&, const DragData&);
112         bool isCopyKeyDown(const DragData&);
113
114         void mouseMovedIntoDocument(Document*);
115         bool shouldUseCachedImageForDragImage(const Image&) const;
116
117         void doImageDrag(Element&, const IntPoint&, const IntRect&, Frame&, IntPoint&, const DragState&, PromisedAttachmentInfo&&);
118         void doSystemDrag(DragImage, const IntPoint&, const IntPoint&, Frame&, const DragState&, PromisedAttachmentInfo&&);
119
120         void beginDrag(DragItem, Frame&, const IntPoint& mouseDownPoint, const IntPoint& mouseDraggedPoint, DataTransfer&, DragSourceAction);
121
122         bool canLoadDataFromDraggingPasteboard() const
123         {
124 #if ENABLE(DATA_INTERACTION)
125             return m_isPerformingDrop;
126 #else
127             return true;
128 #endif
129         }
130
131         String platformContentTypeForBlobType(const String& type) const;
132
133         void cleanupAfterSystemDrag();
134         void declareAndWriteDragImage(DataTransfer&, Element&, const URL&, const String& label);
135
136 #if ENABLE(ATTACHMENT_ELEMENT)
137         PromisedAttachmentInfo promisedAttachmentInfo(Frame&, Element&);
138 #endif
139         Page& m_page;
140         DragClient& m_client;
141
142         RefPtr<Document> m_documentUnderMouse; // The document the mouse was last dragged over.
143         RefPtr<Document> m_dragInitiator; // The Document (if any) that initiated the drag.
144         RefPtr<HTMLInputElement> m_fileInputElementUnderMouse;
145         unsigned m_numberOfItemsToBeAccepted;
146         DragHandlingMethod m_dragHandlingMethod;
147
148         DragDestinationAction m_dragDestinationAction;
149         DragSourceAction m_dragSourceAction;
150         bool m_didInitiateDrag;
151         DragOperation m_sourceDragOperation; // Set in startDrag when a drag starts from a mouse down within WebKit
152         IntPoint m_dragOffset;
153         URL m_draggingImageURL;
154         bool m_isPerformingDrop { false };
155     };
156
157     WEBCORE_EXPORT bool isDraggableLink(const Element&);
158
159 } // namespace WebCore