c087f2b7450120cd07fe8a4f3d927e758907f65f
[WebKit-https.git] / Source / WebCore / 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 "HTMLElement.h"
25
26 namespace WebCore {
27
28 class DOMWindow;
29 class Frame;
30 class RenderWidget;
31
32 #if ENABLE(SVG)
33 class SVGDocument;
34 #endif
35
36 class HTMLFrameOwnerElement : public HTMLElement {
37 public:
38     virtual ~HTMLFrameOwnerElement();
39
40     Frame* contentFrame() const { return m_contentFrame; }
41     DOMWindow* contentWindow() const;
42     Document* contentDocument() const;
43
44     void setContentFrame(Frame*);
45     void clearContentFrame();
46
47     void disconnectContentFrame();
48
49     // Most subclasses use RenderWidget (either RenderEmbeddedObject or RenderIFrame)
50     // except for HTMLObjectElement and HTMLEmbedElement which may return any
51     // RenderObject when using fallback content.
52     RenderWidget* renderWidget() const;
53
54 #if ENABLE(SVG)
55     SVGDocument* getSVGDocument(ExceptionCode&) const;
56 #endif
57
58     virtual ScrollbarMode scrollingMode() const { return ScrollbarAuto; }
59
60     SandboxFlags sandboxFlags() const { return m_sandboxFlags; }
61
62 protected:
63     HTMLFrameOwnerElement(const QualifiedName& tagName, Document&);
64     void setSandboxFlags(SandboxFlags);
65
66 private:
67     virtual bool isKeyboardFocusable(KeyboardEvent*) const OVERRIDE;
68     virtual bool isFrameOwnerElement() const OVERRIDE { return true; }
69
70     Frame* m_contentFrame;
71     SandboxFlags m_sandboxFlags;
72 };
73
74 inline HTMLFrameOwnerElement* toFrameOwnerElement(Node* node)
75 {
76     ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isFrameOwnerElement());
77     return static_cast<HTMLFrameOwnerElement*>(node);
78 }
79
80 class SubframeLoadingDisabler {
81 public:
82     explicit SubframeLoadingDisabler(Node* root)
83         : m_root(root)
84     {
85         disabledSubtreeRoots().add(m_root);
86     }
87
88     ~SubframeLoadingDisabler()
89     {
90         disabledSubtreeRoots().remove(m_root);
91     }
92
93     static bool canLoadFrame(HTMLFrameOwnerElement*);
94
95 private:
96     static HashSet<Node*>& disabledSubtreeRoots()
97     {
98         DEFINE_STATIC_LOCAL(HashSet<Node*>, nodes, ());
99         return nodes;
100     }
101
102     Node* m_root;
103 };
104
105 } // namespace WebCore
106
107 #endif // HTMLFrameOwnerElement_h