xref: /llvm-project/lldb/source/Commands/CommandObjectPlugin.cpp (revision 2443bbd4aacd73b61cffe8e7a80a8a320b14dcde)
1 //===-- CommandObjectPlugin.cpp ---------------------------------*- C++ -*-===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 // C Includes
11 // C++ Includes
12 // Other libraries and framework includes
13 // Project includes
14 #include "CommandObjectPlugin.h"
15 #include "lldb/Host/Host.h"
16 #include "lldb/Interpreter/CommandInterpreter.h"
17 #include "lldb/Interpreter/CommandReturnObject.h"
18 
19 using namespace lldb;
20 using namespace lldb_private;
21 
22 class CommandObjectPluginLoad : public CommandObjectParsed {
23 public:
24   CommandObjectPluginLoad(CommandInterpreter &interpreter)
25       : CommandObjectParsed(interpreter, "plugin load",
26                             "Import a dylib that implements an LLDB plugin.",
27                             nullptr) {
28     CommandArgumentEntry arg1;
29     CommandArgumentData cmd_arg;
30 
31     // Define the first (and only) variant of this arg.
32     cmd_arg.arg_type = eArgTypeFilename;
33     cmd_arg.arg_repetition = eArgRepeatPlain;
34 
35     // There is only one variant this argument could be; put it into the
36     // argument entry.
37     arg1.push_back(cmd_arg);
38 
39     // Push the data for the first argument into the m_arguments vector.
40     m_arguments.push_back(arg1);
41   }
42 
43   ~CommandObjectPluginLoad() override = default;
44 
45   int HandleArgumentCompletion(
46       CompletionRequest &request,
47       OptionElementVector &opt_element_vector) override {
48     auto completion_str = request.GetParsedLine()[request.GetCursorIndex()].ref;
49     completion_str = completion_str.take_front(request.GetCursorCharPosition());
50 
51     bool word_complete = request.GetWordComplete();
52     CommandCompletions::InvokeCommonCompletionCallbacks(
53         GetCommandInterpreter(), CommandCompletions::eDiskFileCompletion,
54         completion_str, request.GetMatchStartPoint(),
55         request.GetMaxReturnElements(), nullptr, word_complete,
56         request.GetMatches());
57     request.SetWordComplete(word_complete);
58     return request.GetMatches().GetSize();
59   }
60 
61 protected:
62   bool DoExecute(Args &command, CommandReturnObject &result) override {
63     size_t argc = command.GetArgumentCount();
64 
65     if (argc != 1) {
66       result.AppendError("'plugin load' requires one argument");
67       result.SetStatus(eReturnStatusFailed);
68       return false;
69     }
70 
71     Status error;
72 
73     FileSpec dylib_fspec(command[0].ref, true);
74 
75     if (m_interpreter.GetDebugger().LoadPlugin(dylib_fspec, error))
76       result.SetStatus(eReturnStatusSuccessFinishResult);
77     else {
78       result.AppendError(error.AsCString());
79       result.SetStatus(eReturnStatusFailed);
80     }
81 
82     return result.Succeeded();
83   }
84 };
85 
86 CommandObjectPlugin::CommandObjectPlugin(CommandInterpreter &interpreter)
87     : CommandObjectMultiword(interpreter, "plugin",
88                              "Commands for managing LLDB plugins.",
89                              "plugin <subcommand> [<subcommand-options>]") {
90   LoadSubCommand("load",
91                  CommandObjectSP(new CommandObjectPluginLoad(interpreter)));
92 }
93 
94 CommandObjectPlugin::~CommandObjectPlugin() = default;
95