Add WebKitAdditions extension points to WebCore, WebKit and WebKitLegacy
[WebKit-https.git] / Source / WebCore / page / MainFrame.h
1 /*
2  * Copyright (C) 2013-2014 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 MainFrame_h
27 #define MainFrame_h
28
29 #include "Frame.h"
30 #include <wtf/Vector.h>
31
32 #if defined(__has_include) && __has_include(<WebKitAdditions/MainFrameIncludes.h>)
33 #include <WebKitAdditions/MainFrameIncludes.h>
34 #endif
35
36 namespace WebCore {
37
38 class DiagnosticLoggingClient;
39 class PageConfiguration;
40 class PageOverlayController;
41 class ScrollLatchingState;
42 class ServicesOverlayController;
43 class WheelEventDeltaFilter;
44
45 class MainFrame final : public Frame {
46 public:
47     static Ref<MainFrame> create(Page&, PageConfiguration&);
48
49     virtual ~MainFrame();
50
51     void selfOnlyRef();
52     void selfOnlyDeref();
53
54     WheelEventDeltaFilter* wheelEventDeltaFilter() { return m_recentWheelEventDeltaFilter.get(); }
55     PageOverlayController& pageOverlayController() { return *m_pageOverlayController; }
56
57 #if PLATFORM(MAC)
58 #if ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
59     ServicesOverlayController& servicesOverlayController() { return *m_servicesOverlayController; }
60 #endif // ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
61
62     ScrollLatchingState* latchingState();
63     void pushNewLatchingState();
64     void popLatchingState();
65     void resetLatchingState();
66     void removeLatchingStateForTarget(Element&);
67 #endif // PLATFORM(MAC)
68
69     WEBCORE_EXPORT DiagnosticLoggingClient& diagnosticLoggingClient() const;
70
71 #if defined(__has_include) && __has_include(<WebKitAdditions/MainFrameMembers.h>)
72 #include <WebKitAdditions/MainFrameMembers.h>
73 #endif
74
75 private:
76     MainFrame(Page&, PageConfiguration&);
77
78     void dropChildren();
79
80     unsigned m_selfOnlyRefCount;
81
82 #if PLATFORM(MAC)
83     Vector<ScrollLatchingState> m_latchingState;
84 #if ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
85     std::unique_ptr<ServicesOverlayController> m_servicesOverlayController;
86 #endif
87 #endif
88
89     std::unique_ptr<WheelEventDeltaFilter> m_recentWheelEventDeltaFilter;
90     std::unique_ptr<PageOverlayController> m_pageOverlayController;
91     DiagnosticLoggingClient* m_diagnosticLoggingClient;
92 };
93
94 inline bool Frame::isMainFrame() const
95 {
96     return this == &m_mainFrame;
97 }
98
99 }
100
101 #endif