blob: 7c7fbb56f3382fe08fbd804fab373b0050b350ff [file] [log] [blame]
/*
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are
* met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following disclaimer
* in the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Google Inc. nor the names of its
* contributors may be used to endorse or promote products derived from
* this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "config.h"
#include "TreeScopeOrderedMap.h"
#include "ContainerNodeAlgorithms.h"
#include "ElementIterator.h"
#include "HTMLImageElement.h"
#include "HTMLLabelElement.h"
#include "HTMLMapElement.h"
#include "HTMLNameCollection.h"
namespace WebCore {
using namespace HTMLNames;
void TreeScopeOrderedMap::clear()
{
m_map.clear();
}
void TreeScopeOrderedMap::add(const AtomStringImpl& key, Element& element, const TreeScope& treeScope)
{
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(&element.treeScope() == &treeScope);
ASSERT_WITH_SECURITY_IMPLICATION(treeScope.rootNode().containsIncludingShadowDOM(&element));
if (!element.isInTreeScope())
return;
Map::AddResult addResult = m_map.ensure(&key, [&element] {
return MapEntry(&element);
});
MapEntry& entry = addResult.iterator->value;
#if ASSERT_ENABLED || ENABLE(SECURITY_ASSERTIONS)
ASSERT_WITH_SECURITY_IMPLICATION(!entry.registeredElements.contains(&element));
entry.registeredElements.add(&element);
#endif
if (addResult.isNewEntry)
return;
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(entry.count);
entry.element = nullptr;
entry.count++;
entry.orderedList.clear();
}
void TreeScopeOrderedMap::remove(const AtomStringImpl& key, Element& element)
{
m_map.checkConsistency();
auto it = m_map.find(&key);
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(it != m_map.end());
MapEntry& entry = it->value;
ASSERT_WITH_SECURITY_IMPLICATION(entry.registeredElements.remove(&element));
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(entry.count);
if (entry.count == 1) {
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(!entry.element || entry.element == &element);
m_map.remove(it);
} else {
if (entry.element == &element)
entry.element = nullptr;
entry.count--;
entry.orderedList.clear(); // FIXME: Remove the element instead if there are only few items left.
}
}
template <typename KeyMatchingFunction>
inline Element* TreeScopeOrderedMap::get(const AtomStringImpl& key, const TreeScope& scope, const KeyMatchingFunction& keyMatches) const
{
m_map.checkConsistency();
auto it = m_map.find(&key);
if (it == m_map.end())
return nullptr;
MapEntry& entry = it->value;
ASSERT(entry.count);
if (entry.element) {
auto& element = *entry.element;
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(&element.treeScope() == &scope);
ASSERT_WITH_SECURITY_IMPLICATION(entry.registeredElements.contains(&element));
return &element;
}
// We know there's at least one node that matches; iterate to find the first one.
for (auto& element : descendantsOfType<Element>(scope.rootNode())) {
if (!keyMatches(key, element))
continue;
entry.element = &element;
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(&element.treeScope() == &scope);
ASSERT_WITH_SECURITY_IMPLICATION(entry.registeredElements.contains(entry.element));
return &element;
}
#if ASSERT_ENABLED
// FormAssociatedElement may call getElementById to find its owner form in the middle of a tree removal.
if (auto* currentScope = ContainerChildRemovalScope::currentScope()) {
ASSERT(&scope.rootNode() == &currentScope->parentOfRemovedTree().rootNode());
Node& removedTree = currentScope->removedChild();
ASSERT(is<ContainerNode>(removedTree));
for (auto& element : descendantsOfType<Element>(downcast<ContainerNode>(removedTree))) {
if (!keyMatches(key, element))
continue;
bool removedFromAncestorHasNotBeenCalledYet = element.isConnected();
ASSERT(removedFromAncestorHasNotBeenCalledYet);
return nullptr;
}
}
ASSERT_NOT_REACHED();
#endif // ASSERT_ENABLED
return nullptr;
}
Element* TreeScopeOrderedMap::getElementById(const AtomStringImpl& key, const TreeScope& scope) const
{
return get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
return element.getIdAttribute().impl() == &key;
});
}
Element* TreeScopeOrderedMap::getElementByName(const AtomStringImpl& key, const TreeScope& scope) const
{
return get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
return element.getNameAttribute().impl() == &key;
});
}
HTMLMapElement* TreeScopeOrderedMap::getElementByMapName(const AtomStringImpl& key, const TreeScope& scope) const
{
return downcast<HTMLMapElement>(get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
return is<HTMLMapElement>(element) && downcast<HTMLMapElement>(element).getName().impl() == &key;
}));
}
HTMLImageElement* TreeScopeOrderedMap::getElementByUsemap(const AtomStringImpl& key, const TreeScope& scope) const
{
return downcast<HTMLImageElement>(get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
// FIXME: HTML5 specification says we should match both image and object elements.
return is<HTMLImageElement>(element) && downcast<HTMLImageElement>(element).matchesUsemap(key);
}));
}
HTMLLabelElement* TreeScopeOrderedMap::getElementByLabelForAttribute(const AtomStringImpl& key, const TreeScope& scope) const
{
return downcast<HTMLLabelElement>(get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
return is<HTMLLabelElement>(element) && element.attributeWithoutSynchronization(forAttr).impl() == &key;
}));
}
Element* TreeScopeOrderedMap::getElementByWindowNamedItem(const AtomStringImpl& key, const TreeScope& scope) const
{
return get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
return WindowNameCollection::elementMatches(element, &key);
});
}
Element* TreeScopeOrderedMap::getElementByDocumentNamedItem(const AtomStringImpl& key, const TreeScope& scope) const
{
return get(key, scope, [] (const AtomStringImpl& key, const Element& element) {
return DocumentNameCollection::elementMatches(element, &key);
});
}
const Vector<Element*>* TreeScopeOrderedMap::getAllElementsById(const AtomStringImpl& key, const TreeScope& scope) const
{
m_map.checkConsistency();
auto mapIterator = m_map.find(&key);
if (mapIterator == m_map.end())
return nullptr;
auto& entry = mapIterator->value;
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(entry.count);
if (entry.orderedList.isEmpty()) {
entry.orderedList.reserveCapacity(entry.count);
auto elementDescendants = descendantsOfType<Element>(scope.rootNode());
for (auto it = entry.element ? elementDescendants.beginAt(*entry.element) : elementDescendants.begin(); it; ++it) {
if (it->getIdAttribute().impl() == &key)
entry.orderedList.append(&*it);
}
RELEASE_ASSERT_WITH_SECURITY_IMPLICATION(entry.orderedList.size() == entry.count);
}
return &entry.orderedList;
}
const Vector<AtomString> TreeScopeOrderedMap::keys() const
{
return WTF::map(m_map, [](auto& entry) -> AtomString {
return const_cast<AtomStringImpl*>(entry.key);
});
}
} // namespace WebCore