Back to index

lightning-sunbird  0.9+nobinonly
nsBrowserStatusFilter.h
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is Mozilla.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Netscape Communications Corporation.
00018  * Portions created by the Initial Developer are Copyright (C) 2002
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *   Darin Fisher <darin@netscape.com>
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsBrowserStatusFilter_h__
00039 #define nsBrowserStatusFilter_h__
00040 
00041 #include "nsIWebProgressListener.h"
00042 #include "nsIWebProgress.h"
00043 #include "nsWeakReference.h"
00044 #include "nsITimer.h"
00045 #include "nsCOMPtr.h"
00046 #include "nsString.h"
00047 
00048 //-----------------------------------------------------------------------------
00049 // nsBrowserStatusFilter - a web progress listener implementation designed to 
00050 // sit between nsDocLoader and nsBrowserStatusHandler to filter out and limit
00051 // the frequency of certain events to improve page load performance.
00052 //-----------------------------------------------------------------------------
00053 
00054 class nsBrowserStatusFilter : public nsIWebProgress
00055                             , public nsIWebProgressListener
00056                             , public nsSupportsWeakReference
00057 {
00058 public:
00059     nsBrowserStatusFilter();
00060     virtual ~nsBrowserStatusFilter();
00061 
00062     NS_DECL_ISUPPORTS
00063     NS_DECL_NSIWEBPROGRESS
00064     NS_DECL_NSIWEBPROGRESSLISTENER
00065 
00066 private:
00067     nsresult StartDelayTimer();
00068     void ProcessTimeout();
00069     PRBool DelayInEffect() { return mDelayedStatus || mDelayedProgress; }
00070 
00071     static void TimeoutHandler(nsITimer *aTimer, void *aClosure);
00072 
00073 private:
00074     nsCOMPtr<nsIWebProgressListener> mListener;
00075     nsCOMPtr<nsITimer>               mTimer;
00076 
00077     // delayed values
00078     nsString                         mStatusMsg;
00079     PRInt32                          mCurProgress;
00080     PRInt32                          mMaxProgress;
00081 
00082     // used to convert OnStart/OnStop notifications into progress notifications
00083     PRInt32                          mTotalRequests;
00084     PRInt32                          mFinishedRequests;
00085     PRPackedBool                     mUseRealProgressFlag;
00086 
00087     // indicates whether a timeout is pending
00088     PRPackedBool                     mDelayedStatus;
00089     PRPackedBool                     mDelayedProgress;
00090 };
00091 
00092 #define NS_BROWSERSTATUSFILTER_CLASSNAME \
00093     "nsBrowserStatusFilter"
00094 #define NS_BROWSERSTATUSFILTER_CONTRACTID \
00095     "@mozilla.org/appshell/component/browser-status-filter;1"
00096 #define NS_BROWSERSTATUSFILTER_CID                   \
00097 { /* 6356aa16-7916-4215-a825-cbc2692ca87a */         \
00098     0x6356aa16,                                      \
00099     0x7916,                                          \
00100     0x4215,                                          \
00101     {0xa8, 0x25, 0xcb, 0xc2, 0x69, 0x2c, 0xa8, 0x7a} \
00102 }
00103 
00104 #endif // !nsBrowserStatusFilter_h__