Emoji suggestion (#1235)

Suggest an emoji in addition to the 3 suggested words when the
current word matches an alias in the emoji dictionary, if
available.

2 files changed, 77 insertions, 43 deletions

diff --git a/srcs/juloo.keyboard2/suggestions/CandidatesView.java b/srcs/juloo.keyboard2/suggestions/CandidatesView.java
index 6eba62a..5485ccf 100644
--- a/srcs/juloo.keyboard2/suggestions/CandidatesView.java
+++ b/srcs/juloo.keyboard2/suggestions/CandidatesView.java
@@ -17,10 +17,12 @@ import juloo.keyboard2.R;
 
 public class CandidatesView extends LinearLayout
 {
-  static final int NUM_CANDIDATES = 3;
+  static final int NUM_CANDIDATES = 4;
 
   /** Candidates currently visible. Entries can be [null] when there are less
-      than [NUM_CANDIDATES] suggestions. */
+      than [NUM_CANDIDATES] suggestions.
+      - Entries at indexes [0] to [2] are word suggestions.
+      - Entry at index [3] is the emoji suggestion. */
   String[] _items = new String[NUM_CANDIDATES];
 
   /** Text views showing the candidates in [_items]. Text views visibility is
@@ -43,35 +45,45 @@ public class CandidatesView extends LinearLayout
     setup_item_view(0, R.id.candidates_middle);
     setup_item_view(1, R.id.candidates_right);
     setup_item_view(2, R.id.candidates_left);
+    setup_item_view(3, R.id.candidates_emoji);
   }
 
-  public void set_candidates(List<String> suggestions)
+  public void set_candidates(Suggestions s)
   {
-    int s_count = suggestions.size();
+    int s_count = s.count;
+    for (int i = 0; i < Suggestions.MAX_COUNT; i++)
+      _items[i] = (i < s_count) ? s.suggestions[i] : null;
+    _items[3] = s.emoji_suggestion;
     // Hide the status message when showing candidates.
     if (s_count != 0 && _status_no_dict != null)
       _status_no_dict.setVisibility(View.GONE);
     for (int i = 0; i < _item_views.length; i++)
     {
       TextView v = _item_views[i];
-      if (i < s_count)
+      if (_items[i] != null)
       {
-        String it = suggestions.get(i);
-        _items[i] = it;
-        v.setText(it);
+        v.setText(_items[i]);
         v.setVisibility(View.VISIBLE);
       }
       else
       {
-        _items[i] = null;
         v.setVisibility(View.GONE);
       }
     }
   }
 
+  public void clear_candidates()
+  {
+    for (int i = 0; i < _item_views.length; i++)
+    {
+      _items[i] = null;
+      _item_views[i].setVisibility(View.GONE);
+    }
+  }
+
   public void refresh_config(Config config)
   {
-    set_candidates(Suggestions.NO_SUGGESTIONS);
+    clear_candidates();
     // The status message indicates whether the dictionaries should be
     // installed.
     _status_no_dict = inflate_and_show(_status_no_dict,
diff --git a/srcs/juloo.keyboard2/suggestions/Suggestions.java b/srcs/juloo.keyboard2/suggestions/Suggestions.java
index 41a7941..f72257b 100644
--- a/srcs/juloo.keyboard2/suggestions/Suggestions.java
+++ b/srcs/juloo.keyboard2/suggestions/Suggestions.java
@@ -16,9 +16,14 @@ public final class Suggestions
   Config _config;
   boolean _enabled;
 
-  /** The suggestion displayed at the center of the candidates view and entered
-      by the space bar. */
-  public String best_suggestion = null;
+  /** Current suggestions. The best suggestion is at index [0]. */
+  public String[] suggestions = new String[MAX_COUNT];
+  /** Number of suggestions at the beginning of the [suggestions] array that
+      are not [null]. */
+  public int count = 0;
+  public String emoji_suggestion = null;
+  /** Number of suggestions in [suggestions]. */
+  public static final int MAX_COUNT = 3;
 
   public Suggestions(Callback c, Config conf)
   {
@@ -29,55 +34,74 @@ public final class Suggestions
   public void started()
   {
     _enabled = _config.editor_config.should_show_candidates_view;
-    best_suggestion = null;
+    clear();
   }
 
   public void currently_typed_word(String word)
   {
     if (!_enabled)
       return;
-    Cdict dict = _config.current_dictionary;
-    if (word.length() < 2 || dict == null)
-    {
-      set_suggestions(NO_SUGGESTIONS);
-    }
+    if (word.length() < 2 || _config.current_dictionary == null)
+      clear();
     else
-    {
-      String[] dst = new String[3];
-      query_suggestions(dict, word, dst, 3);
-      set_suggestions(Arrays.asList(dst));
-    }
+      query_suggestions(word);
+    set_suggestions();
+  }
+
+  void clear()
+  {
+    count = 0;
+    suggestions[0] = null;
+    emoji_suggestion = null;
   }
 
-  int query_suggestions(Cdict dict, String word, String[] dst, int max_count)
+  int query_suggestions(String word)
   {
+    Cdict dict = _config.current_dictionary;
     boolean first_char_upper = Character.isUpperCase(word.charAt(0));
     word = apply_substitutions(word);
     Cdict.Result r = dict.find(word);
     int i = 0;
     if (r.found)
-      dst[i++] = dict.word(r.index);
-    int[] suffixes = dict.suffixes(r, max_count);
+      suggestions[i++] = dict.word(r.index);
+    int[] suffixes = dict.suffixes(r, MAX_COUNT);
     // Disable distance search for small words
-    int[] dist = (word.length() < 3 || i + 1 >= max_count) ? NO_RESULTS :
-      dict.distance(word, 1, max_count);
-    for (int j = 0; j < max_count && i < max_count; j++)
+    int[] dist = (word.length() < 3 || i + 1 >= MAX_COUNT) ? NO_RESULTS :
+      dict.distance(word, 1, MAX_COUNT);
+    for (int j = 0; j < MAX_COUNT && i < MAX_COUNT; j++)
     {
       if (suffixes.length > j)
-        dst[i++] = dict.word(suffixes[j]);
-      if (dist.length > j && i < max_count)
-        dst[i++] = dict.word(dist[j]);
+        suggestions[i++] = dict.word(suffixes[j]);
+      if (dist.length > j && i < MAX_COUNT)
+        suggestions[i++] = dict.word(dist[j]);
     }
     if (first_char_upper)
-      capitalize_results(dst);
+      capitalize_results();
+    emoji_suggestion = query_emoji(word); // word with substitutions applied
+    count = i;
     return i;
   }
 
-  void capitalize_results(String[] rs)
+  void capitalize_results()
   {
-    for (int i = 0; i < rs.length; i++)
-      if (rs[i] != null)
-        rs[i] = rs[i].substring(0, 1).toUpperCase() + rs[i].substring(1);
+    for (int i = 0; i < count; i++)
+      suggestions[i] = suggestions[i].substring(0, 1).toUpperCase()
+        + suggestions[i].substring(1);
+  }
+
+  String query_emoji(String word)
+  {
+    Cdict dict = _config.emoji_dictionary;
+    // Disable emoji suggestion for short words
+    if (dict == null || word.length() < 3)
+      return null;
+    Cdict.Result r = dict.find(word);
+    if (r.found)
+      return dict.word(r.index);
+    int[] s = dict.suffixes(r, 1);
+    if (s.length > 0)
+      return dict.word(s[0]);
+    return null;
   }
 
   /** Apply the same substitutions that were used when building the
@@ -96,17 +120,15 @@ public final class Suggestions
     return b.toString();
   }
 
-  void set_suggestions(List<String> ws)
+  void set_suggestions()
   {
-    _callback.set_suggestions(ws);
-    best_suggestion = (ws.size() > 0) ? ws.get(0) : null;
+    _callback.set_suggestions(this);
   }
 
-  static final List<String> NO_SUGGESTIONS = Arrays.asList();
   static final int[] NO_RESULTS = new int[0];
 
   public static interface Callback
   {
-    public void set_suggestions(List<String> suggestions);
+    public void set_suggestions(Suggestions suggestions);
   }
 }