// Copyright (c) Microsoft Corporation. All rights reserved.

// Licensed under the MIT License.

import { ChildProcess, SpawnOptions as ChildProcessSpawnOptions } from 'child_process';

import * as Rx from 'rxjs';

import { CancellationToken, Uri } from 'vscode';

import { EnvironmentVariables } from '../variables/types';

export const IBufferDecoder = Symbol('IBufferDecoder');

export interface IBufferDecoder {

decode(buffers: Buffer[], encoding: string): string;

}

export type Output<T extends string | Buffer> = {

source: 'stdout' | 'stderr';

out: T;

};

export type ObservableExecutionResult<T extends string | Buffer> = {

proc: ChildProcess;

out: Rx.Observable<Output<T>>;

};

// tslint:disable-next-line:interface-name

export type SpawnOptions = ChildProcessSpawnOptions & {

encoding?: string;

token?: CancellationToken;

mergeStdOutErr?: boolean;

throwOnStdErr?: boolean;

};

export type ExecutionResult<T extends string | Buffer> = {

stdout: T;

stderr?: T;

};

export const IProcessService = Symbol('IProcessService');

export interface IProcessService {

execObservable(file: string, args: string[], options: SpawnOptions): ObservableExecutionResult<string>;

exec(file: string, args: string[], options: SpawnOptions): Promise<ExecutionResult<string>>;

}

export const IPythonExecutionFactory = Symbol('IPythonExecutionFactory');

export interface IPythonExecutionFactory {

create(resource?: Uri): Promise<IPythonExecutionService>;

}

export const IPythonExecutionService = Symbol('IPythonExecutionService');

export interface IPythonExecutionService {

getVersion(): Promise<string>;

getExecutablePath(): Promise<string>;

isModuleInstalled(moduleName: string): Promise<boolean>;

execObservable(args: string[], options: SpawnOptions): ObservableExecutionResult<string>;

execModuleObservable(moduleName: string, args: string[], options: SpawnOptions): ObservableExecutionResult<string>;

exec(args: string[], options: SpawnOptions): Promise<ExecutionResult<string>>;

execModule(moduleName: string, args: string[], options: SpawnOptions): Promise<ExecutionResult<string>>;

}

export class StdErrError extends Error {

constructor(message: string) {

super(message);

}

}

export interface IExecutionEnvironmentVariablesService {

getEnvironmentVariables(resource?: Uri): Promise<EnvironmentVariables | undefined>;

}