| /* |
| * Copyright (C) 2006 Apple Computer, Inc. |
| * |
| * 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. |
| */ |
| |
| #ifndef THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_FRAME_TREE_H_ |
| #define THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_FRAME_TREE_H_ |
| |
| #include "base/macros.h" |
| #include "third_party/blink/renderer/core/core_export.h" |
| #include "third_party/blink/renderer/platform/heap/handle.h" |
| #include "third_party/blink/renderer/platform/wtf/text/atomic_string.h" |
| |
| namespace blink { |
| |
| class Frame; |
| |
| class CORE_EXPORT FrameTree final { |
| DISALLOW_NEW(); |
| |
| public: |
| explicit FrameTree(Frame* this_frame); |
| ~FrameTree(); |
| |
| const AtomicString& GetName() const; |
| |
| enum ReplicationPolicy { |
| // Does not propagate name changes beyond this FrameTree object. |
| kDoNotReplicate, |
| |
| // Kicks-off propagation of name changes to other renderers. |
| kReplicate, |
| }; |
| void SetName(const AtomicString&, ReplicationPolicy = kDoNotReplicate); |
| |
| // TODO(andypaicu): remove this once we have gathered the data |
| void ExperimentalSetNulledName(); |
| |
| Frame* Parent() const; |
| Frame& Top() const; |
| Frame* NextSibling() const; |
| Frame* FirstChild() const; |
| |
| bool IsDescendantOf(const Frame* ancestor) const; |
| Frame* TraverseNext(const Frame* stay_within = nullptr) const; |
| |
| Frame* Find(const AtomicString& name) const; |
| unsigned ChildCount() const; |
| |
| Frame* ScopedChild(unsigned index) const; |
| // https://whatwg.org/C/window-object.html#named-access-on-the-window-object |
| // This implements the steps needed for looking up a child browsing context |
| // that matches |name|. If |name.IsEmpty()| is true, this is guaranteed to |
| // return null: the spec specifically states that browsing contexts with a |
| // name are never considered. |
| Frame* ScopedChild(const AtomicString& name) const; |
| unsigned ScopedChildCount() const; |
| void InvalidateScopedChildCount(); |
| |
| void Trace(blink::Visitor*); |
| |
| private: |
| Member<Frame> this_frame_; |
| |
| AtomicString name_; // The actual frame name (may be empty). |
| |
| mutable unsigned scoped_child_count_; |
| |
| // TODO(andypaicu): remove this once we have gathered the data |
| bool experimental_set_nulled_name_; |
| |
| DISALLOW_COPY_AND_ASSIGN(FrameTree); |
| }; |
| |
| } // namespace blink |
| |
| #ifndef NDEBUG |
| // Outside the WebCore namespace for ease of invocation from gdb. |
| void showFrameTree(const blink::Frame*); |
| #endif |
| |
| #endif // THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_FRAME_TREE_H_ |