@theia/plugin 1.29.0-next.4 → 1.29.0-next.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.29.0-next.4+0c0f8c7a7ae",
+  "version": "1.29.0-next.9+7b29ac6f2d1",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "0c0f8c7a7aedd67930bf65d6f63d827721707d60"
+  "gitHead": "7b29ac6f2d1a75b44b5c5d37ec7ae0200e0c3e99"
 }

package/src/theia.d.ts

@@ -3469,6 +3469,13 @@ export module '@theia/plugin' {
      */
     export interface Memento {
 
+        /**
+         * Returns the stored keys.
+         *
+         * @return The stored keys.
+         */
+        keys(): readonly string[];
+
         /**
          * Return a value.
          *
@@ -5640,12 +5647,14 @@ export module '@theia/plugin' {
          * Returns `true` if the given section for the given resource (if provided) is affected.
          *
          * @param section Configuration name, supports _dotted_ names.
-         * @param resource A resource Uri.
+         * @param scope a {@link ConfigurationScope}
          * @return `true` if the given section for the given resource (if provided) is affected.
          */
-        affectsConfiguration(section: string, resource?: Uri): boolean;
+        affectsConfiguration(section: string, scope?: ConfigurationScope): boolean;
     }
 
+    export type ConfigurationScope = Uri | WorkspaceFolder | TextDocument | { uri?: Uri, languageId: string };
+
     /**
      * An event describing a change to the set of [workspace folders](#workspace.workspaceFolders).
      */
@@ -6300,13 +6309,13 @@ export module '@theia/plugin' {
          * is returned. Dots in the section-identifier are interpreted as child-access,
          * like `{ myExt: { setting: { doIt: true }}}` and `getConfiguration('myExt.setting').get('doIt') === true`.
          *
-         * When a resource is provided, configuration scoped to that resource is returned.
+         * When a scope is provided configuration confined to that scope is returned. Scope can be a resource or a language identifier or both.
          *
          * @param section A dot-separated identifier.
-         * @param resource A resource for which the configuration is asked for
+         * @param scope A scope for which the configuration is asked for.
          * @return The full configuration or a subset.
          */
-        export function getConfiguration(section?: string, resource?: Uri | null): WorkspaceConfiguration;
+        export function getConfiguration(section?: string, scope?: ConfigurationScope | null): WorkspaceConfiguration;
 
         /**
          * An event that is emitted when the [configuration](#WorkspaceConfiguration) changed.
@@ -9267,6 +9276,18 @@ export module '@theia/plugin' {
          */
         export function registerHoverProvider(selector: DocumentSelector, provider: HoverProvider): Disposable;
 
+        /**
+         * Register a provider that locates evaluatable expressions in text documents.
+         * The editor will evaluate the expression in the active debug session and will show the result in the debug hover.
+         *
+         * If multiple providers are registered for a language an arbitrary provider will be used.
+         *
+         * @param selector A selector that defines the documents this provider is applicable to.
+         * @param provider An evaluatable expression provider.
+         * @return A {@link Disposable} that unregisters this provider when being disposed.
+         */
+        export function registerEvaluatableExpressionProvider(selector: DocumentSelector, provider: EvaluatableExpressionProvider): Disposable;
+
         /**
          * Register a workspace symbol provider.
          *
@@ -9580,6 +9601,54 @@ export module '@theia/plugin' {
         provideHover(document: TextDocument, position: Position, token: CancellationToken | undefined): ProviderResult<Hover>;
     }
 
+    /**
+     * An EvaluatableExpression represents an expression in a document that can be evaluated by an active debugger or runtime.
+     * The result of this evaluation is shown in a tooltip-like widget.
+     * If only a range is specified, the expression will be extracted from the underlying document.
+     * An optional expression can be used to override the extracted expression.
+     * In this case the range is still used to highlight the range in the document.
+     */
+    export class EvaluatableExpression {
+
+        /*
+         * The range is used to extract the evaluatable expression from the underlying document and to highlight it.
+         */
+        readonly range: Range;
+
+        /*
+         * If specified the expression overrides the extracted expression.
+         */
+        readonly expression?: string | undefined;
+
+        /**
+         * Creates a new evaluatable expression object.
+         *
+         * @param range The range in the underlying document from which the evaluatable expression is extracted.
+         * @param expression If specified overrides the extracted expression.
+         */
+        constructor(range: Range, expression?: string);
+    }
+
+    /**
+     * The evaluatable expression provider interface defines the contract between extensions and
+     * the debug hover. In this contract the provider returns an evaluatable expression for a given position
+     * in a document and the editor evaluates this expression in the active debug session and shows the result in a debug hover.
+     */
+    export interface EvaluatableExpressionProvider {
+        /**
+         * Provide an evaluatable expression for the given document and position.
+         * The editor will evaluate this expression in the active debug session and will show the result in the debug hover.
+         * The expression can be implicitly specified by the range in the underlying document or by explicitly returning an expression.
+         *
+         * @param document The document for which the debug hover is about to appear.
+         * @param position The line and character position in the document where the debug hover is about to appear.
+         * @param token A cancellation token.
+         * @return An EvaluatableExpression or a thenable that resolves to such. The lack of a result can be
+         * signaled by returning `undefined` or `null`.
+         */
+        provideEvaluatableExpression(document: TextDocument, position: Position, token: CancellationToken | undefined): ProviderResult<EvaluatableExpression>;
+    }
+
     /**
      * A document highlight kind.
      */