Issue 3363 - Implement IsDocumentWhitelisted and IsElemhideWhitelisted

include/AdblockPlus/FilterEngine.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
@@ skipping 281 matching lines @@
      *        structure, e.g. because it is a proxy, it can be approximated
      *        using `ReferrerMapping`.
      * @return Matching filter, or a `null` if there was no match.
      * @throw `std::invalid_argument`, if an invalid `contentType` was supplied.
      */
     FilterPtr Matches(const std::string& url,
         ContentType contentType,
         const std::vector<std::string>& documentUrls) const;
 
     /**
-     * Checks if the supplied URL is whitelisted.

[Felix Dahlke, 2015/12/02 17:17:29]

"Checks whether the document at the supplied URL is whitelisted", or something
along those lines? Makes more sense to me in combination with the function name.

[René Jeschke, 2015/12/02 17:38:40]

Done.

-     * @param url URL to match.

[Felix Dahlke, 2015/12/02 17:17:29]

I'd vote for: "URL of the document" instead, "matching" doesn't seem to make
that much sense here, it's not Matches().

[René Jeschke, 2015/12/02 17:38:40]

Done.

-     * @param documentUrls Chain of documents requesting the resource, starting

[Felix Dahlke, 2015/12/02 17:17:29]

If you decide to go for "URL of the document" above, we should also do a
s/resource/document here.

[René Jeschke, 2015/12/02 17:38:40]

Done.

-     *        with the current resource's parent frame, ending with the
-     *        top-level frame.
+     * Checks whether the document at the supplied URL is whitelisted.
+     * @param url URL of the document.
+     * @param documentUrls Chain of document URLs requesting the document,
+     *        starting with the current document's parent frame, ending with
+     *        the top-level frame.
      *        If the application is not capable of identifying the frame
      *        structure, e.g. because it is a proxy, it can be approximated
      *        using `ReferrerMapping`.
      * @return `true` if the URL is whitelisted.
      */
     bool IsDocumentWhitelisted(const std::string& url,
         const std::vector<std::string>& documentUrls) const;
 
     /**
-     * Checks if the element hiding is whitelisted for the supplied URL.

[Felix Dahlke, 2015/12/02 17:17:29]

Doesn't sound entirely right to me, how about: "Checks whether element hiding is
disabled at the supplied URL"?

[René Jeschke, 2015/12/02 17:38:39]

Done.

-     * @param url URL to match.
-     * @param documentUrls Chain of documents requesting the resource, starting
-     *        with the current resource's parent frame, ending with the
-     *        top-level frame.
+     * Checks whether element hiding is disabled at the supplied URL.
+     * @param url URL of the document.
+     * @param documentUrls Chain of document URLs requesting the document,
+     *        starting with the current document's parent frame, ending with
+     *        the top-level frame.
      *        If the application is not capable of identifying the frame
      *        structure, e.g. because it is a proxy, it can be approximated
      *        using `ReferrerMapping`.
      * @return `true` if element hiding is whitelisted for the supplied URL.
      */
     bool IsElemhideWhitelisted(const std::string& url,
         const std::vector<std::string>& documentUrls) const;
 
     /**
      * Retrieves CSS selectors for all element hiding filters active on the
@@ skipping 99 matching lines @@
     void InitDone(JsValueList& params);
     FilterPtr CheckFilterMatch(const std::string& url,
                                ContentType contentType,
                                const std::string& documentUrl) const;
     void UpdateAvailable(UpdateAvailableCallback callback, JsValueList& params);
     void UpdateCheckDone(const std::string& eventName,
                          UpdateCheckDoneCallback callback, JsValueList& params);
     void FilterChanged(FilterChangeCallback callback, JsValueList& params);
     void ShowNotification(const ShowNotificationCallback& callback,
       const JsValueList& params);
-    std::string GetWhitelistingFilter(const std::string& url,
-      const std::string& parent, ContentType contentType) const;

[Felix Dahlke, 2015/12/02 17:17:29]

Nit: s/parent/documentUrl/, analogous to the two Matches() variants?

[Felix Dahlke, 2015/12/02 17:17:29]

Nit: Switch parent/documentUrl and contentType, analogous to Matches()? Same
below.

[René Jeschke, 2015/12/02 17:38:40]

Done.

[René Jeschke, 2015/12/02 17:38:40]

Done.

-    std::string GetWhitelistingFilter(const std::string& urlArg,

[Felix Dahlke, 2015/12/02 17:17:29]

Nit: s/urlArg/url/?

[René Jeschke, 2015/12/02 17:38:40]

Done.

-      const std::vector<std::string>& documentUrls,
-      ContentType contentType) const;
+    FilterPtr GetWhitelistingFilter(const std::string& url,
+      ContentType contentType, const std::string& documentUrl) const;
+    FilterPtr GetWhitelistingFilter(const std::string& url,
+      ContentType contentType,
+      const std::vector<std::string>& documentUrls) const;
   };
 }
 
 #endif