content/xul/document/src/nsXULPrototypeCache.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Chris Waterson <waterson@netscape.com>
  24  *   Brendan Eich <brendan@mozilla.org>
  25  *   Ben Goodger <ben@netscape.com>
  26  *   Benjamin Smedberg <bsmedberg@covad.net>
  27  *   Mark Hammond <mhammond@skippinet.com.au>
  28  *
  29  * Alternatively, the contents of this file may be used under the terms of
  30  * either of the GNU General Public License Version 2 or later (the "GPL"),
  31  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  32  * in which case the provisions of the GPL or the LGPL are applicable instead
  33  * of those above. If you wish to allow use of your version of this file only
  34  * under the terms of either the GPL or the LGPL, and not to allow others to
  35  * use your version of this file under the terms of the MPL, indicate your
  36  * decision by deleting the provisions above and replace them with the notice
  37  * and other provisions required by the GPL or the LGPL. If you do not delete
  38  * the provisions above, a recipient may use your version of this file under
  39  * the terms of any one of the MPL, the GPL or the LGPL.
  40  *
  41  * ***** END LICENSE BLOCK ***** */
  42
  43 #ifndef nsXULPrototypeCache_h__
  44 #define nsXULPrototypeCache_h__
  45
  46 #include "nsCOMPtr.h"
  47 #include "nsICSSStyleSheet.h"
  48 #include "nsIObserver.h"
  49 #include "nsIXBLDocumentInfo.h"
  50 #include "nsIXULPrototypeCache.h"
  51 #include "nsDataHashtable.h"
  52 #include "nsInterfaceHashtable.h"
  53 #include "nsRefPtrHashtable.h"
  54 #include "nsURIHashKey.h"
  55 #include "nsXULPrototypeDocument.h"
  56
  57 class nsIFastLoadService;
  58
  59 struct CacheScriptEntry
  60 {
  61     PRUint32    mScriptTypeID; // the script language ID.
  62     void*       mScriptObject; // the script object.
  63 };
  64
  65 /**
  66  * The XUL prototype cache can be used to store and retrieve shared data for
  67  * XUL documents, style sheets, XBL, and scripts.
  68  *
  69  * The cache has two levels:
  70  *  1. In-memory hashtables
  71  *  2. The on-disk fastload file.
  72  */
  73 class nsXULPrototypeCache : public nsIXULPrototypeCache,
  74                                    nsIObserver
  75 {
  76 public:
  77     // nsISupports
  78     NS_DECL_ISUPPORTS
  79     NS_DECL_NSIOBSERVER
  80
  81     // nsIXULPrototypeCache
  82     virtual PRBool IsCached(nsIURI* aURI) {
  83         return GetPrototype(aURI) != nsnull;
  84     }
  85     virtual void AbortFastLoads();
  86
  87
  88     /**
  89      * Whether the prototype cache is enabled.
  90      */
  91     PRBool IsEnabled();
  92
  93     /**
  94      * Flush the cache; remove all XUL prototype documents, style
  95      * sheets, and scripts.
  96      */
  97     void Flush();
  98
  99     /**
 100      * Remove a XUL document from the set of loading documents.
 101      */
 102     void RemoveFromFastLoadSet(nsIURI* aDocumentURI);
 103
 104     /**
 105      * Write the XUL prototype document to fastload file. The proto must be
 106      * fully loaded.
 107      */
 108     nsresult WritePrototype(nsXULPrototypeDocument* aPrototypeDocument);
 109
 110     // The following methods are used to put and retrive various items into and
 111     // from the cache.
 112
 113     nsXULPrototypeDocument* GetPrototype(nsIURI* aURI);
 114     nsresult PutPrototype(nsXULPrototypeDocument* aDocument);
 115
 116     void* GetScript(nsIURI* aURI, PRUint32* langID);
 117     nsresult PutScript(nsIURI* aURI, PRUint32 langID, void* aScriptObject);
 118
 119     nsIXBLDocumentInfo* GetXBLDocumentInfo(nsIURI* aURL) {
 120         return mXBLDocTable.GetWeak(aURL);
 121     }
 122     nsresult PutXBLDocumentInfo(nsIXBLDocumentInfo* aDocumentInfo);
 123
 124     /**
 125      * Get a style sheet by URI. If the style sheet is not in the cache,
 126      * returns nsnull.
 127      */
 128     nsICSSStyleSheet* GetStyleSheet(nsIURI* aURI) {
 129         return mStyleSheetTable.GetWeak(aURI);
 130     }
 131
 132     /**
 133      * Store a style sheet in the cache. The key, style sheet's URI is obtained
 134      * from the style sheet itself.
 135      */
 136     nsresult PutStyleSheet(nsICSSStyleSheet* aStyleSheet);
 137
 138
 139     static nsXULPrototypeCache* GetInstance();
 140     static nsIFastLoadService* GetFastLoadService();
 141
 142     static void ReleaseGlobals()
 143     {
 144         NS_IF_RELEASE(sInstance);
 145     }
 146
 147 protected:
 148     friend NS_IMETHODIMP
 149     NS_NewXULPrototypeCache(nsISupports* aOuter, REFNSIID aIID, void** aResult);
 150
 151     nsXULPrototypeCache();
 152     virtual ~nsXULPrototypeCache();
 153
 154     static nsXULPrototypeCache* sInstance;
 155
 156     void FlushScripts();
 157     void FlushSkinFiles();
 158
 159     nsRefPtrHashtable<nsURIHashKey,nsXULPrototypeDocument>  mPrototypeTable; // owns the prototypes
 160     nsInterfaceHashtable<nsURIHashKey,nsICSSStyleSheet>    mStyleSheetTable;
 161     nsDataHashtable<nsURIHashKey,CacheScriptEntry>         mScriptTable;
 162     nsInterfaceHashtable<nsURIHashKey,nsIXBLDocumentInfo>  mXBLDocTable;
 163
 164     ///////////////////////////////////////////////////////////////////////////
 165     // FastLoad
 166     // this is really a hash set, with a dummy data parameter
 167     nsDataHashtable<nsURIHashKey,PRUint32> mFastLoadURITable;
 168
 169     static nsIFastLoadService*    gFastLoadService;
 170     static nsIFile*               gFastLoadFile;
 171
 172     // Bootstrap FastLoad Service
 173     nsresult StartFastLoad(nsIURI* aDocumentURI);
 174     nsresult StartFastLoadingURI(nsIURI* aURI, PRInt32 aDirectionFlags);
 175 };
 176
 177 #endif // nsXULPrototypeCache_h__