blob: 5f596a32ec624213fa7ab442a21b86862af7aacf [file] [log] [blame]
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 1999 Antti Koivisto (koivisto@kde.org)
* Copyright (C) 2003-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.
*
*/
#include "config.h"
#include "HTMLCollection.h"
#include "CachedHTMLCollection.h"
#include "HTMLNames.h"
#include "NodeRareData.h"
namespace WebCore {
using namespace HTMLNames;
inline auto HTMLCollection::rootTypeFromCollectionType(CollectionType type) -> RootType
{
switch (type) {
case DocImages:
case DocApplets:
case DocEmbeds:
case DocForms:
case DocLinks:
case DocAnchors:
case DocScripts:
case DocAll:
case WindowNamedItems:
case DocumentNamedItems:
case DocumentAllNamedItems:
case FormControls:
return HTMLCollection::IsRootedAtDocument;
case AllDescendants:
case ByClass:
case ByTag:
case ByHTMLTag:
case NodeChildren:
case TableTBodies:
case TSectionRows:
case TableRows:
case TRCells:
case SelectOptions:
case SelectedOptions:
case DataListOptions:
case MapAreas:
return HTMLCollection::IsRootedAtNode;
}
ASSERT_NOT_REACHED();
return HTMLCollection::IsRootedAtNode;
}
static NodeListInvalidationType invalidationTypeExcludingIdAndNameAttributes(CollectionType type)
{
switch (type) {
case ByTag:
case ByHTMLTag:
case AllDescendants:
case DocImages:
case DocEmbeds:
case DocForms:
case DocScripts:
case DocAll:
case NodeChildren:
case TableTBodies:
case TSectionRows:
case TableRows:
case TRCells:
case SelectOptions:
case MapAreas:
return DoNotInvalidateOnAttributeChanges;
case DocApplets:
case SelectedOptions:
case DataListOptions:
// FIXME: We can do better some day.
return InvalidateOnAnyAttrChange;
case ByClass:
return InvalidateOnClassAttrChange;
case DocAnchors:
return InvalidateOnNameAttrChange;
case DocLinks:
return InvalidateOnHRefAttrChange;
case WindowNamedItems:
case DocumentNamedItems:
case DocumentAllNamedItems:
return InvalidateOnIdNameAttrChange;
case FormControls:
return InvalidateForFormControls;
}
ASSERT_NOT_REACHED();
return DoNotInvalidateOnAttributeChanges;
}
HTMLCollection::HTMLCollection(ContainerNode& ownerNode, CollectionType type)
: m_ownerNode(ownerNode)
, m_collectionType(type)
, m_invalidationType(invalidationTypeExcludingIdAndNameAttributes(type))
, m_rootType(rootTypeFromCollectionType(type))
{
ASSERT(m_rootType == static_cast<unsigned>(rootTypeFromCollectionType(type)));
ASSERT(m_invalidationType == static_cast<unsigned>(invalidationTypeExcludingIdAndNameAttributes(type)));
ASSERT(m_collectionType == static_cast<unsigned>(type));
}
HTMLCollection::~HTMLCollection()
{
if (hasNamedElementCache())
document().collectionWillClearIdNameMap(*this);
// HTMLNameCollection & ClassCollection remove cache by themselves.
// FIXME: We need a cleaner way to handle this.
switch (type()) {
case ByClass:
case ByTag:
case ByHTMLTag:
case WindowNamedItems:
case DocumentNamedItems:
case DocumentAllNamedItems:
break;
default:
ownerNode().nodeLists()->removeCachedCollection(this);
}
}
void HTMLCollection::invalidateCacheForDocument(Document& document)
{
if (hasNamedElementCache())
invalidateNamedElementCache(document);
}
void HTMLCollection::invalidateNamedElementCache(Document& document) const
{
ASSERT(hasNamedElementCache());
document.collectionWillClearIdNameMap(*this);
{
auto locker = holdLock(m_namedElementCacheAssignmentLock);
m_namedElementCache = nullptr;
}
}
Element* HTMLCollection::namedItemSlow(const AtomicString& name) const
{
// The pathological case. We need to walk the entire subtree.
updateNamedElementCache();
ASSERT(m_namedElementCache);
if (const Vector<Element*>* idResults = m_namedElementCache->findElementsWithId(name)) {
if (idResults->size())
return idResults->at(0);
}
if (const Vector<Element*>* nameResults = m_namedElementCache->findElementsWithName(name)) {
if (nameResults->size())
return nameResults->at(0);
}
return nullptr;
}
// Documented in https://dom.spec.whatwg.org/#interface-htmlcollection.
const Vector<AtomicString>& HTMLCollection::supportedPropertyNames()
{
updateNamedElementCache();
ASSERT(m_namedElementCache);
return m_namedElementCache->propertyNames();
}
bool HTMLCollection::isSupportedPropertyName(const String& name)
{
updateNamedElementCache();
ASSERT(m_namedElementCache);
if (m_namedElementCache->findElementsWithId(name))
return true;
if (m_namedElementCache->findElementsWithName(name))
return true;
return false;
}
void HTMLCollection::updateNamedElementCache() const
{
if (hasNamedElementCache())
return;
auto cache = std::make_unique<CollectionNamedElementCache>();
unsigned size = length();
for (unsigned i = 0; i < size; ++i) {
Element& element = *item(i);
const AtomicString& id = element.getIdAttribute();
if (!id.isEmpty())
cache->appendToIdCache(id, element);
if (!is<HTMLElement>(element))
continue;
const AtomicString& name = element.getNameAttribute();
if (!name.isEmpty() && id != name && (type() != DocAll || nameShouldBeVisibleInDocumentAll(downcast<HTMLElement>(element))))
cache->appendToNameCache(name, element);
}
setNamedItemCache(WTFMove(cache));
}
Vector<Ref<Element>> HTMLCollection::namedItems(const AtomicString& name) const
{
// FIXME: This non-virtual function can't possibly be doing the correct thing for
// any derived class that overrides the virtual namedItem function.
Vector<Ref<Element>> elements;
if (name.isEmpty())
return elements;
updateNamedElementCache();
ASSERT(m_namedElementCache);
auto* elementsWithId = m_namedElementCache->findElementsWithId(name);
auto* elementsWithName = m_namedElementCache->findElementsWithName(name);
elements.reserveInitialCapacity((elementsWithId ? elementsWithId->size() : 0) + (elementsWithName ? elementsWithName->size() : 0));
if (elementsWithId) {
for (auto& element : *elementsWithId)
elements.uncheckedAppend(*element);
}
if (elementsWithName) {
for (auto& element : *elementsWithName)
elements.uncheckedAppend(*element);
}
return elements;
}
} // namespace WebCore