cleans up sdk patching so we no longer have unresolved names

test/generated_sdk/lib/isolate/isolate.dart

+// 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.
+
+/**
+ * Concurrent programming using _isolates_:
+ * independent workers that are similar to threads
+ * but don't share memory,
+ * communicating only via messages.
+ */
+library dart.isolate;
+
+import "dart:async";
+
+part "capability.dart";
+import 'dart:_js_helper' show patch;
+import 'dart:_isolate_helper' show CapabilityImpl,
+                                   CloseToken,
+                                   IsolateNatives,
+                                   JsIsolateSink,
+                                   ReceivePortImpl,
+                                   RawReceivePortImpl;
+
+/**
+ * Thrown when an isolate cannot be created.
+ */
+class IsolateSpawnException implements Exception {
+  /** Error message reported by the spawn operation. */
+  final String message;
+  IsolateSpawnException(this.message);
+  String toString() => "IsolateSpawnException: $message";
+}
+
+/**
+ * An isolated Dart execution context.
+ *
+ * All Dart code runs in an isolate, and code can access classes and values
+ * only from the same isolate. Different isolates can communicate by sending
+ * values through ports (see [ReceivePort], [SendPort]).
+ *
+ * An `Isolate` object is a reference to an isolate, usually different from
+ * the current isolate.
+ * It represents, and can be used control, the other isolate.
+ *
+ * When spawning a new isolate, the spawning isolate receives an `Isolate`
+ * object representing the new isolate when the spawn operation succeeds.
+ *
+ * Isolates run code in its own event loop, and each event may run smaller tasks
+ * in a nested microtask queue.
+ *
+ * An `Isolate` object allows other isolates to control the event loop
+ * of the isolate that it represents, and to inspect the isolate,
+ * for example by pausing the isolate or by getting events when the isolate
+ * has an uncaught error.
+ *
+ * The [controlPort] gives access to controlling the isolate, and the
+ * [pauseCapability] and [terminateCapability] guard access to some control
+ * operations.
+ * The `Isolate` object provided by a spawn operation will have the
+ * control port and capabilities needed to control the isolate.
+ * New isolates objects can be created without some of these capabilities
+ * if necessary.
+ *
+ * An `Isolate` object cannot be sent over a `SendPort`, but the control port
+ * and capabilities can be sent, and can be used to create a new functioning
+ * `Isolate` object in the receiving port's isolate.
+ */
+class Isolate {
+  /** Argument to `ping` and `kill`: Ask for immediate action. */
+  static const int IMMEDIATE = 0;
+  /** Argument to `ping` and `kill`: Ask for action before the next event. */
+  static const int BEFORE_NEXT_EVENT = 1;
+  /** Argument to `ping` and `kill`: Ask for action after normal events. */
+  static const int AS_EVENT = 2;
+
+  /**
+   * Control port used to send control messages to the isolate.
+   *
+   * This class provides helper functions that sends control messages
+   * to the control port.
+   *
+   * The control port identifies the isolate.
+   */
+  final SendPort controlPort;
+
+  /**
+   * Capability granting the ability to pause the isolate.
+   *
+   * This capability is used by [pause].
+   * If the capability is not the correct pause capability of the isolate,
+   * including if the capability is `null`, then calls to `pause` will have no
+   * effect.
+   *
+   * If the isolate is started in a paused state, use this capability as
+   * argument to [resume] to resume the isolate.
+   */
+  final Capability pauseCapability;
+
+  /**
+   * Capability granting the ability to terminate the isolate.
+   *
+   * This capability is used by [kill] and [setErrorsFatal].
+   * If the capability is not the correct termination capability of the isolate,
+   * including if the capability is `null`, then calls to those methods will
+   * have no effect.
+   */
+  final Capability terminateCapability;
+
+  /**
+   * Create a new [Isolate] object with a restricted set of capabilities.
+   *
+   * The port should be a control port for an isolate, as taken from
+   * another `Isolate` object.
+   *
+   * The capabilities should be the subset of the capabilities that are
+   * available to the original isolate.
+   * Capabilities of an isolate are locked to that isolate, and have no effect
+   * anywhere else, so the capabilities should come from the same isolate as
+   * the control port.
+   *
+   * If all the available capabilities are included,
+   * there is no reason to create a new object,
+   * since the behavior is defined entirely
+   * by the control port and capabilities.
+   */
+  Isolate(this.controlPort, {this.pauseCapability,
+                             this.terminateCapability});
+
+  /**
+   * Return the current [Isolate].
+   *
+   * The isolate gives access to the capabilities needed to inspect,
+   * pause or kill the isolate, and allows granting these capabilities
+   * to others.
+   */
+  static Isolate get current => _currentIsolateCache;
+
+  /**
+   * Creates and spawns an isolate that shares the same code as the current
+   * isolate.
+   *
+   * The argument [entryPoint] specifies the entry point of the spawned
+   * isolate. It must be a top-level function or a static method that
+   * takes one argument - that is, one-parameter functions that can be
+   * compile-time constant function values.
+   * It is not allowed to pass the value of function expressions or an instance
+   * method extracted from an object.
+   *
+   * The entry-point function is invoked with the initial [message].
+   * Usually the initial [message] contains a [SendPort] so
+   * that the spawner and spawnee can communicate with each other.
+   *
+   * If the [paused] parameter is set to `true`,
+   * the isolate will start up in a paused state,
+   * as if by an initial call of `isolate.pause(isolate.pauseCapability)`.
+   * This allows setting up error or exit listeners on the isolate
+   * before it starts running.
+   * To resume the isolate, call `isolate.resume(isolate.pauseCapability)`.
+   *
+   * WARNING: The `pause` parameter is not implemented on all platforms yet.
+   *
+   * Returns a future that will complete with an [Isolate] instance if the
+   * spawning succeeded. It will complete with an error otherwise.
+   */
+  static Future<Isolate> spawn(void entryPoint(message), var message,
+                                     { bool paused: false }) {
+    try {
+      return IsolateNatives.spawnFunction(entryPoint, message, paused)
+          .then((msg) => new Isolate(msg[1],
+                                     pauseCapability: msg[2],
+                                     terminateCapability: msg[3]));
+    } catch (e, st) {
+      return new Future<Isolate>.error(e, st);
+    }
+  }
+
+  /**
+   * Creates and spawns an isolate that runs the code from the library with
+   * the specified URI.
+   *
+   * The isolate starts executing the top-level `main` function of the library
+   * with the given URI.
+   *
+   * The target `main` must be a subtype of one of these three signatures:
+   *
+   * * `main()`
+   * * `main(args)`
+   * * `main(args, message)`
+   *
+   * When present, the parameter `args` is set to the provided [args] list.
+   * When present, the parameter `message` is set to the initial [message].
+   *
+   * If the [packageRoot] parameter is provided, it is used to find the location
+   * of packages imports in the spawned isolate.
+   * The `packageRoot` URI must be a "file" or "http"/"https" URI that specifies
+   * a directory. If it doesn't end in a slash, one will be added before
+   * using the URI, and any query or fragment parts are ignored.
+   * Package imports (like "package:foo/bar.dart") in the new isolate are
+   * resolved against this location, as by
+   * `packageRoot.resolve("foo/bar.dart")`.
+   * This includes the main entry [uri] if it happens to be a package-URL.
+   * If [packageRoot] is omitted, it defaults to the same URI that
+   * the current isolate is using.
+   *
+   * WARNING: The [packageRoot] parameter is not implemented on all
+   * platforms yet.
+   *
+   * If the [paused] parameter is set to `true`,
+   * the isolate will start up in a paused state,
+   * as if by an initial call of `isolate.pause(isolate.pauseCapability)`.
+   * This allows setting up error or exit listeners on the isolate
+   * before it starts running.
+   * To resume the isolate, call `isolate.resume(isolate.pauseCapability)`.
+   *
+   * WARNING: The `pause` parameter is not implemented on all platforms yet.
+   *
+   * Returns a future that will complete with an [Isolate] instance if the
+   * spawning succeeded. It will complete with an error otherwise.
+   */
+  static Future<Isolate> spawnUri(
+      Uri uri, List<String> args, var message, { bool paused: false,
+                                                 Uri packageRoot }) {
+    if (packageRoot != null) throw new UnimplementedError("packageRoot");
+    try {
+      if (args is List<String>) {
+        for (int i = 0; i < args.length; i++) {
+          if (args[i] is! String) {
+            throw new ArgumentError("Args must be a list of Strings $args");
+          }
+        }
+      } else if (args != null) {
+        throw new ArgumentError("Args must be a list of Strings $args");
+      }
+      return IsolateNatives.spawnUri(uri, args, message, paused)
+          .then((msg) => new Isolate(msg[1],
+                                     pauseCapability: msg[2],
+                                     terminateCapability: msg[3]));
+    } catch (e, st) {
+      return new Future<Isolate>.error(e, st);
+    }
+  }
+
+  /**
+   * Requests the isolate to pause.
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * The isolate should stop handling events by pausing its event queue.
+   * The request will eventually make the isolate stop doing anything.
+   * It will be handled before any other messages that are later sent to the
+   * isolate from the current isolate, but no other guarantees are provided.
+   *
+   * The event loop may be paused before previously sent, but not yet exeuted,
+   * messages have been reached.
+   *
+   * If [resumeCapability] is provided, it is used to identity the pause,
+   * and must be used again to end the pause using [resume].
+   * Otherwise a new resume capability is created and returned.
+   *
+   * If an isolate is paused more than once using the same capability,
+   * only one resume with that capability is needed to end the pause.
+   *
+   * If an isolate is paused using more than one capability,
+   * they must all be individully ended before the isolate resumes.
+   *
+   * Returns the capability that must be used to resume end the pause.
+   */
+  Capability pause([Capability resumeCapability]) {
+    if (resumeCapability == null) resumeCapability = new Capability();
+    _pause(resumeCapability);
+    return resumeCapability;
+  }
+
+  /** Internal implementation of [pause]. */
+  void _pause(Capability resumeCapability) {
+    var message = new List(3)
+        ..[0] = "pause"
+        ..[1] = pauseCapability
+        ..[2] = resumeCapability;
+    controlPort.send(message);
+  }
+
+  /**
+   * Resumes a paused isolate.
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * Sends a message to an isolate requesting that it ends a pause
+   * that was requested using the [resumeCapability].
+   *
+   * When all active pause requests have been cancelled, the isolate
+   * will continue handling normal messages.
+   *
+   * The capability must be one returned by a call to [pause] on this
+   * isolate, otherwise the resume call does nothing.
+   */
+  void resume(Capability resumeCapability) {
+    var message = new List(2)
+        ..[0] = "resume"
+        ..[1] = resumeCapability;
+    controlPort.send(message);
+  }
+
+  /**
+   * Asks the isolate to send a message on [responsePort] when it terminates.
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * The isolate will send a `null` message on [responsePort] as the last
+   * thing before it terminates. It will run no further code after the message
+   * has been sent.
+   *
+   * If the isolate is already dead, no message will be sent.
+   */
+  /* TODO(lrn): Can we do better? Can the system recognize this message and
+   * send a reply if the receiving isolate is dead?
+   */
+  void addOnExitListener(SendPort responsePort) {
+    // TODO(lrn): Can we have an internal method that checks if the receiving
+    // isolate of a SendPort is still alive?
+    var message = new List(2)
+        ..[0] = "add-ondone"
+        ..[1] = responsePort;
+    controlPort.send(message);
+  }
+
+  /**
+   * Stop listening on exit messages from the isolate.
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * If a call has previously been made to [addOnExitListener] with the same
+   * send-port, this will unregister the port, and it will no longer receive
+   * a message when the isolate terminates.
+   * A response may still be sent until this operation is fully processed by
+   * the isolate.
+   */
+  void removeOnExitListener(SendPort responsePort) {
+    var message = new List(2)
+        ..[0] = "remove-ondone"
+        ..[1] = responsePort;
+    controlPort.send(message);
+  }
+
+  /**
+   * Set whether uncaught errors will terminate the isolate.
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * If errors are fatal, any uncaught error will terminate the isolate
+   * event loop and shut down the isolate.
+   *
+   * This call requires the [terminateCapability] for the isolate.
+   * If the capability is not correct, no change is made.
+   */
+  void setErrorsFatal(bool errorsAreFatal) {
+    var message = new List(3)
+        ..[0] = "set-errors-fatal"
+        ..[1] = terminateCapability
+        ..[2] = errorsAreFatal;
+    controlPort.send(message);
+  }
+
+  /**
+   * Requests the isolate to shut down.
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * The isolate is requested to terminate itself.
+   * The [priority] argument specifies when this must happen.
+   *
+   * The [priority] must be one of [IMMEDIATE], [BEFORE_NEXT_EVENT] or
+   * [AS_EVENT].
+   * The shutdown is performed at different times depending on the priority:
+   *
+   * * `IMMEDIATE`: The the isolate shuts down as soon as possible.
+   *     Control messages are handled in order, so all previously sent control
+   *     events from this isolate will all have been processed.
+   *     The shutdown should happen no later than if sent with
+   *     `BEFORE_NEXT_EVENT`.
+   *     It may happen earlier if the system has a way to shut down cleanly
+   *     at an earlier time, even during the execution of another event.
+   * * `BEFORE_NEXT_EVENT`: The shutdown is scheduled for the next time
+   *     control returns to the event loop of the receiving isolate,
+   *     after the current event, and any already scheduled control events,
+   *     are completed.
+   * * `AS_EVENT`: The shutdown does not happen until all prevously sent
+   *     non-control messages from the current isolate to the receiving isolate
+   *     have been processed.
+   *     The kill operation effectively puts the shutdown into the normal event
+   *     queue after previously sent messages, and it is affected by any control
+   *     messages that affect normal events, including `pause`.
+   *     This can be used to wait for a another event to be processed.
+   */
+  void kill([int priority = BEFORE_NEXT_EVENT]) {
+    controlPort.send(["kill", terminateCapability, priority]);
+  }
+
+  /**
+   * Request that the isolate send a response on the [responsePort].
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * If the isolate is alive, it will eventually send a `null` response on
+   * the response port.
+   *
+   * The [pingType] must be one of [IMMEDIATE], [BEFORE_NEXT_EVENT] or
+   * [AS_EVENT].
+   * The response is sent at different times depending on the ping type:
+   *
+   * * `IMMEDIATE`: The the isolate responds as soon as it receives the
+   *     control message. This is after any previous control message
+   *     from the same isolate has been received.
+   * * `BEFORE_NEXT_EVENT`: The response is scheduled for the next time
+   *     control returns to the event loop of the receiving isolate,
+   *     after the current event, and any already scheduled control events,
+   *     are completed.
+   * * `AS_EVENT`: The response is not sent until all prevously sent
+   *     non-control messages from the current isolate to the receiving isolate
+   *     have been processed.
+   *     The ping effectively puts the response into the normal event queue
+   *     after previously sent messages, and it is affected by any control
+   *     messages that affect normal events, including `pause`.
+   *     This can be used to wait for a another event to be processed.
+   */
+  void ping(SendPort responsePort, [int pingType = IMMEDIATE]) {
+    var message = new List(3)
+        ..[0] = "ping"
+        ..[1] = responsePort
+        ..[2] = pingType;
+    controlPort.send(message);
+  }
+
+  /**
+   * Requests that uncaught errors of the isolate are sent back to [port].
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * The errors are sent back as two elements lists.
+   * The first element is a `String` representation of the error, usually
+   * created by calling `toString` on the error.
+   * The second element is a `String` representation of an accompanying
+   * stack trace, or `null` if no stack trace was provided.
+   *
+   * Listening using the same port more than once does nothing. It will only
+   * get each error once.
+   */
+  void addErrorListener(SendPort port) {
+    var message = new List(2)
+        ..[0] = "getErrors"
+        ..[1] = port;
+    controlPort.send(message);
+  }
+
+  /**
+   * Stop listening for uncaught errors through [port].
+   *
+   * WARNING: This method is experimental and not handled on every platform yet.
+   *
+   * The `port` should be a port that is listening for errors through
+   * [addErrorListener]. This call requests that the isolate stops sending
+   * errors on the port.
+   *
+   * If the same port has been passed via `addErrorListener` more than once,
+   * only one call to `removeErrorListener` is needed to stop it from receiving
+   * errors.
+   *
+   * Closing the receive port at the end of the send port will not stop the
+   * isolate from sending errors, they are just going to be lost.
+   */
+  void removeErrorListener(SendPort port) {
+    var message = new List(2)
+        ..[0] = "stopErrors"
+        ..[1] = port;
+    controlPort.send(message);
+  }
+
+  /**
+   * Returns a broadcast stream of uncaught errors from the isolate.
+   *
+   * Each error is provided as an error event on the stream.
+   *
+   * The actual error object and stackTraces will not necessarily
+   * be the same object types as in the actual isolate, but they will
+   * always have the same [Object.toString] result.
+   *
+   * This stream is based on [addErrorListener] and [removeErrorListener].
+   */
+  Stream get errors {
+    StreamController controller;
+    RawReceivePort port;
+    void handleError(message) {
+      String errorDescription = message[0];
+      String stackDescription = message[1];
+      var error = new RemoteError(errorDescription, stackDescription);
+      controller.addError(error, error.stackTrace);
+    }
+    controller = new StreamController.broadcast(
+        sync: true,
+        onListen: () {
+          port = new RawReceivePort(handleError);
+          this.addErrorListener(port.sendPort);
+        },
+        onCancel: () {
+          this.removeErrorListener(port.sendPort);
+          port.close();
+          port = null;
+        });
+    return controller.stream;
+  }
+
+  static final _currentIsolateCache = IsolateNatives.currentIsolate;
+}
+
+/**
+ * Sends messages to its [ReceivePort]s.
+ *
+ * [SendPort]s are created from [ReceivePort]s. Any message sent through
+ * a [SendPort] is delivered to its corresponding [ReceivePort]. There might be
+ * many [SendPort]s for the same [ReceivePort].
+ *
+ * [SendPort]s can be transmitted to other isolates, and they preserve equality
+ * when sent.
+ */
+abstract class SendPort implements Capability {
+
+  /**
+   * Sends an asynchronous [message] through this send port, to its
+   * corresponding `ReceivePort`.
+   *
+   * The content of [message] can be: primitive values (null, num, bool, double,
+   * String), instances of [SendPort], and lists and maps whose elements are any
+   * of these. List and maps are also allowed to be cyclic.
+   *
+   * In the special circumstances when two isolates share the same code and are
+   * running in the same process (e.g. isolates created via [Isolate.spawn]), it
+   * is also possible to send object instances (which would be copied in the
+   * process). This is currently only supported by the dartvm.  For now, the
+   * dart2js compiler only supports the restricted messages described above.
+   */
+  void send(var message);
+
+  /**
+   * Tests whether [other] is a [SendPort] pointing to the same
+   * [ReceivePort] as this one.
+   */
+  bool operator==(var other);
+
+  /**
+   * Returns an immutable hash code for this send port that is
+   * consistent with the == operator.
+   */
+  int get hashCode;
+}
+
+/**
+ * Together with [SendPort], the only means of communication between isolates.
+ *
+ * [ReceivePort]s have a `sendPort` getter which returns a [SendPort].
+ * Any message that is sent through this [SendPort]
+ * is delivered to the [ReceivePort] it has been created from. There, the
+ * message is dispatched to the `ReceivePort`'s listener.
+ *
+ * A [ReceivePort] is a non-broadcast stream. This means that it buffers
+ * incoming messages until a listener is registered. Only one listener can
+ * receive messages. See [Stream.asBroadcastStream] for transforming the port
+ * to a broadcast stream.
+ *
+ * A [ReceivePort] may have many [SendPort]s.
+ */
+abstract class ReceivePort implements Stream {
+
+  /**
+   * Opens a long-lived port for receiving messages.
+   *
+   * A [ReceivePort] is a non-broadcast stream. This means that it buffers
+   * incoming messages until a listener is registered. Only one listener can
+   * receive messages. See [Stream.asBroadcastStream] for transforming the port
+   * to a broadcast stream.
+   *
+   * A receive port is closed by canceling its subscription.
+   */
+  factory ReceivePort() = ReceivePortImpl;
+
+  /**
+   * Creates a [ReceivePort] from a [RawReceivePort].
+   *
+   * The handler of the given [rawPort] is overwritten during the construction
+   * of the result.
+   */
+  factory ReceivePort.fromRawReceivePort(RawReceivePort rawPort) {
+    return new ReceivePortImpl.fromRawReceivePort(rawPort);
+  }
+
+  /**
+   * Inherited from [Stream].
+   *
+   * Note that [onError] and [cancelOnError] are ignored since a ReceivePort
+   * will never receive an error.
+   *
+   * The [onDone] handler will be called when the stream closes.
+   * The stream closes when [close] is called.
+   */
+  StreamSubscription listen(void onData(var message),
+                            { Function onError,
+                              void onDone(),
+                              bool cancelOnError });
+
+  /**
+   * Closes `this`.
+   *
+   * If the stream has not been canceled yet, adds a close-event to the event
+   * queue and discards any further incoming messages.
+   *
+   * If the stream has already been canceled this method has no effect.
+   */
+  void close();
+
+  /**
+   * Returns a [SendPort] that sends to this receive port.
+   */
+  SendPort get sendPort;
+}
+
+abstract class RawReceivePort {
+  /**
+   * Opens a long-lived port for receiving messages.
+   *
+   * A [RawReceivePort] is low level and does not work with [Zone]s. It
+   * can not be paused. The data-handler must be set before the first
+   * event is received.
+   */
+  factory RawReceivePort([void handler(event)]) {
+    return new RawReceivePortImpl(handler);
+  }
+
+  /**
+   * Sets the handler that is invoked for every incoming message.
+   *
+   * The handler is invoked in the root-zone ([Zone.ROOT]).
+   */
+  void set handler(Function newHandler);
+
+  /**
+   * Closes the port.
+   *
+   * After a call to this method any incoming message is silently dropped.
+   */
+  void close();
+
+  /**
+   * Returns a [SendPort] that sends to this raw receive port.
+   */
+  SendPort get sendPort;
+}
+
+/**
+ * Wraps unhandled exceptions thrown during isolate execution. It is
+ * used to show both the error message and the stack trace for unhandled
+ * exceptions.
+ */
+// TODO(floitsch): probably going to remove and replace with something else.
+class _IsolateUnhandledException implements Exception {
+  /** Message being handled when exception occurred. */
+  final message;
+
+  /** Wrapped exception. */
+  final source;
+
+  /** Trace for the wrapped exception. */
+  final StackTrace stackTrace;
+
+  const _IsolateUnhandledException(this.message, this.source, this.stackTrace);
+
+  String toString() {
+    return 'IsolateUnhandledException: exception while handling message: '
+        '${message} \n  '
+        '${source.toString().replaceAll("\n", "\n  ")}\n'
+        'original stack trace:\n  '
+        '${stackTrace.toString().replaceAll("\n","\n  ")}';
+  }
+}
+
+/**
+ * Description of an error from another isolate.
+ *
+ * This error has the same `toString()` and `stackTrace.toString()` behavior
+ * as the original error, but has no other features of the original error.
+ */
+class RemoteError implements Error {
+  final String _description;
+  final StackTrace stackTrace;
+  RemoteError(String description, String stackDescription)
+      : _description = description,
+        stackTrace = new _RemoteStackTrace(stackDescription);
+  String toString() => _description;
+}
+
+class _RemoteStackTrace implements StackTrace {
+  String _trace;
+  _RemoteStackTrace(this._trace);
+  String toString() => _trace;
+}