The Tor Browser: addon-sdk/source/lib/sdk/deprecated/list.js@b8a032363ba2 (annotated)

addon-sdk/source/lib/sdk/deprecated/list.js@b8a032363ba2 (annotated)

addon-sdk/source/lib/sdk/deprecated/list.js

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 "use strict";
 module.metadata = {
   "stability": "experimental"
 };
 const { Trait } = require('../deprecated/traits');
 const { iteratorSymbol } = require('../util/iteration');
 /**
  * @see https://jetpack.mozillalabs.com/sdk/latest/docs/#module/api-utils/list
  */
 const Iterable = Trait.compose({
   /**
    * Hash map of key-values to iterate over.
    * Note: That this property can be a getter if you need dynamic behavior.
    * @type {Object}
    */
   _keyValueMap: Trait.required,
   /**
    * Custom iterator providing `Iterable`s enumeration behavior.
    * @param {Boolean} onKeys
    */
   __iterator__: function __iterator__(onKeys, onKeyValue) {
     let map = this._keyValueMap;
     for (let key in map)
       yield onKeyValue ? [key, map[key]] : onKeys ? key : map[key];
   }
 });
 exports.Iterable = Iterable;
 /**
  * An ordered collection (also known as a sequence) disallowing duplicate
  * elements. List is composed out of `Iterable` there for it provides custom
  * enumeration behavior that is similar to array (enumerates only on the
  * elements of the list). List is a base trait and is meant to be a part of
  * composition, since all of it's API is private except length property.
  */
 const listOptions = {
   _keyValueMap: null,
   /**
    * List constructor can take any number of element to populate itself.
    * @params {Object|String|Number} element
    * @example
    *    List(1,2,3).length == 3 // true
    */
   constructor: function List() {
     this._keyValueMap = [];
     for (let i = 0, ii = arguments.length; i < ii; i++)
       this._add(arguments[i]);
   },
   /**
    * Number of elements in this list.
    * @type {Number}
    */
   get length() this._keyValueMap.length,
    /**
     * Returns a string representing this list.
     * @returns {String}
     */
   toString: function toString() 'List(' + this._keyValueMap + ')',
   /**
    * Returns `true` if this list contains the specified `element`.
    * @param {Object|Number|String} element
    * @returns {Boolean}
    */
   _has: function _has(element) 0 <= this._keyValueMap.indexOf(element),
   /**
    * Appends the specified `element` to the end of this list, if it doesn't
    * contains it. Ignores the call if `element` is already contained.
    * @param {Object|Number|String} element
    */
   _add: function _add(element) {
     let list = this._keyValueMap,
         index = list.indexOf(element);
     if (0 > index)
       list.push(this._public[list.length] = element);
   },
   /**
    * Removes specified `element` from this list, if it contains it.
    * Ignores the call if `element` is not contained.
    * @param {Object|Number|String} element
    */
   _remove: function _remove(element) {
     let list = this._keyValueMap,
         index = list.indexOf(element);
     if (0 <= index) {
       delete this._public[list.length - 1];
       list.splice(index, 1);
       for (let length = list.length; index < length; index++)
         this._public[index] = list[index];
     }
   },
   /**
    * Removes all of the elements from this list.
    */
   _clear: function _clear() {
     for (let i = 0, ii = this._keyValueMap.length; i < ii; i ++)
       delete this._public[i];
     this._keyValueMap.splice(0);
   },
   /**
    * Custom iterator providing `List`s enumeration behavior.
    * We cant reuse `_iterator` that is defined by `Iterable` since it provides
    * iteration in an arbitrary order.
    * @see https://developer.mozilla.org/en/JavaScript/Reference/Statements/for...in
    * @param {Boolean} onKeys
    */
   __iterator__: function __iterator__(onKeys, onKeyValue) {
     let array = this._keyValueMap.slice(0),
         i = -1;
     for (let element of array)
       yield onKeyValue ? [++i, element] : onKeys ? ++i : element;
   },
 };
 listOptions[iteratorSymbol] = function* iterator() {
   let array = this._keyValueMap.slice(0);
   for (let element of array)
     yield element;
 }
 const List = Trait.resolve({ toString: null }).compose(listOptions);
 exports.List = List;