author Sebastian Hengst <>
Sat, 19 Nov 2016 09:25:27 +0100
changeset 323547 cc8f92af70ab9d5dc7a06e6ef26bbb3f72d46d56
parent 323546 48ac718556a01201c327e022ed83825c2dbe5f56
child 323552 e79129082f4a6e327d20cf8d88324fd517277b7b
permissions -rw-r--r--
Backed out changeset 48ac718556a0 (bug 1297474) for crash in Marionette test TestSwitchRemoteFrame.test_remote_frame_revisit. r=backout

/* 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 */

#ifndef mozilla_a11_DocManager_h_
#define mozilla_a11_DocManager_h_

#include "mozilla/ClearOnShutdown.h"
#include "nsIDocument.h"
#include "nsIDOMEventListener.h"
#include "nsRefPtrHashtable.h"
#include "nsIWebProgressListener.h"
#include "nsWeakReference.h"
#include "nsIPresShell.h"
#include "mozilla/StaticPtr.h"

namespace mozilla {
namespace a11y {

class Accessible;
class DocAccessible;
class xpcAccessibleDocument;
class DocAccessibleParent;

 * Manage the document accessible life cycle.
class DocManager : public nsIWebProgressListener,
                   public nsIDOMEventListener,
                   public nsSupportsWeakReference

   * Return document accessible for the given DOM node.
  DocAccessible* GetDocAccessible(nsIDocument* aDocument);

   * Return document accessible for the given presshell.
  DocAccessible* GetDocAccessible(const nsIPresShell* aPresShell)
    if (!aPresShell)
      return nullptr;

    DocAccessible* doc = aPresShell->GetDocAccessible();
    if (doc)
      return doc;

    return GetDocAccessible(aPresShell->GetDocument());

   * Search through all document accessibles for an accessible with the given
   * unique id.
  Accessible* FindAccessibleInCache(nsINode* aNode) const;

   * Called by document accessible when it gets shutdown.
  void NotifyOfDocumentShutdown(DocAccessible* aDocument,
                                nsIDocument* aDOMDocument);

   * Return XPCOM accessible document.
  xpcAccessibleDocument* GetXPCDocument(DocAccessible* aDocument);
  xpcAccessibleDocument* GetCachedXPCDocument(DocAccessible* aDocument) const
    { return mXPCDocumentCache.GetWeak(aDocument); }

   * Notification that a top level document in a content process has gone away.
  static void RemoteDocShutdown(DocAccessibleParent* aDoc)
    DebugOnly<bool> result = sRemoteDocuments->RemoveElement(aDoc);
    MOZ_ASSERT(result, "Why didn't we find the document!");

   * Notify of a new top level document in a content process.
  static void RemoteDocAdded(DocAccessibleParent* aDoc);

  static const nsTArray<DocAccessibleParent*>* TopLevelRemoteDocs()
    { return sRemoteDocuments; }

   * Remove the xpc document for a remote document if there is one.
  static void NotifyOfRemoteDocShutdown(DocAccessibleParent* adoc);

   * Get a XPC document for a remote document.
  static xpcAccessibleDocument* GetXPCDocument(DocAccessibleParent* aDoc);
  static xpcAccessibleDocument* GetCachedXPCDocument(const DocAccessibleParent* aDoc)
    return sRemoteXPCDocumentCache ? sRemoteXPCDocumentCache->GetWeak(aDoc)
      : nullptr;

#ifdef DEBUG
  bool IsProcessingRefreshDriverNotification() const;

  virtual ~DocManager() { }

   * Initialize the manager.
  bool Init();

   * Shutdown the manager.
  void Shutdown();

  DocManager(const DocManager&);
  DocManager& operator =(const DocManager&);

   * Create an accessible document if it was't created and fire accessibility
   * events if needed.
   * @param  aDocument       [in] loaded DOM document
   * @param  aLoadEventType  [in] specifies the event type to fire load event,
   *                           if 0 then no event is fired
  void HandleDOMDocumentLoad(nsIDocument* aDocument,
                             uint32_t aLoadEventType);

   * Add/remove 'pagehide' and 'DOMContentLoaded' event listeners.
  void AddListeners(nsIDocument *aDocument, bool aAddPageShowListener);
  void RemoveListeners(nsIDocument* aDocument);

   * Create document or root accessible.
  DocAccessible* CreateDocOrRootAccessible(nsIDocument* aDocument);

   * Clear the cache and shutdown the document accessibles.
  void ClearDocCache();

  typedef nsRefPtrHashtable<nsPtrHashKey<const nsIDocument>, DocAccessible>
  DocAccessibleHashtable mDocAccessibleCache;

  typedef nsRefPtrHashtable<nsPtrHashKey<const DocAccessible>, xpcAccessibleDocument>
  XPCDocumentHashtable mXPCDocumentCache;
  static nsRefPtrHashtable<nsPtrHashKey<const DocAccessibleParent>, xpcAccessibleDocument>*

   * The list of remote top level documents.
  static StaticAutoPtr<nsTArray<DocAccessibleParent*>> sRemoteDocuments;

 * Return the existing document accessible for the document if any.
 * Note this returns the doc accessible for the primary pres shell if there is
 * more than one.
inline DocAccessible*
GetExistingDocAccessible(const nsIDocument* aDocument)
  nsIPresShell* ps = aDocument->GetShell();
  return ps ? ps->GetDocAccessible() : nullptr;

} // namespace a11y
} // namespace mozilla

#endif // mozilla_a11_DocManager_h_