iteration-semantics.js 10.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
// Copyright 2013 the V8 project authors. All rights reserved.
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
//       copyright notice, this list of conditions and the following
//       disclaimer in the documentation and/or other materials provided
//       with the distribution.
//     * Neither the name of Google Inc. nor the names of its
//       contributors may be used to endorse or promote products derived
//       from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

// Test for-of semantics.

"use strict";


// First, some helpers.

function* values() {
  for (var i = 0; i < arguments.length; i++) {
    yield arguments[i];
  }
}

41 42 43 44 45 46
function wrap_iterator(iterator) {
    var iterable = {};
    iterable[Symbol.iterator] = function() { return iterator; };
    return iterable;
}

47 48 49 50 51 52
function integers_until(max) {
  function next() {
    var ret = { value: this.n, done: this.n == max };
    this.n++;
    return ret;
  }
53
  return wrap_iterator({ next: next, n: 0 });
54 55 56 57 58 59 60
}

function results(results) {
  var i = 0;
  function next() {
    return results[i++];
  }
61
  return wrap_iterator({ next: next });
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77
}

function* integers_from(n) {
  while (1) yield n++;
}

// A destructive append.
function append(x, tail) {
  tail[tail.length] = x;
  return tail;
}

function sum(x, tail) {
  return x + tail;
}

78 79
function fold(cons, seed, iterable) {
  for (var x of iterable) {
80 81 82 83 84
    seed = cons(x, seed);
  }
  return seed;
}

85
function* take(iterable, n) {
86
  if (n == 0) return;
87
  for (let x of iterable) {
88 89 90 91 92
    yield x;
    if (--n == 0) break;
  }
}

93 94
function nth(iterable, n) {
  for (let x of iterable) {
95 96 97 98 99
    if (n-- == 0) return x;
  }
  throw "unreachable";
}

100
function* skip_every(iterable, n) {
101
  var i = 0;
102
  for (let x of iterable) {
103 104 105 106 107
    if (++i % n == 0) continue;
    yield x;
  }
}

108 109
function* iter_map(iterable, f) {
  for (var x of iterable) {
110 111 112
    yield f(x);
  }
}
113
function nested_fold(cons, seed, iterable) {
114
  var visited = []
115
  for (let x of iterable) {
116 117 118 119 120 121 122
    for (let y of x) {
      seed = cons(y, seed);
    }
  }
  return seed;
}

123 124
function* unreachable(iterable) {
  for (let x of iterable) {
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146
    throw "not reached";
  }
}

function one_time_getter(o, prop, val) {
  function set_never() { throw "unreachable"; }
  var gotten = false;
  function get_once() {
    if (gotten) throw "got twice";
    gotten = true;
    return val;
  }
  Object.defineProperty(o, prop, {get: get_once, set: set_never})
  return o;
}

function never_getter(o, prop) {
  function never() { throw "unreachable"; }
  Object.defineProperty(o, prop, {get: never, set: never})
  return o;
}

147 148
function remove_next_after(iterable, n) {
  var iterator = iterable[Symbol.iterator]();
149 150
  function next() {
    if (n-- == 0) delete this.next;
151
    return iterator.next();
152
  }
153
  return wrap_iterator({ next: next });
154 155
}

156 157
function poison_next_after(iterable, n) {
  var iterator = iterable[Symbol.iterator]();
158
  function next() {
159
    return iterator.next();
160 161 162 163 164 165 166 167
  }
  function next_getter() {
    if (n-- < 0)
      throw "poisoned";
    return next;
  }
  var o = {};
  Object.defineProperty(o, 'next', { get: next_getter });
168
  return wrap_iterator(o);
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
}

// Now, the tests.

// Non-generator iterators.
assertEquals(45, fold(sum, 0, integers_until(10)));
// Generator iterators.
assertEquals([1, 2, 3], fold(append, [], values(1, 2, 3)));
// Break.
assertEquals(45, fold(sum, 0, take(integers_from(0), 10)));
// Continue.
assertEquals(90, fold(sum, 0, take(skip_every(integers_from(0), 2), 10)));
// Return.
assertEquals(10, nth(integers_from(0), 10));
// Nested for-of.
assertEquals([0, 0, 1, 0, 1, 2, 0, 1, 2, 3],
             nested_fold(append,
                         [],
                         iter_map(integers_until(5), integers_until)));
// Result objects with sparse fields.
assertEquals([undefined, 1, 2, 3],
             fold(append, [],
                  results([{ done: false },
                           { value: 1, done: false },
                           // A missing "done" is the same as undefined, which
                           // is false.
                           { value: 2 },
                           // Not done.
                           { value: 3, done: 0 },
                           // Done.
                           { value: 4, done: 42 }])));
// Results that are not objects.
201 202 203 204 205
assertThrows(function() {
  assertEquals([undefined, undefined, undefined],
               fold(append, [],
                    results([10, "foo", /qux/, { value: 37, done: true }])));
}, TypeError);
206 207 208 209 210 211 212 213
// Getters (shudder).
assertEquals([1, 2],
             fold(append, [],
                  results([one_time_getter({ value: 1 }, 'done', false),
                           one_time_getter({ done: false }, 'value', 2),
                           { value: 37, done: true },
                           never_getter(never_getter({}, 'done'), 'value')])));

