/* -*- 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/. */ #ifndef TabGroup_h #define TabGroup_h #include "nsISupports.h" #include "nsISupportsImpl.h" #include "nsIPrincipal.h" #include "nsTHashtable.h" #include "nsString.h" #include "mozilla/RefPtr.h" namespace mozilla { class ThrottledEventQueue; namespace dom { // Two browsing contexts are considered "related" if they are reachable from one // another through window.opener, window.parent, or window.frames. This is the // spec concept of a "unit of related browsing contexts" // // Two browsing contexts are considered "similar-origin" if they can be made to // have the same origin by setting document.domain. This is the spec concept of // a "unit of similar-origin related browsing contexts" // // A TabGroup is a set of browsing contexts which are all "related". Within a // TabGroup, browsing contexts are broken into "similar-origin" DocGroups. In // more detail, a DocGroup is actually a collection of documents, and a // TabGroup is a collection of DocGroups. A TabGroup typically will contain // (through its DocGroups) the documents from one or more tabs related by // window.opener. A DocGroup is a member of exactly one TabGroup. class DocGroup; class TabGroup final : public nsISupports { private: class HashEntry : public nsCStringHashKey { public: // NOTE: Weak reference. The DocGroup destructor removes itself from its // owning TabGroup. DocGroup* mDocGroup; explicit HashEntry(const nsACString* aKey); }; typedef nsTHashtable<HashEntry> DocGroupMap; public: typedef DocGroupMap::Iterator Iterator; friend class DocGroup; NS_DECL_THREADSAFE_ISUPPORTS static TabGroup* GetChromeTabGroup(); explicit TabGroup(bool aIsChrome = false); // Get the docgroup for the corresponding doc group key. // Returns null if the given key hasn't been seen yet. already_AddRefed<DocGroup> GetDocGroup(const nsACString& aKey); already_AddRefed<DocGroup> AddDocument(const nsACString& aKey, nsIDocument* aDocument); // Join the specified TabGroup, returning a reference to it. If aTabGroup is // nullptr, create a new tabgroup to join. static already_AddRefed<TabGroup> Join(nsPIDOMWindowOuter* aWindow, TabGroup* aTabGroup); void Leave(nsPIDOMWindowOuter* aWindow); Iterator Iter() { return mDocGroups.Iter(); } // Returns the nsIDocShellTreeItem with the given name, searching each of the // docShell trees which are within this TabGroup. It will pass itself as // aRequestor to each docShellTreeItem which it asks to search for the name, // and will not search the docShellTreeItem which is passed as aRequestor. // // This method is used in order to correctly namespace named windows based on // their unit of related browsing contexts. // // It is illegal to pass in the special case-insensitive names "_blank", // "_self", "_parent" or "_top", as those should be handled elsewhere. nsresult FindItemWithName(const nsAString& aName, nsIDocShellTreeItem* aRequestor, nsIDocShellTreeItem* aOriginalRequestor, nsIDocShellTreeItem** aFoundItem); nsTArray<nsPIDOMWindowOuter*> GetTopLevelWindows(); // Get the event queue that associated windows can use to issue runnables to // the main thread. This may return nullptr during browser shutdown. ThrottledEventQueue* GetThrottledEventQueue() const; private: ~TabGroup(); DocGroupMap mDocGroups; nsTArray<nsPIDOMWindowOuter*> mWindows; RefPtr<ThrottledEventQueue> mThrottledEventQueue; }; } // namespace dom } // namespace mozilla #endif // defined(TabGroup_h)