xref: /llvm-project/lldb/source/Commands/CommandObjectExpression.cpp (revision c11a780ed65a4e11c6bee68f7fd349c611f2fe18)
1 //===-- CommandObjectExpression.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 #include "llvm/ADT/STLExtras.h"
14 #include "llvm/ADT/StringRef.h"
15 
16 // Project includes
17 #include "CommandObjectExpression.h"
18 #include "Plugins/ExpressionParser/Clang/ClangExpressionVariable.h"
19 #include "lldb/Core/Debugger.h"
20 #include "lldb/Core/Value.h"
21 #include "lldb/Core/ValueObjectVariable.h"
22 #include "lldb/DataFormatters/ValueObjectPrinter.h"
23 #include "lldb/Expression/DWARFExpression.h"
24 #include "lldb/Expression/REPL.h"
25 #include "lldb/Expression/UserExpression.h"
26 #include "lldb/Host/Host.h"
27 #include "lldb/Host/OptionParser.h"
28 #include "lldb/Interpreter/CommandInterpreter.h"
29 #include "lldb/Interpreter/CommandReturnObject.h"
30 #include "lldb/Interpreter/OptionArgParser.h"
31 #include "lldb/Symbol/ObjectFile.h"
32 #include "lldb/Symbol/Variable.h"
33 #include "lldb/Target/Language.h"
34 #include "lldb/Target/Process.h"
35 #include "lldb/Target/StackFrame.h"
36 #include "lldb/Target/Target.h"
37 #include "lldb/Target/Thread.h"
38 
39 using namespace lldb;
40 using namespace lldb_private;
41 
42 CommandObjectExpression::CommandOptions::CommandOptions() : OptionGroup() {}
43 
44 CommandObjectExpression::CommandOptions::~CommandOptions() = default;
45 
46 static OptionEnumValueElement g_description_verbosity_type[] = {
47     {eLanguageRuntimeDescriptionDisplayVerbosityCompact, "compact",
48      "Only show the description string"},
49     {eLanguageRuntimeDescriptionDisplayVerbosityFull, "full",
50      "Show the full output, including persistent variable's name and type"},
51     {0, nullptr, nullptr}};
52 
53 static OptionDefinition g_expression_options[] = {
54     // clang-format off
55   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "all-threads",           'a', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeBoolean,              "Should we run all threads if the execution doesn't complete on one thread."},
56   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "ignore-breakpoints",    'i', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeBoolean,              "Ignore breakpoint hits while running expressions"},
57   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "timeout",               't', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeUnsignedInteger,      "Timeout value (in microseconds) for running the expression."},
58   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "unwind-on-error",       'u', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeBoolean,              "Clean up program state if the expression causes a crash, or raises a signal.  "
59                                                                                                                                                                                   "Note, unlike gdb hitting a breakpoint is controlled by another option (-i)."},
60   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "debug",                 'g', OptionParser::eNoArgument,       nullptr, nullptr,                      0, eArgTypeNone,                 "When specified, debug the JIT code by setting a breakpoint on the first instruction "
61                                                                                                                                                                                   "and forcing breakpoints to not be ignored (-i0) and no unwinding to happen on error (-u0)."},
62   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "language",              'l', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeLanguage,             "Specifies the Language to use when parsing the expression.  If not set the target.language "
63                                                                                                                                                                                   "setting is used." },
64   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "apply-fixits",          'X', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeLanguage,             "If true, simple fix-it hints will be automatically applied to the expression." },
65   {LLDB_OPT_SET_1,                  false, "description-verbosity", 'v', OptionParser::eOptionalArgument, nullptr, g_description_verbosity_type, 0, eArgTypeDescriptionVerbosity, "How verbose should the output of this expression be, if the object description is asked for."},
66   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "top-level",             'p', OptionParser::eNoArgument,       nullptr, nullptr,                      0, eArgTypeNone,                 "Interpret the expression as a complete translation unit, without injecting it into the local "
67                                                                                                                                                                                   "context.  Allows declaration of persistent, top-level entities without a $ prefix."},
68   {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "allow-jit",             'j', OptionParser::eRequiredArgument, nullptr, nullptr,                      0, eArgTypeBoolean,              "Controls whether the expression can fall back to being JITted if it's not supported by "
69                                                                                                                                                                                   "the interpreter (defaults to true)."}
70     // clang-format on
71 };
72 
73 Status CommandObjectExpression::CommandOptions::SetOptionValue(
74     uint32_t option_idx, llvm::StringRef option_arg,
75     ExecutionContext *execution_context) {
76   Status error;
77 
78   const int short_option = GetDefinitions()[option_idx].short_option;
79 
80   switch (short_option) {
81   case 'l':
82     language = Language::GetLanguageTypeFromString(option_arg);
83     if (language == eLanguageTypeUnknown)
84       error.SetErrorStringWithFormat(
85           "unknown language type: '%s' for expression",
86           option_arg.str().c_str());
87     break;
88 
89   case 'a': {
90     bool success;
91     bool result;
92     result = OptionArgParser::ToBoolean(option_arg, true, &success);
93     if (!success)
94       error.SetErrorStringWithFormat(
95           "invalid all-threads value setting: \"%s\"",
96           option_arg.str().c_str());
97     else
98       try_all_threads = result;
99   } break;
100 
101   case 'i': {
102     bool success;
103     bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
104     if (success)
105       ignore_breakpoints = tmp_value;
106     else
107       error.SetErrorStringWithFormat(
108           "could not convert \"%s\" to a boolean value.",
109           option_arg.str().c_str());
110     break;
111   }
112 
113   case 'j': {
114     bool success;
115     bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
116     if (success)
117       allow_jit = tmp_value;
118     else
119       error.SetErrorStringWithFormat(
120           "could not convert \"%s\" to a boolean value.",
121           option_arg.str().c_str());
122     break;
123   }
124 
125   case 't':
126     if (option_arg.getAsInteger(0, timeout)) {
127       timeout = 0;
128       error.SetErrorStringWithFormat("invalid timeout setting \"%s\"",
129                                      option_arg.str().c_str());
130     }
131     break;
132 
133   case 'u': {
134     bool success;
135     bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
136     if (success)
137       unwind_on_error = tmp_value;
138     else
139       error.SetErrorStringWithFormat(
140           "could not convert \"%s\" to a boolean value.",
141           option_arg.str().c_str());
142     break;
143   }
144 
145   case 'v':
146     if (option_arg.empty()) {
147       m_verbosity = eLanguageRuntimeDescriptionDisplayVerbosityFull;
148       break;
149     }
150     m_verbosity = (LanguageRuntimeDescriptionDisplayVerbosity)
151         OptionArgParser::ToOptionEnum(
152             option_arg, GetDefinitions()[option_idx].enum_values, 0, error);
153     if (!error.Success())
154       error.SetErrorStringWithFormat(
155           "unrecognized value for description-verbosity '%s'",
156           option_arg.str().c_str());
157     break;
158 
159   case 'g':
160     debug = true;
161     unwind_on_error = false;
162     ignore_breakpoints = false;
163     break;
164 
165   case 'p':
166     top_level = true;
167     break;
168 
169   case 'X': {
170     bool success;
171     bool tmp_value = OptionArgParser::ToBoolean(option_arg, true, &success);
172     if (success)
173       auto_apply_fixits = tmp_value ? eLazyBoolYes : eLazyBoolNo;
174     else
175       error.SetErrorStringWithFormat(
176           "could not convert \"%s\" to a boolean value.",
177           option_arg.str().c_str());
178     break;
179   }
180 
181   default:
182     error.SetErrorStringWithFormat("invalid short option character '%c'",
183                                    short_option);
184     break;
185   }
186 
187   return error;
188 }
189 
190 void CommandObjectExpression::CommandOptions::OptionParsingStarting(
191     ExecutionContext *execution_context) {
192   auto process_sp =
193       execution_context ? execution_context->GetProcessSP() : ProcessSP();
194   if (process_sp) {
195     ignore_breakpoints = process_sp->GetIgnoreBreakpointsInExpressions();
196     unwind_on_error = process_sp->GetUnwindOnErrorInExpressions();
197   } else {
198     ignore_breakpoints = true;
199     unwind_on_error = true;
200   }
201 
202   show_summary = true;
203   try_all_threads = true;
204   timeout = 0;
205   debug = false;
206   language = eLanguageTypeUnknown;
207   m_verbosity = eLanguageRuntimeDescriptionDisplayVerbosityCompact;
208   auto_apply_fixits = eLazyBoolCalculate;
209   top_level = false;
210   allow_jit = true;
211 }
212 
213 llvm::ArrayRef<OptionDefinition>
214 CommandObjectExpression::CommandOptions::GetDefinitions() {
215   return llvm::makeArrayRef(g_expression_options);
216 }
217 
218 CommandObjectExpression::CommandObjectExpression(
219     CommandInterpreter &interpreter)
220     : CommandObjectRaw(
221           interpreter, "expression", "Evaluate an expression on the current "
222                                      "thread.  Displays any returned value "
223                                      "with LLDB's default formatting.",
224           "", eCommandProcessMustBePaused | eCommandTryTargetAPILock),
225       IOHandlerDelegate(IOHandlerDelegate::Completion::Expression),
226       m_option_group(), m_format_options(eFormatDefault),
227       m_repl_option(LLDB_OPT_SET_1, false, "repl", 'r', "Drop into REPL", false,
228                     true),
229       m_command_options(), m_expr_line_count(0), m_expr_lines() {
230   SetHelpLong(
231       R"(
232 Single and multi-line expressions:
233 
234 )"
235       "    The expression provided on the command line must be a complete expression \
236 with no newlines.  To evaluate a multi-line expression, \
237 hit a return after an empty expression, and lldb will enter the multi-line expression editor. \
238 Hit return on an empty line to end the multi-line expression."
239 
240       R"(
241 
242 Timeouts:
243 
244 )"
245       "    If the expression can be evaluated statically (without running code) then it will be.  \
246 Otherwise, by default the expression will run on the current thread with a short timeout: \
247 currently .25 seconds.  If it doesn't return in that time, the evaluation will be interrupted \
248 and resumed with all threads running.  You can use the -a option to disable retrying on all \
249 threads.  You can use the -t option to set a shorter timeout."
250       R"(
251 
252 User defined variables:
253 
254 )"
255       "    You can define your own variables for convenience or to be used in subsequent expressions.  \
256 You define them the same way you would define variables in C.  If the first character of \
257 your user defined variable is a $, then the variable's value will be available in future \
258 expressions, otherwise it will just be available in the current expression."
259       R"(
260 
261 Continuing evaluation after a breakpoint:
262 
263 )"
264       "    If the \"-i false\" option is used, and execution is interrupted by a breakpoint hit, once \
265 you are done with your investigation, you can either remove the expression execution frames \
266 from the stack with \"thread return -x\" or if you are still interested in the expression result \
267 you can issue the \"continue\" command and the expression evaluation will complete and the \
268 expression result will be available using the \"thread.completed-expression\" key in the thread \
269 format."
270 
271       R"(
272 
273 Examples:
274 
275     expr my_struct->a = my_array[3]
276     expr -f bin -- (index * 8) + 5
277     expr unsigned int $foo = 5
278     expr char c[] = \"foo\"; c[0])");
279 
280   CommandArgumentEntry arg;
281   CommandArgumentData expression_arg;
282 
283   // Define the first (and only) variant of this arg.
284   expression_arg.arg_type = eArgTypeExpression;
285   expression_arg.arg_repetition = eArgRepeatPlain;
286 
287   // There is only one variant this argument could be; put it into the argument
288   // entry.
289   arg.push_back(expression_arg);
290 
291   // Push the data for the first argument into the m_arguments vector.
292   m_arguments.push_back(arg);
293 
294   // Add the "--format" and "--gdb-format"
295   m_option_group.Append(&m_format_options,
296                         OptionGroupFormat::OPTION_GROUP_FORMAT |
297                             OptionGroupFormat::OPTION_GROUP_GDB_FMT,
298                         LLDB_OPT_SET_1);
299   m_option_group.Append(&m_command_options);
300   m_option_group.Append(&m_varobj_options, LLDB_OPT_SET_ALL,
301                         LLDB_OPT_SET_1 | LLDB_OPT_SET_2);
302   m_option_group.Append(&m_repl_option, LLDB_OPT_SET_ALL, LLDB_OPT_SET_3);
303   m_option_group.Finalize();
304 }
305 
306 CommandObjectExpression::~CommandObjectExpression() = default;
307 
308 Options *CommandObjectExpression::GetOptions() { return &m_option_group; }
309 
310 int CommandObjectExpression::HandleCompletion(CompletionRequest &request) {
311   EvaluateExpressionOptions options;
312   options.SetCoerceToId(m_varobj_options.use_objc);
313   options.SetLanguage(m_command_options.language);
314   options.SetExecutionPolicy(lldb_private::eExecutionPolicyNever);
315   options.SetAutoApplyFixIts(false);
316   options.SetGenerateDebugInfo(false);
317 
318   // We need a valid execution context with a frame pointer for this
319   // completion, so if we don't have one we should try to make a valid
320   // execution context.
321   if (m_interpreter.GetExecutionContext().GetFramePtr() == nullptr)
322     m_interpreter.UpdateExecutionContext(nullptr);
323 
324   // This didn't work, so let's get out before we start doing things that
325   // expect a valid frame pointer.
326   if (m_interpreter.GetExecutionContext().GetFramePtr() == nullptr)
327     return 0;
328 
329   ExecutionContext exe_ctx(m_interpreter.GetExecutionContext());
330 
331   Target *target = exe_ctx.GetTargetPtr();
332 
333   if (!target)
334     target = GetDummyTarget();
335 
336   if (!target)
337     return 0;
338 
339   unsigned cursor_pos = request.GetRawCursorPos();
340   llvm::StringRef code = request.GetRawLine();
341 
342   const std::size_t original_code_size = code.size();
343 
344   // Remove the first token which is 'expr' or some alias/abbreviation of that.
345   code = llvm::getToken(code).second.ltrim();
346   OptionsWithRaw args(code);
347   code = args.GetRawPart();
348 
349   // The position where the expression starts in the command line.
350   assert(original_code_size >= code.size());
351   std::size_t raw_start = original_code_size - code.size();
352 
353   // Check if the cursor is actually in the expression string, and if not, we
354   // exit.
355   // FIXME: We should complete the options here.
356   if (cursor_pos < raw_start)
357     return 0;
358 
359   // Make the cursor_pos again relative to the start of the code string.
360   assert(cursor_pos >= raw_start);
361   cursor_pos -= raw_start;
362 
363   auto language = exe_ctx.GetFrameRef().GetLanguage();
364 
365   Status error;
366   lldb::UserExpressionSP expr(target->GetUserExpressionForLanguage(
367       code, llvm::StringRef(), language, UserExpression::eResultTypeAny,
368       options, error));
369   if (error.Fail())
370     return 0;
371 
372   expr->Complete(exe_ctx, request, cursor_pos);
373   return request.GetNumberOfMatches();
374 }
375 
376 static lldb_private::Status
377 CanBeUsedForElementCountPrinting(ValueObject &valobj) {
378   CompilerType type(valobj.GetCompilerType());
379   CompilerType pointee;
380   if (!type.IsPointerType(&pointee))
381     return Status("as it does not refer to a pointer");
382   if (pointee.IsVoidType())
383     return Status("as it refers to a pointer to void");
384   return Status();
385 }
386 
387 bool CommandObjectExpression::EvaluateExpression(llvm::StringRef expr,
388                                                  Stream *output_stream,
389                                                  Stream *error_stream,
390                                                  CommandReturnObject *result) {
391   // Don't use m_exe_ctx as this might be called asynchronously after the
392   // command object DoExecute has finished when doing multi-line expression
393   // that use an input reader...
394   ExecutionContext exe_ctx(m_interpreter.GetExecutionContext());
395 
396   Target *target = exe_ctx.GetTargetPtr();
397 
398   if (!target)
399     target = GetDummyTarget();
400 
401   if (target) {
402     lldb::ValueObjectSP result_valobj_sp;
403     bool keep_in_memory = true;
404     StackFrame *frame = exe_ctx.GetFramePtr();
405 
406     EvaluateExpressionOptions options;
407     options.SetCoerceToId(m_varobj_options.use_objc);
408     options.SetUnwindOnError(m_command_options.unwind_on_error);
409     options.SetIgnoreBreakpoints(m_command_options.ignore_breakpoints);
410     options.SetKeepInMemory(keep_in_memory);
411     options.SetUseDynamic(m_varobj_options.use_dynamic);
412     options.SetTryAllThreads(m_command_options.try_all_threads);
413     options.SetDebug(m_command_options.debug);
414     options.SetLanguage(m_command_options.language);
415     options.SetExecutionPolicy(
416         m_command_options.allow_jit
417             ? EvaluateExpressionOptions::default_execution_policy
418             : lldb_private::eExecutionPolicyNever);
419 
420     bool auto_apply_fixits;
421     if (m_command_options.auto_apply_fixits == eLazyBoolCalculate)
422       auto_apply_fixits = target->GetEnableAutoApplyFixIts();
423     else
424       auto_apply_fixits =
425           m_command_options.auto_apply_fixits == eLazyBoolYes ? true : false;
426 
427     options.SetAutoApplyFixIts(auto_apply_fixits);
428 
429     if (m_command_options.top_level)
430       options.SetExecutionPolicy(eExecutionPolicyTopLevel);
431 
432     // If there is any chance we are going to stop and want to see what went
433     // wrong with our expression, we should generate debug info
434     if (!m_command_options.ignore_breakpoints ||
435         !m_command_options.unwind_on_error)
436       options.SetGenerateDebugInfo(true);
437 
438     if (m_command_options.timeout > 0)
439       options.SetTimeout(std::chrono::microseconds(m_command_options.timeout));
440     else
441       options.SetTimeout(llvm::None);
442 
443     ExpressionResults success = target->EvaluateExpression(
444         expr, frame, result_valobj_sp, options, &m_fixed_expression);
445 
446     // We only tell you about the FixIt if we applied it.  The compiler errors
447     // will suggest the FixIt if it parsed.
448     if (error_stream && !m_fixed_expression.empty() &&
449         target->GetEnableNotifyAboutFixIts()) {
450       if (success == eExpressionCompleted)
451         error_stream->Printf(
452             "  Fix-it applied, fixed expression was: \n    %s\n",
453             m_fixed_expression.c_str());
454     }
455 
456     if (result_valobj_sp) {
457       Format format = m_format_options.GetFormat();
458 
459       if (result_valobj_sp->GetError().Success()) {
460         if (format != eFormatVoid) {
461           if (format != eFormatDefault)
462             result_valobj_sp->SetFormat(format);
463 
464           if (m_varobj_options.elem_count > 0) {
465             Status error(CanBeUsedForElementCountPrinting(*result_valobj_sp));
466             if (error.Fail()) {
467               result->AppendErrorWithFormat(
468                   "expression cannot be used with --element-count %s\n",
469                   error.AsCString(""));
470               result->SetStatus(eReturnStatusFailed);
471               return false;
472             }
473           }
474 
475           DumpValueObjectOptions options(m_varobj_options.GetAsDumpOptions(
476               m_command_options.m_verbosity, format));
477           options.SetVariableFormatDisplayLanguage(
478               result_valobj_sp->GetPreferredDisplayLanguage());
479 
480           result_valobj_sp->Dump(*output_stream, options);
481 
482           if (result)
483             result->SetStatus(eReturnStatusSuccessFinishResult);
484         }
485       } else {
486         if (result_valobj_sp->GetError().GetError() ==
487             UserExpression::kNoResult) {
488           if (format != eFormatVoid &&
489               m_interpreter.GetDebugger().GetNotifyVoid()) {
490             error_stream->PutCString("(void)\n");
491           }
492 
493           if (result)
494             result->SetStatus(eReturnStatusSuccessFinishResult);
495         } else {
496           const char *error_cstr = result_valobj_sp->GetError().AsCString();
497           if (error_cstr && error_cstr[0]) {
498             const size_t error_cstr_len = strlen(error_cstr);
499             const bool ends_with_newline =
500                 error_cstr[error_cstr_len - 1] == '\n';
501             if (strstr(error_cstr, "error:") != error_cstr)
502               error_stream->PutCString("error: ");
503             error_stream->Write(error_cstr, error_cstr_len);
504             if (!ends_with_newline)
505               error_stream->EOL();
506           } else {
507             error_stream->PutCString("error: unknown error\n");
508           }
509 
510           if (result)
511             result->SetStatus(eReturnStatusFailed);
512         }
513       }
514     }
515   } else {
516     error_stream->Printf("error: invalid execution context for expression\n");
517     return false;
518   }
519 
520   return true;
521 }
522 
523 void CommandObjectExpression::IOHandlerInputComplete(IOHandler &io_handler,
524                                                      std::string &line) {
525   io_handler.SetIsDone(true);
526   //    StreamSP output_stream =
527   //    io_handler.GetDebugger().GetAsyncOutputStream();
528   //    StreamSP error_stream = io_handler.GetDebugger().GetAsyncErrorStream();
529   StreamFileSP output_sp(io_handler.GetOutputStreamFile());
530   StreamFileSP error_sp(io_handler.GetErrorStreamFile());
531 
532   EvaluateExpression(line.c_str(), output_sp.get(), error_sp.get());
533   if (output_sp)
534     output_sp->Flush();
535   if (error_sp)
536     error_sp->Flush();
537 }
538 
539 bool CommandObjectExpression::IOHandlerIsInputComplete(IOHandler &io_handler,
540                                                        StringList &lines) {
541   // An empty lines is used to indicate the end of input
542   const size_t num_lines = lines.GetSize();
543   if (num_lines > 0 && lines[num_lines - 1].empty()) {
544     // Remove the last empty line from "lines" so it doesn't appear in our
545     // resulting input and return true to indicate we are done getting lines
546     lines.PopBack();
547     return true;
548   }
549   return false;
550 }
551 
552 void CommandObjectExpression::GetMultilineExpression() {
553   m_expr_lines.clear();
554   m_expr_line_count = 0;
555 
556   Debugger &debugger = GetCommandInterpreter().GetDebugger();
557   bool color_prompt = debugger.GetUseColor();
558   const bool multiple_lines = true; // Get multiple lines
559   IOHandlerSP io_handler_sp(
560       new IOHandlerEditline(debugger, IOHandler::Type::Expression,
561                             "lldb-expr", // Name of input reader for history
562                             llvm::StringRef(), // No prompt
563                             llvm::StringRef(), // Continuation prompt
564                             multiple_lines, color_prompt,
565                             1, // Show line numbers starting at 1
566                             *this));
567 
568   StreamFileSP output_sp(io_handler_sp->GetOutputStreamFile());
569   if (output_sp) {
570     output_sp->PutCString(
571         "Enter expressions, then terminate with an empty line to evaluate:\n");
572     output_sp->Flush();
573   }
574   debugger.PushIOHandler(io_handler_sp);
575 }
576 
577 bool CommandObjectExpression::DoExecute(llvm::StringRef command,
578                                         CommandReturnObject &result) {
579   m_fixed_expression.clear();
580   auto exe_ctx = GetCommandInterpreter().GetExecutionContext();
581   m_option_group.NotifyOptionParsingStarting(&exe_ctx);
582 
583   if (command.empty()) {
584     GetMultilineExpression();
585     return result.Succeeded();
586   }
587 
588   OptionsWithRaw args(command);
589   llvm::StringRef expr = args.GetRawPart();
590 
591   if (args.HasArgs()) {
592     if (!ParseOptionsAndNotify(args.GetArgs(), result, m_option_group, exe_ctx))
593       return false;
594 
595     if (m_repl_option.GetOptionValue().GetCurrentValue()) {
596       Target *target = m_interpreter.GetExecutionContext().GetTargetPtr();
597       if (target) {
598         // Drop into REPL
599         m_expr_lines.clear();
600         m_expr_line_count = 0;
601 
602         Debugger &debugger = target->GetDebugger();
603 
604         // Check if the LLDB command interpreter is sitting on top of a REPL
605         // that launched it...
606         if (debugger.CheckTopIOHandlerTypes(IOHandler::Type::CommandInterpreter,
607                                             IOHandler::Type::REPL)) {
608           // the LLDB command interpreter is sitting on top of a REPL that
609           // launched it, so just say the command interpreter is done and
610           // fall back to the existing REPL
611           m_interpreter.GetIOHandler(false)->SetIsDone(true);
612         } else {
613           // We are launching the REPL on top of the current LLDB command
614           // interpreter, so just push one
615           bool initialize = false;
616           Status repl_error;
617           REPLSP repl_sp(target->GetREPL(repl_error, m_command_options.language,
618                                          nullptr, false));
619 
620           if (!repl_sp) {
621             initialize = true;
622             repl_sp = target->GetREPL(repl_error, m_command_options.language,
623                                       nullptr, true);
624             if (!repl_error.Success()) {
625               result.SetError(repl_error);
626               return result.Succeeded();
627             }
628           }
629 
630           if (repl_sp) {
631             if (initialize) {
632               repl_sp->SetCommandOptions(m_command_options);
633               repl_sp->SetFormatOptions(m_format_options);
634               repl_sp->SetValueObjectDisplayOptions(m_varobj_options);
635             }
636 
637             IOHandlerSP io_handler_sp(repl_sp->GetIOHandler());
638 
639             io_handler_sp->SetIsDone(false);
640 
641             debugger.PushIOHandler(io_handler_sp);
642           } else {
643             repl_error.SetErrorStringWithFormat(
644                 "Couldn't create a REPL for %s",
645                 Language::GetNameForLanguageType(m_command_options.language));
646             result.SetError(repl_error);
647             return result.Succeeded();
648           }
649         }
650       }
651     }
652     // No expression following options
653     else if (expr.empty()) {
654       GetMultilineExpression();
655       return result.Succeeded();
656     }
657   }
658 
659   Target *target = GetSelectedOrDummyTarget();
660   if (EvaluateExpression(expr, &(result.GetOutputStream()),
661                          &(result.GetErrorStream()), &result)) {
662 
663     if (!m_fixed_expression.empty() && target->GetEnableNotifyAboutFixIts()) {
664       CommandHistory &history = m_interpreter.GetCommandHistory();
665       // FIXME: Can we figure out what the user actually typed (e.g. some alias
666       // for expr???)
667       // If we can it would be nice to show that.
668       std::string fixed_command("expression ");
669       if (args.HasArgs()) {
670         // Add in any options that might have been in the original command:
671         fixed_command.append(args.GetArgStringWithDelimiter());
672         fixed_command.append(m_fixed_expression);
673       } else
674         fixed_command.append(m_fixed_expression);
675       history.AppendString(fixed_command);
676     }
677     // Increment statistics to record this expression evaluation success.
678     target->IncrementStats(StatisticKind::ExpressionSuccessful);
679     return true;
680   }
681 
682   // Increment statistics to record this expression evaluation failure.
683   target->IncrementStats(StatisticKind::ExpressionFailure);
684   result.SetStatus(eReturnStatusFailed);
685   return false;
686 }
687