Issue 6893, 6741 - Split out INIParser into its own file

lib/iniParser.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
@@ skipping 13 matching lines @@
 const {Filter} = require("./filterClasses");
 const {Subscription} = require("./subscriptionClasses");
 
 /**
  * Parses filter data.
  */
 class INIParser
 {
   constructor()
   {
+    /**
+     * Properties of the filter data.
+     * @type {object}
+     */
     this.fileProperties = {};
+
+    /**
+     * The list of subscriptions in the filter data.
+     * @type {Array.<Subscription>}
+     */
     this.subscriptions = [];
+
+    /**
+     * Known filter texts mapped to their corresponding {@link Filter} objects.
+     * @type {Map.<string, Filter>}
+     */
     this.knownFilters = new Map();
+
+    /**
+     * Known subscription URLs mapped to their corresponding
+     * {@link Subscription} objects.
+     * @type {Map.<string, Subscription>}
+     */
     this.knownSubscriptions = new Map();
 
     this._wantObj = true;
     this._curObj = this.fileProperties;
     this._curSection = null;
   }
 
-  process(val)
+  /**
+   * Processes a line of filter data.
+   *
+   * @param {string?} line The line of filter data to process. This may be
+   *   <code>null</code>, which indicates the end of the filter data.
+   */
+  process(line)
   {
     let origKnownFilters = Filter.knownFilters;
     Filter.knownFilters = this.knownFilters;
+
     let origKnownSubscriptions = Subscription.knownSubscriptions;
     Subscription.knownSubscriptions = this.knownSubscriptions;
-    let match;
+
     try
     {
-      if (this._wantObj === true && (match = /^(\w+)=(.*)$/.exec(val)))
+      let match;
+      if (this._wantObj === true && (match = /^(\w+)=(.*)$/.exec(line)))
       {
         this._curObj[match[1]] = match[2];
       }
-      else if (val === null || (match = /^\s*\[(.+)\]\s*$/.exec(val)))
+      else if (line === null || (match = /^\s*\[(.+)\]\s*$/.exec(line)))
       {
         if (this._curObj)
         {
           // Process current object before going to next section
           switch (this._curSection)
           {
             case "filter":
               if ("text" in this._curObj)
                 Filter.fromObject(this._curObj);
               break;
+
             case "subscription":
               let subscription = Subscription.fromObject(this._curObj);
               if (subscription)
                 this.subscriptions.push(subscription);
               break;
+
             case "subscription filters":
               if (this.subscriptions.length)
               {
-                let subscription = this.subscriptions[
+                let currentSubscription = this.subscriptions[
                   this.subscriptions.length - 1
                 ];
                 for (let text of this._curObj)
                 {
                   let filter = Filter.fromText(text);
-                  subscription.filters.push(filter);
-                  filter.subscriptions.add(subscription);
+                  currentSubscription.filters.push(filter);
+                  filter.subscriptions.add(currentSubscription);
                 }
               }
               break;
           }
         }
 
-        if (val === null)
+        if (line === null)
           return;
 
         this._curSection = match[1].toLowerCase();
         switch (this._curSection)
         {
           case "filter":
           case "subscription":
             this._wantObj = true;
             this._curObj = {};
             break;
           case "subscription filters":
             this._wantObj = false;
             this._curObj = [];
             break;
           default:
             this._wantObj = null;
             this._curObj = null;
         }
       }
-      else if (this._wantObj === false && val)
+      else if (this._wantObj === false && line)
       {
-        this._curObj.push(val.replace(/\\\[/g, "["));
+        this._curObj.push(line.replace(/\\\[/g, "["));
       }
     }
     finally
     {
       Filter.knownFilters = origKnownFilters;
       Subscription.knownSubscriptions = origKnownSubscriptions;
     }
   }
 }
 
 exports.INIParser = INIParser;