1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/*
* Copyright (C) 2006-2017 Apple Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#pragma once
#include "FrameIdentifier.h"
#include <wtf/Forward.h>
#include <wtf/WeakPtr.h>
#include <wtf/text/AtomString.h>
namespace WebCore {
enum class CanWrap : bool { No, Yes };
enum class DidWrap : bool { No, Yes };
class Frame;
class LocalFrame;
class TreeScope;
class FrameTree {
WTF_MAKE_NONCOPYABLE(FrameTree);
public:
static constexpr unsigned invalidCount = static_cast<unsigned>(-1);
FrameTree(Frame& thisFrame, Frame* parentFrame);
~FrameTree();
const AtomString& specifiedName() const { return m_specifiedName; }
WEBCORE_EXPORT AtomString uniqueName() const;
WEBCORE_EXPORT void setSpecifiedName(const AtomString&);
WEBCORE_EXPORT void clearName();
WEBCORE_EXPORT Frame* parent() const;
Frame* nextSibling() const { return m_nextSibling.get(); }
Frame* previousSibling() const { return m_previousSibling.get(); }
Frame* firstChild() const { return m_firstChild.get(); }
Frame* lastChild() const { return m_lastChild.get(); }
Frame* firstRenderedChild() const;
Frame* nextRenderedSibling() const;
WEBCORE_EXPORT bool isDescendantOf(const Frame* ancestor) const;
WEBCORE_EXPORT Frame* traverseNext(const Frame* stayWithin = nullptr) const;
Frame* traverseNextSkippingChildren(const Frame* stayWithin = nullptr) const;
// Rendered means being the main frame or having an ownerRenderer. It may not have been parented in the Widget tree yet (see WidgetHierarchyUpdatesSuspensionScope).
WEBCORE_EXPORT Frame* traverseNextRendered(const Frame* stayWithin = nullptr) const;
WEBCORE_EXPORT Frame* traverseNext(CanWrap, DidWrap* = nullptr) const;
WEBCORE_EXPORT Frame* traversePrevious(CanWrap, DidWrap* = nullptr) const;
Frame* traverseNextInPostOrder(CanWrap) const;
WEBCORE_EXPORT void appendChild(Frame&);
void detachFromParent() { m_parent = nullptr; }
WEBCORE_EXPORT void removeChild(Frame&);
Frame* child(unsigned index) const;
Frame* childBySpecifiedName(const AtomString& name) const;
Frame* childByFrameID(FrameIdentifier) const;
WEBCORE_EXPORT Frame* findByUniqueName(const AtomString&, Frame& activeFrame) const;
WEBCORE_EXPORT Frame* findBySpecifiedName(const AtomString&, Frame& activeFrame) const;
WEBCORE_EXPORT unsigned childCount() const;
unsigned descendantCount() const;
WEBCORE_EXPORT Frame& top() const;
Ref<Frame> protectedTop() const;
unsigned depth() const;
WEBCORE_EXPORT Frame* scopedChild(unsigned index) const;
WEBCORE_EXPORT Frame* scopedChildByUniqueName(const AtomString&) const;
Frame* scopedChildBySpecifiedName(const AtomString& name) const;
unsigned scopedChildCount() const;
private:
Frame* deepFirstChild() const;
Frame* deepLastChild() const;
Frame* nextAncestorSibling(const Frame* stayWithin) const;
Frame* scopedChild(unsigned index, TreeScope*) const;
Frame* scopedChild(const Function<bool(const FrameTree&)>& isMatch, TreeScope*) const;
unsigned scopedChildCount(TreeScope*) const;
template<typename F> Frame* find(const AtomString& name, F&& nameGetter, Frame& activeFrame) const;
Ref<Frame> protectedThisFrame() const;
WeakRef<Frame> m_thisFrame;
WeakPtr<Frame> m_parent;
AtomString m_specifiedName; // The actual frame name (may be empty).
RefPtr<Frame> m_nextSibling;
WeakPtr<Frame> m_previousSibling;
RefPtr<Frame> m_firstChild;
WeakPtr<Frame> m_lastChild;
mutable unsigned m_scopedChildCount { invalidCount };
};
ASCIILiteral blankTargetFrameName();
ASCIILiteral selfTargetFrameName();
bool isBlankTargetFrameName(StringView);
bool isParentTargetFrameName(StringView);
bool isSelfTargetFrameName(StringView);
bool isTopTargetFrameName(StringView);
} // namespace WebCore
#if ENABLE(TREE_DEBUGGING)
// Outside the WebCore namespace for ease of invocation from the debugger.
WEBCORE_EXPORT void showFrameTree(const WebCore::Frame*);
#endif
|
