You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sis.apache.org by de...@apache.org on 2013/09/18 18:56:03 UTC
svn commit: r1524488 -
/sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
Author: desruisseaux
Date: Wed Sep 18 16:56:02 2013
New Revision: 1524488
URL: http://svn.apache.org/r1524488
Log:
Use italic for single letter variable in math expressions.
Modified:
sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
Modified: sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java
URL: http://svn.apache.org/viewvc/sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java?rev=1524488&r1=1524487&r2=1524488&view=diff
==============================================================================
--- sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java [UTF-8] (original)
+++ sis/branches/JDK7/core/sis-build-helper/src/main/java/org/apache/sis/internal/taglet/Preformat.java [UTF-8] Wed Sep 18 16:56:02 2013
@@ -24,7 +24,8 @@ import com.sun.tools.doclets.formats.htm
/**
* The <code>@preformat</code> tag for inserting a pre-formatted code in a javadoc comment.
- * The first word after the tag must be the format name ("java", "math", "wkt" or "text").
+ * The first word after the tag must be the format name ("java", "math", "wkt", "xml", "sql",
+ * "shell" or "text").
* The remaining is the text to format.
*
* <p>This taglet will automatically replace {@code &}, {@code <} and {@code >} by their HTML entities.
@@ -38,6 +39,15 @@ import com.sun.tools.doclets.formats.htm
*/
public final class Preformat extends InlineTaglet {
/**
+ * The set of legal words after {@code preformat}. We write them in lower-cases even if this is not
+ * conform to the Java convention for enumeration constants, because we will use {@link Enum#name()}
+ * for getting the string to look for after {@code preformat}.
+ */
+ private static enum Style {
+ java, math, wkt, xml, sql, shell, text
+ }
+
+ /**
* Special characters to replace by HTML entities.
*/
private static final String[] SPECIAL_CHARS = new String[] {
@@ -104,14 +114,12 @@ public final class Preformat extends Inl
break;
}
}
- final boolean java = format.equals("java");
- final boolean math = format.equals("math");
- final boolean wkt = format.equals("wkt");
- final boolean xml = format.equals("xml");
- final boolean sql = format.equals("sql");
- final boolean shell = format.equals("shell");
- if (!java && !math && !wkt && !xml && !sql && !shell && !format.equals("text")) {
+ Style style;
+ try {
+ style = Style.valueOf(format);
+ } catch (IllegalArgumentException e) {
ConfigurationImpl.getInstance().root.printWarning(tag.position(), "Unknown format: " + format);
+ style = Style.text;
}
/*
* Counts the minimal amount of spaces in the margin.
@@ -150,9 +158,9 @@ all: while (tk.hasMoreTokens()) {
for (int i=0; i<SPECIAL_CHARS.length;) {
line = line.replace(SPECIAL_CHARS[i++], SPECIAL_CHARS[i++]);
}
- if (java) {
- colorJava(line, buffer);
- continue;
+ switch (style) {
+ case java: colorJava(line, buffer); continue;
+ case math: styleMath(line, buffer); continue;
}
}
buffer.append(line);
@@ -235,6 +243,26 @@ all: while (tk.hasMoreTokens()) {
}
/**
+ * Adds italic on variables in a math formulas.
+ * We will put in italic only the single latin letters.
+ */
+ private static void styleMath(final String line, final StringBuilder buffer) {
+ final int length = line.length();
+ for (int i=0; i<length; i++) {
+ final char c = line.charAt(i);
+ if ((c >= 'A' && c <= 'Z') || (c >= 'a' && c <= 'z')) {
+ if ((i == 0 || !Character.isLetterOrDigit(line.codePointBefore(i))) &&
+ (i+1 >= length || !Character.isLetterOrDigit(line.codePointAt(i+1))))
+ {
+ buffer.append("<var>").append(c).append("</var>");
+ continue;
+ }
+ }
+ buffer.append(c);
+ }
+ }
+
+ /**
* Removes the leading and trailing linefeeds (but not other kind of spaces).
*/
private static String trim(final String line) {