/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/
import { CancellationToken } from "../../../base/common/cancellation.mjs";
import { IDisposable } from "../../../base/common/lifecycle.mjs";
import { ItemActivation } from "../../../base/parts/quickinput/common/quickInput.mjs";
import { IQuickNavigateConfiguration, IQuickPick, IQuickPickItem } from "./quickInput.mjs";
/**
 * Provider specific options for this particular showing of the
 * quick access.
 */
export interface IQuickAccessProviderRunOptions {
}
/**
 * The specific options for the AnythingQuickAccessProvider. Put here to share between layers.
 */
export interface AnythingQuickAccessProviderRunOptions extends IQuickAccessProviderRunOptions {
    includeHelp?: boolean;
}
export interface IQuickAccessOptions {
    /**
     * Allows to enable quick navigate support in quick input.
     */
    quickNavigateConfiguration?: IQuickNavigateConfiguration;
    /**
     * Allows to configure a different item activation strategy.
     * By default the first item in the list will get activated.
     */
    itemActivation?: ItemActivation;
    /**
     * Whether to take the input value as is and not restore it
     * from any existing value if quick access is visible.
     */
    preserveValue?: boolean;
    /**
     * Provider specific options for this particular showing of the
     * quick access.
     */
    providerOptions?: IQuickAccessProviderRunOptions;
}
export interface IQuickAccessController {
    /**
     * Open the quick access picker with the optional value prefilled.
     */
    show(value?: string, options?: IQuickAccessOptions): void;
    /**
     * Same as `show()` but instead of executing the selected pick item,
     * it will be returned. May return `undefined` in case no item was
     * picked by the user.
     */
    pick(value?: string, options?: IQuickAccessOptions): Promise<IQuickPickItem[] | undefined>;
}
export declare enum DefaultQuickAccessFilterValue {
    /**
     * Keep the value as it is given to quick access.
     */
    PRESERVE = 0,
    /**
     * Use the value that was used last time something was accepted from the picker.
     */
    LAST = 1
}
export interface IQuickAccessProvider {
    /**
     * Allows to set a default filter value when the provider opens. This can be:
     * - `undefined` to not specify any default value
     * - `DefaultFilterValues.PRESERVE` to use the value that was last typed
     * - `string` for the actual value to use
     *
     * Note: the default filter will only be used if quick access was opened with
     * the exact prefix of the provider. Otherwise the filter value is preserved.
     */
    readonly defaultFilterValue?: string | DefaultQuickAccessFilterValue;
    /**
     * Called whenever a prefix was typed into quick pick that matches the provider.
     *
     * @param picker the picker to use for showing provider results. The picker is
     * automatically shown after the method returns, no need to call `show()`.
     * @param token providers have to check the cancellation token everytime after
     * a long running operation or from event handlers because it could be that the
     * picker has been closed or changed meanwhile. The token can be used to find out
     * that the picker was closed without picking an entry (e.g. was canceled by the user).
     * @param options additional configuration specific for this provider that will
     * influence what picks will be shown.
     * @return a disposable that will automatically be disposed when the picker
     * closes or is replaced by another picker.
     */
    provide(picker: IQuickPick<IQuickPickItem>, token: CancellationToken, options?: IQuickAccessProviderRunOptions): IDisposable;
}
export interface IQuickAccessProviderHelp {
    /**
     * The prefix to show for the help entry. If not provided,
     * the prefix used for registration will be taken.
     */
    prefix?: string;
    /**
     * A description text to help understand the intent of the provider.
     */
    description: string;
    /**
     * The command to bring up this quick access provider.
     */
    readonly commandId?: string;
}
export interface IQuickAccessProviderDescriptor {
    /**
     * The actual provider that will be instantiated as needed.
     */
    readonly ctor: {
        new (...services: any[]): IQuickAccessProvider;
    };
    /**
     * The prefix for quick access picker to use the provider for.
     */
    readonly prefix: string;
    /**
     * A placeholder to use for the input field when the provider is active.
     * This will also be read out by screen readers and thus helps for
     * accessibility.
     */
    readonly placeholder?: string;
    /**
     * Documentation for the provider in the quick access help.
     */
    readonly helpEntries: IQuickAccessProviderHelp[];
    /**
     * A context key that will be set automatically when the
     * picker for the provider is showing.
     */
    readonly contextKey?: string;
}
export declare const Extensions: {
    Quickaccess: string;
};
export interface IQuickAccessRegistry {
    /**
     * Registers a quick access provider to the platform.
     */
    registerQuickAccessProvider(provider: IQuickAccessProviderDescriptor): IDisposable;
    /**
     * Get all registered quick access providers.
     */
    getQuickAccessProviders(): IQuickAccessProviderDescriptor[];
    /**
     * Get a specific quick access provider for a given prefix.
     */
    getQuickAccessProvider(prefix: string): IQuickAccessProviderDescriptor | undefined;
}
export declare class QuickAccessRegistry implements IQuickAccessRegistry {
    private providers;
    private defaultProvider;
    registerQuickAccessProvider(provider: IQuickAccessProviderDescriptor): IDisposable;
    getQuickAccessProviders(): IQuickAccessProviderDescriptor[];
    getQuickAccessProvider(prefix: string): IQuickAccessProviderDescriptor | undefined;
    clear(): Function;
}