Fix dangling Tcl span by subclassing JFlexXrefSimple

Also:
- Make TclXref case-sensitive (no affected
  patterns).
- Escape all HTML special characters in
  TclXref.
- Use Common.xref in TclSymbolTokenizer.

Author: idodeclare

src/org/opensolaris/opengrok/analysis/tcl/Tcl.lexh

@@ -0,0 +1,27 @@
+/*
+ * CDDL HEADER START
+ *
+ * The contents of this file are subject to the terms of the
+ * Common Development and Distribution License (the "License").  
+ * You may not use this file except in compliance with the License.
+ *
+ * See LICENSE.txt included in this distribution for the specific
+ * language governing permissions and limitations under the License.
+ *
+ * When distributing Covered Code, include this CDDL HEADER in each
+ * file and include the License file at LICENSE.txt.
+ * If applicable, add the following below this CDDL HEADER, with the
+ * fields enclosed by brackets "[]" replaced with your own identifying
+ * information: Portions Copyright [yyyy] [name of copyright owner]
+ *
+ * CDDL HEADER END
+ */
+
+/*
+ * Copyright (c) 2008, 2016, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
+ */
+
+Identifier = [\:\=a-zA-Z0-9_]+
+
+Number = ([0-9]+\.[0-9]+|[0-9][0-9]*|"#" [boxBOX] [0-9a-fA-F]+)

src/org/opensolaris/opengrok/analysis/tcl/TclSymbolTokenizer.lex

@@ -27,10 +27,8 @@
  */
 
 package org.opensolaris.opengrok.analysis.tcl;
-import java.io.IOException;
-import java.io.Reader;
-import org.opensolaris.opengrok.analysis.JFlexTokenizer;
 
+import org.opensolaris.opengrok.analysis.JFlexTokenizer;
 %%
 %public
 %class TclSymbolTokenizer
@@ -43,10 +41,10 @@ super(in);
 %include CommonTokenizer.lexh
 %char
 
-Identifier = [\:\=a-zA-Z0-9_]+
-
 %state STRING COMMENT SCOMMENT
 
+%include Common.lexh
+%include Tcl.lexh
 %%
 
 <YYINITIAL> {
@@ -55,21 +53,23 @@ Identifier = [\:\=a-zA-Z0-9_]+
                     setAttribs(id, yychar, yychar + yylength());
                     return yystate(); }
               }
+ {Number}    {}
  \"     { yybegin(STRING); }
 "#"     { yybegin(SCOMMENT); }
 
  \\\"    {}
 }
 
 <STRING> {
+ \\[\"\\]    {}
  \"     { yybegin(YYINITIAL); }
-\\\\ | \\\"     {}
 }
 
 <SCOMMENT> {
-\n      { yybegin(YYINITIAL);}
+{EOL}      { yybegin(YYINITIAL);}
 }
 
 <YYINITIAL, STRING, COMMENT, SCOMMENT> {
+{WhiteSpace} |
 [^]    {}
 }

src/org/opensolaris/opengrok/analysis/tcl/TclXref.lex

@@ -27,18 +27,15 @@
  */
 
 package org.opensolaris.opengrok.analysis.tcl;
-import org.opensolaris.opengrok.analysis.JFlexXref;
-import java.io.IOException;
-import java.io.Writer;
-import java.io.Reader;
-import org.opensolaris.opengrok.web.Util;
 
+import org.opensolaris.opengrok.analysis.JFlexXrefSimple;
+import org.opensolaris.opengrok.web.HtmlConsts;
+import org.opensolaris.opengrok.web.Util;
 %%
 %public
 %class TclXref
-%extends JFlexXref
+%extends JFlexXrefSimple
 %unicode
-%ignorecase
 %int
 %include CommonXref.lexh
 %{
@@ -49,17 +46,14 @@ import org.opensolaris.opengrok.web.Util;
   protected void setLineNumber(int x) { yyline = x; }
 %}
 
-Identifier = [\:\=a-zA-Z0-9_]+
-
 File = [a-zA-Z] {FNameChar}+ "." ([a-zA-Z]+)
 
-Number = ([0-9]+\.[0-9]+|[0-9][0-9]*|"#" [boxBOX] [0-9a-fA-F]+)
-
 %state  STRING COMMENT SCOMMENT
 
 %include Common.lexh
 %include CommonURI.lexh
 %include CommonPath.lexh
+%include Tcl.lexh
 %%
 <YYINITIAL>{
 
@@ -68,34 +62,42 @@ Number = ([0-9]+\.[0-9]+|[0-9][0-9]*|"#" [boxBOX] [0-9a-fA-F]+)
     writeSymbol(id, Consts.kwd, yyline);
 }
 
-{Number}        { out.write("<span class=\"n\">");
-                  out.write(yytext());
-                  out.write("</span>"); }
-
- \"     { yybegin(STRING);out.write("<span class=\"s\">\"");}
- "#"    { yybegin(SCOMMENT);out.write("<span class=\"c\">#");}
+ {Number}        {
+    disjointSpan(HtmlConsts.NUMBER_CLASS);
+    out.write(yytext());
+    disjointSpan(null);
+ }
+
+ \"     {
+    pushSpan(STRING, HtmlConsts.STRING_CLASS);
+    out.write(htmlize(yytext()));
+ }
+ "#"    {
+    pushSpan(SCOMMENT, HtmlConsts.COMMENT_CLASS);
+    out.write(yytext());
+ }
 
  \\\"    { out.write(htmlize(yytext())); }
 }
 
 <STRING> {
- \" {WhiteSpace} \"  { out.write(yytext()); }
- \"     { yybegin(YYINITIAL); out.write("\"</span>"); }
- \\\\   { out.write("\\\\"); }
- \\\"   { out.write("\\\""); }
+ \\[\"\\] |
+ \" {WhiteSpace} \"    { out.write(htmlize(yytext())); }
+ \"     {
+    out.write(htmlize(yytext()));
+    yypop();
+ }
 }
 
 <SCOMMENT> {
-  {EOL} {
-    yybegin(YYINITIAL); out.write("</span>");
+  {WhspChar}*{EOL}    {
+    yypop();
     startNewLine();
   }
 }
 
 <YYINITIAL, STRING, COMMENT, SCOMMENT> {
-"&"     {out.write( "&amp;");}
-"<"     {out.write( "&lt;");}
-">"     {out.write( "&gt;");}
+[&<>\'\"]    { out.write(htmlize(yytext())); }
 {WhspChar}*{EOL} { startNewLine(); }
  {WhiteSpace}   { out.write(yytext()); }
  [!-~]  { out.write(yycharat(0)); }