Add XMLProblems (see #218)

Author: angelozerr

org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/contentmodel/participants/diagnostics/XMLValidator.java

@@ -31,6 +31,7 @@
 import org.eclipse.lsp4xml.dom.Element;
 import org.eclipse.lsp4xml.dom.XMLDocument;
 import org.eclipse.lsp4xml.extensions.contentmodel.settings.ContentModelSettings;
+import org.eclipse.lsp4xml.extensions.contentmodel.settings.XMLProblems;
 import org.eclipse.lsp4xml.services.extensions.diagnostics.LSPContentHandler;
 import org.eclipse.lsp4xml.uriresolver.CacheResourceDownloadingException;
 import org.eclipse.lsp4xml.uriresolver.IExternalSchemaLocationProvider;
@@ -103,19 +104,18 @@ public static void doDiagnostics(XMLDocument document, XMLEntityResolver entityR
 	/**
 	 * Warn if XML document is not bound to a grammar according the settings
 	 * 
-	 * @param document             the XML document
-	 * @param diagnostics          the diagnostics list to populate
-	 * @param contentModelSettings the settings to use to know the severity of warn.
+	 * @param document    the XML document
+	 * @param diagnostics the diagnostics list to populate
+	 * @param settings    the settings to use to know the severity of warn.
 	 */
 	private static void warnNoGrammar(XMLDocument document, List<Diagnostic> diagnostics,
-			ContentModelSettings contentModelSettings) {
+			ContentModelSettings settings) {
 		boolean hasGrammar = document.hasGrammar();
 		if (hasGrammar) {
 			return;
 		}
 		// By default "hint" settings.
-		DiagnosticSeverity severity = contentModelSettings != null ? contentModelSettings.getNoGrammarSeverity()
-				: DiagnosticSeverity.Hint;
+		DiagnosticSeverity severity = XMLProblems.getNoGrammarSeverity(settings);
 		if (severity == null) {
 			// "ignore" settings
 			return;

org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/contentmodel/settings/ContentModelSettings.java

@@ -10,7 +10,6 @@
  */
 package org.eclipse.lsp4xml.extensions.contentmodel.settings;
 
-import org.eclipse.lsp4j.DiagnosticSeverity;
 import org.eclipse.lsp4xml.utils.JSONUtility;
 
 /**
@@ -23,7 +22,7 @@ public class ContentModelSettings {
 
 	private String[] catalogs;
 
-	private String warnNoGrammar;
+	private XMLProblems problems;
 
 	private XMLFileAssociation[] fileAssociations;
 
@@ -81,28 +80,16 @@ public XMLFileAssociation[] getFileAssociations() {
 		return fileAssociations;
 	}
 
-	public static ContentModelSettings getSettings(Object initializationOptionsSettings) {
-		return JSONUtility.toModel(initializationOptionsSettings, ContentModelSettings.class);
+	public XMLProblems getProblems() {
+		return problems;
 	}
 
-	public void setWarnNoGrammar(String warnNoGrammar) {
-		this.warnNoGrammar = warnNoGrammar;
+	public void setProblems(XMLProblems problems) {
+		this.problems = problems;
 	}
 
-	public String getWarnNoGrammar() {
-		return warnNoGrammar;
+	public static ContentModelSettings getSettings(Object initializationOptionsSettings) {
+		return JSONUtility.toModel(initializationOptionsSettings, ContentModelSettings.class);
 	}
 
-	public DiagnosticSeverity getNoGrammarSeverity() {
-		if ("ignore".equalsIgnoreCase(warnNoGrammar)) {
-			return null;
-		} else if ("info".equalsIgnoreCase(warnNoGrammar)) {
-			return DiagnosticSeverity.Information;
-		} else if ("warning".equalsIgnoreCase(warnNoGrammar)) {
-			return DiagnosticSeverity.Warning;
-		} else if ("error".equalsIgnoreCase(warnNoGrammar)) {
-			return DiagnosticSeverity.Error;
-		}
-		return DiagnosticSeverity.Hint;
-	}
 }

org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/extensions/contentmodel/settings/XMLProblems.java

@@ -0,0 +1,64 @@
+/**
+ *  Copyright (c) 2018 Angelo ZERR
+ *  All rights reserved. This program and the accompanying materials
+ *  are made available under the terms of the Eclipse Public License v1.0
+ *  which accompanies this distribution, and is available at
+ *  http://www.eclipse.org/legal/epl-v10.html
+ *
+ *  Contributors:
+ *  Angelo Zerr <angelo.zerr@gmail.com> - initial API and implementation
+ */
+package org.eclipse.lsp4xml.extensions.contentmodel.settings;
+
+import org.eclipse.lsp4j.DiagnosticSeverity;
+
+/**
+ * XML problems settings.
+ *
+ */
+public class XMLProblems {
+
+	/**
+	 * This severity preference to mark the root element of XML document which is
+	 * not bound to a XML Schema/DTD.
+	 * 
+	 * Values are {ignore, hint, info, warning, error}
+	 */
+	private String noGrammar;
+
+	public void setNoGrammar(String noGrammar) {
+		this.noGrammar = noGrammar;
+	}
+
+	public String getNoGrammar() {
+		return noGrammar;
+	}
+
+	/**
+	 * Returns the <code>noGrammar</code> severity according the given settings and
+	 * {@link DiagnosticSeverity#Hint} otherwise.
+	 * 
+	 * @param settings the settings
+	 * @return the <code>noGrammar</code> severity according the given settings and
+	 *         {@link DiagnosticSeverity#Hint} otherwise.
+	 */
+	public static DiagnosticSeverity getNoGrammarSeverity(ContentModelSettings settings) {
+		DiagnosticSeverity defaultSeverity = DiagnosticSeverity.Hint;
+		if (settings == null || settings.getProblems() == null) {
+			return defaultSeverity;
+		}
+		XMLProblems problems = settings.getProblems();
+		String noGrammar = problems.getNoGrammar();
+		if ("ignore".equalsIgnoreCase(noGrammar)) {
+			// Ignore "noGrammar", return null.
+			return null;
+		} else if ("info".equalsIgnoreCase(noGrammar)) {
+			return DiagnosticSeverity.Information;
+		} else if ("warning".equalsIgnoreCase(noGrammar)) {
+			return DiagnosticSeverity.Warning;
+		} else if ("error".equalsIgnoreCase(noGrammar)) {
+			return DiagnosticSeverity.Error;
+		}
+		return defaultSeverity;
+	}
+}

org.eclipse.lsp4xml/src/test/java/org/eclipse/lsp4xml/XMLAssert.java

@@ -42,6 +42,7 @@
 import org.eclipse.lsp4xml.dom.XMLDocument;
 import org.eclipse.lsp4xml.dom.XMLParser;
 import org.eclipse.lsp4xml.extensions.contentmodel.settings.ContentModelSettings;
+import org.eclipse.lsp4xml.extensions.contentmodel.settings.XMLProblems;
 import org.eclipse.lsp4xml.services.XMLLanguageService;
 import org.eclipse.lsp4xml.services.extensions.CompletionSettings;
 import org.eclipse.lsp4xml.services.extensions.diagnostics.IXMLErrorCode;
@@ -234,7 +235,9 @@ public static void testDiagnosticsFor(String xml, String catalogPath, Consumer<X
 
 		ContentModelSettings settings = new ContentModelSettings();
 		settings.setUseCache(false);
-		settings.setWarnNoGrammar("ignore");
+		XMLProblems problems = new XMLProblems();
+		problems.setNoGrammar("ignore");
+		settings.setProblems(problems);
 		if (catalogPath != null) {
 			// Configure XML catalog for XML schema
 			settings.setCatalogs(new String[] { catalogPath });