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 282 matching lines @@
      *        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 whether the document at the supplied URL is whitelisted.
-     * @param url URL of the document

[Felix Dahlke, 2015/12/02 18:02:01]

Nit: Seems we usually end with a period.

[René Jeschke, 2015/12/02 18:09:41]

Done.

+     * @param url URL of the document.
      * @param documentUrls Chain of document URLs requesting the document,
-     *        starting with the current documents's parent frame, ending with

[Felix Dahlke, 2015/12/02 18:02:02]

Typo: s/documents's/document's/ 

[René Jeschke, 2015/12/02 18:09:41]

Done.

+     *        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 whether element hiding is disabled at the supplied URL.
-     * @param url URL to match.

[Felix Dahlke, 2015/12/02 18:01:58]

Maybe it's not entirely correct, but I think it'd be clearer if we go for "URL
of the document" as well here.

[René Jeschke, 2015/12/02 18:09:41]

Done.

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

[Felix Dahlke, 2015/12/02 18:02:01]

Same as above, we're not really talking about a "resources"here.

[René Jeschke, 2015/12/02 18:09:42]

Done.

-     *        with the current resource's parent frame, ending with the
-     *        top-level frame.
+     * @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 108 matching lines @@
       const JsValueList& params);
     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