trigger: add filter in trigger monitor buffer

The filter can be set with /trigger monitor <filter> or by entering data
in the trigger monitor input.

src/plugins/trigger/trigger-buffer.c

@@ -30,8 +30,201 @@
 
 
 struct t_gui_buffer *trigger_buffer = NULL;
+char **trigger_buffer_filters = NULL;
 
 
+/*
+ * Checks if a trigger matches the filters.
+ *
+ * Returns:
+ *   1: trigger matches the filters
+ *   0: trigger does NOT match the filters
+ */
+
+int
+trigger_buffer_match_filters (struct t_trigger *trigger)
+{
+    int i;
+
+    /* trigger is matching if there are no filters at all */
+    if (!trigger_buffer_filters)
+        return 1;
+
+    for (i = 0; trigger_buffer_filters[i]; i++)
+    {
+        if (trigger_buffer_filters[i][0] == '@')
+        {
+            /* check if the hook matches the filter */
+            if (weechat_strcasecmp (
+                    trigger_hook_type_string[weechat_config_integer (trigger->options[TRIGGER_OPTION_HOOK])],
+                    trigger_buffer_filters[i] + 1) == 0)
+            {
+                return 1;
+            }
+        }
+        else
+        {
+            /* check if the name matches the filter */
+            if (weechat_string_match (trigger->name, trigger_buffer_filters[i], 0))
+                return 1;
+        }
+    }
+
+    /* trigger does not match the filters */
+    return 0;
+}
+
+/*
+ * Sets filter for trigger monitor buffer.
+ */
+
+void
+trigger_buffer_set_filter (const char *filter)
+{
+    if (trigger_buffer_filters)
+    {
+        weechat_string_free_split (trigger_buffer_filters);
+        trigger_buffer_filters = NULL;
+    }
+
+    if (filter && filter[0])
+        trigger_buffer_filters = weechat_string_split (filter, ",", 0, 0, NULL);
+}
+
+/*
+ * Sets title for trigger monitor buffer.
+ */
+
+void
+trigger_buffer_set_title ()
+{
+    const char *ptr_filter;
+    char title[1024];
+
+    ptr_filter = weechat_buffer_get_string (trigger_buffer, "localvar_trigger_filter");
+    snprintf (title, sizeof (title),
+              _("Trigger monitor (filter: %s) | Input: q=close words=filter"),
+              (ptr_filter) ? ptr_filter : "*");
+
+    weechat_buffer_set (trigger_buffer, "title", title);
+}
+
+/*
+ * Callback for user data in trigger buffer.
+ */
+
+int
+trigger_buffer_input_cb (void *data, struct t_gui_buffer *buffer,
+                        const char *input_data)
+{
+    /* make C compiler happy */
+    (void) data;
+
+    /* close buffer */
+    if (strcmp (input_data, "q") == 0)
+    {
+        weechat_buffer_close (buffer);
+        return WEECHAT_RC_OK;
+    }
+
+    /* set filters */
+    if (strcmp (input_data, "*") == 0)
+        weechat_buffer_set (buffer, "localvar_del_trigger_filter", "");
+    else
+        weechat_buffer_set (buffer, "localvar_set_trigger_filter", input_data);
+    trigger_buffer_set_filter (weechat_buffer_get_string (buffer,
+                                                          "localvar_trigger_filter"));
+    trigger_buffer_set_title ();
+
+    return WEECHAT_RC_OK;
+}
+
+/*
+ * Callback called when trigger buffer is closed.
+ */
+
+int
+trigger_buffer_close_cb (void *data, struct t_gui_buffer *buffer)
+{
+    /* make C compiler happy */
+    (void) data;
+    (void) buffer;
+
+    trigger_buffer = NULL;
+
+    return WEECHAT_RC_OK;
+}
+
+/*
+ * Restores buffer callbacks (input and close) for buffer created by trigger
+ * plugin.
+ */
+
+void
+trigger_buffer_set_callbacks ()
+{
+    struct t_gui_buffer *ptr_buffer;
+
+    ptr_buffer = weechat_buffer_search (TRIGGER_PLUGIN_NAME,
+                                        TRIGGER_BUFFER_NAME);
+    if (ptr_buffer)
+    {
+        trigger_buffer = ptr_buffer;
+        weechat_buffer_set_pointer (trigger_buffer, "close_callback",
+                                    &trigger_buffer_close_cb);
+        weechat_buffer_set_pointer (trigger_buffer, "input_callback",
+                                    &trigger_buffer_input_cb);
+        trigger_buffer_set_filter (weechat_buffer_get_string (trigger_buffer,
+                                                              "localvar_trigger_filter"));
+    }
+}
+
+/*
+ * Opens trigger buffer.
+ */
+
+void
+trigger_buffer_open (const char *filter, int switch_to_buffer)
+{
+    if (!trigger_buffer)
+    {
+        trigger_buffer = weechat_buffer_new (TRIGGER_BUFFER_NAME,
+                                             &trigger_buffer_input_cb, NULL,
+                                             &trigger_buffer_close_cb, NULL);
+
+        /* failed to create buffer ? then return */
+        if (!trigger_buffer)
+            return;
+
+        if (!weechat_buffer_get_integer (trigger_buffer, "short_name_is_set"))
+            weechat_buffer_set (trigger_buffer, "short_name", TRIGGER_BUFFER_NAME);
+        weechat_buffer_set (trigger_buffer, "localvar_set_type", "debug");
+        weechat_buffer_set (trigger_buffer, "localvar_set_server", TRIGGER_BUFFER_NAME);
+        weechat_buffer_set (trigger_buffer, "localvar_set_channel", TRIGGER_BUFFER_NAME);
+        weechat_buffer_set (trigger_buffer, "localvar_set_no_log", "1");
+
+        /* disable all highlights on this buffer */
+        weechat_buffer_set (trigger_buffer, "highlight_words", "-");
+    }
+
+    if (filter && filter[0])
+    {
+        weechat_buffer_set (trigger_buffer,
+                            "localvar_set_trigger_filter", filter);
+    }
+    else
+    {
+        weechat_buffer_set (trigger_buffer,
+                            "localvar_del_trigger_filter", "");
+    }
+    trigger_buffer_set_filter (filter);
+
+    trigger_buffer_set_title ();
+
+    if (switch_to_buffer)
+        weechat_buffer_set (trigger_buffer, "display", "1");
+}
+
 /*
  * Callback called for each entry in hashtable.
  */
