content/xbl/src/nsXBLResourceLoader.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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  *   Original Author: David W. Hyatt (hyatt@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 #include "nsCOMPtr.h"
  40 #include "nsICSSLoaderObserver.h"
  41 #include "nsCOMArray.h"
  42 #include "nsCycleCollectionParticipant.h"
  43
  44 class nsIContent;
  45 class nsIAtom;
  46 class nsIDocument;
  47 class nsIScriptContext;
  48 class nsSupportsHashtable;
  49 class nsXBLPrototypeResources;
  50 class nsXBLPrototypeBinding;
  51
  52 // *********************************************************************/
  53 // The XBLResourceLoader class
  54
  55 struct nsXBLResource {
  56   nsXBLResource* mNext;
  57   nsIAtom* mType;
  58   nsString mSrc;
  59
  60   nsXBLResource(nsIAtom* aType, const nsAString& aSrc) {
  61     MOZ_COUNT_CTOR(nsXBLResource);
  62     mNext = nsnull;
  63     mType = aType;
  64     mSrc = aSrc;
  65   }
  66
  67   ~nsXBLResource() {
  68     MOZ_COUNT_DTOR(nsXBLResource);
  69     delete mNext;
  70   }
  71 };
  72
  73 class nsXBLResourceLoader : public nsICSSLoaderObserver
  74 {
  75 public:
  76   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  77   NS_DECL_CYCLE_COLLECTION_CLASS(nsXBLResourceLoader)
  78
  79   // nsICSSLoaderObserver
  80   NS_IMETHOD StyleSheetLoaded(nsICSSStyleSheet* aSheet, PRBool aWasAlternate,
  81                               nsresult aStatus);
  82
  83   void LoadResources(PRBool* aResult);
  84   void AddResource(nsIAtom* aResourceType, const nsAString& aSrc);
  85   void AddResourceListener(nsIContent* aElement);
  86
  87   nsXBLResourceLoader(nsXBLPrototypeBinding* aBinding,
  88                       nsXBLPrototypeResources* aResources);
  89   virtual ~nsXBLResourceLoader();
  90
  91   void NotifyBoundElements();
  92
  93 // MEMBER VARIABLES
  94   nsXBLPrototypeBinding* mBinding; // A pointer back to our binding.
  95   nsXBLPrototypeResources* mResources; // A pointer back to our resources
  96                                        // information.  May be null if the
  97                                        // resources have already been
  98                                        // destroyed.
  99
 100   nsXBLResource* mResourceList; // The list of resources we need to load.
 101   nsXBLResource* mLastResource;
 102
 103   PRPackedBool mLoadingResources;
 104   // We need mInLoadResourcesFunc because we do a mixture of sync and
 105   // async loads.
 106   PRPackedBool mInLoadResourcesFunc;
 107   PRInt16 mPendingSheets; // The number of stylesheets that have yet to load.
 108
 109   // Bound elements that are waiting on the stylesheets and scripts.
 110   nsCOMArray<nsIContent> mBoundElements;
 111 };
 112