pkg/dartdev/lib/src/vm_interop_handler.dart

// Copyright (c) 2020, 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.

import 'dart:isolate';

import 'package:meta/meta.dart';

/// Contains methods used to communicate DartDev results back to the VM.
abstract class VmInteropHandler {
  /// Initializes [VmInteropHandler] to utilize [port] to communicate with the
  /// VM.
  static void initialize(SendPort port) => _port = port;

  /// Notifies the VM to run [script] with [args] upon DartDev exit.
  ///
  /// If [packageConfigOverride] is given, that is where the packageConfig is found.
  static void run(
    String script,
    List<String> args, {
    @required String packageConfigOverride,
  }) {
    assert(_port != null);
    if (_port == null) return;
    final message = <dynamic>[
      _kResultRun,
      script,
      packageConfigOverride,
      // Copy the list so it doesn't get GC'd underneath us.
      args.toList()
    ];
    _port.send(message);
  }

  /// Notifies the VM that DartDev has completed running. If provided a
  /// non-zero [exitCode], the VM will terminate with the given exit code.
  static void exit(int exitCode) {
    assert(_port != null);
    if (_port == null) return;
    final message = <dynamic>[_kResultExit, exitCode];
    _port.send(message);
  }

  // Note: keep in sync with runtime/bin/dartdev_isolate.h
  static const int _kResultRun = 1;
  static const int _kResultExit = 2;

  static SendPort _port;
}