print list of analyzers with -h guru (#3495)

fixes #3494

Author: Vladimir Kotal

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuru.java

@@ -391,7 +391,7 @@ public static Map<String, String> getfileTypeDescriptions() {
         return Collections.unmodifiableMap(fileTypeDescriptions);
     }
 
-    public List<AnalyzerFactory> getAnalyzerFactories() {
+    public static List<AnalyzerFactory> getAnalyzerFactories() {
         return Collections.unmodifiableList(factories);
     }
 

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/AnalyzerGuruHelp.java

@@ -18,6 +18,7 @@
  */
 
 /*
+ * Copyright (c) 2021, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2017, 2019, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.analysis;
@@ -48,26 +49,38 @@ private AnalyzerGuruHelp() {
      */
     public static String getUsage() {
         StringBuilder b = new StringBuilder();
-        b.append("AnalyzerGuru prefixes:\n");
+
+        b.append("List of analyzers:" + System.lineSeparator());
+        b.append("The names of the analyzers (left column) can be used for the -A indexer option:" +
+                System.lineSeparator() + System.lineSeparator());
+        byFactory(AnalyzerGuru.getAnalyzerFactories().stream().
+                collect(Collectors.toMap(f -> f.getClass().getSimpleName(), f -> f))).
+                forEach((factory) -> {
+            b.append(String.format("%-10s : %s%n",
+                    factory.fac.getClass().getSimpleName().replace("AnalyzerFactory", ""),
+                    factory.fac.getName() != null ? factory.fac.getName() : "N/A"));
+        });
+
+        b.append(System.lineSeparator() + "AnalyzerGuru prefixes:" + System.lineSeparator());
         byKey(AnalyzerGuru.getPrefixesMap()).forEach((kv) -> {
-            b.append(String.format("%-10s : %s\n", reportable(kv.key + '*'),
+            b.append(String.format("%-10s : %s%n", reportable(kv.key + '*'),
                 reportable(kv.fac)));
         });
 
-        b.append("\nAnalyzerGuru extensions:\n");
+        b.append(System.lineSeparator() + "AnalyzerGuru extensions:" + System.lineSeparator());
         byKey(AnalyzerGuru.getExtensionsMap()).forEach((kv) -> {
-            b.append(String.format("*.%-7s : %s\n",
+            b.append(String.format("*.%-7s : %s%n",
                 reportable(kv.key.toLowerCase(Locale.ROOT)),
                 reportable(kv.fac)));
         });
 
-        b.append("\nAnalyzerGuru magic strings:\n");
+        b.append(System.lineSeparator() + "AnalyzerGuru magic strings:" + System.lineSeparator());
         byFactory(AnalyzerGuru.getMagicsMap()).forEach((kv) -> {
-            b.append(String.format("%-23s : %s\n", reportable(kv.key),
+            b.append(String.format("%-23s : %s%n", reportable(kv.key),
                 reportable(kv.fac)));
         });
 
-        b.append("\nAnalyzerGuru magic matchers:\n");
+        b.append(System.lineSeparator() + "AnalyzerGuru magic matchers:" + System.lineSeparator());
         AnalyzerGuru.getAnalyzerFactoryMatchers().forEach((m) -> {
             if (m.getIsPreciseMagic()) {
                 b.append(reportable(m));
@@ -121,7 +134,7 @@ private static String reportable(String value) {
     }
 
     private static String reportable(FileAnalyzerFactory.Matcher m) {
-        final String MATCHER_FMT = "%-11s %-1s %s\n";
+        final String MATCHER_FMT = "%-11s %-1s %s%n";
         StringBuilder b = new StringBuilder();
         String[] lines = splitLines(m.description(), 66);
         for (int i = 0; i < lines.length; ++i) {
@@ -172,8 +185,7 @@ private static String[] splitLines(String str, int width) {
         return res.stream().toArray(String[]::new);
     }
 
-    private static List<MappedFactory> byKey(
-        Map<String, AnalyzerFactory> mapped) {
+    private static List<MappedFactory> byKey(Map<String, AnalyzerFactory> mapped) {
 
         List<MappedFactory> res = mapped.entrySet().stream().map((t) -> {
             return new MappedFactory(t.getKey(), t.getValue());
@@ -186,8 +198,7 @@ private static List<MappedFactory> byKey(
         return res;
     }
 
-    private static List<MappedFactory> byFactory(
-        Map<String, AnalyzerFactory> mapped) {
+    private static List<MappedFactory> byFactory(Map<String, AnalyzerFactory> mapped) {
 
         List<MappedFactory> res = mapped.entrySet().stream().map((t) -> {
             return new MappedFactory(t.getKey(), t.getValue());

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/document/MandocAnalyzer.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2021, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2017, 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.analysis.document;

opengrok-indexer/src/main/java/org/opengrok/indexer/analysis/document/MandocAnalyzerFactory.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2007, 2018, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2007, 2021, Oracle and/or its affiliates. All rights reserved.
  * Copyright (c) 2017, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.analysis.document;
@@ -32,7 +32,7 @@
 
 public class MandocAnalyzerFactory extends FileAnalyzerFactory {
 
-    private static final String NAME = "Mandoc";
+    private static final String NAME = "Manual pages";
 
     public static final Matcher MATCHER = new Matcher() {
         @Override

opengrok-indexer/src/test/java/org/opengrok/indexer/analysis/LuceneCompatibilityTest.java

@@ -18,7 +18,7 @@
  */
 
 /*
- * Copyright (c) 2012, 2020, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 2021, Oracle and/or its affiliates. All rights reserved.
  * Portions Copyright (c) 2020, Chris Fraire <[email protected]>.
  */
 package org.opengrok.indexer.analysis;
@@ -89,7 +89,7 @@ protected void setUp() throws Exception {
     }
 
     public void testCompatibility() throws Exception {
-        for (AnalyzerFactory fa : guru.getAnalyzerFactories()) {
+        for (AnalyzerFactory fa : AnalyzerGuru.getAnalyzerFactories()) {
             String input = "Hello world";
             String[] output = new String[]{"Hello", "world"};
             testA = fa.getAnalyzer();