Implement temporary upper case hint icon

This change partially implements the requested feature. The following
are not supported yet.
- Non-letter key handling on automatic temporary upper case layout.
- Non-letter key handling on shift chording in caps lock layout.
- Hint icons for manual temporary upper case layout are not final ones.

Bug: 3193390

Change-Id: I636da99d1be05b1337935d87c6f4d140661e1cc8

java/res/values/attrs.xml

@@ -106,12 +106,15 @@
         <attr name="keyOutputText" format="string" />
         <!-- The label to display on the key. -->
         <attr name="keyLabel" format="string" />
-        <!-- The label to display on the key when keyboard is in temporary shift mode. -->
-        <attr name="temporaryShiftKeyLabel" format="string" />
+        <!-- The unicode that this key generates in manual temporary upper case mode. -->
+        <attr name="manualTemporaryUpperCaseCode" format="integer" />
         <!-- The icon to display on the key instead of the label. -->
         <attr name="keyIcon" format="reference" />
         <!-- The hint icon to display on the key in conjunction with the label -->
         <attr name="keyHintIcon" format="reference" />
+        <!-- The hint icon to display on the key when keyboard is in manual temporary upper case
+             mode. -->
+        <attr name="manualTemporaryUpperCaseHintIcon" format="reference" />
     </declare-styleable>
 
     <declare-styleable name="BaseKeyboard_Row">

java/res/xml-xlarge/kbd_qwerty_row2.xml

@@ -66,8 +66,9 @@
             <default>
                 <Key
                     latin:keyLabel="\'"
-                    latin:temporaryShiftKeyLabel="&quot;"
+                    latin:manualTemporaryUpperCaseCode="34"
                     latin:keyHintIcon="@drawable/key_hint_quote_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_quote_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
                     latin:popupCharacters="&quot;" />
             </default>

java/res/xml-xlarge/kbd_qwerty_row3.xml

@@ -64,14 +64,16 @@
             <default>
                 <Key
                     latin:keyLabel=","
-                    latin:temporaryShiftKeyLabel="!"
+                    latin:manualTemporaryUpperCaseCode="33"
                     latin:keyHintIcon="@drawable/key_hint_exclamation_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_exclamation_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
                     latin:popupCharacters="!" />
                 <Key
                     latin:keyLabel="."
-                    latin:temporaryShiftKeyLabel="\?"
+                    latin:manualTemporaryUpperCaseCode="63"
                     latin:keyHintIcon="@drawable/key_hint_question_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_question_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
                     latin:popupCharacters="\?" />
             </default>

java/res/xml-xlarge/kbd_qwerty_row4.xml

@@ -55,10 +55,11 @@
                     latin:popupKeyboard="@xml/popup_smileys" />
                 <Key
                     latin:keyLabel="="
-                    latin:temporaryShiftKeyLabel="+"
+                    latin:manualTemporaryUpperCaseCode="43"
                     latin:keyHintIcon="@drawable/key_hint_plus_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_plus_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
-                    latin:popupCharacters="&gt;" />
+                    latin:popupCharacters="+" />
             </default>
         </switch>
         <Key
@@ -77,8 +78,9 @@
             <default>
                 <Key
                     latin:keyLabel="-"
-                    latin:temporaryShiftKeyLabel="/"
+                    latin:manualTemporaryUpperCaseCode="47"
                     latin:keyHintIcon="@drawable/key_hint_slash_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_slash_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
                     latin:popupCharacters="/" />
             </default>
@@ -95,16 +97,18 @@
             >
                 <Key
                     latin:keyLabel="_"
-                    latin:temporaryShiftKeyLabel=":"
+                    latin:manualTemporaryUpperCaseCode="58"
                     latin:keyHintIcon="@drawable/key_hint_colon_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_colon_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
                     latin:popupCharacters=":" />
             </case>
             <default>
                 <Key
                     latin:keyLabel="_"
-                    latin:temporaryShiftKeyLabel="\@"
+                    latin:manualTemporaryUpperCaseCode="64"
                     latin:keyHintIcon="@drawable/key_hint_at_holo"
+                    latin:manualTemporaryUpperCaseHintIcon="@drawable/key_hint_at_large_holo"
                     latin:popupKeyboard="@xml/kbd_popup_template"
                     latin:popupCharacters="\@" />
             </default>

java/src/com/android/inputmethod/latin/BaseKeyboard.java

