Merge pull request #1880 from idodeclare/feature/extract_interfaces1

Extract JFlexLexer, JFlexStateStacker, JFlexXrefSimple

Author: tarzanek

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

@@ -0,0 +1,106 @@
+/*
+ * 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) 2017, Chris Fraire <[email protected]>.
+ */
+
+package org.opensolaris.opengrok.analysis;
+
+import java.io.IOException;
+import java.io.Reader;
+
+/**
+ * Represents an API for lexers created by JFlex for {@code %type int}.
+ * <p>http://jflex.de
+ */
+public interface JFlexLexer {
+
+    /**
+     * Gets the matched input text as documented by JFlex.
+     * @return "the matched input text region"
+     */
+    String yytext();
+
+    /**
+     * Gets the matched input text length as documented by JFlex.
+     * @return "the length of the matched input text region (does not require a
+     * String object to be created)"
+     */
+    int yylength();
+
+    /**
+     * Gets a character from the matched input text as documented by JFlex.
+     * @param pos "a value from 0 to {@link #yylength()}-1"
+     * @return "the character at position {@code pos} from the matched text. It
+     * is equivalent to {@link #yytext()} then {@link String#charAt(int)} --
+     * but faster."
+     */
+    char yycharat(int pos);
+
+    /**
+     * "Closes the input stream [as documented by JFlex]. All subsequent calls
+     * to the scanning method will return the end of file value."
+     * @throws IOException if an error occurs while closing
+     */
+    void yyclose() throws IOException;
+
+    /**
+     * "Closes the current input stream [as documented by JFlex], and resets
+     * the scanner to read from a new Reader."
+     * @param reader the new reader
+     */
+    void yyreset(Reader reader);
+
+    /**
+     * Gets the current lexical state as documented by JFlex.
+     * @return "the current lexical state of the scanner."
+     */
+    int yystate();
+
+    /**
+     * "Enters the lexical state {@code lexicalState} [as documented by
+     * JFlex]."
+     * @param lexicalState the new state
+     */
+    void yybegin(int lexicalState);
+
+    /**
+     * "Pushes {@code number} characters of the matched text back into the
+     * input stream [as documented by JFlex].
+     * <p>[The characters] will be read again in the next call of the scanning
+     * method.
+     * <p>The number of characters to be read again must not be greater than
+     * the length of the matched text. The pushed back characters will not be
+     * included in {@link #yylength()} and {@link #yytext()}."
+     * @param number the [constrained] number of characters
+     */
+    void yypushback(int number);
+
+    /**
+     * "Runs the scanner [as documented by JFlex].
+     * <p>[The method] can be used to get the next token from the input."
+     * <p>"Consume[s] input until one of the expressions in the specification
+     * is matched or an error occurs."
+     * @return a value returned by the lexer specification if defined or the
+     * {@code EOF} value upon reading end-of-file
+     * @throws IOException if an error occurs reading the input
+     */
+    int yylex() throws IOException;
+}

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

@@ -0,0 +1,49 @@
+/*
+ * 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) 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;
+
+import java.io.IOException;
+
+/**
+ * Represents an API for an extension of {@link JFlexLexer} that needs to track
+ * a state stack.
+ */
+public interface JFlexStackingLexer extends JFlexLexer {
+
+    /**
+     * Saves current {@link #yystate()} to stack, and enters the specified
+     * {@code newState} with {@link #yybegin(int)}.
+     * @param newState state id
+     */
+    void yypush(int newState);
+
+    /**
+     * Pops the last state from the stack, and enters the state with
+     * {@link #yybegin(int)}.
+     * @throws IOException if any error occurs while effecting the pop
+     */
+    void yypop() throws IOException;
+}

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

@@ -0,0 +1,83 @@
+/*
+ * 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) 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;
+
+import java.io.IOException;
+import java.util.Stack;
+
+/**
+ * Represents an abstract base class for resettable lexers that need to track
+ * a state stack.
+ */
+public abstract class JFlexStateStacker implements Resettable,
+    JFlexStackingLexer {
+
+    protected final Stack<Integer> stack = new Stack<>();
+
+    /**
+     * Resets the instance using {@link #clearStack()}.
+     */
+    @Override
+    public void reset() {
+        clearStack();
+    }
+
+    /**
+     * Saves current {@link #yystate()} to stack, and enters the specified
+     * {@code newState} with {@link #yybegin(int)}.
+     * @param newState state id
+     */
+    public void yypush(int newState) {
+        this.stack.push(yystate());
+        yybegin(newState);
+    }
+
+    /**
+     * Pops the last state from the stack, and enters the state with
+     * {@link #yybegin(int)}.
+     * @throws IOException if any error occurs while effecting the pop
+     */
+    public void yypop() throws IOException {
+        yybegin(this.stack.pop());
+    }
+
+    /**
+     * Calls {@link #clearStack()}, and enters the specified {@code newState}
+     * with {@link #yybegin(int)}.
+     * @param newState state id
+     */
+    public void yyjump(int newState) {
+        clearStack();
+        yybegin(newState);
+    }
+
+    /**
+     * Clears the instance stack.
+     */
+    protected void clearStack() {
+        stack.clear();
+    }
+}

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

