third_party/WebKit/Source/core/html/HTMLFrameOwnerElement.h

   1 /*
   2  * Copyright (C) 2006, 2007, 2009 Apple Inc. All rights reserved.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public License
  15  * along with this library; see the file COPYING.LIB.  If not, write to
  16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  17  * Boston, MA 02110-1301, USA.
  18  *
  19  */
  20
  21 #ifndef HTMLFrameOwnerElement_h
  22 #define HTMLFrameOwnerElement_h
  23
  24 #include "core/CoreExport.h"
  25 #include "core/dom/Document.h"
  26 #include "core/frame/FrameOwner.h"
  27 #include "core/html/HTMLElement.h"
  28 #include "platform/heap/Handle.h"
  29 #include "platform/scroll/ScrollTypes.h"
  30 #include "platform/weborigin/SecurityPolicy.h"
  31 #include "wtf/HashCountedSet.h"
  32
  33 namespace blink {
  34
  35 class LocalDOMWindow;
  36 class ExceptionState;
  37 class Frame;
  38 class LayoutPart;
  39 class Widget;
  40
  41 class CORE_EXPORT HTMLFrameOwnerElement : public HTMLElement, public FrameOwner {
  42     WILL_BE_USING_GARBAGE_COLLECTED_MIXIN(HTMLFrameOwnerElement);
  43 public:
  44     ~HTMLFrameOwnerElement() override;
  45
  46     Frame* contentFrame() const { return m_contentFrame; }
  47     DOMWindow* contentWindow() const;
  48     Document* contentDocument() const;
  49
  50     void setContentFrame(Frame&);
  51     void clearContentFrame();
  52
  53     virtual void disconnectContentFrame();
  54
  55     // Most subclasses use LayoutPart (either LayoutEmbeddedObject or LayoutIFrame)
  56     // except for HTMLObjectElement and HTMLEmbedElement which may return any
  57     // LayoutObject when using fallback content.
  58     LayoutPart* layoutPart() const;
  59
  60     Document* getSVGDocument(ExceptionState&) const;
  61
  62     virtual ScrollbarMode scrollingMode() const { return ScrollbarAuto; }
  63
  64     virtual bool loadedNonEmptyDocument() const { return false; }
  65     virtual void didLoadNonEmptyDocument() { }
  66
  67     void setWidget(PassRefPtrWillBeRawPtr<Widget>);
  68     Widget* ownedWidget() const;
  69
  70     class UpdateSuspendScope {
  71         STACK_ALLOCATED();
  72     public:
  73         UpdateSuspendScope();
  74         ~UpdateSuspendScope();
  75
  76     private:
  77         void performDeferredWidgetTreeOperations();
  78     };
  79
  80     // FrameOwner overrides:
  81     bool isLocal() const override { return true; }
  82     void dispatchLoad() override;
  83     SandboxFlags sandboxFlags() const override { return m_sandboxFlags; }
  84     void renderFallbackContent() override { }
  85
  86     DECLARE_VIRTUAL_TRACE();
  87
  88 protected:
  89     HTMLFrameOwnerElement(const QualifiedName& tagName, Document&);
  90     void setSandboxFlags(SandboxFlags);
  91
  92     bool loadOrRedirectSubframe(const KURL&, const AtomicString& frameName, bool replaceCurrentItem);
  93
  94 private:
  95     bool isKeyboardFocusable() const override;
  96     bool isFrameOwnerElement() const final { return true; }
  97
  98     virtual ReferrerPolicy referrerPolicyAttribute() { return ReferrerPolicyDefault; }
  99
 100     RawPtrWillBeMember<Frame> m_contentFrame;
 101     RefPtrWillBeMember<Widget> m_widget;
 102     SandboxFlags m_sandboxFlags;
 103 };
 104
 105 DEFINE_ELEMENT_TYPE_CASTS(HTMLFrameOwnerElement, isFrameOwnerElement());
 106
 107 class SubframeLoadingDisabler {
 108     STACK_ALLOCATED();
 109 public:
 110     explicit SubframeLoadingDisabler(Node& root)
 111         : m_root(root)
 112     {
 113         disabledSubtreeRoots().add(m_root);
 114     }
 115
 116     ~SubframeLoadingDisabler()
 117     {
 118         disabledSubtreeRoots().remove(m_root);
 119     }
 120
 121     static bool canLoadFrame(HTMLFrameOwnerElement& owner)
 122     {
 123         if (owner.document().unloadStarted())
 124             return false;
 125         for (Node* node = &owner; node; node = node->parentOrShadowHostNode()) {
 126             if (disabledSubtreeRoots().contains(node))
 127                 return false;
 128         }
 129         return true;
 130     }
 131
 132 private:
 133     static WillBeHeapHashCountedSet<RawPtrWillBeMember<Node>>& disabledSubtreeRoots();
 134
 135     RawPtrWillBeMember<Node> m_root;
 136 };
 137
 138 DEFINE_TYPE_CASTS(HTMLFrameOwnerElement, FrameOwner, owner, owner->isLocal(), owner.isLocal());
 139
 140 } // namespace blink
 141
 142 #endif // HTMLFrameOwnerElement_h