Treat calculation Suggestions as answers.

This change allows AnswerSuggestionProcessor to manage Calculation
suggestions as well, ensuring all answers (including calculation) are
uniformly processed when new answer layout is enabled.

Bug: 920396
Change-Id: If233480827eb286131eae4a761b8cb9d210cdc3a
Reviewed-on: https://chromium-review.googlesource.com/c/1481953Reviewed-by: Theresa <twellington@chromium.org>
Commit-Queue: Ender <ender@google.com>
Cr-Commit-Position: refs/heads/master@{#634832}

chrome/android/java/src/org/chromium/chrome/browser/omnibox/suggestions/AutocompleteMediator.java

@@ -145,9 +145,9 @@ class AutocompleteMediator implements OnSuggestionsReceivedListener, SuggestionH
         mAutocomplete = new AutocompleteController(this);
         mHandler = new Handler();
         mBasicSuggestionProcessor = new BasicSuggestionProcessor(mContext, this, textProvider);
+        mAnswerSuggestionProcessor = new AnswerSuggestionProcessor(mContext, this, textProvider);
         mEditUrlProcessor = new EditUrlSuggestionProcessor(
                 delegate, (suggestion) -> onSelection(suggestion, 0));
-        mAnswerSuggestionProcessor = new AnswerSuggestionProcessor(mContext, this);
     }
 
     /**

chrome/android/java/src/org/chromium/chrome/browser/omnibox/suggestions/answer/AnswerSuggestionProcessor.java

@@ -12,6 +12,8 @@ import android.view.View;
 
 import org.chromium.base.ThreadUtils;
 import org.chromium.chrome.browser.ChromeFeatureList;
+import org.chromium.chrome.browser.omnibox.OmniboxSuggestionType;
+import org.chromium.chrome.browser.omnibox.UrlBarEditingTextStateProvider;
 import org.chromium.chrome.browser.omnibox.suggestions.AnswersImageFetcher;
 import org.chromium.chrome.browser.omnibox.suggestions.AutocompleteCoordinator.SuggestionProcessor;
 import org.chromium.chrome.browser.omnibox.suggestions.OmniboxSuggestion;
@@ -37,22 +39,27 @@ public class AnswerSuggestionProcessor implements SuggestionProcessor {
     private final Context mContext;
     private final SuggestionHost mSuggestionHost;
     private final AnswersImageFetcher mImageFetcher;
+    private final UrlBarEditingTextStateProvider mUrlBarEditingTextProvider;
     private boolean mEnableNewAnswerLayout;
 
     /**
      * @param context An Android context.
      * @param suggestionHost A handle to the object using the suggestions.
      */
