Dartifying some IndexedDB APIs.

sdk/lib/indexed_db/dart2js/indexed_db_dart2js.dart

 library dart.dom.indexed_db;
 
 import 'dart:async';
 import 'dart:html';
 import 'dart:html_common';
 import 'dart:_js_helper' show Creates, Returns, JSName, Null;
 import 'dart:_foreign_helper' show JS;
 // Copyright (c) 2012, 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.
@@ skipping 146 matching lines @@
   @DocsEditable
   final dynamic source;
 
   @DomName('IDBCursor.advance')
   @DocsEditable
   void advance(int count) native;
 
   @JSName('continue')
   @DomName('IDBCursor.continue')
   @DocsEditable
-  void continueFunction([Object key]) native;
+  void next([Object key]) native;
 
   @DomName('IDBCursor.delete')
   @DocsEditable
   Request delete() native;
 
   Request update(/*any*/ value) {
     var value_1 = convertDartToNative_SerializedScriptValue(value);
     return _update_1(value_1);
   }
   @JSName('update')
@@ skipping 158 matching lines @@
   /**
    * Checks to see if Indexed DB is supported on the current platform.
    */
   static bool get supported {
     return JS('bool',
         '!!(window.indexedDB || '
         'window.webkitIndexedDB || '
         'window.mozIndexedDB)');
   }
 
+  @DomName('IDBFactory.open')
+  Future<Database> open(String name,
+      {int version, void onUpgradeNeeded(VersionChangeEvent),
+      void onBlocked(Event)}) {
+    if ((version == null) != (onUpgradeNeeded == null)) {
+      return new Future.immediateError(new ArgumentError(
+          'version specified but not onUpgradeNeeded'));

[nweiz, 2013/02/07 20:38:10]

This is inaccurate if onUpgradeNeeded is specified but not version.

[blois, 2013/02/08 22:18:56]

Done.

+    }
+    try {
+      var request;
+      if (version != null) {
+        request = $dom_open(name, version);
+      } else {
+        request = $dom_open(name);
+      }
+
+      if (onUpgradeNeeded != null) {
+        request.onUpgradeNeeded.listen(onUpgradeNeeded);
+      }
+      if (onBlocked != null) {
+        request.onBlocked.listen(onBlocked);
+      }
+      return _completeRequest(request);
+    } catch (e, stacktrace) {
+      return new Future.immediateError(e, stacktrace);
+    }
+  }
+
+  @DomName('IDBFactory.open')
+  Future<IdbFactory> deleteDatabase(String name,
+      {void onBlocked(Event)}) {
+    try {
+      var request = $dom_deleteDatabase(name);
+
+      if (onBlocked != null) {
+        request.onBlocked.listen(onBlocked);
+      }
+      return _completeRequest(request);
+    } catch (e, stacktrace) {
+      return new Future.immediateError(e, stacktrace);
+    }
+  }
+
 
   @DomName('IDBFactory.cmp')
   @DocsEditable
   int cmp(Object first, Object second) native;
 
+  @JSName('deleteDatabase')
   @DomName('IDBFactory.deleteDatabase')
   @DocsEditable
-  OpenDBRequest deleteDatabase(String name) native;
+  OpenDBRequest $dom_deleteDatabase(String name) native;
 
+  @JSName('open')
   @DomName('IDBFactory.open')
   @DocsEditable
   @Returns('Request')
   @Creates('Request')
   @Creates('Database')
-  OpenDBRequest open(String name, [int version]) native;
+  OpenDBRequest $dom_open(String name, [int version]) native;
 
   @DomName('IDBFactory.webkitGetDatabaseNames')
   @DocsEditable
   Request webkitGetDatabaseNames() native;
 
 }
+
+
+/**
+ * Ties a request to a completer, so the completer is completed when it succeeds
+ * and errors out when the request errors.
+ */
+Future _completeRequest(Request request) {
+  var completer = new Completer();
+  // TODO: make sure that completer.complete is synchronous as transactions
+  // may be committed if the result is not processed immediately.
+  request.onSuccess.listen((e) {
+    completer.complete(request.result);
+  });
+  request.onError.listen((e) {
+    completer.completeError(e);
+  });
+  return completer.future;
+}
 // Copyright (c) 2012, 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.
 
 
 @DocsEditable
 @DomName('IDBIndex')
 class Index native "*IDBIndex" {
 
   @DomName('IDBIndex.keyPath')
@@ skipping 110 matching lines @@
   @DomName('IDBKeyRange.upperBound')
   @DocsEditable
   static KeyRange upperBound_(Object bound, [bool open]) native;
 
 }
 // Copyright (c) 2012, 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.
 
 
