Issue 6741 - Use ES2015 classes in lib/matcher.js

lib/matcher.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 "use strict";
 
 /**
  * @fileOverview Matcher class implementing matching addresses against
  *               a list of filters.
  */
 
-const {Filter, WhitelistFilter} = require("./filterClasses");
+const {WhitelistFilter} = require("./filterClasses");
 
 /**
  * Blacklist/whitelist filter matching
  */
 class Matcher
 {
   constructor()
   {
     /**
      * Lookup table for filters by their associated keyword
@@ skipping 66 matching lines @@
   }
 
   /**
    * Chooses a keyword to be associated with the filter
    * @param {Filter} filter
    * @returns {string} keyword or an empty string if no keyword could be found
    */
   findKeyword(filter)
   {
     let result = "";
-    let {text} = filter;
-    if (Filter.regexpRegExp.test(text))
+    let {pattern} = filter;
+    if (pattern == null)
       return result;
 
-    // Remove options
-    let match = Filter.optionsRegExp.exec(text);
-    if (match)
-      text = match.input.substr(0, match.index);
-
-    // Remove whitelist marker
-    if (text[0] == "@" && text[1] == "@")
-      text = text.substr(2);
-
-    let candidates = text.toLowerCase().match(
+    let candidates = pattern.toLowerCase().match(
       /[^a-z0-9%*][a-z0-9%]{3,}(?=[^a-z0-9%*])/g
     );
     if (!candidates)
       return result;
 
     let hash = this.filterByKeyword;
     let resultCount = 0xFFFFFF;
     let resultLength = 0;
     for (let i = 0, l = candidates.length; i < l; i++)
     {
@@ skipping 15 matching lines @@
    * Checks whether a particular filter is being matched against.
    * @param {RegExpFilter} filter
    * @returns {boolean}
    */
   hasFilter(filter)
   {
     return this.keywordByFilter.has(filter);
   }
 
   /**
-   * Returns the keyword used for a filter, null for unknown filters.
+   * Returns the keyword used for a filter, <code>null</code>
+   * for unknown filters.
    * @param {RegExpFilter} filter
    * @returns {?string}
    */
   getKeywordForFilter(filter)
   {
     let keyword = this.keywordByFilter.get(filter);
     return typeof keyword != "undefined" ? keyword : null;
   }
 
   /**
@@ skipping 59 matching lines @@
         return result;
     }
 
     return null;
   }
 }
 
 exports.Matcher = Matcher;
 
 
-
+/**
+ * Combines a matcher for blocking and exception rules, automatically sorts
+ * rules into two {@link Matcher} instances.
+ */
 class CombinedMatcher
 {
-  /**
-   * Combines a matcher for blocking and exception rules, automatically sorts
-   * rules into two Matcher instances.
-   * @augments Matcher
-   */
   constructor()
   {
     /**
      * Maximal number of matching cache entries to be kept
      * @type {number}
      */
     this.maxCacheEntries = 1000;
 
     /**
      * Matcher for blocking rules.
      * @type {Matcher}
      */
     this.blacklist = new Matcher();
 
     /**
      * Matcher for exception rules.
      * @type {Matcher}
      */
     this.whitelist = new Matcher();
 
     /**
-     * Lookup table of previous matchesAny results
+     * Lookup table of previous {@link Matcher#matchesAny} results
      * @type {Map.<string,Filter>}
      */
     this.resultCache = new Map();
   }
 
   /**
    * @see Matcher#clear
    */
   clear()
   {
@@ skipping 137 matching lines @@
 
     this.resultCache.set(key, result);
 
     return result;
   }
 }
 
 exports.CombinedMatcher = CombinedMatcher;
 
 /**
- * Shared CombinedMatcher instance that should usually be used.
+ * Shared {@link CombinedMatcher} instance that should usually be used.
  * @type {CombinedMatcher}
  */
-exports.defaultMatcher = new CombinedMatcher();
+let defaultMatcher = new CombinedMatcher();
+
+exports.defaultMatcher = defaultMatcher;