android-16.0.0_r2/s

/*
 * Copyright 2018 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.fonts;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotEquals;

import android.graphics.Typeface;
import android.graphics.cts.R;
import android.platform.test.ravenwood.RavenwoodRule;
import android.text.TextPaint;
import android.util.Pair;

import com.android.ravenwood.common.RavenwoodCommonUtils;

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;

/**
 * Provides a utility for testing fonts
 *
 * For the purpose of testing font selection of families or fallbacks, this class provies following
 * regular font files.
 *
 * - ascii_a3em_weight100_upright.ttf
 *   'a' has 3em width and others have 1em width. The metadata has weight=100, non-italic value.
 * - ascii_b3em_weight100_italic.ttf
 *   'b' has 3em width and others have 1em width. The metadata has weight=100, italic value.
 * - ascii_c3em_weight200_upright.ttf
 *   'c' has 3em width and others have 1em width. The metadata has weight=200, non-italic value.
 * - ascii_d3em_weight200_italic.ttf
 *   'd' has 3em width and others have 1em width. The metadata has weight=200, italic value.
 * - ascii_e3em_weight300_upright.ttf
 *   'e' has 3em width and others have 1em width. The metadata has weight=300, non-italic value.
 * - ascii_f3em_weight300_italic.ttf
 *   'f' has 3em width and others have 1em width. The metadata has weight=300, italic value.
 * - ascii_g3em_weight400_upright.ttf
 *   'g' has 3em width and others have 1em width. The metadata has weight=400, non-italic value.
 * - ascii_h3em_weight400_italic.ttf
 *   'h' has 3em width and others have 1em width. The metadata has weight=400, italic value.
 * - ascii_i3em_weight500_upright.ttf
 *   'i' has 3em width and others have 1em width. The metadata has weight=500, non-italic value.
 * - ascii_j3em_weight500_italic.ttf
 *   'j' has 3em width and others have 1em width. The metadata has weight=500, italic value.
 * - ascii_k3em_weight600_upright.ttf
 *   'k' has 3em width and others have 1em width. The metadata has weight=600, non-italic value.
 * - ascii_l3em_weight600_italic.ttf
 *   'l' has 3em width and others have 1em width. The metadata has weight=600, italic value.
 * - ascii_m3em_weight700_upright.ttf
 *   'm' has 3em width and others have 1em width. The metadata has weight=700, non-italic value.
 * - ascii_n3em_weight700_italic.ttf
 *   'n' has 3em width and others have 1em width. The metadata has weight=700, italic value.
 * - ascii_o3em_weight800_upright.ttf
 *   'o' has 3em width and others have 1em width. The metadata has weight=800, non-italic value.
 * - ascii_p3em_weight800_italic.ttf
 *   'p' has 3em width and others have 1em width. The metadata has weight=800, italic value.
 * - ascii_q3em_weight900_upright.ttf
 *   'q' has 3em width and others have 1em width. The metadata has weight=900, non-italic value.
 * - ascii_r3em_weight900_italic.ttf
 *   'r' has 3em width and others have 1em width. The metadata has weight=900, italic value.
 *
 * In addition to above font files, this class provides a font collection file and a variable font
 * file.
 * - ascii.ttc
 *   The collection of above 18 fonts with above order.
 * - ascii_vf.ttf
 *   This font supports a-z characters and all characters has 1em width. This font supports 'wght',
 *   'ital' axes but no effect for the glyph width. This font also supports 'Asc[a-z]' 26 axes which
 *   makes glyph width 3em. For example, 'Asca 1.0' makes a glyph width of 'a' 3em, 'Ascb 1.0' makes
 *   a glyph width of 'b' 3em. With these axes, above font can be replicated like
 *   - 'Asca' 1.0, 'wght' 100.0' is equivalent with ascii_a3em_width100_upright.ttf
 *   - 'Ascb' 1.0, 'wght' 100.0, 'ital' 1.0' is equivalent with ascii_b3em_width100_italic.ttf
 */
public class FontTestUtil {
    private static final String FAMILY_SELECTION_FONT_PATH_IN_ASSET = "fonts/family_selection";
    private static final List<Pair<Integer, Boolean>> sStyleList;
    private static final Map<Pair<Integer, Boolean>, String> sFontMap;
    private static final Map<Pair<Integer, Boolean>, Integer> sTtcMap;
    private static final Map<Pair<Integer, Boolean>, String> sVariationSettingsMap;
    private static final Map<Pair<Integer, Boolean>, Integer> sResourceMap;
    private static final String[] sFontList = {  // Same order of ascii.ttc
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_a3em_weight100_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_b3em_weight100_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_c3em_weight200_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_d3em_weight200_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_e3em_weight300_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_f3em_weight300_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_g3em_weight400_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_h3em_weight400_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_i3em_weight500_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_j3em_weight500_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_k3em_weight600_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_l3em_weight600_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_m3em_weight700_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_n3em_weight700_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_o3em_weight800_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_p3em_weight800_italic.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_q3em_weight900_upright.ttf",
            FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ttf/ascii_r3em_weight900_italic.ttf",
    };

