Home | History | Annotate | Download | only in core
      1 
      2 /*
      3  * Copyright 2011 Google Inc.
      4  *
      5  * Use of this source code is governed by a BSD-style license that can be
      6  * found in the LICENSE file.
      7  */
      8 
      9 
     10 
     11 #ifndef SkTypefaceCache_DEFINED
     12 #define SkTypefaceCache_DEFINED
     13 
     14 #include "SkTypeface.h"
     15 #include "SkTDArray.h"
     16 
     17 /*  TODO
     18  *  Provide std way to cache name+requestedStyle aliases to the same typeface.
     19  *
     20  *  The current mechanism ends up create a diff typeface for each one, even if
     21  *  they map to the same internal obj (e.g. CTFontRef on the mac)
     22  */
     23 
     24 class SkTypefaceCache {
     25 public:
     26     /**
     27      * Callback for FindByProc. Returns true if the given typeface is a match
     28      * for the given context. The passed typeface is owned by the cache and is
     29      * not additionally ref()ed. The typeface may be in the disposed state.
     30      */
     31     typedef bool (*FindProc)(SkTypeface*, SkTypeface::Style, void* context);
     32 
     33     /**
     34      *  Helper: returns a unique fontID to pass to the constructor of
     35      *  your subclass of SkTypeface
     36      */
     37     static SkFontID NewFontID();
     38 
     39     /**
     40      *  Add a typeface to the cache. This ref()s the typeface, so that the
     41      *  cache is also an owner. Later, if we need to purge the cache, typefaces
     42      *  whose refcnt is 1 (meaning only the cache is an owner) will be
     43      *  unref()ed.
     44      */
     45     static void Add(SkTypeface*,
     46                     SkTypeface::Style requested,
     47                     bool strong = true);
     48 
     49     /**
     50      *  Search the cache for a typeface with the specified fontID (uniqueID).
     51      *  If one is found, return it (its reference count is unmodified). If none
     52      *  is found, return NULL. The reference count is unmodified as it is
     53      *  assumed that the stack will contain a ref to the typeface.
     54      */
     55     static SkTypeface* FindByID(SkFontID fontID);
     56 
     57     /**
     58      *  Iterate through the cache, calling proc(typeface, ctx) with each
     59      *  typeface. If proc returns true, then we return that typeface (this
     60      *  ref()s the typeface). If it never returns true, we return NULL.
     61      */
     62     static SkTypeface* FindByProcAndRef(FindProc proc, void* ctx);
     63 
     64     /**
     65      *  This will unref all of the typefaces in the cache for which the cache
     66      *  is the only owner. Normally this is handled automatically as needed.
     67      *  This function is exposed for clients that explicitly want to purge the
     68      *  cache (e.g. to look for leaks).
     69      */
     70     static void PurgeAll();
     71 
     72     /**
     73      *  Debugging only: dumps the status of the typefaces in the cache
     74      */
     75     static void Dump();
     76 
     77 private:
     78     static SkTypefaceCache& Get();
     79 
     80     void add(SkTypeface*, SkTypeface::Style requested, bool strong = true);
     81     SkTypeface* findByID(SkFontID findID) const;
     82     SkTypeface* findByProcAndRef(FindProc proc, void* ctx) const;
     83     void purge(int count);
     84     void purgeAll();
     85 
     86     struct Rec {
     87         SkTypeface*         fFace;
     88         bool                fStrong;
     89         SkTypeface::Style   fRequestedStyle;
     90     };
     91     SkTDArray<Rec> fArray;
     92 };
     93 
     94 #endif
     95