466 lines
14 KiB
C++
466 lines
14 KiB
C++
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=2 sw=2 et tw=80: */
|
|
/* ***** BEGIN LICENSE BLOCK *****
|
|
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
*
|
|
* The contents of this file are subject to the Mozilla Public License Version
|
|
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
* the License. You may obtain a copy of the License at
|
|
* http://www.mozilla.org/MPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
* for the specific language governing rights and limitations under the
|
|
* License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is
|
|
* Netscape Communications Corporation.
|
|
* Portions created by the Initial Developer are Copyright (C) 1998
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*
|
|
* Alternatively, the contents of this file may be used under the terms of
|
|
* either of the GNU General Public License Version 2 or later (the "GPL"),
|
|
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
* of those above. If you wish to allow use of your version of this file only
|
|
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
* use your version of this file under the terms of the MPL, indicate your
|
|
* decision by deleting the provisions above and replace them with the notice
|
|
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
* the provisions above, a recipient may use your version of this file under
|
|
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
*
|
|
* ***** END LICENSE BLOCK ***** */
|
|
|
|
|
|
#ifndef nsPIDOMWindow_h__
|
|
#define nsPIDOMWindow_h__
|
|
|
|
#include "nsISupports.h"
|
|
#include "nsIDOMLocation.h"
|
|
#include "nsIDOMXULCommandDispatcher.h"
|
|
#include "nsIDOMElement.h"
|
|
#include "nsIDOMWindowInternal.h"
|
|
#include "nsIChromeEventHandler.h"
|
|
#include "nsIDOMDocument.h"
|
|
#include "nsIURI.h"
|
|
#include "nsCOMPtr.h"
|
|
|
|
class nsIPrincipal;
|
|
|
|
// 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
|
|
openAbused, // it's a popup. disallow it, but allow domain override.
|
|
openOverridden // disallow window open
|
|
};
|
|
|
|
// permissible values for GetOpenAllow
|
|
enum OpenAllowValue {
|
|
allowNot = 0, // the window opening is denied
|
|
allowNoAbuse, // allowed: not a popup
|
|
allowWhitelisted // allowed: it's whitelisted or popup blocking is disabled
|
|
};
|
|
|
|
class nsIDocShell;
|
|
class nsIFocusController;
|
|
class nsIDocument;
|
|
struct nsTimeout;
|
|
|
|
#define NS_PIDOMWINDOW_IID \
|
|
{ 0x55f987bc, 0xca30, 0x494c, \
|
|
{ 0xa9, 0x85, 0xf1, 0xf3, 0x4b, 0x9d, 0x47, 0xd8 } }
|
|
|
|
class nsPIDOMWindow : public nsIDOMWindowInternal
|
|
{
|
|
public:
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(NS_PIDOMWINDOW_IID)
|
|
|
|
virtual nsPIDOMWindow* GetPrivateRoot() = 0;
|
|
|
|
virtual nsresult GetObjectProperty(const PRUnichar* aProperty,
|
|
nsISupports** aObject) = 0;
|
|
|
|
// This is private because activate/deactivate events are not part
|
|
// of the DOM spec.
|
|
virtual nsresult Activate() = 0;
|
|
virtual nsresult Deactivate() = 0;
|
|
|
|
nsIChromeEventHandler* GetChromeEventHandler() const
|
|
{
|
|
return mChromeEventHandler;
|
|
}
|
|
|
|
PRBool HasMutationListeners(PRUint32 aMutationEventType) const
|
|
{
|
|
const nsPIDOMWindow *win;
|
|
|
|
if (IsOuterWindow()) {
|
|
win = GetCurrentInnerWindow();
|
|
|
|
if (!win) {
|
|
NS_ERROR("No current inner window available!");
|
|
|
|
return PR_FALSE;
|
|
}
|
|
} else {
|
|
if (!mOuterWindow) {
|
|
NS_ERROR("HasMutationListeners() called on orphan inner window!");
|
|
|
|
return PR_FALSE;
|
|
}
|
|
|
|
win = this;
|
|
}
|
|
|
|
return (win->mMutationBits & aMutationEventType) != 0;
|
|
}
|
|
|
|
void SetMutationListeners(PRUint32 aType)
|
|
{
|
|
nsPIDOMWindow *win;
|
|
|
|
if (IsOuterWindow()) {
|
|
win = GetCurrentInnerWindow();
|
|
|
|
if (!win) {
|
|
NS_ERROR("No inner window available to set mutation bits on!");
|
|
|
|
return;
|
|
}
|
|
} else {
|
|
if (!mOuterWindow) {
|
|
NS_ERROR("HasMutationListeners() called on orphan inner window!");
|
|
|
|
return;
|
|
}
|
|
|
|
win = this;
|
|
}
|
|
|
|
win->mMutationBits |= aType;
|
|
}
|
|
|
|
virtual nsIFocusController* GetRootFocusController() = 0;
|
|
|
|
// GetExtantDocument provides a backdoor to the DOM GetDocument accessor
|
|
nsIDOMDocument* GetExtantDocument() const
|
|
{
|
|
return mDocument;
|
|
}
|
|
|
|
// 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.
|
|
nsIDOMElement* GetFrameElementInternal() const
|
|
{
|
|
if (mOuterWindow) {
|
|
return mOuterWindow->GetFrameElementInternal();
|
|
}
|
|
|
|
NS_ASSERTION(!IsInnerWindow(),
|
|
"GetFrameElementInternal() called on orphan inner window");
|
|
|
|
return mFrameElement;
|
|
}
|
|
|
|
// Caller must release the old frame element and addref the new one.
|
|
void SetFrameElementInternal(nsIDOMElement *aFrameElement)
|
|
{
|
|
if (IsOuterWindow()) {
|
|
mFrameElement = aFrameElement;
|
|
|
|
return;
|
|
}
|
|
|
|
if (!mOuterWindow) {
|
|
NS_ERROR("frameElement set on inner window with no outer!");
|
|
|
|
return;
|
|
}
|
|
|
|
mOuterWindow->SetFrameElementInternal(aFrameElement);
|
|
}
|
|
|
|
PRBool IsLoadingOrRunningTimeout() const
|
|
{
|
|
const nsPIDOMWindow *win = GetCurrentInnerWindow();
|
|
|
|
if (!win) {
|
|
win = this;
|
|
}
|
|
|
|
return !win->mIsDocumentLoaded || win->mRunningTimeout;
|
|
}
|
|
|
|
// Check whether a document is currently loading
|
|
PRBool IsLoading() const
|
|
{
|
|
const nsPIDOMWindow *win;
|
|
|
|
if (IsOuterWindow()) {
|
|
win = GetCurrentInnerWindow();
|
|
|
|
if (!win) {
|
|
NS_ERROR("No current inner window available!");
|
|
|
|
return PR_FALSE;
|
|
}
|
|
} else {
|
|
if (!mOuterWindow) {
|
|
NS_ERROR("IsLoading() called on orphan inner window!");
|
|
|
|
return PR_FALSE;
|
|
}
|
|
|
|
win = this;
|
|
}
|
|
|
|
return !win->mIsDocumentLoaded;
|
|
}
|
|
|
|
PRBool IsHandlingResizeEvent() const
|
|
{
|
|
const nsPIDOMWindow *win;
|
|
|
|
if (IsOuterWindow()) {
|
|
win = GetCurrentInnerWindow();
|
|
|
|
if (!win) {
|
|
NS_ERROR("No current inner window available!");
|
|
|
|
return PR_FALSE;
|
|
}
|
|
} else {
|
|
if (!mOuterWindow) {
|
|
NS_ERROR("IsHandlingResizeEvent() called on orphan inner window!");
|
|
|
|
return PR_FALSE;
|
|
}
|
|
|
|
win = this;
|
|
}
|
|
|
|
return win->mIsHandlingResizeEvent;
|
|
}
|
|
|
|
// DO NOT USE THIS FUNCTION. IT DOES NOTHING. USE
|
|
// SetOpenerScriptPrincipal INSTEAD.
|
|
virtual void SetOpenerScriptURL(nsIURI* aURI) = 0;
|
|
|
|
virtual PopupControlState PushPopupControlState(PopupControlState aState,
|
|
PRBool aForce) const = 0;
|
|
virtual void PopPopupControlState(PopupControlState state) const = 0;
|
|
virtual PopupControlState GetPopupControlState() const = 0;
|
|
|
|
// GetOpenAllow must not be called on a window that no longer has a docshell
|
|
// This function is deprecated. It will assume that there is no existing
|
|
// window with name aName for purposes of its answer. Expect this function
|
|
// to get removed soon!
|
|
virtual OpenAllowValue GetOpenAllow(const nsAString &aName) = 0;
|
|
|
|
// Returns an object containing the window's state. This also suspends
|
|
// all running timeouts in the window.
|
|
virtual nsresult SaveWindowState(nsISupports **aState) = 0;
|
|
|
|
// Restore the window state from aState.
|
|
virtual nsresult RestoreWindowState(nsISupports *aState) = 0;
|
|
|
|
// Resume suspended timeouts in this window and in child windows.
|
|
virtual nsresult ResumeTimeouts() = 0;
|
|
|
|
nsPIDOMWindow *GetOuterWindow()
|
|
{
|
|
return mIsInnerWindow ? mOuterWindow : this;
|
|
}
|
|
|
|
nsPIDOMWindow *GetCurrentInnerWindow() const
|
|
{
|
|
return mInnerWindow;
|
|
}
|
|
|
|
PRBool IsInnerWindow() const
|
|
{
|
|
return mIsInnerWindow;
|
|
}
|
|
|
|
PRBool IsOuterWindow() const
|
|
{
|
|
return !IsInnerWindow();
|
|
}
|
|
|
|
virtual PRBool WouldReuseInnerWindow(nsIDocument *aNewDocument) = 0;
|
|
|
|
protected:
|
|
// The nsPIDOMWindow constructor. The aOuterWindow argument should
|
|
// be null if and only if the created window itself is an outer
|
|
// window. In all other cases aOuterWindow should be the outer
|
|
// window for the inner window that is being created.
|
|
nsPIDOMWindow(nsPIDOMWindow *aOuterWindow)
|
|
: mFrameElement(nsnull), mRunningTimeout(nsnull), mMutationBits(0),
|
|
mIsDocumentLoaded(PR_FALSE), mIsHandlingResizeEvent(PR_FALSE),
|
|
mIsInnerWindow(aOuterWindow != nsnull), mInnerWindow(nsnull),
|
|
mOuterWindow(aOuterWindow)
|
|
{
|
|
}
|
|
|
|
// 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<nsIChromeEventHandler> mChromeEventHandler; // strong
|
|
nsCOMPtr<nsIDOMDocument> mDocument; // strong
|
|
|
|
// These members are only used on outer windows.
|
|
nsIDOMElement *mFrameElement; // weak
|
|
|
|
// These variables are only used on inner windows.
|
|
nsTimeout *mRunningTimeout;
|
|
|
|
PRUint32 mMutationBits;
|
|
|
|
PRPackedBool mIsDocumentLoaded;
|
|
PRPackedBool mIsHandlingResizeEvent;
|
|
PRPackedBool mIsInnerWindow;
|
|
|
|
// And these are the references between inner and outer windows.
|
|
nsPIDOMWindow *mInnerWindow;
|
|
nsPIDOMWindow *mOuterWindow;
|
|
};
|
|
|
|
#define NS_PIDOMWINDOW_MOZILLA_1_8_BRANCH_IID \
|
|
{ 0xa9b7f235, 0x4c98, 0x4257, \
|
|
{ 0xb1, 0x1a, 0xbe, 0x53, 0x39, 0x69, 0xdf, 0x2a } }
|
|
|
|
class nsPIDOMWindow_MOZILLA_1_8_BRANCH : public nsPIDOMWindow
|
|
{
|
|
public:
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(NS_PIDOMWINDOW_MOZILLA_1_8_BRANCH_IID)
|
|
|
|
/**
|
|
* 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(nsIDOMWindowInternal *aOpener,
|
|
PRBool aOriginalOpener) = 0;
|
|
|
|
/**
|
|
* Fire any DOM notification events related to things that happened while
|
|
* the window was frozen.
|
|
*/
|
|
virtual nsresult FireDelayedDOMEvents() = 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;
|
|
|
|
protected:
|
|
nsPIDOMWindow_MOZILLA_1_8_BRANCH(nsPIDOMWindow *aOuterWindow)
|
|
: nsPIDOMWindow(aOuterWindow)
|
|
{
|
|
}
|
|
};
|
|
|
|
#define NS_PIDOMWINDOW_MOZILLA_1_8_BRANCH2_IID \
|
|
{ 0xddd4affd, 0x6ad4, 0x44b4, \
|
|
{ 0xa8, 0xfc, 0x78, 0x1d, 0xbd, 0xf1, 0x87, 0x1d } }
|
|
|
|
class nsPIDOMWindow_MOZILLA_1_8_BRANCH2 : public nsPIDOMWindow_MOZILLA_1_8_BRANCH
|
|
{
|
|
public:
|
|
NS_DEFINE_STATIC_IID_ACCESSOR(NS_PIDOMWINDOW_MOZILLA_1_8_BRANCH2_IID)
|
|
|
|
// Tell this window who opened it. This only has an effect if there is
|
|
// either no document currently in the window or if the document is the
|
|
// original document this window came with (an about:blank document either
|
|
// preloaded into it when it was created, or created by
|
|
// CreateAboutBlankContentViewer()).
|
|
virtual void SetOpenerScriptPrincipal(nsIPrincipal* aPrincipal) = 0;
|
|
// Ask this window who opened it.
|
|
virtual nsIPrincipal* GetOpenerScriptPrincipal() = 0;
|
|
|
|
protected:
|
|
nsPIDOMWindow_MOZILLA_1_8_BRANCH2(nsPIDOMWindow *aOuterWindow)
|
|
: nsPIDOMWindow_MOZILLA_1_8_BRANCH(aOuterWindow)
|
|
{
|
|
}
|
|
};
|
|
|
|
#ifdef _IMPL_NS_LAYOUT
|
|
PopupControlState
|
|
PushPopupControlState(PopupControlState aState, PRBool aForce);
|
|
|
|
void
|
|
PopPopupControlState(PopupControlState aState);
|
|
|
|
#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 _IMPL_NS_LAYOUT
|
|
NS_AUTO_POPUP_STATE_PUSHER(PopupControlState aState, PRBool aForce = PR_FALSE)
|
|
: mOldState(::PushPopupControlState(aState, aForce))
|
|
{
|
|
}
|
|
|
|
~NS_AUTO_POPUP_STATE_PUSHER()
|
|
{
|
|
PopPopupControlState(mOldState);
|
|
}
|
|
#else
|
|
NS_AUTO_POPUP_STATE_PUSHER(nsPIDOMWindow *aWindow, PopupControlState aState)
|
|
: mWindow(aWindow), mOldState(openAbused)
|
|
{
|
|
if (aWindow) {
|
|
mOldState = aWindow->PushPopupControlState(aState, PR_FALSE);
|
|
}
|
|
}
|
|
|
|
~NS_AUTO_POPUP_STATE_PUSHER()
|
|
{
|
|
if (mWindow) {
|
|
mWindow->PopPopupControlState(mOldState);
|
|
}
|
|
}
|
|
#endif
|
|
|
|
protected:
|
|
#ifndef _IMPL_NS_LAYOUT
|
|
nsCOMPtr<nsPIDOMWindow> 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 nsnull; }
|
|
static void operator delete(void* /*memory*/) {}
|
|
};
|
|
|
|
#define nsAutoPopupStatePusher NS_AUTO_POPUP_STATE_PUSHER
|
|
|
|
#endif // nsPIDOMWindow_h__
|