Issue 1296 - Add SetUpdateAvailableCallback

include/AdblockPlus/FilterEngine.h

 /*
  * This file is part of Adblock Plus <http://adblockplus.org/>,
  * Copyright (C) 2006-2014 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 138 matching lines @@
      * Possible resource content types.
      */
     enum ContentType {CONTENT_TYPE_OTHER, CONTENT_TYPE_SCRIPT,
                       CONTENT_TYPE_IMAGE, CONTENT_TYPE_STYLESHEET,
                       CONTENT_TYPE_OBJECT, CONTENT_TYPE_SUBDOCUMENT,
                       CONTENT_TYPE_DOCUMENT, CONTENT_TYPE_XMLHTTPREQUEST,
                       CONTENT_TYPE_OBJECT_SUBREQUEST, CONTENT_TYPE_FONT,
                       CONTENT_TYPE_MEDIA};
 
     /**
-     * Callback type invoked when an update is available.
-     * The parameter is optional error message.
+     * Callback type invoked when an update becomes available.
+     * The parameter is the download URL of the update.
      */
-    typedef std::tr1::function<void(const std::string&)> UpdaterCallback;
+    typedef std::tr1::function<void(const std::string&)>
+        UpdateAvailableCallback;
+
+    /**
+     * Callback type invoked when a manually triggered update check finishes.
+     * The parameter is an optional error message.
+     */
+    typedef std::tr1::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/adblockplus/symbols/FilterNotifier.html#.triggerListeners)
      * for the full list).
      * The second parameter is the filter/subscription object affected, if any.
      */
     typedef std::tr1::function<void(const std::string&, const JsValuePtr)> FilterChangeCallback;
 
@@ skipping 104 matching lines @@
     void SetPref(const std::string& pref, JsValuePtr 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);
 
     /**
+     * Sets the callback invoked when an application update becomes available.
+     * @param callback Callback to invoke.
+     */
+    void SetUpdateAvailableCallback(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 after every update check -
-     *        to react to updates being available, register a callback for the
-     *        "updateAvailable" event (see JsEngine::SetEventCallback()).
+     *        Note that the callback will be invoked whether updates are
+     *        availble or not - to react to updates being available, use

[Wladimir Palant, 2014/09/18 19:44:17]

Nit: available

[Felix Dahlke, 2014/09/19 02:51:41]

Done.

+     *        `FilterEngine::SetUpdateAvailableCallback()`.
      */
-    void ForceUpdateCheck(UpdaterCallback callback = 0);
+    void ForceUpdateCheck(UpdateCheckDoneCallback callback = 0);
 
     /**
      * Sets the callback invoked when the filters change.
      * @param callback Callback to invoke.
      */
     void SetFilterChangeCallback(FilterChangeCallback callback);
 
     /**
      * Removes the callback invoked when the filters change.
      */
@@ skipping 31 matching lines @@
     JsEnginePtr jsEngine;
     bool initialized;
     bool firstRun;
     int updateCheckId;
     static const std::map<ContentType, std::string> contentTypes;
 
     void InitDone(JsValueList& params);
     FilterPtr CheckFilterMatch(const std::string& url,
                                ContentType contentType,
                                const std::string& documentUrl) const;
-    void UpdateCheckDone(const std::string& eventName, UpdaterCallback callback, JsValueList& params);
+    void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params);
+    void UpdateCheckDone(const std::string& eventName,
+                         UpdateCheckDoneCallback callback, JsValueList& params);
     void FilterChanged(FilterChangeCallback callback, JsValueList& params);
   };
 }
 
 #endif