2841253880dd8fd1b5cfef2693bce1bb2f5206d5
[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 namespace WebCore {
33
34 class DiagnosticLoggingClient;
35 class PageConfiguration;
36 class PageOverlayController;
37 class ScrollLatchingState;
38 class ServicesOverlayController;
39 class WheelEventDeltaTracker;
40
41 class MainFrame final : public Frame {
42 public:
43     static Ref<MainFrame> create(Page&, PageConfiguration&);
44
45     virtual ~MainFrame();
46
47     void selfOnlyRef();
48     void selfOnlyDeref();
49
50     WheelEventDeltaTracker* wheelEventDeltaTracker() { return m_recentWheelEventDeltaTracker.get(); }
51     PageOverlayController& pageOverlayController() { return *m_pageOverlayController; }
52
53 #if PLATFORM(MAC)
54 #if ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
55     ServicesOverlayController& servicesOverlayController() { return *m_servicesOverlayController; }
56 #endif // ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
57
58     ScrollLatchingState* latchingState();
59     void pushNewLatchingState();
60     void popLatchingState();
61     void resetLatchingState();
62 #endif // PLATFORM(MAC)
63
64     WEBCORE_EXPORT DiagnosticLoggingClient& diagnosticLoggingClient() const;
65
66 private:
67     MainFrame(Page&, PageConfiguration&);
68
69     void dropChildren();
70
71     unsigned m_selfOnlyRefCount;
72
73 #if PLATFORM(MAC)
74     Vector<ScrollLatchingState> m_latchingState;
75 #if ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)
76     std::unique_ptr<ServicesOverlayController> m_servicesOverlayController;
77 #endif
78 #endif
79
80     std::unique_ptr<WheelEventDeltaTracker> m_recentWheelEventDeltaTracker;
81     std::unique_ptr<PageOverlayController> m_pageOverlayController;
82     DiagnosticLoggingClient* m_diagnosticLoggingClient;
83 };
84
85 inline bool Frame::isMainFrame() const
86 {
87     return this == &m_mainFrame;
88 }
89
90 }
91
92 #endif