214 215 216
// Unlike the case with for-in, null and undefined cause an error.
assertThrows('fold(sum, 0, unreachable(null))', TypeError);
assertThrows('fold(sum, 0, unreachable(undefined))', TypeError);
217 218 219

// Other non-iterators do cause an error.
assertThrows('fold(sum, 0, unreachable({}))', TypeError);
220
assertThrows('fold(sum, 0, unreachable(false))', TypeError);
221 222
assertThrows('fold(sum, 0, unreachable(37))', TypeError);

223 224 225
// "next" is looked up only once during the iteration prologue (see
// https://github.com/tc39/ecma262/pull/988)
assertEquals(45, fold(sum, 0, remove_next_after(integers_until(10), 5)));
226 227 228 229 230
assertEquals(45,
             fold(sum, 0, remove_next_after(integers_until(10), 10)));
assertEquals(45,
             fold(sum, 0, poison_next_after(integers_until(10), 10)));

231
function labelled_continue(iterable) {
232 233 234 235
  var n = 0;
outer:
  while (true) {
    n++;
236
    for (var x of iterable) continue outer;
237 238 239 240 241 242
    break;
  }
  return n;
}
assertEquals(11, labelled_continue(integers_until(10)));

243
function labelled_break(iterable) {
244 245 246 247
  var n = 0;
outer:
  while (true) {
    n++;
248
    for (var x of iterable) break outer;
249 250 251 252 253 254
  }
  return n;
}
assertEquals(1, labelled_break(integers_until(10)));

// Test continue/break in catch.
255
function catch_control(iterable, k) {
256
  var n = 0;
257
  for (var x of iterable) {
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
    try {
      return k(x);
    } catch (e) {
      if (e == "continue") continue;
      else if (e == "break") break;
      else throw e;
    }
  } while (false);
  return false;
}
assertEquals(false,
             catch_control(integers_until(10),
                           function() { throw "break" }));
assertEquals(false,
             catch_control(integers_until(10),
                           function() { throw "continue" }));
assertEquals(5,
             catch_control(integers_until(10),
                           function(x) {
                             if (x == 5) return x;
                             throw "continue";
                           }));

// Test continue/break in try.
282
function try_control(iterable, k) {
283
  var n = 0;
284
  for (var x of iterable) {
285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305
    try {
      var e = k(x);
      if (e == "continue") continue;
      else if (e == "break") break;
      return e;
    } catch (e) {
      throw e;
    }
  } while (false);
  return false;
}
assertEquals(false,
             try_control(integers_until(10),
                         function() { return "break" }));
assertEquals(false,
             try_control(integers_until(10),
                         function() { return "continue" }));
assertEquals(5,
             try_control(integers_until(10),
                         function(x) { return (x == 5) ? x : "continue" }));

306
// TODO(neis,cbruni): Enable once the corresponding traps work again.
307
// Proxy results, with getters.
308 309 310 311 312 313 314 315 316 317 318 319
// function transparent_proxy(x) {
//   return new Proxy({}, {
//     get: function(receiver, name) { return x[name]; }
//   });
// }
// assertEquals([1, 2],
//              fold(append, [],
//                   results([one_time_getter({ value: 1 }, 'done', false),
//                            one_time_getter({ done: false }, 'value', 2),
//                            { value: 37, done: true },
//                            never_getter(never_getter({}, 'done'), 'value')]
//                           .map(transparent_proxy))));
320 321

// Proxy iterators.
322 323 324 325 326 327 328 329 330 331 332 333 334 335
// function poison_proxy_after(iterable, n) {
//   var iterator = iterable[Symbol.iterator]();
//   return wrap_iterator(new Proxy({}, {
//     get: function(receiver, name) {
//       if (name == 'next' && n-- < 0) throw "unreachable";
//       return iterator[name];
//     },
//     // Needed for integers_until(10)'s this.n++.
//     set: function(receiver, name, val) {
//       return iterator[name] = val;
//     }
//   }));
// }
// assertEquals(45, fold(sum, 0, poison_proxy_after(integers_until(10), 10)));
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357


function test_iterator_result_object_non_object(value, descr) {
  var arr = [];
  var ex;
  var message = 'Iterator result ' + (descr || value) + ' is not an object';
  try {
    fold(append, arr,
         results([{value: 1}, {}, value, {value: 2}, {done: true}]));
  } catch (e) {
    ex = e;
  }
  assertInstanceof(ex, TypeError);
  assertEquals(message, ex.message);
  assertArrayEquals([1, undefined], arr);
}
test_iterator_result_object_non_object(null);
test_iterator_result_object_non_object(undefined);
test_iterator_result_object_non_object(42);
test_iterator_result_object_non_object('abc');
test_iterator_result_object_non_object(false);
test_iterator_result_object_non_object(Symbol('x'), 'Symbol(x)');