();
for (URI uri : connectedDocuments.keySet()) {
IFile[] foundFiles = ResourcesPlugin.getWorkspace().getRoot()
@@ -777,15 +776,13 @@ protected LanguageServer getServer() {
* notifications are sent).
* If done in the UI thread, a job will be created
* displaying that the server is being initialized
- *
*/
- @NonNull
protected CompletableFuture getInitializedServer() {
start();
final CompletableFuture currentInitializeFuture = initializeFuture;
if (currentInitializeFuture != null && !currentInitializeFuture.isDone()) {
- return currentInitializeFuture.thenApply(r -> this.languageServer);
+ return currentInitializeFuture.thenApply(r -> castNonNull(this.languageServer));
}
return CompletableFuture.completedFuture(this.languageServer);
}
@@ -795,7 +792,7 @@ protected CompletableFuture getInitializedServer() {
*
* @param fn LS notification to send
*/
- public void sendNotification(@NonNull Consumer fn) {
+ public void sendNotification(Consumer fn) {
// Enqueues a notification on the dispatch thread associated with the wrapped language server. This
// ensures the interleaving of document updates and other requests in the UI is mirrored in the
// order in which they get dispatched to the server
@@ -820,7 +817,7 @@ public void sendNotification(@NonNull Consumer fn) {
*
* @return Async result
*/
- public CompletableFuture execute(@NonNull Function> fn) {
+ public <@Nullable T> CompletableFuture execute(Function> fn) {
// Send the request on the dispatch thread
CompletableFuture lsRequest = executeImpl(fn);
// then additionally make sure the response is delivered on a thread from the default ForkJoinPool.
@@ -834,7 +831,7 @@ public CompletableFuture execute(@NonNull Function CompletableFuture execute(@NonNull Function
* @return Async result
*/
- @NonNull
- CompletableFuture executeImpl(@NonNull Function> fn) {
+ <@Nullable T> CompletableFuture executeImpl(Function> fn) {
// Run the supplied function, ensuring that it is enqueued on the dispatch thread associated with the
- // wrapped language server, and is thus guarannteed to be seen in the correct order with respect
+ // wrapped language server, and is thus guaranteed to be seen in the correct order with respect
// to e.g. previous document changes
//
// Note this doesn't get the .thenApplyAsync(Function.identity()) chained on additionally, unlike
// the public-facing version of this method, because we trust the LSPExecutor implementations to
// make sure the server response thread doesn't get blocked by any further work
- AtomicReference> request = new AtomicReference<>();
+ AtomicReference<@Nullable CompletableFuture> request = new AtomicReference<>();
Function> cancelWrapper = ls -> {
CompletableFuture res = fn.apply(ls);
request.set(res);
@@ -890,7 +886,7 @@ CompletableFuture executeImpl(@NonNull Function {
switch (reg.getMethod()) {
case "workspace/didChangeWorkspaceFolders": //$NON-NLS-1$
- Assert.isNotNull(serverCapabilities,
- "Dynamic capability registration failed! Server not yet initialized?"); //$NON-NLS-1$
if (initiallySupportsWorkspaceFolders) {
// Can treat this as a NOP since nothing can disable it dynamically if it was
// enabled on initialization.
@@ -941,8 +938,8 @@ void registerCapability(RegistrationParams params) {
break;
case "workspace/executeCommand": //$NON-NLS-1$
final var gson = new Gson(); // TODO? retrieve the GSon used by LS
- ExecuteCommandOptions executeCommandOptions = gson.fromJson((JsonObject) reg.getRegisterOptions(),
- ExecuteCommandOptions.class);
+ ExecuteCommandOptions executeCommandOptions = castNonNull(gson.fromJson((JsonObject) reg.getRegisterOptions(),
+ ExecuteCommandOptions.class));
List newCommands = executeCommandOptions.getCommands();
if (!newCommands.isEmpty()) {
addRegistration(reg, () -> unregisterCommands(newCommands));
@@ -1002,7 +999,7 @@ void registerCapability(RegistrationParams params) {
}});
}
- private void addRegistration(@NonNull Registration reg, @NonNull Runnable unregistrationHandler) {
+ private void addRegistration(Registration reg, Runnable unregistrationHandler) {
String regId = reg.getId();
synchronized (dynamicRegistrations) {
Assert.isLegal(!dynamicRegistrations.containsKey(regId), "Registration id is not unique"); //$NON-NLS-1$
@@ -1014,8 +1011,9 @@ synchronized void setWorkspaceFoldersEnablement(boolean enable) {
if (enable == supportsWorkspaceFolderCapability()) {
return;
}
+ var serverCapabilities = this.serverCapabilities;
if (serverCapabilities == null) {
- this.serverCapabilities = new ServerCapabilities();
+ serverCapabilities = this.serverCapabilities = new ServerCapabilities();
}
WorkspaceServerCapabilities workspace = serverCapabilities.getWorkspace();
if (workspace == null) {
@@ -1212,7 +1210,7 @@ private boolean isProjectOpenCloseEvent(IResourceDelta delta) {
*
* @return True if this workspace folder is non-null and has non-empty content
*/
- private boolean isValid(WorkspaceFolder wsFolder) {
+ private boolean isValid(@Nullable WorkspaceFolder wsFolder) {
return wsFolder != null && wsFolder.getUri() != null && !wsFolder.getUri().isEmpty();
}
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServers.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServers.java
index 37a3807f9..b8cef079e 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServers.java
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServers.java
@@ -12,6 +12,8 @@
*******************************************************************************/
package org.eclipse.lsp4e;
+import static org.eclipse.lsp4e.internal.NullSafetyHelper.castNonNull;
+
import java.io.IOException;
import java.util.ArrayList;
import java.util.Collection;
@@ -30,7 +32,7 @@
import org.eclipse.core.resources.IProject;
import org.eclipse.core.runtime.Assert;
-import org.eclipse.jdt.annotation.NonNull;
+import org.eclipse.jdt.annotation.NonNullByDefault;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.jface.text.IDocument;
import org.eclipse.lsp4e.LanguageServersRegistry.LanguageServerDefinition;
@@ -44,6 +46,7 @@
*/
public abstract class LanguageServers> {
+ @SuppressWarnings("null")
private static void forwardCancellation(CompletableFuture from, CompletableFuture... to) {
from.exceptionally(t -> {
if (t instanceof CancellationException) {
@@ -53,7 +56,7 @@ private static void forwardCancellation(CompletableFuture from, CompletableFu
});
}
- /** creates a future that is running on het common async pool, ensuring it's not blocking UI Thread */
+ /** creates a future that is running on the common async pool, ensuring it's not blocking UI Thread */
private static CompletableFuture onCommonPool(CompletableFuture source) {
CompletableFuture res = source.thenApplyAsync(Function.identity());
forwardCancellation(res, source);
@@ -70,8 +73,7 @@ private static CompletableFuture onCommonPool(CompletableFuture source
*
* @return Async result
*/
- @NonNull
- public CompletableFuture<@NonNull List<@NonNull T>> collectAll(Function> fn) {
+ public CompletableFuture> collectAll(Function> fn) {
return collectAll((w, ls) -> fn.apply(ls));
}
@@ -87,9 +89,8 @@ private static CompletableFuture onCommonPool(CompletableFuture source
*
* @return Async result
*/
- @NonNull
- public CompletableFuture<@NonNull List<@NonNull T>> collectAll(BiFunction> fn) {
- final CompletableFuture<@NonNull List> init = CompletableFuture.completedFuture(new ArrayList());
+ public CompletableFuture> collectAll(BiFunction> fn) {
+ final CompletableFuture> init = CompletableFuture.completedFuture(new ArrayList());
return onCommonPool(executeOnServers(fn).reduce(init, LanguageServers::add, LanguageServers::addAll));
}
@@ -104,8 +105,7 @@ private static CompletableFuture onCommonPool(CompletableFuture source
*
* @return A list of pending results (note that these may be null or empty)
*/
- @NonNull
- public List<@NonNull CompletableFuture<@Nullable T>> computeAll(Function> fn) {
+ public List> computeAll(Function> fn) {
return computeAll((w, ls) -> fn.apply(ls));
}
@@ -122,8 +122,7 @@ private static CompletableFuture onCommonPool(CompletableFuture source
*
* @return A list of pending results (note that these may be null or empty)
*/
- @NonNull
- public List<@NonNull CompletableFuture<@Nullable T>> computeAll(BiFunction> fn) {
+ public List> computeAll(BiFunction> fn) {
return getServers().stream().map(serverFuture -> {
CompletableFuture> requestFuture = serverFuture
.thenApply(w -> w == null ? CompletableFuture.completedFuture(null) : w.executeImpl(ls -> fn.apply(w, ls)));
@@ -144,7 +143,7 @@ private static CompletableFuture onCommonPool(CompletableFuture source
* @return An asynchronous result that will complete with a populated Optional<T> from the first
* non-empty response, and with an empty Optional if none of the servers returned a non-empty result.
*/
- public CompletableFuture> computeFirst(Function> queryLS) {
+ public CompletableFuture> computeFirst(Function> queryLS) {
return computeFirst((w, ls) -> queryLS.apply(ls));
}
@@ -161,7 +160,7 @@ public CompletableFuture> computeFirst(FunctionOptional<T> from the first
* non-empty response, and with an empty Optional if none of the servers returned a non-empty result.
*/
- public CompletableFuture> computeFirst(BiFunction> queryLS) {
+ public CompletableFuture> computeFirst(BiFunction> queryLS) {
final CompletableFuture> result = new CompletableFuture<>();
// Dispatch the request to the servers, appending a step to each such that
@@ -172,7 +171,8 @@ public CompletableFuture> computeFirst(BiFunction {
CompletableFuture populateFuture = lsRequest.thenApply(t -> {
- if (!isEmpty(t)) { // some LS methods return null objects when they have nothing to report, and some return an empty List
+ // some LS methods return null objects when they have nothing to report, and some return an empty List
+ if (t != null && !isEmptyCollection(t)) {
result.complete(Optional.of(t));
}
return t;
@@ -185,43 +185,44 @@ public CompletableFuture> computeFirst(BiFunction filter) {
+ @SuppressWarnings("unchecked")
+ public E withFilter(final Predicate filter) {
Assert.isLegal(this.filter == NO_FILTER);
this.filter = filter;
- return (E)this;
+ return (E) this;
}
/**
* Specifies the capabilities that a server must have to process this request
* @param serverCapabilities
- * @return
*/
- public @NonNull E withCapability(final @NonNull Function> serverCapabilities) {
+ @SuppressWarnings("unchecked")
+ public E withCapability(final Function> serverCapabilities) {
Assert.isLegal(this.filter == NO_FILTER);
this.filter = f -> LSPEclipseUtils.hasCapability(serverCapabilities.apply(f));
- return (E)this;
+ return (E) this;
}
/**
*
* @return Predicate that will be used to determine which servers this executor will use
*/
- public @NonNull Predicate getFilter() {
+ public Predicate getFilter() {
return this.filter;
}
- protected Boolean matches(@NonNull CompletableFuture<@Nullable LanguageServerWrapper> wrapperFuture) {
+ protected Boolean matches(CompletableFuture<@Nullable LanguageServerWrapper> wrapperFuture) {
try {
return wrapperFuture.thenApply(Objects::nonNull).get(50, TimeUnit.MILLISECONDS);
} catch (java.util.concurrent.ExecutionException e) {
@@ -253,20 +254,21 @@ public boolean anyMatching() {
@SuppressWarnings("null")
public static class LanguageServerDocumentExecutor extends LanguageServers {
- private final @NonNull IDocument document;
+ private final IDocument document;
- protected LanguageServerDocumentExecutor(final @NonNull IDocument document) {
+ protected LanguageServerDocumentExecutor(final IDocument document) {
this.document = document;
}
- public @NonNull IDocument getDocument() {
+ public IDocument getDocument() {
return this.document;
}
- @NonNull CompletableFuture<@Nullable LanguageServerWrapper> connect(@NonNull CompletableFuture<@Nullable LanguageServerWrapper> wrapperFuture) {
+ CompletableFuture<@Nullable LanguageServerWrapper> connect(CompletableFuture<@Nullable LanguageServerWrapper> wrapperFuture) {
return wrapperFuture.thenCompose(wrapper -> {
if (wrapper != null) {
try {
+ @NonNullByDefault({})
CompletableFuture serverFuture = wrapper.connectDocument(document);
if (serverFuture != null) {
return serverFuture;
@@ -283,15 +285,15 @@ protected LanguageServerDocumentExecutor(final @NonNull IDocument document) {
/**
* Test whether this server supports the requested ServerCapabilities.
*/
- private @NonNull CompletableFuture<@Nullable LanguageServerWrapper> filter(@NonNull LanguageServerWrapper wrapper) {
+ private CompletableFuture<@Nullable LanguageServerWrapper> filter(LanguageServerWrapper wrapper) {
return wrapper.getInitializedServer()
.thenCompose(server -> CompletableFuture
- .completedFuture(server != null && getFilter().test(wrapper.getServerCapabilities())))
+ .completedFuture(server != null && getFilter().test(castNonNull(wrapper.getServerCapabilities()))))
.thenApply(matches -> matches ? wrapper: null);
}
@Override
- protected @NonNull List<@NonNull CompletableFuture<@Nullable LanguageServerWrapper>> getServers() {
+ protected List> getServers() {
// Compute list of servers from document & filter
Collection wrappers = LanguageServiceAccessor.getLSWrappers(document);
return order(wrappers).stream().map(this::filter).map(this::connect).toList();
@@ -327,18 +329,17 @@ public static class LanguageServerProjectExecutor extends LanguageServers> getServers() {
+ protected List> getServers() {
// Compute list of servers from project & filter
- Collection<@NonNull LanguageServerWrapper> startedWrappers = order(LanguageServiceAccessor.getStartedWrappers(project, getFilter(), !restartStopped));
- List<@NonNull CompletableFuture> wrappers = new ArrayList<>(startedWrappers.size());
+ Collection startedWrappers = order(LanguageServiceAccessor.getStartedWrappers(project, getFilter(), !restartStopped));
+ List> wrappers = new ArrayList<>(startedWrappers.size());
for (LanguageServerWrapper wrapper : startedWrappers) {
wrappers.add(wrapper.getInitializedServer().thenApply(ls -> wrapper));
}
@@ -346,8 +347,8 @@ public static class LanguageServerProjectExecutor extends LanguageServers boolean isEmpty(final T t) {
- return t == null || (t instanceof Collection c && c.isEmpty());
+ private static boolean isEmptyCollection(final Object obj) {
+ return (obj instanceof Collection c && c.isEmpty());
}
protected Collection order(Collection wrappers) {
@@ -355,18 +356,18 @@ protected Collection order(Collection temp = new ArrayList<>(wrappers);
for (int i = 0; i < temp.size(); i++) {
LanguageServerWrapper wrapper = temp.get(i);
- if (wrapper != null && wrapper.serverDefinition != null && Objects.equals(serverDefinition, wrapper.serverDefinition)) {
+ if (Objects.equals(serverDefinition, wrapper.serverDefinition)) {
Collections.swap(temp, 0, i);
return temp;
}
- };
+ }
}
return wrappers;
}
- // Pluggable strategy for getting the set of LSWrappers to dispatch operations on
- protected abstract @NonNull List<@NonNull CompletableFuture<@Nullable LanguageServerWrapper>> getServers();
+ /** Pluggable strategy for getting the set of LSWrappers to dispatch operations on */
+ protected abstract List> getServers();
/**
* Hook called when requests are scheduled - for subclasses to implement optimistic locking
@@ -381,7 +382,6 @@ protected void computeVersion() {}
* @param col
* @return A stream (empty if col is null)
*/
- @NonNull
public static Stream streamSafely(@Nullable Collection col) {
return col == null ? Stream.of() : col.stream();
}
@@ -392,12 +392,9 @@ public static Stream streamSafely(@Nullable Collection col) {
* @param Result type
* @param accumulator One async result
* @param element Another async result
- * @return
*/
- @SuppressWarnings("null")
- @NonNull
- private static CompletableFuture<@NonNull List<@NonNull T>> add(@NonNull CompletableFuture> accumulator, @NonNull CompletableFuture<@Nullable T> element) {
- CompletableFuture<@NonNull List<@NonNull T>> res = accumulator.thenCombine(element, (a, b) -> {
+ private static CompletableFuture> add(CompletableFuture> accumulator, CompletableFuture<@Nullable T> element) {
+ CompletableFuture> res = accumulator.thenCombine(element, (a, b) -> {
if (b != null) {
a.add(b);
}
@@ -414,10 +411,8 @@ public static Stream streamSafely(@Nullable Collection col) {
* @param another Another async result
* @return Async combined result
*/
- @SuppressWarnings("null")
- @NonNull
- public static CompletableFuture<@NonNull List> addAll(@NonNull CompletableFuture<@NonNull List> accumulator, @NonNull CompletableFuture<@NonNull List> another) {
- CompletableFuture<@NonNull List> res = accumulator.thenCombine(another, (a, b) -> {
+ public static CompletableFuture> addAll(CompletableFuture> accumulator, CompletableFuture> another) {
+ CompletableFuture> res = accumulator.thenCombine(another, (a, b) -> {
a.addAll(b);
return a;
});
@@ -431,13 +426,12 @@ public static Stream streamSafely(@Nullable Collection col) {
* (not chained with other futures) so cancelling the futures in
* this stream will send a cancellation event to the LSs.
*/
- @NonNull
private Stream> executeOnServers(
BiFunction> fn) {
return getServers().stream().map(serverFuture -> {
// wrap in AtomicReference to allow dereferencing in downstream future
CompletableFuture> lsRequestFuture = serverFuture.thenApply(w -> w == null
- ? CompletableFuture.completedFuture((T) null)
+ ? CompletableFuture.completedFuture(null)
: w.executeImpl(ls -> fn.apply(w, ls)));
CompletableFuture res = lsRequestFuture.thenCompose(Function.identity());
lsRequestFuture.thenAccept(request -> forwardCancellation(res, request));
@@ -450,7 +444,7 @@ private Stream> executeOnServers(
* then we give up and supply an empty result rather than potentially waiting
* forever...
*/
- private void completeEmptyOrWithException(final CompletableFuture> completableFuture, final Throwable t) {
+ private void completeEmptyOrWithException(final CompletableFuture> completableFuture, final @Nullable Throwable t) {
if (t != null) {
completableFuture.completeExceptionally(t);
} else {
@@ -463,7 +457,7 @@ private void completeEmptyOrWithException(final CompletableFuture void completeEmptyOrWithException(final CompletableFuture NO_FILTER = s -> true;
- private @NonNull Predicate filter = NO_FILTER;
+ private static final Predicate NO_FILTER = s -> true;
+ private Predicate filter = NO_FILTER;
protected @Nullable LanguageServerDefinition serverDefinition;
}
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServersRegistry.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServersRegistry.java
index 9905741f1..9957eea63 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServersRegistry.java
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServersRegistry.java
@@ -36,7 +36,6 @@
import org.eclipse.core.runtime.Status;
import org.eclipse.core.runtime.content.IContentType;
import org.eclipse.debug.core.ILaunchConfiguration;
-import org.eclipse.jdt.annotation.NonNull;
import org.eclipse.jdt.annotation.Nullable;
import org.eclipse.jface.preference.IPersistentPreferenceStore;
import org.eclipse.jface.preference.IPreferenceStore;
@@ -89,13 +88,13 @@ public class LanguageServersRegistry {
private static final String ENABLED_WHEN_DESC = "description"; //$NON-NLS-1$
public abstract static class LanguageServerDefinition {
- public final @NonNull String id;
- public final @NonNull String label;
+ public final String id;
+ public final String label;
public final boolean isSingleton;
public final int lastDocumentDisconnectedTimeout;
- public final @NonNull Map languageIdMappings;
+ public final Map languageIdMappings;
- LanguageServerDefinition(@NonNull String id, @NonNull String label, boolean isSingleton, int lastDocumentDisconnectedTimeout) {
+ LanguageServerDefinition(String id, String label, boolean isSingleton, int lastDocumentDisconnectedTimeout) {
this.id = id;
this.label = label;
this.isSingleton = isSingleton;
@@ -103,7 +102,7 @@ public abstract static class LanguageServerDefinition {
this.languageIdMappings = new ConcurrentHashMap<>();
}
- public void registerAssociation(@NonNull IContentType contentType, @NonNull String languageId) {
+ public void registerAssociation(IContentType contentType, String languageId) {
this.languageIdMappings.put(contentType, languageId);
}
@@ -156,7 +155,7 @@ private static int getLastDocumentDisconnectedTimeout(IConfigurationElement elem
return lastDocumentisconnectedTiemoutAttribute == null ? DEFAULT_LAST_DOCUMENTED_DISCONNECTED_TIEMOUT : Integer.parseInt(lastDocumentisconnectedTiemoutAttribute);
}
- public ExtensionLanguageServerDefinition(@NonNull IConfigurationElement element) {
+ public ExtensionLanguageServerDefinition(IConfigurationElement element) {
super(element.getAttribute(ID_ATTRIBUTE), element.getAttribute(LABEL_ATTRIBUTE), getIsSingleton(element), getLastDocumentDisconnectedTimeout(element));
this.extension = element;
}
@@ -265,7 +264,7 @@ private LanguageServersRegistry() {
private void initialize() {
String prefs = preferenceStore.getString(CONTENT_TYPE_TO_LSP_LAUNCH_PREF_KEY);
- if (prefs != null && !prefs.isEmpty()) {
+ if (!prefs.isEmpty()) {
String[] entries = prefs.split(","); //$NON-NLS-1$
for (String entry : entries) {
ContentTypeToLSPLaunchConfigEntry mapping = ContentTypeToLSPLaunchConfigEntry.readFromPreference(entry);
@@ -286,7 +285,7 @@ private void initialize() {
IContentType contentType = Platform.getContentTypeManager().getContentType(extension.getAttribute(CONTENT_TYPE_ATTRIBUTE));
String languageId = extension.getAttribute(LANGUAGE_ID_ATTRIBUTE);
EnablementTester expression = null;
- if (extension.getChildren(ENABLED_WHEN_ATTRIBUTE) != null) {
+ if (extension.getChildren(ENABLED_WHEN_ATTRIBUTE).length > 0) {
IConfigurationElement[] enabledWhenElements = extension.getChildren(ENABLED_WHEN_ATTRIBUTE);
if (enabledWhenElements.length == 1) {
IConfigurationElement enabledWhen = enabledWhenElements[0];
@@ -320,7 +319,7 @@ private void initialize() {
}
}
- private IEvaluationContext evaluationContext() {
+ private @Nullable IEvaluationContext evaluationContext() {
final var handlerService = PlatformUI.getWorkbench().getService(IHandlerService.class);
return handlerService == null
? null
@@ -351,7 +350,7 @@ private void persistContentTypeToLaunchConfigurationMapping() {
* @return the {@link LanguageServerDefinition}s directly associated to the given content-type.
* This does not include the one that match transitively as per content-type hierarchy
*/
- List<@NonNull ContentTypeToLanguageServerDefinition> findProviderFor(final @NonNull IContentType contentType) {
+ List findProviderFor(final IContentType contentType) {
return connections.stream()
.filter(entry -> entry.getKey().equals(contentType))
.sorted((mapping1, mapping2) -> {
@@ -367,16 +366,15 @@ private void persistContentTypeToLaunchConfigurationMapping() {
}).toList();
}
- public void registerAssociation(@NonNull IContentType contentType, @NonNull ILaunchConfiguration launchConfig, @NonNull Set launchMode) {
+ public void registerAssociation(IContentType contentType, ILaunchConfiguration launchConfig, Set launchMode) {
final var mapping = new ContentTypeToLSPLaunchConfigEntry(contentType, launchConfig,
launchMode);
connections.add(mapping);
persistContentTypeToLaunchConfigurationMapping();
}
- public void registerAssociation(@NonNull IContentType contentType,
- @NonNull LanguageServerDefinition serverDefinition, @Nullable String languageId,
- EnablementTester enablement) {
+ public void registerAssociation(IContentType contentType, LanguageServerDefinition serverDefinition,
+ @Nullable String languageId, @Nullable EnablementTester enablement) {
if (languageId != null) {
serverDefinition.registerAssociation(contentType, languageId);
}
@@ -398,7 +396,7 @@ public List getContentTypeToLSPExtensions
return this.connections.stream().filter(mapping -> mapping.getValue() instanceof ExtensionLanguageServerDefinition).toList();
}
- public @Nullable LanguageServerDefinition getDefinition(@NonNull String languageServerId) {
+ public @Nullable LanguageServerDefinition getDefinition(String languageServerId) {
for (ContentTypeToLanguageServerDefinition mapping : this.connections) {
if (mapping.getValue().id.equals(languageServerId)) {
return mapping.getValue();
@@ -412,13 +410,12 @@ public List getContentTypeToLSPExtensions
*/
private static final class ContentTypeMapping {
- @NonNull public final String id;
- @NonNull public final IContentType contentType;
- @Nullable public final String languageId;
- @Nullable
- public final EnablementTester enablement;
+ public final String id;
+ public final IContentType contentType;
+ public final @Nullable String languageId;
+ public final @Nullable EnablementTester enablement;
- public ContentTypeMapping(@NonNull IContentType contentType, @NonNull String id, @Nullable String languageId,
+ public ContentTypeMapping(IContentType contentType, String id, @Nullable String languageId,
@Nullable EnablementTester enablement) {
this.contentType = contentType;
this.id = id;
@@ -433,7 +430,7 @@ public ContentTypeMapping(@NonNull IContentType contentType, @NonNull String id,
* @param serverDefinition
* @return whether the given serverDefinition is suitable for the file
*/
- public boolean matches(@NonNull IFile file, @NonNull LanguageServerDefinition serverDefinition) {
+ public boolean matches(IFile file, LanguageServerDefinition serverDefinition) {
return getAvailableLSFor(LSPEclipseUtils.getFileContentTypes(file), file.getLocationURI()).contains(serverDefinition);
}
@@ -442,16 +439,16 @@ public boolean matches(@NonNull IFile file, @NonNull LanguageServerDefinition se
* @param serverDefinition
* @return whether the given serverDefinition is suitable for the file
*/
- public boolean matches(@NonNull IDocument document, @NonNull LanguageServerDefinition serverDefinition) {
+ public boolean matches(IDocument document, LanguageServerDefinition serverDefinition) {
return getAvailableLSFor(LSPEclipseUtils.getDocumentContentTypes(document), LSPEclipseUtils.toUri(document)).contains(serverDefinition);
}
- public boolean canUseLanguageServer(@NonNull IEditorInput editorInput) {
+ public boolean canUseLanguageServer(IEditorInput editorInput) {
return !getAvailableLSFor(
Arrays.asList(Platform.getContentTypeManager().findContentTypesFor(editorInput.getName())), LSPEclipseUtils.toUri(editorInput)).isEmpty();
}
- public boolean canUseLanguageServer(@NonNull IDocument document) {
+ public boolean canUseLanguageServer(IDocument document) {
List contentTypes = LSPEclipseUtils.getDocumentContentTypes(document);
if (contentTypes.isEmpty()) {
@@ -461,7 +458,7 @@ public boolean canUseLanguageServer(@NonNull IDocument document) {
return !getAvailableLSFor(contentTypes, LSPEclipseUtils.toUri(document)).isEmpty();
}
- public boolean canUseLanguageServer(@NonNull IFile file) {
+ public boolean canUseLanguageServer(IFile file) {
return !getAvailableLSFor(LSPEclipseUtils.getFileContentTypes(file), file.getLocationURI()).isEmpty();
}
@@ -470,7 +467,7 @@ public boolean canUseLanguageServer(@NonNull IFile file) {
* @param contentTypes content-types to check against LS registry. Base types are checked too.
* @return definitions that can support the following content-types
*/
- private Set getAvailableLSFor(Collection contentTypes, URI uri) {
+ private Set getAvailableLSFor(Collection contentTypes, @Nullable URI uri) {
final var res = new HashSet();
contentTypes = expandToSuperTypes(contentTypes);
for (ContentTypeToLanguageServerDefinition mapping : this.connections) {
diff --git a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServiceAccessor.java b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServiceAccessor.java
index 43e33dce5..f47e02e00 100644
--- a/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServiceAccessor.java
+++ b/org.eclipse.lsp4e/src/org/eclipse/lsp4e/LanguageServiceAccessor.java
@@ -14,6 +14,8 @@
*******************************************************************************/
package org.eclipse.lsp4e;
+import static org.eclipse.lsp4e.internal.NullSafetyHelper.castNonNull;
+
import java.io.IOException;
import java.net.URI;
import java.util.ArrayDeque;
@@ -51,8 +53,8 @@
import org.eclipse.ui.part.FileEditorInput;
/**
- * The entry-point to retrieve a Language Server Wrapper for a given resource/project.
- * Deals with instantiations and caching of underlying
+ * The entry-point to retrieve a Language Server Wrapper for a given
+ * resource/project. Deals with instantiations and caching of underlying
* {@link LanguageServerWrapper}.
*
*/
@@ -62,7 +64,7 @@ private LanguageServiceAccessor() {
// this class shouldn't be instantiated
}
- private static final Set<@NonNull LanguageServerWrapper> startedServers = new CopyOnWriteArraySet<>();
+ private static final Set startedServers = new CopyOnWriteArraySet<>();
private static final Map providersToLSDefinitions = new HashMap<>();
/**
@@ -79,23 +81,23 @@ public static void clearStartedServers() {
/**
* A bean storing association of a Document/File with a language server wrapper.
+ *
* @deprecated use {@link LanguageServers#forDocument(IDocument)} instead.
*/
@Deprecated(forRemoval = true)
public static class LSPDocumentInfo {
- private final @NonNull URI fileUri;
- private final @NonNull IDocument document;
- private final @NonNull LanguageServerWrapper wrapper;
+ private final URI fileUri;
+ private final IDocument document;
+ private final LanguageServerWrapper wrapper;
- private LSPDocumentInfo(@NonNull URI fileUri, @NonNull IDocument document,
- @NonNull LanguageServerWrapper wrapper) {
+ private LSPDocumentInfo(URI fileUri, IDocument document, LanguageServerWrapper wrapper) {
this.fileUri = fileUri;
this.document = document;
this.wrapper = wrapper;
}
- public @NonNull IDocument getDocument() {
+ public IDocument getDocument() {
return this.document;
}
@@ -104,7 +106,7 @@ private LSPDocumentInfo(@NonNull URI fileUri, @NonNull IDocument document,
*
* @return the file URI
*/
- public @NonNull URI getFileUri() {
+ public URI getFileUri() {
return this.fileUri;
}
@@ -126,35 +128,28 @@ public boolean isActive() {
}
public static void disableLanguageServerContentType(
- @NonNull ContentTypeToLanguageServerDefinition contentTypeToLSDefinition) {
+ ContentTypeToLanguageServerDefinition contentTypeToLSDefinition) {
Optional result = startedServers.stream()
.filter(server -> server.serverDefinition.equals(contentTypeToLSDefinition.getValue())).findFirst();
if (result.isPresent()) {
IContentType contentType = contentTypeToLSDefinition.getKey();
- if (contentType != null) {
- result.get().disconnectContentType(contentType);
- }
+ result.get().disconnectContentType(contentType);
}
}
public static void enableLanguageServerContentType(
- @NonNull final ContentTypeToLanguageServerDefinition contentTypeToLSDefinition,
- @NonNull final IEditorReference[] editors) {
+ final ContentTypeToLanguageServerDefinition contentTypeToLSDefinition, final IEditorReference[] editors) {
final IContentType contentType = contentTypeToLSDefinition.getKey();
- if(contentType == null)
- return;
final LanguageServerDefinition lsDefinition = contentTypeToLSDefinition.getValue();
- if(lsDefinition == null)
- return;
-
for (final IEditorReference editor : editors) {
try {
if (editor.getEditorInput() instanceof FileEditorInput editorInput) {
final IFile editorFile = editorInput.getFile();
final IContentDescription contentDesc = editorFile.getContentDescription();
- if(contentDesc == null)
+ if (contentDesc == null)
continue;
- if (contentType.equals(contentDesc.getContentType()) && contentTypeToLSDefinition.isEnabled(editorFile.getLocationURI())) {
+ if (contentType.equals(contentDesc.getContentType())
+ && contentTypeToLSDefinition.isEnabled(editorFile.getLocationURI())) {
getInitializedLanguageServer(editorFile, lsDefinition, capabilities -> true);
}
}
@@ -164,18 +159,21 @@ public static void enableLanguageServerContentType(
}
}
-
/**
- * Get the requested language server instance for the given file. Starts the language server if not already started.
+ * Get the requested language server instance for the given file. Starts the
+ * language server if not already started.
+ *
* @param resource
* @param lsDefinition
- * @param capabilitiesPredicate a predicate to check capabilities
- * @return a LanguageServer for the given file, which is defined with provided server ID and conforms to specified request.
- * If {@code capabilitesPredicate} does not test positive for the server's capabilities, {@code null} is returned.
+ * @param capabilitiesPredicate
+ * a predicate to check capabilities
+ * @return a LanguageServer for the given file, which is defined with provided
+ * server ID and conforms to specified request. If
+ * {@code capabilitesPredicate} does not test positive for the server's
+ * capabilities, {@code null} is returned.
*/
- private static CompletableFuture getInitializedLanguageServer(@NonNull IResource resource,
- @NonNull LanguageServerDefinition lsDefinition, Predicate capabilitiesPredicate)
- throws IOException {
+ private static @Nullable CompletableFuture getInitializedLanguageServer(IResource resource,
+ LanguageServerDefinition lsDefinition, @Nullable Predicate capabilitiesPredicate) {
LanguageServerWrapper wrapper = getLSWrapper(resource.getProject(), lsDefinition, resource.getFullPath());
if (capabilitiesComply(wrapper, capabilitiesPredicate)) {
return wrapper.getInitializedServer();
@@ -183,7 +181,6 @@ private static CompletableFuture getInitializedLanguageServer(@N
return null;
}
-
/**
* Checks if the given {@code wrapper}'s capabilities comply with the given
* {@code capabilitiesPredicate}.
@@ -199,11 +196,13 @@ private static CompletableFuture getInitializedLanguageServer(@N
* {@code wrapper.getServerCapabilities() == null}
*/
private static boolean capabilitiesComply(LanguageServerWrapper wrapper,
- Predicate capabilitiesPredicate) {
+ @Nullable Predicate capabilitiesPredicate) {
return capabilitiesPredicate == null
- /* next null check is workaround for https://github.com/TypeFox/ls-api/issues/47 */
+ /*
+ * next null check is workaround for https://github.com/TypeFox/ls-api/issues/47
+ */
|| wrapper.getServerCapabilities() == null
- || capabilitiesPredicate.test(wrapper.getServerCapabilities());
+ || capabilitiesPredicate.test(castNonNull(wrapper.getServerCapabilities()));
}
/**
@@ -212,13 +211,11 @@ private static boolean capabilitiesComply(LanguageServerWrapper wrapper,
* @param file
* @param request
* @return the matching LS wrappers
- * @throws IOException
* @noreference This method is currently internal and should only be referenced
* for testing
*/
- @NonNull
- public static List getLSWrappers(@NonNull final IFile file,
- @Nullable final Predicate request) throws IOException {
+ public static List getLSWrappers(final IFile file,
+ final @Nullable Predicate request) {
final var project = file.getProject();
if (project == null) {
return Collections.emptyList();
@@ -226,9 +223,13 @@ public static List getLSWrappers(@NonNull final IFile fil
final var lsRegistry = LanguageServersRegistry.getInstance();
final var fileURI = file.getLocationURI();
+ if (fileURI == null) {
+ return Collections.emptyList();
+ }
- List<@NonNull LanguageServerWrapper> wrappers = getStartedWrappers(file.getProject(), request, true);
- wrappers.removeIf(wrapper -> !wrapper.isConnectedTo(fileURI) || !lsRegistry.matches(file, wrapper.serverDefinition));
+ List wrappers = getStartedWrappers(file.getProject(), request, true);
+ wrappers.removeIf(
+ wrapper -> !wrapper.isConnectedTo(fileURI) || !lsRegistry.matches(file, wrapper.serverDefinition));
// look for running language servers via content-type
final var directContentTypes = LSPEclipseUtils.getFileContentTypes(file);
@@ -246,10 +247,6 @@ public static List