Bug 460926 A11y hierachy is broken on Ubuntu 8.10 (GNOME 2.24), r=Evan.Yan sr=roc
[wine-gecko.git] / uriloader / prefetch / nsPrefetchService.h
blobc634e74e4033ce81e5c9c8dd7ba7428fc21f9671
1 /* ***** BEGIN LICENSE BLOCK *****
2 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 * The contents of this file are subject to the Mozilla Public License Version
5 * 1.1 (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
7 * http://www.mozilla.org/MPL/
9 * Software distributed under the License is distributed on an "AS IS" basis,
10 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
11 * for the specific language governing rights and limitations under the
12 * License.
14 * The Original Code is Mozilla.
16 * The Initial Developer of the Original Code is
17 * Netscape Communications Corporation.
18 * Portions created by the Initial Developer are Copyright (C) 2002
19 * the Initial Developer. All Rights Reserved.
21 * Contributor(s):
22 * Darin Fisher <darin@netscape.com> (original author)
24 * Alternatively, the contents of this file may be used under the terms of
25 * either the GNU General Public License Version 2 or later (the "GPL"), or
26 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 * in which case the provisions of the GPL or the LGPL are applicable instead
28 * of those above. If you wish to allow use of your version of this file only
29 * under the terms of either the GPL or the LGPL, and not to allow others to
30 * use your version of this file under the terms of the MPL, indicate your
31 * decision by deleting the provisions above and replace them with the notice
32 * and other provisions required by the GPL or the LGPL. If you do not delete
33 * the provisions above, a recipient may use your version of this file under
34 * the terms of any one of the MPL, the GPL or the LGPL.
36 * ***** END LICENSE BLOCK ***** */
38 #ifndef nsPrefetchService_h__
39 #define nsPrefetchService_h__
41 #include "nsCPrefetchService.h"
42 #include "nsIGenericFactory.h"
43 #include "nsIObserver.h"
44 #include "nsIInterfaceRequestor.h"
45 #include "nsIChannelEventSink.h"
46 #include "nsIWebProgressListener.h"
47 #include "nsIStreamListener.h"
48 #include "nsIChannel.h"
49 #include "nsIURI.h"
50 #include "nsIDOMDocument.h"
51 #include "nsIDOMLoadStatus.h"
52 #include "nsWeakReference.h"
53 #include "nsCOMPtr.h"
54 #include "nsAutoPtr.h"
56 class nsPrefetchService;
57 class nsPrefetchListener;
58 class nsPrefetchNode;
60 //-----------------------------------------------------------------------------
61 // nsPrefetchService
62 //-----------------------------------------------------------------------------
64 class nsPrefetchService : public nsIPrefetchService
65 , public nsIWebProgressListener
66 , public nsIObserver
67 , public nsSupportsWeakReference
69 public:
70 NS_DECL_ISUPPORTS
71 NS_DECL_NSIPREFETCHSERVICE
72 NS_DECL_NSIWEBPROGRESSLISTENER
73 NS_DECL_NSIOBSERVER
75 nsPrefetchService();
77 nsresult Init();
78 void ProcessNextURI();
80 nsPrefetchNode *GetCurrentNode() { return mCurrentNode.get(); }
81 nsPrefetchNode *GetQueueHead() { return mQueueHead; }
83 void NotifyLoadRequested(nsPrefetchNode *node);
84 void NotifyLoadCompleted(nsPrefetchNode *node);
86 private:
87 ~nsPrefetchService();
89 nsresult Prefetch(nsIURI *aURI,
90 nsIURI *aReferrerURI,
91 nsIDOMNode *aSource,
92 PRBool aExplicit);
94 void AddProgressListener();
95 void RemoveProgressListener();
96 nsresult EnqueueURI(nsIURI *aURI, nsIURI *aReferrerURI,
97 nsIDOMNode *aSource, nsPrefetchNode **node);
98 nsresult EnqueueNode(nsPrefetchNode *node);
99 nsresult DequeueNode(nsPrefetchNode **node);
100 void EmptyQueue();
102 void StartPrefetching();
103 void StopPrefetching();
105 nsPrefetchNode *mQueueHead;
106 nsPrefetchNode *mQueueTail;
107 nsRefPtr<nsPrefetchNode> mCurrentNode;
108 PRInt32 mStopCount;
109 // true if pending document loads have ever reached zero.
110 PRInt32 mHaveProcessed;
111 PRBool mDisabled;
114 //-----------------------------------------------------------------------------
115 // nsPrefetchNode
116 //-----------------------------------------------------------------------------
118 class nsPrefetchNode : public nsIDOMLoadStatus
119 , public nsIStreamListener
120 , public nsIInterfaceRequestor
121 , public nsIChannelEventSink
123 public:
124 NS_DECL_ISUPPORTS
125 NS_DECL_NSIDOMLOADSTATUS
126 NS_DECL_NSIREQUESTOBSERVER
127 NS_DECL_NSISTREAMLISTENER
128 NS_DECL_NSIINTERFACEREQUESTOR
129 NS_DECL_NSICHANNELEVENTSINK
131 nsPrefetchNode(nsPrefetchService *aPrefetchService,
132 nsIURI *aURI,
133 nsIURI *aReferrerURI,
134 nsIDOMNode *aSource);
136 ~nsPrefetchNode() {}
138 nsresult OpenChannel();
139 nsresult CancelChannel(nsresult error);
141 nsPrefetchNode *mNext;
142 nsCOMPtr<nsIURI> mURI;
143 nsCOMPtr<nsIURI> mReferrerURI;
144 nsCOMPtr<nsIWeakReference> mSource;
146 private:
147 nsRefPtr<nsPrefetchService> mService;
148 nsCOMPtr<nsIChannel> mChannel;
149 PRUint16 mState;
150 PRInt32 mBytesRead;
153 #endif // !nsPrefetchService_h__