diff -r 000000000000 -r 6474c204b198 accessible/src/base/DocManager.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/accessible/src/base/DocManager.h Wed Dec 31 06:09:35 2014 +0100 @@ -0,0 +1,165 @@ +/* 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/. */ + +#ifndef mozilla_a11_DocManager_h_ +#define mozilla_a11_DocManager_h_ + +#include "nsIDocument.h" +#include "nsIDOMEventListener.h" +#include "nsRefPtrHashtable.h" +#include "nsIWebProgressListener.h" +#include "nsWeakReference.h" +#include "nsIPresShell.h" + +namespace mozilla { +namespace a11y { + +class Accessible; +class DocAccessible; + +/** + * Manage the document accessible life cycle. + */ +class DocManager : public nsIWebProgressListener, + public nsIDOMEventListener, + public nsSupportsWeakReference +{ +public: + virtual ~DocManager() { } + + NS_DECL_THREADSAFE_ISUPPORTS + NS_DECL_NSIWEBPROGRESSLISTENER + NS_DECL_NSIDOMEVENTLISTENER + + /** + * 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. + */ + inline void NotifyOfDocumentShutdown(nsIDocument* aDocument) + { + mDocAccessibleCache.Remove(aDocument); + RemoveListeners(aDocument); + } + +#ifdef DEBUG + bool IsProcessingRefreshDriverNotification() const; +#endif + +protected: + DocManager(); + + /** + * Initialize the manager. + */ + bool Init(); + + /** + * Shutdown the manager. + */ + void Shutdown(); + +private: + DocManager(const DocManager&); + DocManager& operator =(const DocManager&); + +private: + /** + * 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); + + typedef nsRefPtrHashtable, DocAccessible> + DocAccessibleHashtable; + + /** + * Get first entry of the document accessible from cache. + */ + static PLDHashOperator + GetFirstEntryInDocCache(const nsIDocument* aKey, + DocAccessible* aDocAccessible, + void* aUserArg); + + /** + * Clear the cache and shutdown the document accessibles. + */ + void ClearDocCache(); + + struct nsSearchAccessibleInCacheArg + { + Accessible* mAccessible; + nsINode* mNode; + }; + + static PLDHashOperator + SearchAccessibleInDocCache(const nsIDocument* aKey, + DocAccessible* aDocAccessible, + void* aUserArg); + +#ifdef DEBUG + static PLDHashOperator + SearchIfDocIsRefreshing(const nsIDocument* aKey, + DocAccessible* aDocAccessible, void* aUserArg); +#endif + + DocAccessibleHashtable mDocAccessibleCache; +}; + +/** + * 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_