Issue 1107 - Support notifications

include/AdblockPlus/Notification.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 #ifndef ADBLOCK_PLUS_NOTIFICATION_H
 #define ADBLOCK_PLUS_NOTIFICATION_H
 
 #include <string>
 #include <vector>
-#include <memory>
+#include "tr1_memory.h"
 
 namespace AdblockPlus
 {
   class FilterEngine;
+  /**
+   * Possible notification types.
+   */
   enum NotificationType
   {
-    NOTIFICATION_TYPE_INFORMATION = 0,
-    NOTIFICATION_TYPE_QUESTION    = 1,
-    NOTIFICATION_TYPE_CRITICAL    = 2 
+    NOTIFICATION_TYPE_INFORMATION,
+    NOTIFICATION_TYPE_QUESTION,
+    NOTIFICATION_TYPE_CRITICAL
   };
 
-  struct NotificationTexts
-  {
-    std::string title;
-    std::string message;
-  };
-
-  class Notification : public JsValue
+  /**
+   * Wrapper for an Adblock Plus notification object.
+   */
+  class Notification: public JsValue
   {
     friend class FilterEngine;
   protected:
-    struct PrivateCtrArg{};
     static std::tr1::shared_ptr<Notification> JsValueToNotification(const JsValuePtr& jsValue);
-    /// @param jsText is javascript object returned by getLocalizedTexts.
-    static NotificationTexts JsTextsToNotificationTexts(const JsValue& jsText);
+    /**
+     * Constructor.
+     * @param jsValue `JsValuePtr` notification JavaScript object.
+     */
+    explicit Notification(const JsValuePtr& jsValue);
   public:
-    Notification(NotificationType type, const std::string& id, const JsValuePtr& jsValue, PrivateCtrArg);
-    Notification(const JsValuePtr& value, PrivateCtrArg);
-    std::string GetId() const;
+    /**
+     * Retrieves the type of this notification.
+     * @return Type of this notification.
+     */
     NotificationType GetType() const;
-    void SetTitle(const std::string& value, const std::string& locale = std::string());
-    void SetMessage(const std::string& value, const std::string& locale = std::string());
-    std::vector<std::string> GetUrlFilters() const;
-    void AddUrlFilter(const std::string& value);
+
+    /**
+     * Retrieves the title of this notification.
+     * @return Title of this notification.
+     */
+    const std::string& GetTitle() const;
+
+    /**
+     * Retrieves the message of this notification.
+     * @return Message of this notification.
+     */
+    const std::string& GetMessageString() const;
+
+    /**
+     * Marks this notification as shown. It is only relevant for question
+     * notifications. Other notifications are marked automatically.
+     */
+    void MarkAsShown();
   private:
-    void SetMultilingualProperty(const std::string& propertyName, const std::string& value, const std::string& locale);
+    std::string title;
+    std::string message;
+    NotificationType type;
   };
+  typedef std::tr1::shared_ptr<Notification> NotificationPtr;
 }
 
 #endif