Back to index

lightning-sunbird  0.9+nobinonly
imgRequestProxy.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is mozilla.org code.
00017  *
00018  * The Initial Developer of the Original Code is
00019  * Netscape Communications Corporation.
00020  * Portions created by the Initial Developer are Copyright (C) 2001
00021  * the Initial Developer. All Rights Reserved.
00022  *
00023  * Contributor(s):
00024  *   Stuart Parmenter <pavlov@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either the GNU General Public License Version 2 or later (the "GPL"), or
00028  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "imgIRequest.h"
00041 #include "imgIDecoderObserver.h"
00042 
00043 #include "imgIContainer.h"
00044 #include "imgIDecoder.h"
00045 #include "nsIRequestObserver.h"
00046 #include "nsIChannel.h"
00047 #include "nsILoadGroup.h"
00048 #include "nsISupportsPriority.h"
00049 #include "nsCOMPtr.h"
00050 
00051 #include "imgRequest.h"
00052 
00053 #include "prlock.h"
00054 
00055 #define NS_IMGREQUESTPROXY_CID \
00056 { /* 20557898-1dd2-11b2-8f65-9c462ee2bc95 */         \
00057      0x20557898,                                     \
00058      0x1dd2,                                         \
00059      0x11b2,                                         \
00060     {0x8f, 0x65, 0x9c, 0x46, 0x2e, 0xe2, 0xbc, 0x95} \
00061 }
00062 
00063 class imgRequestProxy : public imgIRequest, public nsISupportsPriority
00064 {
00065 public:
00066   NS_DECL_ISUPPORTS
00067   NS_DECL_IMGIREQUEST
00068   NS_DECL_NSIREQUEST
00069   NS_DECL_NSISUPPORTSPRIORITY
00070 
00071   imgRequestProxy();
00072   virtual ~imgRequestProxy();
00073 
00074   // Callers to Init or ChangeOwner are required to call
00075   // NotifyProxyListener on the request after (although not immediately
00076   // after) doing so.
00077   nsresult Init(imgRequest *request, nsILoadGroup *aLoadGroup, imgIDecoderObserver *aObserver);
00078   nsresult ChangeOwner(imgRequest *aNewOwner); // this will change mOwner.  Do not call this if the previous
00079                                                // owner has already sent notifications out!
00080 
00081   void AddToLoadGroup();
00082   void RemoveFromLoadGroup(PRBool releaseLoadGroup);
00083 
00084 protected:
00085   friend class imgRequest;
00086 
00087   /* non-virtual imgIDecoderObserver methods */
00088   void OnStartDecode   ();
00089   void OnStartContainer(imgIContainer *aContainer);
00090   void OnStartFrame    (gfxIImageFrame *aFrame);
00091   void OnDataAvailable (gfxIImageFrame *aFrame, const nsIntRect * aRect);
00092   void OnStopFrame     (gfxIImageFrame *aFrame);
00093   void OnStopContainer (imgIContainer *aContainer);
00094   void OnStopDecode    (nsresult status, const PRUnichar *statusArg); 
00095 
00096   /* non-virtual imgIContainerObserver methods */
00097   void FrameChanged(imgIContainer *aContainer, gfxIImageFrame *aFrame, nsIntRect * aDirtyRect);
00098 
00099   /* non-virtual nsIRequestObserver (plus some) methods */
00100   void OnStartRequest(nsIRequest *request, nsISupports *ctxt);
00101   void OnStopRequest(nsIRequest *request, nsISupports *ctxt, nsresult statusCode, PRBool aLastPart); 
00102 
00103   inline PRBool HasObserver() const {
00104     return mListener != nsnull;
00105   }
00106   
00107 private:
00108   friend class imgCacheValidator;
00109 
00110   imgRequest *mOwner;
00111 
00112   imgIDecoderObserver* mListener;  // Weak ref; see imgILoader.idl
00113   nsCOMPtr<nsILoadGroup> mLoadGroup;
00114 
00115   nsLoadFlags mLoadFlags;
00116   PRPackedBool mCanceled;
00117   PRPackedBool mIsInLoadGroup;
00118 
00119   PRLock *mLock;
00120 };