1 /*
   2  * Copyright (c) 2008, 2014, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package sun.font;
  27 
  28 import java.awt.Font;
  29 import java.io.BufferedReader;
  30 import java.io.File;
  31 import java.io.FileInputStream;
  32 import java.io.InputStreamReader;
  33 import java.lang.ref.SoftReference;
  34 import java.util.concurrent.ConcurrentHashMap;
  35 import java.security.AccessController;
  36 
  37 import java.security.PrivilegedAction;
  38 import javax.swing.plaf.FontUIResource;
  39 
  40 import sun.util.logging.PlatformLogger;
  41 
  42 /**
  43  * A collection of utility methods.
  44  */
  45 public final class FontUtilities {
  46 
  47     public static boolean isSolaris;
  48 
  49     public static boolean isLinux;
  50 
  51     public static boolean isMacOSX;
  52 
  53     public static boolean isAIX;
  54 
  55     public static boolean useJDKScaler;
  56 
  57     public static boolean useT2K;
  58     // useLegacy is a short-term debugging transition aid.
  59     public static boolean useLegacy;
  60 
  61     public static boolean isWindows;
  62 
  63     public static boolean isOpenJDK;
  64 
  65     static final String LUCIDA_FILE_NAME = "LucidaSansRegular.ttf";
  66 
  67     private static boolean debugFonts = false;
  68     private static PlatformLogger logger = null;
  69     private static boolean logging;
  70 
  71     // This static initializer block figures out the OS constants.
  72     static {
  73 
  74         AccessController.doPrivileged(new PrivilegedAction<Object>() {
  75             @SuppressWarnings("deprecation") // PlatformLogger.setLevel is deprecated.
  76             @Override
  77             public Object run() {
  78                 String osName = System.getProperty("os.name", "unknownOS");
  79                 isSolaris = osName.startsWith("SunOS");
  80 
  81                 isLinux = osName.startsWith("Linux");
  82 
  83                 isMacOSX = osName.contains("OS X"); // TODO: MacOSX
  84 
  85                 isAIX = osName.startsWith("AIX");
  86 
  87                 /* Support a value of "t2k" as meaning use the JDK internal
  88                  * scaler over the platform scaler whether or not t2k is
  89                  * actually available.
  90                  * This can be considered transitional support for some
  91                  * level of compatibility, as in it avoids the native scaler
  92                  * as before but cannot guarantee rendering equivalence
  93                  * with T2K.
  94                  * It will also use t2k instead of freetype if t2k is
  95                  * available - this is the same as before.
  96                  * The new value of "jdk" means even if t2k is available,
  97                  * the decision as to whether to use that or freetype is
  98                  * not affected by this setting.
  99                  */
 100                 String scalerStr = System.getProperty("sun.java2d.font.scaler");
 101                 if (scalerStr != null) {
 102                     useT2K = "t2k".equals(scalerStr);
 103                     if (useT2K) {
 104                         System.out.println("WARNING: t2k will be removed in JDK 11.");
 105                     }
 106                     useLegacy = "legacy".equals(scalerStr);
 107                     if (useLegacy) {
 108                         System.out.println("WARNING: legacy behavior will be removed in JDK 11.");
 109                     }
 110                     useJDKScaler = useT2K || "jdk".equals(scalerStr);
 111                 } else {
 112                     useT2K = false;
 113                     useLegacy = false;
 114                     useJDKScaler = false;
 115                 }
 116                 isWindows = osName.startsWith("Windows");
 117                 String jreLibDirName = System.getProperty("java.home", "")
 118                                                       + File.separator + "lib";
 119                 String jreFontDirName =
 120                         jreLibDirName + File.separator + "fonts";
 121                 File lucidaFile = new File(jreFontDirName + File.separator
 122                                            + LUCIDA_FILE_NAME);
 123                 isOpenJDK = !lucidaFile.exists();
 124 
 125                 String debugLevel =
 126                     System.getProperty("sun.java2d.debugfonts");
 127 
 128                 if (debugLevel != null && !debugLevel.equals("false")) {
 129                     debugFonts = true;
 130                     logger = PlatformLogger.getLogger("sun.java2d");
 131                     if (debugLevel.equals("warning")) {
 132                         logger.setLevel(PlatformLogger.Level.WARNING);
 133                     } else if (debugLevel.equals("severe")) {
 134                         logger.setLevel(PlatformLogger.Level.SEVERE);
 135                     }
 136                 }
 137 
 138                 if (debugFonts) {
 139                     logger = PlatformLogger.getLogger("sun.java2d");
 140                     logging = logger.isEnabled();
 141                 }
 142 
 143                 return null;
 144             }
 145         });
 146     }
 147 
 148     /**
 149      * Referenced by code in the JDK which wants to test for the
 150      * minimum char code for which layout may be required.
 151      * Note that even basic latin text can benefit from ligatures,
 152      * eg "ffi" but we presently apply those only if explicitly
 153      * requested with TextAttribute.LIGATURES_ON.
 154      * The value here indicates the lowest char code for which failing
 155      * to invoke layout would prevent acceptable rendering.
 156      */
 157     public static final int MIN_LAYOUT_CHARCODE = 0x0300;
 158 
 159     /**
 160      * Referenced by code in the JDK which wants to test for the
 161      * maximum char code for which layout may be required.
 162      * Note this does not account for supplementary characters
 163      * where the caller interprets 'layout' to mean any case where
 164      * one 'char' (ie the java type char) does not map to one glyph
 165      */
 166     public static final int MAX_LAYOUT_CHARCODE = 0x206F;
 167 
 168     /**
 169      * Calls the private getFont2D() method in java.awt.Font objects.
 170      *
 171      * @param font the font object to call
 172      *
 173      * @return the Font2D object returned by Font.getFont2D()
 174      */
 175     public static Font2D getFont2D(Font font) {
 176         return FontAccess.getFontAccess().getFont2D(font);
 177     }
 178 
 179     /**
 180      * Return true if there any characters which would trigger layout.
 181      * This method considers supplementary characters to be simple,
 182      * since we do not presently invoke layout on any code points in
 183      * outside the BMP.
 184      */
 185     public static boolean isComplexScript(char [] chs, int start, int limit) {
 186 
 187         for (int i = start; i < limit; i++) {
 188             if (chs[i] < MIN_LAYOUT_CHARCODE) {
 189                 continue;
 190             }
 191             else if (isComplexCharCode(chs[i])) {
 192                 return true;
 193             }
 194         }
 195         return false;
 196     }
 197 
 198     /**
 199      * If there is anything in the text which triggers a case
 200      * where char->glyph does not map 1:1 in straightforward
 201      * left->right ordering, then this method returns true.
 202      * Scripts which might require it but are not treated as such
 203      * due to JDK implementations will not return true.
 204      * ie a 'true' return is an indication of the treatment by
 205      * the implementation.
 206      * Whether supplementary characters should be considered is dependent
 207      * on the needs of the caller. Since this method accepts the 'char' type
 208      * then such chars are always represented by a pair. From a rendering
 209      * perspective these will all (in the cases I know of) still be one
 210      * unicode character -> one glyph. But if a caller is using this to
 211      * discover any case where it cannot make naive assumptions about
 212      * the number of chars, and how to index through them, then it may
 213      * need the option to have a 'true' return in such a case.
 214      */
 215     public static boolean isComplexText(char [] chs, int start, int limit) {
 216 
 217         for (int i = start; i < limit; i++) {
 218             if (chs[i] < MIN_LAYOUT_CHARCODE) {
 219                 continue;
 220             }
 221             else if (isNonSimpleChar(chs[i])) {
 222                 return true;
 223             }
 224         }
 225         return false;
 226     }
 227 
 228     /* This is almost the same as the method above, except it takes a
 229      * char which means it may include undecoded surrogate pairs.
 230      * The distinction is made so that code which needs to identify all
 231      * cases in which we do not have a simple mapping from
 232      * char->unicode character->glyph can be identified.
 233      * For example measurement cannot simply sum advances of 'chars',
 234      * the caret in editable text cannot advance one 'char' at a time, etc.
 235      * These callers really are asking for more than whether 'layout'
 236      * needs to be run, they need to know if they can assume 1->1
 237      * char->glyph mapping.
 238      */
 239     public static boolean isNonSimpleChar(char ch) {
 240         return
 241             isComplexCharCode(ch) ||
 242             (ch >= CharToGlyphMapper.HI_SURROGATE_START &&
 243              ch <= CharToGlyphMapper.LO_SURROGATE_END);
 244     }
 245 
 246     /* If the character code falls into any of a number of unicode ranges
 247      * where we know that simple left->right layout mapping chars to glyphs
 248      * 1:1 and accumulating advances is going to produce incorrect results,
 249      * we want to know this so the caller can use a more intelligent layout
 250      * approach. A caller who cares about optimum performance may want to
 251      * check the first case and skip the method call if its in that range.
 252      * Although there's a lot of tests in here, knowing you can skip
 253      * CTL saves a great deal more. The rest of the checks are ordered
 254      * so that rather than checking explicitly if (>= start & <= end)
 255      * which would mean all ranges would need to be checked so be sure
 256      * CTL is not needed, the method returns as soon as it recognises
 257      * the code point is outside of a CTL ranges.
 258      * NOTE: Since this method accepts an 'int' it is asssumed to properly
 259      * represent a CHARACTER. ie it assumes the caller has already
 260      * converted surrogate pairs into supplementary characters, and so
 261      * can handle this case and doesn't need to be told such a case is
 262      * 'complex'.
 263      */
 264     public static boolean isComplexCharCode(int code) {
 265 
 266         if (code < MIN_LAYOUT_CHARCODE || code > MAX_LAYOUT_CHARCODE) {
 267             return false;
 268         }
 269         else if (code <= 0x036f) {
 270             // Trigger layout for combining diacriticals 0x0300->0x036f
 271             return true;
 272         }
 273         else if (code < 0x0590) {
 274             // No automatic layout for Greek, Cyrillic, Armenian.
 275              return false;
 276         }
 277         else if (code <= 0x06ff) {
 278             // Hebrew 0590 - 05ff
 279             // Arabic 0600 - 06ff
 280             return true;
 281         }
 282         else if (code < 0x0900) {
 283             return false; // Syriac and Thaana
 284         }
 285         else if (code <= 0x0e7f) {
 286             // if Indic, assume shaping for conjuncts, reordering:
 287             // 0900 - 097F Devanagari
 288             // 0980 - 09FF Bengali
 289             // 0A00 - 0A7F Gurmukhi
 290             // 0A80 - 0AFF Gujarati
 291             // 0B00 - 0B7F Oriya
 292             // 0B80 - 0BFF Tamil
 293             // 0C00 - 0C7F Telugu
 294             // 0C80 - 0CFF Kannada
 295             // 0D00 - 0D7F Malayalam
 296             // 0D80 - 0DFF Sinhala
 297             // 0E00 - 0E7F if Thai, assume shaping for vowel, tone marks
 298             return true;
 299         }
 300         else if (code <  0x0f00) {
 301             return false;
 302         }
 303         else if (code <= 0x0fff) { // U+0F00 - U+0FFF Tibetan
 304             return true;
 305         }
 306         else if (code < 0x1100) {
 307             return false;
 308         }
 309         else if (code < 0x11ff) { // U+1100 - U+11FF Old Hangul
 310             return true;
 311         }
 312         else if (code < 0x1780) {
 313             return false;
 314         }
 315         else if (code <= 0x17ff) { // 1780 - 17FF Khmer
 316             return true;
 317         }
 318         else if (code < 0x200c) {
 319             return false;
 320         }
 321         else if (code <= 0x200d) { //  zwj or zwnj
 322             return true;
 323         }
 324         else if (code >= 0x202a && code <= 0x202e) { // directional control
 325             return true;
 326         }
 327         else if (code >= 0x206a && code <= 0x206f) { // directional control
 328             return true;
 329         }
 330         return false;
 331     }
 332 
 333     public static PlatformLogger getLogger() {
 334         return logger;
 335     }
 336 
 337     public static boolean isLogging() {
 338         return logging;
 339     }
 340 
 341     public static boolean debugFonts() {
 342         return debugFonts;
 343     }
 344 
 345 
 346     // The following methods are used by Swing.
 347 
 348     /* Revise the implementation to in fact mean "font is a composite font.
 349      * This ensures that Swing components will always benefit from the
 350      * fall back fonts
 351      */
 352     public static boolean fontSupportsDefaultEncoding(Font font) {
 353         return getFont2D(font) instanceof CompositeFont;
 354     }
 355 
 356     /**
 357      * This method is provided for internal and exclusive use by Swing.
 358      *
 359      * It may be used in conjunction with fontSupportsDefaultEncoding(Font)
 360      * In the event that a desktop properties font doesn't directly
 361      * support the default encoding, (ie because the host OS supports
 362      * adding support for the current locale automatically for native apps),
 363      * then Swing calls this method to get a font which  uses the specified
 364      * font for the code points it covers, but also supports this locale
 365      * just as the standard composite fonts do.
 366      * Note: this will over-ride any setting where an application
 367      * specifies it prefers locale specific composite fonts.
 368      * The logic for this, is that this method is used only where the user or
 369      * application has specified that the native L&F be used, and that
 370      * we should honour that request to use the same font as native apps use.
 371      *
 372      * The behaviour of this method is to construct a new composite
 373      * Font object that uses the specified physical font as its first
 374      * component, and adds all the components of "dialog" as fall back
 375      * components.
 376      * The method currently assumes that only the size and style attributes
 377      * are set on the specified font. It doesn't copy the font transform or
 378      * other attributes because they aren't set on a font created from
 379      * the desktop. This will need to be fixed if use is broadened.
 380      *
 381      * Operations such as Font.deriveFont will work properly on the
 382      * font returned by this method for deriving a different point size.
 383      * Additionally it tries to support a different style by calling
 384      * getNewComposite() below. That also supports replacing slot zero
 385      * with a different physical font but that is expected to be "rare".
 386      * Deriving with a different style is needed because its been shown
 387      * that some applications try to do this for Swing FontUIResources.
 388      * Also operations such as new Font(font.getFontName(..), Font.PLAIN, 14);
 389      * will NOT yield the same result, as the new underlying CompositeFont
 390      * cannot be "looked up" in the font registry.
 391      * This returns a FontUIResource as that is the Font sub-class needed
 392      * by Swing.
 393      * Suggested usage is something like :
 394      * FontUIResource fuir;
 395      * Font desktopFont = getDesktopFont(..);
 396      * if (FontManager.fontSupportsDefaultEncoding(desktopFont)) {
 397      *   fuir = new FontUIResource(desktopFont);
 398      * } else {
 399      *   fuir = FontManager.getCompositeFontUIResource(desktopFont);
 400      * }
 401      * return fuir;
 402      */
 403     private static volatile
 404         SoftReference<ConcurrentHashMap<PhysicalFont, CompositeFont>>
 405         compMapRef = new SoftReference<>(null);
 406 
 407     public static FontUIResource getCompositeFontUIResource(Font font) {
 408 
 409         FontUIResource fuir = new FontUIResource(font);
 410         Font2D font2D = FontUtilities.getFont2D(font);
 411 
 412         if (!(font2D instanceof PhysicalFont)) {
 413             /* Swing should only be calling this when a font is obtained
 414              * from desktop properties, so should generally be a physical font,
 415              * an exception might be for names like "MS Serif" which are
 416              * automatically mapped to "Serif", so there's no need to do
 417              * anything special in that case. But note that suggested usage
 418              * is first to call fontSupportsDefaultEncoding(Font) and this
 419              * method should not be called if that were to return true.
 420              */
 421              return fuir;
 422         }
 423 
 424         FontManager fm = FontManagerFactory.getInstance();
 425         Font2D dialog = fm.findFont2D("dialog", font.getStyle(), FontManager.NO_FALLBACK);
 426         // Should never be null, but MACOSX fonts are not CompositeFonts
 427         if (dialog == null || !(dialog instanceof CompositeFont)) {
 428             return fuir;
 429         }
 430         CompositeFont dialog2D = (CompositeFont)dialog;
 431         PhysicalFont physicalFont = (PhysicalFont)font2D;
 432         ConcurrentHashMap<PhysicalFont, CompositeFont> compMap = compMapRef.get();
 433         if (compMap == null) { // Its been collected.
 434             compMap = new ConcurrentHashMap<PhysicalFont, CompositeFont>();
 435             compMapRef = new SoftReference<>(compMap);
 436         }
 437         CompositeFont compFont = compMap.get(physicalFont);
 438         if (compFont == null) {
 439             compFont = new CompositeFont(physicalFont, dialog2D);
 440             compMap.put(physicalFont, compFont);
 441         }
 442         FontAccess.getFontAccess().setFont2D(fuir, compFont.handle);
 443         /* marking this as a created font is needed as only created fonts
 444          * copy their creator's handles.
 445          */
 446         FontAccess.getFontAccess().setCreatedFont(fuir);
 447         return fuir;
 448     }
 449 
 450    /* A small "map" from GTK/fontconfig names to the equivalent JDK
 451     * logical font name.
 452     */
 453     private static final String[][] nameMap = {
 454         {"sans",       "sansserif"},
 455         {"sans-serif", "sansserif"},
 456         {"serif",      "serif"},
 457         {"monospace",  "monospaced"}
 458     };
 459 
 460     public static String mapFcName(String name) {
 461         for (int i = 0; i < nameMap.length; i++) {
 462             if (name.equals(nameMap[i][0])) {
 463                 return nameMap[i][1];
 464             }
 465         }
 466         return null;
 467     }
 468 
 469 
 470     /* This is called by Swing passing in a fontconfig family name
 471      * such as "sans". In return Swing gets a FontUIResource instance
 472      * that has queried fontconfig to resolve the font(s) used for this.
 473      * Fontconfig will if asked return a list of fonts to give the largest
 474      * possible code point coverage.
 475      * For now we use only the first font returned by fontconfig, and
 476      * back it up with the most closely matching JDK logical font.
 477      * Essentially this means pre-pending what we return now with fontconfig's
 478      * preferred physical font. This could lead to some duplication in cases,
 479      * if we already included that font later. We probably should remove such
 480      * duplicates, but it is not a significant problem. It can be addressed
 481      * later as part of creating a Composite which uses more of the
 482      * same fonts as fontconfig. At that time we also should pay more
 483      * attention to the special rendering instructions fontconfig returns,
 484      * such as whether we should prefer embedded bitmaps over antialiasing.
 485      * There's no way to express that via a Font at present.
 486      */
 487     public static FontUIResource getFontConfigFUIR(String fcFamily,
 488                                                    int style, int size) {
 489 
 490         String mapped = mapFcName(fcFamily);
 491         if (mapped == null) {
 492             mapped = "sansserif";
 493         }
 494 
 495         FontUIResource fuir;
 496         FontManager fm = FontManagerFactory.getInstance();
 497         if (fm instanceof SunFontManager) {
 498             SunFontManager sfm = (SunFontManager) fm;
 499             fuir = sfm.getFontConfigFUIR(mapped, style, size);
 500         } else {
 501             fuir = new FontUIResource(mapped, style, size);
 502         }
 503         return fuir;
 504     }
 505 
 506 
 507     /**
 508      * Used by windows printing to assess if a font is likely to
 509      * be layout compatible with JDK
 510      * TrueType fonts should be, but if they have no GPOS table,
 511      * but do have a GSUB table, then they are probably older
 512      * fonts GDI handles differently.
 513      */
 514     public static boolean textLayoutIsCompatible(Font font) {
 515 
 516         Font2D font2D = getFont2D(font);
 517         if (font2D instanceof TrueTypeFont) {
 518             TrueTypeFont ttf = (TrueTypeFont) font2D;
 519             return
 520                 ttf.getDirectoryEntry(TrueTypeFont.GSUBTag) == null ||
 521                 ttf.getDirectoryEntry(TrueTypeFont.GPOSTag) != null;
 522         } else {
 523             return false;
 524         }
 525     }
 526 
 527 }