[Mac] Implement a NotificationUIManager that uses Notification Center on 10.8 for text notifications

chrome/browser/notifications/notification_ui_manager_mac.h

Index: chrome/browser/notifications/notification_ui_manager_mac.h
diff --git a/chrome/browser/notifications/notification_ui_manager_mac.h b/chrome/browser/notifications/notification_ui_manager_mac.h
new file mode 100644
index 0000000000000000000000000000000000000000..22f0c4657281301ffb845f64b0ed6a47723aedca
--- /dev/null
+++ b/chrome/browser/notifications/notification_ui_manager_mac.h
@@ -0,0 +1,82 @@
+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+#ifndef CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_MAC_H_
+#define CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_MAC_H_
+#pragma once
+
+#import <AppKit/AppKit.h>
+
+#include <map>
+
+#include "base/basictypes.h"
+#include "base/memory/scoped_nsobject.h"
+#include "base/memory/scoped_ptr.h"
+#include "base/string16.h"
+#include "chrome/browser/notifications/notification_ui_manager.h"
+
+@protocol CrUserNotification;
+class Notification;
+@class NotificationCenterDelegate;
+class NotificationUIManagerImpl;
+class PrefService;
+class Profile;
+
+// This class is an implementation of NotificationUIManager that will send
+// text-only (non-HTML) notifications to Notification Center on 10.8. This
+// class is only instantiated on 10.8 and above. For HTML notifications,
+// this class uses an instance of NotificationUIManagerImpl to present
+// notifications in the typical way.
+class NotificationUIManagerMac : public NotificationUIManager {
+ public:
+  explicit NotificationUIManagerMac(PrefService* local_state);
+  virtual ~NotificationUIManagerMac();
+
+  // NotificationUIManager:
+  virtual void Add(const Notification& notification,
+                   Profile* profile) OVERRIDE;
+  virtual bool CancelById(const std::string& notification_id) OVERRIDE;
+  virtual bool CancelAllBySourceOrigin(const GURL& source_origin) OVERRIDE;
+  virtual void CancelAll() OVERRIDE;
+  virtual BalloonCollection* balloon_collection() OVERRIDE;
+  virtual NotificationPrefsManager* prefs_manager() OVERRIDE;
+  virtual void GetQueuedNotificationsForTesting(
+      std::vector<const Notification*>* notifications) OVERRIDE;
+
+  // Returns the corresponding C++ object for the Cocoa notification object,
+  // or NULL if it could not be found.
+  const Notification* FindNotificationWithCocoaNotification(

[jianli, 2012/04/10 00:54:14]

nit: please add const modifier.

[Robert Sesek, 2012/04/12 17:48:47]

Done.

+      id<CrUserNotification> notification);
+
+  NotificationUIManagerImpl* builtin_manager() {

[jianli, 2012/04/10 00:54:14]

ditto.

[Robert Sesek, 2012/04/12 17:48:47]

Done.

+    return builtin_manager_.get();
+  }
+
+ private:
+  typedef std::map<id<CrUserNotification>, Notification*> NotificationMap;

[jianli, 2012/04/10 00:54:14]

Which scenario do we want to optimize for by using map container? It seems that
you're always traversing the whole collection when finding or removing a
notification. If so, there is no difference from using vector. If we do want to
optimize the above scenarios, perhaps you could consider using notification_id
as the key value.

[Robert Sesek, 2012/04/12 17:48:47]

Good insight! I originally used pointer equality, for which this map layout was
optimized, but later found out that the Cocoa framework does not guarantee that.
I've optimized for the notification_id case now.

+
+  // Erases a Cocoa notification from both the application and Notification
+  // Center, and deletes the corresponding C++ object.
+  bool RemoveNotification(id<CrUserNotification> notification);
+
+  // Finds a notification with a given replacement id.
+  id<CrUserNotification> FindNotificationWithReplacementId(

[jianli, 2012/04/10 00:54:14]

ditto.

[Robert Sesek, 2012/04/12 17:48:47]

Done.

+      const string16& replacement_id);
+
+  // The class used to present HTML notifications that can't be sent to
+  // Notification Center.
+  scoped_ptr<NotificationUIManagerImpl> builtin_manager_;
+
+  // Cocoa class that receives callbacks from the NSUserNotificationCenter.
+  scoped_nsobject<NotificationCenterDelegate> delegate_;
+
+  // A mapping between the Cocoa objects and the C++ objects. Both objects are
+  // owned, so the key must be released and the value must be deleted when
+  // removed from the map, typically done with RemoveNotification.
+  NotificationMap notification_map_;
+
+  DISALLOW_COPY_AND_ASSIGN(NotificationUIManagerMac);
+};
+
+#endif  // CHROME_BROWSER_NOTIFICATIONS_NOTIFICATION_UI_MANAGER_MAC_H_