-@DocsEditable
 @DomName('IDBObjectStore')
 class ObjectStore native "*IDBObjectStore" {
 
+  @DomName('IDBObjectStore.put')
+  Future put(value, [key]) {
+    try {
+      var request;
+      if (key != null) {
+        request = $dom_put(value, key);
+      } else {
+        request = $dom_put(value);
+      }
+      return _completeRequest(request);
+    } catch (e, stacktrace) {
+      return new Future.immediateError(e, stacktrace);
+    }
+  }
+
+  @DomName('IDBObjectStore.getObject')
+  Future getObject(key) {
+    try {
+      var request = $dom_getObject(key);
+
+      return _completeRequest(request);
+    } catch (e, stacktrace) {
+      return new Future.immediateError(e, stacktrace);
+    }
+  }
+
+  /**
+   * Creates a stream of cursors over the records in this object store.
+   *
+   * **The stream must be manually advanced by calling [Cursor.next] after
+   * each item or by specifying autoAdvance to be true.**
+   *
+   *     var cursors = objectStore.openCursor().listen(
+   *       (cursor) {
+   *         // ...some processing with the cursor
+   *         cursor.next(); // advance onto the next cursor.
+   *       },
+   *       onDone: () {
+   *         // called when there are no more cursors.
+   *         print('all done!');
+   *       });
+   *
+   * Asynchronous operations which are not related to the current transaction
+   * will cause the transaction to automatically be committed-- all processing
+   * must be done synchronously unless they are additional async requests to
+   * the current transaction.
+   */
+  @DomName('IDBObjectStore.openCursor')
+  Stream<Cursor> openCursor({key, KeyRange range, String direction,
+      bool autoAdvance}) {
+    var key_OR_range = null;
+    if (key != null) {
+      if (range != null) {
+        throw new ArgumentError('Cannot specify both key and range.');
+      }
+      key_OR_range = key;
+    } else {
+      key_OR_range = range;
+    }
+
+    // TODO: try/catch this and return a stream with an immediate error.
+    var request;
+    if (direction == null) {
+      request = $dom_openCursor(key_OR_range);
+    } else {
+      request = $dom_openCursor(key_OR_range, direction);
+    }
+    return _cursorStreamFromResult(request, autoAdvance);
+  }
+
+
   @DomName('IDBObjectStore.autoIncrement')
   @DocsEditable
   final bool autoIncrement;
 
   @DomName('IDBObjectStore.indexNames')
   @DocsEditable
   @Returns('DomStringList')
   @Creates('DomStringList')
   final List<String> indexNames;
 
@@ skipping 82 matching lines @@
   @DomName('IDBObjectStore.deleteIndex')
   @DocsEditable
   void deleteIndex(String name) native;
 
   @JSName('get')
   @DomName('IDBObjectStore.get')
   @DocsEditable
   @Returns('Request')
   @Creates('Request')
   @annotation_Creates_SerializedScriptValue
-  Request getObject(key) native;
+  Request $dom_getObject(key) native;
 
   @DomName('IDBObjectStore.index')
   @DocsEditable
   Index index(String name) native;
 
+  @JSName('openCursor')
   @DomName('IDBObjectStore.openCursor')
   @DocsEditable
   @Returns('Request')
   @Creates('Request')
   @Creates('Cursor')
-  Request openCursor([key_OR_range, String direction]) native;
+  Request $dom_openCursor([key_OR_range, String direction]) native;
 
-  Request put(/*any*/ value, [/*any*/ key]) {
+  Request $dom_put(/*any*/ value, [/*any*/ key]) {
     if (?key) {
       var value_1 = convertDartToNative_SerializedScriptValue(value);
       var key_2 = convertDartToNative_SerializedScriptValue(key);
-      return _put_1(value_1, key_2);
+      return _$dom_put_1(value_1, key_2);
     }
     var value_3 = convertDartToNative_SerializedScriptValue(value);
-    return _put_2(value_3);
+    return _$dom_put_2(value_3);
   }
   @JSName('put')
   @DomName('IDBObjectStore.put')
   @DocsEditable
   @Returns('Request')
   @Creates('Request')
   @_annotation_Creates_IDBKey
-  Request _put_1(value, key) native;
+  Request _$dom_put_1(value, key) native;
   @JSName('put')
   @DomName('IDBObjectStore.put')
   @DocsEditable
   @Returns('Request')
   @Creates('Request')
   @_annotation_Creates_IDBKey
-  Request _put_2(value) native;
+  Request _$dom_put_2(value) native;
+
+
+  /**
+   * Helper for iterating over cursors in a request.
+   */
+  static Stream<Cursor> _cursorStreamFromResult(Request request,
+      bool autoAdvance) {
+    // TODO: need to guarantee that the controller provides the values
+    // immediately as waiting until the next tick will cause the transaction to
+    // close.
+    var controller = new StreamController<Cursor>();
+
+    request.onError.listen((e) {
+      //TODO: Report stacktrace once issue 4061 is resolved.
+      controller.signalError(e);
+    });
+
+    request.onSuccess.listen((e) {
+      Cursor cursor = request.result;
+      if (cursor == null) {
+        controller.close();
+      } else {
+        controller.add(cursor);
+        if (autoAdvance == true) {
+          cursor.next();
+        }
+      }
+    });
+    return controller.stream;
+  }
 }
 // Copyright (c) 2012, 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.
 
 
 @DocsEditable
 @DomName('IDBOpenDBRequest')
 class OpenDBRequest extends Request implements EventTarget native "*IDBOpenDBRequest" {
 
@@ skipping 111 matching lines @@
 class RequestEvents extends Events {
   @DocsEditable
   RequestEvents(EventTarget _ptr) : super(_ptr);
 
   @DocsEditable
   EventListenerList get error => this['error'];
 
   @DocsEditable
   EventListenerList get success => this['success'];
 }
-// Copyright (c) 2012, the Dart project authors.  Please see the AUTHORS file
+// Copyright (c) 2013, 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.
 
 
-@DocsEditable
 @DomName('IDBTransaction')
 class Transaction extends EventTarget native "*IDBTransaction" {
 
+  /**
+   * Provides a Future which will be completed once the transaction has
+   * completed.
+   *
+   * The future will error if an error occurrs on the transaction or if the
+   * transaction is aborted.
+   */
+  Future<Database> get completed {
+    var completer = new Completer<Database>();
+
+    this.onComplete.first.then((_) {
+      completer.complete(db);
+    });
+
+    this.onError.first.then((e) {
+      completer.completeError(e);
+    });
+
+    this.onAbort.first.then((e) {
+      completer.completeError(e);
+    });
+
+    return completer.future;
+  }
+
+
   @DomName('IDBTransaction.abortEvent')
   @DocsEditable
   static const EventStreamProvider<Event> abortEvent = const EventStreamProvider<Event>('abort');
 
   @DomName('IDBTransaction.completeEvent')
   @DocsEditable
   static const EventStreamProvider<Event> completeEvent = const EventStreamProvider<Event>('complete');
 
   @DomName('IDBTransaction.errorEvent')
   @DocsEditable
@@ skipping 47 matching lines @@
   @DocsEditable
   Stream<Event> get onAbort => abortEvent.forTarget(this);
 
   @DomName('IDBTransaction.oncomplete')
   @DocsEditable
   Stream<Event> get onComplete => completeEvent.forTarget(this);
 
   @DomName('IDBTransaction.onerror')
   @DocsEditable
   Stream<Event> get onError => errorEvent.forTarget(this);
+
 }
 
 @DocsEditable
 @deprecated
 class TransactionEvents extends Events {
   @DocsEditable
   TransactionEvents(EventTarget _ptr) : super(_ptr);
 
   @DocsEditable
   EventListenerList get abort => this['abort'];
@@ skipping 23 matching lines @@
 }
 // Copyright (c) 2012, 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.
 
 
 @DocsEditable
 @DomName('IDBAny')
 class _IDBAny native "*IDBAny" {
 }