Back to index

lightning-sunbird  0.9+nobinonly
imgCache.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 "imgICache.h"
00041 #include "nsIObserver.h"
00042 #include "nsWeakReference.h"
00043 
00044 #include "prtypes.h"
00045 
00046 class imgRequest;
00047 class nsIURI;
00048 class nsICacheEntryDescriptor;
00049 
00050 #define NS_IMGCACHE_CID \
00051 { /* fb4fd28a-1dd1-11b2-8391-e14242c59a41 */         \
00052      0xfb4fd28a,                                     \
00053      0x1dd1,                                         \
00054      0x11b2,                                         \
00055     {0x83, 0x91, 0xe1, 0x42, 0x42, 0xc5, 0x9a, 0x41} \
00056 }
00057 
00058 class imgCache : public imgICache, 
00059                  public nsIObserver,
00060                  public nsSupportsWeakReference
00061 {
00062 public:
00063   NS_DECL_ISUPPORTS
00064   NS_DECL_IMGICACHE
00065   NS_DECL_NSIOBSERVER
00066 
00067   imgCache();
00068   virtual ~imgCache();
00069 
00070   static nsresult Init();
00071 
00072   static void Shutdown(); // for use by the factory
00073 
00074   /* additional members */
00075   static PRBool Put(nsIURI *aKey, imgRequest *request, nsICacheEntryDescriptor **aEntry);
00076   static PRBool Get(nsIURI *aKey, PRBool *aHasExpired, imgRequest **aRequest, nsICacheEntryDescriptor **aEntry);
00077   static PRBool Remove(nsIURI *aKey);
00078 
00079   static nsresult ClearChromeImageCache();
00080   static nsresult ClearImageCache();
00081 };
00082