A few tweaks to the docs command

Author: Matyrobbrt

gradle/libs.versions.toml

@@ -32,7 +32,7 @@ webhooks = "0.8.2"
 eventdispatcher = "1.7.1"
 asmutils = "0.4.0"
 typetools = "0.6.3"
-javadocapi = "21ad5c1759"
+javadocapi = "25c84a4"
 commons-io = "2.11.0"
 caffeine = "3.1.1"
 urldetector = "0.1.23"

src/commander/java/com/mcmoddev/mmdbot/commander/docs/ConfigBasedElementLoader.java

@@ -25,6 +25,7 @@
 import de.ialistannen.javadocapi.indexing.OnlineJavadocIndexer;
 import de.ialistannen.javadocapi.rendering.Java11PlusLinkResolver;
 import de.ialistannen.javadocapi.spoon.JavadocElementExtractor;
+import de.ialistannen.javadocapi.spoon.JavadocLauncher;
 import de.ialistannen.javadocapi.spoon.filtering.IndexerFilterChain;
 import de.ialistannen.javadocapi.spoon.filtering.ParallelProcessor;
 import de.ialistannen.javadocapi.storage.AggregatedElementLoader;
@@ -38,6 +39,7 @@
 import org.spongepowered.configurate.hocon.HoconConfigurationLoader;
 import spoon.Launcher;
 import spoon.OutputType;
+import spoon.support.compiler.ProgressLogger;
 import spoon.support.compiler.ZipFolder;
 
 import java.io.FileOutputStream;
@@ -125,7 +127,7 @@ private void tryIndex(final String indexUrl, final SqliteStorage storage) throws
             Files.createDirectories(parent);
         }
         Files.createFile(storage.getFile());
