1 files changed, 193 insertions, 17 deletions

diff --git a/src/androidselect.c b/src/androidselect.c
index 61f1c6045db..04f4cf1573f 100644
--- a/src/androidselect.c
+++ b/src/androidselect.c
@@ -30,6 +30,7 @@ along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.  */
 #include "coding.h"
 #include "android.h"
 #include "androidterm.h"
+#include "termhooks.h"
 
 /* Selection support on Android is confined to copying and pasting of
    plain text and MIME data from the clipboard.  There is no primary
@@ -490,6 +491,9 @@ struct android_emacs_desktop_notification
 /* Methods provided by the EmacsDesktopNotification class.  */
 static struct android_emacs_desktop_notification notification_class;
 
+/* Hash table pairing notification identifiers with callbacks.  */
+static Lisp_Object notification_table;
+
 /* Initialize virtual function IDs and class pointers tied to the
    EmacsDesktopNotification class.  */
 
@@ -521,7 +525,8 @@ android_init_emacs_desktop_notification (void)
 
   FIND_METHOD (init, "<init>", "(Ljava/lang/String;"
                "Ljava/lang/String;Ljava/lang/String;"
-               "Ljava/lang/String;II)V");
+               "Ljava/lang/String;II[Ljava/lang/String;"
+               "[Ljava/lang/String;)V");
   FIND_METHOD (display, "display", "()V");
 #undef FIND_METHOD
 }
