-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Stub implementation of proposed API for multiDocumentHighlightProvider. #13248
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
packages/plugin/src/theia.proposed.multiDocumentHighlightProvider.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
// ***************************************************************************** | ||
// Copyright (C) 2023 STMicroelectronics and others. | ||
// | ||
// This program and the accompanying materials are made available under the | ||
// terms of the Eclipse Public License v. 2.0 which is available at | ||
// http://www.eclipse.org/legal/epl-2.0. | ||
// | ||
// This Source Code may also be made available under the following Secondary | ||
// Licenses when the conditions for such availability set forth in the Eclipse | ||
// Public License v. 2.0 are satisfied: GNU General Public License, version 2 | ||
// with the GNU Classpath Exception which is available at | ||
// https://www.gnu.org/software/classpath/license.html. | ||
// | ||
// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0 | ||
// ***************************************************************************** | ||
|
||
/*--------------------------------------------------------------------------------------------- | ||
* Copyright (c) Microsoft Corporation. All rights reserved. | ||
* Licensed under the MIT License. See License.txt in the project root for license information. | ||
*--------------------------------------------------------------------------------------------*/ | ||
// code copied and modified from https://github.com/microsoft/vscode/blob/1.85.1/src/vscode-dts/vscode.proposed.multiDocumentHighlightProvider.d.ts | ||
|
||
declare module '@theia/plugin' { | ||
|
||
/** | ||
* Represents a collection of document highlights from multiple documents. | ||
*/ | ||
export class MultiDocumentHighlight { | ||
|
||
/** | ||
* The URI of the document containing the highlights. | ||
*/ | ||
uri: Uri; | ||
|
||
/** | ||
* The highlights for the document. | ||
*/ | ||
highlights: DocumentHighlight[]; | ||
|
||
/** | ||
* Creates a new instance of MultiDocumentHighlight. | ||
* @param uri The URI of the document containing the highlights. | ||
* @param highlights The highlights for the document. | ||
*/ | ||
constructor(uri: Uri, highlights: DocumentHighlight[]); | ||
} | ||
|
||
export interface MultiDocumentHighlightProvider { | ||
|
||
/** | ||
* Provide a set of document highlights, like all occurrences of a variable or | ||
* all exit-points of a function. | ||
* | ||
* @param document The document in which the command was invoked. | ||
* @param position The position at which the command was invoked. | ||
* @param otherDocuments An array of additional valid documents for which highlights should be provided. | ||
* @param token A cancellation token. | ||
* @returns A Map containing a mapping of the Uri of a document to the document highlights or a thenable that resolves to such. The lack of a result can be | ||
* signaled by returning `undefined`, `null`, or an empty map. | ||
*/ | ||
provideMultiDocumentHighlights(document: TextDocument, position: Position, otherDocuments: TextDocument[], token: CancellationToken): | ||
ProviderResult<MultiDocumentHighlight[]>; | ||
} | ||
|
||
namespace languages { | ||
|
||
/** | ||
* Register a multi document highlight provider. | ||
* | ||
* Multiple providers can be registered for a language. In that case providers are sorted | ||
* by their {@link languages.match score} and groups sequentially asked for document highlights. | ||
* The process stops when a provider returns a `non-falsy` or `non-failure` result. | ||
* | ||
* @param selector A selector that defines the documents this provider is applicable to. | ||
* @param provider A multi-document highlight provider. | ||
* @returns A {@link Disposable} that unregisters this provider when being disposed. | ||
* @stubbed | ||
*/ | ||
export function registerMultiDocumentHighlightProvider(selector: DocumentSelector, provider: MultiDocumentHighlightProvider): Disposable; | ||
} | ||
|
||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we want to make this work in the future, we should mark it with
@monaco-uplift
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this annotation here:
theia/packages/plugin/src/theia.proposed.multiDocumentHighlightProvider.ts
Line 77 in d692875
Should I also add it to this doc?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I try to do as few changes to the api.d.ts files we take from VS Code because it makes it easier to maintain them, IMO (diff, etc.). Unless this is a general convention, I would prefer the
@monaco-uplift
annotatio where we put the stub implementation.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for explanation, @tsmaeder.
I have rebased and updated my changes, as this is a trivial fix and there was the usual conflict with the changelog. The monaco uplift annotation has been moved to plugin-context file.