    private static final String[] FONT_VARIATION_SETTING_LIST = {
            "'Asca' 1.0, 'wght' 100.0",
            "'Ascb' 1.0, 'wght' 100.0, 'ital' 1.0",
            "'Ascc' 1.0, 'wght' 200.0",
            "'Ascd' 1.0, 'wght' 200.0, 'ital' 1.0",
            "'Asce' 1.0, 'wght' 300.0",
            "'Ascf' 1.0, 'wght' 300.0, 'ital' 1.0",
            "'Ascg' 1.0, 'wght' 400.0",
            "'Asch' 1.0, 'wght' 400.0, 'ital' 1.0",
            "'Asci' 1.0, 'wght' 500.0",
            "'Ascj' 1.0, 'wght' 500.0, 'ital' 1.0",
            "'Asck' 1.0, 'wght' 600.0",
            "'Ascl' 1.0, 'wght' 600.0, 'ital' 1.0",
            "'Ascm' 1.0, 'wght' 700.0",
            "'Ascn' 1.0, 'wght' 700.0, 'ital' 1.0",
            "'Asco' 1.0, 'wght' 800.0",
            "'Ascp' 1.0, 'wght' 800.0, 'ital' 1.0",
            "'Ascq' 1.0, 'wght' 900.0",
            "'Ascr' 1.0, 'wght' 900.0, 'ital' 1.0",
    };

    private static final int[] FONT_RESOURCE_ID_LIST = {
            R.font.ascii_a3em_weight100_upright,
            R.font.ascii_b3em_weight100_italic,
            R.font.ascii_c3em_weight200_upright,
            R.font.ascii_d3em_weight200_italic,
            R.font.ascii_e3em_weight300_upright,
            R.font.ascii_f3em_weight300_italic,
            R.font.ascii_g3em_weight400_upright,
            R.font.ascii_h3em_weight400_italic,
            R.font.ascii_i3em_weight500_upright,
            R.font.ascii_j3em_weight500_italic,
            R.font.ascii_k3em_weight600_upright,
            R.font.ascii_l3em_weight600_italic,
            R.font.ascii_m3em_weight700_upright,
            R.font.ascii_n3em_weight700_italic,
            R.font.ascii_o3em_weight800_upright,
            R.font.ascii_p3em_weight800_italic,
            R.font.ascii_q3em_weight900_upright,
            R.font.ascii_r3em_weight900_italic,
    };

    private static final char[] CHAR_3EM_WIDTH = {
            'a',
            'b',
            'c',
            'd',
            'e',
            'f',
            'g',
            'h',
            'i',
            'j',
            'k',
            'l',
            'm',
            'n',
            'o',
            'p',
            'q',
            'r',
    };

    static {
        // Style list with the same order of sFontList.
        ArrayList<Pair<Integer, Boolean>> styles = new ArrayList<>();
        styles.add(new Pair<>(100, false));
        styles.add(new Pair<>(100, true));
        styles.add(new Pair<>(200, false));
        styles.add(new Pair<>(200, true));
        styles.add(new Pair<>(300, false));
        styles.add(new Pair<>(300, true));
        styles.add(new Pair<>(400, false));
        styles.add(new Pair<>(400, true));
        styles.add(new Pair<>(500, false));
        styles.add(new Pair<>(500, true));
        styles.add(new Pair<>(600, false));
        styles.add(new Pair<>(600, true));
        styles.add(new Pair<>(700, false));
        styles.add(new Pair<>(700, true));
        styles.add(new Pair<>(800, false));
        styles.add(new Pair<>(800, true));
        styles.add(new Pair<>(900, false));
        styles.add(new Pair<>(900, true));
        sStyleList = Collections.unmodifiableList(styles);

        HashMap<Pair<Integer, Boolean>, String> map = new HashMap<>();
        HashMap<Pair<Integer, Boolean>, Integer> ttcMap = new HashMap<>();
        HashMap<Pair<Integer, Boolean>, String> variationMap = new HashMap<>();
        HashMap<Pair<Integer, Boolean>, Integer> resourceMap = new HashMap<>();
        HashMap<Character, Pair<Integer, Boolean>> reverseMap = new HashMap<>();
        for (int i = 0; i < sFontList.length; ++i) {
            map.put(sStyleList.get(i), sFontList[i]);
            ttcMap.put(sStyleList.get(i), i);
            variationMap.put(sStyleList.get(i), FONT_VARIATION_SETTING_LIST[i]);
            resourceMap.put(sStyleList.get(i), FONT_RESOURCE_ID_LIST[i]);
        }
        sFontMap = Collections.unmodifiableMap(map);
        sTtcMap = Collections.unmodifiableMap(ttcMap);
        sVariationSettingsMap = Collections.unmodifiableMap(variationMap);
        sResourceMap = Collections.unmodifiableMap(resourceMap);
    }

