| /* |
| * Copyright (C) 2006 The Android Open Source Project |
| * |
| * Licensed under the Apache License, Version 2.0 (the "License"); |
| * you may not use this file except in compliance with the License. |
| * You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, software |
| * distributed under the License is distributed on an "AS IS" BASIS, |
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| * See the License for the specific language governing permissions and |
| * limitations under the License. |
| */ |
| |
| package android.graphics; |
| |
| import android.annotation.IntDef; |
| import android.annotation.NonNull; |
| import android.content.res.AssetManager; |
| import android.graphics.fonts.FontRequest; |
| import android.graphics.fonts.FontResult; |
| import android.os.Bundle; |
| import android.os.Handler; |
| import android.os.ParcelFileDescriptor; |
| import android.os.ResultReceiver; |
| import android.provider.FontsContract; |
| import android.text.FontConfig; |
| import android.util.Log; |
| import android.util.LongSparseArray; |
| import android.util.LruCache; |
| import android.util.SparseArray; |
| |
| import com.android.internal.annotations.GuardedBy; |
| |
| import libcore.io.IoUtils; |
| |
| import org.xmlpull.v1.XmlPullParserException; |
| |
| import java.io.File; |
| import java.io.FileInputStream; |
| import java.io.FileNotFoundException; |
| import java.io.IOException; |
| import java.lang.annotation.Retention; |
| import java.lang.annotation.RetentionPolicy; |
| import java.nio.ByteBuffer; |
| import java.nio.channels.FileChannel; |
| import java.util.ArrayList; |
| import java.util.HashMap; |
| import java.util.List; |
| import java.util.Map; |
| |
| /** |
| * The Typeface class specifies the typeface and intrinsic style of a font. |
| * This is used in the paint, along with optionally Paint settings like |
| * textSize, textSkewX, textScaleX to specify |
| * how text appears when drawn (and measured). |
| */ |
| public class Typeface { |
| |
| private static String TAG = "Typeface"; |
| |
| /** The default NORMAL typeface object */ |
| public static final Typeface DEFAULT; |
| /** |
| * The default BOLD typeface object. Note: this may be not actually be |
| * bold, depending on what fonts are installed. Call getStyle() to know |
| * for sure. |
| */ |
| public static final Typeface DEFAULT_BOLD; |
| /** The NORMAL style of the default sans serif typeface. */ |
| public static final Typeface SANS_SERIF; |
| /** The NORMAL style of the default serif typeface. */ |
| public static final Typeface SERIF; |
| /** The NORMAL style of the default monospace typeface. */ |
| public static final Typeface MONOSPACE; |
| |
| static Typeface[] sDefaults; |
| private static final LongSparseArray<SparseArray<Typeface>> sTypefaceCache = |
| new LongSparseArray<>(3); |
| @GuardedBy("sLock") |
| private static FontsContract sFontsContract; |
| @GuardedBy("sLock") |
| private static Handler mHandler; |
| |
| /** |
| * Cache for Typeface objects dynamically loaded from assets. Currently max size is 16. |
| */ |
| private static final LruCache<String, Typeface> sDynamicTypefaceCache = new LruCache<>(16); |
| |
| static Typeface sDefaultTypeface; |
| static Map<String, Typeface> sSystemFontMap; |
| static FontFamily[] sFallbackFonts; |
| private static final Object sLock = new Object(); |
| |
| static final String FONTS_CONFIG = "fonts.xml"; |
| |
| /** |
| * @hide |
| */ |
| public long native_instance; |
| |
| // Style |
| public static final int NORMAL = 0; |
| public static final int BOLD = 1; |
| public static final int ITALIC = 2; |
| public static final int BOLD_ITALIC = 3; |
| |
| private int mStyle = 0; |
| |
| private static void setDefault(Typeface t) { |
| sDefaultTypeface = t; |
| nativeSetDefault(t.native_instance); |
| } |
| |
| /** Returns the typeface's intrinsic style attributes */ |
| public int getStyle() { |
| return mStyle; |
| } |
| |
| /** Returns true if getStyle() has the BOLD bit set. */ |
| public final boolean isBold() { |
| return (mStyle & BOLD) != 0; |
| } |
| |
| /** Returns true if getStyle() has the ITALIC bit set. */ |
| public final boolean isItalic() { |
| return (mStyle & ITALIC) != 0; |
| } |
| |
| /** |
| * @hide |
| * Used by Resources. |
| */ |
| @NonNull |
| public static Typeface createFromResources(AssetManager mgr, String path, int cookie) { |
| if (sFallbackFonts != null) { |
| synchronized (sDynamicTypefaceCache) { |
| final String key = createAssetUid(mgr, path); |
| Typeface typeface = sDynamicTypefaceCache.get(key); |
| if (typeface != null) return typeface; |
| |
| FontFamily fontFamily = new FontFamily(); |
| if (fontFamily.addFontFromAssetManager(mgr, path, cookie, false /* isAsset */)) { |
| FontFamily[] families = {fontFamily}; |
| typeface = createFromFamiliesWithDefault(families); |
| sDynamicTypefaceCache.put(key, typeface); |
| return typeface; |
| } |
| } |
| } |
| throw new RuntimeException("Font resource not found " + path); |
| } |
| |
| /** |
| * Create a typeface object given a font request. The font will be asynchronously fetched, |
| * therefore the result is delivered to the given callback. See {@link FontRequest}. |
| * Only one of the methods in callback will be invoked, depending on whether the request |
| * succeeds or fails. These calls will happen on the main thread. |
| * @param request A {@link FontRequest} object that identifies the provider and query for the |
| * request. May not be null. |
| * @param callback A callback that will be triggered when results are obtained. May not be null. |
| */ |
| public static void create(@NonNull FontRequest request, @NonNull FontRequestCallback callback) { |
| synchronized (sLock) { |
| if (sFontsContract == null) { |
| sFontsContract = new FontsContract(); |
| mHandler = new Handler(); |
| } |
| final ResultReceiver receiver = new ResultReceiver(null) { |
| @Override |
| public void onReceiveResult(int resultCode, Bundle resultData) { |
| mHandler.post(new Runnable() { |
| @Override |
| public void run() { |
| receiveResult(request, callback, resultCode, resultData); |
| } |
| }); |
| } |
| }; |
| sFontsContract.getFont(request, receiver); |
| } |
| } |
| |
| private static void receiveResult(FontRequest request, FontRequestCallback callback, |
| int resultCode, Bundle resultData) { |
| if (resultCode == FontsContract.RESULT_CODE_PROVIDER_NOT_FOUND) { |
| callback.onTypefaceRequestFailed( |
| FontRequestCallback.FAIL_REASON_PROVIDER_NOT_FOUND); |
| return; |
| } |
| if (resultCode == FontsContract.RESULT_CODE_FONT_NOT_FOUND |
| || resultData == null) { |
| callback.onTypefaceRequestFailed( |
| FontRequestCallback.FAIL_REASON_FONT_NOT_FOUND); |
| return; |
| } |
| List<FontResult> resultList = |
| resultData.getParcelableArrayList(FontsContract.PARCEL_FONT_RESULTS); |
| if (resultList == null || resultList.isEmpty()) { |
| callback.onTypefaceRequestFailed( |
| FontRequestCallback.FAIL_REASON_FONT_NOT_FOUND); |
| return; |
| } |
| FontFamily fontFamily = new FontFamily(); |
| for (int i = 0; i < resultList.size(); ++i) { |
| FontResult result = resultList.get(i); |
| ParcelFileDescriptor fd = result.getFileDescriptor(); |
| if (fd == null) { |
| callback.onTypefaceRequestFailed( |
| FontRequestCallback.FAIL_REASON_FONT_LOAD_ERROR); |
| return; |
| } |
| try (FileInputStream is = new FileInputStream(fd.getFileDescriptor())) { |
| FileChannel fileChannel = is.getChannel(); |
| long fontSize = fileChannel.size(); |
| ByteBuffer fontBuffer = fileChannel.map( |
| FileChannel.MapMode.READ_ONLY, 0, fontSize); |
| int style = result.getStyle(); |
| int weight = (style & BOLD) != 0 ? 700 : 400; |
| // TODO: this method should be |
| // create(fd, ttcIndex, fontVariationSettings, style). |
| if (!fontFamily.addFontWeightStyle(fontBuffer, result.getTtcIndex(), |
| null, weight, (style & ITALIC) != 0)) { |
| Log.e(TAG, "Error creating font " + request.getQuery()); |
| callback.onTypefaceRequestFailed( |
| FontRequestCallback.FAIL_REASON_FONT_LOAD_ERROR); |
| return; |
| } |
| } catch (IOException e) { |
| Log.e(TAG, "Error reading font " + request.getQuery(), e); |
| callback.onTypefaceRequestFailed( |
| FontRequestCallback.FAIL_REASON_FONT_LOAD_ERROR); |
| return; |
| } finally { |
| IoUtils.closeQuietly(fd); |
| } |
| } |
| fontFamily.freeze(); |
| callback.onTypefaceRetrieved(Typeface.createFromFamiliesWithDefault( |
| new FontFamily[] {fontFamily})); |
| } |
| |
| /** |
| * Interface used to receive asynchronously fetched typefaces. |
| */ |
| public interface FontRequestCallback { |
| /** |
| * Constant returned by {@link #onTypefaceRequestFailed(int)} signaling that the given |
| * provider was not found on the device. |
| */ |
| int FAIL_REASON_PROVIDER_NOT_FOUND = 0; |
| /** |
| * Constant returned by {@link #onTypefaceRequestFailed(int)} signaling that the font |
| * returned by the provider was not loaded properly. |
| */ |
| int FAIL_REASON_FONT_LOAD_ERROR = 1; |
| /** |
| * Constant returned by {@link #onTypefaceRequestFailed(int)} signaling that the given |
| * provider did not return any results for the given query. |
| */ |
| int FAIL_REASON_FONT_NOT_FOUND = 2; |
| |
| /** @hide */ |
| @IntDef({FAIL_REASON_PROVIDER_NOT_FOUND, FAIL_REASON_FONT_LOAD_ERROR, |
| FAIL_REASON_FONT_NOT_FOUND}) |
| @Retention(RetentionPolicy.SOURCE) |
| @interface FontRequestFailReason {} |
| |
| /** |
| * Called then a Typeface request done via {@link Typeface#create(FontRequest, |
| * FontRequestCallback)} is complete. Note that this method will not be called if |
| * {@link #onTypefaceRequestFailed(int)} is called instead. |
| * @param typeface The Typeface object retrieved. |
| */ |
| void onTypefaceRetrieved(Typeface typeface); |
| |
| /** |
| * Called when a Typeface request done via {@link Typeface#create(FontRequest, |
| * FontRequestCallback)} fails. |
| * @param reason One of {@link #FAIL_REASON_PROVIDER_NOT_FOUND}, |
| * {@link #FAIL_REASON_FONT_NOT_FOUND} or |
| * {@link #FAIL_REASON_FONT_LOAD_ERROR}. |
| */ |
| void onTypefaceRequestFailed(@FontRequestFailReason int reason); |
| } |
| |
| /** |
| * Create a typeface object given a family name, and option style information. |
| * If null is passed for the name, then the "default" font will be chosen. |
| * The resulting typeface object can be queried (getStyle()) to discover what |
| * its "real" style characteristics are. |
| * |
| * @param familyName May be null. The name of the font family. |
| * @param style The style (normal, bold, italic) of the typeface. |
| * e.g. NORMAL, BOLD, ITALIC, BOLD_ITALIC |
| * @return The best matching typeface. |
| */ |
| public static Typeface create(String familyName, int style) { |
| if (sSystemFontMap != null) { |
| return create(sSystemFontMap.get(familyName), style); |
| } |
| return null; |
| } |
| |
| /** |
| * Create a typeface object that best matches the specified existing |
| * typeface and the specified Style. Use this call if you want to pick a new |
| * style from the same family of an existing typeface object. If family is |
| * null, this selects from the default font's family. |
| * |
| * @param family May be null. The name of the existing type face. |
| * @param style The style (normal, bold, italic) of the typeface. |
| * e.g. NORMAL, BOLD, ITALIC, BOLD_ITALIC |
| * @return The best matching typeface. |
| */ |
| public static Typeface create(Typeface family, int style) { |
| if (style < 0 || style > 3) { |
| style = 0; |
| } |
| long ni = 0; |
| if (family != null) { |
| // Return early if we're asked for the same face/style |
| if (family.mStyle == style) { |
| return family; |
| } |
| |
| ni = family.native_instance; |
| } |
| |
| Typeface typeface; |
| SparseArray<Typeface> styles = sTypefaceCache.get(ni); |
| |
| if (styles != null) { |
| typeface = styles.get(style); |
| if (typeface != null) { |
| return typeface; |
| } |
| } |
| |
| typeface = new Typeface(nativeCreateFromTypeface(ni, style)); |
| if (styles == null) { |
| styles = new SparseArray<Typeface>(4); |
| sTypefaceCache.put(ni, styles); |
| } |
| styles.put(style, typeface); |
| |
| return typeface; |
| } |
| |
| /** |
| * Returns one of the default typeface objects, based on the specified style |
| * |
| * @return the default typeface that corresponds to the style |
| */ |
| public static Typeface defaultFromStyle(int style) { |
| return sDefaults[style]; |
| } |
| |
| /** |
| * Create a new typeface from the specified font data. |
| * |
| * @param mgr The application's asset manager |
| * @param path The file name of the font data in the assets directory |
| * @return The new typeface. |
| */ |
| public static Typeface createFromAsset(AssetManager mgr, String path) { |
| if (sFallbackFonts != null) { |
| synchronized (sDynamicTypefaceCache) { |
| final String key = createAssetUid(mgr, path); |
| Typeface typeface = sDynamicTypefaceCache.get(key); |
| if (typeface != null) return typeface; |
| |
| FontFamily fontFamily = new FontFamily(); |
| if (fontFamily.addFontFromAssetManager(mgr, path, 0, true /* isAsset */)) { |
| fontFamily.freeze(); |
| FontFamily[] families = { fontFamily }; |
| typeface = createFromFamiliesWithDefault(families); |
| sDynamicTypefaceCache.put(key, typeface); |
| return typeface; |
| } else { |
| fontFamily.abortCreation(); |
| } |
| } |
| } |
| throw new RuntimeException("Font asset not found " + path); |
| } |
| |
| /** |
| * Creates a unique id for a given AssetManager and asset path. |
| * |
| * @param mgr AssetManager instance |
| * @param path The path for the asset. |
| * @return Unique id for a given AssetManager and asset path. |
| */ |
| private static String createAssetUid(final AssetManager mgr, String path) { |
| final SparseArray<String> pkgs = mgr.getAssignedPackageIdentifiers(); |
| final StringBuilder builder = new StringBuilder(); |
| final int size = pkgs.size(); |
| for (int i = 0; i < size; i++) { |
| builder.append(pkgs.valueAt(i)); |
| builder.append("-"); |
| } |
| builder.append(path); |
| return builder.toString(); |
| } |
| |
| /** |
| * Create a new typeface from the specified font file. |
| * |
| * @param path The path to the font data. |
| * @return The new typeface. |
| */ |
| public static Typeface createFromFile(File path) { |
| return createFromFile(path.getAbsolutePath()); |
| } |
| |
| /** |
| * Create a new typeface from the specified font file. |
| * |
| * @param path The full path to the font data. |
| * @return The new typeface. |
| */ |
| public static Typeface createFromFile(String path) { |
| if (sFallbackFonts != null) { |
| FontFamily fontFamily = new FontFamily(); |
| if (fontFamily.addFont(path, 0 /* ttcIndex */)) { |
| fontFamily.freeze(); |
| FontFamily[] families = { fontFamily }; |
| return createFromFamiliesWithDefault(families); |
| } else { |
| fontFamily.abortCreation(); |
| } |
| } |
| throw new RuntimeException("Font not found " + path); |
| } |
| |
| /** |
| * Create a new typeface from an array of font families. |
| * |
| * @param families array of font families |
| * @hide |
| */ |
| public static Typeface createFromFamilies(FontFamily[] families) { |
| long[] ptrArray = new long[families.length]; |
| for (int i = 0; i < families.length; i++) { |
| ptrArray[i] = families[i].mNativePtr; |
| } |
| return new Typeface(nativeCreateFromArray(ptrArray)); |
| } |
| |
| /** |
| * Create a new typeface from an array of font families, including |
| * also the font families in the fallback list. |
| * |
| * @param families array of font families |
| * @hide |
| */ |
| public static Typeface createFromFamiliesWithDefault(FontFamily[] families) { |
| long[] ptrArray = new long[families.length + sFallbackFonts.length]; |
| for (int i = 0; i < families.length; i++) { |
| ptrArray[i] = families[i].mNativePtr; |
| } |
| for (int i = 0; i < sFallbackFonts.length; i++) { |
| ptrArray[i + families.length] = sFallbackFonts[i].mNativePtr; |
| } |
| return new Typeface(nativeCreateFromArray(ptrArray)); |
| } |
| |
| // don't allow clients to call this directly |
| private Typeface(long ni) { |
| if (ni == 0) { |
| throw new RuntimeException("native typeface cannot be made"); |
| } |
| |
| native_instance = ni; |
| mStyle = nativeGetStyle(ni); |
| } |
| |
| private static FontFamily makeFamilyFromParsed(FontConfig.Family family, |
| Map<String, ByteBuffer> bufferForPath) { |
| FontFamily fontFamily = new FontFamily(family.getLanguage(), family.getVariant()); |
| for (FontConfig.Font font : family.getFonts()) { |
| ByteBuffer fontBuffer = bufferForPath.get(font.getFontName()); |
| if (fontBuffer == null) { |
| try (FileInputStream file = new FileInputStream(font.getFontName())) { |
| FileChannel fileChannel = file.getChannel(); |
| long fontSize = fileChannel.size(); |
| fontBuffer = fileChannel.map(FileChannel.MapMode.READ_ONLY, 0, fontSize); |
| bufferForPath.put(font.getFontName(), fontBuffer); |
| } catch (IOException e) { |
| Log.e(TAG, "Error mapping font file " + font.getFontName()); |
| continue; |
| } |
| } |
| if (!fontFamily.addFontWeightStyle(fontBuffer, font.getTtcIndex(), font.getAxes(), |
| font.getWeight(), font.isItalic())) { |
| Log.e(TAG, "Error creating font " + font.getFontName() + "#" + font.getTtcIndex()); |
| } |
| } |
| fontFamily.freeze(); |
| return fontFamily; |
| } |
| |
| /* |
| * (non-Javadoc) |
| * |
| * This should only be called once, from the static class initializer block. |
| */ |
| private static void init() { |
| // Load font config and initialize Minikin state |
| File systemFontConfigLocation = getSystemFontConfigLocation(); |
| File configFilename = new File(systemFontConfigLocation, FONTS_CONFIG); |
| try { |
| FileInputStream fontsIn = new FileInputStream(configFilename); |
| FontConfig fontConfig = FontListParser.parse(fontsIn); |
| |
| Map<String, ByteBuffer> bufferForPath = new HashMap<String, ByteBuffer>(); |
| |
| List<FontFamily> familyList = new ArrayList<FontFamily>(); |
| // Note that the default typeface is always present in the fallback list; |
| // this is an enhancement from pre-Minikin behavior. |
| for (int i = 0; i < fontConfig.getFamilies().size(); i++) { |
| FontConfig.Family f = fontConfig.getFamilies().get(i); |
| if (i == 0 || f.getName() == null) { |
| familyList.add(makeFamilyFromParsed(f, bufferForPath)); |
| } |
| } |
| sFallbackFonts = familyList.toArray(new FontFamily[familyList.size()]); |
| setDefault(Typeface.createFromFamilies(sFallbackFonts)); |
| |
| Map<String, Typeface> systemFonts = new HashMap<String, Typeface>(); |
| for (int i = 0; i < fontConfig.getFamilies().size(); i++) { |
| Typeface typeface; |
| FontConfig.Family f = fontConfig.getFamilies().get(i); |
| if (f.getName() != null) { |
| if (i == 0) { |
| // The first entry is the default typeface; no sense in |
| // duplicating the corresponding FontFamily. |
| typeface = sDefaultTypeface; |
| } else { |
| FontFamily fontFamily = makeFamilyFromParsed(f, bufferForPath); |
| FontFamily[] families = { fontFamily }; |
| typeface = Typeface.createFromFamiliesWithDefault(families); |
| } |
| systemFonts.put(f.getName(), typeface); |
| } |
| } |
| for (FontConfig.Alias alias : fontConfig.getAliases()) { |
| Typeface base = systemFonts.get(alias.getToName()); |
| Typeface newFace = base; |
| int weight = alias.getWeight(); |
| if (weight != 400) { |
| newFace = new Typeface(nativeCreateWeightAlias(base.native_instance, weight)); |
| } |
| systemFonts.put(alias.getName(), newFace); |
| } |
| sSystemFontMap = systemFonts; |
| |
| } catch (RuntimeException e) { |
| Log.w(TAG, "Didn't create default family (most likely, non-Minikin build)", e); |
| // TODO: normal in non-Minikin case, remove or make error when Minikin-only |
| } catch (FileNotFoundException e) { |
| Log.e(TAG, "Error opening " + configFilename, e); |
| } catch (IOException e) { |
| Log.e(TAG, "Error reading " + configFilename, e); |
| } catch (XmlPullParserException e) { |
| Log.e(TAG, "XML parse exception for " + configFilename, e); |
| } |
| } |
| |
| static { |
| init(); |
| // Set up defaults and typefaces exposed in public API |
| DEFAULT = create((String) null, 0); |
| DEFAULT_BOLD = create((String) null, Typeface.BOLD); |
| SANS_SERIF = create("sans-serif", 0); |
| SERIF = create("serif", 0); |
| MONOSPACE = create("monospace", 0); |
| |
| sDefaults = new Typeface[] { |
| DEFAULT, |
| DEFAULT_BOLD, |
| create((String) null, Typeface.ITALIC), |
| create((String) null, Typeface.BOLD_ITALIC), |
| }; |
| |
| } |
| |
| private static File getSystemFontConfigLocation() { |
| return new File("/system/etc/"); |
| } |
| |
| @Override |
| protected void finalize() throws Throwable { |
| try { |
| nativeUnref(native_instance); |
| native_instance = 0; // Other finalizers can still call us. |
| } finally { |
| super.finalize(); |
| } |
| } |
| |
| @Override |
| public boolean equals(Object o) { |
| if (this == o) return true; |
| if (o == null || getClass() != o.getClass()) return false; |
| |
| Typeface typeface = (Typeface) o; |
| |
| return mStyle == typeface.mStyle && native_instance == typeface.native_instance; |
| } |
| |
| @Override |
| public int hashCode() { |
| /* |
| * Modified method for hashCode with long native_instance derived from |
| * http://developer.android.com/reference/java/lang/Object.html |
| */ |
| int result = 17; |
| result = 31 * result + (int) (native_instance ^ (native_instance >>> 32)); |
| result = 31 * result + mStyle; |
| return result; |
| } |
| |
| private static native long nativeCreateFromTypeface(long native_instance, int style); |
| private static native long nativeCreateWeightAlias(long native_instance, int weight); |
| private static native void nativeUnref(long native_instance); |
| private static native int nativeGetStyle(long native_instance); |
| private static native long nativeCreateFromArray(long[] familyArray); |
| private static native void nativeSetDefault(long native_instance); |
| } |