WebFrame.h revision 65f03d4f644ce73618e5f4f50dd694b26f55ae12
165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch/* 265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * Copyright (C) 2010 Apple Inc. All rights reserved. 365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * 465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * Redistribution and use in source and binary forms, with or without 565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * modification, are permitted provided that the following conditions 665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * are met: 765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * 1. Redistributions of source code must retain the above copyright 865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * notice, this list of conditions and the following disclaimer. 965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * 2. Redistributions in binary form must reproduce the above copyright 1065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * notice, this list of conditions and the following disclaimer in the 1165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * documentation and/or other materials provided with the distribution. 1265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * 1365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' 1465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 1565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 1665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS 1765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 1865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 1965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 2065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 2165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 2265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 2365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch * THE POSSIBILITY OF SUCH DAMAGE. 2465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch */ 2565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 2665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#ifndef WebFrame_h 2765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#define WebFrame_h 2865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 2965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include "APIObject.h" 3065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include "ImmutableArray.h" 3165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include "WebFrameLoaderClient.h" 3265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <JavaScriptCore/JSBase.h> 3365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <WebCore/FrameLoaderClient.h> 3465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <WebCore/FrameLoaderTypes.h> 3565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <WebCore/PolicyChecker.h> 3665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <wtf/Forward.h> 3765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <wtf/PassRefPtr.h> 3865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#include <wtf/RefPtr.h> 3965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 4065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochnamespace WebCore { 4165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch class Frame; 4265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch class HTMLFrameOwnerElement; 4365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch class KURL; 4465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch} 4565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 4665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochnamespace WebKit { 4765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 4865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochclass InjectedBundleNodeHandle; 4965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochclass InjectedBundleRangeHandle; 5065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochclass InjectedBundleScriptWorld; 5165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochclass WebPage; 5265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 5365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochclass WebFrame : public APIObject { 5465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochpublic: 5565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch static const Type APIType = TypeBundleFrame; 5665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 5765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch static PassRefPtr<WebFrame> createMainFrame(WebPage*); 5865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch static PassRefPtr<WebFrame> createSubframe(WebPage*, const String& frameName, WebCore::HTMLFrameOwnerElement*); 5965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch ~WebFrame(); 6065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 6165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch // Called when the FrameLoaderClient (and therefore the WebCore::Frame) is being torn down. 6265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void invalidate(); 6365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 6465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebPage* page() const; 6565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebCore::Frame* coreFrame() const { return m_coreFrame; } 6665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 6765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch uint64_t frameID() const { return m_frameID; } 6865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 6965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch uint64_t setUpPolicyListener(WebCore::FramePolicyFunction); 7065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void invalidatePolicyListener(); 7165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void didReceivePolicyDecision(uint64_t listenerID, WebCore::PolicyAction, uint64_t downloadID); 7265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 7365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void startDownload(const WebCore::ResourceRequest&); 7465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void convertHandleToDownload(WebCore::ResourceHandle*, const WebCore::ResourceRequest&, const WebCore::ResourceRequest& initialRequest, const WebCore::ResourceResponse&); 7565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 7665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String source() const; 7765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String contentsAsString() const; 7865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String selectionAsString() const; 7965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 8065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebCore::IntSize size() const; 8165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 8265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch // WKBundleFrame API and SPI functions 8365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch bool isMainFrame() const; 8465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String name() const; 8565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String url() const; 8665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String innerText() const; 8765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch bool isFrameSet() const; 8865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch PassRefPtr<ImmutableArray> childFrames(); 8965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch JSValueRef computedStyleIncludingVisitedInfo(JSObjectRef element); 9065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch JSGlobalContextRef jsContext(); 9165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch JSGlobalContextRef jsContextForWorld(InjectedBundleScriptWorld*); 9265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 9365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch JSValueRef jsWrapperForWorld(InjectedBundleNodeHandle*, InjectedBundleScriptWorld*); 9465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch JSValueRef jsWrapperForWorld(InjectedBundleRangeHandle*, InjectedBundleScriptWorld*); 9565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 9665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch static String counterValue(JSObjectRef element); 9765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch static String markerText(JSObjectRef element); 9865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 9965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch unsigned numberOfActiveAnimations() const; 10065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch bool pauseAnimationOnElementWithId(const String& animationName, const String& elementID, double time); 10165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void suspendAnimations(); 10265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void resumeAnimations(); 10365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String layerTreeAsText() const; 10465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 10565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch unsigned pendingUnloadCount() const; 10665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 10765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch bool allowsFollowingLink(const WebCore::KURL&) const; 10865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 10965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch String provisionalURL() const; 11065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 11165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch // Simple listener class used by plug-ins to know when frames finish or fail loading. 11265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch class LoadListener { 11365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch public: 11465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch virtual ~LoadListener() { } 11565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 11665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch virtual void didFinishLoad(WebFrame*) = 0; 11765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch virtual void didFailLoad(WebFrame*, bool wasCancelled) = 0; 11865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch }; 11965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void setLoadListener(LoadListener* loadListener) { m_loadListener = loadListener; } 12065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch LoadListener* loadListener() const { return m_loadListener; } 12165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 12265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdochprivate: 12365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch static PassRefPtr<WebFrame> create(); 12465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebFrame(); 12565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 12665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch void init(WebPage*, const String& frameName, WebCore::HTMLFrameOwnerElement*); 12765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 12865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch virtual Type type() const { return APIType; } 12965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 13065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebCore::Frame* m_coreFrame; 13165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 13265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch uint64_t m_policyListenerID; 13365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebCore::FramePolicyFunction m_policyFunction; 13465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch uint64_t m_policyDownloadID; 13565f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 13665f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch WebFrameLoaderClient m_frameLoaderClient; 13765f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch LoadListener* m_loadListener; 13865f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 13965f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch uint64_t m_frameID; 14065f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch}; 14165f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 14265f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch} // namespace WebKit 14365f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch 14465f03d4f644ce73618e5f4f50dd694b26f55ae12Ben Murdoch#endif // WebFrame_h 145