LLDB  mainline
CommandObjectPlugin.cpp
Go to the documentation of this file.
1 //===-- CommandObjectPlugin.cpp -------------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "CommandObjectPlugin.h"
12 
13 using namespace lldb;
14 using namespace lldb_private;
15 
17 public:
19  : CommandObjectParsed(interpreter, "plugin load",
20  "Import a dylib that implements an LLDB plugin.",
21  nullptr) {
23  CommandArgumentData cmd_arg;
24 
25  // Define the first (and only) variant of this arg.
26  cmd_arg.arg_type = eArgTypeFilename;
28 
29  // There is only one variant this argument could be; put it into the
30  // argument entry.
31  arg1.push_back(cmd_arg);
32 
33  // Push the data for the first argument into the m_arguments vector.
34  m_arguments.push_back(arg1);
35  }
36 
37  ~CommandObjectPluginLoad() override = default;
38 
39  void
41  OptionElementVector &opt_element_vector) override {
42  CommandCompletions::InvokeCommonCompletionCallbacks(
43  GetCommandInterpreter(), CommandCompletions::eDiskFileCompletion,
44  request, nullptr);
45  }
46 
47 protected:
48  bool DoExecute(Args &command, CommandReturnObject &result) override {
49  size_t argc = command.GetArgumentCount();
50 
51  if (argc != 1) {
52  result.AppendError("'plugin load' requires one argument");
54  return false;
55  }
56 
57  Status error;
58 
59  FileSpec dylib_fspec(command[0].ref());
60  FileSystem::Instance().Resolve(dylib_fspec);
61 
62  if (GetDebugger().LoadPlugin(dylib_fspec, error))
64  else {
65  result.AppendError(error.AsCString());
67  }
68 
69  return result.Succeeded();
70  }
71 };
72 
73 CommandObjectPlugin::CommandObjectPlugin(CommandInterpreter &interpreter)
74  : CommandObjectMultiword(interpreter, "plugin",
75  "Commands for managing LLDB plugins.",
76  "plugin <subcommand> [<subcommand-options>]") {
77  LoadSubCommand("load",
78  CommandObjectSP(new CommandObjectPluginLoad(interpreter)));
79 }
80 
std::vector< CommandArgumentData > CommandArgumentEntry
A command line argument class.
Definition: Args.h:33
A class that represents a running process on the host machine.
bool LoadSubCommand(llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj) override
void HandleArgumentCompletion(CompletionRequest &request, OptionElementVector &opt_element_vector) override
The input array contains a parsed version of the line.
static llvm::sys::DynamicLibrary LoadPlugin(const lldb::DebuggerSP &debugger_sp, const FileSpec &spec, Status &error)
Definition: SBDebugger.cpp:63
size_t GetArgumentCount() const
Gets the number of arguments left in this command object.
Definition: Args.cpp:254
A file utility class.
Definition: FileSpec.h:56
"lldb/Utility/ArgCompletionRequest.h"
std::vector< OptionArgElement > OptionElementVector
Definition: Options.h:41
CommandObjectPluginLoad(CommandInterpreter &interpreter)
void void AppendError(llvm::StringRef in_string)
bool DoExecute(Args &command, CommandReturnObject &result) override
Definition: SBAddress.h:15
const char * AsCString(const char *default_error_str="unknown error") const
Get the error string associated with the current error.
Definition: Status.cpp:131
void SetStatus(lldb::ReturnStatus status)
An error handling class.
Definition: Status.h:44