@@ -178,17 +178,23 @@ public class BaseKeyboard {
          * being the most important.
          */
         public int[] codes;
+        /** The unicode that this key generates in manual temporary upper case mode. */
+        public int manualTemporaryUpperCaseCode;
 
         /** Label to display */
         public CharSequence label;
-        /** Label to display when keyboard is in temporary shift mode */
-        public CharSequence temporaryShiftLabel;
 
         /** Icon to display instead of a label. Icon takes precedence over a label */
         public Drawable icon;
         /** Hint icon to display on the key in conjunction with the label */
         public Drawable hintIcon;
         /** Preview version of the icon, for the preview popup */
+        /**
+         * The hint icon to display on the key when keyboard is in manual temporary upper case
+         * mode.
+         */
+        public Drawable manualTemporaryUpperCaseHintIcon;
+
         public Drawable iconPreview;
         /** Width of the key, not including the gap */
         public int width;
@@ -320,9 +326,13 @@ public class BaseKeyboard {
             setDefaultBounds(icon);
             hintIcon = a.getDrawable(R.styleable.BaseKeyboard_Key_keyHintIcon);
             setDefaultBounds(hintIcon);
+            manualTemporaryUpperCaseHintIcon = a.getDrawable(
+                    R.styleable.BaseKeyboard_Key_manualTemporaryUpperCaseHintIcon);
+            setDefaultBounds(manualTemporaryUpperCaseHintIcon);
 
             label = a.getText(R.styleable.BaseKeyboard_Key_keyLabel);
-            temporaryShiftLabel = a.getText(R.styleable.BaseKeyboard_Key_temporaryShiftKeyLabel);
+            manualTemporaryUpperCaseCode = a.getInt(
+                    R.styleable.BaseKeyboard_Key_manualTemporaryUpperCaseCode, 0);
             text = a.getText(R.styleable.BaseKeyboard_Key_keyOutputText);
 
             if (codes == null && !TextUtils.isEmpty(label)) {

java/src/com/android/inputmethod/latin/BaseKeyboardView.java

@@ -772,6 +772,8 @@ public class BaseKeyboardView extends View implements PointerTracker.UIProxy {
         final int kbdPaddingTop = getPaddingTop();
         final Key[] keys = mKeys;
         final Key invalidKey = mInvalidatedKey;
+        final boolean isTemporaryUpperCase = (mKeyboard instanceof LatinKeyboard
+                && ((LatinKeyboard)mKeyboard).isTemporaryUpperCase());
 
         paint.setColor(mKeyTextColor);
         boolean drawSingleKey = false;
@@ -807,17 +809,6 @@ public class BaseKeyboardView extends View implements PointerTracker.UIProxy {
 
             boolean drawHintIcon = true;
             if (label != null) {
-                // If keyboard is multi-touch capable and in temporary upper case state and key has
-                // tempoarary shift label, label should be hint character and hint icon should not
-                // be drawn.
-                if (mHasDistinctMultitouch
-                        && mKeyboard instanceof LatinKeyboard
-                        && ((LatinKeyboard)mKeyboard).isTemporaryUpperCase()
-                        && key.temporaryShiftLabel != null) {
-                    label = key.temporaryShiftLabel.toString();
-                    drawHintIcon = false;
-                }
-
                 // For characters, use large font. For labels like "Done", use small font.
                 final int labelSize;
                 if (label.length() > 1 && key.codes.length < 2) {
@@ -862,7 +853,10 @@ public class BaseKeyboardView extends View implements PointerTracker.UIProxy {
                 int drawableHeight = key.height;
                 int drawableX = 0;
                 int drawableY = HINT_ICON_VERTICAL_ADJUSTMENT_PIXEL;
-                drawIcon(canvas, key.hintIcon, drawableX, drawableY, drawableWidth, drawableHeight);
+                Drawable icon = (isTemporaryUpperCase
+                        && key.manualTemporaryUpperCaseHintIcon != null)
+                        ? key.manualTemporaryUpperCaseHintIcon : key.hintIcon;
+                drawIcon(canvas, icon, drawableX, drawableY, drawableWidth, drawableHeight);
             }
             canvas.translate(-key.x - kbdPaddingLeft, -key.y - kbdPaddingTop);
         }

java/src/com/android/inputmethod/latin/PointerTracker.java

@@ -419,12 +419,6 @@ public class PointerTracker {
         if (key.codes[0] == BaseKeyboard.KEYCODE_SHIFT) {
             mHandler.startLongPressShiftTimer(mLongPressShiftKeyTimeout, keyIndex, this);
         } else {
-            // If keyboard is in temporary upper case state and the key has temporary shift label,
-            // non-shift long press should not be started.  On distinct multi touch device, when
-            // pressing shift key (in temporary upper case), hint icon should not be drawn on key
-            // top. So we should disable long press for such key.
-            if (isTemporaryUpperCase() && key.temporaryShiftLabel != null)
-                return;
             mHandler.startLongPressTimer(mLongPressKeyTimeout, keyIndex, this);
         }
     }
@@ -462,10 +456,10 @@ public class PointerTracker {
                     code = key.codes[mTapCount];
                 }
 
-                // If keyboard is in temporary upper case state and key has temporary shift label,
-                // alternate character code should be sent.
-                if (isTemporaryUpperCase() && key.temporaryShiftLabel != null) {
-                    code = key.temporaryShiftLabel.charAt(0);
+                // If keyboard is in manual temporary upper case state and key has manual temporary
+                // shift code, alternate character code should be sent.
+                if (isTemporaryUpperCase() && key.manualTemporaryUpperCaseCode != 0) {
+                    code = key.manualTemporaryUpperCaseCode;
                     codes[0] = code;
                 }