/* * Copyright (C) 2010 Google Inc. * * 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.inputmethod.keyboard; import com.android.inputmethod.latin.R; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; import android.content.res.Resources; import android.content.res.TypedArray; import android.content.res.XmlResourceParser; import android.util.Log; import android.util.TypedValue; import android.util.Xml; import android.view.InflateException; import java.io.IOException; import java.util.Arrays; import java.util.List; /** * Parser for BaseKeyboard. * * This class parses Keyboard XML file and fill out keys in Keyboard. * The Keyboard XML file looks like: *
 *   >!-- xml/keyboard.xml --<
 *   >Keyboard keyboard_attributes*<
 *     >!-- Keyboard Content --<
 *     >Row row_attributes*<
 *       >!-- Row Content --<
 *       >Key key_attributes* /<
 *       >Spacer horizontalGap="0.2in" /<
 *       >include keyboardLayout="@xml/other_keys"<
 *       ...
 *     >/Row<
 *     >include keyboardLayout="@xml/other_rows"<
 *     ...
 *   >/Keyboard<
 * 
* The XML file which is included in other file must have >merge< as root element, such as: *
 *   >!-- xml/other_keys.xml --<
 *   >merge<
 *     >Key key_attributes* /<
 *     ...
 *   >/merge<
 * 
* and *
 *   >!-- xml/other_rows.xml --<
 *   >merge<
 *     >Row row_attributes*<
 *       >Key key_attributes* /<
 *     >/Row<
 *     ...
 *   >/merge<
 * 
* You can also use switch-case-default tags to select Rows and Keys. *
 *   >switch<
 *     >case case_attribute*<
 *       >!-- Any valid tags at switch position --<
 *     >/case<
 *     ...
 *     >default<
 *       >!-- Any valid tags at switch position --<
 *     >/default<
 *   >/switch<
 * 
* You can declare Key style and specify styles within Key tags. *
 *     >switch<
 *       >case colorScheme="white"<
 *         >key-style styleName="shift-key" parentStyle="modifier-key"
 *           keyIcon="@drawable/sym_keyboard_shift"
 *         /<
 *       >/case<
 *       >case colorScheme="black"<
 *         >key-style styleName="shift-key" parentStyle="modifier-key"
 *           keyIcon="@drawable/sym_bkeyboard_shift"
 *         /<
 *       >/case<
 *     >/switch<
 *     ...
 *     >Key keyStyle="shift-key" ... /<
 * 
*/ public class KeyboardParser { private static final String TAG = "KeyboardParser"; private static final boolean DEBUG = false; // Keyboard XML Tags private static final String TAG_KEYBOARD = "Keyboard"; private static final String TAG_ROW = "Row"; private static final String TAG_KEY = "Key"; private static final String TAG_SPACER = "Spacer"; private static final String TAG_INCLUDE = "include"; private static final String TAG_MERGE = "merge"; private static final String TAG_SWITCH = "switch"; private static final String TAG_CASE = "case"; private static final String TAG_DEFAULT = "default"; public static final String TAG_KEY_STYLE = "key-style"; private final Keyboard mKeyboard; private final Resources mResources; private int mCurrentX = 0; private int mCurrentY = 0; private int mMaxRowWidth = 0; private int mTotalHeight = 0; private Row mCurrentRow = null; private final KeyStyles mKeyStyles = new KeyStyles(); public KeyboardParser(Keyboard keyboard, Resources res) { mKeyboard = keyboard; mResources = res; } public int getMaxRowWidth() { return mMaxRowWidth; } public int getTotalHeight() { return mTotalHeight; } public void parseKeyboard(int resId) throws XmlPullParserException, IOException { if (DEBUG) Log.d(TAG, String.format("<%s> %s", TAG_KEYBOARD, mKeyboard.mId)); final XmlResourceParser parser = mResources.getXml(resId); int event; while ((event = parser.next()) != XmlPullParser.END_DOCUMENT) { if (event == XmlPullParser.START_TAG) { final String tag = parser.getName(); if (TAG_KEYBOARD.equals(tag)) { parseKeyboardAttributes(parser); parseKeyboardContent(parser, mKeyboard.getKeys()); break; } else { throw new IllegalStartTag(parser, TAG_KEYBOARD); } } } } private void parseKeyboardAttributes(XmlResourceParser parser) { final Keyboard keyboard = mKeyboard; final TypedArray keyboardAttr = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard); final TypedArray keyAttr = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard_Key); try { final int displayHeight = keyboard.getDisplayHeight(); final int keyboardHeight = (int)keyboardAttr.getDimension( R.styleable.Keyboard_keyboardHeight, displayHeight / 2); final int maxKeyboardHeight = getDimensionOrFraction(keyboardAttr, R.styleable.Keyboard_maxKeyboardHeight, displayHeight, displayHeight / 2); // Keyboard height will not exceed maxKeyboardHeight. final int height = Math.min(keyboardHeight, maxKeyboardHeight); final int width = keyboard.getDisplayWidth(); keyboard.setKeyboardHeight(height); keyboard.setKeyWidth(getDimensionOrFraction(keyboardAttr, R.styleable.Keyboard_keyWidth, width, width / 10)); keyboard.setRowHeight(getDimensionOrFraction(keyboardAttr, R.styleable.Keyboard_rowHeight, height, 50)); keyboard.setHorizontalGap(getDimensionOrFraction(keyboardAttr, R.styleable.Keyboard_horizontalGap, width, 0)); keyboard.setVerticalGap(getDimensionOrFraction(keyboardAttr, R.styleable.Keyboard_verticalGap, height, 0)); keyboard.setPopupKeyboardResId(keyboardAttr.getResourceId( R.styleable.Keyboard_popupKeyboardTemplate, 0)); keyboard.setMaxPopupKeyboardColumn(keyAttr.getInt( R.styleable.Keyboard_Key_maxPopupKeyboardColumn, 5)); } finally { keyAttr.recycle(); keyboardAttr.recycle(); } } private void parseKeyboardContent(XmlResourceParser parser, List keys) throws XmlPullParserException, IOException { int event; while ((event = parser.next()) != XmlPullParser.END_DOCUMENT) { if (event == XmlPullParser.START_TAG) { final String tag = parser.getName(); if (TAG_ROW.equals(tag)) { Row row = new Row(mResources, mKeyboard, parser); if (DEBUG) Log.d(TAG, String.format("<%s>", TAG_ROW)); if (keys != null) startRow(row); parseRowContent(parser, row, keys); } else if (TAG_INCLUDE.equals(tag)) { parseIncludeKeyboardContent(parser, keys); } else if (TAG_SWITCH.equals(tag)) { parseSwitchKeyboardContent(parser, keys); } else if (TAG_KEY_STYLE.equals(tag)) { parseKeyStyle(parser, keys); } else { throw new IllegalStartTag(parser, TAG_ROW); } } else if (event == XmlPullParser.END_TAG) { final String tag = parser.getName(); if (TAG_KEYBOARD.equals(tag)) { endKeyboard(mKeyboard.getVerticalGap()); break; } else if (TAG_CASE.equals(tag) || TAG_DEFAULT.equals(tag) || TAG_MERGE.equals(tag)) { if (DEBUG) Log.d(TAG, String.format("", tag)); break; } else if (TAG_KEY_STYLE.equals(tag)) { continue; } else { throw new IllegalEndTag(parser, TAG_ROW); } } } } private void parseRowContent(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { int event; while ((event = parser.next()) != XmlPullParser.END_DOCUMENT) { if (event == XmlPullParser.START_TAG) { final String tag = parser.getName(); if (TAG_KEY.equals(tag)) { parseKey(parser, row, keys); } else if (TAG_SPACER.equals(tag)) { parseSpacer(parser, keys); } else if (TAG_INCLUDE.equals(tag)) { parseIncludeRowContent(parser, row, keys); } else if (TAG_SWITCH.equals(tag)) { parseSwitchRowContent(parser, row, keys); } else if (TAG_KEY_STYLE.equals(tag)) { parseKeyStyle(parser, keys); } else { throw new IllegalStartTag(parser, TAG_KEY); } } else if (event == XmlPullParser.END_TAG) { final String tag = parser.getName(); if (TAG_ROW.equals(tag)) { if (DEBUG) Log.d(TAG, String.format("", TAG_ROW)); if (keys != null) endRow(); break; } else if (TAG_CASE.equals(tag) || TAG_DEFAULT.equals(tag) || TAG_MERGE.equals(tag)) { if (DEBUG) Log.d(TAG, String.format("", tag)); break; } else if (TAG_KEY_STYLE.equals(tag)) { continue; } else { throw new IllegalEndTag(parser, TAG_KEY); } } } } private void parseKey(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { if (keys == null) { checkEndTag(TAG_KEY, parser); } else { Key key = new Key(mResources, row, mCurrentX, mCurrentY, parser, mKeyStyles); if (DEBUG) Log.d(TAG, String.format("<%s keyLabel=%s code=%d popupCharacters=%s />", TAG_KEY, key.mLabel, key.mCode, Arrays.toString(key.mPopupCharacters))); checkEndTag(TAG_KEY, parser); keys.add(key); if (key.mCode == Keyboard.CODE_SHIFT) mKeyboard.getShiftKeys().add(key); endKey(key); } } private void parseSpacer(XmlResourceParser parser, List keys) throws XmlPullParserException, IOException { if (keys == null) { checkEndTag(TAG_SPACER, parser); } else { if (DEBUG) Log.d(TAG, String.format("<%s />", TAG_SPACER)); final TypedArray a = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard); final int gap = getDimensionOrFraction(a, R.styleable.Keyboard_horizontalGap, mKeyboard.getDisplayWidth(), 0); a.recycle(); checkEndTag(TAG_SPACER, parser); setSpacer(gap); } } private void parseIncludeKeyboardContent(XmlResourceParser parser, List keys) throws XmlPullParserException, IOException { parseIncludeInternal(parser, null, keys); } private void parseIncludeRowContent(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { parseIncludeInternal(parser, row, keys); } private void parseIncludeInternal(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { if (keys == null) { checkEndTag(TAG_INCLUDE, parser); } else { final TypedArray a = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard_Include); final int keyboardLayout = a.getResourceId( R.styleable.Keyboard_Include_keyboardLayout, 0); a.recycle(); checkEndTag(TAG_INCLUDE, parser); if (keyboardLayout == 0) throw new ParseException("No keyboardLayout attribute in ", parser); if (DEBUG) Log.d(TAG, String.format("<%s keyboardLayout=%s />", TAG_INCLUDE, mResources.getResourceEntryName(keyboardLayout))); parseMerge(mResources.getLayout(keyboardLayout), row, keys); } } private void parseMerge(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { int event; while ((event = parser.next()) != XmlPullParser.END_DOCUMENT) { if (event == XmlPullParser.START_TAG) { final String tag = parser.getName(); if (TAG_MERGE.equals(tag)) { if (row == null) { parseKeyboardContent(parser, keys); } else { parseRowContent(parser, row, keys); } break; } else { throw new ParseException( "Included keyboard layout must have root element", parser); } } } } private void parseSwitchKeyboardContent(XmlResourceParser parser, List keys) throws XmlPullParserException, IOException { parseSwitchInternal(parser, null, keys); } private void parseSwitchRowContent(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { parseSwitchInternal(parser, row, keys); } private void parseSwitchInternal(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { if (DEBUG) Log.d(TAG, String.format("<%s> %s", TAG_SWITCH, mKeyboard.mId)); boolean selected = false; int event; while ((event = parser.next()) != XmlPullParser.END_DOCUMENT) { if (event == XmlPullParser.START_TAG) { final String tag = parser.getName(); if (TAG_CASE.equals(tag)) { selected |= parseCase(parser, row, selected ? null : keys); } else if (TAG_DEFAULT.equals(tag)) { selected |= parseDefault(parser, row, selected ? null : keys); } else { throw new IllegalStartTag(parser, TAG_KEY); } } else if (event == XmlPullParser.END_TAG) { final String tag = parser.getName(); if (TAG_SWITCH.equals(tag)) { if (DEBUG) Log.d(TAG, String.format("", TAG_SWITCH)); break; } else { throw new IllegalEndTag(parser, TAG_KEY); } } } } private boolean parseCase(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { final boolean selected = parseCaseCondition(parser); if (row == null) { // Processing Rows. parseKeyboardContent(parser, selected ? keys : null); } else { // Processing Keys. parseRowContent(parser, row, selected ? keys : null); } return selected; } private boolean parseCaseCondition(XmlResourceParser parser) { final KeyboardId id = mKeyboard.mId; if (id == null) return true; final TypedArray a = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard_Case); final TypedArray viewAttr = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.KeyboardView); try { final boolean modeMatched = matchInteger(a, R.styleable.Keyboard_Case_mode, id.mMode); final boolean settingsKeyMatched = matchBoolean(a, R.styleable.Keyboard_Case_hasSettingsKey, id.mHasSettingsKey); final boolean voiceEnabledMatched = matchBoolean(a, R.styleable.Keyboard_Case_voiceKeyEnabled, id.mVoiceKeyEnabled); final boolean voiceKeyMatched = matchBoolean(a, R.styleable.Keyboard_Case_hasVoiceKey, id.mHasVoiceKey); final boolean colorSchemeMatched = matchInteger(viewAttr, R.styleable.KeyboardView_colorScheme, id.mColorScheme); // As noted at KeyboardSwitcher.KeyboardId class, we are interested only in // enum value masked by IME_MASK_ACTION and IME_FLAG_NO_ENTER_ACTION. So matching // this attribute with id.mImeOptions as integer value is enough for our purpose. final boolean imeOptionsMatched = matchInteger(a, R.styleable.Keyboard_Case_imeOptions, id.mImeOptions); final boolean selected = modeMatched && settingsKeyMatched && voiceEnabledMatched && voiceKeyMatched && colorSchemeMatched && imeOptionsMatched; if (DEBUG) Log.d(TAG, String.format("<%s%s%s%s%s%s%s> %s", TAG_CASE, textAttr(KeyboardId.modeName( a.getInt(R.styleable.Keyboard_Case_mode, -1)), "mode"), textAttr(KeyboardId.colorSchemeName( a.getInt(R.styleable.KeyboardView_colorScheme, -1)), "colorSchemeName"), booleanAttr(a, R.styleable.Keyboard_Case_hasSettingsKey, "hasSettingsKey"), booleanAttr(a, R.styleable.Keyboard_Case_voiceKeyEnabled, "voiceKeyEnabled"), booleanAttr(a, R.styleable.Keyboard_Case_hasVoiceKey, "hasVoiceKey"), textAttr(KeyboardId.imeOptionsName( a.getInt(R.styleable.Keyboard_Case_imeOptions, -1)), "imeOptions"), Boolean.toString(selected))); return selected; } finally { a.recycle(); viewAttr.recycle(); } } private static boolean matchInteger(TypedArray a, int index, int value) { // If does not have "index" attribute, that means this is wild-card for the // attribute. return !a.hasValue(index) || a.getInt(index, 0) == value; } private static boolean matchBoolean(TypedArray a, int index, boolean value) { // If does not have "index" attribute, that means this is wild-card for the // attribute. return !a.hasValue(index) || a.getBoolean(index, false) == value; } private boolean parseDefault(XmlResourceParser parser, Row row, List keys) throws XmlPullParserException, IOException { if (DEBUG) Log.d(TAG, String.format("<%s>", TAG_DEFAULT)); if (row == null) { parseKeyboardContent(parser, keys); } else { parseRowContent(parser, row, keys); } return true; } private void parseKeyStyle(XmlResourceParser parser, List keys) { TypedArray keyStyleAttr = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard_KeyStyle); TypedArray keyAttrs = mResources.obtainAttributes(Xml.asAttributeSet(parser), R.styleable.Keyboard_Key); try { if (!keyStyleAttr.hasValue(R.styleable.Keyboard_KeyStyle_styleName)) throw new ParseException("<" + TAG_KEY_STYLE + "/> needs styleName attribute", parser); if (keys != null) mKeyStyles.parseKeyStyleAttributes(keyStyleAttr, keyAttrs, parser); } finally { keyStyleAttr.recycle(); keyAttrs.recycle(); } } private static void checkEndTag(String tag, XmlResourceParser parser) throws XmlPullParserException, IOException { if (parser.next() == XmlPullParser.END_TAG && tag.equals(parser.getName())) return; throw new NonEmptyTag(tag, parser); } private void startRow(Row row) { mCurrentX = 0; mCurrentRow = row; } private void endRow() { if (mCurrentRow == null) throw new InflateException("orphant end row tag"); mCurrentY += mCurrentRow.mDefaultHeight; mCurrentRow = null; } private void endKey(Key key) { mCurrentX += key.mGap + key.mWidth; if (mCurrentX > mMaxRowWidth) mMaxRowWidth = mCurrentX; } private void endKeyboard(int defaultVerticalGap) { mTotalHeight = mCurrentY - defaultVerticalGap; } private void setSpacer(int gap) { mCurrentX += gap; } public static int getDimensionOrFraction(TypedArray a, int index, int base, int defValue) { final TypedValue value = a.peekValue(index); if (value == null) return defValue; if (value.type == TypedValue.TYPE_DIMENSION) { return a.getDimensionPixelOffset(index, defValue); } else if (value.type == TypedValue.TYPE_FRACTION) { // Round it to avoid values like 47.9999 from getting truncated return Math.round(a.getFraction(index, base, base, defValue)); } return defValue; } @SuppressWarnings("serial") public static class ParseException extends InflateException { public ParseException(String msg, XmlResourceParser parser) { super(msg + " at line " + parser.getLineNumber()); } } @SuppressWarnings("serial") private static class IllegalStartTag extends ParseException { public IllegalStartTag(XmlResourceParser parser, String parent) { super("Illegal start tag " + parser.getName() + " in " + parent, parser); } } @SuppressWarnings("serial") private static class IllegalEndTag extends ParseException { public IllegalEndTag(XmlResourceParser parser, String parent) { super("Illegal end tag " + parser.getName() + " in " + parent, parser); } } @SuppressWarnings("serial") private static class NonEmptyTag extends ParseException { public NonEmptyTag(String tag, XmlResourceParser parser) { super(tag + " must be empty tag", parser); } } private static String textAttr(String value, String name) { return value != null ? String.format(" %s=%s", name, value) : ""; } private static String booleanAttr(TypedArray a, int index, String name) { return a.hasValue(index) ? String.format(" %s=%s", name, a.getBoolean(index, false)) : ""; } }