gfx/thebes/src/gfxTextRunCache.cpp

   1 /* -*- Mode: C++; tab-width: 20; 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 Foundation code.
  16  *
  17  * The Initial Developer of the Original Code is Mozilla Foundation.
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Vladimir Vukicevic <vladimir@pobox.com>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "gfxTextRunCache.h"
  39 #include "gfxTextRunWordCache.h"
  40
  41 #include "nsExpirationTracker.h"
  42
  43 /*
  44  * Cache textruns and expire them after 3*10 seconds of no use
  45  */
  46 class TextRunExpiringCache : public nsExpirationTracker<gfxTextRun,3> {
  47 public:
  48     TextRunExpiringCache()
  49         : nsExpirationTracker<gfxTextRun,3>(10*1000) {}
  50     ~TextRunExpiringCache() {
  51         AgeAllGenerations();
  52     }
  53
  54     // This gets called when the timeout has expired on a gfxTextRun
  55     virtual void NotifyExpired(gfxTextRun *aTextRun) {
  56         RemoveObject(aTextRun);
  57         gfxTextRunWordCache::RemoveTextRun(aTextRun);
  58         delete aTextRun;
  59     }
  60 };
  61
  62 static TextRunExpiringCache *gTextRunCache = nsnull;
  63
  64 gfxTextRun *
  65 gfxTextRunCache::MakeTextRun(const PRUnichar *aText, PRUint32 aLength,
  66                              gfxFontGroup *aFontGroup,
  67                              const gfxTextRunFactory::Parameters* aParams,
  68                              PRUint32 aFlags)
  69 {
  70     if (!gTextRunCache)
  71         return nsnull;
  72     return gfxTextRunWordCache::MakeTextRun(aText, aLength, aFontGroup,
  73         aParams, aFlags);
  74 }
  75
  76 gfxTextRun *
  77 gfxTextRunCache::MakeTextRun(const PRUnichar *aText, PRUint32 aLength,
  78                              gfxFontGroup *aFontGroup,
  79                              gfxContext *aRefContext,
  80                              PRUint32 aAppUnitsPerDevUnit,
  81                              PRUint32 aFlags)
  82 {
  83     if (!gTextRunCache)
  84         return nsnull;
  85     gfxTextRunFactory::Parameters params = {
  86         aRefContext, nsnull, nsnull, nsnull, 0, aAppUnitsPerDevUnit
  87     };
  88     return gfxTextRunWordCache::MakeTextRun(aText, aLength, aFontGroup,
  89         &params, aFlags);
  90 }
  91
  92 gfxTextRun *
  93 gfxTextRunCache::MakeTextRun(const PRUint8 *aText, PRUint32 aLength,
  94                              gfxFontGroup *aFontGroup,
  95                              gfxContext *aRefContext,
  96                              PRUint32 aAppUnitsPerDevUnit,
  97                              PRUint32 aFlags)
  98 {
  99     if (!gTextRunCache)
 100         return nsnull;
 101     gfxTextRunFactory::Parameters params = {
 102         aRefContext, nsnull, nsnull, nsnull, 0, aAppUnitsPerDevUnit
 103     };
 104     return gfxTextRunWordCache::MakeTextRun(aText, aLength, aFontGroup,
 105         &params, aFlags);
 106 }
 107
 108 void
 109 gfxTextRunCache::ReleaseTextRun(gfxTextRun *aTextRun)
 110 {
 111     if (!aTextRun)
 112         return;
 113     if (!(aTextRun->GetFlags() & gfxTextRunWordCache::TEXT_IN_CACHE)) {
 114         delete aTextRun;
 115         return;
 116     }
 117     nsresult rv = gTextRunCache->AddObject(aTextRun);
 118     if (NS_FAILED(rv)) {
 119         delete aTextRun;
 120         return;
 121     }
 122 }
 123
 124 nsresult
 125 gfxTextRunCache::Init()
 126 {
 127     gTextRunCache = new TextRunExpiringCache();
 128     return gTextRunCache ? NS_OK : NS_ERROR_OUT_OF_MEMORY;
 129 }
 130
 131 void
 132 gfxTextRunCache::Shutdown()
 133 {
 134     delete gTextRunCache;
 135     gTextRunCache = nsnull;
 136 }