layout/style/nsFontFaceLoader.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 // vim:cindent:ts=2:et:sw=2:
   3 /* ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is Mozilla Foundation code.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Mozilla Foundation.
  20  * Portions created by the Initial Developer are Copyright (C) 2008
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   John Daggett <jdaggett@mozilla.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 /* code for loading in @font-face defined font data */
  41
  42 #ifndef nsFontFaceLoader_h_
  43 #define nsFontFaceLoader_h_
  44
  45 #include "nsCOMPtr.h"
  46 #include "nsIStreamLoader.h"
  47 #include "nsIURI.h"
  48 #include "nsIChannel.h"
  49 #include "nsITimer.h"
  50 #include "gfxUserFontSet.h"
  51 #include "nsHashKeys.h"
  52 #include "nsTHashtable.h"
  53
  54 class nsIRequest;
  55 class nsISupports;
  56 class nsPresContext;
  57 class nsIPrincipal;
  58
  59 class nsFontFaceLoader;
  60
  61 // nsUserFontSet - defines the loading mechanism for downloadable fonts
  62 class nsUserFontSet : public gfxUserFontSet
  63 {
  64 public:
  65   nsUserFontSet(nsPresContext *aContext);
  66   ~nsUserFontSet();
  67
  68   // Called when this font set is no longer associated with a presentation.
  69   void Destroy();
  70
  71   // starts loading process, creating and initializing a nsFontFaceLoader obj
  72   // returns whether load process successfully started or not
  73   nsresult StartLoad(gfxFontEntry *aFontToLoad,
  74                      const gfxFontFaceSrc *aFontFaceSrc);
  75
  76   // Called by nsFontFaceLoader when the loader has completed normally.
  77   // It's removed from the mLoaders set.
  78   void RemoveLoader(nsFontFaceLoader *aLoader);
  79
  80   nsPresContext *GetPresContext() { return mPresContext; }
  81
  82 protected:
  83   nsPresContext *mPresContext;  // weak reference
  84
  85   // Set of all loaders pointing to us. These are not strong pointers,
  86   // but that's OK because nsFontFaceLoader always calls RemoveLoader on
  87   // us before it dies (unless we die first).
  88   nsTHashtable< nsPtrHashKey<nsFontFaceLoader> > mLoaders;
  89 };
  90
  91 class nsFontFaceLoader : public nsIStreamLoaderObserver
  92 {
  93 public:
  94
  95   nsFontFaceLoader(gfxFontEntry *aFontToLoad, nsIURI *aFontURI,
  96                    nsUserFontSet *aFontSet, nsIChannel *aChannel);
  97   virtual ~nsFontFaceLoader();
  98
  99   NS_DECL_ISUPPORTS
 100   NS_DECL_NSISTREAMLOADEROBSERVER
 101
 102   // initiate the load
 103   nsresult Init();
 104   // cancel the load and remove its reference to mFontSet
 105   void Cancel();
 106
 107   void DropChannel() { mChannel = nsnull; }
 108
 109   void StartedLoading(nsIStreamLoader *aStreamLoader);
 110
 111   static void LoadTimerCallback(nsITimer *aTimer, void *aClosure);
 112
 113   static nsresult CheckLoadAllowed(nsIPrincipal* aSourcePrincipal,
 114                                    nsIURI* aTargetURI,
 115                                    nsISupports* aContext);
 116
 117 private:
 118   nsRefPtr<gfxFontEntry>  mFontEntry;
 119   nsCOMPtr<nsIURI>        mFontURI;
 120   nsRefPtr<nsUserFontSet> mFontSet;
 121   nsCOMPtr<nsIChannel>    mChannel;
 122   nsCOMPtr<nsITimer>      mLoadTimer;
 123
 124   nsIStreamLoader        *mStreamLoader;
 125 };
 126
 127 #endif /* !defined(nsFontFaceLoader_h_) */