    /**
     * Measure a character with 100px text size
     */
    private static float measureChar(Typeface typeface, char c) {
        final TextPaint tp = new TextPaint();
        tp.setTextSize(100);
        tp.setTypeface(typeface);
        tp.setTextLocale(Locale.US);
        return tp.measureText(new char[] { c }, 0, 1);
    }

    /**
     * Returns a path to the font collection file in asset directory.
     */
    public static String getTtcFontFileInAsset() {
        return FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ascii.ttc";
    }

    /**
     * Returns a resource id for the font collection file.
     */
    public static int getTtcFontFileResourceId() {
        return R.font.ascii;
    }

    /**
     * Returns a path to the variable font file in asset directory.
     */
    public static String getVFFontInAsset() {
        return FAMILY_SELECTION_FONT_PATH_IN_ASSET + "/ascii_vf.ttf";
    }

    /**
     * Returns a resource id for the variable font.
     */
    public static int getVFFontResourceId() {
        return R.font.ascii_vf;
    }

    /**
     * Returns a ttc index of the specified style.
     */
    public static int getTtcIndexFromStyle(int weight, boolean italic) {
        return sTtcMap.get(new Pair<>(weight, italic)).intValue();
    }

    /**
     * Returns a variation settings string of the specified style.
     */
    public static String getVarSettingsFromStyle(int weight, boolean italic) {
        return sVariationSettingsMap.get(new Pair<>(weight, italic));
    }

    /**
     * Returns a font resource ID of the specific style.
     */
    public static int getFontResourceIdFromStyle(int weight, boolean italic) {
        return sResourceMap.get(new Pair<>(weight, italic));
    }

    /**
     * Returns a font path from the specified style.
     */
    public static String getFontPathFromStyle(int weight, boolean italic) {
        return sFontMap.get(new Pair<>(weight, italic));
    }

    /**
     * Returns all supported styles.
     *
     * @return a pair of weight and style(uplight/italic)
     */
    public static List<Pair<Integer, Boolean>> getAllStyles() {
        return sStyleList;
    }

    /**
     * Returns selected font index in the sStyleList array.
     */
    private static int getSelectedFontStyle(Typeface typeface) {
        int indexOf3Em = -1;
        for (int i = 0; i < CHAR_3EM_WIDTH.length; ++i) {
            if (measureChar(typeface, CHAR_3EM_WIDTH[i]) == 300.0f) {
                assertEquals("A font has two 3em width character. Likely the wrong test setup.",
                        -1, indexOf3Em);
                indexOf3Em = i;
            }
        }
        assertNotEquals("No font has 3em width character. Likely the wrong test setup.",
                -1, indexOf3Em);
        return indexOf3Em;
    }

    /**
     * Returns selected font's style.
     */
    public static Pair<Integer, Boolean> getSelectedStyle(Typeface typeface) {
        return sStyleList.get(getSelectedFontStyle(typeface));
    }

    /**
     * Returns selected font's file path.
     *
     * Note that this is valid only if the all Font objects in the FontFamily is created with
     * AssetManager.
     */
    public static String getSelectedFontPathInAsset(Typeface typeface) {
        return sFontList[getSelectedFontStyle(typeface)];
    }

    /**
     * Returns selected font's ttc index.
     *
     * Note that this is valid only if the all Font objects in the FontFamily is created with
     * TTC font with ttcIndex.
     */
    public static int getSelectedTtcIndex(Typeface typeface) {
        return getSelectedFontStyle(typeface);
    }

    /**
     * Returns selected font's variation settings.
     *
     * Note that this is valid only if the all Font objects in the FontFamily is created with
     * variable fonts with font variation settings.
     */
    public static String getSelectedVariationSettings(Typeface typeface) {
        return FONT_VARIATION_SETTING_LIST[getSelectedFontStyle(typeface)];
    }

    /** Returns the correct fonts directory, either on device or running in Ravenwood. */
    public static String getFontsDir() {
        if (RavenwoodRule.isOnRavenwood()) {
            return RavenwoodCommonUtils.getRavenwoodRuntimePath() + "/fonts/";
        } else {
            return "/system/fonts/";
        }
    }
}