Issue 6940 - Use underscore prefixes lib/matcher.js

lib/matcher.js

Index: lib/matcher.js
===================================================================
--- a/lib/matcher.js
+++ b/lib/matcher.js
@@ -52,95 +52,97 @@
  * Blacklist/whitelist filter matching
  */
 class Matcher
 {
   constructor()
   {
     /**
      * Lookup table for filters by their associated keyword
+     * @private

[Manish Jethani, 2018/10/21 12:12:19]

I've already started using @private/@protected elsewhere [1], but I put it as
the last thing in the comment. Could you please make @private the last line in
the comment?

[1]: https://hg.adblockplus.org/adblockpluscore/rev/4a0244a174e6#l2.57

[Jon Sonesen, 2018/10/23 01:28:01]

Acknowledged.

      * @type {Map.<string,(Filter|Set.<Filter>)>}
      */
-    this.filterByKeyword = new Map();
+    this._filterByKeyword = new Map();
   }
 
   /**
    * Removes all known filters
    */
   clear()
   {
-    this.filterByKeyword.clear();
+    this._filterByKeyword.clear();
   }
 
   /**
    * Adds a filter to the matcher
    * @param {RegExpFilter} filter
    */
   add(filter)
   {
     // Look for a suitable keyword
     let keyword = this.findKeyword(filter);
-    let set = this.filterByKeyword.get(keyword);
+    let set = this._filterByKeyword.get(keyword);
     if (typeof set == "undefined")
     {
-      this.filterByKeyword.set(keyword, filter);
+      this._filterByKeyword.set(keyword, filter);
     }
     else if (set.size == 1)
     {
       if (filter != set)
-        this.filterByKeyword.set(keyword, new Set([set, filter]));
+        this._filterByKeyword.set(keyword, new Set([set, filter]));
     }
     else
     {
       set.add(filter);
     }
   }
 
   /**
    * Removes a filter from the matcher
    * @param {RegExpFilter} filter
    */
   remove(filter)
   {
     let keyword = this.findKeyword(filter);
-    let set = this.filterByKeyword.get(keyword);
+    let set = this._filterByKeyword.get(keyword);
     if (typeof set == "undefined")
       return;
 
     if (set.size == 1)
     {
       if (filter == set)
-        this.filterByKeyword.delete(keyword);
+        this._filterByKeyword.delete(keyword);
     }
     else
     {
       set.delete(filter);
 
       if (set.size == 1)
-        this.filterByKeyword.set(keyword, [...set][0]);
+        this._filterByKeyword.set(keyword, [...set][0]);
     }
   }
 
   /**
    * Chooses a keyword to be associated with the filter
+   * @protected

[Manish Jethani, 2018/10/21 12:12:19]

Same here.

[Jon Sonesen, 2018/10/23 01:28:04]

Acknowledged.

    * @param {Filter} filter
    * @returns {string} keyword or an empty string if no keyword could be found
    */
   findKeyword(filter)
   {
     let result = "";
     let {pattern} = filter;
     if (pattern == null)
       return result;
 
     let candidates = pattern.toLowerCase().match(allKeywordsRegExp);
     if (!candidates)
       return result;
 
-    let hash = this.filterByKeyword;
+    let hash = this._filterByKeyword;
     let resultCount = 0xFFFFFF;
     let resultLength = 0;
     for (let i = 0, l = candidates.length; i < l; i++)
     {
       let candidate = candidates[i].substr(1);
       let filters = hash.get(candidate);
       let count = typeof filters != "undefined" ? filters.size : 0;
       if (count < resultCount ||
@@ -163,17 +165,17 @@
    * @param {boolean} [thirdParty]
    * @param {string} [sitekey]
    * @param {boolean} [specificOnly]
    * @returns {?Filter}
    */
   _checkEntryMatch(keyword, location, typeMask, docDomain, thirdParty, sitekey,

[Manish Jethani, 2018/10/21 12:52:04]

About this function, I think we can make it "protected". Let's remove the
underscore and add the @protected tag.

[Jon Sonesen, 2018/10/23 01:28:02]

Acknowledged.

                    specificOnly)
   {
-    let set = this.filterByKeyword.get(keyword);
+    let set = this._filterByKeyword.get(keyword);
     if (typeof set == "undefined")
       return null;
 
     for (let filter of set)
     {
       if (specificOnly && filter.isGeneric() &&
           !(filter instanceof WhitelistFilter))
         continue;