Merge pull request #1833 from idodeclare/feature/perl_symbols

Feature/perl symbols

Author: tarzanek

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

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis;
 
@@ -113,4 +114,13 @@ public void yypush(int newState) {
     public void yypop() {
         this.yybegin(this.stack.pop());
     }
+
+    /**
+     * reset current yy state, and clear stack
+     * @param newState state id
+     */
+    public void yyjump(int newState) {
+        yybegin(newState);
+        this.stack.clear();
+    }
 }

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

@@ -20,6 +20,7 @@
 /*
  * Copyright (c) 2009, 2017, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright 2011 Jens Elkner.
+ * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis;
 
@@ -537,27 +538,31 @@ protected void startNewLine() throws IOException {
      * @param keywords a set of keywords recognized by this analyzer (no links
      * will be generated if the symbol is a keyword)
      * @param line the line number on which the symbol appears
+     * @return true if the {@code symbol} was not in {@code keywords} or if
+     * {@code keywords} was null
      * @throws IOException if an error occurs while writing to the stream
      */
-    protected void writeSymbol(String symbol, Set<String> keywords, int line)
+    protected boolean writeSymbol(String symbol, Set<String> keywords, int line)
             throws IOException {
-        writeSymbol(symbol, keywords, line, true, false);
+        return writeSymbol(symbol, keywords, line, true, false);
     }
 
-        /**
+    /**
      * Write a symbol and generate links as appropriate.
      *
      * @param symbol the symbol to write
      * @param keywords a set of keywords recognized by this analyzer (no links
      * will be generated if the symbol is a keyword)
      * @param line the line number on which the symbol appears
      * @param caseSensitive Whether the keyword list is case sensitive
+     * @return true if the {@code symbol} was not in {@code keywords} or if
+     * {@code keywords} was null
      * @throws IOException if an error occurs while writing to the stream
      */