-    public AnswerSuggestionProcessor(Context context, SuggestionHost suggestionHost) {
+    public AnswerSuggestionProcessor(Context context, SuggestionHost suggestionHost,
+            UrlBarEditingTextStateProvider editingTextProvider) {
         mContext = context;
         mSuggestionHost = suggestionHost;
         mPendingAnswerRequestUrls = new HashMap<>();
         mImageFetcher = new AnswersImageFetcher();
+        mUrlBarEditingTextProvider = editingTextProvider;
     }
 
     @Override
     public boolean doesProcessSuggestion(OmniboxSuggestion suggestion) {
-        return suggestion.hasAnswer();
+        // Calculation answers are specific in a way that these are basic suggestions, but processed
+        // as answers, when new answer layout is enabled.
+        return suggestion.hasAnswer() || suggestion.getType() == OmniboxSuggestionType.CALCULATOR;
     }
 
     @Override
@@ -81,9 +88,9 @@ public class AnswerSuggestionProcessor implements SuggestionProcessor {
                 mSuggestionHost.createSuggestionViewDelegate(suggestion, position);
 
         if (mEnableNewAnswerLayout) {
-            setStateForNewSuggestion(model, suggestion.getAnswer(), delegate);
+            setStateForNewSuggestion(model, suggestion, delegate);
         } else {
-            setStateForClassicSuggestion(model, suggestion.getAnswer(), delegate);
+            setStateForClassicSuggestion(model, suggestion, delegate);
         }
     }
 
@@ -98,6 +105,7 @@ public class AnswerSuggestionProcessor implements SuggestionProcessor {
         // Attempting to fetch answer data before we have a profile to request it for.
         if (mSuggestionHost.getCurrentProfile() == null) return;
 
+        // Note: we also handle calculations here, which do not have answer defined.
         if (!suggestion.hasAnswer()) return;
         final String url = suggestion.getAnswer().getSecondLine().getImage();
         if (url == null) return;
@@ -140,33 +148,34 @@ public class AnswerSuggestionProcessor implements SuggestionProcessor {
      * Sets both lines of the Omnibox suggestion in a basic Suggestion result.
      */
     private void setStateForClassicSuggestion(
-            PropertyModel model, SuggestionAnswer answer, SuggestionViewDelegate delegate) {
-        SuggestionAnswer.ImageLine firstLine = answer.getFirstLine();
-        SuggestionAnswer.ImageLine secondLine = answer.getSecondLine();
+            PropertyModel model, OmniboxSuggestion suggestion, SuggestionViewDelegate delegate) {
+        AnswerText[] details = AnswerTextClassic.from(mContext, suggestion);
 
-        model.set(SuggestionViewProperties.IS_ANSWER, true);
-
-        AnswerText[] details = AnswerTextClassic.from(mContext, answer);
+        SuggestionAnswer answer = suggestion.getAnswer();
+        if (answer != null) {
+            model.set(SuggestionViewProperties.HAS_ANSWER_IMAGE, answer.getSecondLine().hasImage());
+        }
 
+        model.set(SuggestionViewProperties.IS_ANSWER, true);
         model.set(SuggestionViewProperties.DELEGATE, delegate);
 
         model.set(SuggestionViewProperties.TEXT_LINE_1_SIZING,
                 Pair.create(TypedValue.COMPLEX_UNIT_SP, details[0].mHeightSp));
-        model.set(SuggestionViewProperties.TEXT_LINE_2_SIZING,
-                Pair.create(TypedValue.COMPLEX_UNIT_SP, details[1].mHeightSp));
-
         model.set(SuggestionViewProperties.TEXT_LINE_1_TEXT,
                 new SuggestionTextContainer(details[0].mText));
-        model.set(SuggestionViewProperties.TEXT_LINE_2_TEXT,
-                new SuggestionTextContainer(details[1].mText));
-
         model.set(SuggestionViewProperties.TEXT_LINE_1_MAX_LINES, details[0].mMaxLines);
-        model.set(SuggestionViewProperties.TEXT_LINE_2_MAX_LINES, details[1].mMaxLines);
-
         model.set(SuggestionViewProperties.TEXT_LINE_1_TEXT_DIRECTION, View.TEXT_DIRECTION_INHERIT);
-        model.set(SuggestionViewProperties.TEXT_LINE_2_TEXT_DIRECTION, View.TEXT_DIRECTION_INHERIT);
 
-        model.set(SuggestionViewProperties.HAS_ANSWER_IMAGE, secondLine.hasImage());
+        if (details[1] != null) {
+            model.set(SuggestionViewProperties.TEXT_LINE_2_SIZING,
+                    Pair.create(TypedValue.COMPLEX_UNIT_SP, details[1].mHeightSp));
+            model.set(SuggestionViewProperties.TEXT_LINE_2_TEXT,
+                    new SuggestionTextContainer(details[1].mText));
+            model.set(SuggestionViewProperties.TEXT_LINE_2_MAX_LINES, details[1].mMaxLines);
+            model.set(SuggestionViewProperties.TEXT_LINE_2_TEXT_DIRECTION,
+                    View.TEXT_DIRECTION_INHERIT);
+        }
+
         model.set(SuggestionViewProperties.SUGGESTION_ICON_TYPE, SuggestionIcon.MAGNIFIER);
 
         model.set(SuggestionViewProperties.REFINABLE, true);
@@ -176,11 +185,10 @@ public class AnswerSuggestionProcessor implements SuggestionProcessor {
      * Sets both lines of the Omnibox suggestion based on an Answers in Suggest result.
      */
     private void setStateForNewSuggestion(
-            PropertyModel model, SuggestionAnswer answer, SuggestionViewDelegate delegate) {
-        SuggestionAnswer.ImageLine firstLine = answer.getFirstLine();
-        SuggestionAnswer.ImageLine secondLine = answer.getSecondLine();
-
-        AnswerText[] details = AnswerTextNewLayout.from(mContext, answer);
+            PropertyModel model, OmniboxSuggestion suggestion, SuggestionViewDelegate delegate) {
+        SuggestionAnswer answer = suggestion.getAnswer();
+        AnswerText[] details = AnswerTextNewLayout.from(
+                mContext, suggestion, mUrlBarEditingTextProvider.getTextWithAutocomplete());
 
         model.set(AnswerSuggestionViewProperties.DELEGATE, delegate);
 
@@ -196,33 +204,38 @@ public class AnswerSuggestionProcessor implements SuggestionProcessor {
         @AnswerIcon
         int icon = AnswerIcon.UNDEFINED;
 
-        switch (answer.getType()) {
-            case AnswerType.DICTIONARY:
-                icon = AnswerIcon.DICTIONARY;
-                break;
-            case AnswerType.FINANCE:
-                icon = AnswerIcon.FINANCE;
-                break;
-            case AnswerType.KNOWLEDGE_GRAPH:
-                icon = AnswerIcon.KNOWLEDGE;
-                break;
-            case AnswerType.SUNRISE:
-                icon = AnswerIcon.SUNRISE;
-                break;
-            case AnswerType.TRANSLATION:
-                icon = AnswerIcon.TRANSLATION;
-                break;
-            case AnswerType.WEATHER:
-                icon = AnswerIcon.WEATHER;
-                break;
-            case AnswerType.WHEN_IS:
-                icon = AnswerIcon.EVENT;
-                break;
-            case AnswerType.CURRENCY:
-                icon = AnswerIcon.CURRENCY;
-                break;
-            case AnswerType.SPORTS:
-                icon = AnswerIcon.SPORTS;
+        if (answer != null) {
+            switch (answer.getType()) {
+                case AnswerType.DICTIONARY:
+                    icon = AnswerIcon.DICTIONARY;
+                    break;
+                case AnswerType.FINANCE:
+                    icon = AnswerIcon.FINANCE;
+                    break;
+                case AnswerType.KNOWLEDGE_GRAPH:
+                    icon = AnswerIcon.KNOWLEDGE;
+                    break;
+                case AnswerType.SUNRISE:
+                    icon = AnswerIcon.SUNRISE;
+                    break;
+                case AnswerType.TRANSLATION:
+                    icon = AnswerIcon.TRANSLATION;
+                    break;
+                case AnswerType.WEATHER:
+                    icon = AnswerIcon.WEATHER;
+                    break;
+                case AnswerType.WHEN_IS:
+                    icon = AnswerIcon.EVENT;
+                    break;
+                case AnswerType.CURRENCY:
+                    icon = AnswerIcon.CURRENCY;
+                    break;
+                case AnswerType.SPORTS:
+                    icon = AnswerIcon.SPORTS;
+            }
+        } else {
+            assert suggestion.getType() == OmniboxSuggestionType.CALCULATOR;
+            icon = AnswerIcon.CALCULATOR;
         }
 
         model.set(AnswerSuggestionViewProperties.ANSWER_ICON_TYPE, icon);

chrome/android/java/src/org/chromium/chrome/browser/omnibox/suggestions/answer/AnswerText.java

@@ -49,6 +49,8 @@ abstract class AnswerText {
     AnswerText(Context context) {
         mContext = context;
         mDensity = context.getResources().getDisplayMetrics().density;
+        mText = new SpannableStringBuilder();
+        mMaxLines = 1;
     }
 
     /**
@@ -58,16 +60,14 @@ abstract class AnswerText {
      * @param delegate Callback converting AnswerTextType to an array of TextAppearanceSpan objects.
      */
     protected void build(SuggestionAnswer.ImageLine line) {
-        mText = new SpannableStringBuilder();
-        mMaxLines = 1;
-
         // This method also computes height of the entire text span.
         // Ensure we're not rebuilding or appending once AnswerText has been constructed.
         assert mHeightSp == 0;
 
         List<SuggestionAnswer.TextField> textFields = line.getTextFields();
         for (int i = 0; i < textFields.size(); i++) {
-            appendAndStyleText(textFields.get(i));
+            appendAndStyleText(
+                    textFields.get(i).getText(), getAppearanceForText(textFields.get(i).getType()));
             if (textFields.get(i).hasNumLines()) {
                 mMaxLines = Math.max(mMaxLines, Math.min(3, textFields.get(i).getNumLines()));
             }
@@ -75,22 +75,24 @@ abstract class AnswerText {
 
         if (line.hasAdditionalText()) {
             mText.append("  ");
-            appendAndStyleText(line.getAdditionalText());
+            appendAndStyleText(line.getAdditionalText().getText(),
+                    getAppearanceForText(line.getAdditionalText().getType()));
         }
         if (line.hasStatusText()) {
             mText.append("  ");
-            appendAndStyleText(line.getStatusText());
+            appendAndStyleText(line.getStatusText().getText(),
+                    getAppearanceForText(line.getStatusText().getType()));
         }
     }
 
     /**
      * Append the styled text in textField to the supplied builder.
      *
-     * @param textField The text field (with text and type) to append.
+     * @param text Text to be appended.
+     * @param styles Styles to be applied to appended text.
      */
     @SuppressWarnings("deprecation") // Update usage of Html.fromHtml when API min is 24
-    private void appendAndStyleText(SuggestionAnswer.TextField textField) {
-        MetricAffectingSpan[] styles = getAppearanceForText(textField.getType());
+    protected void appendAndStyleText(String text, MetricAffectingSpan[] styles) {
         // Determine the maximum height of the TextAppearanceSpans that are applied for this field.
         for (MetricAffectingSpan style : styles) {
             if (!(style instanceof TextAppearanceSpan)) continue;
@@ -100,7 +102,7 @@ abstract class AnswerText {
         }
 
         // Unescape HTML entities (e.g. "&quot;", "&gt;").
-        String text = Html.fromHtml(textField.getText()).toString();
+        text = Html.fromHtml(text).toString();
 
         // Append as HTML (answer responses contain simple markup).
         int start = mText.length();

chrome/android/java/src/org/chromium/chrome/browser/omnibox/suggestions/answer/AnswerTextClassic.java

@@ -13,6 +13,8 @@ import android.text.style.TextAppearanceSpan;
 
 import org.chromium.base.Log;
 import org.chromium.chrome.R;
+import org.chromium.chrome.browser.omnibox.OmniboxSuggestionType;
+import org.chromium.chrome.browser.omnibox.suggestions.OmniboxSuggestion;
 import org.chromium.components.omnibox.AnswerTextType;
 import org.chromium.components.omnibox.SuggestionAnswer;
 
@@ -27,14 +29,22 @@ class AnswerTextClassic extends AnswerText {
      * content.
      *
      * @param context Current context.
-     * @param answer Specifies answer to be converted.
+     * @param suggestion Suggestion to be converted.
      * @return array of AnswerText elements to use to construct suggestion item.
      */
-    static AnswerText[] from(Context context, SuggestionAnswer answer) {
+    static AnswerText[] from(Context context, OmniboxSuggestion suggestion) {
         AnswerText[] result = new AnswerText[2];
-
-        result[0] = new AnswerTextClassic(context, answer.getFirstLine());
-        result[1] = new AnswerTextClassic(context, answer.getSecondLine());
+        SuggestionAnswer answer = suggestion.getAnswer();
+        if (answer == null) {
+            // As an exception, we handle calculation suggestions, too, considering them an Answer,
+            // even if these are not one.
+            assert suggestion.getType() == OmniboxSuggestionType.CALCULATOR;
+            result[0] = new AnswerTextClassic(context, suggestion.getDisplayText());
+            result[1] = null;
+        } else {
+            result[0] = new AnswerTextClassic(context, answer.getFirstLine());
+            result[1] = new AnswerTextClassic(context, answer.getSecondLine());
+        }
 
         // Trim number of presented query lines.
         result[0].mMaxLines = 1;
@@ -43,7 +53,7 @@ class AnswerTextClassic extends AnswerText {
     }
 
     /**
-     * Create new instance of AnswerTextClassic.
+     * Create new instance of AnswerTextClassic for answer suggestions.
      *
      * @param context Current context.
      * @param line Suggestion line that will be converted to Answer Text.
@@ -53,6 +63,17 @@ class AnswerTextClassic extends AnswerText {
         build(line);
     }
 
+    /**
+     * Create new instance of AnswerTextClassic for non-answer suggestions.
+     *
+     * @param context Current context.
+     * @param text Suggestion text.
+     */
+    AnswerTextClassic(Context context, String text) {
+        super(context);
+        appendAndStyleText(text, getAppearanceForText(AnswerTextType.SUGGESTION));
+    }
+
     /**
      * Return the TextAppearanceSpan array specifying text decorations for a given field type.
      *

chrome/android/java/src/org/chromium/chrome/browser/omnibox/suggestions/answer/AnswerTextNewLayout.java

@@ -11,6 +11,8 @@ import android.text.style.TextAppearanceSpan;
 
 import org.chromium.base.Log;
 import org.chromium.chrome.R;
+import org.chromium.chrome.browser.omnibox.OmniboxSuggestionType;
+import org.chromium.chrome.browser.omnibox.suggestions.OmniboxSuggestion;
 import org.chromium.components.omnibox.AnswerTextType;
 import org.chromium.components.omnibox.AnswerType;
 import org.chromium.components.omnibox.SuggestionAnswer;
@@ -27,17 +29,24 @@ class AnswerTextNewLayout extends AnswerText {
      * content.
      *
      * @param context Current context.
-     * @param answer Specifies answer to be converted.
+     * @param suggestion Suggestion to be converted.
+     * @param query Query that triggered the suggestion.
      * @return array of AnswerText elements to use to construct suggestion item.
      */
-    static AnswerText[] from(Context context, SuggestionAnswer answer) {
+    static AnswerText[] from(Context context, OmniboxSuggestion suggestion, String query) {
         AnswerText[] result = new AnswerText[2];
 
-        if (answer.getType() == AnswerType.DICTIONARY) {
+        SuggestionAnswer answer = suggestion.getAnswer();
+        if (answer == null) {
+            // As an exception, we handle calculation suggestions, too, considering them an Answer,
+            // even if these are not one.
+            assert suggestion.getType() == OmniboxSuggestionType.CALCULATOR;
+            result[0] = new AnswerTextNewLayout(context, suggestion.getFillIntoEdit(), true);
+            result[1] = new AnswerTextNewLayout(context, query, false);
+        } else if (answer.getType() == AnswerType.DICTIONARY) {
             result[0] = new AnswerTextNewLayout(context, answer.getFirstLine(), true);
             result[1] = new AnswerTextNewLayout(context, answer.getSecondLine(), false);
             result[0].mMaxLines = 1;
-
         } else {
             result[0] = new AnswerTextNewLayout(context, answer.getSecondLine(), true);
             result[1] = new AnswerTextNewLayout(context, answer.getFirstLine(), false);
@@ -48,11 +57,11 @@ class AnswerTextNewLayout extends AnswerText {
     }
 
     /**
-     * Create new instance of AnswerTextNewLayout.
+     * Create new instance of AnswerTextNewLayout for answer suggestions.
      *
      * @param context Current context.
      * @param line Suggestion line that will be converted to Answer Text.
-     * @param isAnswerLine True, whether this instance holds answer.
+     * @param isAnswerLine True, if this instance holds answer.
      */
     AnswerTextNewLayout(Context context, SuggestionAnswer.ImageLine line, boolean isAnswerLine) {
         super(context);
@@ -60,6 +69,18 @@ class AnswerTextNewLayout extends AnswerText {
         build(line);
     }
 
+    /**
+     * Create new instance of AnswerTextNewLayout for non-answer suggestions.
+     * @param context Current context.
+     * @param text Suggestion text.
+     * @param isAnswerLine True, if this instance holds answer.
+     */
+    AnswerTextNewLayout(Context context, String text, boolean isAnswerLine) {
+        super(context);
+        mIsAnswer = isAnswerLine;
+        appendAndStyleText(text, getAppearanceForText(AnswerTextType.SUGGESTION));
+    }
+
     /**
      * Return the TextAppearanceSpan array specifying text decorations for a given field type.
      *