-        final var launcher = new Launcher();
+        final var launcher = new JavadocLauncher();
         if (indexUrl.startsWith("https://") || indexUrl.startsWith("http://")) {
             log.info("Downloading {} for indexing...", indexUrl);
             try (final var readChannel = Channels.newChannel(new URL(indexUrl).openStream())) {
@@ -148,19 +150,20 @@ private void tryIndex(final String indexUrl, final SqliteStorage storage) throws
         index(launcher, storage);
     }
 
-    private void index(final Launcher launcher, final SqliteStorage storage) {
-        log.warn("Started indexing JavaDocs...");
+    static void index(final Launcher launcher, final SqliteStorage storage) {
+        log.warn("Started indexing JavaDocs for {}...", storage.getFile());
         launcher.getEnvironment().setShouldCompile(false);
         launcher.getEnvironment().disableConsistencyChecks();
         launcher.getEnvironment().setOutputType(OutputType.NO_OUTPUT);
         launcher.getEnvironment().setCommentEnabled(true);
         launcher.getEnvironment().setComplianceLevel(16);
+        launcher.getEnvironment().setSpoonProgress(new LoggingProcessLogger(launcher));
 
         final var model = launcher.buildModel();
         final var extractor = new JavadocElementExtractor();
         final var processor = new ParallelProcessor(
             new IndexerFilterChain(Set.of("*")).asFilter(),
-            Runtime.getRuntime().availableProcessors()
+            1
         );
         model.getAllModules()
             .forEach(it -> processor.process(
@@ -196,4 +199,34 @@ private static List<ExternalJavadocReference> indexExternalJavadoc(List<String>
 
         return references;
     }
+
+    public static class LoggingProcessLogger extends ProgressLogger {
+
+        public int touchedClasses;
+
+        public LoggingProcessLogger(Launcher launcher) {
+            super(launcher.getEnvironment());
+            touchedClasses = 0;
+        }
+
+        @Override
+        public void start(Process process) {
+            log.warn("Stating phase {}", process);
+            touchedClasses = 0;
+        }
+
+        @Override
+        public void step(Process process, String task, int taskId, int nbTask) {
+            log.info("Working on {} as part of {}", task, process);
+            touchedClasses++;
+            if (touchedClasses % 1000 == 0) {
+                log.warn("Phase {} has discovered {} classes so far. Currently working on {}", process, touchedClasses, task);
+            }
+        }
+
+        @Override
+        public void end(Process process) {
+            log.warn("Phase {} done! Discovered classes: {}", process, touchedClasses);
+        }
+    }
 }

src/commander/java/com/mcmoddev/mmdbot/commander/docs/CustomDocFormatter.java

@@ -0,0 +1,110 @@
+/*
+ * MMDBot - https://github.com/MinecraftModDevelopment/MMDBot
+ * Copyright (C) 2016-2022 <MMD - MinecraftModDevelopment>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation;
+ * Specifically version 2.1 of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ * USA
+ * https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+ */
+package com.mcmoddev.mmdbot.commander.docs;
+
+import com.google.common.collect.Lists;
+import de.ialistannen.javadocapi.model.JavadocElement;
+import de.ialistannen.javadocapi.model.QualifiedName;
+import de.ialistannen.javadocapi.model.types.JavadocType;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Optional;
+import java.util.stream.Collectors;
+
+public class CustomDocFormatter implements DocsEmbed.DocFormatter {
+    @Override
+    public String format(final JavadocElement element, final JavadocElement.DeclarationStyle style) {
+        if (element instanceof JavadocType type) {
+            return formatType(type, style);
+        }
+
+        return element.getDeclaration(style);
+    }
+
+    public String formatType(final JavadocType type, final JavadocElement.DeclarationStyle style) {
+        final var result = new StringBuilder();
+
+        if (!type.getAnnotations().isEmpty()) {
+            result.append(type.getAnnotations().stream()
+                .map(it -> it.getDeclaration(style))
+                .collect(Collectors.joining("\n")));
+            result.append("\n");
+        }
+
+        result.append(String.join(" ", filterModifiers(type))).append(" ");
+        result.append(type.getType().getKeyword()).append(" ");
+
+        result.append(type.getQualifiedName().formatted(style));
+
+        if (!type.getTypeParameters().isEmpty()) {
+            result.append(type.getTypeParameters().stream()
+                .map(it -> it.getDeclaration(style))
+                .collect(Collectors.joining(", ", "<", ">")));
+        }
+
+        if (type.getType() == JavadocType.Type.ANNOTATION) {
+            final var members = type.getMembers().stream()
+                    .flatMap(it -> getMethodName(it).stream())
+                    .filter(QualifiedName::isMethod)
+                    .map(QualifiedName::asString)
+                    .toList();
+            if (!members.isEmpty()) {
+                final var partitioned = Lists.partition(members, 5);
+                result.append("(\n");
+                result.append(String.join("\n", partitioned.stream()
+                    .map(it -> "  " + String.join(", ", it))
+                    .toList()));
+                result.append("\n)");
+            }
+        }
+
+        if (type.getSuperClass() != null) {
+            result.append(" extends ").append(type.getSuperClass().getDeclaration(style));
+        }
+
+        if (!type.getSuperInterfaces().isEmpty()) {
+            result.append(" implements ").append(type.getSuperInterfaces().stream()
+                .map(it -> it.getDeclaration(style))
+                .collect(Collectors.joining(", ")));
+        }
+
+        return result.toString();
+    }
+
+    private List<String> filterModifiers(final JavadocType type) {
+        final var modifiers = new ArrayList<>(type.getModifiers());
+        if (type.getType() == JavadocType.Type.INTERFACE || type.getType() == JavadocType.Type.ANNOTATION) {
+            modifiers.remove("abstract");
+        }
+        return modifiers;
+    }
+
+    public Optional<QualifiedName> getMethodName(QualifiedName qualifiedName) {
+        if (qualifiedName.asString().contains("#")) {
+            return Optional.of(new QualifiedName(
+                qualifiedName.asString().substring(qualifiedName.asString().indexOf("#") + 1),
+                qualifiedName.getModuleName().orElse(null)
+            ));
+        }
+        return Optional.empty();
+    }
+}

src/commander/java/com/mcmoddev/mmdbot/commander/docs/DocsCommand.java

@@ -139,7 +139,7 @@ protected void execute(final SlashCommandEvent event) {
         }
 
         final var query = event.getOption("query", "", OptionMapping::getAsString);
-        if (query.length() <= 2) {
+        if (query.length() <= 1) {
             event.deferReply(true)
                 .setContent("Expected at least 2 characters for the query!")
                 .queue();
@@ -235,7 +235,7 @@ void replyResult(long userId, UUID buttonId, BiFunction<Message, Collection<Fuzz
                 buttonId
             );
         } else {
-            replier.apply(new MessageBuilder("Multiple results have been found for this qualified name.")
+            replier.apply(new MessageBuilder("No results have been found for this qualified name.")
                 .setActionRows(ActionRow.of(DismissListener.createDismissButton(userId)))
                 .build(), List.of()).queue();
         }

src/commander/java/com/mcmoddev/mmdbot/commander/docs/DocsConfig.java

@@ -67,7 +67,7 @@ public static final class Database {
         @Getter
         @Required
         @Setting("indexUrl")
-        @Comment("An URL or a path relative to '/docs' which ")
+        @Comment("An URL or a path relative to '/docs' from which to index the javadocs, from the sources")
         private String indexUrl = "https://repo1.maven.org/maven2/com/google/code/gson/gson/2.9.0/gson-2.9.0-sources.jar";
     }
 

src/commander/java/com/mcmoddev/mmdbot/commander/docs/ManualIndexer.java

@@ -0,0 +1,59 @@
+/*
+ * MMDBot - https://github.com/MinecraftModDevelopment/MMDBot
+ * Copyright (C) 2016-2022 <MMD - MinecraftModDevelopment>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation;
+ * Specifically version 2.1 of the License.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+ * USA
+ * https://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
+ */
+package com.mcmoddev.mmdbot.commander.docs;
+
+import de.ialistannen.javadocapi.spoon.JavadocLauncher;
+import de.ialistannen.javadocapi.storage.ConfiguredGson;
+import de.ialistannen.javadocapi.storage.SqliteStorage;
+import spoon.support.compiler.ZipFolder;
+
+import java.io.File;
+import java.io.IOException;
+import java.net.URL;
+import java.net.URLClassLoader;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.util.ArrayList;
+
+public class ManualIndexer {
+    public static void main(String[] args) throws Exception {
+        final var inPath = Path.of("run/thecommander/docs/input/groovy-4.0.4-sources.jar");
+        final var outPath = Path.of("run/thecommander/docs/groovy_docs.db");
+        Files.createFile(outPath);
+
+        final var launcher = new JavadocLauncher();
+        launcher.addInputResource(new ZipFolder(inPath.toFile()));
+
+        final var inLibs = new ArrayList<URL>();
+
+        inLibs.add(get("\"C:\\Users\\rober\\.gradle\\caches\\modules-2\\files-2.1\\org.codehaus.gpars\\gpars\\1.2.1\\c3ea0fbcd67a163bd5e3a3efdaa3428262d0d437\\gpars-1.2.1.jar\""));
+
+        launcher.getEnvironment().setInputClassLoader(new URLClassLoader(inLibs.toArray(URL[]::new)));
+
+        ConfigBasedElementLoader.index(launcher, new SqliteStorage(
+            ConfiguredGson.create(), outPath
+        ));
+    }
+
+    private static URL get(@SuppressWarnings("SameParameterValue") String path) throws IOException {
+        return new File(path.replace("\"", "")).toURI().toURL();
+    }
+}

src/commander/java/com/mcmoddev/mmdbot/commander/docs/NormalDocsSender.java

@@ -60,9 +60,7 @@
 
 public class NormalDocsSender implements DocsSender {
 
-    // TODO maybe remove the `abstract` part from interfaces, and other similar cases
-    // Maybe also add the parameters an annotation can have
-    private final DocsEmbed.DocFormatter formatter = JavadocElement::getDeclaration;
+    private final DocsEmbed.DocFormatter formatter = new CustomDocFormatter();
     private final NameShortener nameShortener = new NameShortener();
 
     @Override