types.ts

import { Result } from '@stopify/continuations-runtime';
export { Result };
export { HandleNew, CaptureMethod, CompilerOpts } from '@stopify/continuations';
import * as t from 'babel-types';

export type Stoppable = (isStop: () => boolean,
                         onStop: () => void,
                         onDone: () => void,
                         opts: RuntimeOpts) => void;

export type ElapsedTimeEstimatorName = 'exact' | 'reservoir' | 'velocity' | 'interrupt' | 'countdown';

export interface RuntimeOpts {
  filename: string,
  estimator: ElapsedTimeEstimatorName;
  yieldInterval: number,
  resampleInterval: number,
  timePerElapsed: number,
  stop: number | undefined,
  variance: boolean,
  stackSize: number,
  restoreFrames: number,

  /** These are strings that Selenium recognizes, which is why it says
   * 'MicrosoftEdge' instead of 'edge'.
   */
  env: 'firefox' | 'chrome' | 'node' | 'MicrosoftEdge' | 'safari'
}

export type Error = {
  kind: 'error',
  exception: any
}

export interface AsyncEval {
  evalAsyncFromAst(ast: t.Program, onDone: (result: Result) => void): void;
  evalAsync(src: string, onDone: (result: Result) => void): void;
}

export interface AsyncRun {
  kind : 'ok',
  g: { [key: string]: any},
  run(onDone: (result: Result) => void,
    onYield?: () => void,
    onBreakpoint?: (line: number) => void): void;
  pause(onPaused: (line?: number) => void): void;
  resume(): void;
  isRunning(): boolean;
  setBreakpoints(line: number[]): void;
  step(onStep: (line: number) => void): void;
  pauseK(callback: (k: (r: Result) => void) => void): void;
  pauseImmediate(callback: () => void): void;
  continueImmediate(result: Result): void;
  processEvent(body: () => any, receiver: (x: Result) => void): void;

  /** Start an external higher-order function. */
  externalHOF(body: (complete: (result: Result) => void) => void): void;

  /** Run Stopified code from an external higher-order function. */
  runStopifiedCode(body: () => void, callback: (x: Result) => void): void;
}