/**
* 调试功能的命名空间
*/
export namespace debug {
/**
* 当前活动的调试会话或“未定义”。活动调试会话就是其中之一
* 由调试操作浮动窗口或调试操作浮动窗口的下拉菜单中当前显示的窗口表示。
* 如果没有活动的调试会话,该值是' undefined '。
*/
export let activeDebugSession: DebugSession | undefined;
/**
* 当前活动的调试控制台。
* 如果没有活动的调试会话,则不会显示发送到调试控制台的输出。
*/
export let activeDebugConsole: DebugConsole;
/**
* 断点列表。
*/
export let breakpoints: Breakpoint[];
/**
* 活动调试会话时触发的事件已经改变了。
* 请注意,当活动调试会话更改为' undefined '时,也会触发该事件。
*/
export const onDidChangeActiveDebugSession: Event<DebugSession | undefined>;
/**
* 启动新的调试会话时触发的事件。
*/
export const onDidStartDebugSession: Event<DebugSession>;
/**
* 当从调试会话接收到自定义DAP事件时触发的事件。
*/
export const onDidReceiveDebugSessionCustomEvent: Event<DebugSessionCustomEvent>;
/**
* 调试会话结束时触发的事件。
*/
export const onDidTerminateDebugSession: Event<DebugSession>;
/**
* 添加、删除或更改一组断点时发出的事件。
*/
export const onDidChangeBreakpoints: Event<BreakpointsChangeEvent>;
/**
* 为特定的调试类型注册调试配置提供程序。
* 可选的triggerKind可以用来指定何时触发提供程序的' provideDebugConfigurations '方法。
* 当前可能有两种触发器类型:带有' Initial '值(或者如果没有给定触发器类型参数)的' provideDebugConfigurations '方法用于提供要复制到新创建的launch.json中的初始调试配置。
* 对于触发器类型' Dynamic ', ' provideDebugConfigurations '方法用于动态地决定呈现给用户的调试配置(除了launch.json中的静态配置)。
* 请注意,' triggerKind '参数只适用于' provideDebugConfigurations '方法:所以' resolveDebugConfiguration '方法根本不受影响。
* 将单个提供者注册为针对不同触发器类型的解析方法,将导致多次调用相同的解析方法。
* 可以为同一类型注册多个提供者。
*
* @param type 提供程序为其注册的调试类型。
* @param provider 要注册的调试配置提供程序。
* @param triggerKind 为其注册提供程序的“提供调试配置”方法的触发器。如果“触发类型”缺失,则值“调试配置提供程序触发类型”。最初的假设。
* @return 释放时取消注册此提供程序的disposable对象。
*/
export function registerDebugConfigurationProvider(debugType: string, provider: DebugConfigurationProvider, triggerKind?: DebugConfigurationProviderTriggerKind): Disposable;
/**
* 为特定的调试类型注册一个调试适配器描述符工厂。
* 扩展只允许为扩展定义的调试类型注册调试适配器描述符工厂。
* 否则将抛出一个错误。
* 为一个调试类型注册多个调试适配器描述符工厂会导致错误。
*
* @param debugType 工厂注册的调试类型。
* @param factory 要注册的debug适配器描述符工厂。
* @return 丢弃时取消该工厂的注册。
*/
export function registerDebugAdapterDescriptorFactory(debugType: string, factory: DebugAdapterDescriptorFactory): Disposable;
/**
* 为给定的调试类型注册一个调试适配器跟踪工厂。
*
* @param debugType 工厂注册的调试类型,或匹配所有调试类型的' '。
* @param factory 要注册的调试适配器跟踪工厂。
* @return 丢弃时取消该工厂的注册。
*/
export function registerDebugAdapterTrackerFactory(debugType: string, factory: DebugAdapterTrackerFactory): Disposable;
/**
* 通过使用命名启动或命名复合配置,或者直接传递一个[Debug configuration](# Debug configuration)来启动调试。
* 命名的配置在'.vscode/launch '中查找。json `在给定的文件夹中找到。
* 在开始调试之前,将保存所有未保存的文件,并更新启动配置。
* 在配置中使用的文件夹特定变量(例如:` ${workspace Folder} `)在给定文件夹下解析。
*
* @param folder workspace folder用于查找命名的配置和解析变量,或者“undefined”用于非文件夹设置。
* @param nameOrConfiguration 调试或复合配置的名称,或debug configuration对象的名称。
* @param parentSessionOrOptions 调试会话的选项。当传递父会话debug session时,假定只有这个父会话的选项。
* @return 当调试可以成功启动时解析的thenable。
*/
export function startDebugging(folder: WorkspaceFolder | undefined, nameOrConfiguration: string | DebugConfiguration, parentSessionOrOptions?: DebugSession | DebugSessionOptions): Thenable<boolean>;
/**
* 停止给定的调试会话,或者如果忽略了会话,停止所有的调试会话。
*
* @param session 停止[ebug session;如果省略,所有会话将停止。
*/
export function stopDebugging(session?: DebugSession): Thenable<void>;
/**
* 添加断点。
*
* @param breakpoints 要添加的断点。
*/
export function addBreakpoints(breakpoints: Breakpoint[]): void;
/**
* 删除断点。
*
* @param breakpoints 要删除的断点。
*
*/
export function removeBreakpoints(breakpoints: Breakpoint[]): void;
/**
* 将调试适配器协议接收到的“源”描述符对象转换为可用于加载其内容的Uri。
* 如果源描述符基于路径,则返回一个文件Uri。
* 如果源描述符使用一个引用号,就会构造一个特定的调试Uri (scheme 'debug'),它需要一个对应的VS Code内容提供者和一个运行的调试会话
*
* 如果“源”描述符没有足够的信息来创建Uri,则抛出一个错误。
*
* @param source 一个符合调试适配器协议中定义的源类型的对象。
* @param session 一个可选的调试会话,当源描述符使用引用号从活动调试会话加载内容时将使用该会话。
* @return 可用于加载源文件内容的uri。
*/
export function asDebugSourceUri(source: DebugProtocolSource, session?: DebugSession): Uri;
}
vscode.debug API
最新推荐文章于 2024-04-30 14:54:05 发布