1 //===-- CommandObjectPlugin.cpp ---------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
12 // Other libraries and framework includes
14 #include "CommandObjectPlugin.h"
15 #include "lldb/Host/Host.h"
16 #include "lldb/Interpreter/CommandInterpreter.h"
17 #include "lldb/Interpreter/CommandReturnObject.h"
20 using namespace lldb_private;
22 class CommandObjectPluginLoad : public CommandObjectParsed {
24 CommandObjectPluginLoad(CommandInterpreter &interpreter)
25 : CommandObjectParsed(interpreter, "plugin load",
26 "Import a dylib that implements an LLDB plugin.",
28 CommandArgumentEntry arg1;
29 CommandArgumentData cmd_arg;
31 // Define the first (and only) variant of this arg.
32 cmd_arg.arg_type = eArgTypeFilename;
33 cmd_arg.arg_repetition = eArgRepeatPlain;
35 // There is only one variant this argument could be; put it into the
37 arg1.push_back(cmd_arg);
39 // Push the data for the first argument into the m_arguments vector.
40 m_arguments.push_back(arg1);
43 ~CommandObjectPluginLoad() override = default;
45 int HandleArgumentCompletion(Args &input, int &cursor_index,
46 int &cursor_char_position,
47 OptionElementVector &opt_element_vector,
48 int match_start_point, int max_return_elements,
50 StringList &matches) override {
51 auto completion_str = input[cursor_index].ref;
52 completion_str = completion_str.take_front(cursor_char_position);
54 CommandCompletions::InvokeCommonCompletionCallbacks(
55 GetCommandInterpreter(), CommandCompletions::eDiskFileCompletion,
56 completion_str, match_start_point, max_return_elements, nullptr,
57 word_complete, matches);
58 return matches.GetSize();
62 bool DoExecute(Args &command, CommandReturnObject &result) override {
63 size_t argc = command.GetArgumentCount();
66 result.AppendError("'plugin load' requires one argument");
67 result.SetStatus(eReturnStatusFailed);
73 FileSpec dylib_fspec(command[0].ref, true);
75 if (m_interpreter.GetDebugger().LoadPlugin(dylib_fspec, error))
76 result.SetStatus(eReturnStatusSuccessFinishResult);
78 result.AppendError(error.AsCString());
79 result.SetStatus(eReturnStatusFailed);
82 return result.Succeeded();
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)));
94 CommandObjectPlugin::~CommandObjectPlugin() = default;