Add -r option: include recently accepted emojis in find results

See updated `README.adoc` to learn more.

On the implementation side, I just add 1000 to the score of emojis
within the "Recent" category to make them win. What's nice is the
remaining score still applies over that initial 1000.

Signed-off-by: Philippe Proulx <[email protected]>

Author: eepp

README.adoc

@@ -557,6 +557,13 @@ same{nbsp}⌚.
 |`-R`
 |[[opt-R]]🙈 the "`Recent`" category.
 
+|`-r`
+|[[opt-r]]Include the recently accepted emojis in the results
+when 🔍 emojis.
+
+In this 💼, jome 👁️ the recently accepted emojis first within the
+result grid.
+
 |`-k`
 |[[opt-k]]🙈 the keyword 📜.
 

jome/emoji-db.cpp

@@ -126,10 +126,12 @@ EmojiCat::EmojiCat(QString id, QString name) :
 }
 
 EmojiDb::EmojiDb(const QString& dir, const EmojiSize emojiSize,
-                 const unsigned int maxRecentEmojis, const bool noRecentCat) :
+                 const unsigned int maxRecentEmojis, const bool noRecentCat,
+                 const bool incRecentInFindResults) :
     _emojiSize {emojiSize},
     _emojisPngPath {qFmtFormat("{}/emojis-{}.png", dir.toStdString(), this->emojiSizeInt())},
-    _maxRecentEmojis {maxRecentEmojis}
+    _maxRecentEmojis {maxRecentEmojis},
+    _incRecentInFindResults {incRecentInFindResults}
 {
     this->_createEmojis(dir);
     this->_createCats(dir, noRecentCat);
@@ -445,12 +447,17 @@ void EmojiDb::findEmojis(QString catName, const QString& needlesStr,
     // handle specific codepoint search
     if (needles.size() == 1 && needles.first().size() >= 3 && needles.first().startsWith("u+")) {
         for (auto& cat : _cats) {
-            if (cat->isRecent()) {
-                // exclude "Recent" category
+            if (!catName.isEmpty() && cat->isRecent()) {
+                // invalid
                 continue;
             }
 
-            if (!catName.isEmpty() && !cat->lcName().contains(catName)) {
+            if (cat->isRecent()) {
+                if (!_incRecentInFindResults) {
+                    // exclude "Recent" category
+                    continue;
+                }
+            } else if (!catName.isEmpty() && !cat->lcName().contains(catName)) {
                 // we don't even want to search this category
                 continue;
             }
@@ -470,18 +477,28 @@ void EmojiDb::findEmojis(QString catName, const QString& needlesStr,
     auto pos = 0U;
 
     for (auto& cat : _cats) {
-        if (cat->isRecent()) {
-            // exclude "Recent" category
+        auto initScore = 0U;
+
+        if (!catName.isEmpty() && cat->isRecent()) {
+            // invalid
             continue;
         }
 
-        if (!catName.isEmpty() && !cat->lcName().contains(catName)) {
+        if (cat->isRecent()) {
+            if (_incRecentInFindResults) {
+                // boost to get them before the other categories
+                initScore = 1000;
+            } else {
+                // exclude "Recent" category
+                continue;
+            }
+        } else if (!catName.isEmpty() && !cat->lcName().contains(catName)) {
             // we don't even want to search this category
             continue;
         }
 
         for (auto emoji : cat->emojis()) {
-            auto score = 0U;
+            auto score = initScore;
 
             for (auto& needle : needles) {
                 auto needleScore = 0U;

jome/emoji-db.hpp

@@ -303,7 +303,8 @@ class EmojiDb final
      * `noRecentCat` is false.
      */
     explicit EmojiDb(const QString& dir, EmojiSize emojiSize,
-                     unsigned int maxRecentEmojis, bool noRecentCat);
+                     unsigned int maxRecentEmojis, bool noRecentCat,
+                     bool incRecentInFindResults);
 
     /*
      * Appends the emojis found with the partial category name `cat` and
@@ -463,6 +464,7 @@ class EmojiDb final
     mutable std::set<const Emoji *> _tmpFindResultEmojis;
     EmojiCat *_recentEmojisCat = nullptr;
     unsigned int _maxRecentEmojis;
+    bool _incRecentInFindResults;
 };
 
 } // namespace jome

jome/jome.cpp

@@ -54,6 +54,7 @@ struct Params final
     bool noRecentCat;
     bool noKwList;
     boost::optional<jome::Emoji::SkinTone> defSkinTone;
+    bool incRecentInFindResults;
 };
 
 namespace {
@@ -71,6 +72,7 @@ Params parseArgs(QApplication& app)
     const QCommandLineOption noNlOpt {"n", "Do not output newline."};
     const QCommandLineOption removeVs16Opt {"V", "Do not output VS-16 codepoints."};
     const QCommandLineOption defSkinToneOpt {"t", "Set default skin tone to <TONE> (`L`, `ML`, `M`, `MD`, or `D`).", "TONE"};
+    const QCommandLineOption incRecentInFindResultsOpt {"r", "Include recently accepted emojis in find results."};
     const QCommandLineOption cmdOpt {"c", "Execute external command <CMD> with accepted emoji.", "CMD"};
     const QCommandLineOption copyToClipboardOpt {"b", "Copy the accepted emoji to the clipboard."};
     const QCommandLineOption noHideOpt {"q", "Do not quit when accepting."};
@@ -89,6 +91,7 @@ Params parseArgs(QApplication& app)
     parser.addOption(noNlOpt);
     parser.addOption(removeVs16Opt);
     parser.addOption(defSkinToneOpt);
+    parser.addOption(incRecentInFindResultsOpt);
     parser.addOption(cmdOpt);
     parser.addOption(copyToClipboardOpt);
     parser.addOption(noHideOpt);
@@ -114,6 +117,7 @@ Params parseArgs(QApplication& app)
     params.noCatLabels = parser.isSet(noCatLabelsOpt);
     params.noRecentCat = parser.isSet(noRecentCatOpt);
     params.noKwList = parser.isSet(noKwListOpt);
+    params.incRecentInFindResults = parser.isSet(incRecentInFindResultsOpt);
 
     {
         const auto fmt = parser.value(formatOpt);
@@ -317,7 +321,10 @@ int main(int argc, char ** const argv)
     const auto params = parseArgs(app);
 
     // create emoji database
-    jome::EmojiDb db {JOME_DATA_DIR, params.emojiSize, params.maxRecentEmojis, params.noRecentCat};
+    jome::EmojiDb db {
+        JOME_DATA_DIR, params.emojiSize, params.maxRecentEmojis, params.noRecentCat,
+        params.incRecentInFindResults
+    };
 
     // create window (not visible yet)
     jome::QJomeWindow win {db, params.darkBg, params.noCatList, params.noCatLabels,

man/jome.1

@@ -822,6 +822,15 @@ Hide the category labels in the emoji grid.
 Hide the \(lqRecent\(rq category.
 .RE
 .sp
+\fB\-r\fP
+.RS 4
+Include the recently accepted emojis in the results when
+finding emojis.
+.sp
+In this case, jome shows the recently accepted emojis first within the
+result grid.
+.RE
+.sp
 \fB\-k\fP
 .RS 4
 Hide the keyword list.

man/jome.1.adoc

@@ -513,6 +513,13 @@ You cannot specify the **-s** and **-q** options together.
 **-R**::
     Hide the "`Recent`" category.
 
+**-r**::
+    Include the recently accepted emojis in the results when
+    finding emojis.
++
+In this case, jome shows the recently accepted emojis first within the
+result grid.
+
 **-k**::
     Hide the keyword list.