content/xul/document/public/nsIXULPrototypeCache.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  *   Ben Goodger <ben@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsIXULPrototypeCache_h__
  40 #define nsIXULPrototypeCache_h__
  41
  42 #include "nsISupports.h"
  43 class nsIURI;
  44
  45 // {3A0A0FC1-8349-11d3-BE47-00104BDE6048}
  46 #define NS_XULPROTOTYPECACHE_CID \
  47 { 0x3a0a0fc1, 0x8349, 0x11d3, { 0xbe, 0x47, 0x0, 0x10, 0x4b, 0xde, 0x60, 0x48 } }
  48
  49 // {f8bee3d7-4be8-46ae-92c2-60c25d5cd647}
  50 #define NS_IXULPROTOTYPECACHE_IID \
  51 { 0xf8bee3d7, 0x4be8, 0x46ae, \
  52   { 0x92, 0xc2, 0x60, 0xc2, 0x5d, 0x5c, 0xd6, 0x47 } }
  53
  54 /**
  55  * This interface lets code from outside gklayout access the prototype cache.
  56  */
  57 class nsIXULPrototypeCache : public nsISupports
  58 {
  59 public:
  60     NS_DECLARE_STATIC_IID_ACCESSOR(NS_IXULPROTOTYPECACHE_IID)
  61
  62     /**
  63      * Whether the XUL document at the specified URI is in the cache.
  64      */
  65     virtual PRBool IsCached(nsIURI* aURI) = 0;
  66
  67     /**
  68      * Stop the FastLoad process abruptly, removing the FastLoad file.
  69      */
  70     virtual void AbortFastLoads() = 0;
  71 };
  72
  73 NS_DEFINE_STATIC_IID_ACCESSOR(nsIXULPrototypeCache, NS_IXULPROTOTYPECACHE_IID)
  74
  75 NS_IMETHODIMP
  76 NS_NewXULPrototypeCache(nsISupports* aOuter, REFNSIID aIID, void** aResult);
  77
  78
  79 const char XUL_FASTLOAD_FILE_BASENAME[] = "XUL";
  80
  81 // Increase the subtractor when changing version, say when changing the
  82 // (opaque to XPCOM FastLoad code) format of XUL-specific XDR serializations.
  83 // See also JSXDR_BYTECODE_VERSION in jsxdrapi.h, which tracks incompatible JS
  84 // bytecode version changes.
  85 #define XUL_FASTLOAD_FILE_VERSION       (0xfeedbeef - 25)
  86
  87 #define XUL_SERIALIZATION_BUFFER_SIZE   (64 * 1024)
  88 #define XUL_DESERIALIZATION_BUFFER_SIZE (8 * 1024)
  89
  90
  91 #endif // nsIXULPrototypeCache_h__