Support multiple values in plugin list

Author: dmpots

lldb/source/Commands/CommandObjectPlugin.cpp

@@ -197,20 +197,49 @@ List only the plugin 'foo' matching a fully qualified name exactly
 protected:
   void DoExecute(Args &command, CommandReturnObject &result) override {
     size_t argc = command.GetArgumentCount();
-    if (argc > 1) {
-      result.AppendError("'plugin list' requires zero or one arguments");
-      return;
-    }
-    llvm::StringRef pattern = argc ? command[0].ref() : "";
     result.SetStatus(eReturnStatusSuccessFinishResult);
 
-    bool found_matching = false;
-    if (m_options.m_json_format) {
-      llvm::json::Object obj = PluginManager::GetJSON(pattern);
-      found_matching = obj.size() > 0;
-      if (found_matching)
-        result.AppendMessage(ConvertJSONToPrettyString(std::move(obj)));
-    } else {
+    // Create a temporary vector to hold the patterns to simplify the logic
+    // for the case when the user passes no patterns
+    std::vector<llvm::StringRef> patterns;
+    patterns.reserve(argc == 0 ? 1 : argc);
+    if (argc == 0)
+      patterns.push_back("");
+    else
+      for (size_t i = 0; i < argc; ++i)
+        patterns.push_back(command[i].ref());
+
+    if (m_options.m_json_format)
+      OutputJsonFormat(patterns, result);
+    else
+      OutputTextFormat(patterns, result);
+  }
+
+private:
+  void OutputJsonFormat(const std::vector<llvm::StringRef> &patterns,
+                        CommandReturnObject &result) {
+    llvm::json::Object obj;
+    bool found_empty = false;
+    for (const llvm::StringRef pattern : patterns) {
+      llvm::json::Object pat_obj = PluginManager::GetJSON(pattern);
+      if (pat_obj.empty()) {
+        found_empty = true;
+        result.AppendErrorWithFormat(
+            "Found no matching plugins for pattern '%s'", pattern.data());
+        break;
+      }
+      for (auto &entry : pat_obj) {
+        obj[entry.first] = std::move(entry.second);
+      }
+    }
+    if (!found_empty) {
+      result.AppendMessage(ConvertJSONToPrettyString(std::move(obj)));
+    }
+  }
+
+  void OutputTextFormat(const std::vector<llvm::StringRef> &patterns,
+                        CommandReturnObject &result) {
+    for (const llvm::StringRef pattern : patterns) {
       int num_matching = ActOnMatchingPlugins(
           pattern, [&](const PluginNamespace &plugin_namespace,
                        const std::vector<RegisteredPluginInfo> &plugins) {
@@ -221,11 +250,12 @@ List only the plugin 'foo' matching a fully qualified name exactly
                   plugin.name.data(), plugin.description.data());
             }
           });
-      found_matching = num_matching > 0;
+      if (num_matching == 0) {
+        result.AppendErrorWithFormat(
+            "Found no matching plugins for pattern '%s'", pattern.data());
+        break;
+      }
     }
-
-    if (!found_matching)
-      result.AppendErrorWithFormat("Found no matching plugins");
   }
 
   PluginListCommandOptions m_options;

lldb/test/Shell/Commands/command-plugin-list.test

@@ -27,12 +27,20 @@ plugin list system-runtime
 # CHECK: system-runtime
 # CHECK:  [+] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
 
+# Test plugin list on multiple args works.
+plugin list system-runtime instrumentation-runtime.AddressSanitizer
+# CHECK-LABEL: plugin list system-runtime instrumentation-runtime.AddressSanitizer
+# CHECK: system-runtime
+# CHECK:  [+] systemruntime-macosx           System runtime plugin for Mac OS X native libraries
+# CHECK: instrumentation-runtime
+# CHECK:  [+] AddressSanitizer               AddressSanitizer instrumentation runtime plugin.
+
 # Test json output for plugin list.
 plugin list --json
 # CHECK-LABEL plugin list --json
 # CHECK: {
-# CHECK-DAG:  "system-runtime":
 # CHECK-DAG:  "instrumentation-runtime":
+# CHECK-DAG:  "system-runtime":
 # CHECK: }
 
 # Test json output for plugin list with a namespace
@@ -47,17 +55,28 @@ plugin list system-runtime --json
 # CHECK:  ]
 # CHECK: }
 
+# Test json output for listing multiple plugins
+plugin list --json system-runtime instrumentation-runtime.AddressSanitizer
+# CHECK-LABEL plugin list --json system-runtime instrumentation-runtime.AddressSanitizer
+# CHECK: {
+# CHECK-DAG:  "instrumentation-runtime":
+# CHECK-DAG:    "name": "AddressSanitizer"
+# CHECK-DAG:  "system-runtime":
+# CHECK: }
+
 
 # Test plugin list does not match a plugin name by substring.
 # RUN: %lldb -o "plugin list macosx" 2>&1 | FileCheck %s --check-prefix=ERROR_PLUGIN_NOT_FOUND
 
 # Test plugin list does not match a plugin namespace by substring.
 # RUN: %lldb -o "plugin list system-runtime." 2>&1 | FileCheck %s --check-prefix=ERROR_PLUGIN_NOT_FOUND
 
+# Test plugin list returns an error for unknown second argument
+# RUN: %lldb -o "plugin list system-runtime foo" 2>&1 | FileCheck %s --check-prefix=ERROR_PLUGIN_NOT_FOUND
+
+# Test plugin list returns an error for unknown second argument
+# RUN: %lldb -o "plugin list --json system-runtime foo" 2>&1 | FileCheck %s --check-prefix=ERROR_PLUGIN_NOT_FOUND
+
 # Test plugin list for unknown plugin returns an error.
 # RUN: %lldb -o "plugin list some-plugin-that-does-not-exist" 2>&1 | FileCheck %s --check-prefix=ERROR_PLUGIN_NOT_FOUND
 # ERROR_PLUGIN_NOT_FOUND: error: Found no matching plugins
-
-# Test plugin list fails on multiple arguments.
-# RUN: %lldb -o "plugin list a b c" 2>&1 | FileCheck %s --check-prefix=ERROR_ARGUMENTS
-# ERROR_ARGUMENTS: error: 'plugin list' requires zero or one arguments