15ffd83dbSDimitry Andric //===-- CommandObjectBreakpointCommand.cpp --------------------------------===//
2*0b57cec5SDimitry Andric //
3*0b57cec5SDimitry Andric // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4*0b57cec5SDimitry Andric // See https://llvm.org/LICENSE.txt for license information.
5*0b57cec5SDimitry Andric // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6*0b57cec5SDimitry Andric //
7*0b57cec5SDimitry Andric //===----------------------------------------------------------------------===//
8*0b57cec5SDimitry Andric 
9*0b57cec5SDimitry Andric #include "CommandObjectBreakpointCommand.h"
10*0b57cec5SDimitry Andric #include "CommandObjectBreakpoint.h"
11*0b57cec5SDimitry Andric #include "lldb/Breakpoint/Breakpoint.h"
12*0b57cec5SDimitry Andric #include "lldb/Breakpoint/BreakpointIDList.h"
13*0b57cec5SDimitry Andric #include "lldb/Breakpoint/BreakpointLocation.h"
14*0b57cec5SDimitry Andric #include "lldb/Core/IOHandler.h"
15*0b57cec5SDimitry Andric #include "lldb/Host/OptionParser.h"
16*0b57cec5SDimitry Andric #include "lldb/Interpreter/CommandInterpreter.h"
17*0b57cec5SDimitry Andric #include "lldb/Interpreter/CommandReturnObject.h"
18*0b57cec5SDimitry Andric #include "lldb/Interpreter/OptionArgParser.h"
19480093f4SDimitry Andric #include "lldb/Interpreter/OptionGroupPythonClassWithDict.h"
20*0b57cec5SDimitry Andric #include "lldb/Target/Target.h"
21*0b57cec5SDimitry Andric 
22*0b57cec5SDimitry Andric using namespace lldb;
23*0b57cec5SDimitry Andric using namespace lldb_private;
24*0b57cec5SDimitry Andric 
25*0b57cec5SDimitry Andric // FIXME: "script-type" needs to have its contents determined dynamically, so
269dba64beSDimitry Andric // somebody can add a new scripting language to lldb and have it pickable here
279dba64beSDimitry Andric // without having to change this enumeration by hand and rebuild lldb proper.
28*0b57cec5SDimitry Andric static constexpr OptionEnumValueElement g_script_option_enumeration[] = {
299dba64beSDimitry Andric     {
309dba64beSDimitry Andric         eScriptLanguageNone,
319dba64beSDimitry Andric         "command",
329dba64beSDimitry Andric         "Commands are in the lldb command interpreter language",
339dba64beSDimitry Andric     },
349dba64beSDimitry Andric     {
359dba64beSDimitry Andric         eScriptLanguagePython,
369dba64beSDimitry Andric         "python",
379dba64beSDimitry Andric         "Commands are in the Python language.",
389dba64beSDimitry Andric     },
399dba64beSDimitry Andric     {
40480093f4SDimitry Andric         eScriptLanguageLua,
41480093f4SDimitry Andric         "lua",
42480093f4SDimitry Andric         "Commands are in the Lua language.",
43480093f4SDimitry Andric     },
44480093f4SDimitry Andric     {
45480093f4SDimitry Andric         eScriptLanguageDefault,
469dba64beSDimitry Andric         "default-script",
479dba64beSDimitry Andric         "Commands are in the default scripting language.",
489dba64beSDimitry Andric     },
499dba64beSDimitry Andric };
50*0b57cec5SDimitry Andric 
51*0b57cec5SDimitry Andric static constexpr OptionEnumValues ScriptOptionEnum() {
52*0b57cec5SDimitry Andric   return OptionEnumValues(g_script_option_enumeration);
53*0b57cec5SDimitry Andric }
54*0b57cec5SDimitry Andric 
559dba64beSDimitry Andric #define LLDB_OPTIONS_breakpoint_command_add
569dba64beSDimitry Andric #include "CommandOptions.inc"
57*0b57cec5SDimitry Andric 
58*0b57cec5SDimitry Andric class CommandObjectBreakpointCommandAdd : public CommandObjectParsed,
59*0b57cec5SDimitry Andric                                           public IOHandlerDelegateMultiline {
60*0b57cec5SDimitry Andric public:
61*0b57cec5SDimitry Andric   CommandObjectBreakpointCommandAdd(CommandInterpreter &interpreter)
62*0b57cec5SDimitry Andric       : CommandObjectParsed(interpreter, "add",
63*0b57cec5SDimitry Andric                             "Add LLDB commands to a breakpoint, to be executed "
64*0b57cec5SDimitry Andric                             "whenever the breakpoint is hit."
65*0b57cec5SDimitry Andric                             "  If no breakpoint is specified, adds the "
66*0b57cec5SDimitry Andric                             "commands to the last created breakpoint.",
67*0b57cec5SDimitry Andric                             nullptr),
68*0b57cec5SDimitry Andric         IOHandlerDelegateMultiline("DONE",
69*0b57cec5SDimitry Andric                                    IOHandlerDelegate::Completion::LLDBCommand),
70480093f4SDimitry Andric         m_options(), m_func_options("breakpoint command", false, 'F') {
71*0b57cec5SDimitry Andric     SetHelpLong(
72*0b57cec5SDimitry Andric         R"(
73*0b57cec5SDimitry Andric General information about entering breakpoint commands
74*0b57cec5SDimitry Andric ------------------------------------------------------
75*0b57cec5SDimitry Andric 
76*0b57cec5SDimitry Andric )"
77*0b57cec5SDimitry Andric         "This command will prompt for commands to be executed when the specified \
78*0b57cec5SDimitry Andric breakpoint is hit.  Each command is typed on its own line following the '> ' \
79*0b57cec5SDimitry Andric prompt until 'DONE' is entered."
80*0b57cec5SDimitry Andric         R"(
81*0b57cec5SDimitry Andric 
82*0b57cec5SDimitry Andric )"
83*0b57cec5SDimitry Andric         "Syntactic errors may not be detected when initially entered, and many \
84*0b57cec5SDimitry Andric malformed commands can silently fail when executed.  If your breakpoint commands \
85*0b57cec5SDimitry Andric do not appear to be executing, double-check the command syntax."
86*0b57cec5SDimitry Andric         R"(
87*0b57cec5SDimitry Andric 
88*0b57cec5SDimitry Andric )"
89*0b57cec5SDimitry Andric         "Note: You may enter any debugger command exactly as you would at the debugger \
90*0b57cec5SDimitry Andric prompt.  There is no limit to the number of commands supplied, but do NOT enter \
91*0b57cec5SDimitry Andric more than one command per line."
92*0b57cec5SDimitry Andric         R"(
93*0b57cec5SDimitry Andric 
94*0b57cec5SDimitry Andric Special information about PYTHON breakpoint commands
95*0b57cec5SDimitry Andric ----------------------------------------------------
96*0b57cec5SDimitry Andric 
97*0b57cec5SDimitry Andric )"
98*0b57cec5SDimitry Andric         "You may enter either one or more lines of Python, including function \
99*0b57cec5SDimitry Andric definitions or calls to functions that will have been imported by the time \
100*0b57cec5SDimitry Andric the code executes.  Single line breakpoint commands will be interpreted 'as is' \
101*0b57cec5SDimitry Andric when the breakpoint is hit.  Multiple lines of Python will be wrapped in a \
102*0b57cec5SDimitry Andric generated function, and a call to the function will be attached to the breakpoint."
103*0b57cec5SDimitry Andric         R"(
104*0b57cec5SDimitry Andric 
105*0b57cec5SDimitry Andric This auto-generated function is passed in three arguments:
106*0b57cec5SDimitry Andric 
107*0b57cec5SDimitry Andric     frame:  an lldb.SBFrame object for the frame which hit breakpoint.
108*0b57cec5SDimitry Andric 
109*0b57cec5SDimitry Andric     bp_loc: an lldb.SBBreakpointLocation object that represents the breakpoint location that was hit.
110*0b57cec5SDimitry Andric 
111*0b57cec5SDimitry Andric     dict:   the python session dictionary hit.
112*0b57cec5SDimitry Andric 
113*0b57cec5SDimitry Andric )"
114*0b57cec5SDimitry Andric         "When specifying a python function with the --python-function option, you need \
115*0b57cec5SDimitry Andric to supply the function name prepended by the module name:"
116*0b57cec5SDimitry Andric         R"(
117*0b57cec5SDimitry Andric 
118*0b57cec5SDimitry Andric     --python-function myutils.breakpoint_callback
119*0b57cec5SDimitry Andric 
120*0b57cec5SDimitry Andric The function itself must have the following prototype:
121*0b57cec5SDimitry Andric 
122*0b57cec5SDimitry Andric def breakpoint_callback(frame, bp_loc, dict):
123*0b57cec5SDimitry Andric   # Your code goes here
124*0b57cec5SDimitry Andric 
125*0b57cec5SDimitry Andric )"
126*0b57cec5SDimitry Andric         "The arguments are the same as the arguments passed to generated functions as \
127*0b57cec5SDimitry Andric described above.  Note that the global variable 'lldb.frame' will NOT be updated when \
128*0b57cec5SDimitry Andric this function is called, so be sure to use the 'frame' argument. The 'frame' argument \
129*0b57cec5SDimitry Andric can get you to the thread via frame.GetThread(), the thread can get you to the \
130*0b57cec5SDimitry Andric process via thread.GetProcess(), and the process can get you back to the target \
131*0b57cec5SDimitry Andric via process.GetTarget()."
132*0b57cec5SDimitry Andric         R"(
133*0b57cec5SDimitry Andric 
134*0b57cec5SDimitry Andric )"
135*0b57cec5SDimitry Andric         "Important Note: As Python code gets collected into functions, access to global \
136*0b57cec5SDimitry Andric variables requires explicit scoping using the 'global' keyword.  Be sure to use correct \
137*0b57cec5SDimitry Andric Python syntax, including indentation, when entering Python breakpoint commands."
138*0b57cec5SDimitry Andric         R"(
139*0b57cec5SDimitry Andric 
140*0b57cec5SDimitry Andric Example Python one-line breakpoint command:
141*0b57cec5SDimitry Andric 
142*0b57cec5SDimitry Andric (lldb) breakpoint command add -s python 1
143*0b57cec5SDimitry Andric Enter your Python command(s). Type 'DONE' to end.
144e8d8bef9SDimitry Andric def function (frame, bp_loc, internal_dict):
145e8d8bef9SDimitry Andric     """frame: the lldb.SBFrame for the location at which you stopped
146e8d8bef9SDimitry Andric        bp_loc: an lldb.SBBreakpointLocation for the breakpoint location information
147e8d8bef9SDimitry Andric        internal_dict: an LLDB support object not to be used"""
148e8d8bef9SDimitry Andric     print("Hit this breakpoint!")
149e8d8bef9SDimitry Andric     DONE
150*0b57cec5SDimitry Andric 
151*0b57cec5SDimitry Andric As a convenience, this also works for a short Python one-liner:
152*0b57cec5SDimitry Andric 
153e8d8bef9SDimitry Andric (lldb) breakpoint command add -s python 1 -o 'import time; print(time.asctime())'
154*0b57cec5SDimitry Andric (lldb) run
155*0b57cec5SDimitry Andric Launching '.../a.out'  (x86_64)
156*0b57cec5SDimitry Andric (lldb) Fri Sep 10 12:17:45 2010
157*0b57cec5SDimitry Andric Process 21778 Stopped
158*0b57cec5SDimitry Andric * thread #1: tid = 0x2e03, 0x0000000100000de8 a.out`c + 7 at main.c:39, stop reason = breakpoint 1.1, queue = com.apple.main-thread
159*0b57cec5SDimitry Andric   36
160*0b57cec5SDimitry Andric   37   	int c(int val)
161*0b57cec5SDimitry Andric   38   	{
162*0b57cec5SDimitry Andric   39 ->	    return val + 3;
163*0b57cec5SDimitry Andric   40   	}
164*0b57cec5SDimitry Andric   41
165*0b57cec5SDimitry Andric   42   	int main (int argc, char const *argv[])
166*0b57cec5SDimitry Andric 
167*0b57cec5SDimitry Andric Example multiple line Python breakpoint command:
168*0b57cec5SDimitry Andric 
169*0b57cec5SDimitry Andric (lldb) breakpoint command add -s p 1
170*0b57cec5SDimitry Andric Enter your Python command(s). Type 'DONE' to end.
171e8d8bef9SDimitry Andric def function (frame, bp_loc, internal_dict):
172e8d8bef9SDimitry Andric     """frame: the lldb.SBFrame for the location at which you stopped
173e8d8bef9SDimitry Andric        bp_loc: an lldb.SBBreakpointLocation for the breakpoint location information
174e8d8bef9SDimitry Andric        internal_dict: an LLDB support object not to be used"""
175e8d8bef9SDimitry Andric     global bp_count
176e8d8bef9SDimitry Andric     bp_count = bp_count + 1
177e8d8bef9SDimitry Andric     print("Hit this breakpoint " + repr(bp_count) + " times!")
178e8d8bef9SDimitry Andric     DONE
179*0b57cec5SDimitry Andric 
180*0b57cec5SDimitry Andric )"
181*0b57cec5SDimitry Andric         "In this case, since there is a reference to a global variable, \
182*0b57cec5SDimitry Andric 'bp_count', you will also need to make sure 'bp_count' exists and is \
183*0b57cec5SDimitry Andric initialized:"
184*0b57cec5SDimitry Andric         R"(
185*0b57cec5SDimitry Andric 
186*0b57cec5SDimitry Andric (lldb) script
187*0b57cec5SDimitry Andric >>> bp_count = 0
188*0b57cec5SDimitry Andric >>> quit()
189*0b57cec5SDimitry Andric 
190*0b57cec5SDimitry Andric )"
191*0b57cec5SDimitry Andric         "Your Python code, however organized, can optionally return a value.  \
192*0b57cec5SDimitry Andric If the returned value is False, that tells LLDB not to stop at the breakpoint \
193*0b57cec5SDimitry Andric to which the code is associated. Returning anything other than False, or even \
194*0b57cec5SDimitry Andric returning None, or even omitting a return statement entirely, will cause \
195*0b57cec5SDimitry Andric LLDB to stop."
196*0b57cec5SDimitry Andric         R"(
197*0b57cec5SDimitry Andric 
198*0b57cec5SDimitry Andric )"
199*0b57cec5SDimitry Andric         "Final Note: A warning that no breakpoint command was generated when there \
200*0b57cec5SDimitry Andric are no syntax errors may indicate that a function was declared but never called.");
201*0b57cec5SDimitry Andric 
202480093f4SDimitry Andric     m_all_options.Append(&m_options);
203480093f4SDimitry Andric     m_all_options.Append(&m_func_options, LLDB_OPT_SET_2 | LLDB_OPT_SET_3,
204480093f4SDimitry Andric                          LLDB_OPT_SET_2);
205480093f4SDimitry Andric     m_all_options.Finalize();
206480093f4SDimitry Andric 
207*0b57cec5SDimitry Andric     CommandArgumentEntry arg;
208*0b57cec5SDimitry Andric     CommandArgumentData bp_id_arg;
209*0b57cec5SDimitry Andric 
210*0b57cec5SDimitry Andric     // Define the first (and only) variant of this arg.
211*0b57cec5SDimitry Andric     bp_id_arg.arg_type = eArgTypeBreakpointID;
212*0b57cec5SDimitry Andric     bp_id_arg.arg_repetition = eArgRepeatOptional;
213*0b57cec5SDimitry Andric 
214*0b57cec5SDimitry Andric     // There is only one variant this argument could be; put it into the
215*0b57cec5SDimitry Andric     // argument entry.
216*0b57cec5SDimitry Andric     arg.push_back(bp_id_arg);
217*0b57cec5SDimitry Andric 
218*0b57cec5SDimitry Andric     // Push the data for the first argument into the m_arguments vector.
219*0b57cec5SDimitry Andric     m_arguments.push_back(arg);
220*0b57cec5SDimitry Andric   }
221*0b57cec5SDimitry Andric 
222*0b57cec5SDimitry Andric   ~CommandObjectBreakpointCommandAdd() override = default;
223*0b57cec5SDimitry Andric 
224480093f4SDimitry Andric   Options *GetOptions() override { return &m_all_options; }
225*0b57cec5SDimitry Andric 
226*0b57cec5SDimitry Andric   void IOHandlerActivated(IOHandler &io_handler, bool interactive) override {
2279dba64beSDimitry Andric     StreamFileSP output_sp(io_handler.GetOutputStreamFileSP());
228*0b57cec5SDimitry Andric     if (output_sp && interactive) {
229*0b57cec5SDimitry Andric       output_sp->PutCString(g_reader_instructions);
230*0b57cec5SDimitry Andric       output_sp->Flush();
231*0b57cec5SDimitry Andric     }
232*0b57cec5SDimitry Andric   }
233*0b57cec5SDimitry Andric 
234*0b57cec5SDimitry Andric   void IOHandlerInputComplete(IOHandler &io_handler,
235*0b57cec5SDimitry Andric                               std::string &line) override {
236*0b57cec5SDimitry Andric     io_handler.SetIsDone(true);
237*0b57cec5SDimitry Andric 
238*0b57cec5SDimitry Andric     std::vector<BreakpointOptions *> *bp_options_vec =
239*0b57cec5SDimitry Andric         (std::vector<BreakpointOptions *> *)io_handler.GetUserData();
240*0b57cec5SDimitry Andric     for (BreakpointOptions *bp_options : *bp_options_vec) {
241*0b57cec5SDimitry Andric       if (!bp_options)
242*0b57cec5SDimitry Andric         continue;
243*0b57cec5SDimitry Andric 
2449dba64beSDimitry Andric       auto cmd_data = std::make_unique<BreakpointOptions::CommandData>();
245*0b57cec5SDimitry Andric       cmd_data->user_source.SplitIntoLines(line.c_str(), line.size());
246*0b57cec5SDimitry Andric       bp_options->SetCommandDataCallback(cmd_data);
247*0b57cec5SDimitry Andric     }
248*0b57cec5SDimitry Andric   }
249*0b57cec5SDimitry Andric 
250*0b57cec5SDimitry Andric   void CollectDataForBreakpointCommandCallback(
251*0b57cec5SDimitry Andric       std::vector<BreakpointOptions *> &bp_options_vec,
252*0b57cec5SDimitry Andric       CommandReturnObject &result) {
253*0b57cec5SDimitry Andric     m_interpreter.GetLLDBCommandsFromIOHandler(
254*0b57cec5SDimitry Andric         "> ",             // Prompt
255*0b57cec5SDimitry Andric         *this,            // IOHandlerDelegate
256*0b57cec5SDimitry Andric         &bp_options_vec); // Baton for the "io_handler" that will be passed back
257*0b57cec5SDimitry Andric                           // into our IOHandlerDelegate functions
258*0b57cec5SDimitry Andric   }
259*0b57cec5SDimitry Andric 
260*0b57cec5SDimitry Andric   /// Set a one-liner as the callback for the breakpoint.
261*0b57cec5SDimitry Andric   void
262*0b57cec5SDimitry Andric   SetBreakpointCommandCallback(std::vector<BreakpointOptions *> &bp_options_vec,
263*0b57cec5SDimitry Andric                                const char *oneliner) {
264*0b57cec5SDimitry Andric     for (auto bp_options : bp_options_vec) {
2659dba64beSDimitry Andric       auto cmd_data = std::make_unique<BreakpointOptions::CommandData>();
266*0b57cec5SDimitry Andric 
267*0b57cec5SDimitry Andric       cmd_data->user_source.AppendString(oneliner);
268*0b57cec5SDimitry Andric       cmd_data->stop_on_error = m_options.m_stop_on_error;
269*0b57cec5SDimitry Andric 
270*0b57cec5SDimitry Andric       bp_options->SetCommandDataCallback(cmd_data);
271*0b57cec5SDimitry Andric     }
272*0b57cec5SDimitry Andric   }
273*0b57cec5SDimitry Andric 
274480093f4SDimitry Andric   class CommandOptions : public OptionGroup {
275*0b57cec5SDimitry Andric   public:
276*0b57cec5SDimitry Andric     CommandOptions()
277480093f4SDimitry Andric         : OptionGroup(), m_use_commands(false), m_use_script_language(false),
278*0b57cec5SDimitry Andric           m_script_language(eScriptLanguageNone), m_use_one_liner(false),
279480093f4SDimitry Andric           m_one_liner() {}
280*0b57cec5SDimitry Andric 
281*0b57cec5SDimitry Andric     ~CommandOptions() override = default;
282*0b57cec5SDimitry Andric 
283*0b57cec5SDimitry Andric     Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg,
284*0b57cec5SDimitry Andric                           ExecutionContext *execution_context) override {
285*0b57cec5SDimitry Andric       Status error;
286480093f4SDimitry Andric       const int short_option =
287480093f4SDimitry Andric           g_breakpoint_command_add_options[option_idx].short_option;
288*0b57cec5SDimitry Andric 
289*0b57cec5SDimitry Andric       switch (short_option) {
290*0b57cec5SDimitry Andric       case 'o':
291*0b57cec5SDimitry Andric         m_use_one_liner = true;
2925ffd83dbSDimitry Andric         m_one_liner = std::string(option_arg);
293*0b57cec5SDimitry Andric         break;
294*0b57cec5SDimitry Andric 
295*0b57cec5SDimitry Andric       case 's':
296*0b57cec5SDimitry Andric         m_script_language = (lldb::ScriptLanguage)OptionArgParser::ToOptionEnum(
2979dba64beSDimitry Andric             option_arg,
2989dba64beSDimitry Andric             g_breakpoint_command_add_options[option_idx].enum_values,
299*0b57cec5SDimitry Andric             eScriptLanguageNone, error);
300480093f4SDimitry Andric         switch (m_script_language) {
301480093f4SDimitry Andric         case eScriptLanguagePython:
302480093f4SDimitry Andric         case eScriptLanguageLua:
303*0b57cec5SDimitry Andric           m_use_script_language = true;
304480093f4SDimitry Andric           break;
305480093f4SDimitry Andric         case eScriptLanguageNone:
306480093f4SDimitry Andric         case eScriptLanguageUnknown:
307*0b57cec5SDimitry Andric           m_use_script_language = false;
308480093f4SDimitry Andric           break;
309*0b57cec5SDimitry Andric         }
310*0b57cec5SDimitry Andric         break;
311*0b57cec5SDimitry Andric 
312*0b57cec5SDimitry Andric       case 'e': {
313*0b57cec5SDimitry Andric         bool success = false;
314*0b57cec5SDimitry Andric         m_stop_on_error =
315*0b57cec5SDimitry Andric             OptionArgParser::ToBoolean(option_arg, false, &success);
316*0b57cec5SDimitry Andric         if (!success)
317*0b57cec5SDimitry Andric           error.SetErrorStringWithFormat(
318*0b57cec5SDimitry Andric               "invalid value for stop-on-error: \"%s\"",
319*0b57cec5SDimitry Andric               option_arg.str().c_str());
320*0b57cec5SDimitry Andric       } break;
321*0b57cec5SDimitry Andric 
322*0b57cec5SDimitry Andric       case 'D':
323*0b57cec5SDimitry Andric         m_use_dummy = true;
324*0b57cec5SDimitry Andric         break;
325*0b57cec5SDimitry Andric 
326*0b57cec5SDimitry Andric       default:
3279dba64beSDimitry Andric         llvm_unreachable("Unimplemented option");
328*0b57cec5SDimitry Andric       }
329*0b57cec5SDimitry Andric       return error;
330*0b57cec5SDimitry Andric     }
331*0b57cec5SDimitry Andric 
332*0b57cec5SDimitry Andric     void OptionParsingStarting(ExecutionContext *execution_context) override {
333*0b57cec5SDimitry Andric       m_use_commands = true;
334*0b57cec5SDimitry Andric       m_use_script_language = false;
335*0b57cec5SDimitry Andric       m_script_language = eScriptLanguageNone;
336*0b57cec5SDimitry Andric 
337*0b57cec5SDimitry Andric       m_use_one_liner = false;
338*0b57cec5SDimitry Andric       m_stop_on_error = true;
339*0b57cec5SDimitry Andric       m_one_liner.clear();
340*0b57cec5SDimitry Andric       m_use_dummy = false;
341*0b57cec5SDimitry Andric     }
342*0b57cec5SDimitry Andric 
343*0b57cec5SDimitry Andric     llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
3449dba64beSDimitry Andric       return llvm::makeArrayRef(g_breakpoint_command_add_options);
345*0b57cec5SDimitry Andric     }
346*0b57cec5SDimitry Andric 
347*0b57cec5SDimitry Andric     // Instance variables to hold the values for command options.
348*0b57cec5SDimitry Andric 
349*0b57cec5SDimitry Andric     bool m_use_commands;
350*0b57cec5SDimitry Andric     bool m_use_script_language;
351*0b57cec5SDimitry Andric     lldb::ScriptLanguage m_script_language;
352*0b57cec5SDimitry Andric 
353*0b57cec5SDimitry Andric     // Instance variables to hold the values for one_liner options.
354*0b57cec5SDimitry Andric     bool m_use_one_liner;
355*0b57cec5SDimitry Andric     std::string m_one_liner;
356*0b57cec5SDimitry Andric     bool m_stop_on_error;
357*0b57cec5SDimitry Andric     bool m_use_dummy;
358*0b57cec5SDimitry Andric   };
359*0b57cec5SDimitry Andric 
360*0b57cec5SDimitry Andric protected:
361*0b57cec5SDimitry Andric   bool DoExecute(Args &command, CommandReturnObject &result) override {
3629dba64beSDimitry Andric     Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy);
363*0b57cec5SDimitry Andric 
3649dba64beSDimitry Andric     const BreakpointList &breakpoints = target.GetBreakpointList();
365*0b57cec5SDimitry Andric     size_t num_breakpoints = breakpoints.GetSize();
366*0b57cec5SDimitry Andric 
367*0b57cec5SDimitry Andric     if (num_breakpoints == 0) {
368*0b57cec5SDimitry Andric       result.AppendError("No breakpoints exist to have commands added");
369*0b57cec5SDimitry Andric       result.SetStatus(eReturnStatusFailed);
370*0b57cec5SDimitry Andric       return false;
371*0b57cec5SDimitry Andric     }
372*0b57cec5SDimitry Andric 
373480093f4SDimitry Andric     if (!m_func_options.GetName().empty()) {
374480093f4SDimitry Andric       m_options.m_use_one_liner = false;
375480093f4SDimitry Andric       if (!m_options.m_use_script_language) {
376480093f4SDimitry Andric         m_options.m_script_language = GetDebugger().GetScriptLanguage();
377480093f4SDimitry Andric         m_options.m_use_script_language = true;
378480093f4SDimitry Andric       }
379*0b57cec5SDimitry Andric     }
380*0b57cec5SDimitry Andric 
381*0b57cec5SDimitry Andric     BreakpointIDList valid_bp_ids;
382*0b57cec5SDimitry Andric     CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs(
3839dba64beSDimitry Andric         command, &target, result, &valid_bp_ids,
384*0b57cec5SDimitry Andric         BreakpointName::Permissions::PermissionKinds::listPerm);
385*0b57cec5SDimitry Andric 
386*0b57cec5SDimitry Andric     m_bp_options_vec.clear();
387*0b57cec5SDimitry Andric 
388*0b57cec5SDimitry Andric     if (result.Succeeded()) {
389*0b57cec5SDimitry Andric       const size_t count = valid_bp_ids.GetSize();
390*0b57cec5SDimitry Andric 
391*0b57cec5SDimitry Andric       for (size_t i = 0; i < count; ++i) {
392*0b57cec5SDimitry Andric         BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i);
393*0b57cec5SDimitry Andric         if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) {
394*0b57cec5SDimitry Andric           Breakpoint *bp =
3959dba64beSDimitry Andric               target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get();
396*0b57cec5SDimitry Andric           BreakpointOptions *bp_options = nullptr;
397*0b57cec5SDimitry Andric           if (cur_bp_id.GetLocationID() == LLDB_INVALID_BREAK_ID) {
398*0b57cec5SDimitry Andric             // This breakpoint does not have an associated location.
399*0b57cec5SDimitry Andric             bp_options = bp->GetOptions();
400*0b57cec5SDimitry Andric           } else {
401*0b57cec5SDimitry Andric             BreakpointLocationSP bp_loc_sp(
402*0b57cec5SDimitry Andric                 bp->FindLocationByID(cur_bp_id.GetLocationID()));
403*0b57cec5SDimitry Andric             // This breakpoint does have an associated location. Get its
404*0b57cec5SDimitry Andric             // breakpoint options.
405*0b57cec5SDimitry Andric             if (bp_loc_sp)
406*0b57cec5SDimitry Andric               bp_options = bp_loc_sp->GetLocationOptions();
407*0b57cec5SDimitry Andric           }
408*0b57cec5SDimitry Andric           if (bp_options)
409*0b57cec5SDimitry Andric             m_bp_options_vec.push_back(bp_options);
410*0b57cec5SDimitry Andric         }
411*0b57cec5SDimitry Andric       }
412*0b57cec5SDimitry Andric 
413*0b57cec5SDimitry Andric       // If we are using script language, get the script interpreter in order
414*0b57cec5SDimitry Andric       // to set or collect command callback.  Otherwise, call the methods
415*0b57cec5SDimitry Andric       // associated with this object.
416*0b57cec5SDimitry Andric       if (m_options.m_use_script_language) {
417e8d8bef9SDimitry Andric         Status error;
418480093f4SDimitry Andric         ScriptInterpreter *script_interp = GetDebugger().GetScriptInterpreter(
419480093f4SDimitry Andric             /*can_create=*/true, m_options.m_script_language);
420*0b57cec5SDimitry Andric         // Special handling for one-liner specified inline.
421*0b57cec5SDimitry Andric         if (m_options.m_use_one_liner) {
422e8d8bef9SDimitry Andric           error = script_interp->SetBreakpointCommandCallback(
423*0b57cec5SDimitry Andric               m_bp_options_vec, m_options.m_one_liner.c_str());
424480093f4SDimitry Andric         } else if (!m_func_options.GetName().empty()) {
425e8d8bef9SDimitry Andric           error = script_interp->SetBreakpointCommandCallbackFunction(
426480093f4SDimitry Andric               m_bp_options_vec, m_func_options.GetName().c_str(),
427480093f4SDimitry Andric               m_func_options.GetStructuredData());
428*0b57cec5SDimitry Andric         } else {
429*0b57cec5SDimitry Andric           script_interp->CollectDataForBreakpointCommandCallback(
430*0b57cec5SDimitry Andric               m_bp_options_vec, result);
431*0b57cec5SDimitry Andric         }
432e8d8bef9SDimitry Andric         if (!error.Success())
433e8d8bef9SDimitry Andric           result.SetError(error);
434*0b57cec5SDimitry Andric       } else {
435*0b57cec5SDimitry Andric         // Special handling for one-liner specified inline.
436*0b57cec5SDimitry Andric         if (m_options.m_use_one_liner)
437*0b57cec5SDimitry Andric           SetBreakpointCommandCallback(m_bp_options_vec,
438*0b57cec5SDimitry Andric                                        m_options.m_one_liner.c_str());
439*0b57cec5SDimitry Andric         else
440*0b57cec5SDimitry Andric           CollectDataForBreakpointCommandCallback(m_bp_options_vec, result);
441*0b57cec5SDimitry Andric       }
442*0b57cec5SDimitry Andric     }
443*0b57cec5SDimitry Andric 
444*0b57cec5SDimitry Andric     return result.Succeeded();
445*0b57cec5SDimitry Andric   }
446*0b57cec5SDimitry Andric 
447*0b57cec5SDimitry Andric private:
448*0b57cec5SDimitry Andric   CommandOptions m_options;
449480093f4SDimitry Andric   OptionGroupPythonClassWithDict m_func_options;
450480093f4SDimitry Andric   OptionGroupOptions m_all_options;
451480093f4SDimitry Andric 
452*0b57cec5SDimitry Andric   std::vector<BreakpointOptions *> m_bp_options_vec; // This stores the
453*0b57cec5SDimitry Andric                                                      // breakpoint options that
454*0b57cec5SDimitry Andric                                                      // we are currently
455*0b57cec5SDimitry Andric   // collecting commands for.  In the CollectData... calls we need to hand this
456*0b57cec5SDimitry Andric   // off to the IOHandler, which may run asynchronously. So we have to have
457*0b57cec5SDimitry Andric   // some way to keep it alive, and not leak it. Making it an ivar of the
458*0b57cec5SDimitry Andric   // command object, which never goes away achieves this.  Note that if we were
459*0b57cec5SDimitry Andric   // able to run the same command concurrently in one interpreter we'd have to
460*0b57cec5SDimitry Andric   // make this "per invocation".  But there are many more reasons why it is not
461*0b57cec5SDimitry Andric   // in general safe to do that in lldb at present, so it isn't worthwhile to
462*0b57cec5SDimitry Andric   // come up with a more complex mechanism to address this particular weakness
463*0b57cec5SDimitry Andric   // right now.
464*0b57cec5SDimitry Andric   static const char *g_reader_instructions;
465*0b57cec5SDimitry Andric };
466*0b57cec5SDimitry Andric 
467*0b57cec5SDimitry Andric const char *CommandObjectBreakpointCommandAdd::g_reader_instructions =
468*0b57cec5SDimitry Andric     "Enter your debugger command(s).  Type 'DONE' to end.\n";
469*0b57cec5SDimitry Andric 
470*0b57cec5SDimitry Andric // CommandObjectBreakpointCommandDelete
471*0b57cec5SDimitry Andric 
4729dba64beSDimitry Andric #define LLDB_OPTIONS_breakpoint_command_delete
4739dba64beSDimitry Andric #include "CommandOptions.inc"
474*0b57cec5SDimitry Andric 
475*0b57cec5SDimitry Andric class CommandObjectBreakpointCommandDelete : public CommandObjectParsed {
476*0b57cec5SDimitry Andric public:
477*0b57cec5SDimitry Andric   CommandObjectBreakpointCommandDelete(CommandInterpreter &interpreter)
478*0b57cec5SDimitry Andric       : CommandObjectParsed(interpreter, "delete",
479*0b57cec5SDimitry Andric                             "Delete the set of commands from a breakpoint.",
480*0b57cec5SDimitry Andric                             nullptr),
481*0b57cec5SDimitry Andric         m_options() {
482*0b57cec5SDimitry Andric     CommandArgumentEntry arg;
483*0b57cec5SDimitry Andric     CommandArgumentData bp_id_arg;
484*0b57cec5SDimitry Andric 
485*0b57cec5SDimitry Andric     // Define the first (and only) variant of this arg.
486*0b57cec5SDimitry Andric     bp_id_arg.arg_type = eArgTypeBreakpointID;
487*0b57cec5SDimitry Andric     bp_id_arg.arg_repetition = eArgRepeatPlain;
488*0b57cec5SDimitry Andric 
489*0b57cec5SDimitry Andric     // There is only one variant this argument could be; put it into the
490*0b57cec5SDimitry Andric     // argument entry.
491*0b57cec5SDimitry Andric     arg.push_back(bp_id_arg);
492*0b57cec5SDimitry Andric 
493*0b57cec5SDimitry Andric     // Push the data for the first argument into the m_arguments vector.
494*0b57cec5SDimitry Andric     m_arguments.push_back(arg);
495*0b57cec5SDimitry Andric   }
496*0b57cec5SDimitry Andric 
497*0b57cec5SDimitry Andric   ~CommandObjectBreakpointCommandDelete() override = default;
498*0b57cec5SDimitry Andric 
499*0b57cec5SDimitry Andric   Options *GetOptions() override { return &m_options; }
500*0b57cec5SDimitry Andric 
501*0b57cec5SDimitry Andric   class CommandOptions : public Options {
502*0b57cec5SDimitry Andric   public:
503*0b57cec5SDimitry Andric     CommandOptions() : Options(), m_use_dummy(false) {}
504*0b57cec5SDimitry Andric 
505*0b57cec5SDimitry Andric     ~CommandOptions() override = default;
506*0b57cec5SDimitry Andric 
507*0b57cec5SDimitry Andric     Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_arg,
508*0b57cec5SDimitry Andric                           ExecutionContext *execution_context) override {
509*0b57cec5SDimitry Andric       Status error;
510*0b57cec5SDimitry Andric       const int short_option = m_getopt_table[option_idx].val;
511*0b57cec5SDimitry Andric 
512*0b57cec5SDimitry Andric       switch (short_option) {
513*0b57cec5SDimitry Andric       case 'D':
514*0b57cec5SDimitry Andric         m_use_dummy = true;
515*0b57cec5SDimitry Andric         break;
516*0b57cec5SDimitry Andric 
517*0b57cec5SDimitry Andric       default:
5189dba64beSDimitry Andric         llvm_unreachable("Unimplemented option");
519*0b57cec5SDimitry Andric       }
520*0b57cec5SDimitry Andric 
521*0b57cec5SDimitry Andric       return error;
522*0b57cec5SDimitry Andric     }
523*0b57cec5SDimitry Andric 
524*0b57cec5SDimitry Andric     void OptionParsingStarting(ExecutionContext *execution_context) override {
525*0b57cec5SDimitry Andric       m_use_dummy = false;
526*0b57cec5SDimitry Andric     }
527*0b57cec5SDimitry Andric 
528*0b57cec5SDimitry Andric     llvm::ArrayRef<OptionDefinition> GetDefinitions() override {
5299dba64beSDimitry Andric       return llvm::makeArrayRef(g_breakpoint_command_delete_options);
530*0b57cec5SDimitry Andric     }
531*0b57cec5SDimitry Andric 
532*0b57cec5SDimitry Andric     // Instance variables to hold the values for command options.
533*0b57cec5SDimitry Andric     bool m_use_dummy;
534*0b57cec5SDimitry Andric   };
535*0b57cec5SDimitry Andric 
536*0b57cec5SDimitry Andric protected:
537*0b57cec5SDimitry Andric   bool DoExecute(Args &command, CommandReturnObject &result) override {
5389dba64beSDimitry Andric     Target &target = GetSelectedOrDummyTarget(m_options.m_use_dummy);
539*0b57cec5SDimitry Andric 
5409dba64beSDimitry Andric     const BreakpointList &breakpoints = target.GetBreakpointList();
541*0b57cec5SDimitry Andric     size_t num_breakpoints = breakpoints.GetSize();
542*0b57cec5SDimitry Andric 
543*0b57cec5SDimitry Andric     if (num_breakpoints == 0) {
544*0b57cec5SDimitry Andric       result.AppendError("No breakpoints exist to have commands deleted");
545*0b57cec5SDimitry Andric       result.SetStatus(eReturnStatusFailed);
546*0b57cec5SDimitry Andric       return false;
547*0b57cec5SDimitry Andric     }
548*0b57cec5SDimitry Andric 
549*0b57cec5SDimitry Andric     if (command.empty()) {
550*0b57cec5SDimitry Andric       result.AppendError(
551*0b57cec5SDimitry Andric           "No breakpoint specified from which to delete the commands");
552*0b57cec5SDimitry Andric       result.SetStatus(eReturnStatusFailed);
553*0b57cec5SDimitry Andric       return false;
554*0b57cec5SDimitry Andric     }
555*0b57cec5SDimitry Andric 
556*0b57cec5SDimitry Andric     BreakpointIDList valid_bp_ids;
557*0b57cec5SDimitry Andric     CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs(
5589dba64beSDimitry Andric         command, &target, result, &valid_bp_ids,
559*0b57cec5SDimitry Andric         BreakpointName::Permissions::PermissionKinds::listPerm);
560*0b57cec5SDimitry Andric 
561*0b57cec5SDimitry Andric     if (result.Succeeded()) {
562*0b57cec5SDimitry Andric       const size_t count = valid_bp_ids.GetSize();
563*0b57cec5SDimitry Andric       for (size_t i = 0; i < count; ++i) {
564*0b57cec5SDimitry Andric         BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i);
565*0b57cec5SDimitry Andric         if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) {
566*0b57cec5SDimitry Andric           Breakpoint *bp =
5679dba64beSDimitry Andric               target.GetBreakpointByID(cur_bp_id.GetBreakpointID()).get();
568*0b57cec5SDimitry Andric           if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) {
569*0b57cec5SDimitry Andric             BreakpointLocationSP bp_loc_sp(
570*0b57cec5SDimitry Andric                 bp->FindLocationByID(cur_bp_id.GetLocationID()));
571*0b57cec5SDimitry Andric             if (bp_loc_sp)
572*0b57cec5SDimitry Andric               bp_loc_sp->ClearCallback();
573*0b57cec5SDimitry Andric             else {
574*0b57cec5SDimitry Andric               result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n",
575*0b57cec5SDimitry Andric                                            cur_bp_id.GetBreakpointID(),
576*0b57cec5SDimitry Andric                                            cur_bp_id.GetLocationID());
577*0b57cec5SDimitry Andric               result.SetStatus(eReturnStatusFailed);
578*0b57cec5SDimitry Andric               return false;
579*0b57cec5SDimitry Andric             }
580*0b57cec5SDimitry Andric           } else {
581*0b57cec5SDimitry Andric             bp->ClearCallback();
582*0b57cec5SDimitry Andric           }
583*0b57cec5SDimitry Andric         }
584*0b57cec5SDimitry Andric       }
585*0b57cec5SDimitry Andric     }
586*0b57cec5SDimitry Andric     return result.Succeeded();
587*0b57cec5SDimitry Andric   }
588*0b57cec5SDimitry Andric 
589*0b57cec5SDimitry Andric private:
590*0b57cec5SDimitry Andric   CommandOptions m_options;
591*0b57cec5SDimitry Andric };
592*0b57cec5SDimitry Andric 
593*0b57cec5SDimitry Andric // CommandObjectBreakpointCommandList
594*0b57cec5SDimitry Andric 
595*0b57cec5SDimitry Andric class CommandObjectBreakpointCommandList : public CommandObjectParsed {
596*0b57cec5SDimitry Andric public:
597*0b57cec5SDimitry Andric   CommandObjectBreakpointCommandList(CommandInterpreter &interpreter)
5989dba64beSDimitry Andric       : CommandObjectParsed(interpreter, "list",
5999dba64beSDimitry Andric                             "List the script or set of commands to be "
6009dba64beSDimitry Andric                             "executed when the breakpoint is hit.",
6019dba64beSDimitry Andric                             nullptr, eCommandRequiresTarget) {
602*0b57cec5SDimitry Andric     CommandArgumentEntry arg;
603*0b57cec5SDimitry Andric     CommandArgumentData bp_id_arg;
604*0b57cec5SDimitry Andric 
605*0b57cec5SDimitry Andric     // Define the first (and only) variant of this arg.
606*0b57cec5SDimitry Andric     bp_id_arg.arg_type = eArgTypeBreakpointID;
607*0b57cec5SDimitry Andric     bp_id_arg.arg_repetition = eArgRepeatPlain;
608*0b57cec5SDimitry Andric 
609*0b57cec5SDimitry Andric     // There is only one variant this argument could be; put it into the
610*0b57cec5SDimitry Andric     // argument entry.
611*0b57cec5SDimitry Andric     arg.push_back(bp_id_arg);
612*0b57cec5SDimitry Andric 
613*0b57cec5SDimitry Andric     // Push the data for the first argument into the m_arguments vector.
614*0b57cec5SDimitry Andric     m_arguments.push_back(arg);
615*0b57cec5SDimitry Andric   }
616*0b57cec5SDimitry Andric 
617*0b57cec5SDimitry Andric   ~CommandObjectBreakpointCommandList() override = default;
618*0b57cec5SDimitry Andric 
619*0b57cec5SDimitry Andric protected:
620*0b57cec5SDimitry Andric   bool DoExecute(Args &command, CommandReturnObject &result) override {
6219dba64beSDimitry Andric     Target *target = &GetSelectedTarget();
622*0b57cec5SDimitry Andric 
623*0b57cec5SDimitry Andric     const BreakpointList &breakpoints = target->GetBreakpointList();
624*0b57cec5SDimitry Andric     size_t num_breakpoints = breakpoints.GetSize();
625*0b57cec5SDimitry Andric 
626*0b57cec5SDimitry Andric     if (num_breakpoints == 0) {
627*0b57cec5SDimitry Andric       result.AppendError("No breakpoints exist for which to list commands");
628*0b57cec5SDimitry Andric       result.SetStatus(eReturnStatusFailed);
629*0b57cec5SDimitry Andric       return false;
630*0b57cec5SDimitry Andric     }
631*0b57cec5SDimitry Andric 
632*0b57cec5SDimitry Andric     if (command.empty()) {
633*0b57cec5SDimitry Andric       result.AppendError(
634*0b57cec5SDimitry Andric           "No breakpoint specified for which to list the commands");
635*0b57cec5SDimitry Andric       result.SetStatus(eReturnStatusFailed);
636*0b57cec5SDimitry Andric       return false;
637*0b57cec5SDimitry Andric     }
638*0b57cec5SDimitry Andric 
639*0b57cec5SDimitry Andric     BreakpointIDList valid_bp_ids;
640*0b57cec5SDimitry Andric     CommandObjectMultiwordBreakpoint::VerifyBreakpointOrLocationIDs(
641*0b57cec5SDimitry Andric         command, target, result, &valid_bp_ids,
642*0b57cec5SDimitry Andric         BreakpointName::Permissions::PermissionKinds::listPerm);
643*0b57cec5SDimitry Andric 
644*0b57cec5SDimitry Andric     if (result.Succeeded()) {
645*0b57cec5SDimitry Andric       const size_t count = valid_bp_ids.GetSize();
646*0b57cec5SDimitry Andric       for (size_t i = 0; i < count; ++i) {
647*0b57cec5SDimitry Andric         BreakpointID cur_bp_id = valid_bp_ids.GetBreakpointIDAtIndex(i);
648*0b57cec5SDimitry Andric         if (cur_bp_id.GetBreakpointID() != LLDB_INVALID_BREAK_ID) {
649*0b57cec5SDimitry Andric           Breakpoint *bp =
650*0b57cec5SDimitry Andric               target->GetBreakpointByID(cur_bp_id.GetBreakpointID()).get();
651*0b57cec5SDimitry Andric 
652*0b57cec5SDimitry Andric           if (bp) {
653*0b57cec5SDimitry Andric             BreakpointLocationSP bp_loc_sp;
654*0b57cec5SDimitry Andric             if (cur_bp_id.GetLocationID() != LLDB_INVALID_BREAK_ID) {
655*0b57cec5SDimitry Andric               bp_loc_sp = bp->FindLocationByID(cur_bp_id.GetLocationID());
656480093f4SDimitry Andric               if (!bp_loc_sp) {
657*0b57cec5SDimitry Andric                 result.AppendErrorWithFormat("Invalid breakpoint ID: %u.%u.\n",
658*0b57cec5SDimitry Andric                                              cur_bp_id.GetBreakpointID(),
659*0b57cec5SDimitry Andric                                              cur_bp_id.GetLocationID());
660*0b57cec5SDimitry Andric                 result.SetStatus(eReturnStatusFailed);
661*0b57cec5SDimitry Andric                 return false;
662*0b57cec5SDimitry Andric               }
663*0b57cec5SDimitry Andric             }
664*0b57cec5SDimitry Andric 
665*0b57cec5SDimitry Andric             StreamString id_str;
666*0b57cec5SDimitry Andric             BreakpointID::GetCanonicalReference(&id_str,
667*0b57cec5SDimitry Andric                                                 cur_bp_id.GetBreakpointID(),
668*0b57cec5SDimitry Andric                                                 cur_bp_id.GetLocationID());
669*0b57cec5SDimitry Andric             const Baton *baton = nullptr;
670*0b57cec5SDimitry Andric             if (bp_loc_sp)
671480093f4SDimitry Andric               baton =
672480093f4SDimitry Andric                   bp_loc_sp
673*0b57cec5SDimitry Andric                       ->GetOptionsSpecifyingKind(BreakpointOptions::eCallback)
674*0b57cec5SDimitry Andric                       ->GetBaton();
675*0b57cec5SDimitry Andric             else
676*0b57cec5SDimitry Andric               baton = bp->GetOptions()->GetBaton();
677*0b57cec5SDimitry Andric 
678*0b57cec5SDimitry Andric             if (baton) {
679*0b57cec5SDimitry Andric               result.GetOutputStream().Printf("Breakpoint %s:\n",
680*0b57cec5SDimitry Andric                                               id_str.GetData());
681480093f4SDimitry Andric               baton->GetDescription(result.GetOutputStream().AsRawOstream(),
682480093f4SDimitry Andric                                     eDescriptionLevelFull,
683480093f4SDimitry Andric                                     result.GetOutputStream().GetIndentLevel() +
684480093f4SDimitry Andric                                         2);
685*0b57cec5SDimitry Andric             } else {
686*0b57cec5SDimitry Andric               result.AppendMessageWithFormat(
687*0b57cec5SDimitry Andric                   "Breakpoint %s does not have an associated command.\n",
688*0b57cec5SDimitry Andric                   id_str.GetData());
689*0b57cec5SDimitry Andric             }
690*0b57cec5SDimitry Andric           }
691*0b57cec5SDimitry Andric           result.SetStatus(eReturnStatusSuccessFinishResult);
692*0b57cec5SDimitry Andric         } else {
693*0b57cec5SDimitry Andric           result.AppendErrorWithFormat("Invalid breakpoint ID: %u.\n",
694*0b57cec5SDimitry Andric                                        cur_bp_id.GetBreakpointID());
695*0b57cec5SDimitry Andric           result.SetStatus(eReturnStatusFailed);
696*0b57cec5SDimitry Andric         }
697*0b57cec5SDimitry Andric       }
698*0b57cec5SDimitry Andric     }
699*0b57cec5SDimitry Andric 
700*0b57cec5SDimitry Andric     return result.Succeeded();
701*0b57cec5SDimitry Andric   }
702*0b57cec5SDimitry Andric };
703*0b57cec5SDimitry Andric 
704*0b57cec5SDimitry Andric // CommandObjectBreakpointCommand
705*0b57cec5SDimitry Andric 
706*0b57cec5SDimitry Andric CommandObjectBreakpointCommand::CommandObjectBreakpointCommand(
707*0b57cec5SDimitry Andric     CommandInterpreter &interpreter)
708*0b57cec5SDimitry Andric     : CommandObjectMultiword(
709480093f4SDimitry Andric           interpreter, "command",
710480093f4SDimitry Andric           "Commands for adding, removing and listing "
711*0b57cec5SDimitry Andric           "LLDB commands executed when a breakpoint is "
712*0b57cec5SDimitry Andric           "hit.",
713*0b57cec5SDimitry Andric           "command <sub-command> [<sub-command-options>] <breakpoint-id>") {
714*0b57cec5SDimitry Andric   CommandObjectSP add_command_object(
715*0b57cec5SDimitry Andric       new CommandObjectBreakpointCommandAdd(interpreter));
716*0b57cec5SDimitry Andric   CommandObjectSP delete_command_object(
717*0b57cec5SDimitry Andric       new CommandObjectBreakpointCommandDelete(interpreter));
718*0b57cec5SDimitry Andric   CommandObjectSP list_command_object(
719*0b57cec5SDimitry Andric       new CommandObjectBreakpointCommandList(interpreter));
720*0b57cec5SDimitry Andric 
721*0b57cec5SDimitry Andric   add_command_object->SetCommandName("breakpoint command add");
722*0b57cec5SDimitry Andric   delete_command_object->SetCommandName("breakpoint command delete");
723*0b57cec5SDimitry Andric   list_command_object->SetCommandName("breakpoint command list");
724*0b57cec5SDimitry Andric 
725*0b57cec5SDimitry Andric   LoadSubCommand("add", add_command_object);
726*0b57cec5SDimitry Andric   LoadSubCommand("delete", delete_command_object);
727*0b57cec5SDimitry Andric   LoadSubCommand("list", list_command_object);
728*0b57cec5SDimitry Andric }
729*0b57cec5SDimitry Andric 
730*0b57cec5SDimitry Andric CommandObjectBreakpointCommand::~CommandObjectBreakpointCommand() = default;
731