forked from eclipse-lemminx/lemminx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provides file completion when the user starts typing a path in an attribute value Displays all folders and files as of now. Fixes eclipse-lemminx#345 Signed-off-by: Nikolas Komonen <[email protected]>
- Loading branch information
1 parent
46984c2
commit 011fcdc
Showing
17 changed files
with
837 additions
and
64 deletions.
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
46 changes: 46 additions & 0 deletions
46
org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/general/FilePathPlugin.java
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,46 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2019 Red Hat Inc. and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v20.html | ||
| * | ||
| * Contributors: | ||
| * Red Hat Inc. - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package org.eclipse.lsp4xml.extensions.general; | ||
|
|
||
| import org.eclipse.lsp4j.InitializeParams; | ||
| import org.eclipse.lsp4xml.extensions.general.completion.FilePathCompletionParticipant; | ||
| import org.eclipse.lsp4xml.services.extensions.IXMLExtension; | ||
| import org.eclipse.lsp4xml.services.extensions.XMLExtensionsRegistry; | ||
| import org.eclipse.lsp4xml.services.extensions.save.ISaveContext; | ||
|
|
||
| /** | ||
| * FilePathPlugin | ||
| */ | ||
| public class FilePathPlugin implements IXMLExtension { | ||
|
|
||
| private final FilePathCompletionParticipant completionParticipant; | ||
|
|
||
| public FilePathPlugin() { | ||
| completionParticipant = new FilePathCompletionParticipant(); | ||
| } | ||
|
|
||
| @Override | ||
| public void start(InitializeParams params, XMLExtensionsRegistry registry) { | ||
| registry.registerCompletionParticipant(completionParticipant); | ||
| } | ||
|
|
||
| @Override | ||
| public void stop(XMLExtensionsRegistry registry) { | ||
| registry.unregisterCompletionParticipant(completionParticipant); | ||
| } | ||
|
|
||
| @Override | ||
| public void doSave(ISaveContext context) { | ||
|
|
||
| } | ||
|
|
||
|
|
||
| } |
271 changes: 271 additions & 0 deletions
271
...java/org/eclipse/lsp4xml/extensions/general/completion/FilePathCompletionParticipant.java
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,271 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2019 Red Hat Inc. and others. | ||
| * All rights reserved. This program and the accompanying materials | ||
| * which accompanies this distribution, and is available at | ||
| * http://www.eclipse.org/legal/epl-v20.html | ||
| * | ||
| * Contributors: | ||
| * Red Hat Inc. - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| package org.eclipse.lsp4xml.extensions.general.completion; | ||
|
|
||
| import static org.eclipse.lsp4xml.utils.FilesUtils.cleanPathForWindows; | ||
| import static org.eclipse.lsp4xml.utils.FilesUtils.getFilePathSlash; | ||
| import static org.eclipse.lsp4xml.utils.FilesUtils.getNormalizedPath; | ||
| import static org.eclipse.lsp4xml.utils.OSUtils.isWindows; | ||
| import static org.eclipse.lsp4xml.utils.StringUtils.isEmpty; | ||
|
|
||
| import java.io.File; | ||
| import java.io.FilenameFilter; | ||
| import java.net.URI; | ||
| import java.nio.file.Path; | ||
| import java.nio.file.Paths; | ||
|
|
||
| import org.eclipse.lsp4j.CompletionItem; | ||
| import org.eclipse.lsp4j.CompletionItemKind; | ||
| import org.eclipse.lsp4j.Position; | ||
| import org.eclipse.lsp4j.Range; | ||
| import org.eclipse.lsp4j.TextEdit; | ||
| import org.eclipse.lsp4xml.commons.BadLocationException; | ||
| import org.eclipse.lsp4xml.dom.DOMDocument; | ||
| import org.eclipse.lsp4xml.services.extensions.ICompletionParticipant; | ||
| import org.eclipse.lsp4xml.services.extensions.ICompletionRequest; | ||
| import org.eclipse.lsp4xml.services.extensions.ICompletionResponse; | ||
| import org.eclipse.lsp4xml.settings.SharedSettings; | ||
| import org.eclipse.lsp4xml.utils.CompletionSortTextHelper; | ||
| import org.eclipse.lsp4xml.utils.FilesUtils; | ||
| import org.eclipse.lsp4xml.utils.StringUtils; | ||
|
|
||
| /** | ||
| * FilePathCompletionParticipant | ||
| */ | ||
| public class FilePathCompletionParticipant implements ICompletionParticipant { | ||
|
|
||
| public static final String FILE_SCHEME = "file"; | ||
|
|
||
| private static final FilenameFilter xsdFilter = new FilenameFilter() { | ||
|
|
||
| @Override | ||
| public boolean accept(File dir, String name) { | ||
| if (name.matches(".+\\.[^\\s]+$") == false) { | ||
| return true; | ||
| } | ||
| return name.toLowerCase().endsWith(".xsd"); | ||
| } | ||
| }; | ||
|
|
||
| @Override | ||
| public void onTagOpen(ICompletionRequest completionRequest, ICompletionResponse completionResponse) throws Exception { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void onXMLContent(ICompletionRequest request, ICompletionResponse response) throws Exception { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void onAttributeName(boolean generateValue, Range fullRange, ICompletionRequest request, | ||
| ICompletionResponse response, SharedSettings settings) throws Exception { | ||
|
|
||
| } | ||
|
|
||
| @Override | ||
| public void onAttributeValue(String valuePrefix, Range fullRange, boolean addQuotes, ICompletionRequest request, | ||
| ICompletionResponse response, SharedSettings settings) throws Exception { | ||
|
|
||
| DOMDocument xmlDocument = request.getXMLDocument(); | ||
| String text = xmlDocument.getText(); | ||
|
|
||
| // Get full attribute value range | ||
| // +- 1 since it includes the quotations | ||
| int documentStartOffset = xmlDocument.offsetAt(fullRange.getStart()) + 1; | ||
| int documentEndOffset = xmlDocument.offsetAt(fullRange.getEnd()) - 1; | ||
| String fullAttributeValue = text.substring(documentStartOffset, documentEndOffset); | ||
| if (isEmpty(fullAttributeValue)) { | ||
| return; | ||
| } | ||
|
|
||
| // Get value and range from fullAttributeValue | ||
| int completionOffset = request.getOffset(); // offset after the typed character | ||
| int parsedAttributeStartOffset = StringUtils.getOffsetAfterWhitespace(fullAttributeValue, completionOffset - documentStartOffset) + documentStartOffset; // first character of URI | ||
| String subAttributeValue = text.substring(parsedAttributeStartOffset, completionOffset); | ||
|
|
||
| Position startValue = xmlDocument.positionAt(parsedAttributeStartOffset); | ||
| Position endValue = xmlDocument.positionAt(completionOffset); | ||
| fullRange = new Range(startValue, endValue); | ||
|
|
||
| // Try to get the URI string from the attribute value in case it has a file scheme | ||
| // header (eg: "file://") | ||
| String pathInAttribute = subAttributeValue; | ||
| boolean hasFileScheme = false; | ||
|
|
||
| hasFileScheme = subAttributeValue.startsWith(FilesUtils.FILE_SCHEME); | ||
| if (hasFileScheme) { | ||
| pathInAttribute = subAttributeValue.substring(FilesUtils.FILE_SCHEME.length()); | ||
| } | ||
|
|
||
| String slash = getFilePathSlash(subAttributeValue); | ||
|
|
||
| if (hasFileScheme) { | ||
| if (!pathInAttribute.startsWith("/")) { | ||
| return; // use of 'file://' and the path was not absolute | ||
| } | ||
| if (isWindows && pathInAttribute.length() == 1) { // only '/', so list Windows Drives | ||
|
|
||
| Range replaceRange = adjustReplaceRange(xmlDocument, fullRange, subAttributeValue, "/"); | ||
|
|
||
| File[] drives = File.listRoots(); | ||
| for (File drive : drives) { | ||
| createFilePathCompletionItem(Paths.get("/"), drive, replaceRange, response, "/"); | ||
| } | ||
| return; | ||
| } | ||
| } | ||
| else { | ||
| if(isWindows && "/".equals(slash)) { // non-URI using forward slash in Windows | ||
| return; | ||
| } | ||
| } | ||
|
|
||
| // Get the normalized URI string from the parent directory file if necessary | ||
| String directoryOfFile = null; | ||
|
|
||
| if (!hasFileScheme) { //pathInAttribute is not a uri, so we might need to reference the directory path | ||
| String uriString = xmlDocument.getTextDocument().getUri(); | ||
| URI uri = URI.create(uriString); | ||
|
|
||
| if(!FILE_SCHEME.equals(uri.getScheme())) { | ||
| return; | ||
| } | ||
|
|
||
| String uriPathString = uri.getPath(); | ||
| if(!uriPathString.startsWith("/")) { | ||
| return; //file uri is incorrect | ||
| } | ||
| int lastSlash = uriPathString.lastIndexOf("/"); | ||
| if(lastSlash > -1) { | ||
| directoryOfFile = uriPathString.substring(0, lastSlash); | ||
|
|
||
| if(isWindows) { | ||
| // Necessary to that this path is readable in Windows | ||
| directoryOfFile = cleanPathForWindows(directoryOfFile); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| //Try to get an correctly formatted path from the given values | ||
| Path validAttributeValuePath = getNormalizedPath(directoryOfFile, pathInAttribute); | ||
|
|
||
| if(validAttributeValuePath == null) { | ||
| return; | ||
| } | ||
|
|
||
| //Get adjusted range for the completion item (insert at end, or overwrite some existing text in the path) | ||
| Range replaceRange = adjustReplaceRange(xmlDocument, fullRange, subAttributeValue, slash); | ||
|
|
||
| createNextValidCompletionPaths(validAttributeValuePath, slash, replaceRange, response, null); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a Range that covers trailing content after a slash, or | ||
| * if it already ends with a slash then a Range right after it. | ||
| * @param xmlDocument | ||
| * @param fullRange | ||
| * @param attributeValue | ||
| * @param slash | ||
| * @return | ||
| */ | ||
| private Range adjustReplaceRange(DOMDocument xmlDocument, Range fullRange, String attributeValue, String slash) { | ||
| //In the case the currently typed file/directory needs to be overwritten | ||
| Position replaceStart = null; | ||
| Position currentEnd = fullRange.getEnd(); | ||
|
|
||
| int startOffset; | ||
| try { | ||
| startOffset = xmlDocument.offsetAt(fullRange.getStart()); | ||
| } catch (BadLocationException e) { | ||
| return null; | ||
| } | ||
| int lastSlashIndex = attributeValue.lastIndexOf(slash); | ||
| if(lastSlashIndex > -1) { | ||
| try { | ||
| replaceStart = xmlDocument.positionAt(startOffset + lastSlashIndex); | ||
| } catch (BadLocationException e) { | ||
| return null; | ||
| } | ||
| } | ||
| Range replaceRange = new Range(); | ||
| if(replaceStart != null) { | ||
| replaceRange.setStart(replaceStart); | ||
| } | ||
| else { | ||
| replaceRange.setStart(currentEnd); | ||
| } | ||
| replaceRange.setEnd(currentEnd); | ||
|
|
||
| return replaceRange; | ||
| } | ||
|
|
||
| /** | ||
| * Creates the completion items based off the given absolute path | ||
| * @param pathToAttributeDirectory | ||
| * @param attributePath | ||
| * @param replaceRange | ||
| * @param response | ||
| * @param filter | ||
| */ | ||
| private void createNextValidCompletionPaths(Path pathToAttributeDirectory, String slash, Range replaceRange, ICompletionResponse response, | ||
| FilenameFilter filter) { | ||
|
|
||
| File[] proposedFiles = gatherFiles(pathToAttributeDirectory, filter); | ||
| if (proposedFiles != null) { | ||
| for (File child : proposedFiles) { | ||
| if (child != null) { | ||
| createFilePathCompletionItem(pathToAttributeDirectory, child, replaceRange, response, slash); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Returns a list of File objects that are in the given directory | ||
| * @param pathOfDirectory | ||
| * @param filter | ||
| * @return | ||
| */ | ||
| private File[] gatherFiles(Path pathOfDirectory, FilenameFilter filter) { | ||
|
|
||
| File f = new File(pathOfDirectory.toString()); | ||
| if(f.isDirectory()) { | ||
| return f.listFiles(filter); | ||
| } | ||
| return null; | ||
| } | ||
|
|
||
| private void createFilePathCompletionItem(Path pathOfDirectory, File f, Range replaceRange, ICompletionResponse response, String slash) { | ||
| CompletionItem item = new CompletionItem(); | ||
| String fName = f.getName(); | ||
| if(isWindows && fName.isEmpty()) { // Edge case for Windows drive letter | ||
| fName = f.getPath(); | ||
| fName = fName.substring(0, fName.length() - 1); | ||
| } | ||
| String insertText; | ||
| insertText = slash + fName; | ||
| item.setLabel(insertText); | ||
|
|
||
| CompletionItemKind kind = f.isDirectory()? CompletionItemKind.Folder : CompletionItemKind.File; | ||
| item.setKind(kind); | ||
|
|
||
| item.setSortText(CompletionSortTextHelper.getSortText(kind)); | ||
| item.setFilterText(insertText); | ||
| item.setTextEdit(new TextEdit(replaceRange, insertText)); | ||
| response.addCompletionItem(item); | ||
| } | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| } |
Oops, something went wrong.