зеркало из https://github.com/mozilla/pjs.git
375 строки
14 KiB
C++
375 строки
14 KiB
C++
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
|
|
*
|
|
* 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 the Mozilla browser.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications, Inc. Portions created by Netscape are
|
|
* Copyright (C) 1999, Mozilla. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Travis Bogard <travis@netscape.com>
|
|
*/
|
|
|
|
#ifndef nsDocShell_h__
|
|
#define nsDocShell_h__
|
|
|
|
#include "nsIParser.h" // for nsCharSetSource
|
|
#include "nsIPresShell.h"
|
|
#include "nsIDOMNode.h"
|
|
#include "nsIDOMNodeList.h"
|
|
#include "nsIViewManager.h"
|
|
#include "nsIScrollableView.h"
|
|
#include "nsIContentViewer.h"
|
|
#include "nsIPref.h"
|
|
#include "nsVoidArray.h"
|
|
#include "nsIScriptContext.h"
|
|
|
|
#include "nsCDocShell.h"
|
|
#include "nsIDocShellTreeOwner.h"
|
|
#include "nsIContentViewerContainer.h"
|
|
#include "nsIDeviceContext.h"
|
|
|
|
#include "nsIDocumentLoader.h"
|
|
|
|
#include "nsWeakReference.h"
|
|
|
|
// Local Includes
|
|
#include "nsDSURIContentListener.h"
|
|
|
|
// Helper Classes
|
|
#include "nsCOMPtr.h"
|
|
#include "nsPoint.h" // mCurrent/mDefaultScrollbarPreferences
|
|
#include "nsString.h"
|
|
|
|
// Threshold value in ms for META refresh based redirects
|
|
#define REFRESH_REDIRECT_TIMER 15000
|
|
|
|
// Interfaces Needed
|
|
#include "nsIDocumentCharsetInfo.h"
|
|
#include "nsIDocCharset.h"
|
|
#include "nsIGlobalHistory.h"
|
|
#include "nsIInterfaceRequestor.h"
|
|
#include "nsIInterfaceRequestorUtils.h"
|
|
#include "nsIPrompt.h"
|
|
#include "nsIRefreshURI.h"
|
|
#include "nsIScriptGlobalObject.h"
|
|
#include "nsIScriptGlobalObjectOwner.h"
|
|
#include "nsISHistory.h"
|
|
#include "nsIStringBundle.h"
|
|
#include "nsISupportsArray.h"
|
|
#include "nsITimerCallback.h"
|
|
#include "nsIWebNavigation.h"
|
|
#include "nsIWebProgressListener.h"
|
|
#include "nsISHContainer.h"
|
|
#include "nsIDocShellLoadInfo.h"
|
|
#include "nsIDocShellHistory.h"
|
|
#include "nsIURIFixup.h"
|
|
#include "nsIWebBrowserFind.h"
|
|
|
|
#define MAKE_LOAD_TYPE(type, flags) ((type) | ((flags) << 16))
|
|
|
|
/* load commands */
|
|
enum LoadCmd {
|
|
LOAD_CMD_NORMAL = 0x1, // Normal load
|
|
LOAD_CMD_RELOAD = 0x2, // Reload
|
|
LOAD_CMD_HISTORY = 0x4 // Load from history
|
|
};
|
|
|
|
/* load types are legal combinations of load commands and flags */
|
|
enum LoadType {
|
|
LOAD_NORMAL = MAKE_LOAD_TYPE(LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_NONE),
|
|
LOAD_NORMAL_REPLACE = MAKE_LOAD_TYPE(LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_REPLACE_HISTORY),
|
|
LOAD_HISTORY = MAKE_LOAD_TYPE(LOAD_CMD_HISTORY, nsIWebNavigation::LOAD_FLAGS_NONE),
|
|
LOAD_RELOAD_NORMAL = MAKE_LOAD_TYPE(LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_NONE),
|
|
LOAD_RELOAD_BYPASS_CACHE = MAKE_LOAD_TYPE(LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE),
|
|
LOAD_RELOAD_BYPASS_PROXY = MAKE_LOAD_TYPE(LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY),
|
|
LOAD_RELOAD_BYPASS_PROXY_AND_CACHE = MAKE_LOAD_TYPE(LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_BYPASS_CACHE | nsIWebNavigation::LOAD_FLAGS_BYPASS_PROXY),
|
|
LOAD_LINK = MAKE_LOAD_TYPE(LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_IS_LINK),
|
|
LOAD_REFRESH = MAKE_LOAD_TYPE(LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_IS_REFRESH),
|
|
LOAD_RELOAD_CHARSET_CHANGE = MAKE_LOAD_TYPE(LOAD_CMD_RELOAD, nsIWebNavigation::LOAD_FLAGS_CHARSET_CHANGE),
|
|
LOAD_BYPASS_HISTORY = MAKE_LOAD_TYPE(LOAD_CMD_NORMAL, nsIWebNavigation::LOAD_FLAGS_BYPASS_HISTORY)
|
|
};
|
|
|
|
/* internally used ViewMode types */
|
|
enum ViewMode {
|
|
viewNormal = 0x0,
|
|
viewSource = 0x1
|
|
};
|
|
|
|
//*****************************************************************************
|
|
//*** nsRefreshTimer
|
|
//*****************************************************************************
|
|
|
|
class nsRefreshTimer : public nsITimerCallback
|
|
{
|
|
public:
|
|
nsRefreshTimer();
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
// nsITimerCallback interface
|
|
NS_IMETHOD_(void) Notify(nsITimer * timer);
|
|
|
|
nsCOMPtr<nsIDocShell> mDocShell;
|
|
nsCOMPtr<nsIURI> mURI;
|
|
PRBool mRepeat;
|
|
PRInt32 mDelay;
|
|
PRBool mMetaRefresh;
|
|
|
|
protected:
|
|
virtual ~nsRefreshTimer();
|
|
};
|
|
|
|
//*****************************************************************************
|
|
//*** nsDocShellInitInfo
|
|
//*****************************************************************************
|
|
|
|
class nsDocShellInitInfo
|
|
{
|
|
public:
|
|
//nsIGenericWindow Stuff
|
|
PRInt32 x;
|
|
PRInt32 y;
|
|
PRInt32 cx;
|
|
PRInt32 cy;
|
|
};
|
|
|
|
//*****************************************************************************
|
|
//*** nsDocShell
|
|
//*****************************************************************************
|
|
|
|
class nsDocShell : public nsIDocShell,
|
|
public nsIDocShellTreeItem,
|
|
public nsIDocShellTreeNode,
|
|
public nsIDocShellHistory,
|
|
public nsIWebNavigation,
|
|
public nsIBaseWindow,
|
|
public nsIScrollable,
|
|
public nsITextScroll,
|
|
public nsIDocCharset,
|
|
public nsIContentViewerContainer,
|
|
public nsIInterfaceRequestor,
|
|
public nsIScriptGlobalObjectOwner,
|
|
public nsIRefreshURI,
|
|
public nsIWebProgressListener,
|
|
public nsSupportsWeakReference
|
|
{
|
|
friend class nsDSURIContentListener;
|
|
|
|
public:
|
|
// Object Management
|
|
nsDocShell();
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
NS_DECL_NSIDOCSHELL
|
|
NS_DECL_NSIDOCSHELLTREEITEM
|
|
NS_DECL_NSIDOCSHELLTREENODE
|
|
NS_DECL_NSIDOCSHELLHISTORY
|
|
NS_DECL_NSIWEBNAVIGATION
|
|
NS_DECL_NSIBASEWINDOW
|
|
NS_DECL_NSISCROLLABLE
|
|
NS_DECL_NSITEXTSCROLL
|
|
NS_DECL_NSIDOCCHARSET
|
|
NS_DECL_NSIINTERFACEREQUESTOR
|
|
NS_DECL_NSISCRIPTGLOBALOBJECTOWNER
|
|
NS_DECL_NSIWEBPROGRESSLISTENER
|
|
NS_DECL_NSIREFRESHURI
|
|
NS_DECL_NSICONTENTVIEWERCONTAINER
|
|
|
|
nsresult SetLoadCookie(nsISupports * aCookie);
|
|
nsresult GetLoadCookie(nsISupports ** aResult);
|
|
// used when the docshell gets content that's being redirected (so we don't go through
|
|
// our own InternalLoad method) to reset the load type...
|
|
nsresult SetLoadType(PRUint32 aLoadType);
|
|
nsDocShellInfoLoadType ConvertLoadTypeToDocShellLoadInfo(PRUint32 aLoadType);
|
|
PRUint32 ConvertDocShellLoadInfoToLoadType(nsDocShellInfoLoadType aDocShellLoadType);
|
|
|
|
protected:
|
|
// Object Management
|
|
virtual ~nsDocShell();
|
|
NS_IMETHOD DestroyChildren();
|
|
|
|
// Content Viewer Management
|
|
NS_IMETHOD EnsureContentViewer();
|
|
NS_IMETHOD EnsureDeviceContext();
|
|
NS_IMETHOD CreateAboutBlankContentViewer();
|
|
NS_IMETHOD CreateContentViewer(const char * aContentType,
|
|
nsIRequest * request, nsIStreamListener ** aContentHandler);
|
|
NS_IMETHOD NewContentViewerObj(const char * aContentType,
|
|
nsIRequest * request, nsILoadGroup * aLoadGroup,
|
|
nsIStreamListener ** aContentHandler, nsIContentViewer ** aViewer);
|
|
NS_IMETHOD SetupNewViewer(nsIContentViewer * aNewViewer);
|
|
|
|
NS_IMETHOD GetEldestPresContext(nsIPresContext** aPresContext);
|
|
NS_IMETHOD CreateFixupURI(const PRUnichar * aStringURI, nsIURI ** aURI);
|
|
NS_IMETHOD GetCurrentDocumentOwner(nsISupports ** aOwner);
|
|
virtual nsresult DoURILoad(nsIURI * aURI,
|
|
nsIURI * aReferrer,
|
|
nsISupports * aOwner,
|
|
nsURILoadCommand aLoadCmd,
|
|
nsIInputStream * aPostData,
|
|
nsIInputStream * aHeadersData);
|
|
NS_IMETHOD AddHeadersToChannel(nsIInputStream * aHeadersData,
|
|
nsIChannel * aChannel);
|
|
virtual nsresult DoChannelLoad(nsIChannel * aChannel,
|
|
nsURILoadCommand aLoadCmd,
|
|
nsIURILoader * aURILoader);
|
|
NS_IMETHOD ScrollIfAnchor(nsIURI * aURI, PRBool * aWasAnchor);
|
|
NS_IMETHOD OnLoadingSite(nsIChannel * aChannel);
|
|
|
|
NS_IMETHOD OnNewURI(nsIURI * aURI, nsIChannel * aChannel, PRUint32 aLoadType);
|
|
|
|
virtual void SetCurrentURI(nsIURI * aURI);
|
|
virtual void SetReferrerURI(nsIURI * aURI);
|
|
|
|
// Session History
|
|
virtual PRBool ShouldAddToSessionHistory(nsIURI * aURI);
|
|
virtual nsresult AddToSessionHistory(nsIURI * aURI, nsIChannel * aChannel,
|
|
nsISHEntry ** aNewEntry);
|
|
|
|
NS_IMETHOD LoadHistoryEntry(nsISHEntry * aEntry, PRUint32 aLoadType);
|
|
NS_IMETHOD PersistLayoutHistoryState();
|
|
NS_IMETHOD CloneAndReplace(nsISHEntry * srcEntry, PRUint32 aCloneID,
|
|
nsISHEntry * areplaceEntry, nsISHEntry ** destEntry);
|
|
|
|
// Global History
|
|
NS_IMETHOD ShouldAddToGlobalHistory(nsIURI * aURI, PRBool * aShouldAdd);
|
|
NS_IMETHOD AddToGlobalHistory(nsIURI * aURI);
|
|
NS_IMETHOD UpdateCurrentGlobalHistory();
|
|
|
|
// Helper Routines
|
|
nsDocShellInitInfo * InitInfo();
|
|
NS_IMETHOD GetPromptAndStringBundle(nsIPrompt ** aPrompt,
|
|
nsIStringBundle ** aStringBundle);
|
|
NS_IMETHOD GetChildOffset(nsIDOMNode * aChild, nsIDOMNode * aParent,
|
|
PRInt32 * aOffset);
|
|
NS_IMETHOD GetRootScrollableView(nsIScrollableView ** aOutScrollView);
|
|
NS_IMETHOD EnsureContentListener();
|
|
NS_IMETHOD EnsureScriptEnvironment();
|
|
NS_IMETHOD EnsureFind();
|
|
|
|
static inline PRUint32
|
|
PRTimeToSeconds(PRTime t_usec)
|
|
{
|
|
PRTime usec_per_sec;
|
|
PRUint32 t_sec;
|
|
LL_I2L(usec_per_sec, PR_USEC_PER_SEC);
|
|
LL_DIV(t_usec, t_usec, usec_per_sec);
|
|
LL_L2I(t_sec, t_usec);
|
|
return t_sec;
|
|
}
|
|
|
|
|
|
|
|
virtual nsresult FindTarget(const PRUnichar *aTargetName,
|
|
PRBool *aIsNewWindow,
|
|
nsIDocShell **aResult);
|
|
|
|
PRBool IsFrame();
|
|
|
|
// DocShell Focus helpers
|
|
void ForceUpdate(nsIDocShell* aDocShell);
|
|
nsresult FindNextChildDoc(nsIDocShellTreeNode* aNode, PRBool aForward, nsIDocShell** aDocShell);
|
|
PRBool FocusNextChild(nsIBaseWindow * aCurrentFocus, PRBool aForward);
|
|
void MakeSureOfSetFocus(nsIBaseWindow * aCurrentFocus, nsIDocShell* aDocShell = nsnull);
|
|
|
|
//
|
|
// Helper method that is called when a new document (including any
|
|
// sub-documents - ie. frames) has been completely loaded.
|
|
//
|
|
virtual nsresult EndPageLoad(nsIWebProgress * aProgress,
|
|
nsIChannel * aChannel,
|
|
nsresult aResult);
|
|
protected:
|
|
nsString mName;
|
|
nsString mTitle;
|
|
nsVoidArray mChildren;
|
|
nsCOMPtr<nsISupportsArray> mRefreshURIList;
|
|
nsDSURIContentListener * mContentListener;
|
|
nsDocShellInitInfo * mInitInfo;
|
|
nsCOMPtr<nsIContentViewer> mContentViewer;
|
|
nsCOMPtr<nsIDocumentCharsetInfo> mDocumentCharsetInfo;
|
|
nsCOMPtr<nsIDeviceContext> mDeviceContext;
|
|
nsCOMPtr<nsIDocumentLoader>mDocLoader;
|
|
nsCOMPtr<nsIWidget> mParentWidget;
|
|
nsCOMPtr<nsIPref> mPrefs;
|
|
nsCOMPtr<nsIURI> mCurrentURI;
|
|
nsCOMPtr<nsIURI> mReferrerURI;
|
|
nsCOMPtr<nsIScriptGlobalObject> mScriptGlobal;
|
|
nsCOMPtr<nsIScriptContext> mScriptContext;
|
|
nsCOMPtr<nsISHistory> mSessionHistory;
|
|
nsCOMPtr<nsIGlobalHistory> mGlobalHistory;
|
|
nsCOMPtr<nsISupports> mLoadCookie; // the load cookie associated with the window context.
|
|
nsCOMPtr<nsIURIFixup> mURIFixup;
|
|
nsCOMPtr<nsIWebBrowserFind> mFind;
|
|
PRInt32 mMarginWidth;
|
|
PRInt32 mMarginHeight;
|
|
PRInt32 mItemType;
|
|
nsPoint mCurrentScrollbarPref; // this document only
|
|
nsPoint mDefaultScrollbarPref; // persistent across doc loads
|
|
PRUint32 mLoadType;
|
|
|
|
PRBool mAllowSubframes;
|
|
PRPackedBool mAllowPlugins;
|
|
PRPackedBool mAllowJavascript;
|
|
PRPackedBool mAllowMetaRedirects;
|
|
PRPackedBool mAllowImages;
|
|
PRPackedBool mFocusDocFirst;
|
|
|
|
PRUint32 mAppType;
|
|
PRInt32 mChildOffset; // Offset in the parent's child list.
|
|
PRUint32 mBusyFlags;
|
|
PRPackedBool mHasFocus;
|
|
|
|
// Reference to the SHEntry for this docshell until the page is destroyed.
|
|
// Somebody give me better name
|
|
nsCOMPtr<nsISHEntry> mOSHE;
|
|
// Reference to the SHEntry for this docshell until the page is loaded
|
|
// Somebody give me better name
|
|
nsCOMPtr<nsISHEntry> mLSHE;
|
|
|
|
PRBool mFiredUnloadEvent;
|
|
|
|
// this flag is for bug #21358. a docshell may load many urls
|
|
// which don't result in new documents being created (i.e. a new content viewer)
|
|
// we want to make sure we don't call a on load event more than once for a given
|
|
// content viewer.
|
|
PRBool mEODForCurrentDocument;
|
|
PRBool mURIResultedInDocument;
|
|
|
|
// used to keep track of whether user click links should be handle by us
|
|
// or immediately kicked out to an external application. mscott: eventually
|
|
// i'm going to try to fold this up into the uriloader where it belongs but i haven't
|
|
// figured out how to do that yet.
|
|
PRBool mUseExternalProtocolHandler;
|
|
|
|
// Disallow popping up new windows with target=
|
|
PRBool mDisallowPopupWindows;
|
|
|
|
// Validate window targets to prevent frameset spoofing
|
|
PRBool mValidateOrigin;
|
|
|
|
PRBool mIsBeingDestroyed;
|
|
|
|
// WEAK REFERENCES BELOW HERE.
|
|
// Note these are intentionally not addrefd. Doing so will create a cycle.
|
|
// For that reasons don't use nsCOMPtr.
|
|
|
|
nsIDocShellTreeItem * mParent; // Weak Reference
|
|
nsIDocShellTreeOwner * mTreeOwner; // Weak Reference
|
|
nsIChromeEventHandler * mChromeEventHandler; //Weak Reference
|
|
};
|
|
|
|
#endif /* nsDocShell_h__ */
|