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

// Licensed under the MIT License.

'use strict';

import { DebugConfiguration } from 'vscode';

import { DebugProtocol } from 'vscode-debugprotocol/lib/debugProtocol';

import { DebuggerTypeName } from './constants';

export enum DebugOptions {

RedirectOutput = 'RedirectOutput',

Django = 'Django',

Jinja = 'Jinja',

DebugStdLib = 'DebugStdLib',

Sudo = 'Sudo',

Pyramid = 'Pyramid',

FixFilePathCase = 'FixFilePathCase',

WindowsClient = 'WindowsClient',

UnixClient = 'UnixClient',

StopOnEntry = 'StopOnEntry',

ShowReturnValue = 'ShowReturnValue',

SubProcess = 'Multiprocess'

}

export type PathMapping = {

localRoot: string;

remoteRoot: string;

};

export type Connection = {

host?: string;

port?: number;

};

interface ICommonDebugArguments {

redirectOutput?: boolean;

django?: boolean;

gevent?: boolean;

jinja?: boolean;

debugStdLib?: boolean;

justMyCode?: boolean;

logToFile?: boolean;

debugOptions?: DebugOptions[];

port?: number;

host?: string;

// Show return values of functions while stepping.

showReturnValue?: boolean;

subProcess?: boolean;

// An absolute path to local directory with source.

pathMappings?: PathMapping[];

}

export interface IKnownAttachDebugArguments extends ICommonDebugArguments {

workspaceFolder?: string;

customDebugger?: boolean;

// localRoot and remoteRoot are deprecated (replaced by pathMappings).

localRoot?: string;

remoteRoot?: string;

// Internal field used to attach to subprocess using python debug adapter

subProcessId?: number;

processId?: number | string;

connect?: Connection;

listen?: Connection;

}

export interface IKnownLaunchRequestArguments extends ICommonDebugArguments {

sudo?: boolean;

pyramid?: boolean;

workspaceFolder?: string;

// An absolute path to the program to debug.

module?: string;

program?: string;

pythonPath: string;

// Automatically stop target after launch. If not specified, target does not stop.

stopOnEntry?: boolean;

args: string[];

cwd?: string;

debugOptions?: DebugOptions[];

env?: Record<string, string | undefined>;

envFile: string;

console?: ConsoleType;

// Internal field used to set custom python debug adapter (for testing)

debugAdapterPath?: string;

}

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

export interface LaunchRequestArguments

extends DebugProtocol.LaunchRequestArguments,

IKnownLaunchRequestArguments,

DebugConfiguration {

type: typeof DebuggerTypeName;

}

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

export interface AttachRequestArguments

extends DebugProtocol.AttachRequestArguments,

IKnownAttachDebugArguments,

DebugConfiguration {

type: typeof DebuggerTypeName;

}

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

export interface DebugConfigurationArguments extends LaunchRequestArguments, AttachRequestArguments {}

export type ConsoleType = 'internalConsole' | 'integratedTerminal' | 'externalTerminal';

export type TriggerType = 'launch' | 'attach' | 'test';