Merge pull request #1845 from idodeclare/feature/refactor_statics

Drop static writeXref()s; use existing thread-cached analyzers instead

Author: tarzanek

.gitignore

@@ -1,8 +1,6 @@
 *~
-nbproject/*~
+*.swp
 /nbproject/configs/*.properties
-opengrok-web-nbproject/nbproject/*~
-opengrok-web-nbproject/nbproject/build-impl.xml~
 tags
 TAGS
 build
@@ -39,8 +37,6 @@ webrev
 opengrok-web-nbproject/nbproject/private/
 opengrok-web-nbproject/nbproject/genfiles.properties
 run_my.bat
-*.xml~
-opengrok-web-nbproject/nbproject/build-impl.xml~
 build.bat
 jacoco
 jacoco.exec

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

@@ -462,7 +462,14 @@ public static void writeXref(FileAnalyzerFactory factory, Reader in,
             // spaces to match the project's tab settings.
             input = ExpandTabsReader.wrap(in, project);
         }
-        factory.writeXref(input, out, defs, annotation, project);
+
+        WriteXrefArgs args = new WriteXrefArgs(input, out);
+        args.setDefs(defs);
+        args.setAnnotation(annotation);
+        args.setProject(project);
+
+        FileAnalyzer analyzer = factory.getAnalyzer();
+        analyzer.writeXref(args);
     }
 
     /**

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

@@ -20,6 +20,7 @@
 /*
  * Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
  * Use is subject to license terms.
+ * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis;
 
@@ -182,6 +183,18 @@ public String getFileTypeName() {
     public void analyze(Document doc, StreamSource src, Writer xrefOut) throws IOException {
         // not used
     }
+
+    /**
+     * Derived classes should override to write a cross referenced HTML file
+     * for the specified args.
+     * @param args a defined instance
+     * @return the instance used to write the cross-referencing
+     * @throws java.io.IOException if an error occurs
+     */
+    public JFlexXref writeXref(WriteXrefArgs args) throws IOException {
+        throw new UnsupportedOperationException(
+            "Base FileAnalyzer cannot write xref");
+    }
 
     // you analyzer HAS to override this to get proper symbols in results
     protected JFlexTokenizer SymbolTokenizer;

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

@@ -25,14 +25,10 @@
 
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.Reader;
-import java.io.Writer;
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.List;
 import org.opensolaris.opengrok.analysis.FileAnalyzer.Genre;
-import org.opensolaris.opengrok.configuration.Project;
-import org.opensolaris.opengrok.history.Annotation;
 
 /**
  * Factory class which creates a {@code FileAnalyzer} object and
@@ -241,18 +237,4 @@ protected interface Matcher {
         FileAnalyzerFactory isMagic(byte[] contents, InputStream in)
                 throws IOException;
     }
-
-    /**
-     * Write a cross referenced HTML file. Reads the source from {@code in}.
-     * @param in input source
-     * @param out output xref writer
-     * @param defs definitions for the file (could be {@code null})
-     * @param annotation annotation for the file (could be {@code null})
-     * @param project project the file belongs to (could be {@code null})
-     * @throws java.io.IOException if an error occurs
-     */
-    public void writeXref(Reader in, Writer out, Definitions defs, Annotation annotation, Project project)
-            throws IOException {
-        throw new UnsupportedOperationException("Not yet implemented");
-    }
 }

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

@@ -19,15 +19,13 @@
 
 /*
  * Copyright (c) 2005, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Portions Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opensolaris.opengrok.analysis;
 
-import java.io.BufferedInputStream;
 import java.io.IOException;
 import java.io.InputStream;
-import java.io.InputStreamReader;
 import java.io.Reader;
-import java.nio.charset.Charset;
 import org.opensolaris.opengrok.util.IOUtils;
 
 public abstract class TextAnalyzer extends FileAnalyzer {
@@ -36,6 +34,33 @@ public TextAnalyzer(FileAnalyzerFactory factory) {
         super(factory);
     }
 
+    /**
+     * Write a cross referenced HTML file reads the source from in
+     * @param args a defined instance
+     * @return the instance used to write the cross-referencing
+     * @throws IOException if an I/O error occurs
+     */
+    @Override
+    public JFlexXref writeXref(WriteXrefArgs args) throws IOException {
+        if (args == null) throw new IllegalArgumentException("`args' is null");
+        JFlexXref xref = newXref(args.getIn());
+        xref.setDefs(args.getDefs());
+        xref.setScopesEnabled(scopesEnabled);
+        xref.setFoldingEnabled(foldingEnabled);
+        xref.annotation = args.getAnnotation();
+        xref.project = args.getProject();
+        xref.write(args.getOut());
+        return xref;
+    }
+
+    /**
+     * Derived classes should implement to create an xref for the language
+     * supported by this analyzer.
+     * @param reader the data to produce xref for
+     * @return an xref instance
+     */
+    protected abstract JFlexXref newXref(Reader reader);
+
     protected Reader getReader(InputStream stream) throws IOException {
         return IOUtils.createBOMStrippedReader(stream);
     }

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

