You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
758 lines
32 KiB
758 lines
32 KiB
4 months ago
|
/*
|
||
|
|
* Copyright (C) 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 com.android.recovery.tools;
|
||
|
|
|
||
|
|
import com.ibm.icu.text.BreakIterator;
|
||
|
|
|
||
|
|
import org.apache.commons.cli.CommandLine;
|
||
|
|
import org.apache.commons.cli.GnuParser;
|
||
|
|
import org.apache.commons.cli.HelpFormatter;
|
||
|
|
import org.apache.commons.cli.OptionBuilder;
|
||
|
|
import org.apache.commons.cli.Options;
|
||
|
|
import org.apache.commons.cli.ParseException;
|
||
|
|
import org.w3c.dom.Document;
|
||
|
|
import org.w3c.dom.Node;
|
||
|
|
import org.w3c.dom.NodeList;
|
||
|
|
|
||
|
|
import java.awt.Color;
|
||
|
|
import java.awt.Font;
|
||
|
|
import java.awt.FontFormatException;
|
||
|
|
import java.awt.FontMetrics;
|
||
|
|
import java.awt.Graphics2D;
|
||
|
|
import java.awt.RenderingHints;
|
||
|
|
import java.awt.font.TextAttribute;
|
||
|
|
import java.awt.image.BufferedImage;
|
||
|
|
import java.io.File;
|
||
|
|
import java.io.IOException;
|
||
|
|
import java.text.AttributedString;
|
||
|
|
import java.util.ArrayList;
|
||
|
|
import java.util.Arrays;
|
||
|
|
import java.util.HashMap;
|
||
|
|
import java.util.HashSet;
|
||
|
|
import java.util.List;
|
||
|
|
import java.util.Locale;
|
||
|
|
import java.util.Map;
|
||
|
|
import java.util.Set;
|
||
|
|
import java.util.TreeMap;
|
||
|
|
import java.util.logging.Level;
|
||
|
|
import java.util.logging.Logger;
|
||
|
|
|
||
|
|
import javax.imageio.ImageIO;
|
||
|
|
import javax.xml.parsers.DocumentBuilder;
|
||
|
|
import javax.xml.parsers.DocumentBuilderFactory;
|
||
|
|
import javax.xml.parsers.ParserConfigurationException;
|
||
|
|
|
||
|
|
/** Command line tool to generate the localized image for recovery mode. */
|
||
|
|
public class ImageGenerator {
|
||
|
|
// Initial height of the image to draw.
|
||
|
|
private static final int INITIAL_HEIGHT = 20000;
|
||
|
|
|
||
|
|
private static final float DEFAULT_FONT_SIZE = 40;
|
||
|
|
|
||
|
|
private static final Logger LOGGER = Logger.getLogger(ImageGenerator.class.getName());
|
||
|
|
|
||
|
|
// This is the canvas we used to draw texts.
|
||
|
|
private BufferedImage mBufferedImage;
|
||
|
|
|
||
|
|
// The width in pixels of our image. The value will be adjusted once when we calculate the
|
||
|
|
// maximum width to fit the wrapped text strings.
|
||
|
|
private int mImageWidth;
|
||
|
|
|
||
|
|
// The current height in pixels of our image. We will adjust the value when drawing more texts.
|
||
|
|
private int mImageHeight;
|
||
|
|
|
||
|
|
// The current vertical offset in pixels to draw the top edge of new text strings.
|
||
|
|
private int mVerticalOffset;
|
||
|
|
|
||
|
|
// The font size to draw the texts.
|
||
|
|
private final float mFontSize;
|
||
|
|
|
||
|
|
// The name description of the text to localize. It's used to find the translated strings in the
|
||
|
|
// resource file.
|
||
|
|
private final String mTextName;
|
||
|
|
|
||
|
|
// The directory that contains all the needed font files (e.g. ttf, otf, ttc files).
|
||
|
|
private final String mFontDirPath;
|
||
|
|
|
||
|
|
// Align the text in the center of the image.
|
||
|
|
private final boolean mCenterAlignment;
|
||
|
|
|
||
|
|
// Some localized font cannot draw the word "Android" and some PUNCTUATIONS; we need to fall
|
||
|
|
// back to use our default latin font instead.
|
||
|
|
private static final char[] PUNCTUATIONS = {',', ';', '.', '!', '?'};
|
||
|
|
|
||
|
|
private static final String ANDROID_STRING = "Android";
|
||
|
|
|
||
|
|
// The width of the word "Android" when drawing with the default font.
|
||
|
|
private int mAndroidStringWidth;
|
||
|
|
|
||
|
|
// The default Font to draw latin characters. It's loaded from DEFAULT_FONT_NAME.
|
||
|
|
private Font mDefaultFont;
|
||
|
|
// Cache of the loaded fonts for all languages.
|
||
|
|
private Map<String, Font> mLoadedFontMap;
|
||
|
|
|
||
|
|
// An explicit map from language to the font name to use.
|
||
|
|
// The map is extracted from frameworks/base/data/fonts/fonts.xml.
|
||
|
|
// And the language-subtag-registry is found in:
|
||
|
|
// https://www.iana.org/assignments/language-subtag-registry/language-subtag-registry
|
||
|
|
private static final String DEFAULT_FONT_NAME = "Roboto-Regular";
|
||
|
|
private static final Map<String, String> LANGUAGE_TO_FONT_MAP =
|
||
|
|
new TreeMap<String, String>() {
|
||
|
|
{
|
||
|
|
put("am", "NotoSansEthiopic-VF");
|
||
|
|
put("ar", "NotoNaskhArabicUI-Regular");
|
||
|
|
put("as", "NotoSansBengaliUI-VF");
|
||
|
|
put("bn", "NotoSansBengaliUI-VF");
|
||
|
|
put("fa", "NotoNaskhArabicUI-Regular");
|
||
|
|
put("gu", "NotoSansGujaratiUI-Regular");
|
||
|
|
put("hi", "NotoSansDevanagariUI-VF");
|
||
|
|
put("hy", "NotoSansArmenian-VF");
|
||
|
|
put("iw", "NotoSansHebrew-Regular");
|
||
|
|
put("ja", "NotoSansCJK-Regular");
|
||
|
|
put("ka", "NotoSansGeorgian-VF");
|
||
|
|
put("ko", "NotoSansCJK-Regular");
|
||
|
|
put("km", "NotoSansKhmerUI-Regular");
|
||
|
|
put("kn", "NotoSansKannadaUI-VF");
|
||
|
|
put("lo", "NotoSansLaoUI-Regular");
|
||
|
|
put("ml", "NotoSansMalayalamUI-VF");
|
||
|
|
put("mr", "NotoSansDevanagariUI-VF");
|
||
|
|
put("my", "NotoSansMyanmarUI-Regular");
|
||
|
|
put("ne", "NotoSansDevanagariUI-VF");
|
||
|
|
put("or", "NotoSansOriya-Regular");
|
||
|
|
put("pa", "NotoSansGurmukhiUI-VF");
|
||
|
|
put("si", "NotoSansSinhalaUI-VF");
|
||
|
|
put("ta", "NotoSansTamilUI-VF");
|
||
|
|
put("te", "NotoSansTeluguUI-VF");
|
||
|
|
put("th", "NotoSansThaiUI-Regular");
|
||
|
|
put("ur", "NotoNaskhArabicUI-Regular");
|
||
|
|
put("zh", "NotoSansCJK-Regular");
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
// Languages that write from right to left.
|
||
|
|
private static final Set<String> RTL_LANGUAGE =
|
||
|
|
new HashSet<String>() {
|
||
|
|
{
|
||
|
|
add("ar"); // Arabic
|
||
|
|
add("fa"); // Persian
|
||
|
|
add("he"); // Hebrew
|
||
|
|
add("iw"); // Hebrew
|
||
|
|
add("ur"); // Urdu
|
||
|
|
}
|
||
|
|
};
|
||
|
|
|
||
|
|
/** Exception to indicate the failure to find the translated text strings. */
|
||
|
|
public static class LocalizedStringNotFoundException extends Exception {
|
||
|
|
public LocalizedStringNotFoundException(String message) {
|
||
|
|
super(message);
|
||
|
|
}
|
||
|
|
|
||
|
|
public LocalizedStringNotFoundException(String message, Throwable cause) {
|
||
|
|
super(message, cause);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This class maintains the content of wrapped text, the attributes to draw these text, and
|
||
|
|
* the width of each wrapped lines.
|
||
|
|
*/
|
||
|
|
private class WrappedTextInfo {
|
||
|
|
/** LineInfo holds the AttributedString and width of each wrapped line. */
|
||
|
|
private class LineInfo {
|
||
|
|
public AttributedString mLineContent;
|
||
|
|
public int mLineWidth;
|
||
|
|
|
||
|
|
LineInfo(AttributedString text, int width) {
|
||
|
|
mLineContent = text;
|
||
|
|
mLineWidth = width;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// Maintains the content of each line, as well as the width needed to draw these lines for
|
||
|
|
// a given language.
|
||
|
|
public List<LineInfo> mWrappedLines;
|
||
|
|
|
||
|
|
WrappedTextInfo() {
|
||
|
|
mWrappedLines = new ArrayList<>();
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Checks if the given text has words "Android" and some PUNCTUATIONS. If it does, and its
|
||
|
|
* associated textFont cannot display them correctly (e.g. for persian and hebrew); sets the
|
||
|
|
* attributes of these substrings to use our default font instead.
|
||
|
|
*
|
||
|
|
* @param text the input string to perform the check on
|
||
|
|
* @param width the pre-calculated width for the given text
|
||
|
|
* @param textFont the localized font to draw the input string
|
||
|
|
* @param fallbackFont our default font to draw latin characters
|
||
|
|
*/
|
||
|
|
public void addLine(String text, int width, Font textFont, Font fallbackFont) {
|
||
|
|
AttributedString attributedText = new AttributedString(text);
|
||
|
|
attributedText.addAttribute(TextAttribute.FONT, textFont);
|
||
|
|
attributedText.addAttribute(TextAttribute.SIZE, mFontSize);
|
||
|
|
|
||
|
|
// Skips the check if we don't specify a fallbackFont.
|
||
|
|
if (fallbackFont != null) {
|
||
|
|
// Adds the attribute to use default font to draw the word "Android".
|
||
|
|
if (text.contains(ANDROID_STRING)
|
||
|
|
&& textFont.canDisplayUpTo(ANDROID_STRING) != -1) {
|
||
|
|
int index = text.indexOf(ANDROID_STRING);
|
||
|
|
attributedText.addAttribute(TextAttribute.FONT, fallbackFont, index,
|
||
|
|
index + ANDROID_STRING.length());
|
||
|
|
}
|
||
|
|
|
||
|
|
// Adds the attribute to use default font to draw the PUNCTUATIONS ", . ; ! ?"
|
||
|
|
for (char punctuation : PUNCTUATIONS) {
|
||
|
|
// TODO (xunchang) handle the RTL language that has different directions for '?'
|
||
|
|
if (text.indexOf(punctuation) != -1 && !textFont.canDisplay(punctuation)) {
|
||
|
|
int index = 0;
|
||
|
|
while ((index = text.indexOf(punctuation, index)) != -1) {
|
||
|
|
attributedText.addAttribute(TextAttribute.FONT, fallbackFont, index,
|
||
|
|
index + 1);
|
||
|
|
index += 1;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
mWrappedLines.add(new LineInfo(attributedText, width));
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Merges two WrappedTextInfo. */
|
||
|
|
public void addLines(WrappedTextInfo other) {
|
||
|
|
mWrappedLines.addAll(other.mWrappedLines);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Initailizes the fields of the image image. */
|
||
|
|
public ImageGenerator(
|
||
|
|
int initialImageWidth,
|
||
|
|
String textName,
|
||
|
|
float fontSize,
|
||
|
|
String fontDirPath,
|
||
|
|
boolean centerAlignment) {
|
||
|
|
mImageWidth = initialImageWidth;
|
||
|
|
mImageHeight = INITIAL_HEIGHT;
|
||
|
|
mVerticalOffset = 0;
|
||
|
|
|
||
|
|
// Initialize the canvas with the default height.
|
||
|
|
mBufferedImage = new BufferedImage(mImageWidth, mImageHeight, BufferedImage.TYPE_BYTE_GRAY);
|
||
|
|
|
||
|
|
mTextName = textName;
|
||
|
|
mFontSize = fontSize;
|
||
|
|
mFontDirPath = fontDirPath;
|
||
|
|
mLoadedFontMap = new TreeMap<>();
|
||
|
|
|
||
|
|
mCenterAlignment = centerAlignment;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Finds the translated text string for the given textName by parsing the resourceFile. Example
|
||
|
|
* of the xml fields: <resources xmlns:android="http://schemas.android.com/apk/res/android">
|
||
|
|
* <string name="recovery_installing_security" msgid="9184031299717114342"> "Sicherheitsupdate
|
||
|
|
* wird installiert"</string> </resources>
|
||
|
|
*
|
||
|
|
* @param resourceFile the input resource file in xml format.
|
||
|
|
* @param textName the name description of the text.
|
||
|
|
* @return the string representation of the translated text.
|
||
|
|
*/
|
||
|
|
private String getTextString(File resourceFile, String textName)
|
||
|
|
throws IOException, ParserConfigurationException, org.xml.sax.SAXException,
|
||
|
|
LocalizedStringNotFoundException {
|
||
|
|
DocumentBuilderFactory builder = DocumentBuilderFactory.newInstance();
|
||
|
|
DocumentBuilder db = builder.newDocumentBuilder();
|
||
|
|
|
||
|
|
Document doc = db.parse(resourceFile);
|
||
|
|
doc.getDocumentElement().normalize();
|
||
|
|
|
||
|
|
NodeList nodeList = doc.getElementsByTagName("string");
|
||
|
|
for (int i = 0; i < nodeList.getLength(); i++) {
|
||
|
|
Node node = nodeList.item(i);
|
||
|
|
String name = node.getAttributes().getNamedItem("name").getNodeValue();
|
||
|
|
if (name.equals(textName)) {
|
||
|
|
return node.getTextContent();
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new LocalizedStringNotFoundException(
|
||
|
|
textName + " not found in " + resourceFile.getName());
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Constructs the locale from the name of the resource file. */
|
||
|
|
private Locale getLocaleFromFilename(String filename) throws IOException {
|
||
|
|
// Gets the locale string by trimming the top "values-".
|
||
|
|
String localeString = filename.substring(7);
|
||
|
|
if (localeString.matches("[A-Za-z]+")) {
|
||
|
|
return Locale.forLanguageTag(localeString);
|
||
|
|
}
|
||
|
|
if (localeString.matches("[A-Za-z]+-r[A-Za-z]+")) {
|
||
|
|
// "${Language}-r${Region}". e.g. en-rGB
|
||
|
|
String[] tokens = localeString.split("-r");
|
||
|
|
return Locale.forLanguageTag(String.join("-", tokens));
|
||
|
|
}
|
||
|
|
if (localeString.startsWith("b+")) {
|
||
|
|
// The special case of b+sr+Latn, which has the form "b+${Language}+${ScriptName}"
|
||
|
|
String[] tokens = localeString.substring(2).split("\\+");
|
||
|
|
return Locale.forLanguageTag(String.join("-", tokens));
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new IOException("Unrecognized locale string " + localeString);
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Iterates over the xml files in the format of values-$LOCALE/strings.xml under the resource
|
||
|
|
* directory and collect the translated text.
|
||
|
|
*
|
||
|
|
* @param resourcePath the path to the resource directory
|
||
|
|
* @param localesSet a list of supported locales; resources of other locales will be omitted.
|
||
|
|
* @return a map with the locale as key, and translated text as value
|
||
|
|
* @throws LocalizedStringNotFoundException if we cannot find the translated text for the given
|
||
|
|
* locale
|
||
|
|
*/
|
||
|
|
public Map<Locale, String> readLocalizedStringFromXmls(String resourcePath,
|
||
|
|
Set<String> localesSet) throws IOException, LocalizedStringNotFoundException {
|
||
|
|
File resourceDir = new File(resourcePath);
|
||
|
|
if (!resourceDir.isDirectory()) {
|
||
|
|
throw new LocalizedStringNotFoundException(resourcePath + " is not a directory.");
|
||
|
|
}
|
||
|
|
|
||
|
|
Map<Locale, String> result =
|
||
|
|
// Overrides the string comparator so that sr is sorted behind sr-Latn. And thus
|
||
|
|
// recovery can find the most relevant locale when going down the list.
|
||
|
|
new TreeMap<>(
|
||
|
|
(Locale l1, Locale l2) -> {
|
||
|
|
if (l1.toLanguageTag().equals(l2.toLanguageTag())) {
|
||
|
|
return 0;
|
||
|
|
}
|
||
|
|
if (l1.getLanguage().equals(l2.toLanguageTag())) {
|
||
|
|
return -1;
|
||
|
|
}
|
||
|
|
if (l2.getLanguage().equals(l1.toLanguageTag())) {
|
||
|
|
return 1;
|
||
|
|
}
|
||
|
|
return l1.toLanguageTag().compareTo(l2.toLanguageTag());
|
||
|
|
});
|
||
|
|
|
||
|
|
// Find all the localized resource subdirectories in the format of values-$LOCALE
|
||
|
|
String[] nameList =
|
||
|
|
resourceDir.list((File file, String name) -> name.startsWith("values-"));
|
||
|
|
for (String name : nameList) {
|
||
|
|
String localeString = name.substring(7);
|
||
|
|
if (localesSet != null && !localesSet.contains(localeString)) {
|
||
|
|
LOGGER.info("Skip parsing text for locale " + localeString);
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
File textFile = new File(resourcePath, name + "/strings.xml");
|
||
|
|
String localizedText;
|
||
|
|
try {
|
||
|
|
localizedText = getTextString(textFile, mTextName);
|
||
|
|
} catch (IOException | ParserConfigurationException | org.xml.sax.SAXException e) {
|
||
|
|
throw new LocalizedStringNotFoundException(
|
||
|
|
"Failed to read the translated text for locale " + name, e);
|
||
|
|
}
|
||
|
|
|
||
|
|
Locale locale = getLocaleFromFilename(name);
|
||
|
|
// Removes the double quotation mark from the text.
|
||
|
|
result.put(locale, localizedText.substring(1, localizedText.length() - 1));
|
||
|
|
}
|
||
|
|
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Returns a font object associated given the given locale
|
||
|
|
*
|
||
|
|
* @throws IOException if the font file fails to open
|
||
|
|
* @throws FontFormatException if the font file doesn't have the expected format
|
||
|
|
*/
|
||
|
|
private Font loadFontsByLocale(String language) throws IOException, FontFormatException {
|
||
|
|
if (mLoadedFontMap.containsKey(language)) {
|
||
|
|
return mLoadedFontMap.get(language);
|
||
|
|
}
|
||
|
|
|
||
|
|
String fontName = LANGUAGE_TO_FONT_MAP.getOrDefault(language, DEFAULT_FONT_NAME);
|
||
|
|
String[] suffixes = {".otf", ".ttf", ".ttc"};
|
||
|
|
for (String suffix : suffixes) {
|
||
|
|
File fontFile = new File(mFontDirPath, fontName + suffix);
|
||
|
|
if (fontFile.isFile()) {
|
||
|
|
Font result = Font.createFont(Font.TRUETYPE_FONT, fontFile).deriveFont(mFontSize);
|
||
|
|
mLoadedFontMap.put(language, result);
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
throw new IOException(
|
||
|
|
"Can not find the font file " + fontName + " for language " + language);
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Wraps the text with a maximum of mImageWidth pixels per line. */
|
||
|
|
private WrappedTextInfo wrapText(String text, FontMetrics metrics) {
|
||
|
|
WrappedTextInfo info = new WrappedTextInfo();
|
||
|
|
|
||
|
|
BreakIterator lineBoundary = BreakIterator.getLineInstance();
|
||
|
|
lineBoundary.setText(text);
|
||
|
|
|
||
|
|
int lineWidth = 0; // Width of the processed words of the current line.
|
||
|
|
int start = lineBoundary.first();
|
||
|
|
StringBuilder line = new StringBuilder();
|
||
|
|
for (int end = lineBoundary.next(); end != BreakIterator.DONE;
|
||
|
|
start = end, end = lineBoundary.next()) {
|
||
|
|
String token = text.substring(start, end);
|
||
|
|
int tokenWidth = metrics.stringWidth(token);
|
||
|
|
// Handles the width mismatch of the word "Android" between different fonts.
|
||
|
|
if (token.contains(ANDROID_STRING)
|
||
|
|
&& metrics.getFont().canDisplayUpTo(ANDROID_STRING) != -1) {
|
||
|
|
tokenWidth = tokenWidth - metrics.stringWidth(ANDROID_STRING) + mAndroidStringWidth;
|
||
|
|
}
|
||
|
|
|
||
|
|
if (lineWidth + tokenWidth > mImageWidth) {
|
||
|
|
info.addLine(line.toString(), lineWidth, metrics.getFont(), mDefaultFont);
|
||
|
|
|
||
|
|
line = new StringBuilder();
|
||
|
|
lineWidth = 0;
|
||
|
|
}
|
||
|
|
line.append(token);
|
||
|
|
lineWidth += tokenWidth;
|
||
|
|
}
|
||
|
|
|
||
|
|
info.addLine(line.toString(), lineWidth, metrics.getFont(), mDefaultFont);
|
||
|
|
|
||
|
|
return info;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Handles the special characters of the raw text embedded in the xml file; and wraps the text
|
||
|
|
* with a maximum of mImageWidth pixels per line.
|
||
|
|
*
|
||
|
|
* @param text the string representation of text to wrap
|
||
|
|
* @param metrics the metrics of the Font used to draw the text; it gives the width in pixels of
|
||
|
|
* the text given its string representation
|
||
|
|
* @return a WrappedTextInfo class with the width of each AttributedString smaller than
|
||
|
|
* mImageWidth pixels
|
||
|
|
*/
|
||
|
|
private WrappedTextInfo processAndWrapText(String text, FontMetrics metrics) {
|
||
|
|
// Apostrophe is escaped in the xml file.
|
||
|
|
String processed = text.replace("\\'", "'");
|
||
|
|
// The separator "\n\n" indicates a new line in the text.
|
||
|
|
String[] lines = processed.split("\\\\n\\\\n");
|
||
|
|
WrappedTextInfo result = new WrappedTextInfo();
|
||
|
|
for (String line : lines) {
|
||
|
|
result.addLines(wrapText(line, metrics));
|
||
|
|
}
|
||
|
|
|
||
|
|
return result;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Encodes the information of the text image for |locale|. According to minui/resources.cpp, the
|
||
|
|
* width, height and locale of the image is decoded as: int w = (row[1] << 8) | row[0]; int h =
|
||
|
|
* (row[3] << 8) | row[2]; __unused int len = row[4]; char* loc =
|
||
|
|
* reinterpret_cast<char*>(&row[5]);
|
||
|
|
*/
|
||
|
|
private List<Integer> encodeTextInfo(int width, int height, String locale) {
|
||
|
|
List<Integer> info =
|
||
|
|
new ArrayList<>(
|
||
|
|
Arrays.asList(
|
||
|
|
width & 0xff,
|
||
|
|
width >> 8,
|
||
|
|
height & 0xff,
|
||
|
|
height >> 8,
|
||
|
|
locale.length()));
|
||
|
|
|
||
|
|
byte[] localeBytes = locale.getBytes();
|
||
|
|
for (byte b : localeBytes) {
|
||
|
|
info.add((int) b);
|
||
|
|
}
|
||
|
|
info.add(0);
|
||
|
|
|
||
|
|
return info;
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Returns Graphics2D object that uses the given locale. */
|
||
|
|
private Graphics2D createGraphics(Locale locale) throws IOException, FontFormatException {
|
||
|
|
Graphics2D graphics = mBufferedImage.createGraphics();
|
||
|
|
graphics.setColor(Color.WHITE);
|
||
|
|
graphics.setRenderingHint(
|
||
|
|
RenderingHints.KEY_TEXT_ANTIALIASING, RenderingHints.VALUE_TEXT_ANTIALIAS_GASP);
|
||
|
|
graphics.setFont(loadFontsByLocale(locale.getLanguage()));
|
||
|
|
|
||
|
|
return graphics;
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Returns the maximum screen width needed to fit the given text after wrapping. */
|
||
|
|
private int measureTextWidth(String text, Locale locale)
|
||
|
|
throws IOException, FontFormatException {
|
||
|
|
Graphics2D graphics = createGraphics(locale);
|
||
|
|
FontMetrics fontMetrics = graphics.getFontMetrics();
|
||
|
|
WrappedTextInfo wrappedTextInfo = processAndWrapText(text, fontMetrics);
|
||
|
|
|
||
|
|
int textWidth = 0;
|
||
|
|
for (WrappedTextInfo.LineInfo lineInfo : wrappedTextInfo.mWrappedLines) {
|
||
|
|
textWidth = Math.max(textWidth, lineInfo.mLineWidth);
|
||
|
|
}
|
||
|
|
|
||
|
|
// This may happen if one single word is larger than the image width.
|
||
|
|
if (textWidth > mImageWidth) {
|
||
|
|
throw new IllegalStateException(
|
||
|
|
"Wrapped text width "
|
||
|
|
+ textWidth
|
||
|
|
+ " is larger than image width "
|
||
|
|
+ mImageWidth
|
||
|
|
+ " for locale: "
|
||
|
|
+ locale);
|
||
|
|
}
|
||
|
|
|
||
|
|
return textWidth;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Draws the text string on the canvas for given locale.
|
||
|
|
*
|
||
|
|
* @param text the string to draw on canvas
|
||
|
|
* @param locale the current locale tag of the string to draw
|
||
|
|
* @throws IOException if we cannot find the corresponding font file for the given locale.
|
||
|
|
* @throws FontFormatException if we failed to load the font file for the given locale.
|
||
|
|
*/
|
||
|
|
private void drawText(String text, Locale locale, String languageTag)
|
||
|
|
throws IOException, FontFormatException {
|
||
|
|
LOGGER.info("Encoding \"" + locale + "\" as \"" + languageTag + "\": " + text);
|
||
|
|
|
||
|
|
Graphics2D graphics = createGraphics(locale);
|
||
|
|
FontMetrics fontMetrics = graphics.getFontMetrics();
|
||
|
|
WrappedTextInfo wrappedTextInfo = processAndWrapText(text, fontMetrics);
|
||
|
|
|
||
|
|
// Marks the start y offset for the text image of current locale; and reserves one line to
|
||
|
|
// encode the image metadata.
|
||
|
|
int currentImageStart = mVerticalOffset;
|
||
|
|
mVerticalOffset += 1;
|
||
|
|
for (WrappedTextInfo.LineInfo lineInfo : wrappedTextInfo.mWrappedLines) {
|
||
|
|
int lineHeight = fontMetrics.getHeight();
|
||
|
|
// Doubles the height of the image if we are short of space.
|
||
|
|
if (mVerticalOffset + lineHeight >= mImageHeight) {
|
||
|
|
resize(mImageWidth, mImageHeight * 2);
|
||
|
|
// Recreates the graphics since it's attached to the buffered image.
|
||
|
|
graphics = createGraphics(locale);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Draws the text at mVerticalOffset and increments the offset with line space.
|
||
|
|
int baseLine = mVerticalOffset + lineHeight - fontMetrics.getDescent();
|
||
|
|
|
||
|
|
// Draws from right if it's an RTL language.
|
||
|
|
int x =
|
||
|
|
mCenterAlignment
|
||
|
|
? (mImageWidth - lineInfo.mLineWidth) / 2
|
||
|
|
: RTL_LANGUAGE.contains(languageTag)
|
||
|
|
? mImageWidth - lineInfo.mLineWidth
|
||
|
|
: 0;
|
||
|
|
graphics.drawString(lineInfo.mLineContent.getIterator(), x, baseLine);
|
||
|
|
|
||
|
|
mVerticalOffset += lineHeight;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Encodes the metadata of the current localized image as pixels.
|
||
|
|
int currentImageHeight = mVerticalOffset - currentImageStart - 1;
|
||
|
|
List<Integer> info = encodeTextInfo(mImageWidth, currentImageHeight, languageTag);
|
||
|
|
for (int i = 0; i < info.size(); i++) {
|
||
|
|
int[] pixel = {info.get(i)};
|
||
|
|
mBufferedImage.getRaster().setPixel(i, currentImageStart, pixel);
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Redraws the image with the new width and new height.
|
||
|
|
*
|
||
|
|
* @param width the new width of the image in pixels.
|
||
|
|
* @param height the new height of the image in pixels.
|
||
|
|
*/
|
||
|
|
private void resize(int width, int height) {
|
||
|
|
BufferedImage resizedImage = new BufferedImage(width, height, BufferedImage.TYPE_BYTE_GRAY);
|
||
|
|
Graphics2D graphic = resizedImage.createGraphics();
|
||
|
|
graphic.drawImage(mBufferedImage, 0, 0, null);
|
||
|
|
graphic.dispose();
|
||
|
|
|
||
|
|
mBufferedImage = resizedImage;
|
||
|
|
mImageWidth = width;
|
||
|
|
mImageHeight = height;
|
||
|
|
}
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This function draws the font characters and saves the result to outputPath.
|
||
|
|
*
|
||
|
|
* @param localizedTextMap a map from locale to its translated text string
|
||
|
|
* @param outputPath the path to write the generated image file.
|
||
|
|
* @throws FontFormatException if there's a format error in one of the font file
|
||
|
|
* @throws IOException if we cannot find the font file for one of the locale, or we failed to
|
||
|
|
* write the image file.
|
||
|
|
*/
|
||
|
|
public void generateImage(Map<Locale, String> localizedTextMap, String outputPath)
|
||
|
|
throws FontFormatException, IOException {
|
||
|
|
FontMetrics defaultFontMetrics =
|
||
|
|
createGraphics(Locale.forLanguageTag("en")).getFontMetrics();
|
||
|
|
mDefaultFont = defaultFontMetrics.getFont();
|
||
|
|
mAndroidStringWidth = defaultFontMetrics.stringWidth(ANDROID_STRING);
|
||
|
|
|
||
|
|
// The last country variant should be the fallback locale for a given language.
|
||
|
|
Map<String, Locale> fallbackLocaleMap = new HashMap<>();
|
||
|
|
int textWidth = 0;
|
||
|
|
for (Locale locale : localizedTextMap.keySet()) {
|
||
|
|
// Updates the fallback locale if we have a new language variant. Don't do it for en-XC
|
||
|
|
// as it's a pseudo-locale.
|
||
|
|
if (!locale.toLanguageTag().equals("en-XC")) {
|
||
|
|
fallbackLocaleMap.put(locale.getLanguage(), locale);
|
||
|
|
}
|
||
|
|
textWidth = Math.max(textWidth, measureTextWidth(localizedTextMap.get(locale), locale));
|
||
|
|
}
|
||
|
|
|
||
|
|
// Removes the black margins to reduce the size of the image.
|
||
|
|
resize(textWidth, mImageHeight);
|
||
|
|
|
||
|
|
for (Locale locale : localizedTextMap.keySet()) {
|
||
|
|
// Recovery expects en-US instead of en_US.
|
||
|
|
String languageTag = locale.toLanguageTag();
|
||
|
|
Locale fallbackLocale = fallbackLocaleMap.get(locale.getLanguage());
|
||
|
|
if (locale.equals(fallbackLocale)) {
|
||
|
|
// Makes the last country variant for a given language be the catch-all for that
|
||
|
|
// language.
|
||
|
|
languageTag = locale.getLanguage();
|
||
|
|
} else if (localizedTextMap.get(locale).equals(localizedTextMap.get(fallbackLocale))) {
|
||
|
|
LOGGER.info("Skip parsing text for duplicate locale " + locale);
|
||
|
|
continue;
|
||
|
|
}
|
||
|
|
|
||
|
|
drawText(localizedTextMap.get(locale), locale, languageTag);
|
||
|
|
}
|
||
|
|
|
||
|
|
resize(mImageWidth, mVerticalOffset);
|
||
|
|
ImageIO.write(mBufferedImage, "png", new File(outputPath));
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Prints the helper message. */
|
||
|
|
public static void printUsage(Options options) {
|
||
|
|
new HelpFormatter().printHelp("java -jar path_to_jar [required_options]", options);
|
||
|
|
}
|
||
|
|
|
||
|
|
/** Creates the command line options. */
|
||
|
|
public static Options createOptions() {
|
||
|
|
Options options = new Options();
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("image_width")
|
||
|
|
.withDescription("The initial width of the image in pixels.")
|
||
|
|
.hasArgs(1)
|
||
|
|
.isRequired()
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("text_name")
|
||
|
|
.withDescription(
|
||
|
|
"The description of the text string, e.g. recovery_erasing")
|
||
|
|
.hasArgs(1)
|
||
|
|
.isRequired()
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("font_dir")
|
||
|
|
.withDescription(
|
||
|
|
"The directory that contains all the support font format files, "
|
||
|
|
+ "e.g. $OUT/system/fonts/")
|
||
|
|
.hasArgs(1)
|
||
|
|
.isRequired()
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("resource_dir")
|
||
|
|
.withDescription(
|
||
|
|
"The resource directory that contains all the translated strings in"
|
||
|
|
+ " xml format, e.g."
|
||
|
|
+ " bootable/recovery/tools/recovery_l10n/res/")
|
||
|
|
.hasArgs(1)
|
||
|
|
.isRequired()
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("output_file")
|
||
|
|
.withDescription("Path to the generated image.")
|
||
|
|
.hasArgs(1)
|
||
|
|
.isRequired()
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("center_alignment")
|
||
|
|
.withDescription("Align the text in the center of the screen.")
|
||
|
|
.hasArg(false)
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("verbose")
|
||
|
|
.withDescription("Output the logging above info level.")
|
||
|
|
.hasArg(false)
|
||
|
|
.create());
|
||
|
|
|
||
|
|
options.addOption(
|
||
|
|
OptionBuilder.withLongOpt("locales")
|
||
|
|
.withDescription("A list of android locales separated by ',' e.g."
|
||
|
|
+ " 'af,en,zh-rTW'")
|
||
|
|
.hasArg(true)
|
||
|
|
.create());
|
||
|
|
|
||
|
|
return options;
|
||
|
|
}
|
||
|
|
|
||
|
|
/** The main function parses the command line options and generates the desired text image. */
|
||
|
|
public static void main(String[] args)
|
||
|
|
throws NumberFormatException, IOException, FontFormatException,
|
||
|
|
LocalizedStringNotFoundException {
|
||
|
|
Options options = createOptions();
|
||
|
|
CommandLine cmd;
|
||
|
|
try {
|
||
|
|
cmd = new GnuParser().parse(options, args);
|
||
|
|
} catch (ParseException e) {
|
||
|
|
System.err.println(e.getMessage());
|
||
|
|
printUsage(options);
|
||
|
|
return;
|
||
|
|
}
|
||
|
|
|
||
|
|
int imageWidth = Integer.parseUnsignedInt(cmd.getOptionValue("image_width"));
|
||
|
|
|
||
|
|
if (cmd.hasOption("verbose")) {
|
||
|
|
LOGGER.setLevel(Level.INFO);
|
||
|
|
} else {
|
||
|
|
LOGGER.setLevel(Level.WARNING);
|
||
|
|
}
|
||
|
|
|
||
|
|
ImageGenerator imageGenerator =
|
||
|
|
new ImageGenerator(
|
||
|
|
imageWidth,
|
||
|
|
cmd.getOptionValue("text_name"),
|
||
|
|
DEFAULT_FONT_SIZE,
|
||
|
|
cmd.getOptionValue("font_dir"),
|
||
|
|
cmd.hasOption("center_alignment"));
|
||
|
|
|
||
|
|
Set<String> localesSet = null;
|
||
|
|
if (cmd.hasOption("locales")) {
|
||
|
|
String[] localesList = cmd.getOptionValue("locales").split(",");
|
||
|
|
localesSet = new HashSet<>(Arrays.asList(localesList));
|
||
|
|
// Ensures that we have the default locale, all english translations are identical.
|
||
|
|
localesSet.add("en-rAU");
|
||
|
|
}
|
||
|
|
Map<Locale, String> localizedStringMap =
|
||
|
|
imageGenerator.readLocalizedStringFromXmls(cmd.getOptionValue("resource_dir"),
|
||
|
|
localesSet);
|
||
|
|
imageGenerator.generateImage(localizedStringMap, cmd.getOptionValue("output_file"));
|
||
|
|
}
|
||
|
|
}
|