/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=8 sts=2 et sw=2 tw=80: */ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ #include "mozilla/dom/CustomElementRegistry.h" #include "mozilla/AsyncEventDispatcher.h" #include "mozilla/CycleCollectedJSContext.h" #include "mozilla/dom/CustomElementRegistryBinding.h" #include "mozilla/dom/HTMLElementBinding.h" #include "mozilla/dom/ShadowIncludingTreeIterator.h" #include "mozilla/dom/XULElementBinding.h" #include "mozilla/dom/Promise.h" #include "mozilla/dom/WebComponentsBinding.h" #include "mozilla/dom/DocGroup.h" #include "mozilla/dom/CustomEvent.h" #include "mozilla/dom/ShadowRoot.h" #include "nsHTMLTags.h" #include "jsapi.h" #include "js/ForOfIterator.h" // JS::ForOfIterator #include "xpcprivate.h" #include "nsGlobalWindow.h" namespace mozilla { namespace dom { //----------------------------------------------------- // CustomElementUpgradeReaction class CustomElementUpgradeReaction final : public CustomElementReaction { public: explicit CustomElementUpgradeReaction(CustomElementDefinition* aDefinition) : mDefinition(aDefinition) { mIsUpgradeReaction = true; } virtual void Traverse( nsCycleCollectionTraversalCallback& aCb) const override { NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(aCb, "mDefinition"); aCb.NoteNativeChild( mDefinition, NS_CYCLE_COLLECTION_PARTICIPANT(CustomElementDefinition)); } size_t SizeOfIncludingThis(MallocSizeOf aMallocSizeOf) const override { // We don't really own mDefinition. return aMallocSizeOf(this); } private: MOZ_CAN_RUN_SCRIPT virtual void Invoke(Element* aElement, ErrorResult& aRv) override { CustomElementRegistry::Upgrade(aElement, mDefinition, aRv); } const RefPtr mDefinition; }; //----------------------------------------------------- // CustomElementCallbackReaction class CustomElementCallbackReaction final : public CustomElementReaction { public: explicit CustomElementCallbackReaction( UniquePtr aCustomElementCallback) : mCustomElementCallback(std::move(aCustomElementCallback)) {} virtual void Traverse( nsCycleCollectionTraversalCallback& aCb) const override { mCustomElementCallback->Traverse(aCb); } size_t SizeOfIncludingThis(MallocSizeOf aMallocSizeOf) const override { size_t n = aMallocSizeOf(this); n += mCustomElementCallback->SizeOfIncludingThis(aMallocSizeOf); return n; } private: virtual void Invoke(Element* aElement, ErrorResult& aRv) override { mCustomElementCallback->Call(); } UniquePtr mCustomElementCallback; }; //----------------------------------------------------- // CustomElementCallback size_t LifecycleCallbackArgs::SizeOfExcludingThis( MallocSizeOf aMallocSizeOf) const { size_t n = name.SizeOfExcludingThisIfUnshared(aMallocSizeOf); n += oldValue.SizeOfExcludingThisIfUnshared(aMallocSizeOf); n += newValue.SizeOfExcludingThisIfUnshared(aMallocSizeOf); n += namespaceURI.SizeOfExcludingThisIfUnshared(aMallocSizeOf); return n; } void CustomElementCallback::Call() { switch (mType) { case Document::eConnected: static_cast(mCallback.get()) ->Call(mThisObject); break; case Document::eDisconnected: static_cast(mCallback.get()) ->Call(mThisObject); break; case Document::eAdopted: static_cast(mCallback.get()) ->Call(mThisObject, mAdoptedCallbackArgs.mOldDocument, mAdoptedCallbackArgs.mNewDocument); break; case Document::eAttributeChanged: static_cast(mCallback.get()) ->Call(mThisObject, mArgs.name, mArgs.oldValue, mArgs.newValue, mArgs.namespaceURI); break; case Document::eGetCustomInterface: MOZ_ASSERT_UNREACHABLE("Don't call GetCustomInterface through callback"); break; } } void CustomElementCallback::Traverse( nsCycleCollectionTraversalCallback& aCb) const { NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(aCb, "mThisObject"); aCb.NoteXPCOMChild(mThisObject); NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(aCb, "mCallback"); aCb.NoteXPCOMChild(mCallback); } size_t CustomElementCallback::SizeOfIncludingThis( MallocSizeOf aMallocSizeOf) const { size_t n = aMallocSizeOf(this); // We don't uniquely own mThisObject. // We own mCallback but it doesn't have any special memory reporting we can do // for it other than report its own size. n += aMallocSizeOf(mCallback); n += mArgs.SizeOfExcludingThis(aMallocSizeOf); // mAdoptedCallbackArgs doesn't really uniquely own its members. return n; } CustomElementCallback::CustomElementCallback( Element* aThisObject, Document::ElementCallbackType aCallbackType, mozilla::dom::CallbackFunction* aCallback) : mThisObject(aThisObject), mCallback(aCallback), mType(aCallbackType) {} //----------------------------------------------------- // CustomElementData CustomElementData::CustomElementData(nsAtom* aType) : CustomElementData(aType, CustomElementData::State::eUndefined) {} CustomElementData::CustomElementData(nsAtom* aType, State aState) : mState(aState), mType(aType) {} void CustomElementData::SetCustomElementDefinition( CustomElementDefinition* aDefinition) { MOZ_ASSERT(mState == State::eCustom); MOZ_ASSERT(!mCustomElementDefinition); MOZ_ASSERT(aDefinition->mType == mType); mCustomElementDefinition = aDefinition; } CustomElementDefinition* CustomElementData::GetCustomElementDefinition() { MOZ_ASSERT(mCustomElementDefinition ? mState == State::eCustom : mState != State::eCustom); return mCustomElementDefinition; } void CustomElementData::Traverse( nsCycleCollectionTraversalCallback& aCb) const { for (uint32_t i = 0; i < mReactionQueue.Length(); i++) { if (mReactionQueue[i]) { mReactionQueue[i]->Traverse(aCb); } } if (mCustomElementDefinition) { NS_CYCLE_COLLECTION_NOTE_EDGE_NAME(aCb, "mCustomElementDefinition"); aCb.NoteNativeChild( mCustomElementDefinition, NS_CYCLE_COLLECTION_PARTICIPANT(CustomElementDefinition)); } } void CustomElementData::Unlink() { mReactionQueue.Clear(); mCustomElementDefinition = nullptr; } size_t CustomElementData::SizeOfIncludingThis( MallocSizeOf aMallocSizeOf) const { size_t n = aMallocSizeOf(this); n += mReactionQueue.ShallowSizeOfExcludingThis(aMallocSizeOf); for (auto& reaction : mReactionQueue) { // "reaction" can be null if we're being called indirectly from // InvokeReactions (e.g. due to a reaction causing a memory report to be // captured somehow). if (reaction) { n += reaction->SizeOfIncludingThis(aMallocSizeOf); } } return n; } //----------------------------------------------------- // CustomElementRegistry namespace { class MOZ_RAII AutoConstructionStackEntry final { public: AutoConstructionStackEntry(nsTArray>& aStack, Element* aElement) : mStack(aStack) { MOZ_ASSERT(aElement->IsHTMLElement() || aElement->IsXULElement()); mIndex = mStack.Length(); mStack.AppendElement(aElement); } ~AutoConstructionStackEntry() { MOZ_ASSERT(mIndex == mStack.Length() - 1, "Removed element should be the last element"); mStack.RemoveElementAt(mIndex); } private: nsTArray>& mStack; uint32_t mIndex; }; } // namespace // Only needed for refcounted objects. NS_IMPL_CYCLE_COLLECTION_CLASS(CustomElementRegistry) NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(CustomElementRegistry) tmp->mConstructors.clear(); NS_IMPL_CYCLE_COLLECTION_UNLINK(mCustomDefinitions) NS_IMPL_CYCLE_COLLECTION_UNLINK(mWhenDefinedPromiseMap) NS_IMPL_CYCLE_COLLECTION_UNLINK(mElementCreationCallbacks) NS_IMPL_CYCLE_COLLECTION_UNLINK(mWindow) NS_IMPL_CYCLE_COLLECTION_UNLINK_PRESERVED_WRAPPER NS_IMPL_CYCLE_COLLECTION_UNLINK_END NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(CustomElementRegistry) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mCustomDefinitions) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mWhenDefinedPromiseMap) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mElementCreationCallbacks) NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mWindow) NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END NS_IMPL_CYCLE_COLLECTION_TRACE_BEGIN(CustomElementRegistry) for (auto iter = tmp->mConstructors.iter(); !iter.done(); iter.next()) { aCallbacks.Trace(&iter.get().mutableKey(), "mConstructors key", aClosure); } NS_IMPL_CYCLE_COLLECTION_TRACE_PRESERVED_WRAPPER NS_IMPL_CYCLE_COLLECTION_TRACE_END NS_IMPL_CYCLE_COLLECTING_ADDREF(CustomElementRegistry) NS_IMPL_CYCLE_COLLECTING_RELEASE(CustomElementRegistry) NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(CustomElementRegistry) NS_WRAPPERCACHE_INTERFACE_MAP_ENTRY NS_INTERFACE_MAP_ENTRY(nsISupports) NS_INTERFACE_MAP_END CustomElementRegistry::CustomElementRegistry(nsPIDOMWindowInner* aWindow) : mWindow(aWindow), mIsCustomDefinitionRunning(false) { MOZ_ASSERT(aWindow); mozilla::HoldJSObjects(this); } CustomElementRegistry::~CustomElementRegistry() { mozilla::DropJSObjects(this); } NS_IMETHODIMP CustomElementRegistry::RunCustomElementCreationCallback::Run() { ErrorResult er; nsDependentAtomString value(mAtom); mCallback->Call(value, er); MOZ_ASSERT(NS_SUCCEEDED(er.StealNSResult()), "chrome JavaScript error in the callback."); RefPtr definition = mRegistry->mCustomDefinitions.Get(mAtom); MOZ_ASSERT(definition, "Callback should define the definition of type."); MOZ_ASSERT(!mRegistry->mElementCreationCallbacks.GetWeak(mAtom), "Callback should be removed."); nsAutoPtr>> elements; mRegistry->mElementCreationCallbacksUpgradeCandidatesMap.Remove(mAtom, &elements); MOZ_ASSERT(elements, "There should be a list"); for (auto iter = elements->Iter(); !iter.Done(); iter.Next()) { nsCOMPtr elem = do_QueryReferent(iter.Get()->GetKey()); if (!elem) { continue; } CustomElementRegistry::Upgrade(elem, definition, er); MOZ_ASSERT(NS_SUCCEEDED(er.StealNSResult()), "chrome JavaScript error in custom element construction."); } return NS_OK; } CustomElementDefinition* CustomElementRegistry::LookupCustomElementDefinition( nsAtom* aNameAtom, int32_t aNameSpaceID, nsAtom* aTypeAtom) { CustomElementDefinition* data = mCustomDefinitions.GetWeak(aTypeAtom); if (!data) { RefPtr callback; mElementCreationCallbacks.Get(aTypeAtom, getter_AddRefs(callback)); if (callback) { mElementCreationCallbacks.Remove(aTypeAtom); mElementCreationCallbacksUpgradeCandidatesMap.LookupOrAdd(aTypeAtom); RefPtr runnable = new RunCustomElementCreationCallback(this, aTypeAtom, callback); nsContentUtils::AddScriptRunner(runnable.forget()); data = mCustomDefinitions.GetWeak(aTypeAtom); } } if (data && data->mLocalName == aNameAtom && data->mNamespaceID == aNameSpaceID) { return data; } return nullptr; } CustomElementDefinition* CustomElementRegistry::LookupCustomElementDefinition( JSContext* aCx, JSObject* aConstructor) const { // We're looking up things that tested true for JS::IsConstructor, // so doing a CheckedUnwrapStatic is fine here. JS::Rooted constructor(aCx, js::CheckedUnwrapStatic(aConstructor)); const auto& ptr = mConstructors.lookup(constructor); if (!ptr) { return nullptr; } CustomElementDefinition* definition = mCustomDefinitions.GetWeak(ptr->value()); MOZ_ASSERT(definition, "Definition must be found in mCustomDefinitions"); return definition; } void CustomElementRegistry::RegisterUnresolvedElement(Element* aElement, nsAtom* aTypeName) { // We don't have a use-case for a Custom Element inside NAC, and continuing // here causes performance issues for NAC + XBL anonymous content. if (aElement->IsInNativeAnonymousSubtree()) { return; } mozilla::dom::NodeInfo* info = aElement->NodeInfo(); // Candidate may be a custom element through extension, // in which case the custom element type name will not // match the element tag name. e.g.