Add NotificationOptions.actions so websites can provide buttons (blink)

Source/modules/notifications/Notification.h

 /*
  * Copyright (C) 2013 Google Inc. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions are
  * met:
  *
  *     * Redistributions of source code must retain the above copyright
  * notice, this list of conditions and the following disclaimer.
  *     * Redistributions in binary form must reproduce the above
@@ skipping 17 matching lines @@
  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 
 #ifndef Notification_h
 #define Notification_h
 
 #include "bindings/core/v8/SerializedScriptValue.h"
 #include "core/dom/ActiveDOMObject.h"
 #include "modules/EventTargetModules.h"
 #include "modules/ModulesExport.h"
+#include "modules/notifications/NotificationAction.h"
 #include "modules/vibration/NavigatorVibration.h"
 #include "platform/AsyncMethodRunner.h"
 #include "platform/heap/Handle.h"
 #include "platform/text/TextDirection.h"
 #include "platform/weborigin/KURL.h"
+#include "public/platform/WebVector.h"
+#include "public/platform/modules/notifications/WebNotificationAction.h"
 #include "public/platform/modules/notifications/WebNotificationDelegate.h"
 #include "public/platform/modules/notifications/WebNotificationPermission.h"
 #include "wtf/PassOwnPtr.h"
 #include "wtf/PassRefPtr.h"
 #include "wtf/RefCounted.h"
 #include "wtf/RefPtr.h"
 
 namespace blink {
 
 class ExecutionContext;
@@ skipping 30 matching lines @@
     void dispatchClickEvent() override;
     void dispatchErrorEvent() override;
     void dispatchCloseEvent() override;
 
     String title() const { return m_title; }
     String dir() const { return m_dir; }
     String lang() const { return m_lang; }
     String body() const { return m_body; }
     String tag() const { return m_tag; }
     String icon() const { return m_iconUrl; }
-    NavigatorVibration::VibrationPattern vibrate(bool& isNull) const;
+    const NavigatorVibration::VibrationPattern& vibrate(bool& isNull) const;
     bool silent() const { return m_silent; }
     ScriptValue data(ScriptState*) const;
+    const Vector<NotificationAction>& actions() const { return m_actions; }
 
     TextDirection direction() const;
     KURL iconURL() const { return m_iconUrl; }
     SerializedScriptValue* serializedData() const { return m_serializedData.get(); }
 
     static String permissionString(WebNotificationPermission);
     static String permission(ExecutionContext*);
     static WebNotificationPermission checkPermission(ExecutionContext*);
     static void requestPermission(ExecutionContext*, NotificationPermissionCallback* = nullptr);
 
+    template<size_t C, typename A>
+    static void actionsToWebActions(const Vector<NotificationAction, C, A>& actions, WebVector<WebNotificationAction>& webActions);
+    static void webActionsToActions(const WebVector<WebNotificationAction>& webActions, Vector<NotificationAction>& actions);

[Peter Beverloo, 2015/07/30 16:24:07]

This can be private.

[johnme, 2015/07/31 15:10:10]

Done.

+
     // EventTarget interface.
     ExecutionContext* executionContext() const final { return ActiveDOMObject::executionContext(); }
     const AtomicString& interfaceName() const override;
 
     // ActiveDOMObject interface.
     void stop() override;
     bool hasPendingActivity() const override;
 
     DECLARE_VIRTUAL_TRACE();
 
 protected:
     // EventTarget interface.
     bool dispatchEventInternal(PassRefPtrWillBeRawPtr<Event>) final;
 
 private:
+    // Conveniently, all Blink platforms that support notifications currently support 2 actions.
+    static const size_t maxActions = 2;

[Peter Beverloo, 2015/07/30 16:24:08]

This is an embedder concern, not a Blink one. Perhaps add something like
WebNotificationManager::supportedActionCount()?

[johnme, 2015/07/31 15:10:10]

Done.

+
     Notification(const String& title, ExecutionContext*);
 
     void scheduleShow();
 
     // Calling show() may start asynchronous operation. If this object has
     // a V8 wrapper, hasPendingActivity() prevents the wrapper from being
     // collected while m_state is Showing, and so this instance stays alive
     // until the operation completes. Otherwise, you need to hold a ref on this
     // instance until the operation completes.
     void show();
 
     void setDir(const String& dir) { m_dir = dir; }
     void setLang(const String& lang) { m_lang = lang; }
     void setBody(const String& body) { m_body = body; }
     void setIconUrl(KURL iconUrl) { m_iconUrl = iconUrl; }
     void setTag(const String& tag) { m_tag = tag; }
     void setVibrate(const NavigatorVibration::VibrationPattern& vibrate) { m_vibrate = vibrate; }
     void setSilent(bool silent) { m_silent = silent; }
     void setSerializedData(PassRefPtr<SerializedScriptValue> data) { m_serializedData = data; }
+    void setActions(const Vector<NotificationAction>& actions) { m_actions = actions; }
 
     void setPersistentId(int64_t persistentId) { m_persistentId = persistentId; }
 
-private:
     String m_title;
     String m_dir;
     String m_lang;
     String m_body;
     String m_tag;
     NavigatorVibration::VibrationPattern m_vibrate;
     bool m_silent;
     RefPtr<SerializedScriptValue> m_serializedData;
+    Vector<NotificationAction> m_actions;
 
     KURL m_iconUrl;
 
     // Notifications can either be bound to the page, which means they're identified by
     // their delegate, or persistent, which means they're identified by a persistent Id
     // given to us by the embedder. This influences how we close the notification.
     int64_t m_persistentId;
 
     enum NotificationState {
         NotificationStateIdle,
         NotificationStateShowing,
         NotificationStateClosing,
         NotificationStateClosed
     };
 
     // Only to be used by the Notification::create() method when notifications were created
     // by the embedder rather than by Blink.
     void setState(NotificationState state) { m_state = state; }
 
     NotificationState m_state;
 
     AsyncMethodRunner<Notification> m_asyncRunner;
 };
 
+template<size_t C, typename A>
+void Notification::actionsToWebActions(const Vector<NotificationAction, C, A>& actions, WebVector<WebNotificationAction>& webActions)

[Peter Beverloo, 2015/07/30 16:24:07]

nit: While the Blink style allows it, I'd prefer it if you would pass the second
argument as a pointer to indicate that it's getting changed. Clearer when
reading the call-sites.

[Peter Beverloo, 2015/07/30 16:24:08]

Why do we need template<>? This should be defined in the implementation file,
and the |maxActions| constant should be local to Notification.cpp.

[johnme, 2015/07/31 15:10:10]

Done.

[johnme, 2015/07/31 15:10:10]

Done (without the template, we need an extra copy from HeapVector to Vector, but
we discussed offline and agreed that was ok).

+{
+    size_t count = std::min(+maxActions, actions.size());
+    WebVector<WebNotificationAction> clearedAndResized(count);
+    webActions.swap(clearedAndResized);
+    for (size_t i = 0; i < count; ++i) {
+        webActions[i].title = actions[i].title();
+    }
+}
+
 } // namespace blink
 
 #endif // Notification_h