Simplify ShXref by extending JFlexXrefSimple

... Avoids no-class <span> elements but otherwise
keeps the Sh-specific extra styleStack.

Author: idodeclare

src/org/opensolaris/opengrok/analysis/JFlexXref.java

@@ -420,6 +420,15 @@ public void disjointSpan(String className) throws IOException {
         disjointSpanClassName = className;
     }
 
+    /**
+     * Gets the argument from the last call to
+     * {@link #disjointSpan(java.lang.String)}.
+     * @return a defined value or null
+     */
+    public String getDisjointSpanClassName() {
+        return disjointSpanClassName;
+    }
+
     /**
      * Write xref to the specified {@code Writer}.
      *

src/org/opensolaris/opengrok/analysis/sh/ShSymbolTokenizer.lex

@@ -23,8 +23,7 @@
  */
 
 package org.opensolaris.opengrok.analysis.sh;
-import java.io.IOException;
-import java.io.Reader;
+
 import org.opensolaris.opengrok.analysis.JFlexTokenizer;
 %%
 %public

src/org/opensolaris/opengrok/analysis/sh/ShXref.lex

@@ -23,20 +23,20 @@
  */
 
 package org.opensolaris.opengrok.analysis.sh;
-import org.opensolaris.opengrok.analysis.JFlexXref;
+
 import java.io.IOException;
-import org.opensolaris.opengrok.web.Util;
 import java.util.Stack;
-
+import org.opensolaris.opengrok.analysis.JFlexXrefSimple;
+import org.opensolaris.opengrok.web.HtmlConsts;
+import org.opensolaris.opengrok.web.Util;
 %%
 %public
 %class ShXref
