Make help() output prettier with groups.

Author: Jason Feinstein

library/src/main/java/jwf/debugport/annotations/Command.java

@@ -11,6 +11,12 @@
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface Command {
+    String GROUP_METHOD_INSPECTION = "Method Inspection";
+    String GROUP_FIELD_INSPECTION = "Field Inspection";
+    String GROUP_ACCESS = "Access";
+    String GROUP_OTHER = "Other";
+
+    String group() default GROUP_OTHER;
 
     @Target(ElementType.METHOD)
     @Retention(RetentionPolicy.RUNTIME)

library/src/main/java/jwf/debugport/internal/debug/commands/call.java

@@ -10,7 +10,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_ACCESS)
 public class call {
     /*
      * In order to support a varargs-like behavior when the command is called with no third

library/src/main/java/jwf/debugport/internal/debug/commands/exit.java

@@ -10,7 +10,7 @@
  */
 @Command
 public class exit {
-    @Command.Help("Exit this interpreter")
+    @Command.Help("Exit this interpreter.")
     public static void invoke(Interpreter env, CallStack callStack) {
         env.println("Thanks for using Android DebugPort!");
         try {

library/src/main/java/jwf/debugport/internal/debug/commands/fields.java

@@ -8,7 +8,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_FIELD_INSPECTION)
 public class fields {
     @Command.Help("List all of the fields available for a particular object.")
     public static void invoke(Interpreter interpreter, CallStack callStack, @Command.ParamName("obj") Object obj) {

library/src/main/java/jwf/debugport/internal/debug/commands/fieldsLocal.java

@@ -8,7 +8,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_FIELD_INSPECTION)
 public class fieldsLocal {
     @Command.Help("List all of the fields defined locally for an object.")
     public static void invoke(Interpreter interpreter, CallStack callStack, @Command.ParamName("obj") Object obj) {

library/src/main/java/jwf/debugport/internal/debug/commands/get.java

@@ -9,7 +9,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_ACCESS)
 public class get {
     @Command.Help("Get the value of a field, regardless of access modifiers, on the provided object.")
     public static Object invoke(

library/src/main/java/jwf/debugport/internal/debug/commands/help.java

@@ -12,6 +12,7 @@
 import bsh.CallStack;
 import bsh.Interpreter;
 import jwf.debugport.annotations.Command;
+import jwf.debugport.internal.Utils;
 
 /**
  *
@@ -20,8 +21,9 @@
 public class help {
     private static final ArrayList<CommandHelpInfo> sCommandHelp = new ArrayList<>();
     private static final int MAX_WIDTH = 100;
-    private static final int NAME_START_COL = 2;
-    private static final int HELP_START_COL = 6;
+    private static final int NAME_START_COL = 6;
+    private static final int HELP_START_COL = 10;
+    private static final int GROUP_START_COL = 2;
 
     @Command.Help("Show this help message.")
     public static void invoke(Interpreter interpreter, CallStack callStack) {
@@ -38,8 +40,20 @@ public static void invoke(Interpreter interpreter, CallStack callStack) {
 
             StringBuilder builder = new StringBuilder();
             builder.append("Available Commands:");
+            String lastCommandGroup = "__not_a_group__";
             for (CommandHelpInfo info : sCommandHelp) {
                 builder.append("\n");
+                String commandGroup = info.getCommandGroup();
+                if (!commandGroup.equalsIgnoreCase(lastCommandGroup)) {
+                    if (!lastCommandGroup.equals("__not_a_group__")) {
+                        builder.append("\n");
+                    }
+                    builder.append(CommandUtils.spaces(GROUP_START_COL))
+                            .append(commandGroup)
+                            .append(":")
+                            .append("\n");
+                    lastCommandGroup = commandGroup;
+                }
                 info.appendHelpInfo(builder, nameStartCol, helpStartCol, MAX_WIDTH);
             }
             builder.append("\n");
@@ -54,15 +68,17 @@ public static void registerCommand(Class command) {
         if (!command.isAnnotationPresent(Command.class)) {
             return;
         }
-        sCommandHelp.add(new CommandHelpInfo(command));
+        sCommandHelp.add(new CommandHelpInfo(command, (Command) command.getAnnotation(Command.class)));
         Collections.sort(sCommandHelp);
     }
 
     public static class CommandHelpInfo implements Comparable<CommandHelpInfo> {
         private final Class mCommandClass;
+        private final Command mAnnotation;
 
-        public CommandHelpInfo(Class commandClass) {
+        public CommandHelpInfo(Class commandClass, Command annotation) {
             mCommandClass = commandClass;
+            mAnnotation = annotation;
         }
 
         public int getMaxSignatureLength() {
@@ -82,6 +98,10 @@ public int getMaxSignatureLength() {
             return maxLength;
         }
 
+        public String getCommandGroup() {
+            return mAnnotation.group();
+        }
+
         private String getSignature(Method method) {
             Annotation[][] paramAnnotations = method.getParameterAnnotations();
             Class<?>[] params = method.getParameterTypes();
@@ -167,6 +187,10 @@ public int compareTo(CommandHelpInfo another) {
             if (another == null) {
                 return -1;
             }
+            int groupCompare = mAnnotation.group().compareTo(another.mAnnotation.group());
+            if (groupCompare != 0) {
+                return groupCompare;
+            }
             return mCommandClass.getSimpleName().compareTo(another.mCommandClass.getSimpleName());
         }
 

library/src/main/java/jwf/debugport/internal/debug/commands/methods.java

@@ -8,7 +8,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_METHOD_INSPECTION)
 public class methods {
     @Command.Help("Get the available methods for the provided object.")
     public static void invoke(Interpreter interpreter, CallStack callStack, @Command.ParamName("obj") Object obj) {

library/src/main/java/jwf/debugport/internal/debug/commands/methodsLocal.java

@@ -8,7 +8,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_METHOD_INSPECTION)
 public class methodsLocal {
     @Command.Help("Show all of the locally-declared methods for the provided object.")
     public static void invoke(Interpreter interpreter, CallStack callStack, @Command.ParamName("obj") Object obj) {

library/src/main/java/jwf/debugport/internal/debug/commands/set.java

@@ -9,7 +9,7 @@
 /**
  *
  */
-@Command
+@Command(group = Command.GROUP_ACCESS)
 public class set {
     @Command.Help("Set the value of a field on the provided object to the given value, regardless of access modifiers.")
     public static Object invoke(