remove generated_sdk from checked in code

test/generated_sdk/lib/collection/queue.dart

-// Copyright (c) 2011, the Dart project authors.  Please see the AUTHORS file
-// for details. All rights reserved. Use of this source code is governed by a
-// BSD-style license that can be found in the LICENSE file.
-
-part of dart.collection;
-
-/**
- * A [Queue] is a collection that can be manipulated at both ends. One
- * can iterate over the elements of a queue through [forEach] or with
- * an [Iterator].
- *
- * It is generally not allowed to modify the queue (add or remove entries) while
- * an operation on the queue is being performed, for example during a call to
- * [forEach].
- * Modifying the queue while it is being iterated will most likely break the
- * iteration.
- * This goes both for using the [iterator] directly, or for iterating an
- * `Iterable` returned by a method like [map] or [where].
- */
-abstract class Queue<E> implements Iterable<E>, EfficientLength {
-
-  /**
-   * Creates a queue.
-   */
-  factory Queue() = ListQueue<E>;
-
-  /**
-   * Creates a queue containing all [elements].
-   *
-   * The element order in the queue is as if the elements were added using
-   * [addLast] in the order provided by [elements.iterator].
-   */
-  factory Queue.from(Iterable elements) = ListQueue<E>.from;
-
-  /**
-   * Removes and returns the first element of this queue.
-   *
-   * The queue must not be empty when this method is called.
-   */
-  E removeFirst();
-
-  /**
-   * Removes and returns the last element of the queue.
-   *
-   * The queue must not be empty when this method is called.
-   */
-  E removeLast();
-
-  /**
-   * Adds [value] at the beginning of the queue.
-   */
-  void addFirst(E value);
-
-  /**
-   * Adds [value] at the end of the queue.
-   */
-  void addLast(E value);
-
-  /**
-   * Adds [value] at the end of the queue.
-   */
-  void add(E value);
-
-  /**
-   * Remove a single instance of [value] from the queue.
-   *
-   * Returns `true` if a value was removed, or `false` if the queue
-   * contained no element equal to [value].
-   */
-  bool remove(Object object);
-
-  /**
-   * Adds all elements of [iterable] at the end of the queue. The
-   * length of the queue is extended by the length of [iterable].
-   */
-  void addAll(Iterable<E> iterable);
-
-  /**
-   * Removes all elements matched by [test] from the queue.
-   *
-   * The `test` function must not throw or modify the queue.
-   */
-  void removeWhere(bool test(E element));
-
-  /**
-   * Removes all elements not matched by [test] from the queue.
-   *
-   * The `test` function must not throw or modify the queue.
-   */
-  void retainWhere(bool test(E element));
-
-  /**
-   * Removes all elements in the queue. The size of the queue becomes zero.
-   */
-  void clear();
-}
-
-
-/**
- * An entry in a doubly linked list. It contains a pointer to the next
- * entry, the previous entry, and the boxed element.
- */
-class DoubleLinkedQueueEntry<E> {
-  DoubleLinkedQueueEntry<E> _previous;
-  DoubleLinkedQueueEntry<E> _next;
-  E _element;
-
-  DoubleLinkedQueueEntry(E e) : _element = e;
-
-  void _link(DoubleLinkedQueueEntry<E> previous,
-             DoubleLinkedQueueEntry<E> next) {
-    _next = next;
-    _previous = previous;
-    previous._next = this;
-    next._previous = this;
-  }
-
-  void append(E e) {
-    new DoubleLinkedQueueEntry<E>(e)._link(this, _next);
-  }
-
-  void prepend(E e) {
-    new DoubleLinkedQueueEntry<E>(e)._link(_previous, this);
-  }
-
-  E remove() {
-    _previous._next = _next;
-    _next._previous = _previous;
-    _next = null;
-    _previous = null;
-    return _element;
-  }
-
-  DoubleLinkedQueueEntry<E> _asNonSentinelEntry() {
-    return this;
-  }
-
-  DoubleLinkedQueueEntry<E> previousEntry() {
-    return _previous._asNonSentinelEntry();
-  }
-
-  DoubleLinkedQueueEntry<E> nextEntry() {
-    return _next._asNonSentinelEntry();
-  }
-
-  E get element {
-    return _element;
-  }
-
-  void set element(E e) {
-    _element = e;
-  }
-}
-
-/**
- * A sentinel in a double linked list is used to manipulate the list
- * at both ends.
- * A double linked list has exactly one sentinel,
- * which is the only entry when the list is constructed.
- * Initially, a sentinel has its next and previous entry point to itself.
- * A sentinel does not box any user element.
- */
-class _DoubleLinkedQueueEntrySentinel<E> extends DoubleLinkedQueueEntry<E> {
-  _DoubleLinkedQueueEntrySentinel() : super(null) {
-    _link(this, this);
-  }
-
-  E remove() {
-    throw IterableElementError.noElement();
-  }
-
-  DoubleLinkedQueueEntry<E> _asNonSentinelEntry() {
-    return null;
-  }
-
-  void set element(E e) {
-    // This setter is unreachable.
-    // TODO(lrn): Don't inherit the field if we don't use it.
-    assert(false);
-  }
-
-  E get element {
-    throw IterableElementError.noElement();
-  }
-}
-
-/**
- * A [Queue] implementation based on a double-linked list.
- *
- * Allows constant time add, remove-at-ends and peek operations.
- */
-class DoubleLinkedQueue<E> extends IterableBase<E> implements Queue<E> {
-  _DoubleLinkedQueueEntrySentinel<E> _sentinel;
-  int _elementCount = 0;
-
-  DoubleLinkedQueue() {
-    _sentinel = new _DoubleLinkedQueueEntrySentinel<E>();
-  }
-
-  /**
-   * Creates a double-linked queue containing all [elements].
-   *
-   * The element order in the queue is as if the elements were added using
-   * [addLast] in the order provided by [elements.iterator].
-   */
-  factory DoubleLinkedQueue.from(Iterable elements) {
-    Queue<E> list = new DoubleLinkedQueue();
-    for (final E e in elements) {
-      list.addLast(e);
-    }
-    return list;
-  }
-
-  int get length => _elementCount;
-
-  void addLast(E value) {
-    _sentinel.prepend(value);
-    _elementCount++;
-  }
-
-  void addFirst(E value) {
-    _sentinel.append(value);
-    _elementCount++;
-  }
-
-  void add(E value) {
-    _sentinel.prepend(value);
-    _elementCount++;
-  }
-
-  void addAll(Iterable<E> iterable) {
-    for (final E value in iterable) {
-      _sentinel.prepend(value);
-      _elementCount++;
-    }
-  }
-
-  E removeLast() {
-    E result = _sentinel._previous.remove();
-    _elementCount--;
-    return result;
-  }
-
-  E removeFirst() {
-    E result = _sentinel._next.remove();
-    _elementCount--;
-    return result;
-  }
-
-  bool remove(Object o) {
-    DoubleLinkedQueueEntry<E> entry = _sentinel._next;
-    while (!identical(entry, _sentinel)) {
-      if (entry.element == o) {
-        entry.remove();
-        _elementCount--;
-        return true;
-      }
-      entry = entry._next;
-    }
-    return false;
-  }
-
-  void _filter(bool test(E element), bool removeMatching) {
-    DoubleLinkedQueueEntry<E> entry = _sentinel._next;
-    while (!identical(entry, _sentinel)) {
-      DoubleLinkedQueueEntry<E> next = entry._next;
-      if (identical(removeMatching, test(entry.element))) {
-        entry.remove();
-        _elementCount--;
-      }
-      entry = next;
-    }
-  }
-
-  void removeWhere(bool test(E element)) {
-    _filter(test, true);
-  }
-
-  void retainWhere(bool test(E element)) {
-    _filter(test, false);
-  }
-
-  E get first {
-    return _sentinel._next.element;
-  }
-
-  E get last {
-    return _sentinel._previous.element;
-  }
-
-  E get single {
-    // Note that this throws correctly if the queue is empty.
-    if (identical(_sentinel._next, _sentinel._previous)) {
-      return _sentinel._next.element;
-    }
-    throw IterableElementError.tooMany();
-  }
-
-  DoubleLinkedQueueEntry<E> lastEntry() {
-    return _sentinel.previousEntry();
-  }
-
-  DoubleLinkedQueueEntry<E> firstEntry() {
-    return _sentinel.nextEntry();
-  }
-
-  bool get isEmpty {
-    return (identical(_sentinel._next, _sentinel));
-  }
-
-  void clear() {
-    _sentinel._next = _sentinel;
-    _sentinel._previous = _sentinel;
-    _elementCount = 0;
-  }
-
-  void forEachEntry(void f(DoubleLinkedQueueEntry<E> element)) {
-    DoubleLinkedQueueEntry<E> entry = _sentinel._next;
-    while (!identical(entry, _sentinel)) {
-      DoubleLinkedQueueEntry<E> nextEntry = entry._next;
-      f(entry);
-      entry = nextEntry;
-    }
-  }
-
-  _DoubleLinkedQueueIterator<E> get iterator {
-    return new _DoubleLinkedQueueIterator<E>(_sentinel);
-  }
-
-  String toString() => IterableBase.iterableToFullString(this, '{', '}');
-}
-
-class _DoubleLinkedQueueIterator<E> implements Iterator<E> {
-  _DoubleLinkedQueueEntrySentinel<E> _sentinel;
-  DoubleLinkedQueueEntry<E> _nextEntry = null;
-  E _current;
-
-  _DoubleLinkedQueueIterator(_DoubleLinkedQueueEntrySentinel<E> sentinel)
-      : _sentinel = sentinel, _nextEntry = sentinel._next;
-
-  bool moveNext() {
-    // When [_currentEntry] it is set to [:null:] then it is at the end.
-    if (!identical(_nextEntry, _sentinel)) {
-      _current = _nextEntry._element;
-      _nextEntry = _nextEntry._next;
-      return true;
-    }
-    _current = null;
-    _nextEntry = _sentinel = null;  // Still identical.
-    return false;
-  }
-
-  E get current => _current;
-}
-
-/**
- * List based [Queue].
- *
- * Keeps a cyclic buffer of elements, and grows to a larger buffer when
- * it fills up. This guarantees constant time peek and remove operations, and
- * amortized constant time add operations.
- *
- * The structure is efficient for any queue or stack usage.
- */
-class ListQueue<E> extends IterableBase<E> implements Queue<E> {
-  static const int _INITIAL_CAPACITY = 8;
-  List<E> _table;
-  int _head;
-  int _tail;
-  int _modificationCount = 0;
-
-  /**
-   * Create an empty queue.
-   *
-   * If [initialCapacity] is given, prepare the queue for at least that many
-   * elements.
-   */
-  ListQueue([int initialCapacity]) : _head = 0, _tail = 0 {
-    if (initialCapacity == null || initialCapacity < _INITIAL_CAPACITY) {
-      initialCapacity = _INITIAL_CAPACITY;
-    } else if (!_isPowerOf2(initialCapacity)) {
-      initialCapacity = _nextPowerOf2(initialCapacity);
-    }
-    assert(_isPowerOf2(initialCapacity));
-    _table = new List<E>(initialCapacity);
-  }
-
-  /**
-   * Create a `ListQueue` containing all [elements].
-   *
-   * The elements are added to the queue, as by [addLast], in the order given by
-   * `elements.iterator`.
-   *
-   * All `elements` should be assignable to [E].
-   */
-  factory ListQueue.from(Iterable elements) {
-    if (elements is List) {
-      int length = elements.length;
-      ListQueue<E> queue = new ListQueue(length + 1);
-      assert(queue._table.length > length);
-      List sourceList = elements;
-      queue._table.setRange(0, length, sourceList, 0);
-      queue._tail = length;
-      return queue;
-    } else {
-      int capacity = _INITIAL_CAPACITY;
-      if (elements is EfficientLength) {
-        capacity = elements.length;
-      }
-      ListQueue<E> result = new ListQueue<E>(capacity);
-      for (final E element in elements) {
-        result.addLast(element);
-      }
-      return result;
-    }
-  }
-
-  // Iterable interface.
-
-  Iterator<E> get iterator => new _ListQueueIterator<E>(this);
-
-  void forEach(void action (E element)) {
-    int modificationCount = _modificationCount;
-    for (int i = _head; i != _tail; i = (i + 1) & (_table.length - 1)) {
-      action(_table[i]);
-      _checkModification(modificationCount);
-    }
-  }
-
-  bool get isEmpty => _head == _tail;
-
-  int get length => (_tail - _head) & (_table.length - 1);
-
-  E get first {
-    if (_head == _tail) throw IterableElementError.noElement();
-    return _table[_head];
-  }
-
-  E get last {
-    if (_head == _tail) throw IterableElementError.noElement();
-    return _table[(_tail - 1) & (_table.length - 1)];
-  }
-
-  E get single {
-    if (_head == _tail) throw IterableElementError.noElement();
-    if (length > 1) throw IterableElementError.tooMany();
-    return _table[_head];
-  }
-
-  E elementAt(int index) {
-    RangeError.checkValidIndex(index, this);
-    return _table[(_head + index) & (_table.length - 1)];
-  }
-
-  List<E> toList({ bool growable: true }) {
-    List<E> list;
-    if (growable) {
-      list = new List<E>()..length = length;
-    } else {
-      list = new List<E>(length);
-    }
-    _writeToList(list);
-    return list;
-  }
-
-  // Collection interface.
-
-  void add(E element) {
-    _add(element);
-  }
-
-  void addAll(Iterable<E> elements) {
-    if (elements is List) {
-      List list = elements;
-      int addCount = list.length;
-      int length = this.length;
-      if (length + addCount >= _table.length) {
-        _preGrow(length + addCount);
-        // After preGrow, all elements are at the start of the list.
-        _table.setRange(length, length + addCount, list, 0);
-        _tail += addCount;
-      } else {
-        // Adding addCount elements won't reach _head.
-        int endSpace = _table.length - _tail;
-        if (addCount < endSpace) {
-          _table.setRange(_tail, _tail + addCount, list, 0);
-          _tail += addCount;
-        } else {
-          int preSpace = addCount - endSpace;
-          _table.setRange(_tail, _tail + endSpace, list, 0);
-          _table.setRange(0, preSpace, list, endSpace);
-          _tail = preSpace;
-        }
-      }
-      _modificationCount++;
-    } else {
-      for (E element in elements) _add(element);
-    }
-  }
-
-  bool remove(Object object) {
-    for (int i = _head; i != _tail; i = (i + 1) & (_table.length - 1)) {
-      E element = _table[i];
-      if (element == object) {
-        _remove(i);
-        _modificationCount++;
-        return true;
-      }
-    }
-    return false;
-  }
-
-  void _filterWhere(bool test(E element), bool removeMatching) {
-    int index = _head;
-    int modificationCount = _modificationCount;
-    int i = _head;
-    while (i != _tail) {
-      E element = _table[i];
-      bool remove = identical(removeMatching, test(element));
-      _checkModification(modificationCount);
-      if (remove) {
-        i = _remove(i);
-        modificationCount = ++_modificationCount;
-      } else {
-        i = (i + 1) & (_table.length - 1);
-      }
-    }
-  }
-
-  /**
-   * Remove all elements matched by [test].
-   *
-   * This method is inefficient since it works by repeatedly removing single
-   * elements, each of which can take linear time.
-   */
-  void removeWhere(bool test(E element)) {
-    _filterWhere(test, true);
-  }
-
-  /**
-   * Remove all elements not matched by [test].
-   *
-   * This method is inefficient since it works by repeatedly removing single
-   * elements, each of which can take linear time.
-   */
-  void retainWhere(bool test(E element)) {
-    _filterWhere(test, false);
-  }
-
-  void clear() {
-    if (_head != _tail) {
-      for (int i = _head; i != _tail; i = (i + 1) & (_table.length - 1)) {
-        _table[i] = null;
-      }
-      _head = _tail = 0;
-      _modificationCount++;
-    }
-  }
-
-  String toString() => IterableBase.iterableToFullString(this, "{", "}");
-
-  // Queue interface.
-
-  void addLast(E element) { _add(element); }
-
-  void addFirst(E element) {
-    _head = (_head - 1) & (_table.length - 1);
-    _table[_head] = element;
-    if (_head == _tail) _grow();
-    _modificationCount++;
-  }
-
-  E removeFirst() {
-    if (_head == _tail) throw IterableElementError.noElement();
-    _modificationCount++;
-    E result = _table[_head];
-    _table[_head] = null;
-    _head = (_head + 1) & (_table.length - 1);
-    return result;
-  }
-
-  E removeLast() {
-    if (_head == _tail) throw IterableElementError.noElement();
-    _modificationCount++;
-    _tail = (_tail - 1) & (_table.length - 1);
-    E result = _table[_tail];
-    _table[_tail] = null;
-    return result;
-  }
-
-  // Internal helper functions.
-
-  /**
-   * Whether [number] is a power of two.
-   *
-   * Only works for positive numbers.
-   */
-  static bool _isPowerOf2(int number) => (number & (number - 1)) == 0;
-
-  /**
-   * Rounds [number] up to the nearest power of 2.
-   *
-   * If [number] is a power of 2 already, it is returned.
-   *
-   * Only works for positive numbers.
-   */
-  static int _nextPowerOf2(int number) {
-    assert(number > 0);
-    number = (number << 1) - 1;
-    for(;;) {
-      int nextNumber = number & (number - 1);
-      if (nextNumber == 0) return number;
-      number = nextNumber;
-    }
-  }
-
-  /** Check if the queue has been modified during iteration. */
-  void _checkModification(int expectedModificationCount) {
-    if (expectedModificationCount != _modificationCount) {
-      throw new ConcurrentModificationError(this);
-    }
-  }
-
-  /** Adds element at end of queue. Used by both [add] and [addAll]. */
-  void _add(E element) {
-    _table[_tail] = element;
-    _tail = (_tail + 1) & (_table.length - 1);
-    if (_head == _tail) _grow();
-    _modificationCount++;
-  }
-
-  /**
-   * Removes the element at [offset] into [_table].
-   *
-   * Removal is performed by linerarly moving elements either before or after
-   * [offset] by one position.
-   *
-   * Returns the new offset of the following element. This may be the same
-   * offset or the following offset depending on how elements are moved
-   * to fill the hole.
-   */
-  int _remove(int offset) {
-    int mask = _table.length - 1;
-    int startDistance = (offset - _head) & mask;
-    int endDistance = (_tail - offset) & mask;
-    if (startDistance < endDistance) {
-      // Closest to start.
-      int i = offset;
-      while (i != _head) {
-        int prevOffset = (i - 1) & mask;
-        _table[i] = _table[prevOffset];
-        i = prevOffset;
-      }
-      _table[_head] = null;
-      _head = (_head + 1) & mask;
-      return (offset + 1) & mask;
-    } else {
-      _tail = (_tail - 1) & mask;
-      int i = offset;
-      while (i != _tail) {
-        int nextOffset = (i + 1) & mask;
-        _table[i] = _table[nextOffset];
-        i = nextOffset;
-      }
-      _table[_tail] = null;
-      return offset;
-    }
-  }
-
-  /**
-   * Grow the table when full.
-   */
-  void _grow() {
-    List<E> newTable = new List<E>(_table.length * 2);
-    int split = _table.length - _head;
-    newTable.setRange(0, split, _table, _head);
-    newTable.setRange(split, split + _head, _table, 0);
-    _head = 0;
-    _tail = _table.length;
-    _table = newTable;
-  }
-
-  int _writeToList(List<E> target) {
-    assert(target.length >= length);
-    if (_head <= _tail) {
-      int length = _tail - _head;
-      target.setRange(0, length, _table, _head);
-      return length;
-    } else {
-      int firstPartSize = _table.length - _head;
-      target.setRange(0, firstPartSize, _table, _head);
-      target.setRange(firstPartSize, firstPartSize + _tail, _table, 0);
-      return _tail + firstPartSize;
-    }
-  }
-
-  /** Grows the table even if it is not full. */
-  void _preGrow(int newElementCount) {
-    assert(newElementCount >= length);
-
-    // Add some extra room to ensure that there's room for more elements after
-    // expansion.
-    newElementCount += newElementCount >> 1;
-    int newCapacity = _nextPowerOf2(newElementCount);
-    List<E> newTable = new List<E>(newCapacity);
-    _tail = _writeToList(newTable);
-    _table = newTable;
-    _head = 0;
-  }
-}
-
-/**
- * Iterator for a [ListQueue].
- *
- * Considers any add or remove operation a concurrent modification.
- */
-class _ListQueueIterator<E> implements Iterator<E> {
-  final ListQueue _queue;
-  final int _end;
-  final int _modificationCount;
-  int _position;
-  E _current;
-
-  _ListQueueIterator(ListQueue queue)
-      : _queue = queue,
-        _end = queue._tail,
-        _modificationCount = queue._modificationCount,
-        _position = queue._head;
-
-  E get current => _current;
-
-  bool moveNext() {
-    _queue._checkModification(_modificationCount);
-    if (_position == _end) {
-      _current = null;
-      return false;
-    }
-    _current = _queue._table[_position];
-    _position = (_position + 1) & (_queue._table.length - 1);
-    return true;
-  }
-}