Bind XSD, DTD with CodeLens

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/XMLWorkspaceService.java

@@ -63,7 +63,7 @@ public CompletableFuture<Object> executeCommand(ExecuteCommandParams params) {
  }
  return CompletableFutures.computeAsync(cancelChecker -> {
  try {
- return handler.executeCommand(params, cancelChecker);
+ return handler.executeCommand(params, xmlLanguageServer.getSharedSettings(), cancelChecker);
  } catch (Exception e) {
  if (e instanceof ResponseErrorException) {
  throw (ResponseErrorException) e;

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/client/ClientCommands.java

@@ -28,10 +28,14 @@ private ClientCommands() {
  public static final String SHOW_REFERENCES = "xml.show.references";
 
  /**
- * Open settings command.
- * This custom command is sent to the client in order to have the client
- * open its settings UI.
+ * Open settings command. This custom command is sent to the client in order to
+ * have the client open its settings UI.
  */
  public static final String OPEN_SETTINGS = "xml.open.settings";
 
+ /**
+ * Select file command.
+ */
+ public static final String SELECT_FILE = "xml.select.file";
+
 }

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/client/CodeLensKind.java

@@ -26,4 +26,6 @@ private CodeLensKind() {
  public static final String References = "references";
 
  public static final String Implementations = "implementations";
+
+ public static final String Association = "association";
 }

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/commons/CodeActionFactory.java

@@ -85,10 +85,18 @@ public static CodeAction insert(String title, Position position, String insertTe
  * @return the text edit to insert a new content at the end of the given range.
  */
  public static TextDocumentEdit insertEdit(String insertText, Position position, TextDocumentItem document) {
- TextEdit edit = new TextEdit(new Range(position, position), insertText);
+ TextEdit edit = insertEdit(insertText, position);
+ return insertEdits(document, Collections.singletonList(edit));
+ }
+
+ public static TextEdit insertEdit(String insertText, Position position) {
+ return new TextEdit(new Range(position, position), insertText);
+ }
+
+ public static TextDocumentEdit insertEdits(TextDocumentItem document, List<TextEdit> edits) {
  VersionedTextDocumentIdentifier versionedTextDocumentIdentifier = new VersionedTextDocumentIdentifier(
  document.getUri(), document.getVersion());
- return new TextDocumentEdit(versionedTextDocumentIdentifier, Collections.singletonList(edit));
+ return new TextDocumentEdit(versionedTextDocumentIdentifier, edits);
  }
 
  public static CodeAction replace(String title, Range range, String replaceText, TextDocumentItem document,

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/ContentModelPlugin.java

@@ -15,10 +15,12 @@
 import java.util.Objects;
 
 import org.eclipse.lemminx.dom.DOMDocument;
+import org.eclipse.lemminx.extensions.contentmodel.commands.AssociateGrammarCommand;
 import org.eclipse.lemminx.extensions.contentmodel.commands.XMLValidationAllFilesCommand;
 import org.eclipse.lemminx.extensions.contentmodel.commands.XMLValidationFileCommand;
 import org.eclipse.lemminx.extensions.contentmodel.model.ContentModelManager;
 import org.eclipse.lemminx.extensions.contentmodel.participants.ContentModelCodeActionParticipant;
+import org.eclipse.lemminx.extensions.contentmodel.participants.ContentModelCodeLensParticipant;
 import org.eclipse.lemminx.extensions.contentmodel.participants.ContentModelCompletionParticipant;
 import org.eclipse.lemminx.extensions.contentmodel.participants.ContentModelDocumentLinkParticipant;
 import org.eclipse.lemminx.extensions.contentmodel.participants.ContentModelHoverParticipant;
@@ -36,6 +38,7 @@
 import org.eclipse.lemminx.services.extensions.ITypeDefinitionParticipant;
 import org.eclipse.lemminx.services.extensions.IXMLExtension;
 import org.eclipse.lemminx.services.extensions.XMLExtensionsRegistry;
+import org.eclipse.lemminx.services.extensions.codelens.ICodeLensParticipant;
 import org.eclipse.lemminx.services.extensions.commands.IXMLCommandService;
 import org.eclipse.lemminx.services.extensions.diagnostics.IDiagnosticsParticipant;
 import org.eclipse.lemminx.services.extensions.save.ISaveContext;
@@ -68,6 +71,8 @@ public class ContentModelPlugin implements IXMLExtension {
 
  private ContentModelSymbolsProviderParticipant symbolsProviderParticipant;
 
+ private final ICodeLensParticipant codeLensParticipant;
+
  ContentModelManager contentModelManager;
 
  private ContentModelSettings cmSettings;
@@ -80,6 +85,7 @@ public ContentModelPlugin() {
  diagnosticsParticipant = new ContentModelDiagnosticsParticipant(this);
  codeActionParticipant = new ContentModelCodeActionParticipant();
  typeDefinitionParticipant = new ContentModelTypeDefinitionParticipant();
+ codeLensParticipant = new ContentModelCodeLensParticipant();
  }
 
  @Override
@@ -176,6 +182,7 @@ public void start(InitializeParams params, XMLExtensionsRegistry registry) {
  registry.registerTypeDefinitionParticipant(typeDefinitionParticipant);
  symbolsProviderParticipant = new ContentModelSymbolsProviderParticipant(contentModelManager);
  registry.registerSymbolsProviderParticipant(symbolsProviderParticipant);
+ registry.registerCodeLensParticipant(codeLensParticipant);
 
  // Register custom commands to re-validate XML files
  IXMLCommandService commandService = registry.getCommandService();
@@ -186,6 +193,8 @@ public void start(InitializeParams params, XMLExtensionsRegistry registry) {
  new XMLValidationFileCommand(contentModelManager, documentProvider, validationService));
  commandService.registerCommand(XMLValidationAllFilesCommand.COMMAND_ID,
  new XMLValidationAllFilesCommand(contentModelManager, documentProvider, validationService));
+ commandService.registerCommand(AssociateGrammarCommand.COMMAND_ID,
+ new AssociateGrammarCommand(documentProvider));
  }
  }
 
@@ -198,12 +207,14 @@ public void stop(XMLExtensionsRegistry registry) {
  registry.unregisterDocumentLinkParticipant(documentLinkParticipant);
  registry.unregisterTypeDefinitionParticipant(typeDefinitionParticipant);
  registry.unregisterSymbolsProviderParticipant(symbolsProviderParticipant);
+ registry.unregisterCodeLensParticipant(codeLensParticipant);
 
  // Un-register custom commands to re-validate XML files
  IXMLCommandService commandService = registry.getCommandService();
  if (commandService != null) {
  commandService.unregisterCommand(XMLValidationFileCommand.COMMAND_ID);
  commandService.unregisterCommand(XMLValidationAllFilesCommand.COMMAND_ID);
+ commandService.unregisterCommand(AssociateGrammarCommand.COMMAND_ID);
  }
  }
 

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/commands/AssociateGrammarCommand.java

@@ -0,0 +1,177 @@
+/*******************************************************************************
+* Copyright (c) 2021 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
+*
+* SPDX-License-Identifier: EPL-2.0
+*
+* Contributors:
+* Red Hat Inc. - initial API and implementation
+*******************************************************************************/
+package org.eclipse.lemminx.extensions.contentmodel.commands;
+
+import static org.eclipse.lemminx.extensions.xsd.utils.XSDUtils.TARGET_NAMESPACE_ATTR;
+
+import java.net.URL;
+import java.nio.file.Path;
+import java.text.MessageFormat;
+import java.util.stream.Collectors;
+import java.util.stream.Stream;
+
+import javax.xml.parsers.SAXParser;
+import javax.xml.parsers.SAXParserFactory;
+
+import org.eclipse.lemminx.dom.DOMDocument;
+import org.eclipse.lemminx.extensions.contentmodel.participants.codeactions.NoGrammarConstraintsCodeAction;
+import org.eclipse.lemminx.services.IXMLDocumentProvider;
+import org.eclipse.lemminx.services.extensions.commands.AbstractDOMDocumentCommandHandler;
+import org.eclipse.lemminx.services.extensions.commands.ArgumentsUtils;
+import org.eclipse.lemminx.settings.SharedSettings;
+import org.eclipse.lemminx.utils.DOMUtils;
+import org.eclipse.lemminx.utils.FilesUtils;
+import org.eclipse.lemminx.utils.StringUtils;
+import org.eclipse.lsp4j.ExecuteCommandParams;
+import org.eclipse.lsp4j.jsonrpc.CancelChecker;
+import org.xml.sax.Attributes;
+import org.xml.sax.SAXException;
+import org.xml.sax.helpers.DefaultHandler;
+
+/**
+ * XML Command "xml.associate.grammar.insert" to associate a grammar to a given
+ * DOM document.
+ * 
+ * The command parameters {@link ExecuteCommandParams} must be filled with 3
+ * parameters:
+ * 
+ * <ul>
+ * <li>document URI (String) : the DOM document file URI to bind with a grammar.
+ * </li>
+ * <li>grammar URI (String) : the XSD, DTD file URI to bind with the DOM
+ * document.</li>
+ * <li>binding type (String) : which can takes values "xsd", "dtd", "xml-model"
+ * to know which binding type must be inserted in the DOM document.</li>
+ * </ul>
+ * 
+ * @author Angelo ZERR
+ *
+ */
+public class AssociateGrammarCommand extends AbstractDOMDocumentCommandHandler {
+
+ public static final String COMMAND_ID = "xml.associate.grammar.insert";
+
+ public AssociateGrammarCommand(IXMLDocumentProvider documentProvider) {
+ super(documentProvider);
+ }
+
+ public enum GrammarBindingType {
+
+ XSD("xsd"), //
+ DTD("dtd"), //
+ XML_MODEL("xml-model");
+
+ private String name;
+
+ private GrammarBindingType(String name) {
+ this.name = name != null ? name : name();
+ }
+
+ public String getName() {
+ return name;
+ }
+ }
+
+ @SuppressWarnings({ "serial" })
+ public static class UnknownBindingTypeException extends Exception {
+
+ private final static String MESSAGE = "Unknown binding type ''{0}''. Allowed values are " + //
+ Stream.of(GrammarBindingType.values()) //
+ .map(GrammarBindingType::getName) //
+ .collect(Collectors.joining(", ", "[", "]"));
+
+ public UnknownBindingTypeException(String bindingType) {
+ super(MessageFormat.format(MESSAGE, bindingType));
+ }
+
+ }
+
+ @Override
+ protected Object executeCommand(DOMDocument document, ExecuteCommandParams params, SharedSettings sharedSettings,
+ CancelChecker cancelChecker) throws Exception {
+ String documentURI = document.getDocumentURI();
+ String fullPathGrammarURI = ArgumentsUtils.getArgAt(params, 1, String.class);
+ String bindingType = ArgumentsUtils.getArgAt(params, 2, String.class);
+ String grammarURI = getRelativeURI(fullPathGrammarURI, documentURI);
+
+ if (GrammarBindingType.XSD.getName().equals(bindingType)) {
+ // Check if XSD to bind declares a target namespace
+ String targetNamespace = getTargetNamespace(fullPathGrammarURI);
+ if (StringUtils.isEmpty(targetNamespace)) {
+ // Insert inside <foo /> ->
+ // xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance"
+ // xsi:noNamespaceSchemaLocation=\"xsd/tag.xsd\"
+ return NoGrammarConstraintsCodeAction.createXSINoNamespaceSchemaLocationEdit(grammarURI, document);
+ }
+ // Insert inside <foo /> ->
+ // xmlns="team_namespace"
+ // xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ // xsi:schemaLocation="team_namespace xsd/team.xsd"
+ return NoGrammarConstraintsCodeAction.createXSISchemaLocationEdit(grammarURI, targetNamespace, document);
+ } else if (GrammarBindingType.DTD.getName().equals(bindingType)) {
+ // Insert before <foo /> -> <!DOCTYPE foo SYSTEM "dtd/tag.dtd">
+ return NoGrammarConstraintsCodeAction.createDocTypeEdit(grammarURI, document, sharedSettings);
+ } else if (GrammarBindingType.XML_MODEL.getName().equals(bindingType)) {
+ String targetNamespace = DOMUtils.isXSD(fullPathGrammarURI) ? getTargetNamespace(fullPathGrammarURI) : null;
+ // Insert before <foo /> -> <?xml-model href=\"dtd/tag.dtd\"?>
+ return NoGrammarConstraintsCodeAction.createXmlModelEdit(grammarURI, targetNamespace, document,
+ sharedSettings);
+ }
+ throw new UnknownBindingTypeException(bindingType);
+ }
+
+ private static String getRelativeURI(String fullPathGrammarURI, String documentURI) {
+ try {
+ Path grammarPath = FilesUtils.getPath(fullPathGrammarURI);
+ Path documentPath = FilesUtils.getPath(documentURI);
+ Path relativePath = documentPath.getParent().relativize(grammarPath);
+ return relativePath.toString().replaceAll("\\\\", "/");
+ } catch (Exception e) {
+ return fullPathGrammarURI;
+ }
+ }
+
+ private static String getTargetNamespace(String xsdURI) {
+ TargetNamespaceHandler handler = new TargetNamespaceHandler();
+ try {
+ SAXParserFactory factory = SAXParserFactory.newInstance();
+ SAXParser saxParser = factory.newSAXParser();
+ saxParser.parse(new URL(xsdURI).openStream(), handler);
+ } catch (Exception e) {
+
+ }
+ return handler.getTargetNamespace();
+ }
+
+ /**
+ * SAX handler which extract the targetNamespace attribute from the xs:schema
+ * root tag element and null otherwise.
+ *
+ */
+ private static class TargetNamespaceHandler extends DefaultHandler {
+
+ private String targetNamespace;
+
+ @Override
+ public void startElement(String uri, String localName, String qName, Attributes attributes)
+ throws SAXException {
+ super.startElement(uri, localName, qName, attributes);
+ this.targetNamespace = attributes.getValue(TARGET_NAMESPACE_ATTR);
+ throw new SAXException();
+ }
+
+ public String getTargetNamespace() {
+ return targetNamespace;
+ }
+ }
+
+}

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/commands/XMLValidationAllFilesCommand.java

@@ -18,11 +18,13 @@
 import org.eclipse.lemminx.services.IXMLDocumentProvider;
 import org.eclipse.lemminx.services.IXMLValidationService;
 import org.eclipse.lemminx.services.extensions.commands.IXMLCommandService.IDelegateCommandHandler;
+import org.eclipse.lemminx.settings.SharedSettings;
 import org.eclipse.lsp4j.ExecuteCommandParams;
 import org.eclipse.lsp4j.jsonrpc.CancelChecker;
 
 /**
- * XML Command to revalidate all opened XML files which means:
+ * XML Command "xml.validation.all.files" to revalidate all opened XML files
+ * which means:
  * 
  * <ul>
  * <li>clear the Xerces grammar pool (used by the Xerces validation) and the
@@ -52,7 +54,8 @@ public XMLValidationAllFilesCommand(ContentModelManager contentModelManager, IXM
  }
 
  @Override
- public Object executeCommand(ExecuteCommandParams params, CancelChecker cancelChecker) throws Exception {
+ public Object executeCommand(ExecuteCommandParams params, SharedSettings sharedSettings,
+ CancelChecker cancelChecker) throws Exception {
  // 1. clear the Xerces grammar pool
  // (used by the Xerces validation) and the content model documents cache (used
  // by the XML completion/hover based on the grammar)

org.eclipse.lemminx/src/main/java/org/eclipse/lemminx/extensions/contentmodel/commands/XMLValidationFileCommand.java

@@ -16,11 +16,13 @@
 import org.eclipse.lemminx.services.IXMLDocumentProvider;
 import org.eclipse.lemminx.services.IXMLValidationService;
 import org.eclipse.lemminx.services.extensions.commands.AbstractDOMDocumentCommandHandler;
+import org.eclipse.lemminx.settings.SharedSettings;
 import org.eclipse.lsp4j.ExecuteCommandParams;
 import org.eclipse.lsp4j.jsonrpc.CancelChecker;
 
 /**
- * XML Command to revalidate a give XML file which means:
+ * XML Command "xml.validation.current.file" to revalidate a give XML file which
+ * means:
  * 
  * <ul>
  * <li>remove the referenced grammar in the XML file from the Xerces grammar
@@ -48,8 +50,8 @@ public XMLValidationFileCommand(ContentModelManager contentModelManager, IXMLDoc
  }
 
  @Override
- protected Object executeCommand(DOMDocument document, ExecuteCommandParams params, CancelChecker cancelChecker)
- throws Exception {
+ protected Object executeCommand(DOMDocument document, ExecuteCommandParams params, SharedSettings sharedSettings,
+ CancelChecker cancelChecker) throws Exception {
  // 1. remove the referenced grammar in the XML file from the Xerces grammar pool
  // (used by the Xerces validation) and the content model documents cache (used
  // by the XML completion/hover based on the grammar)