Add SBCommandInterpreter::UserCommandExists

[jingham]

Summary

Turns out there's no API to find out if a user command exists. There's SBCommandInterpreter::CommandExists but that only checks for built-in commands. I needed this to write a test for an upcoming patch, and it's a useful thing to know. I added docs so it's clear CommandExists is for builtin commands and this one is for command script add commands.

[mib]

LGTM! Sorry I forgot about this!

lldb/include/lldb/API/SBCommandInterpreter.h

public:
   GetArgumentDescriptionAsCString(const lldb::CommandArgumentType arg_type);
 
   static bool EventIsCommandInterpreterEvent(const lldb::SBEvent &event);
 
   explicit operator bool() const;
 
   bool IsValid() const;
 
+  /// Return whether a built-in command with the passed in
+  /// name or command path exists.
+  ///
+  /// \param[in] cmd
+  ///   The command or command path to search for.
+  ///
+  /// \return
+  ///   \b true if the command exists, \b false otherwise.
   bool CommandExists(const char *cmd);
 
+  /// Return whether a user defined command with the passed in
+  /// name or command path exists.
+  ///
+  /// \param[in] cmd
+  ///   The command or command path to search for.
+  ///
+  /// \return
+  ///   \b true if the command exists, \b false otherwise.
+  bool UserCommandExists(const char *cmd);
+
+  /// Return whether the passed in name or command path
+  /// exists and is an alias to some other command.
+  ///
+  /// \param[in] cmd
+  ///   The command or command path to search for.
+  ///
+  /// \return
+  ///   \b true if the command exists, \b false otherwise.
   bool AliasExists(const char *cmd);
 
   lldb::SBBroadcaster GetBroadcaster();
 
   static const char *GetBroadcasterClass();
 
   bool HasCommands();
 

lldb/source/API/SBCommandInterpreter.cpp

 
 bool SBCommandInterpreter::CommandExists(const char *cmd) {
   LLDB_INSTRUMENT_VA(this, cmd);
 
   return (((cmd != nullptr) && IsValid()) ? m_opaque_ptr->CommandExists(cmd)
                                           : false);
 }
 
+bool SBCommandInterpreter::UserCommandExists(const char *cmd) {
+  LLDB_INSTRUMENT_VA(this, cmd);
+
+  return (((cmd != nullptr) && IsValid()) ? m_opaque_ptr->UserCommandExists(cmd)
+                                          : false);
+}
+
 bool SBCommandInterpreter::AliasExists(const char *cmd) {
   LLDB_INSTRUMENT_VA(this, cmd);
 
   return (((cmd != nullptr) && IsValid()) ? m_opaque_ptr->AliasExists(cmd)
                                           : false);
 }
 
 bool SBCommandInterpreter::IsActive() {

lldb/test/API/commands/command/script/TestCommandScript.py

class CmdPythonTestCase(TestBase):
 
     def test(self):
         self.build()
         self.pycmd_tests()
 
     def pycmd_tests(self):
         self.runCmd("command source py_import")
 
+        # Test that we did indeed add these commands as user commands:
+        interp = self.dbg.GetCommandInterpreter()
+        self.expectTrue(interp.UserCommandExists("foobar"), "foobar exists")
+        self.expectFalse(interp.CommandExists("foobar"), "It is not a builtin.")
+
         # Test a bunch of different kinds of python callables with
         # both 4 and 5 positional arguments.
         self.expect("foobar", substrs=["All good"])
         self.expect("foobar4", substrs=["All good"])
         self.expect("vfoobar", substrs=["All good"])
         self.expect("v5foobar", substrs=["All good"])
         self.expect("sfoobar", substrs=["All good"])
         self.expect("cfoobar", substrs=["All good"])