gecko-dev/dom/base/nsPIDOMWindow.h

1300 строки
40 KiB
C++

/* -*- 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 nsPIDOMWindow_h__
#define nsPIDOMWindow_h__
#include "nsIDOMWindow.h"
#include "mozIDOMWindow.h"
#include "nsCOMPtr.h"
#include "nsTArray.h"
#include "mozilla/dom/EventTarget.h"
#include "mozilla/TaskCategory.h"
#include "js/TypeDecls.h"
#include "nsRefPtrHashtable.h"
// Only fired for inner windows.
#define DOM_WINDOW_DESTROYED_TOPIC "dom-window-destroyed"
#define DOM_WINDOW_FROZEN_TOPIC "dom-window-frozen"
#define DOM_WINDOW_THAWED_TOPIC "dom-window-thawed"
class nsDOMOfflineResourceList;
class nsDOMWindowList;
class nsGlobalWindowInner;
class nsGlobalWindowOuter;
class nsIArray;
class nsIChannel;
class nsIContent;
class nsICSSDeclaration;
class nsIDocShell;
class nsDocShellLoadInfo;
class nsIDocument;
class nsIPrincipal;
class nsIScriptTimeoutHandler;
class nsISerialEventTarget;
class nsIURI;
class nsPIDOMWindowInner;
class nsPIDOMWindowOuter;
class nsPIWindowRoot;
class nsXBLPrototypeHandler;
typedef uint32_t SuspendTypes;
namespace mozilla {
class ThrottledEventQueue;
class AutoplayPermissionManager;
namespace dom {
class AudioContext;
class ClientInfo;
class ClientState;
class ContentFrameMessageManager;
class DocGroup;
class TabGroup;
class Element;
class MozIdleObserver;
class Navigator;
class Performance;
class Selection;
class ServiceWorker;
class ServiceWorkerDescriptor;
class Timeout;
class TimeoutManager;
class CustomElementRegistry;
enum class CallerType : uint32_t;
} // namespace dom
} // namespace mozilla
// Popup control state enum. The values in this enum must go from most
// permissive to least permissive so that it's safe to push state in
// all situations. Pushing popup state onto the stack never makes the
// current popup state less permissive (see
// nsGlobalWindow::PushPopupControlState()).
enum PopupControlState {
openAllowed = 0, // open that window without worries
openControlled, // it's a popup, but allow it
openBlocked, // it's a popup, but not from an allowed event
openAbused, // it's a popup. disallow it, but allow domain override.
openOverridden // disallow window open
};
enum UIStateChangeType
{
UIStateChangeType_NoChange,
UIStateChangeType_Set,
UIStateChangeType_Clear,
UIStateChangeType_Invalid // used for serialization only
};
enum class FullscreenReason
{
// Toggling the fullscreen mode requires trusted context.
ForFullscreenMode,
// Fullscreen API is the API provided to untrusted content.
ForFullscreenAPI,
// This reason can only be used with exiting fullscreen.
// It is otherwise identical to eForFullscreenAPI except it would
// suppress the fullscreen transition.
ForForceExitFullscreen
};
namespace mozilla {
namespace dom {
class Location;
// The states in this enum represent the different possible outcomes which the
// window could be experiencing of loading a document with the
// Large-Allocation header. The NONE case represents the case where no
// Large-Allocation header was set.
enum class LargeAllocStatus : uint8_t
{
// These are the OK states, NONE means that no large allocation status message
// should be printed, while SUCCESS means that the success message should be
// printed.
NONE,
SUCCESS,
// These are the ERROR states. If a window is in one of these states, then the
// next document loaded in that window should have an error message reported
// to it.
NON_GET,
NON_E10S,
NOT_ONLY_TOPLEVEL_IN_TABGROUP,
NON_WIN32
};
} // namespace dom
} // namespace mozilla
// Must be kept in sync with xpcom/rust/xpcom/src/interfaces/nonidl.rs
#define NS_PIDOMWINDOWINNER_IID \
{ 0x775dabc9, 0x8f43, 0x4277, \
{ 0x9a, 0xdb, 0xf1, 0x99, 0x0d, 0x77, 0xcf, 0xfb } }
// Must be kept in sync with xpcom/rust/xpcom/src/interfaces/nonidl.rs
#define NS_PIDOMWINDOWOUTER_IID \
{ 0x769693d4, 0xb009, 0x4fe2, \
{ 0xaf, 0x18, 0x7d, 0xc8, 0xdf, 0x74, 0x96, 0xdf } }
class nsPIDOMWindowInner : public mozIDOMWindow
{
protected:
friend nsGlobalWindowInner;
friend nsGlobalWindowOuter;
explicit nsPIDOMWindowInner(nsPIDOMWindowOuter* aOuterWindow);
~nsPIDOMWindowInner();
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_PIDOMWINDOWINNER_IID)
nsPIDOMWindowInner* AsInner() {
return this;
}
const nsPIDOMWindowInner* AsInner() const {
return this;
}
nsIGlobalObject* AsGlobal();
const nsIGlobalObject* AsGlobal() const;
nsPIDOMWindowOuter* GetOuterWindow() const {
return mOuterWindow;
}
static nsPIDOMWindowInner* From(mozIDOMWindow* aFrom) {
return static_cast<nsPIDOMWindowInner*>(aFrom);
}
// Returns true if this object has an outer window and it is the current inner
// window of that outer.
inline bool IsCurrentInnerWindow() const;
// Returns true if the document of this window is the active document. This
// is not identical to IsCurrentInnerWindow() because document.open() will
// keep the same document active but create a new window.
inline bool HasActiveDocument();
// Returns true if this window is the same as mTopInnerWindow
inline bool IsTopInnerWindow() const;
// Check whether a document is currently loading
inline bool IsLoading() const;
inline bool IsHandlingResizeEvent() const;
bool AddAudioContext(mozilla::dom::AudioContext* aAudioContext);
void RemoveAudioContext(mozilla::dom::AudioContext* aAudioContext);
void MuteAudioContexts();
void UnmuteAudioContexts();
bool GetAudioCaptured() const;
nsresult SetAudioCapture(bool aCapture);
mozilla::dom::Performance* GetPerformance();
void QueuePerformanceNavigationTiming();
bool HasMutationListeners(uint32_t aMutationEventType) const
{
if (!mOuterWindow) {
NS_ERROR("HasMutationListeners() called on orphan inner window!");
return false;
}
return (mMutationBits & aMutationEventType) != 0;
}
void SetMutationListeners(uint32_t aType)
{
if (!mOuterWindow) {
NS_ERROR("HasMutationListeners() called on orphan inner window!");
return;
}
mMutationBits |= aType;
}
/**
* Call this to check whether some node (this window, its document,
* or content in that document) has a mouseenter/leave event listener.
*/
bool HasMouseEnterLeaveEventListeners()
{
return mMayHaveMouseEnterLeaveEventListener;
}
/**
* Call this to indicate that some node (this window, its document,
* or content in that document) has a mouseenter/leave event listener.
*/
void SetHasMouseEnterLeaveEventListeners()
{
mMayHaveMouseEnterLeaveEventListener = true;
}
/**
* Call this to check whether some node (this window, its document,
* or content in that document) has a Pointerenter/leave event listener.
*/
bool HasPointerEnterLeaveEventListeners()
{
return mMayHavePointerEnterLeaveEventListener;
}
/**
* Call this to indicate that some node (this window, its document,
* or content in that document) has a Pointerenter/leave event listener.
*/
void SetHasPointerEnterLeaveEventListeners()
{
mMayHavePointerEnterLeaveEventListener = true;
}
// Sets the event for window.event. Does NOT take ownership, so
// the caller is responsible for clearing the event before the
// event gets deallocated. Pass nullptr to set window.event to
// undefined. Returns the previous value.
mozilla::dom::Event* SetEvent(mozilla::dom::Event* aEvent)
{
mozilla::dom::Event* old = mEvent;
mEvent = aEvent;
return old;
}
/**
* Check whether this window is a secure context.
*/
bool IsSecureContext() const;
bool IsSecureContextIfOpenerIgnored() const;
// Calling suspend should prevent any asynchronous tasks from
// executing javascript for this window. This means setTimeout,
// requestAnimationFrame, and events should not be fired. Suspending
// a window also suspends its children and workers. Workers may
// continue to perform computations in the background. A window
// can have Suspend() called multiple times and will only resume after
// a matching number of Resume() calls.
void Suspend();
void Resume();
// Apply the parent window's suspend, freeze, and modal state to the current
// window.
void SyncStateFromParentWindow();
/**
* Increment active peer connection count.
*/
void AddPeerConnection();
/**
* Decrement active peer connection count.
*/
void RemovePeerConnection();
/**
* Check whether the active peer connection count is non-zero.
*/
bool HasActivePeerConnections();
bool IsPlayingAudio();
bool IsDocumentLoaded() const;
mozilla::dom::TimeoutManager& TimeoutManager();
bool IsRunningTimeout();
// To cache top inner-window if available after constructed for tab-wised
// indexedDB counters.
void TryToCacheTopInnerWindow();
// Increase/Decrease the number of active IndexedDB transactions/databases for
// the decision making of TabGroup scheduling and timeout-throttling.
void UpdateActiveIndexedDBTransactionCount(int32_t aDelta);
void UpdateActiveIndexedDBDatabaseCount(int32_t aDelta);
// Return true if there is any active IndexedDB databases which could block
// timeout-throttling.
bool HasActiveIndexedDBDatabases();
// Increase/Decrease the number of open WebSockets.
void UpdateWebSocketCount(int32_t aDelta);
// Return true if there are any open WebSockets that could block
// timeout-throttling.
bool HasOpenWebSockets() const;
mozilla::Maybe<mozilla::dom::ClientInfo> GetClientInfo() const;
mozilla::Maybe<mozilla::dom::ClientState> GetClientState() const;
mozilla::Maybe<mozilla::dom::ServiceWorkerDescriptor> GetController() const;
void NoteCalledRegisterForServiceWorkerScope(const nsACString& aScope);
void NoteDOMContentLoaded();
mozilla::dom::TabGroup* TabGroup();
virtual nsPIDOMWindowOuter* GetPrivateRoot() = 0;
virtual mozilla::dom::CustomElementRegistry* CustomElements() = 0;
// XXX: This is called on inner windows
virtual nsPIDOMWindowOuter* GetScriptableTop() = 0;
virtual nsPIDOMWindowOuter* GetScriptableParent() = 0;
virtual already_AddRefed<nsPIWindowRoot> GetTopWindowRoot() = 0;
mozilla::dom::EventTarget* GetChromeEventHandler() const
{
return mChromeEventHandler;
}
virtual nsresult RegisterIdleObserver(
mozilla::dom::MozIdleObserver& aIdleObserver) = 0;
virtual nsresult UnregisterIdleObserver(
mozilla::dom::MozIdleObserver& aIdleObserver) = 0;
virtual bool IsTopLevelWindowActive() = 0;
mozilla::dom::EventTarget* GetParentTarget()
{
if (!mParentTarget) {
UpdateParentTarget();
}
return mParentTarget;
}
virtual void MaybeUpdateTouchState() {}
nsIDocument* GetExtantDoc() const
{
return mDoc;
}
nsIURI* GetDocumentURI() const;
nsIURI* GetDocBaseURI() const;
nsIDocument* GetDoc()
{
if (!mDoc) {
MaybeCreateDoc();
}
return mDoc;
}
virtual PopupControlState GetPopupControlState() const = 0;
// Determine if the window is suspended or frozen. Outer windows
// will forward this call to the inner window for convenience. If
// there is no inner window then the outer window is considered
// suspended and frozen by default.
virtual bool IsSuspended() const = 0;
virtual bool IsFrozen() const = 0;
// Fire any DOM notification events related to things that happened while
// the window was frozen.
virtual nsresult FireDelayedDOMEvents() = 0;
/**
* Get the docshell in this window.
*/
inline nsIDocShell *GetDocShell() const;
/**
* Set a new document in the window. Calling this method will in most cases
* create a new inner window. The call will be forewarded to the outer window,
* if the inner window is not the current inner window an
* NS_ERROR_NOT_AVAILABLE error code will be returned. This may be called with
* a pointer to the current document, in that case the document remains
* unchanged, but a new inner window will be created.
*
* aDocument must not be null.
*/
virtual nsresult SetNewDocument(nsIDocument *aDocument,
nsISupports *aState,
bool aForceReuseInnerWindow) = 0;
/**
* Set the opener window. aOriginalOpener is true if and only if this is the
* original opener for the window. That is, it can only be true at most once
* during the life cycle of a window, and then only the first time
* SetOpenerWindow is called. It might never be true, of course, if the
* window does not have an opener when it's created.
*/
virtual void SetOpenerWindow(nsPIDOMWindowOuter* aOpener,
bool aOriginalOpener) = 0;
/**
* Call this to indicate that some node (this window, its document,
* or content in that document) has a paint event listener.
*/
void SetHasPaintEventListeners()
{
mMayHavePaintEventListener = true;
}
/**
* Call this to check whether some node (this window, its document,
* or content in that document) has a paint event listener.
*/
bool HasPaintEventListeners()
{
return mMayHavePaintEventListener;
}
/**
* Call this to indicate that some node (this window, its document,
* or content in that document) has a touch event listener.
*/
void SetHasTouchEventListeners()
{
if (!mMayHaveTouchEventListener) {
mMayHaveTouchEventListener = true;
MaybeUpdateTouchState();
}
}
/**
* Call this to indicate that some node (this window, its document,
* or content in that document) has a selectionchange event listener.
*/
void SetHasSelectionChangeEventListeners()
{
mMayHaveSelectionChangeEventListener = true;
}
/**
* Call this to check whether some node (this window, its document,
* or content in that document) has a selectionchange event listener.
*/
bool HasSelectionChangeEventListeners()
{
return mMayHaveSelectionChangeEventListener;
}
virtual JSObject* GetCachedXBLPrototypeHandler(nsXBLPrototypeHandler* aKey) = 0;
virtual void CacheXBLPrototypeHandler(nsXBLPrototypeHandler* aKey,
JS::Handle<JSObject*> aHandler) = 0;
/*
* Get and set the currently focused element within the document. If
* aNeedsFocus is true, then set mNeedsFocus to true to indicate that a
* document focus event is needed.
*
* DO NOT CALL EITHER OF THESE METHODS DIRECTLY. USE THE FOCUS MANAGER
* INSTEAD.
*/
inline mozilla::dom::Element* GetFocusedElement() const;
virtual void SetFocusedElement(mozilla::dom::Element* aElement,
uint32_t aFocusMethod = 0,
bool aNeedsFocus = false) = 0;
/**
* Retrieves the method that was used to focus the current node.
*/
virtual uint32_t GetFocusMethod() = 0;
/*
* Tells the window that it now has focus or has lost focus, based on the
* state of aFocus. If this method returns true, then the document loaded
* in the window has never received a focus event and expects to receive
* one. If false is returned, the document has received a focus event before
* and should only receive one if the window is being focused.
*
* aFocusMethod may be set to one of the focus method constants in
* nsIFocusManager to indicate how focus was set.
*/
virtual bool TakeFocus(bool aFocus, uint32_t aFocusMethod) = 0;
/**
* Indicates that the window may now accept a document focus event. This
* should be called once a document has been loaded into the window.
*/
virtual void SetReadyForFocus() = 0;
/**
* Whether the focused content within the window should show a focus ring.
*/
virtual bool ShouldShowFocusRing() = 0;
/**
* Indicates that the page in the window has been hidden. This is used to
* reset the focus state.
*/
virtual void PageHidden() = 0;
/**
* Instructs this window to asynchronously dispatch a hashchange event. This
* method must be called on an inner window.
*/
virtual nsresult DispatchAsyncHashchange(nsIURI *aOldURI,
nsIURI *aNewURI) = 0;
/**
* Instructs this window to synchronously dispatch a popState event.
*/
virtual nsresult DispatchSyncPopState() = 0;
/**
* Tell this window that it should listen for sensor changes of the given
* type.
*/
virtual void EnableDeviceSensor(uint32_t aType) = 0;
/**
* Tell this window that it should remove itself from sensor change
* notifications.
*/
virtual void DisableDeviceSensor(uint32_t aType) = 0;
#if defined(MOZ_WIDGET_ANDROID)
virtual void EnableOrientationChangeListener() = 0;
virtual void DisableOrientationChangeListener() = 0;
#endif
/**
* Tell this window that there is an observer for gamepad input
*
* Inner windows only.
*/
virtual void SetHasGamepadEventListener(bool aHasGamepad = true) = 0;
/**
* NOTE! This function *will* be called on multiple threads so the
* implementation must not do any AddRef/Release or other actions that will
* mutate internal state.
*/
virtual uint32_t GetSerial() = 0;
/**
* Return the window id of this window
*/
uint64_t WindowID() const { return mWindowID; }
// WebIDL-ish APIs
void MarkUncollectableForCCGeneration(uint32_t aGeneration)
{
mMarkedCCGeneration = aGeneration;
}
uint32_t GetMarkedCCGeneration()
{
return mMarkedCCGeneration;
}
mozilla::dom::Navigator* Navigator();
virtual mozilla::dom::Location* GetLocation() = 0;
virtual nsresult GetControllers(nsIControllers** aControllers) = 0;
virtual nsDOMWindowList* GetFrames() = 0;
virtual nsresult GetInnerWidth(int32_t* aWidth) = 0;
virtual nsresult GetInnerHeight(int32_t* aHeight) = 0;
virtual already_AddRefed<nsICSSDeclaration>
GetComputedStyle(mozilla::dom::Element& aElt, const nsAString& aPseudoElt,
mozilla::ErrorResult& aError) = 0;
virtual mozilla::dom::Element* GetFrameElement() = 0;
virtual nsDOMOfflineResourceList* GetApplicationCache() = 0;
virtual bool GetFullScreen() = 0;
virtual nsresult Focus() = 0;
virtual nsresult Close() = 0;
mozilla::dom::DocGroup* GetDocGroup() const;
virtual nsISerialEventTarget*
EventTargetFor(mozilla::TaskCategory aCategory) const = 0;
// Returns the AutoplayPermissionManager that documents in this window should
// use to request permission to autoplay.
already_AddRefed<mozilla::AutoplayPermissionManager>
GetAutoplayPermissionManager();
protected:
void CreatePerformanceObjectIfNeeded();
// Lazily instantiate an about:blank document if necessary, and if
// we have what it takes to do so.
void MaybeCreateDoc();
void SetChromeEventHandlerInternal(mozilla::dom::EventTarget* aChromeEventHandler) {
mChromeEventHandler = aChromeEventHandler;
// mParentTarget will be set when the next event is dispatched.
mParentTarget = nullptr;
}
virtual void UpdateParentTarget() = 0;
// These two variables are special in that they're set to the same
// value on both the outer window and the current inner window. Make
// sure you keep them in sync!
nsCOMPtr<mozilla::dom::EventTarget> mChromeEventHandler; // strong
nsCOMPtr<nsIDocument> mDoc; // strong
// Cache the URI when mDoc is cleared.
nsCOMPtr<nsIURI> mDocumentURI; // strong
nsCOMPtr<nsIURI> mDocBaseURI; // strong
nsCOMPtr<mozilla::dom::EventTarget> mParentTarget; // strong
RefPtr<mozilla::dom::Performance> mPerformance;
mozilla::UniquePtr<mozilla::dom::TimeoutManager> mTimeoutManager;
RefPtr<mozilla::dom::Navigator> mNavigator;
// These variables are only used on inner windows.
uint32_t mMutationBits;
uint32_t mActivePeerConnections;
bool mIsDocumentLoaded;
bool mIsHandlingResizeEvent;
bool mMayHavePaintEventListener;
bool mMayHaveTouchEventListener;
bool mMayHaveSelectionChangeEventListener;
bool mMayHaveMouseEnterLeaveEventListener;
bool mMayHavePointerEnterLeaveEventListener;
bool mAudioCaptured;
// Our inner window's outer window.
nsCOMPtr<nsPIDOMWindowOuter> mOuterWindow;
// The element within the document that is currently focused when this
// window is active.
RefPtr<mozilla::dom::Element> mFocusedElement;
// The AudioContexts created for the current document, if any.
nsTArray<mozilla::dom::AudioContext*> mAudioContexts; // Weak
RefPtr<mozilla::dom::TabGroup> mTabGroup;
// A unique (as long as our 64-bit counter doesn't roll over) id for
// this window.
uint64_t mWindowID;
// Set to true once we've sent the (chrome|content)-document-global-created
// notification.
bool mHasNotifiedGlobalCreated;
uint32_t mMarkedCCGeneration;
// mTopInnerWindow is used for tab-wise check by timeout throttling. It could
// be null.
nsCOMPtr<nsPIDOMWindowInner> mTopInnerWindow;
// The evidence that we have tried to cache mTopInnerWindow only once from
// SetNewDocument(). Note: We need this extra flag because mTopInnerWindow
// could be null and we don't want it to be set multiple times.
bool mHasTriedToCacheTopInnerWindow;
// The number of active IndexedDB databases.
uint32_t mNumOfIndexedDBDatabases;
// The number of open WebSockets.
uint32_t mNumOfOpenWebSockets;
// If we're in the process of requesting permission for this window to
// play audible media, or we've already been granted permission by the
// user, this is non-null, and encapsulates the request.
RefPtr<mozilla::AutoplayPermissionManager> mAutoplayPermissionManager;
// The event dispatch code sets and unsets this while keeping
// the event object alive.
mozilla::dom::Event* mEvent;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsPIDOMWindowInner, NS_PIDOMWINDOWINNER_IID)
class nsPIDOMWindowOuter : public mozIDOMWindowProxy
{
protected:
explicit nsPIDOMWindowOuter();
~nsPIDOMWindowOuter();
void RefreshMediaElementsVolume();
void RefreshMediaElementsSuspend(SuspendTypes aSuspend);
bool IsDisposableSuspend(SuspendTypes aSuspend) const;
void MaybeNotifyMediaResumedFromBlock(SuspendTypes aSuspend);
public:
NS_DECLARE_STATIC_IID_ACCESSOR(NS_PIDOMWINDOWOUTER_IID)
nsPIDOMWindowOuter* AsOuter() {
return this;
}
const nsPIDOMWindowOuter* AsOuter() const {
return this;
}
nsPIDOMWindowOuter* GetOuterWindow() const {
return const_cast<nsPIDOMWindowOuter*>(this);
}
static nsPIDOMWindowOuter* From(mozIDOMWindowProxy* aFrom) {
return static_cast<nsPIDOMWindowOuter*>(aFrom);
}
// Given an inner window, return its outer if the inner is the current inner.
// Otherwise (argument null or not an inner or not current) return null.
static nsPIDOMWindowOuter* GetFromCurrentInner(nsPIDOMWindowInner* aInner);
// Check whether a document is currently loading
inline bool IsLoading() const;
inline bool IsHandlingResizeEvent() const;
nsPIDOMWindowInner* GetCurrentInnerWindow() const
{
return mInnerWindow;
}
nsPIDOMWindowInner* EnsureInnerWindow()
{
// GetDoc forces inner window creation if there isn't one already
GetDoc();
return GetCurrentInnerWindow();
}
bool IsRootOuterWindow()
{
return mIsRootOuterWindow;
}
/**
* Set initial keyboard indicator state for accelerators and focus rings.
*/
void SetInitialKeyboardIndicators(UIStateChangeType aShowAccelerators,
UIStateChangeType aShowFocusRings);
// Internal getter/setter for the frame element, this version of the
// getter crosses chrome boundaries whereas the public scriptable
// one doesn't for security reasons.
mozilla::dom::Element* GetFrameElementInternal() const;
void SetFrameElementInternal(mozilla::dom::Element* aFrameElement);
bool IsActive()
{
return mIsActive;
}
void SetDesktopModeViewport(bool aDesktopModeViewport)
{
mDesktopModeViewport = aDesktopModeViewport;
}
bool IsDesktopModeViewport() const
{
return mDesktopModeViewport;
}
bool IsBackground()
{
return mIsBackground;
}
// Audio API
SuspendTypes GetMediaSuspend() const;
void SetMediaSuspend(SuspendTypes aSuspend);
bool GetAudioMuted() const;
void SetAudioMuted(bool aMuted);
float GetAudioVolume() const;
nsresult SetAudioVolume(float aVolume);
void MaybeActiveMediaComponents();
void SetServiceWorkersTestingEnabled(bool aEnabled);
bool GetServiceWorkersTestingEnabled();
float GetDevicePixelRatio(mozilla::dom::CallerType aCallerType);
void SetLargeAllocStatus(mozilla::dom::LargeAllocStatus aStatus);
bool IsTopLevelWindow();
bool HadOriginalOpener() const;
mozilla::dom::TabGroup* TabGroup();
virtual nsPIDOMWindowOuter* GetPrivateRoot() = 0;
virtual void ActivateOrDeactivate(bool aActivate) = 0;
/**
* |top| gets the root of the window hierarchy.
*
* This function does not cross chrome-content boundaries, so if this
* window's parent is of a different type, |top| will return this window.
*
* When script reads the top property, we run GetScriptableTop, which
* will not cross an <iframe mozbrowser> boundary.
*
* In contrast, C++ calls to GetTop are forwarded to GetRealTop, which
* ignores <iframe mozbrowser> boundaries.
*/
virtual already_AddRefed<nsPIDOMWindowOuter> GetTop() = 0; // Outer only
virtual already_AddRefed<nsPIDOMWindowOuter> GetParent() = 0;
virtual nsPIDOMWindowOuter* GetScriptableTop() = 0;
virtual nsPIDOMWindowOuter* GetScriptableParent() = 0;
virtual already_AddRefed<nsPIWindowRoot> GetTopWindowRoot() = 0;
/**
* Behaves identically to GetScriptableParent except that it returns null
* if GetScriptableParent would return this window.
*/
virtual nsPIDOMWindowOuter* GetScriptableParentOrNull() = 0;
virtual bool IsTopLevelWindowActive() = 0;
virtual void SetActive(bool aActive)
{
mIsActive = aActive;
}
virtual void SetIsBackground(bool aIsBackground) = 0;
mozilla::dom::EventTarget* GetChromeEventHandler() const
{
return mChromeEventHandler;
}
virtual void SetChromeEventHandler(mozilla::dom::EventTarget* aChromeEventHandler) = 0;
mozilla::dom::EventTarget* GetParentTarget()
{
if (!mParentTarget) {
UpdateParentTarget();
}
return mParentTarget;
}
mozilla::dom::ContentFrameMessageManager* GetMessageManager()
{
// We maintain our mMessageManager state alongside mParentTarget.
if (!mParentTarget) {
UpdateParentTarget();
}
return mMessageManager;
}
nsIDocument* GetExtantDoc() const
{
return mDoc;
}
nsIURI* GetDocumentURI() const;
nsIDocument* GetDoc()
{
if (!mDoc) {
MaybeCreateDoc();
}
return mDoc;
}
// Set the window up with an about:blank document with the current subject
// principal.
virtual void SetInitialPrincipalToSubject() = 0;
virtual PopupControlState PushPopupControlState(PopupControlState aState,
bool aForce) const = 0;
virtual void PopPopupControlState(PopupControlState state) const = 0;
virtual PopupControlState GetPopupControlState() const = 0;
// Returns an object containing the window's state. This also suspends
// all running timeouts in the window.
virtual already_AddRefed<nsISupports> SaveWindowState() = 0;
// Restore the window state from aState.
virtual nsresult RestoreWindowState(nsISupports *aState) = 0;
// Determine if the window is suspended or frozen. Outer windows
// will forward this call to the inner window for convenience. If
// there is no inner window then the outer window is considered
// suspended and frozen by default.
virtual bool IsSuspended() const = 0;
virtual bool IsFrozen() const = 0;
// Fire any DOM notification events related to things that happened while
// the window was frozen.
virtual nsresult FireDelayedDOMEvents() = 0;
/**
* Get the docshell in this window.
*/
inline nsIDocShell *GetDocShell() const;
/**
* Set a new document in the window. Calling this method will in most cases
* create a new inner window. This may be called with a pointer to the current
* document, in that case the document remains unchanged, but a new inner
* window will be created.
*
* aDocument must not be null.
*/
virtual nsresult SetNewDocument(nsIDocument *aDocument,
nsISupports *aState,
bool aForceReuseInnerWindow) = 0;
/**
* Set the opener window. aOriginalOpener is true if and only if this is the
* original opener for the window. That is, it can only be true at most once
* during the life cycle of a window, and then only the first time
* SetOpenerWindow is called. It might never be true, of course, if the
* window does not have an opener when it's created.
*/
virtual void SetOpenerWindow(nsPIDOMWindowOuter* aOpener,
bool aOriginalOpener) = 0;
/**
* Ensure the size and position of this window are up-to-date by doing
* a layout flush in the parent (which will in turn, do a layout flush
* in its parent, etc.).
*/
virtual void EnsureSizeAndPositionUpToDate() = 0;
/**
* Callback for notifying a window about a modal dialog being
* opened/closed with the window as a parent.
*/
virtual void EnterModalState() = 0;
virtual void LeaveModalState() = 0;
virtual bool CanClose() = 0;
virtual void ForceClose() = 0;
/**
* Moves the top-level window into fullscreen mode if aIsFullScreen is true,
* otherwise exits fullscreen.
*/
virtual nsresult SetFullscreenInternal(
FullscreenReason aReason, bool aIsFullscreen) = 0;
virtual void FullscreenWillChange(bool aIsFullscreen) = 0;
/**
* This function should be called when the fullscreen state is flipped.
* If no widget is involved the fullscreen change, this method is called
* by SetFullscreenInternal, otherwise, it is called when the widget
* finishes its change to or from fullscreen.
*
* @param aIsFullscreen indicates whether the widget is in fullscreen.
*/
virtual void FinishFullscreenChange(bool aIsFullscreen) = 0;
// XXX: These focus methods all forward to the inner, could we change
// consumers to call these on the inner directly?
/*
* Get and set the currently focused element within the document. If
* aNeedsFocus is true, then set mNeedsFocus to true to indicate that a
* document focus event is needed.
*
* DO NOT CALL EITHER OF THESE METHODS DIRECTLY. USE THE FOCUS MANAGER
* INSTEAD.
*/
inline mozilla::dom::Element* GetFocusedElement() const;
virtual void SetFocusedElement(mozilla::dom::Element* aElement,
uint32_t aFocusMethod = 0,
bool aNeedsFocus = false) = 0;
/**
* Retrieves the method that was used to focus the current node.
*/
virtual uint32_t GetFocusMethod() = 0;
/*
* Tells the window that it now has focus or has lost focus, based on the
* state of aFocus. If this method returns true, then the document loaded
* in the window has never received a focus event and expects to receive
* one. If false is returned, the document has received a focus event before
* and should only receive one if the window is being focused.
*
* aFocusMethod may be set to one of the focus method constants in
* nsIFocusManager to indicate how focus was set.
*/
virtual bool TakeFocus(bool aFocus, uint32_t aFocusMethod) = 0;
/**
* Indicates that the window may now accept a document focus event. This
* should be called once a document has been loaded into the window.
*/
virtual void SetReadyForFocus() = 0;
/**
* Whether the focused content within the window should show a focus ring.
*/
virtual bool ShouldShowFocusRing() = 0;
/**
* Set the keyboard indicator state for accelerators and focus rings.
*/
virtual void SetKeyboardIndicators(UIStateChangeType aShowAccelerators,
UIStateChangeType aShowFocusRings) = 0;
/**
* Indicates that the page in the window has been hidden. This is used to
* reset the focus state.
*/
virtual void PageHidden() = 0;
/**
* Set a arguments for this window. This will be set on the window
* right away (if there's an existing document) and it will also be
* installed on the window when the next document is loaded.
*
* This function serves double-duty for passing both |arguments| and
* |dialogArguments| back from nsWindowWatcher to nsGlobalWindow. For the
* latter, the array is an array of length 0 whose only element is a
* DialogArgumentsHolder representing the JS value passed to showModalDialog.
*/
virtual nsresult SetArguments(nsIArray *aArguments) = 0;
/**
* NOTE! This function *will* be called on multiple threads so the
* implementation must not do any AddRef/Release or other actions that will
* mutate internal state.
*/
virtual uint32_t GetSerial() = 0;
/**
* Return the window id of this window
*/
uint64_t WindowID() const { return mWindowID; }
/**
* Dispatch a custom event with name aEventName targeted at this window.
* Returns whether the default action should be performed.
*
* Outer windows only.
*/
virtual bool DispatchCustomEvent(const nsAString& aEventName) = 0;
/**
* Like nsIDOMWindow::Open, except that we don't navigate to the given URL.
*
* Outer windows only.
*/
virtual nsresult
OpenNoNavigate(const nsAString& aUrl, const nsAString& aName,
const nsAString& aOptions, nsPIDOMWindowOuter **_retval) = 0;
/**
* Fire a popup blocked event on the document.
*/
virtual void
FirePopupBlockedEvent(nsIDocument* aDoc,
nsIURI* aPopupURI,
const nsAString& aPopupWindowName,
const nsAString& aPopupWindowFeatures) = 0;
virtual void
NotifyContentBlockingState(unsigned aState,
nsIChannel* aChannel) = 0;
// WebIDL-ish APIs
void MarkUncollectableForCCGeneration(uint32_t aGeneration)
{
mMarkedCCGeneration = aGeneration;
}
uint32_t GetMarkedCCGeneration()
{
return mMarkedCCGeneration;
}
// XXX(nika): These feel like they should be inner window only, but they're
// called on the outer window.
virtual mozilla::dom::Navigator* GetNavigator() = 0;
virtual mozilla::dom::Location* GetLocation() = 0;
virtual nsresult GetPrompter(nsIPrompt** aPrompt) = 0;
virtual nsresult GetControllers(nsIControllers** aControllers) = 0;
virtual already_AddRefed<mozilla::dom::Selection> GetSelection() = 0;
virtual already_AddRefed<nsPIDOMWindowOuter> GetOpener() = 0;
virtual nsDOMWindowList* GetFrames() = 0;
// aLoadInfo will be passed on through to the windowwatcher.
// aForceNoOpener will act just like a "noopener" feature in aOptions except
// will not affect any other window features.
virtual nsresult Open(const nsAString& aUrl, const nsAString& aName,
const nsAString& aOptions,
nsDocShellLoadInfo* aLoadInfo,
bool aForceNoOpener,
nsPIDOMWindowOuter **_retval) = 0;
virtual nsresult OpenDialog(const nsAString& aUrl, const nsAString& aName,
const nsAString& aOptions,
nsISupports* aExtraArgument,
nsPIDOMWindowOuter** _retval) = 0;
virtual nsresult GetInnerWidth(int32_t* aWidth) = 0;
virtual nsresult GetInnerHeight(int32_t* aHeight) = 0;
virtual mozilla::dom::Element* GetFrameElement() = 0;
virtual bool Closed() = 0;
virtual bool GetFullScreen() = 0;
virtual nsresult SetFullScreen(bool aFullScreen) = 0;
virtual nsresult Focus() = 0;
virtual nsresult Close() = 0;
virtual nsresult MoveBy(int32_t aXDif, int32_t aYDif) = 0;
virtual void UpdateCommands(const nsAString& anAction,
mozilla::dom::Selection* aSel,
int16_t aReason) = 0;
mozilla::dom::DocGroup* GetDocGroup() const;
virtual nsISerialEventTarget*
EventTargetFor(mozilla::TaskCategory aCategory) const = 0;
/**
* These methods provide a way to specify the opener value for the content in
* the window before the content itself is created. This is important in order
* to set the DocGroup of a document, as the opener must be set before the
* document is created.
*
* SetOpenerForInitialContentBrowser is used to set which opener will be used,
* and TakeOpenerForInitialContentBrowser is used by nsXULElement in order to
* take the value set earlier, and null out the value in the window.
*/
void SetOpenerForInitialContentBrowser(nsPIDOMWindowOuter* aOpener);
already_AddRefed<nsPIDOMWindowOuter> TakeOpenerForInitialContentBrowser();
protected:
// Lazily instantiate an about:blank document if necessary, and if
// we have what it takes to do so.
void MaybeCreateDoc();
void SetChromeEventHandlerInternal(mozilla::dom::EventTarget* aChromeEventHandler);
virtual void UpdateParentTarget() = 0;
// These two variables are special in that they're set to the same
// value on both the outer window and the current inner window. Make
// sure you keep them in sync!
nsCOMPtr<mozilla::dom::EventTarget> mChromeEventHandler; // strong
nsCOMPtr<nsIDocument> mDoc; // strong
// Cache the URI when mDoc is cleared.
nsCOMPtr<nsIURI> mDocumentURI; // strong
nsCOMPtr<mozilla::dom::EventTarget> mParentTarget; // strong
RefPtr<mozilla::dom::ContentFrameMessageManager> mMessageManager; // strong
nsCOMPtr<mozilla::dom::Element> mFrameElement;
// This reference is used by nsGlobalWindow.
nsCOMPtr<nsIDocShell> mDocShell;
uint32_t mModalStateDepth;
// Tracks activation state that's used for :-moz-window-inactive.
bool mIsActive;
// Tracks whether our docshell is active. If it is, mIsBackground
// is false. Too bad we have so many different concepts of
// "active".
bool mIsBackground;
/**
* The suspended types can be "disposable" or "permanent". This varable only
* stores the value about permanent suspend.
* - disposable
* To pause all playing media in that window, but doesn't affect the media
* which starts after that.
*
* - permanent
* To pause all media in that window, and also affect the media which starts
* after that.
*/
SuspendTypes mMediaSuspend;
bool mAudioMuted;
float mAudioVolume;
// current desktop mode flag.
bool mDesktopModeViewport;
bool mIsRootOuterWindow;
// And these are the references between inner and outer windows.
nsPIDOMWindowInner* MOZ_NON_OWNING_REF mInnerWindow;
RefPtr<mozilla::dom::TabGroup> mTabGroup;
// A unique (as long as our 64-bit counter doesn't roll over) id for
// this window.
uint64_t mWindowID;
uint32_t mMarkedCCGeneration;
// Let the service workers plumbing know that some feature are enabled while
// testing.
bool mServiceWorkersTestingEnabled;
mozilla::dom::LargeAllocStatus mLargeAllocStatus;
nsCOMPtr<nsPIDOMWindowOuter> mOpenerForInitialContentBrowser;
};
NS_DEFINE_STATIC_IID_ACCESSOR(nsPIDOMWindowOuter, NS_PIDOMWINDOWOUTER_IID)
#include "nsPIDOMWindowInlines.h"
#ifdef MOZILLA_INTERNAL_API
#define NS_AUTO_POPUP_STATE_PUSHER nsAutoPopupStatePusherInternal
#else
#define NS_AUTO_POPUP_STATE_PUSHER nsAutoPopupStatePusherExternal
#endif
// Helper class that helps with pushing and popping popup control
// state. Note that this class looks different from within code that's
// part of the layout library than it does in code outside the layout
// library. We give the two object layouts different names so the symbols
// don't conflict, but code should always use the name
// |nsAutoPopupStatePusher|.
class NS_AUTO_POPUP_STATE_PUSHER
{
public:
#ifdef MOZILLA_INTERNAL_API
explicit NS_AUTO_POPUP_STATE_PUSHER(PopupControlState aState, bool aForce = false);
~NS_AUTO_POPUP_STATE_PUSHER();
#else
NS_AUTO_POPUP_STATE_PUSHER(nsPIDOMWindowOuter *aWindow, PopupControlState aState)
: mWindow(aWindow), mOldState(openAbused)
{
if (aWindow) {
mOldState = aWindow->PushPopupControlState(aState, false);
}
}
~NS_AUTO_POPUP_STATE_PUSHER()
{
if (mWindow) {
mWindow->PopPopupControlState(mOldState);
}
}
#endif
protected:
#ifndef MOZILLA_INTERNAL_API
nsCOMPtr<nsPIDOMWindowOuter> mWindow;
#endif
PopupControlState mOldState;
private:
// Hide so that this class can only be stack-allocated
static void* operator new(size_t /*size*/) CPP_THROW_NEW { return nullptr; }
static void operator delete(void* /*memory*/) {}
};
#define nsAutoPopupStatePusher NS_AUTO_POPUP_STATE_PUSHER
#endif // nsPIDOMWindow_h__