-    protected void writeSymbol(
+    protected boolean writeSymbol(
             String symbol, Set<String> keywords, int line, boolean caseSensitive)
             throws IOException {
-        writeSymbol(symbol, keywords, line, caseSensitive, false);
+        return writeSymbol(symbol, keywords, line, caseSensitive, false);
     }
 
     /**
@@ -569,21 +574,45 @@ protected void writeSymbol(
      * @param line the line number on which the symbol appears
      * @param caseSensitive Whether the keyword list is case sensitive
      * @param quote Whether the symbol gets quoted in links or not
+     * @return true if the {@code symbol} was not in {@code keywords} or if
+     * {@code keywords} was null
+     * @throws IOException if an error occurs while writing to the stream
+     */
+    protected boolean writeSymbol(String symbol, Set<String> keywords,
+        int line, boolean caseSensitive, boolean quote)
+            throws IOException {
+        return writeSymbol(symbol, keywords, line, caseSensitive, quote, false);
+    }
+
+    /**
+     * Write a symbol and generate links as appropriate.
+     *
+     * @param symbol the symbol to write
+     * @param keywords a set of keywords recognized by this analyzer (no links
+     * will be generated if the symbol is a keyword)
+     * @param line the line number on which the symbol appears
+     * @param caseSensitive Whether the keyword list is case sensitive
+     * @param quote Whether the symbol gets quoted in links or not
+     * @param isKeyword Whether the symbol is certainly a keyword without
+     * bothering to look up in a defined {@code keywords}
+     * @return true if the {@code symbol} was not in {@code keywords} or if
+     * {@code keywords} was null and if-and-only-if {@code isKeyword} is false
      * @throws IOException if an error occurs while writing to the stream
      */
-    protected void writeSymbol(
-            String symbol, Set<String> keywords, int line, boolean caseSensitive, boolean quote)
+    protected boolean writeSymbol(
+            String symbol, Set<String> keywords, int line, boolean caseSensitive,
+            boolean quote, boolean isKeyword)
             throws IOException {
         String[] strs = new String[1];
         strs[0] = "";
         String jsEscapedSymbol = symbol.replace("'", "\\'");
         String qt = (quote) ? "&quot;" : "";
 
         String check = caseSensitive ? symbol : symbol.toLowerCase();
-        if (keywords != null && keywords.contains( check )) {
+        if (isKeyword || (keywords != null && keywords.contains( check ))) {
             // This is a keyword, so we don't create a link.
             out.append("<b>").append(symbol).append("</b>");
-
+            return false;
         } else if (defs != null && defs.hasDefinitionAt(symbol, line, strs)) {
             // This is the definition of the symbol.
             String type = strs[0];
@@ -658,6 +687,18 @@ protected void writeSymbol(
             out.append(symbol);
             out.append("</a>");
         }
+        return true;
+    }
+
+    /**
+     * Write an {@code htmlize()}d keyword symbol
+     *
+     * @param symbol the symbol to write
+     * @param line the line number on which the symbol appears
+     * @throws IOException if an error occurs while writing to the stream
+     */
+    protected void writeKeyword(String symbol, int line) throws IOException {
+        writeSymbol(htmlize(symbol), null, line, false, false, true);
     }
 
     /**
@@ -711,4 +752,14 @@ public void yypop() throws IOException {
             out.write(popString);
         }
     }
+
+    /**
+     * reset current yy state, and clear stack
+     * @param newState state id
+     */
+    public void yyjump(int newState) {
+        yybegin(newState);
+        this.stack.clear();
+        this.stackPopString.clear();
+    }
 }

src/org/opensolaris/opengrok/analysis/perl/Consts.java

@@ -30,6 +30,11 @@
   * Holds static hash set containing the Perl keywords
   */
 public class Consts{
+    public static final String SC = "<span class=\"c\">";
+    public static final String SN = "<span class=\"n\">";
+    public static final String SS = "<span class=\"s\">";
+    public static final String ZS = "</span>";
+
     public static final Set<String> kwd = new HashSet<String>() ;
     static {
         // Note that keywords with 1 letter will be ignored for {Identifier}
@@ -46,16 +51,25 @@ public class Consts{
         kwd.add("alarm");
         kwd.add("and");
         kwd.add("atan2");
+        kwd.add("attributes");
+        kwd.add("autodie");
         kwd.add("AUTOLOAD");
+        kwd.add("autouse");
         kwd.add("base");
         kwd.add("BEGIN");
+        kwd.add("bigint");
+        kwd.add("bignum");
+        kwd.add("bigrat");
         kwd.add("bind");
         kwd.add("binmode");
         kwd.add("bless");
+        kwd.add("blib");
         kwd.add("break");
         kwd.add("byte");
+        kwd.add("bytes");
         kwd.add("caller");
         kwd.add("carp");
+        kwd.add("charnames");
         kwd.add("chdir");
         kwd.add("CHECK");
         kwd.add("chmod");
@@ -69,6 +83,7 @@ public class Consts{
         kwd.add("cmp");
         kwd.add("confess");
         kwd.add("connect");
+        kwd.add("constant");
         kwd.add("continue");
         kwd.add("CORE");
         kwd.add("cos");
@@ -80,13 +95,15 @@ public class Consts{
         kwd.add("defined");
         kwd.add("delete");
         kwd.add("DESTROY");
+        kwd.add("diagnostics");
         kwd.add("die");
         kwd.add("do");
         kwd.add("dump");
         kwd.add("each");
         kwd.add("else");
         kwd.add("elseif");	/* parsed "but only to warn you ..." */
         kwd.add("elsif");
+        kwd.add("encoding");
         kwd.add("END");
         kwd.add("endgrent");
         kwd.add("endhostent");
@@ -105,8 +122,10 @@ public class Consts{
         kwd.add("exp");
         kwd.add("fc");
         kwd.add("fcntl");
+        kwd.add("feature");
         kwd.add("fields");
         kwd.add("fileno");
+        kwd.add("filetest");
         kwd.add("flock");
         kwd.add("for");
         kwd.add("foreach");
@@ -162,10 +181,12 @@ public class Consts{
         kwd.add("lcfirst");
         kwd.add("le");
         kwd.add("length");
+        kwd.add("less");
         kwd.add("lib");
         kwd.add("link");
         kwd.add("listen");
         kwd.add("local");
+        kwd.add("locale");
         kwd.add("localtime");
         kwd.add("lock");
         kwd.add("log");
@@ -174,6 +195,7 @@ public class Consts{
         kwd.add("m");
         kwd.add("map");
         kwd.add("mkdir");
+        kwd.add("mro");
         kwd.add("msgctl");
         kwd.add("msgget");
         kwd.add("msgrcv");
@@ -187,11 +209,15 @@ public class Consts{
         kwd.add("oct");
         kwd.add("open");
         kwd.add("opendir");
+        kwd.add("ops");
         kwd.add("or");
         kwd.add("ord");
         kwd.add("our");
+        kwd.add("overload");
+        kwd.add("overloading");
         kwd.add("pack");
         kwd.add("package");
+        kwd.add("parent");
         kwd.add("pipe");
         kwd.add("pop");
         kwd.add("pos");
@@ -206,6 +232,7 @@ public class Consts{
         kwd.add("qw");
         kwd.add("qx");
         kwd.add("rand");
+        kwd.add("re");
         kwd.add("read");
         kwd.add("readdir");
         kwd.add("readline");
@@ -275,6 +302,8 @@ public class Consts{
         kwd.add("syswrite");
         kwd.add("tell");
         kwd.add("telldir");
+        kwd.add("threads::shared");
+        kwd.add("threads");
         kwd.add("tie");
         kwd.add("tied");
         kwd.add("time");
@@ -298,10 +327,12 @@ public class Consts{
         kwd.add("values");
         kwd.add("vars");
         kwd.add("vec");
+        kwd.add("vmsish");
         kwd.add("wait");
         kwd.add("waitpid");
         kwd.add("wantarray");
         kwd.add("warn");
+        kwd.add("warnings::register");
         kwd.add("warnings");
         kwd.add("when");
         kwd.add("while");

src/org/opensolaris/opengrok/analysis/perl/PerlAnalyzerFactory.java

@@ -19,6 +19,7 @@
 
 /*
  * Copyright (c) 2010, 2015 Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 
 package org.opensolaris.opengrok.analysis.perl;
@@ -44,6 +45,7 @@ public class PerlAnalyzerFactory extends FileAnalyzerFactory {
 
     private static final String[] SUFFIXES = {
         "PL",
+        "PLX",
         "PERL",
         "PM",
         "PH"