@@ -93,16 +286,24 @@ trigger_buffer_display_hashtable (const char *name,
 
 /*
  * Displays a trigger in trigger buffer.
+ *
+ * Returns:
+ *   1: the trigger has been displayed
+ *   0: the trigger has NOT been displayed (no buffer, or does not match filter)
  */
 
-void
+int
 trigger_buffer_display_trigger (struct t_trigger *trigger,
                                 struct t_gui_buffer *buffer,
                                 struct t_hashtable *pointers,
                                 struct t_hashtable *extra_vars)
 {
     if (!trigger_buffer)
-        return;
+        return 0;
+
+    /* check if trigger matches the filter(s) */
+    if (!trigger_buffer_match_filters (trigger))
+        return 0;
 
     weechat_printf_tags (trigger_buffer, "no_trigger",
                          "%s\t%s%s %s(%s%s%s)",
@@ -124,97 +325,20 @@ trigger_buffer_display_trigger (struct t_trigger *trigger,
         trigger_buffer_display_hashtable ("pointers", pointers);
     if (extra_vars)
         trigger_buffer_display_hashtable ("extra_vars", extra_vars);
+
+    return 1;
 }
 
 /*
- * Callback for user data in trigger buffer.
- */
-
-int
-trigger_buffer_input_cb (void *data, struct t_gui_buffer *buffer,
-                        const char *input_data)
-{
-    /* make C compiler happy */
-    (void) data;
-
-    /* close buffer */
-    if (strcmp (input_data, "q") == 0)
-    {
-        weechat_buffer_close (buffer);
-        return WEECHAT_RC_OK;
-    }
-
-    return WEECHAT_RC_OK;
-}
-
-/*
- * Callback called when trigger buffer is closed.
- */
-
-int
-trigger_buffer_close_cb (void *data, struct t_gui_buffer *buffer)
-{
-    /* make C compiler happy */
-    (void) data;
-    (void) buffer;
-
-    trigger_buffer = NULL;
-
-    return WEECHAT_RC_OK;
-}
-
-/*
- * Restore buffer callbacks (input and close) for buffer created by trigger
- * plugin.
+ * Ends trigger buffer.
  */
 
 void
-trigger_buffer_set_callbacks ()
+trigger_buffer_end ()
 {
-    struct t_gui_buffer *ptr_buffer;
-
-    ptr_buffer = weechat_buffer_search (TRIGGER_PLUGIN_NAME,
-                                        TRIGGER_BUFFER_NAME);
-    if (ptr_buffer)
+    if (trigger_buffer_filters)
     {
-        trigger_buffer = ptr_buffer;
-        weechat_buffer_set_pointer (trigger_buffer, "close_callback",
-                                    &trigger_buffer_close_cb);
-        weechat_buffer_set_pointer (trigger_buffer, "input_callback",
-                                    &trigger_buffer_input_cb);
+        weechat_string_free_split (trigger_buffer_filters);
+        trigger_buffer_filters = NULL;
     }
 }
-
-/*
- * Opens trigger buffer.
- */
-
-void
-trigger_buffer_open (int switch_to_buffer)
-{
-    if (!trigger_buffer)
-    {
-        trigger_buffer = weechat_buffer_new (TRIGGER_BUFFER_NAME,
-                                             &trigger_buffer_input_cb, NULL,
-                                             &trigger_buffer_close_cb, NULL);
-
-        /* failed to create buffer ? then return */
-        if (!trigger_buffer)
-            return;
-
-        weechat_buffer_set (trigger_buffer, "title", _("Trigger monitor"));
-
-        if (!weechat_buffer_get_integer (trigger_buffer, "short_name_is_set"))
-            weechat_buffer_set (trigger_buffer, "short_name", TRIGGER_BUFFER_NAME);
-        weechat_buffer_set (trigger_buffer, "localvar_set_type", "debug");
-        weechat_buffer_set (trigger_buffer, "localvar_set_server", TRIGGER_BUFFER_NAME);
-        weechat_buffer_set (trigger_buffer, "localvar_set_channel", TRIGGER_BUFFER_NAME);
-        weechat_buffer_set (trigger_buffer, "localvar_set_no_log", "1");
-
-        /* disable all highlights on this buffer */
-        weechat_buffer_set (trigger_buffer, "highlight_words", "-");
-    }
-
-    if (switch_to_buffer)
-        weechat_buffer_set (trigger_buffer, "display", "1");
-}

src/plugins/trigger/trigger-buffer.h

@@ -24,11 +24,12 @@
 
 struct t_gui_buffer *trigger_buffer;
 
-extern void trigger_buffer_display_trigger (struct t_trigger *trigger,
-                                            struct t_gui_buffer *buffer,
-                                            struct t_hashtable *pointers,
-                                            struct t_hashtable *extra_vars);
 extern void trigger_buffer_set_callbacks ();
-extern void trigger_buffer_open (int switch_to_buffer);
+extern void trigger_buffer_open (const char *filter, int switch_to_buffer);
+extern int trigger_buffer_display_trigger (struct t_trigger *trigger,
+                                           struct t_gui_buffer *buffer,
+                                           struct t_hashtable *pointers,
+                                           struct t_hashtable *extra_vars);
+extern void trigger_buffer_end ();
 
 #endif /* WEECHAT_TRIGGER_BUFFER_H */

src/plugins/trigger/trigger-callback.c

@@ -162,7 +162,8 @@ trigger_callback_check_conditions (struct t_trigger *trigger,
 void
 trigger_callback_replace_regex (struct t_trigger *trigger,
                                 struct t_hashtable *pointers,
-                                struct t_hashtable *extra_vars)
+                                struct t_hashtable *extra_vars,
+                                int display_monitor)
 {
     char *value, *replace_eval;
     const char *ptr_key, *ptr_value;
@@ -182,7 +183,7 @@ trigger_callback_replace_regex (struct t_trigger *trigger,
             trigger_hook_regex_default_var[weechat_config_integer (trigger->options[TRIGGER_OPTION_HOOK])];
         if (!ptr_key || !ptr_key[0])
         {
-            if (trigger_buffer)
+            if (trigger_buffer && display_monitor)
             {
                 weechat_printf_tags (trigger_buffer, "no_trigger",
                                      "\t  regex %d: %s",
@@ -194,7 +195,7 @@ trigger_callback_replace_regex (struct t_trigger *trigger,
         ptr_value = weechat_hashtable_get (extra_vars, ptr_key);
         if (!ptr_value)
         {
-            if (trigger_buffer)
+            if (trigger_buffer && display_monitor)
             {
                 weechat_printf_tags (trigger_buffer, "no_trigger",
                                      "\t  regex %d (%s): %s",
@@ -218,7 +219,7 @@ trigger_callback_replace_regex (struct t_trigger *trigger,
             if (value)
             {
                 /* display debug info on trigger buffer */
-                if (trigger_buffer)
+                if (trigger_buffer && display_monitor)
                 {
                     weechat_printf_tags (trigger_buffer, "no_trigger",
                                          "\t  regex %d %s(%s%s%s)%s: "
@@ -250,7 +251,8 @@ void
 trigger_callback_run_command (struct t_trigger *trigger,
                               struct t_gui_buffer *buffer,
                               struct t_hashtable *pointers,
-                              struct t_hashtable *extra_vars)
+                              struct t_hashtable *extra_vars,
+                              int display_monitor)
 {
     char *command_eval;
     int i;
@@ -273,7 +275,7 @@ trigger_callback_run_command (struct t_trigger *trigger,
         if (command_eval)
         {
             /* display debug info on trigger buffer */
-            if (trigger_buffer)
+            if (trigger_buffer && display_monitor)
             {
                 weechat_printf_tags (trigger_buffer, "no_trigger",
                                      _("%s  running command %s\"%s%s%s\"%s "
@@ -312,19 +314,26 @@ trigger_callback_execute (struct t_trigger *trigger,
                           struct t_hashtable *pointers,
                           struct t_hashtable *extra_vars)
 {
+    int display_monitor;
+
     /* display debug info on trigger buffer */
     if (!trigger_buffer && (weechat_trigger_plugin->debug >= 1))
-        trigger_buffer_open (0);
-    trigger_buffer_display_trigger (trigger, buffer, pointers, extra_vars);
+        trigger_buffer_open (NULL, 0);
+    display_monitor = trigger_buffer_display_trigger (trigger,
+                                                      buffer,
+                                                      pointers,
+                                                      extra_vars);
 
     /* check conditions */
     if (trigger_callback_check_conditions (trigger, pointers, extra_vars))
     {
         /* replace text with regex */
-        trigger_callback_replace_regex (trigger, pointers, extra_vars);
+        trigger_callback_replace_regex (trigger, pointers, extra_vars,
+                                        display_monitor);
 
         /* execute command(s) */
-        trigger_callback_run_command (trigger, buffer, pointers, extra_vars);
+        trigger_callback_run_command (trigger, buffer, pointers, extra_vars,
+                                      display_monitor);
     }
 }
 

src/plugins/trigger/trigger-command.c

@@ -912,7 +912,7 @@ trigger_command_trigger (void *data, struct t_gui_buffer *buffer, int argc,
     /* open the trigger monitor buffer */
     if (weechat_strcasecmp (argv[1], "monitor") == 0)
     {
-        trigger_buffer_open (1);
+        trigger_buffer_open ((argc > 2) ? argv_eol[2] : NULL, 1);
         goto end;
     }
 
@@ -949,7 +949,7 @@ trigger_command_init ()
            " || show <name>"
            " || del <name>|-all [<name>...]"
            " || default -yes"
-           " || monitor"),
+           " || monitor [<filter>]"),
         N_("       list: list triggers (without argument, this list is displayed)\n"
            "   listfull: list triggers with detailed info for each trigger\n"
            "listdefault: list default triggers\n"
@@ -1001,7 +1001,10 @@ trigger_command_init ()
            "        del: delete a trigger\n"
            "       -all: do action on all triggers\n"
            "    default: restore default triggers\n"
-           "    monitor: open the trigger monitor buffer\n"
+           "    monitor: open the trigger monitor buffer, with optional filter:\n"
+           "     filter: filter hooks/triggers to display (a hook must start "
+           "with \"@\", for example \"@signal\"), many filters can be separated "
+           "by commas; each trigger name can start or end with \"*\"\n"
            "\n"
            "When a trigger callback is called, following actions are performed, "
            "in this order:\n"
@@ -1025,7 +1028,10 @@ trigger_command_init ()
            "    /trigger add resize_big signal signal_sigwinch "
            "\"${info:term_width} >= 100\" \"\" \"/bar show nicklist\"\n"
            "  silently save config each hour:\n"
-           "    /trigger add cfgsave timer 3600000;0;0 \"\" \"\" \"/mute /save\""),
+           "    /trigger add cfgsave timer 3600000;0;0 \"\" \"\" \"/mute /save\"\n"
+           "  open trigger monitor and show only modifiers and triggers whose "
+           "name starts with \"resize\":\n"
+           "    /trigger monitor @modifier,resize*"),
         "list|listfull|listdefault"
         " || add|addoff|addreplace %(trigger_names) %(trigger_hooks) "
         "%(trigger_hook_arguments) %(trigger_hook_conditions) "
@@ -1038,6 +1044,6 @@ trigger_command_init ()
         "%(trigger_names)|%*"
         " || show %(trigger_names)"
         " || default"
-        " || monitor",
+        " || monitor %(trigger_names)|%(trigger_hooks_filter)",
         &trigger_command_trigger, NULL);
 }

src/plugins/trigger/trigger-completion.c

@@ -163,6 +163,34 @@ trigger_completion_hooks_cb (void *data, const char *completion_item,
     return WEECHAT_RC_OK;
 }
 
+/*
+ * Adds hooks for filtering triggers to completion list.
+ */
+
+int
+trigger_completion_hooks_filter_cb (void *data, const char *completion_item,
+                                    struct t_gui_buffer *buffer,
+                                    struct t_gui_completion *completion)
+{
+    int i;
+    char str_hook[128];
+
+    /* make C compiler happy */
+    (void) data;
+    (void) completion_item;
+    (void) buffer;
+
+    for (i = 0; i < TRIGGER_NUM_HOOK_TYPES; i++)
+    {
+        snprintf (str_hook, sizeof (str_hook),
+                  "@%s", trigger_hook_type_string[i]);
+        weechat_hook_completion_list_add (completion, str_hook,
+                                          0, WEECHAT_LIST_POS_END);
+    }
+
+    return WEECHAT_RC_OK;
+}
+
 /*
  * Adds a word with quotes around to completion list.
  */
@@ -374,6 +402,9 @@ trigger_completion_init ()
     weechat_hook_completion ("trigger_hooks",
                              N_("hooks for triggers"),
                              &trigger_completion_hooks_cb, NULL);
+    weechat_hook_completion ("trigger_hooks_filter",
+                             N_("hooks for triggers (for filter in monitor buffer)"),
+                             &trigger_completion_hooks_filter_cb, NULL);
     weechat_hook_completion ("trigger_hook_arguments",
                              N_("default arguments for a hook"),
                              &trigger_completion_hook_arguments_cb, NULL);

src/plugins/trigger/trigger.c

@@ -1218,6 +1218,7 @@ weechat_plugin_end (struct t_weechat_plugin *plugin)
     /* make C compiler happy */
     (void) plugin;
 
+    trigger_buffer_end ();
     trigger_config_write ();
     trigger_free_all ();
     trigger_config_free ();