Merge pull request #1491 from FelipeFTN/master

Feature: remove_current in notification queues

Author: bynect

docs/dunst.5.pod

@@ -596,7 +596,7 @@ B<Defaults:>
 
 =item * C<mouse_left_click=close_current>
 
-=item * C<mouse_middle_click=do_action, close_current>
+=item * C<mouse_middle_click=do_action, remove_current>
 
 =item * C<mouse_right_click=close_all>
 

dunstrc

@@ -320,6 +320,7 @@
     # * open_url: If the notification has exactly one url, open it. If there are multiple
     #             ones, open the context menu.
     # * close_current: Close current notification.
+    # * remove_current: Remove current notification from history.
     # * close_all: Close all notifications.
     # * context: Open context menu for the notification.
     # * context_all: Open context menu for all notifications.

src/input.c

@@ -97,7 +97,7 @@ void input_handle_click(unsigned int button, bool button_down, int mouse_x, int
                         continue;
                 }
 
-                if (act == MOUSE_DO_ACTION || act == MOUSE_CLOSE_CURRENT || act == MOUSE_CONTEXT || act == MOUSE_OPEN_URL) {
+                if (act == MOUSE_DO_ACTION || act == MOUSE_CLOSE_CURRENT || act == MOUSE_REMOVE_CURRENT || act == MOUSE_CONTEXT || act == MOUSE_OPEN_URL) {
                         struct notification *n = get_notification_at(mouse_y);
 
                         if (n) {
@@ -107,6 +107,8 @@ void input_handle_click(unsigned int button, bool button_down, int mouse_x, int
                                         notification_do_action(n);
                                 } else if (act == MOUSE_OPEN_URL) {
                                         notification_open_url(n);
+                                } else if (act == MOUSE_REMOVE_CURRENT) {
+                                        n->marked_for_removal = REASON_USER;
                                 } else {
                                         notification_open_context_menu(n);
                                 }

src/menu.c

@@ -355,6 +355,14 @@ static gboolean context_menu_result_dispatch(gpointer user_data)
                                 queues_notification_close(n, n->marked_for_closure);
                         n->marked_for_closure = 0;
                 }
+
+                // If the notification was marked for removal, remove it from history
+                if (n->marked_for_removal) {
+                        // Don't close notification if context was aborted
+                        // if (dmenu_output != NULL)
+                        queues_notification_remove(n, n->marked_for_removal);
+                        n->marked_for_removal = 0;
+                }
         }
 
         menu_ctx.locked_notifications = NULL;

src/notification.h

@@ -107,6 +107,7 @@ struct notification {
         enum behavior_fullscreen fullscreen; //!< The instruction what to do with it, when desktop enters fullscreen
         bool script_run;        /**< Has the script been executed already? */
         guint8 marked_for_closure;
+        guint8 marked_for_removal; /**< If set, the notification is marked for removal in history */
         bool word_wrap;
         PangoEllipsizeMode ellipsize;
         PangoAlignment alignment;

src/queues.c

@@ -373,6 +373,13 @@ void queues_notification_close(struct notification *n, enum reason reason)
         queues_notification_close_id(n->id, reason);
 }
 
+void queues_notification_remove(struct notification *n, enum reason reason)
+{
+        assert(n != NULL);
+        queues_notification_close_id(n->id, reason);
+        queues_history_remove_by_id(n->id);
+}
+
 static void queues_destroy_notification(struct notification *n, gpointer user_data)
 {
         (void)user_data;
@@ -505,6 +512,13 @@ void queues_update(struct dunst_status status, gint64 time)
                         continue;
                 }
 
+                if (n->marked_for_removal) {
+                        queues_notification_remove(n, n->marked_for_removal);
+                        n->marked_for_removal = 0;
+                        iter = nextiter;
+                        continue;
+                }
+
 
                 if (queues_notification_is_finished(n, status, time)) {
                         queues_notification_close(n, REASON_TIME);

src/queues.h

@@ -104,9 +104,32 @@ void queues_notification_close_id(gint id, enum reason reason);
  *
  * @param n (transfer full) The notification to close
  * @param reason The #reason to close
- * */
+ */
 void queues_notification_close(struct notification *n, enum reason reason);
 
+/**
+ * Remove the given notification from all queues
+ *
+ * Sends a signal and removes the selected notification from all queues.
+ *
+ * @param n (transfer full) The notification to remove
+ * @param reason The #reason to remove
+ */
+void queues_notification_remove(struct notification *n, enum reason reason);
+
+/**
+ * Remove the notification that has n->id == id
+ *
+ * Sends a signal and removes the selected notification from all queues.
+ *
+ * @param id The id of the notification to remove
+ * @param reason The #reason to remove
+ *
+ * @post Call wake_up() to synchronize the queues with the UI
+ *       (which closes the notification on screen)
+ */
+void queues_notification_remove_id(gint id, enum reason reason);
+
 /**
  * Removes all notifications from history
  * Returns the number of removed notifications

src/settings.h

@@ -33,7 +33,7 @@ enum sort_type { SORT_TYPE_ID, SORT_TYPE_URGENCY_ASCENDING, SORT_TYPE_URGENCY_DE
 enum vertical_alignment { VERTICAL_TOP, VERTICAL_CENTER, VERTICAL_BOTTOM };
 enum separator_color { SEP_FOREGROUND, SEP_AUTO, SEP_FRAME, SEP_CUSTOM };
 enum follow_mode { FOLLOW_NONE, FOLLOW_MOUSE, FOLLOW_KEYBOARD };
-enum mouse_action { MOUSE_NONE, MOUSE_DO_ACTION, MOUSE_CLOSE_CURRENT,
+enum mouse_action { MOUSE_NONE, MOUSE_DO_ACTION, MOUSE_CLOSE_CURRENT, MOUSE_REMOVE_CURRENT,
         MOUSE_CLOSE_ALL, MOUSE_CONTEXT, MOUSE_CONTEXT_ALL, MOUSE_OPEN_URL,
         MOUSE_ACTION_END = LIST_END /* indicates the end of a list of mouse actions */};
 #ifndef ZWLR_LAYER_SHELL_V1_LAYER_ENUM

src/settings_data.h

@@ -312,6 +312,7 @@ static const struct string_to_enum_def mouse_action_enum_data[] = {
         {"context",        MOUSE_CONTEXT },
         {"context_all",    MOUSE_CONTEXT_ALL },
         {"open_url",       MOUSE_OPEN_URL },
+        {"remove_current", MOUSE_REMOVE_CURRENT },
         ENUM_END,
 };
 
@@ -1306,7 +1307,7 @@ static const struct setting allowed_settings[] = {
                 .section = "global",
                 .description = "Action of middle click event",
                 .type = TYPE_LIST,
-                .default_value = "do_action, close_current",
+                .default_value = "do_action, remove_current",
                 .value = &settings.mouse_middle_click,
                 .parser = NULL,
                 .parser_data = GINT_TO_POINTER(MOUSE_LIST),

test/option_parser.c

@@ -373,13 +373,15 @@ TEST test_string_to_list(void)
                 "none, close_current",
                 "close_all,close_current",
                 "close_all,close_current,close_all",
+                "remove_current,close_current,close_all",
         };
         const enum mouse_action results[][4] = {
                 {MOUSE_CLOSE_CURRENT, MOUSE_ACTION_END},
                 {MOUSE_NONE, MOUSE_ACTION_END},
                 {MOUSE_NONE, MOUSE_CLOSE_CURRENT, MOUSE_ACTION_END},
                 {MOUSE_CLOSE_ALL, MOUSE_CLOSE_CURRENT, MOUSE_ACTION_END},
                 {MOUSE_CLOSE_ALL, MOUSE_CLOSE_CURRENT, MOUSE_CLOSE_ALL, MOUSE_ACTION_END},
+                {MOUSE_REMOVE_CURRENT, MOUSE_CLOSE_CURRENT, MOUSE_CLOSE_ALL, MOUSE_ACTION_END},
         };
 
         static char buf[100];