Skip to content

Commit

Permalink
feat: Improve completion with snippet support (#786)
Browse files Browse the repository at this point in the history 
Fixes #786

Signed-off-by: azerr <[email protected]>
  • Loading branch information
@angelozerr @fbricon
angelozerr authored and fbricon committed Jul 12, 2023
1 parent d43d5bc commit cf6bbf7
Show file tree
Hide file tree
Showing 23 changed files with 1,556 additions and 113 deletions.
4 changes: 2 additions & 2 deletions src/main/java/com/redhat/devtools/intellij/lsp4ij/internal/SupportedFeatures.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ public class SupportedFeatures {
textDocumentClientCapabilities.setInlayHint(new InlayHintCapabilities());
// TODO : support textDocument/colorPresentation
// textDocumentClientCapabilities.setColorProvider(new ColorProviderCapabilities());
final var completionItemCapabilities = new CompletionItemCapabilities(Boolean.FALSE);
final var completionItemCapabilities = new CompletionItemCapabilities(Boolean.TRUE);
completionItemCapabilities
.setDocumentationFormat(Arrays.asList(MarkupKind.MARKDOWN, MarkupKind.PLAINTEXT));
// completionItemCapabilities.setInsertTextModeSupport(new CompletionItemInsertTextModeSupportCapabilities(List.of(InsertTextMode.AsIs, InsertTextMode.AdjustIndentation)));
completionItemCapabilities.setInsertTextModeSupport(new CompletionItemInsertTextModeSupportCapabilities(List.of(InsertTextMode.AsIs, InsertTextMode.AdjustIndentation)));
// completionItemCapabilities.setResolveSupport(new CompletionItemResolveSupportCapabilities(List.of("documentation", "detail", "additionalTextEdits"))); //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
textDocumentClientCapabilities.setCompletion(new CompletionCapabilities(completionItemCapabilities));
final var definitionCapabilities = new DefinitionCapabilities();
Expand Down
11 changes: 5 additions & 6 deletions ...a/com/redhat/devtools/intellij/lsp4ij/operations/completion/LSContentAssistProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,18 +54,17 @@ public void fillCompletionVariants(@NotNull CompletionParameters parameters, @No
Project project = parameters.getOriginalFile().getProject();
int offset = parameters.getOffset();
CompletableFuture<List<Pair<LanguageServerWrapper, LanguageServer>>> completionLanguageServersFuture = initiateLanguageServers(project, document);
CompletionParams param;
try {
/*
process the responses out of the completable loop as it may cause deadlock if user is typing
more characters as toProposals will require as read lock that this thread already have and
async processing is occuring on a separate thread.
*/
param = LSPIJUtils.toCompletionParams(LSPIJUtils.toUri(document), offset, document);
CompletionParams params = LSPIJUtils.toCompletionParams(LSPIJUtils.toUri(document), offset, document);
BlockingDeque<Pair<Either<List<CompletionItem>, CompletionList>, LanguageServer>> proposals = new LinkedBlockingDeque<>();
CompletableFuture<Void> future = completionLanguageServersFuture
.thenComposeAsync(languageServers -> CompletableFuture.allOf(languageServers.stream()
.map(languageServer -> languageServer.getSecond().getTextDocumentService().completion(param)
.map(languageServer -> languageServer.getSecond().getTextDocumentService().completion(params)
.thenAcceptAsync(completion -> proposals.add(new Pair<>(completion, languageServer.getSecond()))))
.toArray(CompletableFuture[]::new)));
while (!future.isDone() || !proposals.isEmpty()) {
Expand All @@ -77,7 +76,7 @@ public void fillCompletionVariants(@NotNull CompletionParameters parameters, @No
}

}
} catch (ProcessCanceledException cancellation){
} catch (ProcessCanceledException cancellation) {
throw cancellation;
} catch (RuntimeException | InterruptedException e) {
LOGGER.warn(e.getLocalizedMessage(), e);
Expand All @@ -90,7 +89,7 @@ private Collection<? extends LookupElement> toProposals(Project project, Editor
int offset, Either<List<CompletionItem>,
CompletionList> completion, LanguageServer languageServer) {
if (completion != null) {
List<CompletionItem> items = completion.isLeft()?completion.getLeft():completion.getRight().getItems();
List<CompletionItem> items = completion.isLeft() ? completion.getLeft() : completion.getRight().getItems();
boolean isIncomplete = completion.isRight() && completion.getRight().isIncomplete();
return items.stream().map(item -> createLookupItem(project, editor, offset, item, isIncomplete, languageServer)).
filter(item -> item.validate(document, offset, null)).
Expand All @@ -103,7 +102,7 @@ private Collection<? extends LookupElement> toProposals(Project project, Editor
private LSIncompleteCompletionProposal createLookupItem(Project project, Editor editor, int offset,
CompletionItem item, boolean isIncomplete,
LanguageServer languageServer) {
return isIncomplete?new LSIncompleteCompletionProposal(editor, offset, item, languageServer):
return isIncomplete ? new LSIncompleteCompletionProposal(editor, offset, item, languageServer) :
new LSCompletionProposal(editor, offset, item, languageServer);
}

Expand Down
164 changes: 59 additions & 105 deletions ...redhat/devtools/intellij/lsp4ij/operations/completion/LSIncompleteCompletionProposal.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@
import com.intellij.codeInsight.completion.InsertionContext;
import com.intellij.codeInsight.lookup.LookupElement;
import com.intellij.codeInsight.lookup.LookupElementPresentation;
import com.intellij.codeInsight.template.Template;
import com.intellij.codeInsight.template.TemplateManager;
import com.intellij.codeInsight.template.impl.ConstantNode;
import com.intellij.codeInsight.template.impl.TemplateImpl;
import com.intellij.openapi.editor.Document;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.editor.event.DocumentEvent;
Expand All @@ -27,6 +31,7 @@
import org.eclipse.lsp4j.jsonrpc.messages.Either;
import org.eclipse.lsp4j.services.LanguageServer;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

Expand All @@ -41,29 +46,47 @@ public class LSIncompleteCompletionProposal extends LookupElement {

// Those variables should be defined in LSP4J and reused here whenever done there
// See https://github.com/eclipse/lsp4j/issues/149
/** The currently selected text or the empty string */
/**
* The currently selected text or the empty string
*/
private static final String TM_SELECTED_TEXT = "TM_SELECTED_TEXT"; //$NON-NLS-1$
/** The contents of the current line */
/**
* The contents of the current line
*/
private static final String TM_CURRENT_LINE = "TM_CURRENT_LINE"; //$NON-NLS-1$
/** The contents of the word under cursor or the empty string */
/**
* The contents of the word under cursor or the empty string
*/
private static final String TM_CURRENT_WORD = "TM_CURRENT_WORD"; //$NON-NLS-1$
/** The zero-index based line number */
/**
* The zero-index based line number
*/
private static final String TM_LINE_INDEX = "TM_LINE_INDEX"; //$NON-NLS-1$
/** The one-index based line number */
/**
* The one-index based line number
*/
private static final String TM_LINE_NUMBER = "TM_LINE_NUMBER"; //$NON-NLS-1$
/** The filename of the current document */
/**
* The filename of the current document
*/
private static final String TM_FILENAME = "TM_FILENAME"; //$NON-NLS-1$
/** The filename of the current document without its extensions */
/**
* The filename of the current document without its extensions
*/
private static final String TM_FILENAME_BASE = "TM_FILENAME_BASE"; //$NON-NLS-1$
/** The directory of the current document */
/**
* The directory of the current document
*/
private static final String TM_DIRECTORY = "TM_DIRECTORY"; //$NON-NLS-1$
/** The full file path of the current document */
/**
* The full file path of the current document
*/
private static final String TM_FILEPATH = "TM_FILEPATH"; //$NON-NLS-1$

protected final CompletionItem item;
protected final int initialOffset;
protected int currentOffset;
protected int bestOffset;
protected int currentOffset;
protected int bestOffset;
protected final Editor editor;
private Integer rankCategory;
private Integer rankScore;
Expand All @@ -79,7 +102,25 @@ public LSIncompleteCompletionProposal(Editor editor, int offset, CompletionItem
this.currentOffset = offset;
this.bestOffset = getPrefixCompletionStart(editor.getDocument(), offset);
//this.bestOffset = offset;
putUserData(CodeCompletionHandlerBase.DIRECT_INSERTION, true);
if(item.getInsertTextFormat() != InsertTextFormat.Snippet) {
putUserData(CodeCompletionHandlerBase.DIRECT_INSERTION, true);
}
}

@Override
public void handleInsert(@NotNull InsertionContext context) {
if (item.getInsertTextFormat() == InsertTextFormat.Snippet){
Template myTemplate = SnippetTemplateFactory.createTemplate(getInsertText(), context.getProject(), name -> getVariableValue(name));
startTemplate(context, myTemplate);
} else {
apply(context.getDocument(), context.getCompletionChar(), 0, context.getOffset(CompletionInitializationContext.SELECTION_END_OFFSET));
}
}

private static void startTemplate(InsertionContext context, @NotNull Template template) {
context.getDocument().deleteString(context.getStartOffset(), context.getTailOffset());
context.setAddCompletionChar(false);
TemplateManager.getInstance(context.getProject()).startTemplate(context.getEditor(), template);
}

/**
Expand Down Expand Up @@ -123,7 +164,7 @@ protected String getInsertText() {
String insertText = this.item.getInsertText();
Either<TextEdit, InsertReplaceEdit> eitherTextEdit = this.item.getTextEdit();
if (eitherTextEdit != null) {
if(eitherTextEdit.isLeft()) {
if (eitherTextEdit.isLeft()) {
insertText = eitherTextEdit.getLeft().getNewText();
} else {
insertText = eitherTextEdit.getRight().getNewText();
Expand Down Expand Up @@ -173,7 +214,7 @@ public int getPrefixCompletionStart(Document document, int completionOffset) {
@NotNull
@Override
public String getLookupString() {
String lookup = StringUtils.isNotBlank(item.getFilterText())?item.getFilterText():item.getLabel();
String lookup = StringUtils.isNotBlank(item.getFilterText()) ? item.getFilterText() : item.getLabel();
if (lookup.charAt(0) == '@') {
return lookup.substring(1);
}
Expand All @@ -182,7 +223,7 @@ public String getLookupString() {

private boolean isDeprecated() {
return (item.getTags() != null && item.getTags().contains(CompletionItemTag.Deprecated))
|| (item.getDeprecated() != null && item.getDeprecated().booleanValue());
|| (item.getDeprecated() != null && item.getDeprecated().booleanValue());
}

@Override
Expand All @@ -200,7 +241,7 @@ protected void apply(Document document, char trigger, int stateMask, int offset)
Either<TextEdit, InsertReplaceEdit> eitherTextEdit = item.getTextEdit();
TextEdit textEdit = null;
if (eitherTextEdit != null) {
if(eitherTextEdit.isLeft()) {
if (eitherTextEdit.isLeft()) {
textEdit = eitherTextEdit.getLeft();
} else {
// trick to partially support the new InsertReplaceEdit from LSP 3.16. Reuse previously code for TextEdit.
Expand Down Expand Up @@ -247,66 +288,7 @@ protected void apply(Document document, char trigger, int stateMask, int offset)
}
textEdit.getRange().getEnd().setCharacter(textEdit.getRange().getEnd().getCharacter() + commonSize);
}
insertText = textEdit.getNewText();
int insertionOffset = LSPIJUtils.toOffset(textEdit.getRange().getStart(), document);
insertionOffset = computeNewOffset(item.getAdditionalTextEdits(), insertionOffset, document);
if (item.getInsertTextFormat() == InsertTextFormat.Snippet) {
int currentSnippetOffsetInInsertText = 0;
while ((currentSnippetOffsetInInsertText = insertText.indexOf('$', currentSnippetOffsetInInsertText)) != -1) {
StringBuilder keyBuilder = new StringBuilder();
boolean isChoice = false;
List<String> snippetProposals = new ArrayList<>();
int offsetInSnippet = 1;
while (currentSnippetOffsetInInsertText + offsetInSnippet < insertText.length() && Character.isDigit(insertText.charAt(currentSnippetOffsetInInsertText + offsetInSnippet))) {
keyBuilder.append(insertText.charAt(currentSnippetOffsetInInsertText + offsetInSnippet));
offsetInSnippet++;
}
if (keyBuilder.length() == 0 && insertText.substring(currentSnippetOffsetInInsertText).startsWith("${")) { //$NON-NLS-1$
offsetInSnippet = 2;
while (currentSnippetOffsetInInsertText + offsetInSnippet < insertText.length() && Character.isDigit(insertText.charAt(currentSnippetOffsetInInsertText + offsetInSnippet))) {
keyBuilder.append(insertText.charAt(currentSnippetOffsetInInsertText + offsetInSnippet));
offsetInSnippet++;
}
if (currentSnippetOffsetInInsertText + offsetInSnippet < insertText.length()) {
char currentChar = insertText.charAt(currentSnippetOffsetInInsertText + offsetInSnippet);
if (currentChar == ':' || currentChar == '|') {
isChoice |= currentChar == '|';
offsetInSnippet++;
}
}
boolean close = false;
StringBuilder valueBuilder = new StringBuilder();
while (currentSnippetOffsetInInsertText + offsetInSnippet < insertText.length() && !close) {
char currentChar = insertText.charAt(currentSnippetOffsetInInsertText + offsetInSnippet);
if (valueBuilder.length() > 0 &&
((isChoice && (currentChar == ',' || currentChar == '|') || currentChar == '}'))) {
String value = valueBuilder.toString();
if (value.startsWith("$")) { //$NON-NLS-1$
String varValue = getVariableValue(value.substring(1));
if (varValue != null) {
value = varValue;
}
}
snippetProposals.add(value);
valueBuilder = new StringBuilder();
} else if (currentChar != '}') {
valueBuilder.append(currentChar);
}
close = currentChar == '}';
offsetInSnippet++;
}
}
String defaultProposal = snippetProposals.isEmpty() ? "" : snippetProposals.get(0); //$NON-NLS-1$
if (keyBuilder.length() > 0) {
String key = keyBuilder.toString();
insertText = insertText.substring(0, currentSnippetOffsetInInsertText) + defaultProposal + insertText.substring(currentSnippetOffsetInInsertText + offsetInSnippet);
currentSnippetOffsetInInsertText += defaultProposal.length();
} else {
currentSnippetOffsetInInsertText++;
}
}
}
textEdit.setNewText(insertText); // insertText now has placeholder removed

List<TextEdit> additionalEdits = item.getAdditionalTextEdits();
if (additionalEdits != null && !additionalEdits.isEmpty()) {
List<TextEdit> allEdits = new ArrayList<>();
Expand All @@ -330,30 +312,7 @@ protected void apply(Document document, char trigger, int stateMask, int offset)
}
}

private int computeNewOffset(List<TextEdit> additionalTextEdits, int insertionOffset, Document doc) {
if (additionalTextEdits != null && !additionalTextEdits.isEmpty()) {
int adjustment = 0;
for (TextEdit edit : additionalTextEdits) {
try {
Range rng = edit.getRange();
int start = LSPIJUtils.toOffset(rng.getStart(), doc);
if (start <= insertionOffset) {
int end = LSPIJUtils.toOffset(rng.getEnd(), doc);
int orgLen = end - start;
int newLeng = edit.getNewText().length();
int editChange = newLeng - orgLen;
adjustment += editChange;
}
} catch (RuntimeException e) {
LOGGER.warn(e.getLocalizedMessage(), e);
}
}
return insertionOffset + adjustment;
}
return insertionOffset;
}

private String getVariableValue(String variableName) {
private @Nullable String getVariableValue(String variableName) {
Document document = editor.getDocument();
switch (variableName) {
case TM_FILENAME_BASE:
Expand Down Expand Up @@ -416,11 +375,6 @@ public String getFilterString() {
return item.getLabel();
}

@Override
public void handleInsert(@NotNull InsertionContext context) {
apply(context.getDocument(), context.getCompletionChar(), 0, context.getOffset(CompletionInitializationContext.SELECTION_END_OFFSET));
}

public boolean validate(Document document, int offset, DocumentEvent event) {
return true;
}
Expand Down
Loading

0 comments on commit cf6bbf7

Please sign in to comment.