419bd73249bcb1a96242c46a0ad4f6529e6090f6
[WebKit-https.git] / WebKit2 / WebProcess / WebPage / WebFrame.h
1 /*
2  * Copyright (C) 2010 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 #ifndef WebFrame_h
27 #define WebFrame_h
28
29 #include "APIObject.h"
30 #include "ImmutableArray.h"
31 #include "WebFrameLoaderClient.h"
32 #include <JavaScriptCore/JSBase.h>
33 #include <WebCore/FrameLoaderClient.h>
34 #include <WebCore/FrameLoaderTypes.h>
35 #include <WebCore/PolicyChecker.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefPtr.h>
38
39 namespace WebCore {
40     class Frame;
41     class HTMLFrameOwnerElement;
42     class String;
43 }
44
45 namespace WebKit {
46
47 class WebPage;
48
49 class WebFrame : public APIObject {
50 public:
51     static const Type APIType = TypeBundleFrame;
52
53     static PassRefPtr<WebFrame> createMainFrame(WebPage*);
54     static PassRefPtr<WebFrame> createSubframe(WebPage*, const WebCore::String& frameName, WebCore::HTMLFrameOwnerElement*);
55     ~WebFrame();
56
57     // Called when the FrameLoaderClient (and therefore the WebCore::Frame) is being torn down.
58     void invalidate();
59
60     WebPage* page() const { return m_page; }
61     WebCore::Frame* coreFrame() const { return m_coreFrame; }
62
63     uint64_t frameID() const { return m_frameID; }
64
65     uint64_t setUpPolicyListener(WebCore::FramePolicyFunction);
66     void invalidatePolicyListener();
67     void didReceivePolicyDecision(uint64_t listenerID, WebCore::PolicyAction);
68
69     // WKBundleFrame API and SPI functions
70     bool isMainFrame() const;
71     WebCore::String name() const;
72     WebCore::String url() const;
73     PassRefPtr<ImmutableArray> childFrames();
74     JSValueRef computedStyleIncludingVisitedInfo(JSObjectRef element);
75     JSGlobalContextRef jsContext();
76     static WebCore::String counterValue(JSObjectRef element);
77     static WebCore::String markerText(JSObjectRef element);
78
79     unsigned numberOfActiveAnimations();
80     bool pauseAnimationOnElementWithId(const WebCore::String& animationName, const WebCore::String& elementID, double time);
81
82     // Simple listener class used by plug-ins to know when frames finish or fail loading.
83     class LoadListener {
84     public:
85         virtual ~LoadListener() { }
86
87         virtual void didFinishLoad(WebFrame*) = 0;
88         virtual void didFailLoad(WebFrame*, bool wasCancelled) = 0;
89     };
90     void setLoadListener(LoadListener* loadListener) { m_loadListener = loadListener; }
91     LoadListener* loadListener() const { return m_loadListener; }
92
93 private:
94     static PassRefPtr<WebFrame> create(WebPage*, const WebCore::String& frameName, WebCore::HTMLFrameOwnerElement*);
95     WebFrame(WebPage*, const WebCore::String& frameName, WebCore::HTMLFrameOwnerElement*);
96
97     virtual Type type() const { return APIType; }
98
99     WebPage* m_page;
100     WebCore::Frame* m_coreFrame;
101
102     uint64_t m_policyListenerID;
103     WebCore::FramePolicyFunction m_policyFunction;
104
105     WebFrameLoaderClient m_frameLoaderClient;
106     LoadListener* m_loadListener;
107     
108     uint64_t m_frameID;
109 };
110
111 } // namespace WebKit
112
113 #endif // WebFrame_h