@@ -0,0 +1,67 @@
+/*
+ * 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.Reader;
+import java.io.Writer;
+import org.opensolaris.opengrok.configuration.Project;
+import org.opensolaris.opengrok.history.Annotation;
+
+/**
+ * Represents the arguments for the
+ * {@link org.opensolaris.opengrok.analysis.FileAnalyzer#writeXref(org.opensolaris.opengrok.analysis.WriteXrefArgs)}
+ * method.
+ */
+public class WriteXrefArgs {
+    private final Reader in;
+    private final Writer out;
+    private Definitions defs;
+    private Annotation annotation;
+    private Project project;
+
+    /**
+     * Initializes an instance of {@link WriteXrefArgs} for the required
+     * arguments.
+     * @param in a defined instance
+     * @param out a defined instance
+     * @throws IllegalArgumentException thrown if any argument is null.
+     */
+    public WriteXrefArgs(Reader in, Writer out) {
+        if (in == null) throw new IllegalArgumentException("`in' is null");
+        if (out == null) throw new IllegalArgumentException("`out' is null");
+        this.in = in;
+        this.out = out;
+    }
+
+    public Reader getIn() { return in; }
+    public Writer getOut() { return out; }
+
+    public Definitions getDefs() { return defs; }
+    public void setDefs(Definitions value) { defs = value; }
+
+    public Annotation getAnnotation() { return annotation; }
+    public void setAnnotation(Annotation value) { annotation = value; }
+
+    public Project getProject() { return project; }
+    public void setProject(Project value) { project = value; }
+}

src/org/opensolaris/opengrok/analysis/c/CAnalyzer.java

@@ -22,16 +22,11 @@
  */
 package org.opensolaris.opengrok.analysis.c;
 
-import java.io.IOException;
 import java.io.Reader;
-import java.io.Writer;
-import org.opensolaris.opengrok.analysis.Definitions;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.FileAnalyzerFactory;
 import org.opensolaris.opengrok.analysis.JFlexXref;
 import org.opensolaris.opengrok.analysis.plain.AbstractSourceCodeAnalyzer;
-import org.opensolaris.opengrok.configuration.Project;
-import org.opensolaris.opengrok.history.Annotation;
 
 /**
  * An Analyzer for C/C++/Java type of files
@@ -60,9 +55,4 @@ protected JFlexXref newXref(Reader reader) {
     protected boolean supportsScopes() {
         return true;
     }
-
-    static void writeXref(Reader in, Writer out, Definitions defs, Annotation annotation, Project project) throws IOException {
-        CXref xref = new CXref(in);
-        AbstractSourceCodeAnalyzer.writeXref(xref, in, out, defs, annotation, project);
-    }
 }

src/org/opensolaris/opengrok/analysis/c/CAnalyzerFactory.java

@@ -23,15 +23,9 @@
 
 package org.opensolaris.opengrok.analysis.c;
 
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Writer;
-import org.opensolaris.opengrok.analysis.Definitions;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.FileAnalyzer.Genre;
 import org.opensolaris.opengrok.analysis.FileAnalyzerFactory;
-import org.opensolaris.opengrok.configuration.Project;
-import org.opensolaris.opengrok.history.Annotation;
 
 public class CAnalyzerFactory extends FileAnalyzerFactory {
 
@@ -59,10 +53,4 @@ public CAnalyzerFactory() {
     protected FileAnalyzer newAnalyzer() {
         return new CAnalyzer(this);
     }
-
-    @Override
-    public void writeXref(Reader in, Writer out, Definitions defs, Annotation annotation, Project project)
-        throws IOException {
-        CAnalyzer.writeXref(in, out, defs, annotation, project);
-    }
 }

src/org/opensolaris/opengrok/analysis/c/CxxAnalyzer.java

@@ -22,16 +22,11 @@
  */
 package org.opensolaris.opengrok.analysis.c;
 
-import java.io.IOException;
 import java.io.Reader;
-import java.io.Writer;
-import org.opensolaris.opengrok.analysis.Definitions;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.FileAnalyzerFactory;
 import org.opensolaris.opengrok.analysis.JFlexXref;
 import org.opensolaris.opengrok.analysis.plain.AbstractSourceCodeAnalyzer;
-import org.opensolaris.opengrok.configuration.Project;
-import org.opensolaris.opengrok.history.Annotation;
 
 /**
  * An Analyzer for C++ files
@@ -58,9 +53,4 @@ protected JFlexXref newXref(Reader reader) {
     protected boolean supportsScopes() {
         return true;
     }
-
-    static void writeXref(Reader in, Writer out, Definitions defs, Annotation annotation, Project project) throws IOException {
-        CxxXref xref = new CxxXref(in);
-        AbstractSourceCodeAnalyzer.writeXref(xref, in, out, defs, annotation, project);
-    }
 }

src/org/opensolaris/opengrok/analysis/c/CxxAnalyzerFactory.java

@@ -22,15 +22,9 @@
  */
 package org.opensolaris.opengrok.analysis.c;
 
-import java.io.IOException;
-import java.io.Reader;
-import java.io.Writer;
-import org.opensolaris.opengrok.analysis.Definitions;
 import org.opensolaris.opengrok.analysis.FileAnalyzer;
 import org.opensolaris.opengrok.analysis.FileAnalyzer.Genre;
 import org.opensolaris.opengrok.analysis.FileAnalyzerFactory;
-import org.opensolaris.opengrok.configuration.Project;
-import org.opensolaris.opengrok.history.Annotation;
 
 public class CxxAnalyzerFactory extends FileAnalyzerFactory {
 
@@ -56,10 +50,4 @@ public CxxAnalyzerFactory() {
     protected FileAnalyzer newAnalyzer() {
         return new CxxAnalyzer(this);
     }
-
-    @Override
-    public void writeXref(Reader in, Writer out, Definitions defs, Annotation annotation, Project project)
-        throws IOException {
-        CxxAnalyzer.writeXref(in, out, defs, annotation, project);
-    }
 }