Merge pull request #6 from Saxonica/character-escapes

Output strings with \U escapes for non-ASCII characters

Author: ndw

README.md

@@ -117,3 +117,7 @@ Much of the output is the result of experimentation and exploring the
 Javadoc APIs. If you discover that xmldoclet produces output that
 doesn’t conform to the schema, or if you think that the output is
 incomplete or incorrect, please [open an issue](https://github.com/Saxonica/xmldoclet/issues).
+
+## Change log
+
+* **0.5.0** String constants now use “backslash-U” escapes for non-ASCII characters.

gradle.properties

@@ -1,4 +1,4 @@
-docletVersion=0.4.0
-schemaVersion=0.4.0
+docletVersion=0.5.0
+schemaVersion=0.5.0
 docletTitle=XmlDoclet
 docletName=xmldoclet

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.2.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.1-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

sample/src/main/java/org/example/AbstractClass.java

@@ -0,0 +1,4 @@
+package org.example;
+
+abstract public class AbstractClass implements TestInterface {
+}

sample/src/main/java/org/example/Implementation.java

@@ -0,0 +1,13 @@
+package org.example;
+
+public class Implementation extends AbstractClass {
+    @Override
+    public void foo() {
+        // nop
+    }
+
+    @Override
+    public void bar() {
+        // nop
+    }
+}

sample/src/main/java/org/example/Sample.java

@@ -12,6 +12,11 @@
  * @author <a href="mailto:[email protected]">Norm Tovey-Walsh</a>
  */
 public class Sample {
+    protected static final String cyrillicLower =
+            "\u0430\u0431\u0432\u0433\u0434\u0435\u0436\u0437\u0438" +
+                    "\u043a\u043b\u043c\u043d\u043e\u043f\u0440\u0441\u0441\u0443" +
+                    "\u0444\u0445\u0446\u0447\u0448\u0449\u044b\u044d\u044e\u044f";
+
     public static void main(String[] args) {
         SampleRuntime runtime = new SampleRuntime();
         runtime.run();

sample/src/main/java/org/example/TestClass.java

@@ -92,7 +92,7 @@ public void foo(Class<? extends Object> spoon) {
      * @see <a href="https://example.org">Example.org</a>
      * @param spoon the string {@link com.sun.source.doctree.DocTree}
      * @throws IllegalAccessError when something goes wrong
-     * @throws NullPointerException: this is an error. No colon is allowed in the exception name.
+     * @throws NullPointerException this is an error. No colon is allowed in the exception name.
      * @see jdk.javadoc.doclet.Doclet#init(Locale, Reporter)
      * @see net.sf.saxon.s9api.Processor#getConfigurationProperty(Feature)
      * @return something

xmldoclet/src/main/java/com/saxonica/xmldoclet/scanners/XmlVariableElement.java

@@ -1,7 +1,7 @@
 package com.saxonica.xmldoclet.scanners;
 
-import com.saxonica.xmldoclet.utils.TypeUtils;
 import com.saxonica.xmldoclet.builder.XmlProcessor;
+import com.saxonica.xmldoclet.utils.TypeUtils;
 import com.sun.source.doctree.DocCommentTree;
 import com.sun.source.doctree.DocTree;
 import com.sun.source.doctree.ParamTree;
@@ -36,7 +36,21 @@ public void scan(DocTree tree) {
                     attr.put("value", element.getConstantValue().toString());
                 }
             } else {
-                attr.put("value", element.getConstantValue().toString());
+                StringBuilder sb = new StringBuilder();
+                String value = element.getConstantValue().toString();
+                int offset = 0;
+                int length = value.length();
+                while (offset < length) {
+                    char cur = value.charAt(offset);
+                    if (cur < ' ' || cur > 0x7f) {
+                        sb.append(String.format("\\u%04x", (int) cur));
+                    } else {
+                        sb.append(cur);
+                    }
+                    offset += Character.charCount(cur);
+                }
+
+                attr.put("value", sb.toString());
             }
         }