@@ -562,25 +567,32 @@ android_locate_icon (const char *name)
 }
 
 /* Display a desktop notification with the provided TITLE, BODY,
-   REPLACES_ID, GROUP, ICON, and URGENCY.  Return an identifier for
-   the resulting notification.  */
+   REPLACES_ID, GROUP, ICON, URGENCY, ACTIONS, ACTION_CB and CANCEL_CB.
+   Return an identifier for the resulting notification.  */
 
 static intmax_t
 android_notifications_notify_1 (Lisp_Object title, Lisp_Object body,
                                 Lisp_Object replaces_id,
                                 Lisp_Object group, Lisp_Object icon,
-                                Lisp_Object urgency)
+                                Lisp_Object urgency, Lisp_Object actions,
+                                Lisp_Object action_cb,
+                                Lisp_Object cancel_cb)
 {
   static intmax_t counter;
   intmax_t id;
   jstring title1, body1, group1, identifier1;
   jint type, icon1;
   jobject notification;
+  jobjectArray action_keys, action_titles;
   char identifier[INT_STRLEN_BOUND (int)
                   + INT_STRLEN_BOUND (long int)
                   + INT_STRLEN_BOUND (intmax_t)
                   + sizeof "..."];
   struct timespec boot_time;
+  Lisp_Object key, value, tem;
+  jint nitems, i;
+  jstring item;
+  Lisp_Object length;
 
   if (EQ (urgency, Qlow))
     type = 2; /* IMPORTANCE_LOW */
@@ -591,6 +603,29 @@ android_notifications_notify_1 (Lisp_Object title, Lisp_Object body,
   else
     signal_error ("Invalid notification importance given", urgency);
 
+  nitems = 0;
+
+  /* If ACTIONS is provided, split it into two arrays of Java strings
+     holding keys and titles.  */
+
+  if (!NILP (actions))
+    {
+      /* Count the number of items to be inserted.  */
+
+      length = Flength (actions);
+      if (!TYPE_RANGED_FIXNUMP (jint, length))
+        error ("Action list too long");
+      nitems = XFIXNAT (length);
+      if (nitems & 1)
+        error ("Length of action list is invalid");
+      nitems /= 2;
+
+      /* Verify that the list consists exclusively of strings.  */
+      tem = actions;
+      FOR_EACH_TAIL (tem)
+        CHECK_STRING (XCAR (tem));
+    }
+
   if (NILP (replaces_id))
     {
       /* Generate a new identifier.  */
@@ -626,14 +661,62 @@ android_notifications_notify_1 (Lisp_Object title, Lisp_Object body,
     = (*android_java_env)->NewStringUTF (android_java_env, identifier);
   android_exception_check_3 (title1, body1, group1);
 
+  /* Create the arrays for action identifiers and titles if
+     provided.  */
+
+  if (nitems)
+    {
+      action_keys = (*android_java_env)->NewObjectArray (android_java_env,
+                                                         nitems,
+                                                         java_string_class,
+                                                         NULL);
+      android_exception_check_4 (title, body1, group1, identifier1);
+      action_titles = (*android_java_env)->NewObjectArray (android_java_env,
+                                                           nitems,
+                                                           java_string_class,
+                                                           NULL);
+      android_exception_check_5 (title, body1, group1, identifier1,
+                                 action_keys);
+
+      for (i = 0; i < nitems; ++i)
+        {
+          key = XCAR (actions);
+          value = XCAR (XCDR (actions));
+          actions = XCDR (XCDR (actions));
+
+          /* Create a string for this action.  */
+          item = android_build_string (key, body1, group1, identifier1,
+                                       action_keys, action_titles, NULL);
+          (*android_java_env)->SetObjectArrayElement (android_java_env,
+                                                      action_keys, i,
+                                                      item);
+          ANDROID_DELETE_LOCAL_REF (item);
+
+          /* Create a string for this title.  */
+          item = android_build_string (value, body1, group1, identifier1,
+                                       action_keys, action_titles, NULL);
+          (*android_java_env)->SetObjectArrayElement (android_java_env,
+                                                      action_titles, i,
+                                                      item);
+          ANDROID_DELETE_LOCAL_REF (item);
+        }
+    }
+  else
+    {
+      action_keys = NULL;
+      action_titles = NULL;
+    }
+
   /* Create the notification.  */
   notification
     = (*android_java_env)->NewObject (android_java_env,
                                       notification_class.class,
                                       notification_class.init,
                                       title1, body1, group1,
-                                      identifier1, icon1, type);
-  android_exception_check_4 (title1, body1, group1, identifier1);
+                                      identifier1, icon1, type,
+                                      action_keys, action_titles);
+  android_exception_check_6 (title1, body1, group1, identifier1,
+                             action_titles, action_keys);
 
   /* Delete unused local references.  */
   ANDROID_DELETE_LOCAL_REF (title1);
@@ -641,6 +724,12 @@ android_notifications_notify_1 (Lisp_Object title, Lisp_Object body,
   ANDROID_DELETE_LOCAL_REF (group1);
   ANDROID_DELETE_LOCAL_REF (identifier1);
 
+  if (action_keys)
+    ANDROID_DELETE_LOCAL_REF (action_keys);
+
+  if (action_titles)
+    ANDROID_DELETE_LOCAL_REF (action_titles);
+
   /* Display the notification.  */
   (*android_java_env)->CallNonvirtualVoidMethod (android_java_env,
                                                  notification,
@@ -649,6 +738,12 @@ android_notifications_notify_1 (Lisp_Object title, Lisp_Object body,
   android_exception_check_1 (notification);
   ANDROID_DELETE_LOCAL_REF (notification);
 
+  /* If callbacks are provided, save them into notification_table. */
+
+  if (!NILP (action_cb) || !NILP (cancel_cb))
+    Fputhash (build_string (identifier), Fcons (action_cb, cancel_cb),
+              notification_table);
+
   /* Return the ID.  */
   return id;
 }
@@ -659,14 +754,28 @@ DEFUN ("android-notifications-notify", Fandroid_notifications_notify,
 ARGS must contain keywords followed by values.  Each of the following
 keywords is understood:
 
-  :title        The notification title.
-  :body         The notification body.
-  :replaces-id  The ID of a previous notification to supersede.
-  :group        The notification group, or nil.
-  :urgency      One of the symbols `low', `normal' or `critical',
-                defining the importance of the notification group.
-  :icon         The name of a drawable resource to display as the
-                notification's icon.
+  :title        The notification title.
+  :body The notification body.
+  :replaces-id  The ID of a previous notification to supersede.
+  :group        The notification group, or nil.
+  :urgency      One of the symbols `low', `normal' or `critical',
+                defining the importance of the notification group.
+  :icon The name of a drawable resource to display as the
+                notification's icon.
+  :actions      A list of actions of the form:
+                  (KEY TITLE KEY TITLE ...)
+                where KEY and TITLE are both strings.
+                The action for which CALLBACK is called when the
+                notification itself is selected is named "default",
+                its existence is implied, and its TITLE is ignored.
+                No more than three actions can be defined, not
+                counting any action with "default" as its key.
+  :on-action    Function to call when an action is invoked.
+                The notification id and the key of the action are
+                provided as arguments to the function.
+  :on-cancel    Function to call if the notification is dismissed,
+                with the notification id and the symbol `undefined'
+                for arguments.
 
 The notification group is ignored on Android 7.1 and earlier versions
 of Android.  Outside such older systems, it identifies a category that
@@ -686,6 +795,9 @@ within the "android.R.drawable" class designating an icon with a
 transparent background.  If no icon is provided (or the icon is absent
 from this system), it defaults to "ic_dialog_alert".
 
+Actions specified with :actions cannot be displayed on Android 4.0 and
+earlier versions of the system.
+
 When the system is running Android 13 or later, notifications sent
 will be silently disregarded unless permission to display
 notifications is expressly granted from the "App Info" settings panel
@@ -701,14 +813,15 @@ usage: (android-notifications-notify &rest ARGS) */)
 {
   Lisp_Object title, body, replaces_id, group, urgency;
   Lisp_Object icon;
-  Lisp_Object key, value;
+  Lisp_Object key, value, actions, action_cb, cancel_cb;
   ptrdiff_t i;
 
   if (!android_init_gui)
     error ("No Android display connection!");
 
   /* Clear each variable above.  */
-  title = body = replaces_id = group = icon = urgency = Qnil;
+  title = body = replaces_id = group = icon = urgency = actions = Qnil;
+  action_cb = cancel_cb = Qnil;
 
   /* If NARGS is odd, error.  */
 
@@ -734,6 +847,12 @@ usage: (android-notifications-notify &rest ARGS) */)
         urgency = value;
       else if (EQ (key, QCicon))
         icon = value;
+      else if (EQ (key, QCactions))
+        actions = value;
+      else if (EQ (key, QCon_action))
+        action_cb = value;
+      else if (EQ (key, QCon_cancel))
+        cancel_cb = value;
     }
 
   /* Demand at least TITLE and BODY be present.  */
@@ -758,7 +877,58 @@ usage: (android-notifications-notify &rest ARGS) */)
     CHECK_STRING (icon);
 
   return make_int (android_notifications_notify_1 (title, body, replaces_id,
-                                                   group, icon, urgency));
+                                                   group, icon, urgency,
+                                                   actions, action_cb,
+                                                   cancel_cb));
+}
+
+/* Run callbacks in response to a notification being deleted.
+   Save any input generated for the keyboard within *IE.
+   EVENT should be the notification deletion event.  */
+
+void
+android_notification_deleted (struct android_notification_event *event,
+                              struct input_event *ie)
+{
+  Lisp_Object item, tag;
+  intmax_t id;
+
+  tag  = build_string (event->tag);
+  item = Fgethash (tag, notification_table, Qnil);
+
+  if (!NILP (item))
+    Fremhash (tag, notification_table);
+
+  if (CONSP (item) && FUNCTIONP (XCDR (item))
+      && sscanf (event->tag, "%*d.%*ld.%jd", &id) > 0)
+    {
+      ie->kind = NOTIFICATION_EVENT;
+      ie->arg  = list3 (XCDR (item), make_int (id),
+                        Qundefined);
+    }
+}
+
+/* Run callbacks in response to one of a notification's actions being
+   invoked, saving any input generated for the keyboard within *IE.
+   EVENT should be the notification deletion event, and ACTION the
+   action key.  */
+
+void
+android_notification_action (struct android_notification_event *event,
+                             struct input_event *ie, Lisp_Object action)
+{
+  Lisp_Object item, tag;
+  intmax_t id;
+
+  tag  = build_string (event->tag);
+  item = Fgethash (tag, notification_table, Qnil);
+
+  if (CONSP (item) && FUNCTIONP (XCAR (item))
+      && sscanf (event->tag, "%*d.%*ld.%jd", &id) > 0)
+    {
+      ie->kind = NOTIFICATION_EVENT;
+      ie->arg  = list3 (XCAR (item), make_int (id), action);
+    }
 }
 
 
@@ -800,6 +970,9 @@ syms_of_androidselect (void)
   DEFSYM (QCgroup, ":group");
   DEFSYM (QCurgency, ":urgency");
   DEFSYM (QCicon, ":icon");
+  DEFSYM (QCactions, ":actions");
+  DEFSYM (QCon_action, ":on-action");
+  DEFSYM (QCon_cancel, ":on-cancel");
 
   DEFSYM (Qlow, "low");
   DEFSYM (Qnormal, "normal");
@@ -814,4 +987,7 @@ syms_of_androidselect (void)
   defsubr (&Sandroid_get_clipboard_data);
 
   defsubr (&Sandroid_notifications_notify);
+
+  notification_table = CALLN (Fmake_hash_table, QCtest, Qequal);
+  staticpro (&notification_table);
 }