Noissue - updated to libadblockplus revision 2b0c6fd016be

include/AdblockPlus/FilterEngine.h

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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
@@ skipping 19 matching lines @@
 {
   class FilterEngine;
   typedef std::shared_ptr<FilterEngine> FilterEnginePtr;
 
   /**
    * Wrapper for an Adblock Plus filter object.
    * There are no accessors for most
    * [filter properties](https://adblockplus.org/jsdoc/adblockpluscore/Filter.html),
    * use `GetProperty()` to retrieve them by name.
    */
-  class Filter : public JsValue,
-                 public std::enable_shared_from_this<Filter>
+  class Filter : public JsValue
   {
+    friend class FilterEngine;
   public:
+    Filter(const Filter& src);
+    Filter(Filter&& src);
+    Filter& operator=(const Filter& src);
+    Filter& operator=(Filter&& src);
+
     /**
      * Filter types, see https://adblockplus.org/en/filters.
      */
     enum Type {TYPE_BLOCKING, TYPE_EXCEPTION,
                TYPE_ELEMHIDE, TYPE_ELEMHIDE_EXCEPTION,
                TYPE_COMMENT, TYPE_INVALID};
 
     /**
      * Retrieves the type of this filter.
      * @return Type of this filter.
@@ skipping 11 matching lines @@
      */
     void AddToList();
 
     /**
      * Removes this filter from the list of custom filters.
      */
     void RemoveFromList();
 
     bool operator==(const Filter& filter) const;
 
+  protected:
     /**
      * Creates a wrapper for an existing JavaScript filter object.
      * Normally you shouldn't call this directly, but use
      * FilterEngine::GetFilter() instead.
      * @param value JavaScript filter object.
      */
     Filter(JsValue&& value);
   };
 
   /**
    * Wrapper for a subscription object.
    * There are no accessors for most
    * [subscription properties](https://adblockplus.org/jsdoc/adblockpluscore/Subscription.html),
    * use `GetProperty()` to retrieve them by name.
    */
-  class Subscription : public JsValue,
-                       public std::enable_shared_from_this<Subscription>
+  class Subscription : public JsValue
   {
+    friend class FilterEngine;
   public:
     /**
+     * Copy constructor
+     */
+    Subscription(const Subscription& src);
+
+    /**
+     * Move constructor
+     */
+    Subscription(Subscription&& src);
+
+    /**
+     * Assignment operator
+     */
+    Subscription& operator=(const Subscription& src);
+
+    /**
+     * Move assignment operator
+     */
+    Subscription& operator=(Subscription&& src);
+
+    /**
      * Checks if this subscription has been added to the list of subscriptions.
      * @return `true` if this subscription has been added.
      */
     bool IsListed() const;
 
     /**
      * Adds this subscription to the list of subscriptions.
      */
     void AddToList();
 
     /**
      * Removes this subscription from the list of subscriptions.
      */
     void RemoveFromList();
 
     /**
      * Updates this subscription, i.e.\ retrieves the current filters from the
      * subscription URL.
      */
     void UpdateFilters();
 
     /**
      * Checks if the subscription is currently being updated.
      * @return `true` if the subscription is currently being updated.
      */
     bool IsUpdating() const;
 
     /**
-     * Indicates whether the subscription is acceptable ads subscription.
-     * @return `true` if this subscription is acceptable ads subscription.
+     * Indicates whether the subscription is the Acceptable Ads subscription.
+     * @return `true` if this subscription is the Acceptable Ads subscription.
      */
     bool IsAA() const;
 
     bool operator==(const Subscription& subscription) const;
 
+  protected:
     /**
      * Creates a wrapper for an existing JavaScript subscription object.
      * Normally you shouldn't call this directly, but use
      * FilterEngine::GetSubscription() instead.
      * @param value JavaScript subscription object.
      */
     Subscription(JsValue&& value);
   };
 
   /**
-   * Shared smart pointer to a `Filter` instance.
+   * A smart pointer to a `Filter` instance.
    */
-  typedef std::shared_ptr<Filter> FilterPtr;
-
-  /**
-   * Shared smart pointer to a `Subscription` instance.
-   */
-  typedef std::shared_ptr<Subscription> SubscriptionPtr;
+  typedef std::unique_ptr<Filter> FilterPtr;
 
   /**
    * Main component of libadblockplus.
    * It handles:
    * - Filter management and matching.
    * - Subscription management and synchronization.
    * - Update checks for the application.
    */
   class FilterEngine
   {
@@ skipping 41 matching lines @@
      */
     typedef std::function<void(const std::string&)> UpdateCheckDoneCallback;
 
     /**
      * Callback type invoked when the filters change.
      * The first parameter is the action event code (see
      * [FilterNotifier.triggerListeners](https://adblockplus.org/jsdoc/adblockpluscore/FilterNotifier.html#.triggerListeners)
      * for the full list).
      * The second parameter is the filter/subscription object affected, if any.
      */
-    typedef std::function<void(const std::string&, const JsValuePtr)> FilterChangeCallback;
+    typedef std::function<void(const std::string&, const JsValue&)> FilterChangeCallback;
 
     /**
      * Container of name-value pairs representing a set of preferences.
      */
-    typedef std::map<std::string, AdblockPlus::JsValuePtr> Prefs;
+    typedef std::map<std::string, AdblockPlus::JsValue> Prefs;
 
     /**
      * Callback type invoked when a new notification should be shown.
      * The parameter is the Notification object to be shown.
      */
-    typedef std::function<void(const NotificationPtr&)> ShowNotificationCallback;
+    typedef std::function<void(Notification&)> ShowNotificationCallback;
 
     /**
      * Callback function returning false when current connection is not
      * allowedConnectionType, e.g. because it is a metered connection.
      */
     typedef std::function<bool(const std::string* allowedConnectionType)> IsConnectionAllowedCallback;
 
     /**
      * FilterEngine creation parameters.
      */
@@ skipping 47 matching lines @@
      * @return `true` if the application is running for the first time.
      */
     bool IsFirstRun() const;
 
     /**
      * Retrieves a filter object from its text representation.
      * @param text Text representation of the filter,
      *        see https://adblockplus.org/en/filters.
      * @return New `Filter` instance.
      */
-    FilterPtr GetFilter(const std::string& text) const;
+    Filter GetFilter(const std::string& text) const;
 
     /**
      * Retrieves a subscription object for the supplied URL.
      * @param url Subscription URL.
      * @return New `Subscription` instance.
      */
-    SubscriptionPtr GetSubscription(const std::string& url) const;
+    Subscription GetSubscription(const std::string& url) const;
 
     /**
      * Retrieves the list of custom filters.
      * @return List of custom filters.
      */
-    std::vector<FilterPtr> GetListedFilters() const;
+    std::vector<Filter> GetListedFilters() const;
 
     /**
      * Retrieves all subscriptions.
      * @return List of subscriptions.
      */
-    std::vector<SubscriptionPtr> GetListedSubscriptions() const;
+    std::vector<Subscription> GetListedSubscriptions() const;
 
     /**
      * Retrieves all recommended subscriptions.
      * @return List of recommended subscriptions.
      */
-    std::vector<SubscriptionPtr> FetchAvailableSubscriptions() const;
+    std::vector<Subscription> FetchAvailableSubscriptions() const;
 
     /**
-     * Ensures that Acceptable Ads subscription is enabled or disabled.
+     * Ensures that the Acceptable Ads subscription is enabled or disabled.
      * @param enabled
      *   - if the value is `true`
      *     - ensure that the filter set includes an enabled AA subscription,
      *       adding it if needed and enabling it if disabled.
      *   - if the value is `false`
      *     - if an AA subscription is present, disable it.
      *     - if absent, do nothing.
      */
     void SetAAEnabled(bool enabled);
 
     /**
-     * Checks whether Acceptable Ads subscription is enabled.
-     * @return `true` if acceptable ads subscription is present and enabled.
+     * Checks whether the Acceptable Ads subscription is enabled.
+     * @return `true` if the Acceptable Ads subscription is present and enabled.
      */
     bool IsAAEnabled() const;
 
     /**
-     * Retrieves the URL of Acceptable Ads subscription, what makes the URL
-     * available even if subscription is not add yet.
-     * @return Returns URL of Acceptable Ads.
+     * Retrieves the URL of the Acceptable Ads subscription, what makes the URL
+     * available even if subscription is not added yet.
+     * @return Returns URL of the Acceptable Ads.
      */
     std::string GetAAUrl() const;
 
     /**
      * Invokes the listener set via SetNotificationAvailableCallback() with the
      * next notification to be shown.
      * @param url URL to match notifications to (optional).
      */
-    void ShowNextNotification(const std::string& url = std::string());
+    void ShowNextNotification(const std::string& url = std::string()) const;
 
     /**
      * Sets the callback invoked when a notification should be shown.
      * @param callback Callback to invoke.
      */
     void SetShowNotificationCallback(const ShowNotificationCallback& value);
 
     /**
      * Removes the callback invoked when a notification should be shown.
      */
@@ skipping 65 matching lines @@
      * @param domain Domain to retrieve CSS selectors for.
      * @return List of CSS selectors.
      */
     std::vector<std::string> GetElementHidingSelectors(const std::string& domain) const;
 
     /**
      * Retrieves a preference value.
      * @param pref Preference name.
      * @return Preference value, or `null` if it doesn't exist.
      */
-    JsValuePtr GetPref(const std::string& pref) const;
+    JsValue GetPref(const std::string& pref) const;
 
     /**
      * Sets a preference value.
      * @param pref Preference name.
      * @param value New value of the preference.
      */
-    void SetPref(const std::string& pref, JsValuePtr value);
+    void SetPref(const std::string& pref, const JsValue& value);
 
     /**
      * Extracts the host from a URL.
      * @param url URL to extract the host from.
      * @return Extracted host.
      */
     std::string GetHostFromURL(const std::string& url) const;
 
     /**
      * Sets the callback invoked when an application update becomes available.
      * @param callback Callback to invoke.
      */
-    void SetUpdateAvailableCallback(UpdateAvailableCallback callback);
+    void SetUpdateAvailableCallback(const UpdateAvailableCallback& callback);
 
     /**
      * Removes the callback invoked when an application update becomes
      * available.
      */
     void RemoveUpdateAvailableCallback();
 
     /**
      * Forces an immediate update check.
      * `FilterEngine` will automatically check for updates in regular intervals,
      * so applications should only call this when the user triggers an update
      * check manually.
      * @param callback Optional callback to invoke when the update check is
      *        finished. The string parameter will be empty when the update check
      *        succeeded, or contain an error message if it failed.
      *        Note that the callback will be invoked whether updates are
      *        available or not - to react to updates being available, use
      *        `FilterEngine::SetUpdateAvailableCallback()`.
      */
     void ForceUpdateCheck(const UpdateCheckDoneCallback& callback = UpdateCheckDoneCallback());
 
     /**
      * Sets the callback invoked when the filters change.
      * @param callback Callback to invoke.
      */
-    void SetFilterChangeCallback(FilterChangeCallback callback);
+    void SetFilterChangeCallback(const FilterChangeCallback& callback);
 
     /**
      * Removes the callback invoked when the filters change.
      */
     void RemoveFilterChangeCallback();
 
     /**
      * Stores the value indicating what connection types are allowed, it is
      * passed to CreateParameters::isConnectionAllowed callback.
      * @param value Stored value. nullptr means removing of any previously
@@ skipping 39 matching lines @@
     JsEnginePtr jsEngine;
     bool firstRun;
     int updateCheckId;
     static const std::map<ContentType, std::string> contentTypes;
 
     explicit FilterEngine(const JsEnginePtr& jsEngine);
 
     FilterPtr CheckFilterMatch(const std::string& url,
                                ContentTypeMask contentTypeMask,
                                const std::string& documentUrl) const;
-    void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params);
+    void UpdateAvailable(const UpdateAvailableCallback& callback, const JsValueList& params) const;
     void UpdateCheckDone(const std::string& eventName,
-                         UpdateCheckDoneCallback callback, JsValueList& params);
-    void FilterChanged(FilterChangeCallback callback, JsValueList& params);
+                         const UpdateCheckDoneCallback& callback, const JsValueList& params);
+    void FilterChanged(const FilterChangeCallback& callback, const JsValueList& params) const;
     void ShowNotification(const ShowNotificationCallback& callback,
-      const JsValueList& params);
+      const JsValueList& param) const;
     FilterPtr GetWhitelistingFilter(const std::string& url,
       ContentTypeMask contentTypeMask, const std::string& documentUrl) const;
     FilterPtr GetWhitelistingFilter(const std::string& url,
       ContentTypeMask contentTypeMask,
       const std::vector<std::string>& documentUrls) const;
   };
 }
 
 #endif