Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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
#include "OuterDocAccessible.h"
#include "LocalAccessible-inl.h"
#include "DocAccessible-inl.h"
#include "mozilla/a11y/DocAccessibleChild.h"
#include "mozilla/a11y/DocAccessibleParent.h"
#include "mozilla/dom/BrowserBridgeChild.h"
#include "mozilla/dom/BrowserParent.h"
#include "mozilla/a11y/Role.h"
#ifdef A11Y_LOG
# include "Logging.h"
#endif
using namespace mozilla;
using namespace mozilla::a11y;
////////////////////////////////////////////////////////////////////////////////
// OuterDocAccessible
////////////////////////////////////////////////////////////////////////////////
OuterDocAccessible::OuterDocAccessible(nsIContent* aContent,
DocAccessible* aDoc)
: AccessibleWrap(aContent, aDoc) {
mType = eOuterDocType;
if (IPCAccessibilityActive()) {
auto bridge = dom::BrowserBridgeChild::GetFrom(aContent);
if (bridge) {
// This is an iframe which will be rendered in another process.
SendEmbedderAccessible(bridge);
}
}
// Request document accessible for the content document to make sure it's
// created. It will appended to outerdoc accessible children asynchronously.
dom::Document* outerDoc = mContent->GetUncomposedDoc();
if (outerDoc) {
dom::Document* innerDoc = outerDoc->GetSubDocumentFor(mContent);
if (innerDoc) GetAccService()->GetDocAccessible(innerDoc);
}
}
OuterDocAccessible::~OuterDocAccessible() {}
void OuterDocAccessible::SendEmbedderAccessible(
dom::BrowserBridgeChild* aBridge) {
MOZ_ASSERT(mDoc);
DocAccessibleChild* ipcDoc = mDoc->IPCDoc();
if (ipcDoc) {
uint64_t id = reinterpret_cast<uintptr_t>(UniqueID());
aBridge->SetEmbedderAccessible(ipcDoc, id);
}
}
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible public (DON'T add methods here)
role OuterDocAccessible::NativeRole() const { return roles::INTERNAL_FRAME; }
LocalAccessible* OuterDocAccessible::LocalChildAtPoint(
int32_t aX, int32_t aY, EWhichChildAtPoint aWhichChild) {
LayoutDeviceIntRect docRect = Bounds();
if (!docRect.Contains(aX, aY)) return nullptr;
// Always return the inner doc as direct child accessible unless bounds
// outside of it.
LocalAccessible* child = LocalChildAt(0);
NS_ENSURE_TRUE(child, nullptr);
if (aWhichChild == Accessible::EWhichChildAtPoint::DeepestChild) {
return child->LocalChildAtPoint(
aX, aY, Accessible::EWhichChildAtPoint::DeepestChild);
}
return child;
}
////////////////////////////////////////////////////////////////////////////////
// LocalAccessible public
void OuterDocAccessible::Shutdown() {
#ifdef A11Y_LOG
if (logging::IsEnabled(logging::eDocDestroy)) logging::OuterDocDestroy(this);
#endif
if (auto* bridge = dom::BrowserBridgeChild::GetFrom(mContent)) {
uint64_t id = reinterpret_cast<uintptr_t>(UniqueID());
if (bridge->GetEmbedderAccessibleID() == id) {
// We were the last embedder accessible sent via PBrowserBridge; i.e. a
// new embedder accessible hasn't been created yet for this iframe. Clear
// the embedder accessible on PBrowserBridge.
bridge->SetEmbedderAccessible(nullptr, 0);
}
}
LocalAccessible* child = mChildren.SafeElementAt(0, nullptr);
if (child) {
#ifdef A11Y_LOG
if (logging::IsEnabled(logging::eDocDestroy)) {
logging::DocDestroy("outerdoc's child document rebind is scheduled",
child->AsDoc()->DocumentNode());
}
#endif
RemoveChild(child);
// XXX: sometimes outerdoc accessible is shutdown because of layout style
// change however the presshell of underlying document isn't destroyed and
// the document doesn't get pagehide events. Schedule a document rebind
// to its parent document. Otherwise a document accessible may be lost if
if (!mDoc->IsDefunct()) {
MOZ_ASSERT(!child->IsDefunct(),
"Attempt to reattach shutdown document accessible");
if (!child->IsDefunct()) {
mDoc->BindChildDocument(child->AsDoc());
}
}
}
AccessibleWrap::Shutdown();
}
bool OuterDocAccessible::InsertChildAt(uint32_t aIdx,
LocalAccessible* aAccessible) {
MOZ_RELEASE_ASSERT(aAccessible->IsDoc(),
"OuterDocAccessible can have a document child only!");
// We keep showing the old document for a bit after creating the new one,
// and while building the new DOM and frame tree. That's done on purpose
// to avoid weird flashes of default background color.
// The old viewer will be destroyed after the new one is created.
// For a11y, it should be safe to shut down the old document now.
if (mChildren.Length()) mChildren[0]->Shutdown();
if (!AccessibleWrap::InsertChildAt(0, aAccessible)) return false;
#ifdef A11Y_LOG
if (logging::IsEnabled(logging::eDocCreate)) {
logging::DocCreate("append document to outerdoc",
aAccessible->AsDoc()->DocumentNode());
logging::Address("outerdoc", this);
}
#endif
return true;
}
bool OuterDocAccessible::RemoveChild(LocalAccessible* aAccessible) {
LocalAccessible* child = mChildren.SafeElementAt(0, nullptr);
MOZ_ASSERT(child == aAccessible, "Wrong child to remove!");
if (child != aAccessible) {
return false;
}
#ifdef A11Y_LOG
if (logging::IsEnabled(logging::eDocDestroy)) {
logging::DocDestroy("remove document from outerdoc",
child->AsDoc()->DocumentNode(), child->AsDoc());
logging::Address("outerdoc", this);
}
#endif
bool wasRemoved = AccessibleWrap::RemoveChild(child);
NS_ASSERTION(!mChildren.Length(),
"This child document of outerdoc accessible wasn't removed!");
return wasRemoved;
}
bool OuterDocAccessible::IsAcceptableChild(nsIContent* aEl) const {
// outer document accessible doesn't not participate in ordinal tree
// mutations.
return false;
}
// Accessible
uint32_t OuterDocAccessible::ChildCount() const {
uint32_t result = mChildren.Length();
if (!result && RemoteChildDoc()) {
result = 1;
}
return result;
}
Accessible* OuterDocAccessible::ChildAt(uint32_t aIndex) const {
LocalAccessible* result = LocalChildAt(aIndex);
if (result || aIndex) {
return result;
}
return RemoteChildDoc();
}
Accessible* OuterDocAccessible::ChildAtPoint(int32_t aX, int32_t aY,
EWhichChildAtPoint aWhichChild) {
LayoutDeviceIntRect docRect = Bounds();
if (!docRect.Contains(aX, aY)) return nullptr;
// Always return the inner doc as direct child accessible unless bounds
// outside of it.
Accessible* child = ChildAt(0);
NS_ENSURE_TRUE(child, nullptr);
if (aWhichChild == EWhichChildAtPoint::DeepestChild) {
return child->ChildAtPoint(aX, aY, EWhichChildAtPoint::DeepestChild);
}
return child;
}
DocAccessibleParent* OuterDocAccessible::RemoteChildDoc() const {
dom::BrowserParent* tab = dom::BrowserParent::GetFrom(GetContent());
if (!tab) {
return nullptr;
}
return tab->GetTopLevelDocAccessible();
}