-%extends JFlexXref
+%extends JFlexXrefSimple
 %unicode
 %int
 %include CommonXref.lexh
 %{
-  private final Stack<Integer> stateStack = new Stack<Integer>();
   private final Stack<String> styleStack = new Stack<String>();
 
   // State variables for the HEREDOC state. They tell what the stop word is,
@@ -46,9 +46,8 @@ import java.util.Stack;
   private boolean heredocStripLeadingTabs;
 
   @Override
-  public void reset() {
-      super.reset();
-      stateStack.clear();
+  protected void clearStack() {
+      super.clearStack();
       styleStack.clear();
   }
 
@@ -58,32 +57,21 @@ import java.util.Stack;
   @Override
   protected void setLineNumber(int x) { yyline = x; }
 
-  private void pushstate(int state, String style) throws IOException {
-    if (!styleStack.empty()) {
-      out.write("</span>");
-    }
-    if (style == null) {
-      out.write("<span>");
-    } else {
-      out.write("<span class=\"" + style + "\">");
-    }
-    stateStack.push(yystate());
-    styleStack.push(style);
-    yybegin(state);
+  @Override
+  public void pushSpan(int newState, String className) throws IOException {
+      super.pushSpan(newState, className);
+      styleStack.push(className);
   }
 
-  private void popstate() throws IOException {
-    out.write("</span>");
-    yybegin(stateStack.pop());
-    styleStack.pop();
-    if (!styleStack.empty()) {
-      String style = styleStack.peek();
-      if (style == null) {
-        out.write("<span>");
-      } else {
-        out.write("<span class=\"" + style + "\">");
+  @Override
+  public void yypop() throws IOException {
+      super.yypop();
+      styleStack.pop();
+
+      if (!styleStack.empty()) {
+          String style = styleStack.peek();
+          disjointSpan(style);
       }
-    }
   }
 
   /**
@@ -150,7 +138,8 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
      state on the stack to prevent premature exit from the
      STRING state. */
   \$\{ {Identifier} \[\" {
-    out.write(yytext()); pushstate(STRING, "s");
+    out.write(yytext());
+    pushSpan(STRING, HtmlConsts.STRING_CLASS);
   }
 }
 
@@ -160,11 +149,25 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
     writeSymbol(id, Consts.shkwd, yyline);
 }
 
-{Number}        { out.write("<span class=\"n\">"); out.write(yytext()); out.write("</span>"); }
+{Number}        {
+    String lastClassName = getDisjointSpanClassName();
+    disjointSpan(HtmlConsts.NUMBER_CLASS);
+    out.write(yytext());
+    disjointSpan(lastClassName);
+ }
 
- \$ ? \" { pushstate(STRING, "s"); out.write(yytext()); }
- \$ ? \' { pushstate(QSTRING, "s"); out.write(yytext()); }
- "#"     { pushstate(SCOMMENT, "c"); out.write(yytext()); }
+ \$ ? \" {
+    pushSpan(STRING, HtmlConsts.STRING_CLASS);
+    out.write(yytext());
+ }
+ \$ ? \' {
+    pushSpan(QSTRING, HtmlConsts.STRING_CLASS);
+    out.write(yytext());
+ }
+ "#"     {
+    pushSpan(SCOMMENT, HtmlConsts.COMMENT_CLASS);
+    out.write(yytext());
+ }
 
  // Recognize here-documents. At least a subset of them.
  "<<" "-"? {WhspChar}* {Identifier} {WhspChar}* {
@@ -173,7 +176,7 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
 
    heredocStripLeadingTabs = (text.charAt(2) == '-');
    heredocStopWord = text.substring(heredocStripLeadingTabs ? 3 : 2).trim();
-   pushstate(HEREDOC, "s");
+   pushSpan(HEREDOC, HtmlConsts.STRING_CLASS);
  }
 
  // Any sequence of more than two < characters should not start HEREDOC. Use
@@ -186,37 +189,46 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
 
 <STRING> {
  \" {WhspChar}* \"  { out.write(yytext()); }
- \"     { out.write(yytext()); popstate(); }
+ \"     { out.write(yytext()); yypop(); }
  \\\\ | \\\" | \\\$ | \\` { out.write(yytext()); }
- \$\(   { pushstate(SUBSHELL, null); out.write(yytext()); }
- `      { pushstate(BACKQUOTE, null); out.write(yytext()); }
+ \$\(   {
+    pushSpan(SUBSHELL, null);
+    out.write(yytext());
+ }
+ `      {
+    pushSpan(BACKQUOTE, null);
+    out.write(yytext());
+ }
 
  /* Bug #15661: Recognize ksh command substitution within strings. According
   * to ksh man page http://www2.research.att.com/~gsf/man/man1/ksh-man.html#Command%20Substitution
   * the opening brace must be followed by a blank.
   */
  "${" / {WhspChar} | {EOL} {
-   pushstate(BRACEGROUP, null); out.write(yytext());
+    pushSpan(BRACEGROUP, null);
+    out.write(yytext());
  }
 }
 
 <QSTRING> {
  \' {WhspChar}* \' { out.write(yytext()); }
  \\'  { out.write("\\'"); }
- \'   { out.write(yytext()); popstate(); }
+ \'   { out.write(yytext()); yypop(); }
 }
 
 <SCOMMENT> {
-{EOL} { popstate();
-     startNewLine();}
+{EOL} {
+    yypop();
+    startNewLine();
+ }
 }
 
 <SUBSHELL> {
-  \)   { out.write(yytext()); popstate(); }
+  \)   { out.write(yytext()); yypop(); }
 }
 
 <BACKQUOTE> {
-  ` { out.write(yytext()); popstate(); }
+  ` { out.write(yytext()); yypop(); }
 }
 
 <BRACEGROUP> {
@@ -225,15 +237,15 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
   * the closing brace must be on beginning of line, or it must be preceded by
   * a semi-colon and (optionally) whitespace.
   */
-  ^ {WhspChar}* \}  { out.write(yytext()); popstate(); }
-  ; {WhspChar}* \}  { out.write(yytext()); popstate(); }
+  ^ {WhspChar}* \}  { out.write(yytext()); yypop(); }
+  ; {WhspChar}* \}  { out.write(yytext()); yypop(); }
 }
 
 <HEREDOC> {
   [^\n]+ {
     String line = yytext();
     if (isHeredocStopWord(line)) {
-      popstate();
+      yypop();
     }
     out.write(Util.htmlize(line));
   }
@@ -249,8 +261,8 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
   /* $# should not start a comment. */
   "$#" { out.write(yytext()); }
 
-  \$ ? \( { pushstate(SUBSHELL, null); out.write(yytext()); }
-  ` { pushstate(BACKQUOTE, null); out.write(yytext()); }
+  \$ ? \( { pushSpan(SUBSHELL, null); out.write(yytext()); }
+  ` { pushSpan(BACKQUOTE, null); out.write(yytext()); }
 
  /* Bug #15661: Recognize ksh command substitution within strings. According
   * to ksh man page http://www2.research.att.com/~gsf/man/man1/ksh-man.html#Command%20Substitution
@@ -259,7 +271,7 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
   * group too early if the ${ cmd; } expression contains nested { cmd; } groups.
   */
   \$ ? \{ / {WhspChar} | {EOL} {
-    pushstate(BRACEGROUP, null); out.write(yytext());
+    pushSpan(BRACEGROUP, null); out.write(yytext());
   }
 }
 
@@ -297,12 +309,3 @@ File = {FNameChar}+ "." ([a-zA-Z]+)
           writeEMailAddress(yytext());
         }
 }
-
-<<EOF>> {
-    // If we reach EOF while being in a nested state, pop all the way up
-    // the initial state so that we close open HTML tags.
-    while (!stateStack.isEmpty()) {
-        popstate();
-    }
-    return YYEOF;
-}