Skip to content

Annotate many capability classes for CF #1001

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.

Sign up for GitHub

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

Merged
DavyLandman merged 3 commits into from
Mar 2, 2026
Merged

Annotate many capability classes for CF #1001

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b7cfbd0
Annotate many capability classes for CF.
toinehartman Mar 2, 2026
723a05d
Rename, rewrite and document utility class.
toinehartman Mar 2, 2026
46b53e2
Hide implicit constructor.
toinehartman Mar 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
344 changes: 344 additions & 0 deletions rascal-lsp/src/main/checkerframework/lsp4j.astub
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,3 +107,347 @@ public class CallHierarchyItem {
public void setDetail(@Nullable final String detail) { }
public void setData(@Nullable final Object data) { }
}


package org.eclipse.lsp4j;
Copy link
Copy Markdown
Member Author

@toinehartman toinehartman Mar 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are not all LSP4J classes related to capabilities, since there are very many. However, this is a good start that I think covers the ones that we're most likely to use (and some more). I think we should make a habit of updating these stubs when we expand to new capabilities.


import org.checkerframework.checker.nullness.qual.*;

public class ClientCapabilities {
public @Nullable WorkspaceClientCapabilities getWorkspace() {}
public @Nullable TextDocumentClientCapabilities getTextDocument() {}
public @Nullable NotebookDocumentClientCapabilities getNotebookDocument() {}
public @Nullable WindowClientCapabilities getWindow() {}
public @Nullable GeneralClientCapabilities getGeneral() {}
public @Nullable Object getExperimental() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class WorkspaceClientCapabilities {
public @Nullable Boolean getApplyEdit() {}
public @Nullable WorkspaceEditCapabilities getWorkspaceEdit() {}
public @Nullable DidChangeConfigurationCapabilities getDidChangeConfiguration() {}
public @Nullable DidChangeWatchedFilesCapabilities getDidChangeWatchedFiles() {}
public @Nullable SymbolCapabilities getSymbol() {}
public @Nullable ExecuteCommandCapabilities getExecuteCommand() {}
public @Nullable Boolean getWorkspaceFolders() {}
public @Nullable Boolean getConfiguration() {}
public @Nullable SemanticTokensWorkspaceCapabilities getSemanticTokens() {}
public @Nullable CodeLensWorkspaceCapabilities getCodeLens() {}
public @Nullable FileOperationsWorkspaceCapabilities getFileOperations() {}
public @Nullable InlayHintWorkspaceCapabilities getInlayHint() {}
public @Nullable InlineValueWorkspaceCapabilities getInlineValue() {}
public @Nullable DiagnosticWorkspaceCapabilities getDiagnostics() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class TextDocumentClientCapabilities {
public @Nullable SynchronizationCapabilities getSynchronization() {}
public @Nullable CompletionCapabilities getCompletion() {}
public @Nullable HoverCapabilities getHover() {}
public @Nullable SignatureHelpCapabilities getSignatureHelp() {}
public @Nullable ReferencesCapabilities getReferences() {}
public @Nullable DocumentHighlightCapabilities getDocumentHighlight() {}
public @Nullable DocumentSymbolCapabilities getDocumentSymbol() {}
public @Nullable FormattingCapabilities getFormatting() {}
public @Nullable RangeFormattingCapabilities getRangeFormatting() {}
public @Nullable OnTypeFormattingCapabilities getOnTypeFormatting() {}
public @Nullable DeclarationCapabilities getDeclaration() {}
public @Nullable DefinitionCapabilities getDefinition() {}
public @Nullable TypeDefinitionCapabilities getTypeDefinition() {}
public @Nullable ImplementationCapabilities getImplementation() {}
public @Nullable CodeActionCapabilities getCodeAction() {}
public @Nullable CodeLensCapabilities getCodeLens() {}
public @Nullable DocumentLinkCapabilities getDocumentLink() {}
public @Nullable ColorProviderCapabilities getColorProvider() {}
public @Nullable RenameCapabilities getRename() {}
public @Nullable PublishDiagnosticsCapabilities getPublishDiagnostics() {}
public @Nullable FoldingRangeCapabilities getFoldingRange() {}
public @Nullable TypeHierarchyCapabilities getTypeHierarchy() {}
public @Nullable CallHierarchyCapabilities getCallHierarchy() {}
public @Nullable SelectionRangeCapabilities getSelectionRange() {}
public @Nullable SemanticTokensCapabilities getSemanticTokens() {}
public @Nullable MonikerCapabilities getMoniker() {}
public @Nullable LinkedEditingRangeCapabilities getLinkedEditingRange() {}
public @Nullable InlayHintCapabilities getInlayHint() {}
public @Nullable InlineValueCapabilities getInlineValue() {}
public @Nullable DiagnosticCapabilities getDiagnostic() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class WindowClientCapabilities {
public @Nullable Boolean getWorkDoneProgress() {}
public @Nullable WindowShowMessageRequestCapabilities getShowMessage() {}
public @Nullable ShowDocumentCapabilities getShowDocument() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class GeneralClientCapabilities {
public @Nullable RegularExpressionsCapabilities getRegularExpressions() {}
public @Nullable MarkdownCapabilities getMarkdown() {}
public @Nullable StaleRequestCapabilities getStaleRequestSupport() {}
public @Nullable List<String> getPositionEncodings() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class WorkspaceEditCapabilities {
public @Nullable Boolean getDocumentChanges() {}
public @Nullable List<String> getResourceOperations() {}
public @Nullable String getFailureHandling() {}
public @Nullable Boolean getNormalizesLineEndings() {}
public @Nullable WorkspaceEditChangeAnnotationSupportCapabilities getChangeAnnotationSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DynamicRegistrationCapabilities {
public @Nullable Boolean getDynamicRegistration() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DidChangeWatchedFilesCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getRelativePatternSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class SymbolCapabilities extends DynamicRegistrationCapabilities {
public @Nullable SymbolKindCapabilities getSymbolKind() {}
public @Nullable SymbolTagSupportCapabilities getTagSupport() {}
public @Nullable WorkspaceSymbolResolveSupportCapabilities getResolveSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class SemanticTokensWorkspaceCapabilities {
public @Nullable Boolean getRefreshSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class CodeLensWorkspaceCapabilities {
public @Nullable Boolean getRefreshSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class FileOperationsWorkspaceCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getDidCreate() {}
public @Nullable Boolean getWillCreate() {}
public @Nullable Boolean getDidRename() {}
public @Nullable Boolean getWillRename() {}
public @Nullable Boolean getDidDelete() {}
public @Nullable Boolean getWillDelete() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class InlayHintWorkspaceCapabilities {
public @Nullable Boolean getRefreshSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class InlineValueWorkspaceCapabilities {
public @Nullable Boolean getRefreshSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DiagnosticWorkspaceCapabilities {
public @Nullable Boolean getRefreshSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class WorkspaceEditChangeAnnotationSupportCapabilities {
public @Nullable Boolean getGroupsOnLabel() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class SynchronizationCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getWillSave() {}
public @Nullable Boolean getWillSaveWaitUntil() {}
public @Nullable Boolean getDidSave() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class CompletionCapabilities extends DynamicRegistrationCapabilities {
public @Nullable CompletionItemCapabilities getCompletionItem() {}
public @Nullable CompletionItemKindCapabilities getCompletionItemKind() {}
public @Nullable Boolean getContextSupport() {}
public @Nullable InsertTextMode getInsertTextMode() {}
public @Nullable CompletionListCapabilities getCompletionList() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class HoverCapabilities extends DynamicRegistrationCapabilities {
public @Nullable List<String> getContentFormat() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class SignatureHelpCapabilities extends DynamicRegistrationCapabilities {
public @Nullable SignatureInformationCapabilities getSignatureInformation() {}
public @Nullable Boolean getContextSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DocumentSymbolCapabilities extends DynamicRegistrationCapabilities {
public @Nullable SymbolKindCapabilities getSymbolKind() {}
public @Nullable Boolean getHierarchicalDocumentSymbolSupport() {}
public @Nullable SymbolTagSupportCapabilities getTagSupport() {}
public @Nullable Boolean getLabelSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DeclarationCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getLinkSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DefinitionCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getLinkSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class TypeDefinitionCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getLinkSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class ImplementationCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getLinkSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class CodeActionCapabilities extends DynamicRegistrationCapabilities {
public @Nullable CodeActionLiteralSupportCapabilities getCodeActionLiteralSupport() {}
public @Nullable Boolean getIsPreferredSupport() {}
public @Nullable Boolean getDisabledSupport() {}
public @Nullable Boolean getDataSupport() {}
public @Nullable CodeActionResolveSupportCapabilities getResolveSupport() {}
public @Nullable Boolean getHonorsChangeAnnotations() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class DocumentLinkCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getTooltipSupport() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class RenameCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getPrepareSupport() {}
public @Nullable PrepareSupportDefaultBehavior getPrepareSupportDefaultBehavior() {}
public @Nullable Boolean getHonorsChangeAnnotations() {}
}


package org.eclipse.lsp4j;

import org.checkerframework.checker.nullness.qual.*;

public class SemanticTokensCapabilities extends DynamicRegistrationCapabilities {
public @Nullable Boolean getOverlappingTokenSupport() {}
public @Nullable Boolean getMultilineTokenSupport() {}
public @Nullable Boolean getServerCancelSupport() {}
public @Nullable Boolean getAugmentsSyntaxTokens() {}
}
6 changes: 3 additions & 3 deletions rascal-lsp/src/main/java/org/rascalmpl/vscode/lsp/BaseWorkspaceService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,14 @@
import org.eclipse.lsp4j.FileDelete;
import org.eclipse.lsp4j.RenameFilesParams;
import org.eclipse.lsp4j.ServerCapabilities;
import org.eclipse.lsp4j.WorkspaceClientCapabilities;
import org.eclipse.lsp4j.WorkspaceFolder;
import org.eclipse.lsp4j.WorkspaceFoldersOptions;
import org.eclipse.lsp4j.WorkspaceServerCapabilities;
import org.eclipse.lsp4j.services.LanguageClient;
import org.eclipse.lsp4j.services.LanguageClientAware;
import org.eclipse.lsp4j.services.WorkspaceService;
import org.rascalmpl.vscode.lsp.util.Nullables;
import org.rascalmpl.vscode.lsp.util.concurrent.CompletableFutureUtils;
import org.rascalmpl.vscode.lsp.util.locations.Locations;

Expand Down Expand Up @@ -82,14 +84,12 @@ public void initialize(ClientCapabilities clientCap, @Nullable List<WorkspaceFol
this.workspaceFolders.addAll(currentWorkspaceFolders);
}

var clientWorkspaceCap = clientCap.getWorkspace();

if (capabilities.getWorkspace() == null) {
capabilities.setWorkspace(new WorkspaceServerCapabilities());
}

var workspaceCapabilities = capabilities.getWorkspace();
if (clientWorkspaceCap != null && clientWorkspaceCap.getWorkspaceFolders().booleanValue()) {
if (Nullables.has(clientCap.getWorkspace(), WorkspaceClientCapabilities::getWorkspaceFolders)) {
var folderOptions = new WorkspaceFoldersOptions();
folderOptions.setSupported(true);
folderOptions.setChangeNotifications(true);
Expand Down
Loading
Loading