KeySpecParser.java revision 8632bff2d5a8e1160989008dea6eff4b94b065dd
19b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka/* 28632bff2d5a8e1160989008dea6eff4b94b065ddTadashi G. Takaoka * Copyright (C) 2010 The Android Open Source Project 39b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * 49b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * Licensed under the Apache License, Version 2.0 (the "License"); you may not 59b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * use this file except in compliance with the License. You may obtain a copy of 69b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * the License at 79b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * 89b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * http://www.apache.org/licenses/LICENSE-2.0 99b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * 109b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * Unless required by applicable law or agreed to in writing, software 119b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT 129b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the 139b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * License for the specific language governing permissions and limitations under 149b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * the License. 159b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka */ 169b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 179b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaokapackage com.android.inputmethod.keyboard; 189b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 199b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaokaimport com.android.inputmethod.latin.R; 209b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 219b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaokaimport android.content.res.Resources; 229b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaokaimport android.graphics.drawable.Drawable; 239b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaokaimport android.text.TextUtils; 249b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 259b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka/** 269b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * String parser of popupCharacters attribute of Key. 279b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * The string is comma separated texts each of which represents one popup key. 289b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * Each popup key text is one of the following: 299b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * - A single letter (Letter) 309b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * - Label optionally followed by keyOutputText or code (keyLabel|keyOutputText). 319b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * - Icon followed by keyOutputText or code (@drawable/icon|@integer/key_code) 329b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * Special character, comma ',' backslash '\', and bar '|' can be escaped by '\' 339b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * character. 349b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka * Note that the character '@' and '\' are also parsed by XML parser and CSV parser as well. 359b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka */ 369b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaokapublic class PopupCharactersParser { 379b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static final char ESCAPE = '\\'; 389b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static final String LABEL_END = "|"; 399b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static final String PREFIX_AT = "@"; 409b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static final String PREFIX_ICON = PREFIX_AT + "drawable/"; 419b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static final String PREFIX_CODE = PREFIX_AT + "integer/"; 429b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 439b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private PopupCharactersParser() { 449b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka // Intentional empty constructor for utility class. 459b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 469b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 479b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static boolean hasIcon(String popupSpec) { 489b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (popupSpec.startsWith(PREFIX_ICON)) { 499b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int end = indexOfLabelEnd(popupSpec, 0); 509b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (end > 0) 519b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return true; 529b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("outputText or code not specified: " + popupSpec); 539b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 549b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return false; 559b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 569b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 579b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static boolean hasCode(String popupSpec) { 589b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int end = indexOfLabelEnd(popupSpec, 0); 599b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (end > 0 && end + 1 < popupSpec.length() 609b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka && popupSpec.substring(end + 1).startsWith(PREFIX_CODE)) { 619b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return true; 629b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 639b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return false; 649b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 659b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 669b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static String parseEscape(String text) { 679b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (text.indexOf(ESCAPE) < 0) 689b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return text; 699b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int length = text.length(); 709b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final StringBuilder sb = new StringBuilder(); 719b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka for (int pos = 0; pos < length; pos++) { 729b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final char c = text.charAt(pos); 739b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (c == ESCAPE && pos + 1 < length) { 749b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka sb.append(text.charAt(++pos)); 759b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } else { 769b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka sb.append(c); 779b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 789b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 799b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return sb.toString(); 809b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 819b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 829b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static int indexOfLabelEnd(String popupSpec, int start) { 839b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (popupSpec.indexOf(ESCAPE, start) < 0) { 849b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int end = popupSpec.indexOf(LABEL_END, start); 859b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (end == 0) 869b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError(LABEL_END + " at " + start + ": " + popupSpec); 879b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return end; 889b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 899b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int length = popupSpec.length(); 909b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka for (int pos = start; pos < length; pos++) { 919b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final char c = popupSpec.charAt(pos); 929b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (c == ESCAPE && pos + 1 < length) { 939b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka pos++; 949b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } else if (popupSpec.startsWith(LABEL_END, pos)) { 959b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return pos; 969b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 979b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 989b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return -1; 999b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1009b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 1019b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka public static String getLabel(String popupSpec) { 1029b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (hasIcon(popupSpec)) 1039b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return null; 1049b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int end = indexOfLabelEnd(popupSpec, 0); 1059b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final String label = (end > 0) ? parseEscape(popupSpec.substring(0, end)) 1069b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka : parseEscape(popupSpec); 1079b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (TextUtils.isEmpty(label)) 1089b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("Empty label: " + popupSpec); 1099b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return label; 1109b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1119b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 1129b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka public static String getOutputText(String popupSpec) { 1139b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (hasCode(popupSpec)) 1149b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return null; 1159b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int end = indexOfLabelEnd(popupSpec, 0); 1169b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (end > 0) { 1179b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (indexOfLabelEnd(popupSpec, end + 1) >= 0) 1189b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("Multiple " + LABEL_END + ": " 1199b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka + popupSpec); 1209b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final String outputText = parseEscape(popupSpec.substring(end + LABEL_END.length())); 1219b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (!TextUtils.isEmpty(outputText)) 1229b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return outputText; 1239b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("Empty outputText: " + popupSpec); 1249b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1259b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final String label = getLabel(popupSpec); 1269b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (label == null) 1279b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("Empty label: " + popupSpec); 128c4f71668d7b8203dc66f0f04c089a363189eb4ceTadashi G. Takaoka // Code is automatically generated for one letter label. See {@link getCode()}. 1299b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (label.length() == 1) 1309b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return null; 1319b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return label; 1329b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1339b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 134c4f71668d7b8203dc66f0f04c089a363189eb4ceTadashi G. Takaoka public static int getCode(Resources res, String popupSpec) { 1359b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (hasCode(popupSpec)) { 1369b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int end = indexOfLabelEnd(popupSpec, 0); 1379b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (indexOfLabelEnd(popupSpec, end + 1) >= 0) 1389b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("Multiple " + LABEL_END + ": " + popupSpec); 1399b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int resId = getResourceId(res, 1409b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka popupSpec.substring(end + LABEL_END.length() + PREFIX_AT.length())); 1419b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final int code = res.getInteger(resId); 142c4f71668d7b8203dc66f0f04c089a363189eb4ceTadashi G. Takaoka return code; 1439b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1449b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (indexOfLabelEnd(popupSpec, 0) > 0) 145c4f71668d7b8203dc66f0f04c089a363189eb4ceTadashi G. Takaoka return Keyboard.CODE_DUMMY; 1469b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka final String label = getLabel(popupSpec); 1479b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka // Code is automatically generated for one letter label. 1489b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (label != null && label.length() == 1) 149c4f71668d7b8203dc66f0f04c089a363189eb4ceTadashi G. Takaoka return label.charAt(0); 150c4f71668d7b8203dc66f0f04c089a363189eb4ceTadashi G. Takaoka return Keyboard.CODE_DUMMY; 1519b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1529b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 1539b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka public static Drawable getIcon(Resources res, String popupSpec) { 1549b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (hasIcon(popupSpec)) { 1559b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka int end = popupSpec.indexOf(LABEL_END, PREFIX_ICON.length() + 1); 1569b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka int resId = getResourceId(res, popupSpec.substring(PREFIX_AT.length(), end)); 1579b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return res.getDrawable(resId); 1589b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1599b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return null; 1609b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1619b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 1629b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka private static int getResourceId(Resources res, String name) { 1639b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka String packageName = res.getResourcePackageName(R.string.english_ime_name); 1649b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka int resId = res.getIdentifier(name, null, packageName); 1659b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka if (resId == 0) 1669b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka throw new PopupCharactersParserError("Unknown resource: " + name); 1679b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka return resId; 1689b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1699b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka 1709b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka @SuppressWarnings("serial") 1719b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka public static class PopupCharactersParserError extends RuntimeException { 1729b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka public PopupCharactersParserError(String message) { 1739b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka super(message); 1749b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1759b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka } 1769b6d1d52d91f8f18952ae3841f4bb0d7309bfc0eTadashi G. Takaoka} 177