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.
Modifying schema validation messages
Fixes eclipse-lemminx#181 Signed-off-by: Nikolas <nikolaskomonen@gmail.com>
- Loading branch information
1 parent
39f9420
commit 5fdd264
Showing
10 changed files
with
622 additions
and
11 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
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
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
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
260 changes: 260 additions & 0 deletions
260
...rc/main/java/org/eclipse/lsp4xml/services/extensions/diagnostics/LSPMessageFormatter.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,260 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.eclipse.lsp4xml.services.extensions.diagnostics; | ||
|
|
||
| import java.util.Locale; | ||
| import java.util.MissingResourceException; | ||
| import java.util.ResourceBundle; | ||
| import java.util.regex.Matcher; | ||
| import java.util.regex.Pattern; | ||
|
|
||
| import org.apache.xerces.util.MessageFormatter; | ||
|
|
||
| import org.eclipse.lsp4xml.dom.parser.MultiLineStream; | ||
| import org.eclipse.lsp4xml.extensions.contentmodel.participants.XMLSchemaErrorCode; | ||
|
|
||
| import static org.eclipse.lsp4xml.dom.parser.Constants.*; | ||
|
|
||
| /** | ||
| * SchemaMessageProvider implements an XMLMessageProvider that provides | ||
| * localizable error messages for the W3C XML Schema Language | ||
| * | ||
| * @xerces.internal | ||
| * | ||
| * @author Elena Litani, IBM | ||
| * @version $Id: XSMessageFormatter.java 813087 2009-09-09 19:35:27Z mrglavas $ | ||
| */ | ||
| public class LSPMessageFormatter implements MessageFormatter { | ||
| /** | ||
| * The domain of messages concerning the XML Schema: Structures specification. | ||
| */ | ||
| public static final String SCHEMA_DOMAIN = "http://www.w3.org/TR/xml-schema-1"; | ||
|
|
||
| // private objects to cache the locale and resource bundle | ||
| private Locale fLocale = null; | ||
| private ResourceBundle fResourceBundle = null; | ||
|
|
||
| /** | ||
| * Formats a message with the specified arguments using the given locale | ||
| * information. | ||
| * | ||
| * @param locale The locale of the message. | ||
| * @param key The message key. | ||
| * @param arguments The message replacement text arguments. The order of the | ||
| * arguments must match that of the placeholders in the actual | ||
| * message. | ||
| * | ||
| * @return Returns the formatted message. | ||
| * | ||
| * @throws MissingResourceException Thrown if the message with the specified key | ||
| * cannot be found. | ||
| */ | ||
| public String formatMessage(Locale locale, String key, Object[] arguments) throws MissingResourceException { | ||
|
|
||
| if (locale == null) { | ||
| locale = Locale.getDefault(); | ||
| } | ||
| if (locale != fLocale) { | ||
| fResourceBundle = ResourceBundle.getBundle("XMLSchemaMessages", locale); // XMLSchemaMessages in | ||
| // src/main/resources | ||
| // memorize the most-recent locale | ||
| fLocale = locale; | ||
| } | ||
|
|
||
| String msg = fResourceBundle.getString(key); | ||
| if (arguments != null) { | ||
| try { | ||
| Object[] newArguments = reformatSchemaArguments(XMLSchemaErrorCode.get(key), arguments); | ||
| if (newArguments != null) { | ||
| arguments = newArguments; | ||
| } | ||
| msg = java.text.MessageFormat.format(msg, arguments); | ||
| } catch (Exception e) { | ||
| msg = fResourceBundle.getString("FormatFailed"); | ||
| msg += " " + fResourceBundle.getString(key); | ||
| } | ||
| } | ||
|
|
||
| if (msg == null) { | ||
| msg = fResourceBundle.getString("BadMessageKey"); | ||
| throw new MissingResourceException(msg, "XMLSchemaMessages", key); | ||
| } | ||
|
|
||
| return msg; | ||
| } | ||
|
|
||
| /** | ||
| * Modifies the schema message arguments to a cleaned down format | ||
| * | ||
| * @param code | ||
| * @param message | ||
| * @return | ||
| */ | ||
| public static Object[] reformatSchemaArguments(XMLSchemaErrorCode code, Object[] arguments) { | ||
|
|
||
| switch (code) { | ||
| case cvc_complex_type_2_4_a: | ||
| return cvc_2_4_a_solution(arguments); | ||
| case cvc_complex_type_2_4_b: | ||
| return cvc_2_4_b_solution(arguments); | ||
| case cvc_enumeration_valid: | ||
| return enumeration_valid_solution(arguments); | ||
| default: | ||
| return null; | ||
| } | ||
| } | ||
|
|
||
| private static String reformatElementNames(boolean hasNamespace, String names) { | ||
| StringBuilder sb = new StringBuilder(); | ||
|
|
||
| MultiLineStream stream = new MultiLineStream(names, 0); | ||
|
|
||
| while (!stream.eos()) { // } | ||
| stream.advance(1);// Consume ' ' or '{' if first item | ||
| if(hasNamespace) { | ||
| stream.advance(1); // Consume " | ||
| stream.advanceUntilAnyOfChars(_DQO, _SQO, _SIQ); // " | " | ' | ||
| stream.advance(2); // Consume quotation and':' | ||
| } | ||
| sb.append("\t\""); | ||
| while (stream.peekChar() != _CCB && stream.peekChar() != _CMA) { // } | , | ||
| sb.append(Character.toString((char) stream.peekChar())); | ||
| stream.advance(1); | ||
| } | ||
| sb.append("\"\n"); | ||
| //if (stream.peekChar() == _CMA) { | ||
| stream.advance(1); | ||
| //} | ||
| } | ||
| return sb.toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Reformats a string of format: | ||
| * "[name1, name2, name3]" | ||
| * @param names | ||
| * @return | ||
| */ | ||
| private static String reformatArrayElementNames(String names) { | ||
| StringBuilder sb = new StringBuilder(); | ||
|
|
||
| MultiLineStream stream = new MultiLineStream(names, 0); | ||
|
|
||
| while (!stream.eos()) { // ] | ||
| stream.advance(1);// Consume ' ' or '[' if first item | ||
| sb.append("\t\""); | ||
| while (stream.peekChar() != _CSB && stream.peekChar() != _CMA) { // ] | , | ||
| sb.append(Character.toString((char) stream.peekChar())); | ||
| stream.advance(1); | ||
| } | ||
| sb.append("\"\n"); | ||
| stream.advance(1); // Consume , or ] | ||
|
|
||
| } | ||
| return sb.toString(); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a pattern matcher looking | ||
| * for a string that matches the format of: | ||
| * "{"http://maven.apache.org/POM/4.0.0":propertiesa}" | ||
| * @param name | ||
| * @return | ||
| */ | ||
| private static Matcher getNamespaceMatcher(String name) { | ||
| Pattern namespacePattern = Pattern.compile("^\\{\"(.*)\":(.*)(\\}|,)"); | ||
| return namespacePattern.matcher(name); | ||
| } | ||
|
|
||
| private static boolean isNamespaceDefined(String name) { | ||
| Pattern namespacePattern = Pattern.compile("^\\{\"(.*)\":"); | ||
| return namespacePattern.matcher(name).matches(); | ||
| } | ||
|
|
||
| /** | ||
| * Parses the message for cvc.2.4.a and returns reformatted arguments | ||
| * | ||
| * With Namespace | ||
| * | ||
| * arguments[0]: {"http://maven.apache.org/POM/4.0.0":propertiesa} | ||
| * arguments[1]: {"http://maven.apache.org/POM/4.0.0":groupId, "http://maven.apache.org/POM/4.0.0":version} | ||
| * | ||
| * Without Namespace | ||
| * | ||
| * arguments[0]: propertiesa | ||
| * arguments[1]: {groupId, version} | ||
| * | ||
| * @param arguments | ||
| * @return | ||
| */ | ||
| private static Object[] cvc_2_4_a_solution(Object[] arguments) { | ||
| Matcher m = getNamespaceMatcher((String) arguments[0]); | ||
| String schema = null; | ||
| String name = null; | ||
| String validNames = null; | ||
|
|
||
| if (m.matches()) { | ||
| name = m.group(2); | ||
| schema = "{" + m.group(1) + "}"; | ||
| validNames = reformatElementNames(true, (String)arguments[1]); | ||
| } else { // No namespace, so just element name | ||
| name = (String) arguments[0]; | ||
| schema = "{the schema}"; | ||
| validNames = reformatElementNames(false, (String)arguments[1]); | ||
| } | ||
| return new Object[] { name, validNames, schema }; | ||
| } | ||
|
|
||
| /** | ||
| * Parses the message for cvc.2.4.b and returns reformatted arguments | ||
| * | ||
| * With Namespace | ||
| * | ||
| * arguments[0]: elementName | ||
| * arguments[1]: {"http://maven.apache.org/POM/4.0.0":groupId, "http://maven.apache.org/POM/4.0.0":version} | ||
| * | ||
| * Without Namespace | ||
| * | ||
| * arguments[0]: elementName | ||
| * arguments[1]: {groupId, version} | ||
| * | ||
| * @param arguments | ||
| * @return | ||
| */ | ||
| private static Object[] cvc_2_4_b_solution(Object[] arguments) { | ||
| Matcher m = getNamespaceMatcher((String) arguments[1]); | ||
|
|
||
| String element = null; | ||
| String missingChildElements = null; | ||
| String schema = null; | ||
|
|
||
| if (isNamespaceDefined((String) arguments[1])) { | ||
| element = m.group(2); | ||
| missingChildElements = reformatElementNames(true, (String)arguments[1]); | ||
| schema = "{" + m.group(1) + "}"; | ||
| } else { // No namespace, so just element name | ||
| element = (String) arguments[0]; | ||
| schema = "{the schema}"; | ||
| missingChildElements = reformatElementNames(false, (String)arguments[1]); | ||
| } | ||
| return new Object[] { element, missingChildElements , schema }; | ||
| } | ||
|
|
||
| public static Object[] enumeration_valid_solution(Object[] arguments) { | ||
| return new Object[] { (String) arguments[0], reformatArrayElementNames((String)arguments[1])}; | ||
| } | ||
| } |
Oops, something went wrong.