@@ -28,29 +28,28 @@
 import java.io.IOException;
 import java.io.Reader;
 import java.io.Writer;
-import java.lang.reflect.Field;
 import java.util.Comparator;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.SortedSet;
-import java.util.Stack;
 import java.util.TreeSet;
 import org.opensolaris.opengrok.analysis.Definitions.Tag;
 import org.opensolaris.opengrok.analysis.Scopes.Scope;
 import org.opensolaris.opengrok.configuration.Project;
 import org.opensolaris.opengrok.configuration.RuntimeEnvironment;
 import org.opensolaris.opengrok.history.Annotation;
 import org.opensolaris.opengrok.util.StringUtils;
+import org.opensolaris.opengrok.web.HtmlConsts;
 import org.opensolaris.opengrok.web.Util;
 
 /**
  * Base class for Xref lexers.
  *
  * @author Lubos Kosco
  */
-public abstract class JFlexXref {
+public abstract class JFlexXref extends JFlexStateStacker {
 
     public Writer out;
     public String urlPrefix = RuntimeEnvironment.getInstance().getUrlPrefix();
@@ -81,8 +80,12 @@ public abstract class JFlexXref {
      * @see #startNewLine()
      */
     protected String userPageSuffix;
-    protected Stack<Integer> stack = new Stack<>();
-    protected Stack<String> stackPopString = new Stack<>();
+
+    /**
+     * The span class name from the last call to
+     * {@link #disjointSpan(java.lang.String)}.
+     */
+    private String disjointSpanClassName;
 
     /**
      * Description of the style to use for a type of definitions.
@@ -164,8 +167,18 @@ public void reInit(char[] contents, int length) {
      */
     public void reInit(Reader reader) {
         this.yyreset(reader);
-        annotation = null;
+        reset();
+    }
+
+    /**
+     * Resets the xref tracked state after {@link #reset()}.
+     */
+    @Override
+    public void reset() {
+        super.reset();
 
+        annotation = null;
+        disjointSpanClassName = null;
         scopes = new Scopes();
         scope = null;
         scopeLevel = 0;
@@ -352,6 +365,26 @@ public Scopes getScopes() {
      */
     public abstract int getYYEOF();
 
+    /**
+     * Writes the closing of an open span tag previously opened by this method
+     * and the opening -- if {@code className} is non-null -- of a new span
+     * tag.
+     * <p>This method's disjoint spans are independent of any span used for
+     * scopes.
+     * <p>Any open span is closed at the end of {@link #write(java.io.Writer)}
+     * just before any open scope is closed.
+     * @param className the class name for the new tag or {@code null} just to
+     * close an open tag.
+     * @throws IOException if an output error occurs
+     */
+    public void disjointSpan(String className) throws IOException {
+        if (disjointSpanClassName != null) out.write(HtmlConsts.ZSPAN);
+        if (className != null) {
+            out.write(String.format(HtmlConsts.SPAN_FMT, className));
+        }
+        disjointSpanClassName = className;
+    }
+
     /**
      * Write xref to the specified {@code Writer}.
      *
@@ -367,6 +400,8 @@ public void write(Writer out) throws IOException {
             // nothing to do here, yylex() will do the work
         }
 
+        disjointSpan(null);
+
         // terminate scopes
         if (scopeOpen) {
             out.write("</span>");
@@ -757,45 +792,4 @@ protected void writeEMailAddress(String address) throws IOException {
             out.write(address);
         }
     }
-
-    /**
-     * save current yy state to stack
-     * @param newState state id
-     * @param popString string for the state
-     */
-    public void yypush(int newState, String popString) {
-        this.stack.push(yystate());
-        this.stackPopString.push(popString);
-        yybegin(newState);
-    }
-
-    /**
-     * save current yy state to stack
-     * @param newState state id
-     */
-    public void yypush(int newState) {
-        yypush(newState, null);
-    }
-
-    /**
-     * pop last state from stack
-     * @throws IOException in case of any I/O problem
-     */
-    public void yypop() throws IOException {
-        yybegin(this.stack.pop());
-        String popString = this.stackPopString.pop();
-        if (popString != null) {
-            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();
-    }
 }