1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
/* 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 nsBrowserStatusFilter_h__
#define nsBrowserStatusFilter_h__
#include "nsIWebProgressListener.h"
#include "nsIWebProgressListener2.h"
#include "nsIWebProgress.h"
#include "nsWeakReference.h"
#include "nsCycleCollectionParticipant.h"
#include "nsITimer.h"
#include "nsCOMPtr.h"
#include "nsString.h"
//-----------------------------------------------------------------------------
// nsBrowserStatusFilter - a web progress listener implementation designed to
// sit between nsDocLoader and nsBrowserStatusHandler to filter out and limit
// the frequency of certain events to improve page load performance.
//-----------------------------------------------------------------------------
class nsBrowserStatusFilter : public nsIWebProgress,
public nsIWebProgressListener2,
public nsSupportsWeakReference {
public:
explicit nsBrowserStatusFilter(bool aDisableStateChangeFilters = false);
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(nsBrowserStatusFilter,
nsIWebProgress)
NS_DECL_NSIWEBPROGRESS
NS_DECL_NSIWEBPROGRESSLISTENER
NS_DECL_NSIWEBPROGRESSLISTENER2
protected:
virtual ~nsBrowserStatusFilter();
private:
nsresult StartDelayTimer();
void CallDelayedProgressListeners();
void MaybeSendProgress();
void MaybeSendStatus();
void ResetMembers();
bool DelayInEffect() { return mDelayedStatus || mDelayedProgress; }
static void TimeoutHandler(nsITimer* aTimer, void* aClosure);
private:
nsCOMPtr<nsIWebProgressListener> mListener;
nsCOMPtr<nsIEventTarget> mTarget;
nsCOMPtr<nsITimer> mTimer;
// delayed values
nsString mStatusMsg;
int64_t mCurProgress;
int64_t mMaxProgress;
nsString mCurrentStatusMsg;
int32_t mCurrentPercentage;
bool mStatusIsDirty;
bool mIsLoadingDocument;
// indicates whether a timeout is pending
bool mDelayedStatus;
bool mDelayedProgress;
// If set to `true`, performs no filtering on StateChange notifications.
bool mDisableStateChangeFilters;
};
#define NS_BROWSERSTATUSFILTER_CONTRACTID \
"@mozilla.org/appshell/component/browser-status-filter;1"
#define NS_BROWSERSTATUSFILTER_CID \
{/* 6356aa16-7916-4215-a825-cbc2692ca87a */ \
0x6356aa16, \
0x7916, \
0x4215, \
{0xa8, 0x25, 0xcb, 0xc2, 0x69, 0x2c, 0xa8, 0x7a}}
#endif // !nsBrowserStatusFilter_h__
|
