config: add touch_on_select

this makes an entry bump to the newest slot when it is selected
via `clipmenu`.

Author: N-R-K

man/clipmenu.conf.5

@@ -47,6 +47,12 @@ include rofi's dmenu mode or a custom command. Default: "dmenu".
 When enabled, extra command-line arguments passed to clipmenu are forwarded to
 the launcher. Default: 1.
 .TP
+.B touch_on_select
+When an entry is selected via
+.BR clipmenu (1)
+it will also be moved up to the newest slot.
+Default: 0.
+.TP
 .B cm_dir
 Overrides the default directory for the clip store. This is by default at a
 subdirectory inside XDG_RUNTIME_DIR, TMPDIR, or if both are unset, inside /tmp.

src/clipmenu.c

@@ -149,7 +149,11 @@ static int _nonnull_ interact_with_dmenu(struct config *cfg, int *input_pipe,
         return EXIT_FAILURE;
     }
 
-    return WEXITSTATUS(dmenu_status);
+    int dmenu_exit_code = WEXITSTATUS(dmenu_status);
+    if (dmenu_exit_code == EXIT_SUCCESS && cfg->touch_on_select) {
+        expect(cs_make_newest(&cs, *out_hash) == 0);
+    }
+    return dmenu_exit_code;
 }
 
 /**

src/config.c

@@ -287,6 +287,7 @@ int config_setup_internal(FILE *file, struct config *cfg) {
          0},
         {"launcher_pass_dmenu_args", "CM_LAUNCHER_PASS_DMENU_ARGS",
          &cfg->launcher_pass_dmenu_args, convert_bool, "1", 0},
+        {"touch_on_select", NULL, &cfg->touch_on_select, convert_bool, "0", 0},
         {"cm_dir", "CM_DIR", &cfg->runtime_dir, convert_cm_dir, NULL, 0}};
 
     size_t entries_len = arrlen(entries);

src/config.h

@@ -51,6 +51,7 @@ struct config {
     struct ignore_window ignore_window;
     struct launcher launcher;
     bool launcher_pass_dmenu_args;
+    bool touch_on_select;
 };
 typedef int (*conversion_func_t)(const char *, void *);
 struct config_entry {

src/store.c

@@ -533,7 +533,7 @@ int cs_content_get(struct clip_store *cs, uint64_t hash,
  * @cs: The clip store to operate on
  * @hash: The hash of the entry to move
  */
-static int cs_make_newest(struct clip_store *cs, uint64_t hash) {
+int cs_make_newest(struct clip_store *cs, uint64_t hash) {
     _drop_(cs_unref) struct ref_guard guard = cs_ref(cs);
     if (guard.status < 0) {
         return guard.status;

src/store.h

@@ -166,6 +166,8 @@ void drop_cs_content_unmap(struct cs_content *content);
 void drop_cs_destroy(struct clip_store *cs);
 int _must_use_ _nonnull_ cs_content_get(struct clip_store *cs, uint64_t hash,
                                         struct cs_content *content);
+int _must_use_ _nonnull_n_(1)
+    cs_make_newest(struct clip_store *cs, uint64_t hash);
 int _must_use_ _nonnull_n_(1)
     cs_add(struct clip_store *cs, const char *content, uint64_t *out_hash,
            enum cs_dupe_policy dupe_policy);

tests/test_store.c

@@ -649,6 +649,44 @@ static bool test__cs_add__dupe_keep_last_with_multiple_entries(void) {
     return true;
 }
 
+static bool check_order(struct clip_store *cs, uint64_t *order, size_t len) {
+    _drop_(cs_unref) struct ref_guard guard = cs_ref(cs);
+    struct cs_snip *snip = NULL;
+    for (size_t i = 0; i < len; ++i) {
+        bool iter_ret = cs_snip_iter(&guard, CS_ITER_NEWEST_FIRST, &snip);
+        t_assert(iter_ret == true);
+        t_assert(snip->hash == order[i]);
+    }
+    return 0;
+}
+
+/* After calling cs_make_newest make sure the entry is at the newest slot while
+ * other entries remain in order. */
+static bool test__cs_make_newest(void) {
+    _drop_(teardown_test) struct clip_store cs = setup_test();
+
+    uint64_t hash_a, hash_b, hash_c;
+    int ret = cs_add(&cs, "A", &hash_a, CS_DUPE_KEEP_ALL);
+    t_assert(ret == 0);
+    ret = cs_add(&cs, "B", &hash_b, CS_DUPE_KEEP_ALL);
+    t_assert(ret == 0);
+    ret = cs_add(&cs, "C", &hash_c, CS_DUPE_KEEP_ALL);
+    t_assert(ret == 0);
+    t_assert(cs.header->nr_snips == 3);
+
+    uint64_t order_before[3] = { hash_c, hash_b, hash_a };
+    ret = check_order(&cs, order_before, 3);
+    t_assert(ret == 0);
+    /* Now the order should change to ["A", "C", "B"] */
+    ret = cs_make_newest(&cs, hash_a);
+    t_assert(ret == 0);
+    uint64_t order_after[3] = { hash_a, hash_c, hash_b };
+    ret = check_order(&cs, order_after, 3);
+    t_assert(ret == 0);
+
+    return true;
+}
+
 int main(void) {
     t_run(test__cs_init);
     t_run(test__cs_init__bad_size);
@@ -676,6 +714,7 @@ int main(void) {
     t_run(test__cs_add__dupe_keep_all);
     t_run(test__cs_add__dupe_keep_last);
     t_run(test__cs_add__dupe_keep_last_with_multiple_entries);
+    t_run(test__cs_make_newest);
 
     return 0;
 }