gfx/thebes/public/gfxPlatform.h

   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) 2005
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Vladimir Vukicevic <vladimir@pobox.com>
  23  *   Masayuki Nakano <masayuki@d-toybox.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * 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 GFX_PLATFORM_H
  40 #define GFX_PLATFORM_H
  41
  42 #include "prtypes.h"
  43 #include "nsVoidArray.h"
  44
  45 #include "nsIObserver.h"
  46
  47 #include "gfxTypes.h"
  48 #include "gfxASurface.h"
  49 #include "gfxColor.h"
  50
  51 #ifdef XP_OS2
  52 #undef OS2EMX_PLAIN_CHAR
  53 #endif
  54
  55 typedef void* cmsHPROFILE;
  56 typedef void* cmsHTRANSFORM;
  57
  58 class gfxImageSurface;
  59 class gfxFont;
  60 class gfxFontGroup;
  61 struct gfxFontStyle;
  62 class gfxUserFontSet;
  63 class gfxFontEntry;
  64 class gfxProxyFontEntry;
  65 class nsIURI;
  66
  67 // pref lang id's for font prefs
  68 // !!! needs to match the list of pref font.default.xx entries listed in all.js !!!
  69
  70 enum eFontPrefLang {
  71     eFontPrefLang_Western     =  0,
  72     eFontPrefLang_CentEuro    =  1,
  73     eFontPrefLang_Japanese    =  2,
  74     eFontPrefLang_ChineseTW   =  3,
  75     eFontPrefLang_ChineseCN   =  4,
  76     eFontPrefLang_ChineseHK   =  5,
  77     eFontPrefLang_Korean      =  6,
  78     eFontPrefLang_Cyrillic    =  7,
  79     eFontPrefLang_Baltic      =  8,
  80     eFontPrefLang_Greek       =  9,
  81     eFontPrefLang_Turkish     = 10,
  82     eFontPrefLang_Thai        = 11,
  83     eFontPrefLang_Hebrew      = 12,
  84     eFontPrefLang_Arabic      = 13,
  85     eFontPrefLang_Devanagari  = 14,
  86     eFontPrefLang_Tamil       = 15,
  87     eFontPrefLang_Armenian    = 16,
  88     eFontPrefLang_Bengali     = 17,
  89     eFontPrefLang_Canadian    = 18,
  90     eFontPrefLang_Ethiopic    = 19,
  91     eFontPrefLang_Georgian    = 20,
  92     eFontPrefLang_Gujarati    = 21,
  93     eFontPrefLang_Gurmukhi    = 22,
  94     eFontPrefLang_Khmer       = 23,
  95     eFontPrefLang_Malayalam   = 24,
  96     eFontPrefLang_Oriya       = 25,
  97     eFontPrefLang_Telugu      = 26,
  98     eFontPrefLang_Kannada     = 27,
  99     eFontPrefLang_Sinhala     = 28,
 100
 101     eFontPrefLang_LangCount   = 29, // except Others and UserDefined.
 102
 103     eFontPrefLang_Others      = 29, // x-unicode
 104     eFontPrefLang_UserDefined = 30,
 105
 106     eFontPrefLang_CJKSet      = 31, // special code for CJK set
 107     eFontPrefLang_AllCount    = 32
 108 };
 109
 110 enum eCMSMode {
 111     eCMSMode_Off          = 0,     // No color management
 112     eCMSMode_All          = 1,     // Color manage everything
 113     eCMSMode_TaggedOnly   = 2,     // Color manage tagged Images Only
 114     eCMSMode_AllCount     = 3
 115 };
 116
 117 // when searching through pref langs, max number of pref langs
 118 const PRUint32 kMaxLenPrefLangList = 32;
 119
 120 class THEBES_API gfxPlatform {
 121 public:
 122     /**
 123      * Return a pointer to the current active platform.
 124      * This is a singleton; it contains mostly convenience
 125      * functions to obtain platform-specific objects.
 126      */
 127     static gfxPlatform *GetPlatform();
 128
 129     /**
 130      * Start up Thebes. This can fail.
 131      */
 132     static nsresult Init();
 133
 134     /**
 135      * Clean up static objects to shut down thebes.
 136      */
 137     static void Shutdown();
 138
 139     /**
 140      * Create an offscreen surface of the given dimensions
 141      * and image format.
 142      */
 143     virtual already_AddRefed<gfxASurface> CreateOffscreenSurface(const gfxIntSize& size,
 144                                                                  gfxASurface::gfxImageFormat imageFormat) = 0;
 145
 146
 147     virtual already_AddRefed<gfxASurface> OptimizeImage(gfxImageSurface *aSurface,
 148                                                         gfxASurface::gfxImageFormat format);
 149
 150     /*
 151      * Font bits
 152      */
 153
 154     /**
 155      * Fill aListOfFonts with the results of querying the list of font names
 156      * that correspond to the given language group or generic font family
 157      * (or both, or neither).
 158      */
 159     virtual nsresult GetFontList(const nsACString& aLangGroup,
 160                                  const nsACString& aGenericFamily,
 161                                  nsStringArray& aListOfFonts);
 162
 163     /**
 164      * Rebuilds the any cached system font lists
 165      */
 166     virtual nsresult UpdateFontList();
 167
 168     /**
 169      * Font name resolver, this returns actual font name(s) by the callback
 170      * function. If the font doesn't exist, the callback function is not called.
 171      * If the callback function returns PR_FALSE, the aAborted value is set to
 172      * PR_TRUE, otherwise, PR_FALSE.
 173      */
 174     typedef PRBool (*FontResolverCallback) (const nsAString& aName,
 175                                             void *aClosure);
 176     virtual nsresult ResolveFontName(const nsAString& aFontName,
 177                                      FontResolverCallback aCallback,
 178                                      void *aClosure,
 179                                      PRBool& aAborted) = 0;
 180
 181     /**
 182      * Resolving a font name to family name. The result MUST be in the result of GetFontList().
 183      * If the name doesn't in the system, aFamilyName will be empty string, but not failed.
 184      */
 185     virtual nsresult GetStandardFamilyName(const nsAString& aFontName, nsAString& aFamilyName) = 0;
 186
 187     /**
 188      * Create the appropriate platform font group
 189      */
 190     virtual gfxFontGroup *CreateFontGroup(const nsAString& aFamilies,
 191                                           const gfxFontStyle *aStyle,
 192                                           gfxUserFontSet *aUserFontSet) = 0;
 193
 194
 195     /**
 196      * Look up a local platform font using the full font face name.
 197      * (Needed to support @font-face src local().)
 198      * Ownership of the returned gfxFontEntry is passed to the caller,
 199      * who must either AddRef() or delete.
 200      */
 201     virtual gfxFontEntry* LookupLocalFont(const nsAString& aFontName) { return nsnull; }
 202
 203     /**
 204      * Activate a platform font.  (Needed to support @font-face src url().)
 205      * aFontData must persist as long as a reference is held to aLoader.
 206      * Ownership of the returned gfxFontEntry is passed to the caller,
 207      * who must either AddRef() or delete.
 208      */
 209     virtual gfxFontEntry* MakePlatformFont(const gfxProxyFontEntry *aProxyEntry,
 210                                            nsISupports *aLoader,
 211                                            const PRUint8 *aFontData,
 212                                            PRUint32 aLength)
 213     { return nsnull; }
 214
 215     /**
 216      * Whether to allow downloadable fonts via @font-face rules
 217      */
 218     virtual PRBool DownloadableFontsEnabled();
 219
 220     // check whether format is supported on a platform or not (if unclear, returns true)
 221     virtual PRBool IsFontFormatSupported(nsIURI *aFontURI, PRUint32 aFormatFlags) { return PR_FALSE; }
 222
 223     void GetPrefFonts(const char *aLangGroup, nsString& array, PRBool aAppendUnicode = PR_TRUE);
 224
 225     /**
 226      * Iterate over pref fonts given a list of lang groups.  For a single lang
 227      * group, multiple pref fonts are possible.  If error occurs, returns PR_FALSE,
 228      * PR_TRUE otherwise.  Callback returns PR_FALSE to abort process.
 229      */
 230     typedef PRBool (*PrefFontCallback) (eFontPrefLang aLang, const nsAString& aName,
 231                                         void *aClosure);
 232     static PRBool ForEachPrefFont(eFontPrefLang aLangArray[], PRUint32 aLangArrayLen,
 233                                   PrefFontCallback aCallback,
 234                                   void *aClosure);
 235
 236     // convert a lang group string to enum constant (i.e. "zh-TW" ==> eFontPrefLang_ChineseTW)
 237     static eFontPrefLang GetFontPrefLangFor(const char* aLang);
 238
 239     // convert a enum constant to lang group string (i.e. eFontPrefLang_ChineseTW ==> "zh-TW")
 240     static const char* GetPrefLangName(eFontPrefLang aLang);
 241
 242     // returns true if a pref lang is CJK
 243     static PRBool IsLangCJK(eFontPrefLang aLang);
 244
 245     // helper method to add a pref lang to an array, if not already in array
 246     static void AppendPrefLang(eFontPrefLang aPrefLangs[], PRUint32& aLen, eFontPrefLang aAddLang);
 247
 248     /**
 249      * Are we going to try color management?
 250      */
 251     static eCMSMode GetCMSMode();
 252
 253     /**
 254      * Determines the rendering intent for color management.
 255      *
 256      * If the value in the pref gfx.color_management.rendering_intent is a
 257      * valid rendering intent as defined in modules/lcms/include/lcms.h, that
 258      * value is returned. Otherwise, -1 is returned and the embedded intent
 259      * should be used.
 260      *
 261      * See bug 444014 for details.
 262      */
 263     static int GetRenderingIntent();
 264
 265     /**
 266      * Convert a pixel using a cms transform in an endian-aware manner.
 267      *
 268      * Sets 'out' to 'in' if transform is NULL.
 269      */
 270     static void TransformPixel(const gfxRGBA& in, gfxRGBA& out, cmsHTRANSFORM transform);
 271
 272     /**
 273      * Return the output device ICC profile.
 274      */
 275     static cmsHPROFILE GetCMSOutputProfile();
 276
 277     /**
 278      * Return the sRGB ICC profile.
 279      */
 280     static cmsHPROFILE GetCMSsRGBProfile();
 281
 282     /**
 283      * Return sRGB -> output device transform.
 284      */
 285     static cmsHTRANSFORM GetCMSRGBTransform();
 286
 287     /**
 288      * Return output -> sRGB device transform.
 289      */
 290     static cmsHTRANSFORM GetCMSInverseRGBTransform();
 291
 292     /**
 293      * Return sRGBA -> output device transform.
 294      */
 295     static cmsHTRANSFORM GetCMSRGBATransform();
 296
 297 protected:
 298     gfxPlatform() { }
 299     virtual ~gfxPlatform();
 300
 301 private:
 302     virtual cmsHPROFILE GetPlatformCMSOutputProfile();
 303
 304     nsCOMPtr<nsIObserver> overrideObserver;
 305 };
 306
 307 #endif /* GFX_PLATFORM_H */