LLDB  mainline
CommandInterpreter.cpp
Go to the documentation of this file.
1 //===-- CommandInterpreter.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 <cstdlib>
10 #include <limits>
11 #include <memory>
12 #include <string>
13 #include <vector>
14 
44 
45 #include "lldb/Core/Debugger.h"
47 #include "lldb/Core/StreamFile.h"
48 #include "lldb/Utility/Log.h"
50 #include "lldb/Utility/State.h"
51 #include "lldb/Utility/Stream.h"
52 #include "lldb/Utility/Timer.h"
53 
54 #include "lldb/Host/Config.h"
55 #if LLDB_ENABLE_LIBEDIT
56 #include "lldb/Host/Editline.h"
57 #endif
58 #include "lldb/Host/File.h"
59 #include "lldb/Host/FileCache.h"
60 #include "lldb/Host/Host.h"
61 #include "lldb/Host/HostInfo.h"
62 
69 #include "lldb/Utility/Args.h"
70 
71 #include "lldb/Target/Language.h"
72 #include "lldb/Target/Process.h"
73 #include "lldb/Target/StopInfo.h"
74 #include "lldb/Target/TargetList.h"
75 #include "lldb/Target/Thread.h"
77 
78 #include "llvm/ADT/STLExtras.h"
79 #include "llvm/ADT/ScopeExit.h"
80 #include "llvm/ADT/SmallString.h"
81 #include "llvm/Support/FormatAdapters.h"
82 #include "llvm/Support/Path.h"
83 #include "llvm/Support/PrettyStackTrace.h"
84 #include "llvm/Support/ScopedPrinter.h"
85 
86 using namespace lldb;
87 using namespace lldb_private;
88 
89 static const char *k_white_space = " \t\v";
90 
91 static constexpr const char *InitFileWarning =
92  "There is a .lldbinit file in the current directory which is not being "
93  "read.\n"
94  "To silence this warning without sourcing in the local .lldbinit,\n"
95  "add the following to the lldbinit file in your home directory:\n"
96  " settings set target.load-cwd-lldbinit false\n"
97  "To allow lldb to source .lldbinit files in the current working "
98  "directory,\n"
99  "set the value of this variable to true. Only do so if you understand "
100  "and\n"
101  "accept the security risk.";
102 
103 #define LLDB_PROPERTIES_interpreter
104 #include "InterpreterProperties.inc"
105 
106 enum {
107 #define LLDB_PROPERTIES_interpreter
108 #include "InterpreterPropertiesEnum.inc"
109 };
110 
111 ConstString &CommandInterpreter::GetStaticBroadcasterClass() {
112  static ConstString class_name("lldb.commandInterpreter");
113  return class_name;
114 }
115 
116 CommandInterpreter::CommandInterpreter(Debugger &debugger,
117  bool synchronous_execution)
118  : Broadcaster(debugger.GetBroadcasterManager(),
119  CommandInterpreter::GetStaticBroadcasterClass().AsCString()),
120  Properties(OptionValuePropertiesSP(
121  new OptionValueProperties(ConstString("interpreter")))),
123  m_debugger(debugger), m_synchronous_execution(true),
124  m_skip_lldbinit_files(false), m_skip_app_init_files(false),
125  m_comment_char('#'), m_batch_command_mode(false),
126  m_truncation_warning(eNoTruncation), m_command_source_depth(0) {
127  SetEventName(eBroadcastBitThreadShouldExit, "thread-should-exit");
128  SetEventName(eBroadcastBitResetPrompt, "reset-prompt");
130  SetSynchronous(synchronous_execution);
132  m_collection_sp->Initialize(g_interpreter_properties);
133 }
134 
136  const uint32_t idx = ePropertyExpandRegexAliases;
137  return m_collection_sp->GetPropertyAtIndexAsBoolean(
138  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
139 }
140 
142  const uint32_t idx = ePropertyPromptOnQuit;
143  return m_collection_sp->GetPropertyAtIndexAsBoolean(
144  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
145 }
146 
148  const uint32_t idx = ePropertyPromptOnQuit;
149  m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable);
150 }
151 
153  const uint32_t idx = ePropertySaveSessionOnQuit;
154  return m_collection_sp->GetPropertyAtIndexAsBoolean(
155  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
156 }
157 
159  const uint32_t idx = ePropertySaveSessionOnQuit;
160  m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable);
161 }
162 
164  const uint32_t idx = ePropertySaveSessionDirectory;
165  return m_collection_sp->GetPropertyAtIndexAsFileSpec(nullptr, idx);
166 }
167 
169  const uint32_t idx = ePropertySaveSessionDirectory;
170  m_collection_sp->SetPropertyAtIndexAsString(nullptr, idx, path);
171 }
172 
174  const uint32_t idx = ePropertyEchoCommands;
175  return m_collection_sp->GetPropertyAtIndexAsBoolean(
176  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
177 }
178 
180  const uint32_t idx = ePropertyEchoCommands;
181  m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable);
182 }
183 
185  const uint32_t idx = ePropertyEchoCommentCommands;
186  return m_collection_sp->GetPropertyAtIndexAsBoolean(
187  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
188 }
189 
191  const uint32_t idx = ePropertyEchoCommentCommands;
192  m_collection_sp->SetPropertyAtIndexAsBoolean(nullptr, idx, enable);
193 }
194 
196  m_allow_exit_code = allow;
197  if (!allow)
198  m_quit_exit_code.reset();
199 }
200 
202  if (!m_allow_exit_code)
203  return false;
204  m_quit_exit_code = exit_code;
205  return true;
206 }
207 
208 int CommandInterpreter::GetQuitExitCode(bool &exited) const {
209  exited = m_quit_exit_code.hasValue();
210  if (exited)
211  return *m_quit_exit_code;
212  return 0;
213 }
214 
215 void CommandInterpreter::ResolveCommand(const char *command_line,
216  CommandReturnObject &result) {
217  std::string command = command_line;
218  if (ResolveCommandImpl(command, result) != nullptr) {
219  result.AppendMessageWithFormat("%s", command.c_str());
221  }
222 }
223 
225  const uint32_t idx = ePropertyStopCmdSourceOnError;
226  return m_collection_sp->GetPropertyAtIndexAsBoolean(
227  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
228 }
229 
231  const uint32_t idx = ePropertySpaceReplPrompts;
232  return m_collection_sp->GetPropertyAtIndexAsBoolean(
233  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
234 }
235 
237  const uint32_t idx = ePropertyRepeatPreviousCommand;
238  return m_collection_sp->GetPropertyAtIndexAsBoolean(
239  nullptr, idx, g_interpreter_properties[idx].default_uint_value != 0);
240 }
241 
244 
246 
248 
249  // An alias arguments vector to reuse - reset it before use...
250  OptionArgVectorSP alias_arguments_vector_sp(new OptionArgVector);
251 
252  // Set up some initial aliases.
253  CommandObjectSP cmd_obj_sp = GetCommandSPExact("quit");
254  if (cmd_obj_sp) {
255  AddAlias("q", cmd_obj_sp);
256  AddAlias("exit", cmd_obj_sp);
257  }
258 
259  cmd_obj_sp = GetCommandSPExact("_regexp-attach");
260  if (cmd_obj_sp)
261  AddAlias("attach", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
262 
263  cmd_obj_sp = GetCommandSPExact("process detach");
264  if (cmd_obj_sp) {
265  AddAlias("detach", cmd_obj_sp);
266  }
267 
268  cmd_obj_sp = GetCommandSPExact("process continue");
269  if (cmd_obj_sp) {
270  AddAlias("c", cmd_obj_sp);
271  AddAlias("continue", cmd_obj_sp);
272  }
273 
274  cmd_obj_sp = GetCommandSPExact("_regexp-break");
275  if (cmd_obj_sp)
276  AddAlias("b", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
277 
278  cmd_obj_sp = GetCommandSPExact("_regexp-tbreak");
279  if (cmd_obj_sp)
280  AddAlias("tbreak", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
281 
282  cmd_obj_sp = GetCommandSPExact("thread step-inst");
283  if (cmd_obj_sp) {
284  AddAlias("stepi", cmd_obj_sp);
285  AddAlias("si", cmd_obj_sp);
286  }
287 
288  cmd_obj_sp = GetCommandSPExact("thread step-inst-over");
289  if (cmd_obj_sp) {
290  AddAlias("nexti", cmd_obj_sp);
291  AddAlias("ni", cmd_obj_sp);
292  }
293 
294  cmd_obj_sp = GetCommandSPExact("thread step-in");
295  if (cmd_obj_sp) {
296  AddAlias("s", cmd_obj_sp);
297  AddAlias("step", cmd_obj_sp);
298  CommandAlias *sif_alias = AddAlias(
299  "sif", cmd_obj_sp, "--end-linenumber block --step-in-target %1");
300  if (sif_alias) {
301  sif_alias->SetHelp("Step through the current block, stopping if you step "
302  "directly into a function whose name matches the "
303  "TargetFunctionName.");
304  sif_alias->SetSyntax("sif <TargetFunctionName>");
305  }
306  }
307 
308  cmd_obj_sp = GetCommandSPExact("thread step-over");
309  if (cmd_obj_sp) {
310  AddAlias("n", cmd_obj_sp);
311  AddAlias("next", cmd_obj_sp);
312  }
313 
314  cmd_obj_sp = GetCommandSPExact("thread step-out");
315  if (cmd_obj_sp) {
316  AddAlias("finish", cmd_obj_sp);
317  }
318 
319  cmd_obj_sp = GetCommandSPExact("frame select");
320  if (cmd_obj_sp) {
321  AddAlias("f", cmd_obj_sp);
322  }
323 
324  cmd_obj_sp = GetCommandSPExact("thread select");
325  if (cmd_obj_sp) {
326  AddAlias("t", cmd_obj_sp);
327  }
328 
329  cmd_obj_sp = GetCommandSPExact("_regexp-jump");
330  if (cmd_obj_sp) {
331  AddAlias("j", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
332  AddAlias("jump", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
333  }
334 
335  cmd_obj_sp = GetCommandSPExact("_regexp-list");
336  if (cmd_obj_sp) {
337  AddAlias("l", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
338  AddAlias("list", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
339  }
340 
341  cmd_obj_sp = GetCommandSPExact("_regexp-env");
342  if (cmd_obj_sp)
343  AddAlias("env", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
344 
345  cmd_obj_sp = GetCommandSPExact("memory read");
346  if (cmd_obj_sp)
347  AddAlias("x", cmd_obj_sp);
348 
349  cmd_obj_sp = GetCommandSPExact("_regexp-up");
350  if (cmd_obj_sp)
351  AddAlias("up", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
352 
353  cmd_obj_sp = GetCommandSPExact("_regexp-down");
354  if (cmd_obj_sp)
355  AddAlias("down", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
356 
357  cmd_obj_sp = GetCommandSPExact("_regexp-display");
358  if (cmd_obj_sp)
359  AddAlias("display", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
360 
361  cmd_obj_sp = GetCommandSPExact("disassemble");
362  if (cmd_obj_sp)
363  AddAlias("dis", cmd_obj_sp);
364 
365  cmd_obj_sp = GetCommandSPExact("disassemble");
366  if (cmd_obj_sp)
367  AddAlias("di", cmd_obj_sp);
368 
369  cmd_obj_sp = GetCommandSPExact("_regexp-undisplay");
370  if (cmd_obj_sp)
371  AddAlias("undisplay", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
372 
373  cmd_obj_sp = GetCommandSPExact("_regexp-bt");
374  if (cmd_obj_sp)
375  AddAlias("bt", cmd_obj_sp)->SetSyntax(cmd_obj_sp->GetSyntax());
376 
377  cmd_obj_sp = GetCommandSPExact("target create");
378  if (cmd_obj_sp)
379  AddAlias("file", cmd_obj_sp);
380 
381  cmd_obj_sp = GetCommandSPExact("target modules");
382  if (cmd_obj_sp)
383  AddAlias("image", cmd_obj_sp);
384 
385  alias_arguments_vector_sp = std::make_shared<OptionArgVector>();
386 
387  cmd_obj_sp = GetCommandSPExact("expression");
388  if (cmd_obj_sp) {
389  AddAlias("p", cmd_obj_sp, "--")->SetHelpLong("");
390  AddAlias("print", cmd_obj_sp, "--")->SetHelpLong("");
391  AddAlias("call", cmd_obj_sp, "--")->SetHelpLong("");
392  if (auto *po = AddAlias("po", cmd_obj_sp, "-O --")) {
393  po->SetHelp("Evaluate an expression on the current thread. Displays any "
394  "returned value with formatting "
395  "controlled by the type's author.");
396  po->SetHelpLong("");
397  }
398  CommandAlias *parray_alias =
399  AddAlias("parray", cmd_obj_sp, "--element-count %1 --");
400  if (parray_alias) {
401  parray_alias->SetHelp
402  ("parray <COUNT> <EXPRESSION> -- lldb will evaluate EXPRESSION "
403  "to get a typed-pointer-to-an-array in memory, and will display "
404  "COUNT elements of that type from the array.");
405  parray_alias->SetHelpLong("");
406  }
407  CommandAlias *poarray_alias = AddAlias("poarray", cmd_obj_sp,
408  "--object-description --element-count %1 --");
409  if (poarray_alias) {
410  poarray_alias->SetHelp("poarray <COUNT> <EXPRESSION> -- lldb will "
411  "evaluate EXPRESSION to get the address of an array of COUNT "
412  "objects in memory, and will call po on them.");
413  poarray_alias->SetHelpLong("");
414  }
415  }
416 
417  cmd_obj_sp = GetCommandSPExact("platform shell");
418  if (cmd_obj_sp) {
419  CommandAlias *shell_alias = AddAlias("shell", cmd_obj_sp, " --host --");
420  if (shell_alias) {
421  shell_alias->SetHelp("Run a shell command on the host.");
422  shell_alias->SetHelpLong("");
423  shell_alias->SetSyntax("shell <shell-command>");
424  }
425  }
426 
427  cmd_obj_sp = GetCommandSPExact("process kill");
428  if (cmd_obj_sp) {
429  AddAlias("kill", cmd_obj_sp);
430  }
431 
432  cmd_obj_sp = GetCommandSPExact("process launch");
433  if (cmd_obj_sp) {
434  alias_arguments_vector_sp = std::make_shared<OptionArgVector>();
435 #if defined(__APPLE__)
436 #if defined(TARGET_OS_IPHONE)
437  AddAlias("r", cmd_obj_sp, "--");
438  AddAlias("run", cmd_obj_sp, "--");
439 #else
440  AddAlias("r", cmd_obj_sp, "--shell-expand-args true --");
441  AddAlias("run", cmd_obj_sp, "--shell-expand-args true --");
442 #endif
443 #else
444  StreamString defaultshell;
445  defaultshell.Printf("--shell=%s --",
446  HostInfo::GetDefaultShell().GetPath().c_str());
447  AddAlias("r", cmd_obj_sp, defaultshell.GetString());
448  AddAlias("run", cmd_obj_sp, defaultshell.GetString());
449 #endif
450  }
451 
452  cmd_obj_sp = GetCommandSPExact("target symbols add");
453  if (cmd_obj_sp) {
454  AddAlias("add-dsym", cmd_obj_sp);
455  }
456 
457  cmd_obj_sp = GetCommandSPExact("breakpoint set");
458  if (cmd_obj_sp) {
459  AddAlias("rbreak", cmd_obj_sp, "--func-regex %1");
460  }
461 
462  cmd_obj_sp = GetCommandSPExact("frame variable");
463  if (cmd_obj_sp) {
464  AddAlias("v", cmd_obj_sp);
465  AddAlias("var", cmd_obj_sp);
466  AddAlias("vo", cmd_obj_sp, "--object-description");
467  }
468 
469  cmd_obj_sp = GetCommandSPExact("register");
470  if (cmd_obj_sp) {
471  AddAlias("re", cmd_obj_sp);
472  }
473 
474  cmd_obj_sp = GetCommandSPExact("session history");
475  if (cmd_obj_sp) {
476  AddAlias("history", cmd_obj_sp);
477  }
478 }
479 
481  m_command_io_handler_sp.reset();
482 }
483 
485  // This function has not yet been implemented.
486 
487  // Look for any embedded script command
488  // If found,
489  // get interpreter object from the command dictionary,
490  // call execute_one_command on it,
491  // get the results as a string,
492  // substitute that string for current stuff.
493 
494  return arg;
495 }
496 
497 #define REGISTER_COMMAND_OBJECT(NAME, CLASS) \
498  m_command_dict[NAME] = std::make_shared<CLASS>(*this);
499 
502 
531 
532  // clang-format off
533  const char *break_regexes[][2] = {
534  {"^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*$",
535  "breakpoint set --file '%1' --line %2 --column %3"},
536  {"^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*$",
537  "breakpoint set --file '%1' --line %2"},
538  {"^/([^/]+)/$", "breakpoint set --source-pattern-regexp '%1'"},
539  {"^([[:digit:]]+)[[:space:]]*$", "breakpoint set --line %1"},
540  {"^\\*?(0x[[:xdigit:]]+)[[:space:]]*$", "breakpoint set --address %1"},
541  {"^[\"']?([-+]?\\[.*\\])[\"']?[[:space:]]*$",
542  "breakpoint set --name '%1'"},
543  {"^(-.*)$", "breakpoint set %1"},
544  {"^(.*[^[:space:]])`(.*[^[:space:]])[[:space:]]*$",
545  "breakpoint set --name '%2' --shlib '%1'"},
546  {"^\\&(.*[^[:space:]])[[:space:]]*$",
547  "breakpoint set --name '%1' --skip-prologue=0"},
548  {"^[\"']?(.*[^[:space:]\"'])[\"']?[[:space:]]*$",
549  "breakpoint set --name '%1'"}};
550  // clang-format on
551 
552  size_t num_regexes = llvm::array_lengthof(break_regexes);
553 
554  std::unique_ptr<CommandObjectRegexCommand> break_regex_cmd_up(
556  *this, "_regexp-break",
557  "Set a breakpoint using one of several shorthand formats.",
558  "\n"
559  "_regexp-break <filename>:<linenum>:<colnum>\n"
560  " main.c:12:21 // Break at line 12 and column "
561  "21 of main.c\n\n"
562  "_regexp-break <filename>:<linenum>\n"
563  " main.c:12 // Break at line 12 of "
564  "main.c\n\n"
565  "_regexp-break <linenum>\n"
566  " 12 // Break at line 12 of current "
567  "file\n\n"
568  "_regexp-break 0x<address>\n"
569  " 0x1234000 // Break at address "
570  "0x1234000\n\n"
571  "_regexp-break <name>\n"
572  " main // Break in 'main' after the "
573  "prologue\n\n"
574  "_regexp-break &<name>\n"
575  " &main // Break at first instruction "
576  "in 'main'\n\n"
577  "_regexp-break <module>`<name>\n"
578  " libc.so`malloc // Break in 'malloc' from "
579  "'libc.so'\n\n"
580  "_regexp-break /<source-regex>/\n"
581  " /break here/ // Break on source lines in "
582  "current file\n"
583  " // containing text 'break "
584  "here'.\n",
585  3,
588  false));
589 
590  if (break_regex_cmd_up) {
591  bool success = true;
592  for (size_t i = 0; i < num_regexes; i++) {
593  success = break_regex_cmd_up->AddRegexCommand(break_regexes[i][0],
594  break_regexes[i][1]);
595  if (!success)
596  break;
597  }
598  success =
599  break_regex_cmd_up->AddRegexCommand("^$", "breakpoint list --full");
600 
601  if (success) {
602  CommandObjectSP break_regex_cmd_sp(break_regex_cmd_up.release());
603  m_command_dict[std::string(break_regex_cmd_sp->GetCommandName())] =
604  break_regex_cmd_sp;
605  }
606  }
607 
608  std::unique_ptr<CommandObjectRegexCommand> tbreak_regex_cmd_up(
610  *this, "_regexp-tbreak",
611  "Set a one-shot breakpoint using one of several shorthand formats.",
612  "\n"
613  "_regexp-break <filename>:<linenum>:<colnum>\n"
614  " main.c:12:21 // Break at line 12 and column "
615  "21 of main.c\n\n"
616  "_regexp-break <filename>:<linenum>\n"
617  " main.c:12 // Break at line 12 of "
618  "main.c\n\n"
619  "_regexp-break <linenum>\n"
620  " 12 // Break at line 12 of current "
621  "file\n\n"
622  "_regexp-break 0x<address>\n"
623  " 0x1234000 // Break at address "
624  "0x1234000\n\n"
625  "_regexp-break <name>\n"
626  " main // Break in 'main' after the "
627  "prologue\n\n"
628  "_regexp-break &<name>\n"
629  " &main // Break at first instruction "
630  "in 'main'\n\n"
631  "_regexp-break <module>`<name>\n"
632  " libc.so`malloc // Break in 'malloc' from "
633  "'libc.so'\n\n"
634  "_regexp-break /<source-regex>/\n"
635  " /break here/ // Break on source lines in "
636  "current file\n"
637  " // containing text 'break "
638  "here'.\n",
639  2,
642  false));
643 
644  if (tbreak_regex_cmd_up) {
645  bool success = true;
646  for (size_t i = 0; i < num_regexes; i++) {
647  std::string command = break_regexes[i][1];
648  command += " -o 1";
649  success =
650  tbreak_regex_cmd_up->AddRegexCommand(break_regexes[i][0], command);
651  if (!success)
652  break;
653  }
654  success =
655  tbreak_regex_cmd_up->AddRegexCommand("^$", "breakpoint list --full");
656 
657  if (success) {
658  CommandObjectSP tbreak_regex_cmd_sp(tbreak_regex_cmd_up.release());
659  m_command_dict[std::string(tbreak_regex_cmd_sp->GetCommandName())] =
660  tbreak_regex_cmd_sp;
661  }
662  }
663 
664  std::unique_ptr<CommandObjectRegexCommand> attach_regex_cmd_up(
666  *this, "_regexp-attach", "Attach to process by ID or name.",
667  "_regexp-attach <pid> | <process-name>", 2, 0, false));
668  if (attach_regex_cmd_up) {
669  if (attach_regex_cmd_up->AddRegexCommand("^([0-9]+)[[:space:]]*$",
670  "process attach --pid %1") &&
671  attach_regex_cmd_up->AddRegexCommand(
672  "^(-.*|.* -.*)$", "process attach %1") && // Any options that are
673  // specified get passed to
674  // 'process attach'
675  attach_regex_cmd_up->AddRegexCommand("^(.+)$",
676  "process attach --name '%1'") &&
677  attach_regex_cmd_up->AddRegexCommand("^$", "process attach")) {
678  CommandObjectSP attach_regex_cmd_sp(attach_regex_cmd_up.release());
679  m_command_dict[std::string(attach_regex_cmd_sp->GetCommandName())] =
680  attach_regex_cmd_sp;
681  }
682  }
683 
684  std::unique_ptr<CommandObjectRegexCommand> down_regex_cmd_up(
685  new CommandObjectRegexCommand(*this, "_regexp-down",
686  "Select a newer stack frame. Defaults to "
687  "moving one frame, a numeric argument can "
688  "specify an arbitrary number.",
689  "_regexp-down [<count>]", 2, 0, false));
690  if (down_regex_cmd_up) {
691  if (down_regex_cmd_up->AddRegexCommand("^$", "frame select -r -1") &&
692  down_regex_cmd_up->AddRegexCommand("^([0-9]+)$",
693  "frame select -r -%1")) {
694  CommandObjectSP down_regex_cmd_sp(down_regex_cmd_up.release());
695  m_command_dict[std::string(down_regex_cmd_sp->GetCommandName())] =
696  down_regex_cmd_sp;
697  }
698  }
699 
700  std::unique_ptr<CommandObjectRegexCommand> up_regex_cmd_up(
702  *this, "_regexp-up",
703  "Select an older stack frame. Defaults to moving one "
704  "frame, a numeric argument can specify an arbitrary number.",
705  "_regexp-up [<count>]", 2, 0, false));
706  if (up_regex_cmd_up) {
707  if (up_regex_cmd_up->AddRegexCommand("^$", "frame select -r 1") &&
708  up_regex_cmd_up->AddRegexCommand("^([0-9]+)$", "frame select -r %1")) {
709  CommandObjectSP up_regex_cmd_sp(up_regex_cmd_up.release());
710  m_command_dict[std::string(up_regex_cmd_sp->GetCommandName())] =
711  up_regex_cmd_sp;
712  }
713  }
714 
715  std::unique_ptr<CommandObjectRegexCommand> display_regex_cmd_up(
717  *this, "_regexp-display",
718  "Evaluate an expression at every stop (see 'help target stop-hook'.)",
719  "_regexp-display expression", 2, 0, false));
720  if (display_regex_cmd_up) {
721  if (display_regex_cmd_up->AddRegexCommand(
722  "^(.+)$", "target stop-hook add -o \"expr -- %1\"")) {
723  CommandObjectSP display_regex_cmd_sp(display_regex_cmd_up.release());
724  m_command_dict[std::string(display_regex_cmd_sp->GetCommandName())] =
725  display_regex_cmd_sp;
726  }
727  }
728 
729  std::unique_ptr<CommandObjectRegexCommand> undisplay_regex_cmd_up(
730  new CommandObjectRegexCommand(*this, "_regexp-undisplay",
731  "Stop displaying expression at every "
732  "stop (specified by stop-hook index.)",
733  "_regexp-undisplay stop-hook-number", 2, 0,
734  false));
735  if (undisplay_regex_cmd_up) {
736  if (undisplay_regex_cmd_up->AddRegexCommand("^([0-9]+)$",
737  "target stop-hook delete %1")) {
738  CommandObjectSP undisplay_regex_cmd_sp(undisplay_regex_cmd_up.release());
739  m_command_dict[std::string(undisplay_regex_cmd_sp->GetCommandName())] =
740  undisplay_regex_cmd_sp;
741  }
742  }
743 
744  std::unique_ptr<CommandObjectRegexCommand> connect_gdb_remote_cmd_up(
746  *this, "gdb-remote",
747  "Connect to a process via remote GDB server.\n"
748  "If no host is specifed, localhost is assumed.\n"
749  "gdb-remote is an abbreviation for 'process connect --plugin "
750  "gdb-remote connect://<hostname>:<port>'\n",
751  "gdb-remote [<hostname>:]<portnum>", 2, 0, false));
752  if (connect_gdb_remote_cmd_up) {
753  if (connect_gdb_remote_cmd_up->AddRegexCommand(
754  "^([^:]+|\\[[0-9a-fA-F:]+.*\\]):([0-9]+)$",
755  "process connect --plugin gdb-remote connect://%1:%2") &&
756  connect_gdb_remote_cmd_up->AddRegexCommand(
757  "^([[:digit:]]+)$",
758  "process connect --plugin gdb-remote connect://localhost:%1")) {
759  CommandObjectSP command_sp(connect_gdb_remote_cmd_up.release());
760  m_command_dict[std::string(command_sp->GetCommandName())] = command_sp;
761  }
762  }
763 
764  std::unique_ptr<CommandObjectRegexCommand> connect_kdp_remote_cmd_up(
766  *this, "kdp-remote",
767  "Connect to a process via remote KDP server.\n"
768  "If no UDP port is specified, port 41139 is assumed.\n"
769  "kdp-remote is an abbreviation for 'process connect --plugin "
770  "kdp-remote udp://<hostname>:<port>'\n",
771  "kdp-remote <hostname>[:<portnum>]", 2, 0, false));
772  if (connect_kdp_remote_cmd_up) {
773  if (connect_kdp_remote_cmd_up->AddRegexCommand(
774  "^([^:]+:[[:digit:]]+)$",
775  "process connect --plugin kdp-remote udp://%1") &&
776  connect_kdp_remote_cmd_up->AddRegexCommand(
777  "^(.+)$", "process connect --plugin kdp-remote udp://%1:41139")) {
778  CommandObjectSP command_sp(connect_kdp_remote_cmd_up.release());
779  m_command_dict[std::string(command_sp->GetCommandName())] = command_sp;
780  }
781  }
782 
783  std::unique_ptr<CommandObjectRegexCommand> bt_regex_cmd_up(
785  *this, "_regexp-bt",
786  "Show the current thread's call stack. Any numeric argument "
787  "displays at most that many "
788  "frames. The argument 'all' displays all threads. Use 'settings"
789  " set frame-format' to customize the printing of individual frames "
790  "and 'settings set thread-format' to customize the thread header.",
791  "bt [<digit> | all]", 2, 0, false));
792  if (bt_regex_cmd_up) {
793  // accept but don't document "bt -c <number>" -- before bt was a regex
794  // command if you wanted to backtrace three frames you would do "bt -c 3"
795  // but the intention is to have this emulate the gdb "bt" command and so
796  // now "bt 3" is the preferred form, in line with gdb.
797  if (bt_regex_cmd_up->AddRegexCommand("^([[:digit:]]+)[[:space:]]*$",
798  "thread backtrace -c %1") &&
799  bt_regex_cmd_up->AddRegexCommand("^-c ([[:digit:]]+)[[:space:]]*$",
800  "thread backtrace -c %1") &&
801  bt_regex_cmd_up->AddRegexCommand("^all[[:space:]]*$", "thread backtrace all") &&
802  bt_regex_cmd_up->AddRegexCommand("^[[:space:]]*$", "thread backtrace")) {
803  CommandObjectSP command_sp(bt_regex_cmd_up.release());
804  m_command_dict[std::string(command_sp->GetCommandName())] = command_sp;
805  }
806  }
807 
808  std::unique_ptr<CommandObjectRegexCommand> list_regex_cmd_up(
810  *this, "_regexp-list",
811  "List relevant source code using one of several shorthand formats.",
812  "\n"
813  "_regexp-list <file>:<line> // List around specific file/line\n"
814  "_regexp-list <line> // List current file around specified "
815  "line\n"
816  "_regexp-list <function-name> // List specified function\n"
817  "_regexp-list 0x<address> // List around specified address\n"
818  "_regexp-list -[<count>] // List previous <count> lines\n"
819  "_regexp-list // List subsequent lines",
821  if (list_regex_cmd_up) {
822  if (list_regex_cmd_up->AddRegexCommand("^([0-9]+)[[:space:]]*$",
823  "source list --line %1") &&
824  list_regex_cmd_up->AddRegexCommand(
825  "^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]"
826  "]*$",
827  "source list --file '%1' --line %2") &&
828  list_regex_cmd_up->AddRegexCommand(
829  "^\\*?(0x[[:xdigit:]]+)[[:space:]]*$",
830  "source list --address %1") &&
831  list_regex_cmd_up->AddRegexCommand("^-[[:space:]]*$",
832  "source list --reverse") &&
833  list_regex_cmd_up->AddRegexCommand(
834  "^-([[:digit:]]+)[[:space:]]*$",
835  "source list --reverse --count %1") &&
836  list_regex_cmd_up->AddRegexCommand("^(.+)$",
837  "source list --name \"%1\"") &&
838  list_regex_cmd_up->AddRegexCommand("^$", "source list")) {
839  CommandObjectSP list_regex_cmd_sp(list_regex_cmd_up.release());
840  m_command_dict[std::string(list_regex_cmd_sp->GetCommandName())] =
841  list_regex_cmd_sp;
842  }
843  }
844 
845  std::unique_ptr<CommandObjectRegexCommand> env_regex_cmd_up(
847  *this, "_regexp-env",
848  "Shorthand for viewing and setting environment variables.",
849  "\n"
850  "_regexp-env // Show environment\n"
851  "_regexp-env <name>=<value> // Set an environment variable",
852  2, 0, false));
853  if (env_regex_cmd_up) {
854  if (env_regex_cmd_up->AddRegexCommand("^$",
855  "settings show target.env-vars") &&
856  env_regex_cmd_up->AddRegexCommand("^([A-Za-z_][A-Za-z_0-9]*=.*)$",
857  "settings set target.env-vars %1")) {
858  CommandObjectSP env_regex_cmd_sp(env_regex_cmd_up.release());
859  m_command_dict[std::string(env_regex_cmd_sp->GetCommandName())] =
860  env_regex_cmd_sp;
861  }
862  }
863 
864  std::unique_ptr<CommandObjectRegexCommand> jump_regex_cmd_up(
866  *this, "_regexp-jump", "Set the program counter to a new address.",
867  "\n"
868  "_regexp-jump <line>\n"
869  "_regexp-jump +<line-offset> | -<line-offset>\n"
870  "_regexp-jump <file>:<line>\n"
871  "_regexp-jump *<addr>\n",
872  2, 0, false));
873  if (jump_regex_cmd_up) {
874  if (jump_regex_cmd_up->AddRegexCommand("^\\*(.*)$",
875  "thread jump --addr %1") &&
876  jump_regex_cmd_up->AddRegexCommand("^([0-9]+)$",
877  "thread jump --line %1") &&
878  jump_regex_cmd_up->AddRegexCommand("^([^:]+):([0-9]+)$",
879  "thread jump --file %1 --line %2") &&
880  jump_regex_cmd_up->AddRegexCommand("^([+\\-][0-9]+)$",
881  "thread jump --by %1")) {
882  CommandObjectSP jump_regex_cmd_sp(jump_regex_cmd_up.release());
883  m_command_dict[std::string(jump_regex_cmd_sp->GetCommandName())] =
884  jump_regex_cmd_sp;
885  }
886  }
887 }
888 
890  const char *cmd_str, bool include_aliases, StringList &matches,
891  StringList &descriptions) {
893  &descriptions);
894 
895  if (include_aliases) {
897  &descriptions);
898  }
899 
900  return matches.GetSize();
901 }
902 
904  Args &path, bool leaf_is_command, Status &result) {
905  result.Clear();
906 
907  auto get_multi_or_report_error =
908  [&result](CommandObjectSP cmd_sp,
909  const char *name) -> CommandObjectMultiword * {
910  if (!cmd_sp) {
911  result.SetErrorStringWithFormat("Path component: '%s' not found", name);
912  return nullptr;
913  }
914  if (!cmd_sp->IsUserCommand()) {
915  result.SetErrorStringWithFormat("Path component: '%s' is not a user "
916  "command",
917  name);
918  return nullptr;
919  }
920  CommandObjectMultiword *cmd_as_multi = cmd_sp->GetAsMultiwordCommand();
921  if (!cmd_as_multi) {
922  result.SetErrorStringWithFormat("Path component: '%s' is not a container "
923  "command",
924  name);
925  return nullptr;
926  }
927  return cmd_as_multi;
928  };
929 
930  size_t num_args = path.GetArgumentCount();
931  if (num_args == 0) {
932  result.SetErrorString("empty command path");
933  return nullptr;
934  }
935 
936  if (num_args == 1 && leaf_is_command) {
937  // We just got a leaf command to be added to the root. That's not an error,
938  // just return null for the container.
939  return nullptr;
940  }
941 
942  // Start by getting the root command from the interpreter.
943  const char *cur_name = path.GetArgumentAtIndex(0);
944  CommandObjectSP cur_cmd_sp = GetCommandSPExact(cur_name);
945  CommandObjectMultiword *cur_as_multi =
946  get_multi_or_report_error(cur_cmd_sp, cur_name);
947  if (cur_as_multi == nullptr)
948  return nullptr;
949 
950  size_t num_path_elements = num_args - (leaf_is_command ? 1 : 0);
951  for (size_t cursor = 1; cursor < num_path_elements && cur_as_multi != nullptr;
952  cursor++) {
953  cur_name = path.GetArgumentAtIndex(cursor);
954  cur_cmd_sp = cur_as_multi->GetSubcommandSPExact(cur_name);
955  cur_as_multi = get_multi_or_report_error(cur_cmd_sp, cur_name);
956  }
957  return cur_as_multi;
958 }
959 
960 CommandObjectSP
961 CommandInterpreter::GetCommandSP(llvm::StringRef cmd_str, bool include_aliases,
962  bool exact, StringList *matches,
963  StringList *descriptions) const {
964  CommandObjectSP command_sp;
965 
966  std::string cmd = std::string(cmd_str);
967 
968  if (HasCommands()) {
969  auto pos = m_command_dict.find(cmd);
970  if (pos != m_command_dict.end())
971  command_sp = pos->second;
972  }
973 
974  if (include_aliases && HasAliases()) {
975  auto alias_pos = m_alias_dict.find(cmd);
976  if (alias_pos != m_alias_dict.end())
977  command_sp = alias_pos->second;
978  }
979 
980  if (HasUserCommands()) {
981  auto pos = m_user_dict.find(cmd);
982  if (pos != m_user_dict.end())
983  command_sp = pos->second;
984  }
985 
986  if (HasUserMultiwordCommands()) {
987  auto pos = m_user_mw_dict.find(cmd);
988  if (pos != m_user_mw_dict.end())
989  command_sp = pos->second;
990  }
991 
992  if (!exact && !command_sp) {
993  // We will only get into here if we didn't find any exact matches.
994 
995  CommandObjectSP user_match_sp, user_mw_match_sp, alias_match_sp,
996  real_match_sp;
997 
998  StringList local_matches;
999  if (matches == nullptr)
1000  matches = &local_matches;
1001 
1002  unsigned int num_cmd_matches = 0;
1003  unsigned int num_alias_matches = 0;
1004  unsigned int num_user_matches = 0;
1005  unsigned int num_user_mw_matches = 0;
1006 
1007  // Look through the command dictionaries one by one, and if we get only one
1008  // match from any of them in toto, then return that, otherwise return an
1009  // empty CommandObjectSP and the list of matches.
1010 
1011  if (HasCommands()) {
1012  num_cmd_matches = AddNamesMatchingPartialString(m_command_dict, cmd_str,
1013  *matches, descriptions);
1014  }
1015 
1016  if (num_cmd_matches == 1) {
1017  cmd.assign(matches->GetStringAtIndex(0));
1018  auto pos = m_command_dict.find(cmd);
1019  if (pos != m_command_dict.end())
1020  real_match_sp = pos->second;
1021  }
1022 
1023  if (include_aliases && HasAliases()) {
1024  num_alias_matches = AddNamesMatchingPartialString(m_alias_dict, cmd_str,
1025  *matches, descriptions);
1026  }
1027 
1028  if (num_alias_matches == 1) {
1029  cmd.assign(matches->GetStringAtIndex(num_cmd_matches));
1030  auto alias_pos = m_alias_dict.find(cmd);
1031  if (alias_pos != m_alias_dict.end())
1032  alias_match_sp = alias_pos->second;
1033  }
1034 
1035  if (HasUserCommands()) {
1036  num_user_matches = AddNamesMatchingPartialString(m_user_dict, cmd_str,
1037  *matches, descriptions);
1038  }
1039 
1040  if (num_user_matches == 1) {
1041  cmd.assign(
1042  matches->GetStringAtIndex(num_cmd_matches + num_alias_matches));
1043 
1044  auto pos = m_user_dict.find(cmd);
1045  if (pos != m_user_dict.end())
1046  user_match_sp = pos->second;
1047  }
1048 
1049  if (HasUserMultiwordCommands()) {
1050  num_user_mw_matches = AddNamesMatchingPartialString(
1051  m_user_mw_dict, cmd_str, *matches, descriptions);
1052  }
1053 
1054  if (num_user_mw_matches == 1) {
1055  cmd.assign(matches->GetStringAtIndex(num_cmd_matches + num_alias_matches +
1056  num_user_matches));
1057 
1058  auto pos = m_user_mw_dict.find(cmd);
1059  if (pos != m_user_mw_dict.end())
1060  user_mw_match_sp = pos->second;
1061  }
1062 
1063  // If we got exactly one match, return that, otherwise return the match
1064  // list.
1065 
1066  if (num_user_matches + num_user_mw_matches + num_cmd_matches +
1067  num_alias_matches ==
1068  1) {
1069  if (num_cmd_matches)
1070  return real_match_sp;
1071  else if (num_alias_matches)
1072  return alias_match_sp;
1073  else if (num_user_mw_matches)
1074  return user_mw_match_sp;
1075  else
1076  return user_match_sp;
1077  }
1078  } else if (matches && command_sp) {
1079  matches->AppendString(cmd_str);
1080  if (descriptions)
1081  descriptions->AppendString(command_sp->GetHelp());
1082  }
1083 
1084  return command_sp;
1085 }
1086 
1087 bool CommandInterpreter::AddCommand(llvm::StringRef name,
1088  const lldb::CommandObjectSP &cmd_sp,
1089  bool can_replace) {
1090  if (cmd_sp.get())
1091  lldbassert((this == &cmd_sp->GetCommandInterpreter()) &&
1092  "tried to add a CommandObject from a different interpreter");
1093 
1094  if (name.empty())
1095  return false;
1096 
1097  cmd_sp->SetIsUserCommand(false);
1098 
1099  std::string name_sstr(name);
1100  auto name_iter = m_command_dict.find(name_sstr);
1101  if (name_iter != m_command_dict.end()) {
1102  if (!can_replace || !name_iter->second->IsRemovable())
1103  return false;
1104  name_iter->second = cmd_sp;
1105  } else {
1106  m_command_dict[name_sstr] = cmd_sp;
1107  }
1108  return true;
1109 }
1110 
1111 Status CommandInterpreter::AddUserCommand(llvm::StringRef name,
1112  const lldb::CommandObjectSP &cmd_sp,
1113  bool can_replace) {
1114  Status result;
1115  if (cmd_sp.get())
1116  lldbassert((this == &cmd_sp->GetCommandInterpreter()) &&
1117  "tried to add a CommandObject from a different interpreter");
1118  if (name.empty()) {
1119  result.SetErrorString("can't use the empty string for a command name");
1120  return result;
1121  }
1122  // do not allow replacement of internal commands
1123  if (CommandExists(name)) {
1124  result.SetErrorString("can't replace builtin command");
1125  return result;
1126  }
1127 
1128  if (UserCommandExists(name)) {
1129  if (!can_replace) {
1130  result.SetErrorString("user command exists and force replace not set");
1131  return result;
1132  }
1133  if (cmd_sp->IsMultiwordObject()) {
1134  if (!m_user_mw_dict[std::string(name)]->IsRemovable()) {
1135  result.SetErrorString(
1136  "can't replace explicitly non-removable multi-word command");
1137  return result;
1138  }
1139  } else {
1140  if (!m_user_dict[std::string(name)]->IsRemovable()) {
1141  result.SetErrorString("can't replace explicitly non-removable command");
1142  return result;
1143  }
1144  }
1145  }
1146 
1147  cmd_sp->SetIsUserCommand(true);
1148 
1149  if (cmd_sp->IsMultiwordObject())
1150  m_user_mw_dict[std::string(name)] = cmd_sp;
1151  else
1152  m_user_dict[std::string(name)] = cmd_sp;
1153  return result;
1154 }
1155 
1156 CommandObjectSP
1157 CommandInterpreter::GetCommandSPExact(llvm::StringRef cmd_str,
1158  bool include_aliases) const {
1159  // Break up the command string into words, in case it's a multi-word command.
1160  Args cmd_words(cmd_str);
1161 
1162  if (cmd_str.empty())
1163  return {};
1164 
1165  if (cmd_words.GetArgumentCount() == 1)
1166  return GetCommandSP(cmd_str, include_aliases, true);
1167 
1168  // We have a multi-word command (seemingly), so we need to do more work.
1169  // First, get the cmd_obj_sp for the first word in the command.
1170  CommandObjectSP cmd_obj_sp =
1171  GetCommandSP(cmd_words.GetArgumentAtIndex(0), include_aliases, true);
1172  if (!cmd_obj_sp)
1173  return {};
1174 
1175  // Loop through the rest of the words in the command (everything passed in
1176  // was supposed to be part of a command name), and find the appropriate
1177  // sub-command SP for each command word....
1178  size_t end = cmd_words.GetArgumentCount();
1179  for (size_t i = 1; i < end; ++i) {
1180  if (!cmd_obj_sp->IsMultiwordObject()) {
1181  // We have more words in the command name, but we don't have a
1182  // multiword object. Fail and return.
1183  return {};
1184  }
1185 
1186  cmd_obj_sp = cmd_obj_sp->GetSubcommandSP(cmd_words.GetArgumentAtIndex(i));
1187  if (!cmd_obj_sp) {
1188  // The sub-command name was invalid. Fail and return.
1189  return {};
1190  }
1191  }
1192 
1193  // We successfully looped through all the command words and got valid
1194  // command objects for them.
1195  return cmd_obj_sp;
1196 }
1197 
1198 CommandObject *
1199 CommandInterpreter::GetCommandObject(llvm::StringRef cmd_str,
1200  StringList *matches,
1201  StringList *descriptions) const {
1202  CommandObject *command_obj =
1203  GetCommandSP(cmd_str, false, true, matches, descriptions).get();
1204 
1205  // If we didn't find an exact match to the command string in the commands,
1206  // look in the aliases.
1207 
1208  if (command_obj)
1209  return command_obj;
1210 
1211  command_obj = GetCommandSP(cmd_str, true, true, matches, descriptions).get();
1212 
1213  if (command_obj)
1214  return command_obj;
1215 
1216  // If there wasn't an exact match then look for an inexact one in just the
1217  // commands
1218  command_obj = GetCommandSP(cmd_str, false, false, nullptr).get();
1219 
1220  // Finally, if there wasn't an inexact match among the commands, look for an
1221  // inexact match in both the commands and aliases.
1222 
1223  if (command_obj) {
1224  if (matches)
1225  matches->AppendString(command_obj->GetCommandName());
1226  if (descriptions)
1227  descriptions->AppendString(command_obj->GetHelp());
1228  return command_obj;
1229  }
1230 
1231  return GetCommandSP(cmd_str, true, false, matches, descriptions).get();
1232 }
1233 
1235  llvm::StringRef cmd, StringList *matches, StringList *descriptions) const {
1236  std::string cmd_str(cmd);
1237  auto find_exact = [&](const CommandObject::CommandMap &map) {
1238  auto found_elem = map.find(std::string(cmd));
1239  if (found_elem == map.end())
1240  return (CommandObject *)nullptr;
1241  CommandObject *exact_cmd = found_elem->second.get();
1242  if (exact_cmd) {
1243  if (matches)
1244  matches->AppendString(exact_cmd->GetCommandName());
1245  if (descriptions)
1246  descriptions->AppendString(exact_cmd->GetHelp());
1247  return exact_cmd;
1248  }
1249  return (CommandObject *)nullptr;
1250  };
1251 
1252  CommandObject *exact_cmd = find_exact(GetUserCommands());
1253  if (exact_cmd)
1254  return exact_cmd;
1255 
1256  exact_cmd = find_exact(GetUserMultiwordCommands());
1257  if (exact_cmd)
1258  return exact_cmd;
1259 
1260  // We didn't have an exact command, so now look for partial matches.
1261  StringList tmp_list;
1262  StringList *matches_ptr = matches ? matches : &tmp_list;
1263  AddNamesMatchingPartialString(GetUserCommands(), cmd_str, *matches_ptr);
1265  cmd_str, *matches_ptr);
1266 
1267  return {};
1268 }
1269 
1270 bool CommandInterpreter::CommandExists(llvm::StringRef cmd) const {
1271  return m_command_dict.find(std::string(cmd)) != m_command_dict.end();
1272 }
1273 
1274 bool CommandInterpreter::GetAliasFullName(llvm::StringRef cmd,
1275  std::string &full_name) const {
1276  bool exact_match =
1277  (m_alias_dict.find(std::string(cmd)) != m_alias_dict.end());
1278  if (exact_match) {
1279  full_name.assign(std::string(cmd));
1280  return exact_match;
1281  } else {
1282  StringList matches;
1283  size_t num_alias_matches;
1284  num_alias_matches =
1286  if (num_alias_matches == 1) {
1287  // Make sure this isn't shadowing a command in the regular command space:
1288  StringList regular_matches;
1289  const bool include_aliases = false;
1290  const bool exact = false;
1291  CommandObjectSP cmd_obj_sp(
1292  GetCommandSP(cmd, include_aliases, exact, &regular_matches));
1293  if (cmd_obj_sp || regular_matches.GetSize() > 0)
1294  return false;
1295  else {
1296  full_name.assign(matches.GetStringAtIndex(0));
1297  return true;
1298  }
1299  } else
1300  return false;
1301  }
1302 }
1303 
1304 bool CommandInterpreter::AliasExists(llvm::StringRef cmd) const {
1305  return m_alias_dict.find(std::string(cmd)) != m_alias_dict.end();
1306 }
1307 
1308 bool CommandInterpreter::UserCommandExists(llvm::StringRef cmd) const {
1309  return m_user_dict.find(std::string(cmd)) != m_user_dict.end();
1310 }
1311 
1312 bool CommandInterpreter::UserMultiwordCommandExists(llvm::StringRef cmd) const {
1313  return m_user_mw_dict.find(std::string(cmd)) != m_user_mw_dict.end();
1314 }
1315 
1316 CommandAlias *
1317 CommandInterpreter::AddAlias(llvm::StringRef alias_name,
1318  lldb::CommandObjectSP &command_obj_sp,
1319  llvm::StringRef args_string) {
1320  if (command_obj_sp.get())
1321  lldbassert((this == &command_obj_sp->GetCommandInterpreter()) &&
1322  "tried to add a CommandObject from a different interpreter");
1323 
1324  std::unique_ptr<CommandAlias> command_alias_up(
1325  new CommandAlias(*this, command_obj_sp, args_string, alias_name));
1326 
1327  if (command_alias_up && command_alias_up->IsValid()) {
1328  m_alias_dict[std::string(alias_name)] =
1329  CommandObjectSP(command_alias_up.get());
1330  return command_alias_up.release();
1331  }
1332 
1333  return nullptr;
1334 }
1335 
1336 bool CommandInterpreter::RemoveAlias(llvm::StringRef alias_name) {
1337  auto pos = m_alias_dict.find(std::string(alias_name));
1338  if (pos != m_alias_dict.end()) {
1339  m_alias_dict.erase(pos);
1340  return true;
1341  }
1342  return false;
1343 }
1344 
1345 bool CommandInterpreter::RemoveCommand(llvm::StringRef cmd) {
1346  auto pos = m_command_dict.find(std::string(cmd));
1347  if (pos != m_command_dict.end()) {
1348  if (pos->second->IsRemovable()) {
1349  // Only regular expression objects or python commands are removable
1350  m_command_dict.erase(pos);
1351  return true;
1352  }
1353  }
1354  return false;
1355 }
1356 
1357 bool CommandInterpreter::RemoveUser(llvm::StringRef user_name) {
1358  CommandObject::CommandMap::iterator pos =
1359  m_user_dict.find(std::string(user_name));
1360  if (pos != m_user_dict.end()) {
1361  m_user_dict.erase(pos);
1362  return true;
1363  }
1364  return false;
1365 }
1366 
1367 bool CommandInterpreter::RemoveUserMultiword(llvm::StringRef multi_name) {
1368  CommandObject::CommandMap::iterator pos =
1369  m_user_mw_dict.find(std::string(multi_name));
1370  if (pos != m_user_mw_dict.end()) {
1371  m_user_mw_dict.erase(pos);
1372  return true;
1373  }
1374  return false;
1375 }
1376 
1378  uint32_t cmd_types) {
1379  llvm::StringRef help_prologue(GetDebugger().GetIOHandlerHelpPrologue());
1380  if (!help_prologue.empty()) {
1381  OutputFormattedHelpText(result.GetOutputStream(), llvm::StringRef(),
1382  help_prologue);
1383  }
1384 
1385  CommandObject::CommandMap::const_iterator pos;
1386  size_t max_len = FindLongestCommandWord(m_command_dict);
1387 
1388  if ((cmd_types & eCommandTypesBuiltin) == eCommandTypesBuiltin) {
1389  result.AppendMessage("Debugger commands:");
1390  result.AppendMessage("");
1391 
1392  for (pos = m_command_dict.begin(); pos != m_command_dict.end(); ++pos) {
1393  if (!(cmd_types & eCommandTypesHidden) &&
1394  (pos->first.compare(0, 1, "_") == 0))
1395  continue;
1396 
1397  OutputFormattedHelpText(result.GetOutputStream(), pos->first, "--",
1398  pos->second->GetHelp(), max_len);
1399  }
1400  result.AppendMessage("");
1401  }
1402 
1403  if (!m_alias_dict.empty() &&
1404  ((cmd_types & eCommandTypesAliases) == eCommandTypesAliases)) {
1405  result.AppendMessageWithFormat(
1406  "Current command abbreviations "
1407  "(type '%shelp command alias' for more info):\n",
1408  GetCommandPrefix());
1409  result.AppendMessage("");
1411 
1412  for (auto alias_pos = m_alias_dict.begin(); alias_pos != m_alias_dict.end();
1413  ++alias_pos) {
1414  OutputFormattedHelpText(result.GetOutputStream(), alias_pos->first, "--",
1415  alias_pos->second->GetHelp(), max_len);
1416  }
1417  result.AppendMessage("");
1418  }
1419 
1420  if (!m_user_dict.empty() &&
1421  ((cmd_types & eCommandTypesUserDef) == eCommandTypesUserDef)) {
1422  result.AppendMessage("Current user-defined commands:");
1423  result.AppendMessage("");
1425  for (pos = m_user_dict.begin(); pos != m_user_dict.end(); ++pos) {
1426  OutputFormattedHelpText(result.GetOutputStream(), pos->first, "--",
1427  pos->second->GetHelp(), max_len);
1428  }
1429  result.AppendMessage("");
1430  }
1431 
1432  if (!m_user_mw_dict.empty() &&
1433  ((cmd_types & eCommandTypesUserMW) == eCommandTypesUserMW)) {
1434  result.AppendMessage("Current user-defined container commands:");
1435  result.AppendMessage("");
1437  for (pos = m_user_dict.begin(); pos != m_user_mw_dict.end(); ++pos) {
1438  OutputFormattedHelpText(result.GetOutputStream(), pos->first, "--",
1439  pos->second->GetHelp(), max_len);
1440  }
1441  result.AppendMessage("");
1442  }
1443 
1444  result.AppendMessageWithFormat(
1445  "For more information on any command, type '%shelp <command-name>'.\n",
1446  GetCommandPrefix());
1447 }
1448 
1450  llvm::StringRef &command_string) {
1451  // This function finds the final, lowest-level, alias-resolved command object
1452  // whose 'Execute' function will eventually be invoked by the given command
1453  // line.
1454 
1455  CommandObject *cmd_obj = nullptr;
1456  size_t start = command_string.find_first_not_of(k_white_space);
1457  size_t end = 0;
1458  bool done = false;
1459  while (!done) {
1460  if (start != std::string::npos) {
1461  // Get the next word from command_string.
1462  end = command_string.find_first_of(k_white_space, start);
1463  if (end == std::string::npos)
1464  end = command_string.size();
1465  std::string cmd_word =
1466  std::string(command_string.substr(start, end - start));
1467 
1468  if (cmd_obj == nullptr)
1469  // Since cmd_obj is NULL we are on our first time through this loop.
1470  // Check to see if cmd_word is a valid command or alias.
1471  cmd_obj = GetCommandObject(cmd_word);
1472  else if (cmd_obj->IsMultiwordObject()) {
1473  // Our current object is a multi-word object; see if the cmd_word is a
1474  // valid sub-command for our object.
1475  CommandObject *sub_cmd_obj =
1476  cmd_obj->GetSubcommandObject(cmd_word.c_str());
1477  if (sub_cmd_obj)
1478  cmd_obj = sub_cmd_obj;
1479  else // cmd_word was not a valid sub-command word, so we are done
1480  done = true;
1481  } else
1482  // We have a cmd_obj and it is not a multi-word object, so we are done.
1483  done = true;
1484 
1485  // If we didn't find a valid command object, or our command object is not
1486  // a multi-word object, or we are at the end of the command_string, then
1487  // we are done. Otherwise, find the start of the next word.
1488 
1489  if (!cmd_obj || !cmd_obj->IsMultiwordObject() ||
1490  end >= command_string.size())
1491  done = true;
1492  else
1493  start = command_string.find_first_not_of(k_white_space, end);
1494  } else
1495  // Unable to find any more words.
1496  done = true;
1497  }
1498 
1499  command_string = command_string.substr(end);
1500  return cmd_obj;
1501 }
1502 
1503 static const char *k_valid_command_chars =
1504  "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_";
1505 static void StripLeadingSpaces(std::string &s) {
1506  if (!s.empty()) {
1507  size_t pos = s.find_first_not_of(k_white_space);
1508  if (pos == std::string::npos)
1509  s.clear();
1510  else if (pos == 0)
1511  return;
1512  s.erase(0, pos);
1513  }
1514 }
1515 
1516 static size_t FindArgumentTerminator(const std::string &s) {
1517  const size_t s_len = s.size();
1518  size_t offset = 0;
1519  while (offset < s_len) {
1520  size_t pos = s.find("--", offset);
1521  if (pos == std::string::npos)
1522  break;
1523  if (pos > 0) {
1524  if (llvm::isSpace(s[pos - 1])) {
1525  // Check if the string ends "\s--" (where \s is a space character) or
1526  // if we have "\s--\s".
1527  if ((pos + 2 >= s_len) || llvm::isSpace(s[pos + 2])) {
1528  return pos;
1529  }
1530  }
1531  }
1532  offset = pos + 2;
1533  }
1534  return std::string::npos;
1535 }
1536 
1537 static bool ExtractCommand(std::string &command_string, std::string &command,
1538  std::string &suffix, char &quote_char) {
1539  command.clear();
1540  suffix.clear();
1541  StripLeadingSpaces(command_string);
1542 
1543  bool result = false;
1544  quote_char = '\0';
1545 
1546  if (!command_string.empty()) {
1547  const char first_char = command_string[0];
1548  if (first_char == '\'' || first_char == '"') {
1549  quote_char = first_char;
1550  const size_t end_quote_pos = command_string.find(quote_char, 1);
1551  if (end_quote_pos == std::string::npos) {
1552  command.swap(command_string);
1553  command_string.erase();
1554  } else {
1555  command.assign(command_string, 1, end_quote_pos - 1);
1556  if (end_quote_pos + 1 < command_string.size())
1557  command_string.erase(0, command_string.find_first_not_of(
1558  k_white_space, end_quote_pos + 1));
1559  else
1560  command_string.erase();
1561  }
1562  } else {
1563  const size_t first_space_pos =
1564  command_string.find_first_of(k_white_space);
1565  if (first_space_pos == std::string::npos) {
1566  command.swap(command_string);
1567  command_string.erase();
1568  } else {
1569  command.assign(command_string, 0, first_space_pos);
1570  command_string.erase(0, command_string.find_first_not_of(
1571  k_white_space, first_space_pos));
1572  }
1573  }
1574  result = true;
1575  }
1576 
1577  if (!command.empty()) {
1578  // actual commands can't start with '-' or '_'
1579  if (command[0] != '-' && command[0] != '_') {
1580  size_t pos = command.find_first_not_of(k_valid_command_chars);
1581  if (pos > 0 && pos != std::string::npos) {
1582  suffix.assign(command.begin() + pos, command.end());
1583  command.erase(pos);
1584  }
1585  }
1586  }
1587 
1588  return result;
1589 }
1590 
1592  llvm::StringRef alias_name, std::string &raw_input_string,
1593  std::string &alias_result, CommandReturnObject &result) {
1594  CommandObject *alias_cmd_obj = nullptr;
1595  Args cmd_args(raw_input_string);
1596  alias_cmd_obj = GetCommandObject(alias_name);
1597  StreamString result_str;
1598 
1599  if (!alias_cmd_obj || !alias_cmd_obj->IsAlias()) {
1600  alias_result.clear();
1601  return alias_cmd_obj;
1602  }
1603  std::pair<CommandObjectSP, OptionArgVectorSP> desugared =
1604  ((CommandAlias *)alias_cmd_obj)->Desugar();
1605  OptionArgVectorSP option_arg_vector_sp = desugared.second;
1606  alias_cmd_obj = desugared.first.get();
1607  std::string alias_name_str = std::string(alias_name);
1608  if ((cmd_args.GetArgumentCount() == 0) ||
1609  (alias_name_str != cmd_args.GetArgumentAtIndex(0)))
1610  cmd_args.Unshift(alias_name_str);
1611 
1612  result_str.Printf("%s", alias_cmd_obj->GetCommandName().str().c_str());
1613 
1614  if (!option_arg_vector_sp.get()) {
1615  alias_result = std::string(result_str.GetString());
1616  return alias_cmd_obj;
1617  }
1618  OptionArgVector *option_arg_vector = option_arg_vector_sp.get();
1619 
1620  int value_type;
1621  std::string option;
1622  std::string value;
1623  for (const auto &entry : *option_arg_vector) {
1624  std::tie(option, value_type, value) = entry;
1625  if (option == "<argument>") {
1626  result_str.Printf(" %s", value.c_str());
1627  continue;
1628  }
1629 
1630  result_str.Printf(" %s", option.c_str());
1631  if (value_type == OptionParser::eNoArgument)
1632  continue;
1633 
1634  if (value_type != OptionParser::eOptionalArgument)
1635  result_str.Printf(" ");
1636  int index = GetOptionArgumentPosition(value.c_str());
1637  if (index == 0)
1638  result_str.Printf("%s", value.c_str());
1639  else if (static_cast<size_t>(index) >= cmd_args.GetArgumentCount()) {
1640 
1641  result.AppendErrorWithFormat("Not enough arguments provided; you "
1642  "need at least %d arguments to use "
1643  "this alias.\n",
1644  index);
1645  return nullptr;
1646  } else {
1647  size_t strpos = raw_input_string.find(cmd_args.GetArgumentAtIndex(index));
1648  if (strpos != std::string::npos)
1649  raw_input_string = raw_input_string.erase(
1650  strpos, strlen(cmd_args.GetArgumentAtIndex(index)));
1651  result_str.Printf("%s", cmd_args.GetArgumentAtIndex(index));
1652  }
1653  }
1654 
1655  alias_result = std::string(result_str.GetString());
1656  return alias_cmd_obj;
1657 }
1658 
1660  // The command preprocessor needs to do things to the command line before any
1661  // parsing of arguments or anything else is done. The only current stuff that
1662  // gets preprocessed is anything enclosed in backtick ('`') characters is
1663  // evaluated as an expression and the result of the expression must be a
1664  // scalar that can be substituted into the command. An example would be:
1665  // (lldb) memory read `$rsp + 20`
1666  Status error; // Status for any expressions that might not evaluate
1667  size_t start_backtick;
1668  size_t pos = 0;
1669  while ((start_backtick = command.find('`', pos)) != std::string::npos) {
1670  // Stop if an error was encountered during the previous iteration.
1671  if (error.Fail())
1672  break;
1673 
1674  if (start_backtick > 0 && command[start_backtick - 1] == '\\') {
1675  // The backtick was preceded by a '\' character, remove the slash and
1676  // don't treat the backtick as the start of an expression.
1677  command.erase(start_backtick - 1, 1);
1678  // No need to add one to start_backtick since we just deleted a char.
1679  pos = start_backtick;
1680  continue;
1681  }
1682 
1683  const size_t expr_content_start = start_backtick + 1;
1684  const size_t end_backtick = command.find('`', expr_content_start);
1685 
1686  if (end_backtick == std::string::npos) {
1687  // Stop if there's no end backtick.
1688  break;
1689  }
1690 
1691  if (end_backtick == expr_content_start) {
1692  // Skip over empty expression. (two backticks in a row)
1693  command.erase(start_backtick, 2);
1694  continue;
1695  }
1696 
1697  std::string expr_str(command, expr_content_start,
1698  end_backtick - expr_content_start);
1699 
1701 
1702  // Get a dummy target to allow for calculator mode while processing
1703  // backticks. This also helps break the infinite loop caused when target is
1704  // null.
1705  Target *exe_target = exe_ctx.GetTargetPtr();
1706  Target &target = exe_target ? *exe_target : m_debugger.GetDummyTarget();
1707 
1708  ValueObjectSP expr_result_valobj_sp;
1709 
1710  EvaluateExpressionOptions options;
1711  options.SetCoerceToId(false);
1712  options.SetUnwindOnError(true);
1713  options.SetIgnoreBreakpoints(true);
1714  options.SetKeepInMemory(false);
1715  options.SetTryAllThreads(true);
1716  options.SetTimeout(llvm::None);
1717 
1718  ExpressionResults expr_result =
1719  target.EvaluateExpression(expr_str.c_str(), exe_ctx.GetFramePtr(),
1720  expr_result_valobj_sp, options);
1721 
1722  if (expr_result == eExpressionCompleted) {
1723  Scalar scalar;
1724  if (expr_result_valobj_sp)
1725  expr_result_valobj_sp =
1726  expr_result_valobj_sp->GetQualifiedRepresentationIfAvailable(
1727  expr_result_valobj_sp->GetDynamicValueType(), true);
1728  if (expr_result_valobj_sp->ResolveValue(scalar)) {
1729  command.erase(start_backtick, end_backtick - start_backtick + 1);
1730  StreamString value_strm;
1731  const bool show_type = false;
1732  scalar.GetValue(&value_strm, show_type);
1733  size_t value_string_size = value_strm.GetSize();
1734  if (value_string_size) {
1735  command.insert(start_backtick, std::string(value_strm.GetString()));
1736  pos = start_backtick + value_string_size;
1737  continue;
1738  } else {
1739  error.SetErrorStringWithFormat("expression value didn't result "
1740  "in a scalar value for the "
1741  "expression '%s'",
1742  expr_str.c_str());
1743  break;
1744  }
1745  } else {
1746  error.SetErrorStringWithFormat("expression value didn't result "
1747  "in a scalar value for the "
1748  "expression '%s'",
1749  expr_str.c_str());
1750  break;
1751  }
1752 
1753  continue;
1754  }
1755 
1756  if (expr_result_valobj_sp)
1757  error = expr_result_valobj_sp->GetError();
1758 
1759  if (error.Success()) {
1760  switch (expr_result) {
1761  case eExpressionSetupError:
1762  error.SetErrorStringWithFormat(
1763  "expression setup error for the expression '%s'", expr_str.c_str());
1764  break;
1765  case eExpressionParseError:
1766  error.SetErrorStringWithFormat(
1767  "expression parse error for the expression '%s'", expr_str.c_str());
1768  break;
1770  error.SetErrorStringWithFormat(
1771  "expression error fetching result for the expression '%s'",
1772  expr_str.c_str());
1773  break;
1774  case eExpressionCompleted:
1775  break;
1776  case eExpressionDiscarded:
1777  error.SetErrorStringWithFormat(
1778  "expression discarded for the expression '%s'", expr_str.c_str());
1779  break;
1781  error.SetErrorStringWithFormat(
1782  "expression interrupted for the expression '%s'", expr_str.c_str());
1783  break;
1785  error.SetErrorStringWithFormat(
1786  "expression hit breakpoint for the expression '%s'",
1787  expr_str.c_str());
1788  break;
1789  case eExpressionTimedOut:
1790  error.SetErrorStringWithFormat(
1791  "expression timed out for the expression '%s'", expr_str.c_str());
1792  break;
1794  error.SetErrorStringWithFormat("expression stop at entry point "
1795  "for debugging for the "
1796  "expression '%s'",
1797  expr_str.c_str());
1798  break;
1800  error.SetErrorStringWithFormat(
1801  "expression thread vanished for the expression '%s'",
1802  expr_str.c_str());
1803  break;
1804  }
1805  }
1806  }
1807  return error;
1808 }
1809 
1810 bool CommandInterpreter::HandleCommand(const char *command_line,
1811  LazyBool lazy_add_to_history,
1812  const ExecutionContext &override_context,
1813  CommandReturnObject &result) {
1814 
1815  OverrideExecutionContext(override_context);
1816  bool status = HandleCommand(command_line, lazy_add_to_history, result);
1818  return status;
1819 }
1820 
1821 bool CommandInterpreter::HandleCommand(const char *command_line,
1822  LazyBool lazy_add_to_history,
1823  CommandReturnObject &result) {
1824 
1825  std::string command_string(command_line);
1826  std::string original_command_string(command_line);
1827 
1829  llvm::PrettyStackTraceFormat stack_trace("HandleCommand(command = \"%s\")",
1830  command_line);
1831 
1832  LLDB_LOGF(log, "Processing command: %s", command_line);
1833  LLDB_SCOPED_TIMERF("Processing command: %s.", command_line);
1834 
1835  if (WasInterrupted()) {
1836  result.AppendError("interrupted");
1837  return false;
1838  }
1839 
1840  bool add_to_history;
1841  if (lazy_add_to_history == eLazyBoolCalculate)
1842  add_to_history = (m_command_source_depth == 0);
1843  else
1844  add_to_history = (lazy_add_to_history == eLazyBoolYes);
1845 
1846  m_transcript_stream << "(lldb) " << command_line << '\n';
1847 
1848  bool empty_command = false;
1849  bool comment_command = false;
1850  if (command_string.empty())
1851  empty_command = true;
1852  else {
1853  const char *k_space_characters = "\t\n\v\f\r ";
1854 
1855  size_t non_space = command_string.find_first_not_of(k_space_characters);
1856  // Check for empty line or comment line (lines whose first non-space
1857  // character is the comment character for this interpreter)
1858  if (non_space == std::string::npos)
1859  empty_command = true;
1860  else if (command_string[non_space] == m_comment_char)
1861  comment_command = true;
1862  else if (command_string[non_space] == CommandHistory::g_repeat_char) {
1863  llvm::StringRef search_str(command_string);
1864  search_str = search_str.drop_front(non_space);
1865  if (auto hist_str = m_command_history.FindString(search_str)) {
1866  add_to_history = false;
1867  command_string = std::string(*hist_str);
1868  original_command_string = std::string(*hist_str);
1869  } else {
1870  result.AppendErrorWithFormat("Could not find entry: %s in history",
1871  command_string.c_str());
1872  return false;
1873  }
1874  }
1875  }
1876 
1877  if (empty_command) {
1878  if (!GetRepeatPreviousCommand()) {
1880  return true;
1881  }
1882 
1883  if (m_command_history.IsEmpty()) {
1884  result.AppendError("empty command");
1885  return false;
1886  }
1887 
1888  command_line = m_repeat_command.c_str();
1889  command_string = command_line;
1890  original_command_string = command_line;
1891  if (m_repeat_command.empty()) {
1892  result.AppendError("No auto repeat.");
1893  return false;
1894  }
1895 
1896  add_to_history = false;
1897  } else if (comment_command) {
1899  return true;
1900  }
1901 
1902  Status error(PreprocessCommand(command_string));
1903 
1904  if (error.Fail()) {
1905  result.AppendError(error.AsCString());
1906  return false;
1907  }
1908 
1909  // Phase 1.
1910 
1911  // Before we do ANY kind of argument processing, we need to figure out what
1912  // the real/final command object is for the specified command. This gets
1913  // complicated by the fact that the user could have specified an alias, and,
1914  // in translating the alias, there may also be command options and/or even
1915  // data (including raw text strings) that need to be found and inserted into
1916  // the command line as part of the translation. So this first step is plain
1917  // look-up and replacement, resulting in:
1918  // 1. the command object whose Execute method will actually be called
1919  // 2. a revised command string, with all substitutions and replacements
1920  // taken care of
1921  // From 1 above, we can determine whether the Execute function wants raw
1922  // input or not.
1923 
1924  CommandObject *cmd_obj = ResolveCommandImpl(command_string, result);
1925 
1926  // Although the user may have abbreviated the command, the command_string now
1927  // has the command expanded to the full name. For example, if the input was
1928  // "br s -n main", command_string is now "breakpoint set -n main".
1929  if (log) {
1930  llvm::StringRef command_name = cmd_obj ? cmd_obj->GetCommandName() : "<not found>";
1931  LLDB_LOGF(log, "HandleCommand, cmd_obj : '%s'", command_name.str().c_str());
1932  LLDB_LOGF(log, "HandleCommand, (revised) command_string: '%s'",
1933  command_string.c_str());
1934  const bool wants_raw_input =
1935  (cmd_obj != nullptr) ? cmd_obj->WantsRawCommandString() : false;
1936  LLDB_LOGF(log, "HandleCommand, wants_raw_input:'%s'",
1937  wants_raw_input ? "True" : "False");
1938  }
1939 
1940  // Phase 2.
1941  // Take care of things like setting up the history command & calling the
1942  // appropriate Execute method on the CommandObject, with the appropriate
1943  // arguments.
1944 
1945  if (cmd_obj != nullptr) {
1946  if (add_to_history) {
1947  Args command_args(command_string);
1948  const char *repeat_command = cmd_obj->GetRepeatCommand(command_args, 0);
1949  if (repeat_command != nullptr)
1950  m_repeat_command.assign(repeat_command);
1951  else
1952  m_repeat_command.assign(original_command_string);
1953 
1954  m_command_history.AppendString(original_command_string);
1955  }
1956 
1957  std::string remainder;
1958  const std::size_t actual_cmd_name_len = cmd_obj->GetCommandName().size();
1959  if (actual_cmd_name_len < command_string.length())
1960  remainder = command_string.substr(actual_cmd_name_len);
1961 
1962  // Remove any initial spaces
1963  size_t pos = remainder.find_first_not_of(k_white_space);
1964  if (pos != 0 && pos != std::string::npos)
1965  remainder.erase(0, pos);
1966 
1967  LLDB_LOGF(
1968  log, "HandleCommand, command line after removing command name(s): '%s'",
1969  remainder.c_str());
1970 
1971  cmd_obj->Execute(remainder.c_str(), result);
1972  }
1973 
1974  LLDB_LOGF(log, "HandleCommand, command %s",
1975  (result.Succeeded() ? "succeeded" : "did not succeed"));
1976 
1977  m_transcript_stream << result.GetOutputData();
1978  m_transcript_stream << result.GetErrorData();
1979 
1980  return result.Succeeded();
1981 }
1982 
1984  bool look_for_subcommand = false;
1985 
1986  // For any of the command completions a unique match will be a complete word.
1987 
1988  if (request.GetParsedLine().GetArgumentCount() == 0) {
1989  // We got nothing on the command line, so return the list of commands
1990  bool include_aliases = true;
1991  StringList new_matches, descriptions;
1992  GetCommandNamesMatchingPartialString("", include_aliases, new_matches,
1993  descriptions);
1994  request.AddCompletions(new_matches, descriptions);
1995  } else if (request.GetCursorIndex() == 0) {
1996  // The cursor is in the first argument, so just do a lookup in the
1997  // dictionary.
1998  StringList new_matches, new_descriptions;
1999  CommandObject *cmd_obj =
2001  &new_matches, &new_descriptions);
2002 
2003  if (new_matches.GetSize() && cmd_obj && cmd_obj->IsMultiwordObject() &&
2004  new_matches.GetStringAtIndex(0) != nullptr &&
2005  strcmp(request.GetParsedLine().GetArgumentAtIndex(0),
2006  new_matches.GetStringAtIndex(0)) == 0) {
2007  if (request.GetParsedLine().GetArgumentCount() != 1) {
2008  look_for_subcommand = true;
2009  new_matches.DeleteStringAtIndex(0);
2010  new_descriptions.DeleteStringAtIndex(0);
2011  request.AppendEmptyArgument();
2012  }
2013  }
2014  request.AddCompletions(new_matches, new_descriptions);
2015  }
2016 
2017  if (request.GetCursorIndex() > 0 || look_for_subcommand) {
2018  // We are completing further on into a commands arguments, so find the
2019  // command and tell it to complete the command. First see if there is a
2020  // matching initial command:
2021  CommandObject *command_object =
2023  if (command_object) {
2024  request.ShiftArguments();
2025  command_object->HandleCompletion(request);
2026  }
2027  }
2028 }
2029 
2031 
2032  // Don't complete comments, and if the line we are completing is just the
2033  // history repeat character, substitute the appropriate history line.
2034  llvm::StringRef first_arg = request.GetParsedLine().GetArgumentAtIndex(0);
2035 
2036  if (!first_arg.empty()) {
2037  if (first_arg.front() == m_comment_char)
2038  return;
2039  if (first_arg.front() == CommandHistory::g_repeat_char) {
2040  if (auto hist_str = m_command_history.FindString(first_arg))
2041  request.AddCompletion(*hist_str, "Previous command history event",
2043  return;
2044  }
2045  }
2046 
2047  HandleCompletionMatches(request);
2048 }
2049 
2050 llvm::Optional<std::string>
2052  if (line.empty())
2053  return llvm::None;
2054  const size_t s = m_command_history.GetSize();
2055  for (int i = s - 1; i >= 0; --i) {
2056  llvm::StringRef entry = m_command_history.GetStringAtIndex(i);
2057  if (entry.consume_front(line))
2058  return entry.str();
2059  }
2060  return llvm::None;
2061 }
2062 
2063 void CommandInterpreter::UpdatePrompt(llvm::StringRef new_prompt) {
2064  EventSP prompt_change_event_sp(
2065  new Event(eBroadcastBitResetPrompt, new EventDataBytes(new_prompt)));
2066  ;
2067  BroadcastEvent(prompt_change_event_sp);
2069  m_command_io_handler_sp->SetPrompt(new_prompt);
2070 }
2071 
2072 bool CommandInterpreter::Confirm(llvm::StringRef message, bool default_answer) {
2073  // Check AutoConfirm first:
2074  if (m_debugger.GetAutoConfirm())
2075  return default_answer;
2076 
2077  IOHandlerConfirm *confirm =
2078  new IOHandlerConfirm(m_debugger, message, default_answer);
2079  IOHandlerSP io_handler_sp(confirm);
2080  m_debugger.RunIOHandlerSync(io_handler_sp);
2081  return confirm->GetResponse();
2082 }
2083 
2084 const CommandAlias *
2085 CommandInterpreter::GetAlias(llvm::StringRef alias_name) const {
2086  OptionArgVectorSP ret_val;
2087 
2088  auto pos = m_alias_dict.find(std::string(alias_name));
2089  if (pos != m_alias_dict.end())
2090  return (CommandAlias *)pos->second.get();
2091 
2092  return nullptr;
2093 }
2094 
2095 bool CommandInterpreter::HasCommands() const { return (!m_command_dict.empty()); }
2096 
2097 bool CommandInterpreter::HasAliases() const { return (!m_alias_dict.empty()); }
2098 
2099 bool CommandInterpreter::HasUserCommands() const { return (!m_user_dict.empty()); }
2100 
2102  return (!m_user_mw_dict.empty());
2103 }
2104 
2105 bool CommandInterpreter::HasAliasOptions() const { return HasAliases(); }
2106 
2108  const char *alias_name,
2109  Args &cmd_args,
2110  std::string &raw_input_string,
2111  CommandReturnObject &result) {
2112  OptionArgVectorSP option_arg_vector_sp =
2113  GetAlias(alias_name)->GetOptionArguments();
2114 
2115  bool wants_raw_input = alias_cmd_obj->WantsRawCommandString();
2116 
2117  // Make sure that the alias name is the 0th element in cmd_args
2118  std::string alias_name_str = alias_name;
2119  if (alias_name_str != cmd_args.GetArgumentAtIndex(0))
2120  cmd_args.Unshift(alias_name_str);
2121 
2122  Args new_args(alias_cmd_obj->GetCommandName());
2123  if (new_args.GetArgumentCount() == 2)
2124  new_args.Shift();
2125 
2126  if (option_arg_vector_sp.get()) {
2127  if (wants_raw_input) {
2128  // We have a command that both has command options and takes raw input.
2129  // Make *sure* it has a " -- " in the right place in the
2130  // raw_input_string.
2131  size_t pos = raw_input_string.find(" -- ");
2132  if (pos == std::string::npos) {
2133  // None found; assume it goes at the beginning of the raw input string
2134  raw_input_string.insert(0, " -- ");
2135  }
2136  }
2137 
2138  OptionArgVector *option_arg_vector = option_arg_vector_sp.get();
2139  const size_t old_size = cmd_args.GetArgumentCount();
2140  std::vector<bool> used(old_size + 1, false);
2141 
2142  used[0] = true;
2143 
2144  int value_type;
2145  std::string option;
2146  std::string value;
2147  for (const auto &option_entry : *option_arg_vector) {
2148  std::tie(option, value_type, value) = option_entry;
2149  if (option == "<argument>") {
2150  if (!wants_raw_input || (value != "--")) {
2151  // Since we inserted this above, make sure we don't insert it twice
2152  new_args.AppendArgument(value);
2153  }
2154  continue;
2155  }
2156 
2157  if (value_type != OptionParser::eOptionalArgument)
2158  new_args.AppendArgument(option);
2159 
2160  if (value == "<no-argument>")
2161  continue;
2162 
2163  int index = GetOptionArgumentPosition(value.c_str());
2164  if (index == 0) {
2165  // value was NOT a positional argument; must be a real value
2166  if (value_type != OptionParser::eOptionalArgument)
2167  new_args.AppendArgument(value);
2168  else {
2169  new_args.AppendArgument(option + value);
2170  }
2171 
2172  } else if (static_cast<size_t>(index) >= cmd_args.GetArgumentCount()) {
2173  result.AppendErrorWithFormat("Not enough arguments provided; you "
2174  "need at least %d arguments to use "
2175  "this alias.\n",
2176  index);
2177  return;
2178  } else {
2179  // Find and remove cmd_args.GetArgumentAtIndex(i) from raw_input_string
2180  size_t strpos =
2181  raw_input_string.find(cmd_args.GetArgumentAtIndex(index));
2182  if (strpos != std::string::npos) {
2183  raw_input_string = raw_input_string.erase(
2184  strpos, strlen(cmd_args.GetArgumentAtIndex(index)));
2185  }
2186 
2187  if (value_type != OptionParser::eOptionalArgument)
2188  new_args.AppendArgument(cmd_args.GetArgumentAtIndex(index));
2189  else {
2190  new_args.AppendArgument(option + cmd_args.GetArgumentAtIndex(index));
2191  }
2192  used[index] = true;
2193  }
2194  }
2195 
2196  for (auto entry : llvm::enumerate(cmd_args.entries())) {
2197  if (!used[entry.index()] && !wants_raw_input)
2198  new_args.AppendArgument(entry.value().ref());
2199  }
2200 
2201  cmd_args.Clear();
2202  cmd_args.SetArguments(new_args.GetArgumentCount(),
2203  new_args.GetConstArgumentVector());
2204  } else {
2206  // This alias was not created with any options; nothing further needs to be
2207  // done, unless it is a command that wants raw input, in which case we need
2208  // to clear the rest of the data from cmd_args, since its in the raw input
2209  // string.
2210  if (wants_raw_input) {
2211  cmd_args.Clear();
2212  cmd_args.SetArguments(new_args.GetArgumentCount(),
2213  new_args.GetConstArgumentVector());
2214  }
2215  return;
2216  }
2217 
2219  return;
2220 }
2221 
2222 int CommandInterpreter::GetOptionArgumentPosition(const char *in_string) {
2223  int position = 0; // Any string that isn't an argument position, i.e. '%'
2224  // followed by an integer, gets a position
2225  // of zero.
2226 
2227  const char *cptr = in_string;
2228 
2229  // Does it start with '%'
2230  if (cptr[0] == '%') {
2231  ++cptr;
2232 
2233  // Is the rest of it entirely digits?
2234  if (isdigit(cptr[0])) {
2235  const char *start = cptr;
2236  while (isdigit(cptr[0]))
2237  ++cptr;
2238 
2239  // We've gotten to the end of the digits; are we at the end of the
2240  // string?
2241  if (cptr[0] == '\0')
2242  position = atoi(start);
2243  }
2244  }
2245 
2246  return position;
2247 }
2248 
2249 static void GetHomeInitFile(llvm::SmallVectorImpl<char> &init_file,
2250  llvm::StringRef suffix = {}) {
2251  std::string init_file_name = ".lldbinit";
2252  if (!suffix.empty()) {
2253  init_file_name.append("-");
2254  init_file_name.append(suffix.str());
2255  }
2256 
2258  llvm::sys::path::append(init_file, init_file_name);
2259 
2260  FileSystem::Instance().Resolve(init_file);
2261 }
2262 
2263 static void GetHomeREPLInitFile(llvm::SmallVectorImpl<char> &init_file) {
2266  if (auto main_repl_language = repl_languages.GetSingularLanguage())
2267  language = *main_repl_language;
2268  else
2269  return;
2270 
2271  std::string init_file_name =
2272  (llvm::Twine(".lldbinit-") +
2273  llvm::Twine(Language::GetNameForLanguageType(language)) +
2274  llvm::Twine("-repl"))
2275  .str();
2277  llvm::sys::path::append(init_file, init_file_name);
2278  FileSystem::Instance().Resolve(init_file);
2279 }
2280 
2281 static void GetCwdInitFile(llvm::SmallVectorImpl<char> &init_file) {
2282  llvm::StringRef s = ".lldbinit";
2283  init_file.assign(s.begin(), s.end());
2284  FileSystem::Instance().Resolve(init_file);
2285 }
2286 
2288  CommandReturnObject &result) {
2289  assert(!m_skip_lldbinit_files);
2290 
2291  if (!FileSystem::Instance().Exists(file)) {
2293  return;
2294  }
2295 
2296  // Use HandleCommand to 'source' the given file; this will do the actual
2297  // broadcasting of the commands back to any appropriate listener (see
2298  // CommandObjectSource::Execute for more details).
2299  const bool saved_batch = SetBatchCommandMode(true);
2301  options.SetSilent(true);
2302  options.SetPrintErrors(true);
2303  options.SetStopOnError(false);
2304  options.SetStopOnContinue(true);
2305  HandleCommandsFromFile(file, options, result);
2306  SetBatchCommandMode(saved_batch);
2307 }
2308 
2310  if (m_skip_lldbinit_files) {
2312  return;
2313  }
2314 
2315  llvm::SmallString<128> init_file;
2316  GetCwdInitFile(init_file);
2317  if (!FileSystem::Instance().Exists(init_file)) {
2319  return;
2320  }
2321 
2322  LoadCWDlldbinitFile should_load =
2324 
2325  switch (should_load) {
2326  case eLoadCWDlldbinitFalse:
2328  break;
2329  case eLoadCWDlldbinitTrue:
2330  SourceInitFile(FileSpec(init_file.str()), result);
2331  break;
2332  case eLoadCWDlldbinitWarn: {
2333  llvm::SmallString<128> home_init_file;
2334  GetHomeInitFile(home_init_file);
2335  if (llvm::sys::path::parent_path(init_file) ==
2336  llvm::sys::path::parent_path(home_init_file)) {
2338  } else {
2339  result.AppendError(InitFileWarning);
2340  }
2341  }
2342  }
2343 }
2344 
2345 /// We will first see if there is an application specific ".lldbinit" file
2346 /// whose name is "~/.lldbinit" followed by a "-" and the name of the program.
2347 /// If this file doesn't exist, we fall back to the REPL init file or the
2348 /// default home init file in "~/.lldbinit".
2350  bool is_repl) {
2351  if (m_skip_lldbinit_files) {
2353  return;
2354  }
2355 
2356  llvm::SmallString<128> init_file;
2357 
2358  if (is_repl)
2359  GetHomeREPLInitFile(init_file);
2360 
2361  if (init_file.empty())
2362  GetHomeInitFile(init_file);
2363 
2364  if (!m_skip_app_init_files) {
2365  llvm::StringRef program_name =
2366  HostInfo::GetProgramFileSpec().GetFilename().GetStringRef();
2367  llvm::SmallString<128> program_init_file;
2368  GetHomeInitFile(program_init_file, program_name);
2369  if (FileSystem::Instance().Exists(program_init_file))
2370  init_file = program_init_file;
2371  }
2372 
2373  SourceInitFile(FileSpec(init_file.str()), result);
2374 }
2375 
2377  const char *prefix = GetDebugger().GetIOHandlerCommandPrefix();
2378  return prefix == nullptr ? "" : prefix;
2379 }
2380 
2381 PlatformSP CommandInterpreter::GetPlatform(bool prefer_target_platform) {
2382  PlatformSP platform_sp;
2383  if (prefer_target_platform) {
2385  Target *target = exe_ctx.GetTargetPtr();
2386  if (target)
2387  platform_sp = target->GetPlatform();
2388  }
2389 
2390  if (!platform_sp)
2392  return platform_sp;
2393 }
2394 
2396  auto exe_ctx = GetExecutionContext();
2397  TargetSP target_sp = exe_ctx.GetTargetSP();
2398  if (!target_sp)
2399  return false;
2400 
2401  ProcessSP process_sp(target_sp->GetProcessSP());
2402  if (!process_sp)
2403  return false;
2404 
2405  if (eStateStopped != process_sp->GetState())
2406  return false;
2407 
2408  for (const auto &thread_sp : process_sp->GetThreadList().Threads()) {
2409  StopInfoSP stop_info = thread_sp->GetStopInfo();
2410  if (!stop_info)
2411  return false;
2412 
2413  const StopReason reason = stop_info->GetStopReason();
2414  if (reason == eStopReasonException ||
2415  reason == eStopReasonInstrumentation ||
2416  reason == eStopReasonProcessorTrace)
2417  return true;
2418 
2419  if (reason == eStopReasonSignal) {
2420  const auto stop_signal = static_cast<int32_t>(stop_info->GetValue());
2421  UnixSignalsSP signals_sp = process_sp->GetUnixSignals();
2422  if (!signals_sp || !signals_sp->SignalIsValid(stop_signal))
2423  // The signal is unknown, treat it as abnormal.
2424  return true;
2425 
2426  const auto sigint_num = signals_sp->GetSignalNumberFromName("SIGINT");
2427  const auto sigstop_num = signals_sp->GetSignalNumberFromName("SIGSTOP");
2428  if ((stop_signal != sigint_num) && (stop_signal != sigstop_num))
2429  // The signal very likely implies a crash.
2430  return true;
2431  }
2432  }
2433 
2434  return false;
2435 }
2436 
2437 void
2439  const ExecutionContext &override_context,
2440  const CommandInterpreterRunOptions &options,
2441  CommandReturnObject &result) {
2442 
2443  OverrideExecutionContext(override_context);
2444  HandleCommands(commands, options, result);
2446 }
2447 
2448 void CommandInterpreter::HandleCommands(const StringList &commands,
2449  const CommandInterpreterRunOptions &options,
2450  CommandReturnObject &result) {
2451  size_t num_lines = commands.GetSize();
2452 
2453  // If we are going to continue past a "continue" then we need to run the
2454  // commands synchronously. Make sure you reset this value anywhere you return
2455  // from the function.
2456 
2457  bool old_async_execution = m_debugger.GetAsyncExecution();
2458 
2459  if (!options.GetStopOnContinue()) {
2461  }
2462 
2463  for (size_t idx = 0; idx < num_lines && !WasInterrupted(); idx++) {
2464  const char *cmd = commands.GetStringAtIndex(idx);
2465  if (cmd[0] == '\0')
2466  continue;
2467 
2468  if (options.GetEchoCommands()) {
2469  // TODO: Add Stream support.
2470  result.AppendMessageWithFormat("%s %s\n",
2471  m_debugger.GetPrompt().str().c_str(), cmd);
2472  }
2473 
2475  tmp_result.SetInteractive(result.GetInteractive());
2476  tmp_result.SetSuppressImmediateOutput(true);
2477 
2478  // We might call into a regex or alias command, in which case the
2479  // add_to_history will get lost. This m_command_source_depth dingus is the
2480  // way we turn off adding to the history in that case, so set it up here.
2481  if (!options.GetAddToHistory())
2483  bool success = HandleCommand(cmd, options.m_add_to_history, tmp_result);
2484  if (!options.GetAddToHistory())
2486 
2487  if (options.GetPrintResults()) {
2488  if (tmp_result.Succeeded())
2489  result.AppendMessage(tmp_result.GetOutputData());
2490  }
2491 
2492  if (!success || !tmp_result.Succeeded()) {
2493  llvm::StringRef error_msg = tmp_result.GetErrorData();
2494  if (error_msg.empty())
2495  error_msg = "<unknown error>.\n";
2496  if (options.GetStopOnError()) {
2497  result.AppendErrorWithFormat(
2498  "Aborting reading of commands after command #%" PRIu64
2499  ": '%s' failed with %s",
2500  (uint64_t)idx, cmd, error_msg.str().c_str());
2501  m_debugger.SetAsyncExecution(old_async_execution);
2502  return;
2503  } else if (options.GetPrintResults()) {
2504  result.AppendMessageWithFormat(
2505  "Command #%" PRIu64 " '%s' failed with %s", (uint64_t)idx + 1, cmd,
2506  error_msg.str().c_str());
2507  }
2508  }
2509 
2510  if (result.GetImmediateOutputStream())
2511  result.GetImmediateOutputStream()->Flush();
2512 
2513  if (result.GetImmediateErrorStream())
2514  result.GetImmediateErrorStream()->Flush();
2515 
2516  // N.B. Can't depend on DidChangeProcessState, because the state coming
2517  // into the command execution could be running (for instance in Breakpoint
2518  // Commands. So we check the return value to see if it is has running in
2519  // it.
2520  if ((tmp_result.GetStatus() == eReturnStatusSuccessContinuingNoResult) ||
2521  (tmp_result.GetStatus() == eReturnStatusSuccessContinuingResult)) {
2522  if (options.GetStopOnContinue()) {
2523  // If we caused the target to proceed, and we're going to stop in that
2524  // case, set the status in our real result before returning. This is
2525  // an error if the continue was not the last command in the set of
2526  // commands to be run.
2527  if (idx != num_lines - 1)
2528  result.AppendErrorWithFormat(
2529  "Aborting reading of commands after command #%" PRIu64
2530  ": '%s' continued the target.\n",
2531  (uint64_t)idx + 1, cmd);
2532  else
2533  result.AppendMessageWithFormat("Command #%" PRIu64
2534  " '%s' continued the target.\n",
2535  (uint64_t)idx + 1, cmd);
2536 
2537  result.SetStatus(tmp_result.GetStatus());
2538  m_debugger.SetAsyncExecution(old_async_execution);
2539 
2540  return;
2541  }
2542  }
2543 
2544  // Also check for "stop on crash here:
2545  if (tmp_result.GetDidChangeProcessState() && options.GetStopOnCrash() &&
2547  if (idx != num_lines - 1)
2548  result.AppendErrorWithFormat(
2549  "Aborting reading of commands after command #%" PRIu64
2550  ": '%s' stopped with a signal or exception.\n",
2551  (uint64_t)idx + 1, cmd);
2552  else
2553  result.AppendMessageWithFormat(
2554  "Command #%" PRIu64 " '%s' stopped with a signal or exception.\n",
2555  (uint64_t)idx + 1, cmd);
2556 
2557  result.SetStatus(tmp_result.GetStatus());
2558  m_debugger.SetAsyncExecution(old_async_execution);
2559 
2560  return;
2561  }
2562  }
2563 
2565  m_debugger.SetAsyncExecution(old_async_execution);
2566 
2567  return;
2568 }
2569 
2570 // Make flags that we can pass into the IOHandler so our delegates can do the
2571 // right thing
2572 enum {
2573  eHandleCommandFlagStopOnContinue = (1u << 0),
2574  eHandleCommandFlagStopOnError = (1u << 1),
2575  eHandleCommandFlagEchoCommand = (1u << 2),
2576  eHandleCommandFlagEchoCommentCommand = (1u << 3),
2577  eHandleCommandFlagPrintResult = (1u << 4),
2578  eHandleCommandFlagPrintErrors = (1u << 5),
2579  eHandleCommandFlagStopOnCrash = (1u << 6)
2580 };
2581 
2583  FileSpec &cmd_file, const ExecutionContext &context,
2584  const CommandInterpreterRunOptions &options, CommandReturnObject &result) {
2585  OverrideExecutionContext(context);
2586  HandleCommandsFromFile(cmd_file, options, result);
2588 }
2589 
2591  const CommandInterpreterRunOptions &options, CommandReturnObject &result) {
2592  if (!FileSystem::Instance().Exists(cmd_file)) {
2593  result.AppendErrorWithFormat(
2594  "Error reading commands from file %s - file not found.\n",
2595  cmd_file.GetFilename().AsCString("<Unknown>"));
2596  return;
2597  }
2598 
2599  std::string cmd_file_path = cmd_file.GetPath();
2600  auto input_file_up =
2602  if (!input_file_up) {
2603  std::string error = llvm::toString(input_file_up.takeError());
2604  result.AppendErrorWithFormatv(
2605  "error: an error occurred read file '{0}': {1}\n", cmd_file_path,
2606  llvm::fmt_consume(input_file_up.takeError()));
2607  return;
2608  }
2609  FileSP input_file_sp = FileSP(std::move(input_file_up.get()));
2610 
2611  Debugger &debugger = GetDebugger();
2612 
2613  uint32_t flags = 0;
2614 
2615  if (options.m_stop_on_continue == eLazyBoolCalculate) {
2616  if (m_command_source_flags.empty()) {
2617  // Stop on continue by default
2618  flags |= eHandleCommandFlagStopOnContinue;
2619  } else if (m_command_source_flags.back() &
2620  eHandleCommandFlagStopOnContinue) {
2621  flags |= eHandleCommandFlagStopOnContinue;
2622  }
2623  } else if (options.m_stop_on_continue == eLazyBoolYes) {
2624  flags |= eHandleCommandFlagStopOnContinue;
2625  }
2626 
2627  if (options.m_stop_on_error == eLazyBoolCalculate) {
2628  if (m_command_source_flags.empty()) {
2630  flags |= eHandleCommandFlagStopOnError;
2631  } else if (m_command_source_flags.back() & eHandleCommandFlagStopOnError) {
2632  flags |= eHandleCommandFlagStopOnError;
2633  }
2634  } else if (options.m_stop_on_error == eLazyBoolYes) {
2635  flags |= eHandleCommandFlagStopOnError;
2636  }
2637 
2638  // stop-on-crash can only be set, if it is present in all levels of
2639  // pushed flag sets.
2640  if (options.GetStopOnCrash()) {
2641  if (m_command_source_flags.empty()) {
2642  flags |= eHandleCommandFlagStopOnCrash;
2643  } else if (m_command_source_flags.back() & eHandleCommandFlagStopOnCrash) {
2644  flags |= eHandleCommandFlagStopOnCrash;
2645  }
2646  }
2647 
2648  if (options.m_echo_commands == eLazyBoolCalculate) {
2649  if (m_command_source_flags.empty()) {
2650  // Echo command by default
2651  flags |= eHandleCommandFlagEchoCommand;
2652  } else if (m_command_source_flags.back() & eHandleCommandFlagEchoCommand) {
2653  flags |= eHandleCommandFlagEchoCommand;
2654  }
2655  } else if (options.m_echo_commands == eLazyBoolYes) {
2656  flags |= eHandleCommandFlagEchoCommand;
2657  }
2658 
2659  // We will only ever ask for this flag, if we echo commands in general.
2661  if (m_command_source_flags.empty()) {
2662  // Echo comments by default
2663  flags |= eHandleCommandFlagEchoCommentCommand;
2664  } else if (m_command_source_flags.back() &
2665  eHandleCommandFlagEchoCommentCommand) {
2666  flags |= eHandleCommandFlagEchoCommentCommand;
2667  }
2668  } else if (options.m_echo_comment_commands == eLazyBoolYes) {
2669  flags |= eHandleCommandFlagEchoCommentCommand;
2670  }
2671 
2672  if (options.m_print_results == eLazyBoolCalculate) {
2673  if (m_command_source_flags.empty()) {
2674  // Print output by default
2675  flags |= eHandleCommandFlagPrintResult;
2676  } else if (m_command_source_flags.back() & eHandleCommandFlagPrintResult) {
2677  flags |= eHandleCommandFlagPrintResult;
2678  }
2679  } else if (options.m_print_results == eLazyBoolYes) {
2680  flags |= eHandleCommandFlagPrintResult;
2681  }
2682 
2683  if (options.m_print_errors == eLazyBoolCalculate) {
2684  if (m_command_source_flags.empty()) {
2685  // Print output by default
2686  flags |= eHandleCommandFlagPrintErrors;
2687  } else if (m_command_source_flags.back() & eHandleCommandFlagPrintErrors) {
2688  flags |= eHandleCommandFlagPrintErrors;
2689  }
2690  } else if (options.m_print_errors == eLazyBoolYes) {
2691  flags |= eHandleCommandFlagPrintErrors;
2692  }
2693 
2694  if (flags & eHandleCommandFlagPrintResult) {
2695  debugger.GetOutputFile().Printf("Executing commands in '%s'.\n",
2696  cmd_file_path.c_str());
2697  }
2698 
2699  // Used for inheriting the right settings when "command source" might
2700  // have nested "command source" commands
2701  lldb::StreamFileSP empty_stream_sp;
2702  m_command_source_flags.push_back(flags);
2703  IOHandlerSP io_handler_sp(new IOHandlerEditline(
2704  debugger, IOHandler::Type::CommandInterpreter, input_file_sp,
2705  empty_stream_sp, // Pass in an empty stream so we inherit the top
2706  // input reader output stream
2707  empty_stream_sp, // Pass in an empty stream so we inherit the top
2708  // input reader error stream
2709  flags,
2710  nullptr, // Pass in NULL for "editline_name" so no history is saved,
2711  // or written
2712  debugger.GetPrompt(), llvm::StringRef(),
2713  false, // Not multi-line
2714  debugger.GetUseColor(), 0, *this, nullptr));
2715  const bool old_async_execution = debugger.GetAsyncExecution();
2716 
2717  // Set synchronous execution if we are not stopping on continue
2718  if ((flags & eHandleCommandFlagStopOnContinue) == 0)
2719  debugger.SetAsyncExecution(false);
2720 
2723 
2724  debugger.RunIOHandlerSync(io_handler_sp);
2725  if (!m_command_source_flags.empty())
2726  m_command_source_flags.pop_back();
2727 
2728  m_command_source_dirs.pop_back();
2730 
2732  debugger.SetAsyncExecution(old_async_execution);
2733 }
2734 
2736 
2737 void CommandInterpreter::SetSynchronous(bool value) {
2738  // Asynchronous mode is not supported during reproducer replay.
2739  if (repro::Reproducer::Instance().GetLoader())
2740  return;
2741  m_synchronous_execution = value;
2742 }
2743 
2745  llvm::StringRef prefix,
2746  llvm::StringRef help_text) {
2747  const uint32_t max_columns = m_debugger.GetTerminalWidth();
2748 
2749  size_t line_width_max = max_columns - prefix.size();
2750  if (line_width_max < 16)
2751  line_width_max = help_text.size() + prefix.size();
2752 
2753  strm.IndentMore(prefix.size());
2754  bool prefixed_yet = false;
2755  // Even if we have no help text we still want to emit the command name.
2756  if (help_text.empty())
2757  help_text = "No help text";
2758  while (!help_text.empty()) {
2759  // Prefix the first line, indent subsequent lines to line up
2760  if (!prefixed_yet) {
2761  strm << prefix;
2762  prefixed_yet = true;
2763  } else
2764  strm.Indent();
2765 
2766  // Never print more than the maximum on one line.
2767  llvm::StringRef this_line = help_text.substr(0, line_width_max);
2768 
2769  // Always break on an explicit newline.
2770  std::size_t first_newline = this_line.find_first_of("\n");
2771 
2772  // Don't break on space/tab unless the text is too long to fit on one line.
2773  std::size_t last_space = llvm::StringRef::npos;
2774  if (this_line.size() != help_text.size())
2775  last_space = this_line.find_last_of(" \t");
2776 
2777  // Break at whichever condition triggered first.
2778  this_line = this_line.substr(0, std::min(first_newline, last_space));
2779  strm.PutCString(this_line);
2780  strm.EOL();
2781 
2782  // Remove whitespace / newlines after breaking.
2783  help_text = help_text.drop_front(this_line.size()).ltrim();
2784  }
2785  strm.IndentLess(prefix.size());
2786 }
2787 
2789  llvm::StringRef word_text,
2790  llvm::StringRef separator,
2791  llvm::StringRef help_text,
2792  size_t max_word_len) {
2793  StreamString prefix_stream;
2794  prefix_stream.Printf(" %-*s %*s ", (int)max_word_len, word_text.data(),
2795  (int)separator.size(), separator.data());
2796  OutputFormattedHelpText(strm, prefix_stream.GetString(), help_text);
2797 }
2798 
2799 void CommandInterpreter::OutputHelpText(Stream &strm, llvm::StringRef word_text,
2800  llvm::StringRef separator,
2801  llvm::StringRef help_text,
2802  uint32_t max_word_len) {
2803  int indent_size = max_word_len + separator.size() + 2;
2804 
2805  strm.IndentMore(indent_size);
2806 
2807  StreamString text_strm;
2808  text_strm.Printf("%-*s ", (int)max_word_len, word_text.data());
2809  text_strm << separator << " " << help_text;
2810 
2811  const uint32_t max_columns = m_debugger.GetTerminalWidth();
2812 
2813  llvm::StringRef text = text_strm.GetString();
2814 
2815  uint32_t chars_left = max_columns;
2816 
2817  auto nextWordLength = [](llvm::StringRef S) {
2818  size_t pos = S.find(' ');
2819  return pos == llvm::StringRef::npos ? S.size() : pos;
2820  };
2821 
2822  while (!text.empty()) {
2823  if (text.front() == '\n' ||
2824  (text.front() == ' ' && nextWordLength(text.ltrim(' ')) > chars_left)) {
2825  strm.EOL();
2826  strm.Indent();
2827  chars_left = max_columns - indent_size;
2828  if (text.front() == '\n')
2829  text = text.drop_front();
2830  else
2831  text = text.ltrim(' ');
2832  } else {
2833  strm.PutChar(text.front());
2834  --chars_left;
2835  text = text.drop_front();
2836  }
2837  }
2838 
2839  strm.EOL();
2840  strm.IndentLess(indent_size);
2841 }
2842 
2844  llvm::StringRef search_word, StringList &commands_found,
2845  StringList &commands_help, CommandObject::CommandMap &command_map) {
2846  CommandObject::CommandMap::const_iterator pos;
2847 
2848  for (pos = command_map.begin(); pos != command_map.end(); ++pos) {
2849  llvm::StringRef command_name = pos->first;
2850  CommandObject *cmd_obj = pos->second.get();
2851 
2852  const bool search_short_help = true;
2853  const bool search_long_help = false;
2854  const bool search_syntax = false;
2855  const bool search_options = false;
2856  if (command_name.contains_insensitive(search_word) ||
2857  cmd_obj->HelpTextContainsWord(search_word, search_short_help,
2858  search_long_help, search_syntax,
2859  search_options)) {
2860  commands_found.AppendString(cmd_obj->GetCommandName());
2861  commands_help.AppendString(cmd_obj->GetHelp());
2862  }
2863 
2864  if (cmd_obj->IsMultiwordObject()) {
2865  CommandObjectMultiword *cmd_multiword = cmd_obj->GetAsMultiwordCommand();
2866  FindCommandsForApropos(search_word, commands_found, commands_help,
2867  cmd_multiword->GetSubcommandDictionary());
2868  }
2869  }
2870 }
2871 
2872 void CommandInterpreter::FindCommandsForApropos(llvm::StringRef search_word,
2873  StringList &commands_found,
2874  StringList &commands_help,
2875  bool search_builtin_commands,
2876  bool search_user_commands,
2877  bool search_alias_commands,
2878  bool search_user_mw_commands) {
2879  CommandObject::CommandMap::const_iterator pos;
2880 
2881  if (search_builtin_commands)
2882  FindCommandsForApropos(search_word, commands_found, commands_help,
2883  m_command_dict);
2884 
2885  if (search_user_commands)
2886  FindCommandsForApropos(search_word, commands_found, commands_help,
2887  m_user_dict);
2888 
2889  if (search_user_mw_commands)
2890  FindCommandsForApropos(search_word, commands_found, commands_help,
2891  m_user_mw_dict);
2892 
2893  if (search_alias_commands)
2894  FindCommandsForApropos(search_word, commands_found, commands_help,
2895  m_alias_dict);
2896 }
2897 
2899  return !m_overriden_exe_contexts.empty()
2900  ? m_overriden_exe_contexts.top()
2902 }
2903 
2905  const ExecutionContext &override_context) {
2906  m_overriden_exe_contexts.push(override_context);
2907 }
2908 
2910  if (!m_overriden_exe_contexts.empty())
2912 }
2913 
2915  if (ProcessSP process_sp = GetExecutionContext().GetProcessSP())
2916  m_debugger.FlushProcessOutput(*process_sp, /*flush_stdout*/ true,
2917  /*flush_stderr*/ true);
2918 }
2919 
2921  auto idle_state = CommandHandlingState::eIdle;
2922  if (m_command_state.compare_exchange_strong(
2923  idle_state, CommandHandlingState::eInProgress))
2925  else
2928 }
2929 
2932  if (--m_iohandler_nesting_level == 0) {
2933  auto prev_state = m_command_state.exchange(CommandHandlingState::eIdle);
2934  lldbassert(prev_state != CommandHandlingState::eIdle);
2935  }
2936 }
2937 
2939  auto in_progress = CommandHandlingState::eInProgress;
2940  return m_command_state.compare_exchange_strong(
2941  in_progress, CommandHandlingState::eInterrupted);
2942 }
2943 
2945  bool was_interrupted =
2947  lldbassert(!was_interrupted || m_iohandler_nesting_level > 0);
2948  return was_interrupted;
2949 }
2950 
2952  llvm::StringRef str) {
2953  // Split the output into lines and poll for interrupt requests
2954  const char *data = str.data();
2955  size_t size = str.size();
2956  while (size > 0 && !WasInterrupted()) {
2957  size_t chunk_size = 0;
2958  for (; chunk_size < size; ++chunk_size) {
2959  lldbassert(data[chunk_size] != '\0');
2960  if (data[chunk_size] == '\n') {
2961  ++chunk_size;
2962  break;
2963  }
2964  }
2965  chunk_size = stream.Write(data, chunk_size);
2966  lldbassert(size >= chunk_size);
2967  data += chunk_size;
2968  size -= chunk_size;
2969  }
2970  if (size > 0) {
2971  stream.Printf("\n... Interrupted.\n");
2972  }
2973 }
2974 
2976  llvm::StringRef line, const Flags &io_handler_flags) const {
2977  if (!io_handler_flags.Test(eHandleCommandFlagEchoCommand))
2978  return false;
2979 
2980  llvm::StringRef command = line.trim();
2981  if (command.empty())
2982  return true;
2983 
2984  if (command.front() == m_comment_char)
2985  return io_handler_flags.Test(eHandleCommandFlagEchoCommentCommand);
2986 
2987  return true;
2988 }
2989 
2991  std::string &line) {
2992  // If we were interrupted, bail out...
2993  if (WasInterrupted())
2994  return;
2995 
2996  const bool is_interactive = io_handler.GetIsInteractive();
2997  if (!is_interactive) {
2998  // When we are not interactive, don't execute blank lines. This will happen
2999  // sourcing a commands file. We don't want blank lines to repeat the
3000  // previous command and cause any errors to occur (like redefining an
3001  // alias, get an error and stop parsing the commands file).
3002  if (line.empty())
3003  return;
3004 
3005  // When using a non-interactive file handle (like when sourcing commands
3006  // from a file) we need to echo the command out so we don't just see the
3007  // command output and no command...
3008  if (EchoCommandNonInteractive(line, io_handler.GetFlags()))
3009  io_handler.GetOutputStreamFileSP()->Printf(
3010  "%s%s\n", io_handler.GetPrompt(), line.c_str());
3011  }
3012 
3014 
3016  auto finalize = llvm::make_scope_exit([this]() {
3018  });
3019 
3021  HandleCommand(line.c_str(), eLazyBoolCalculate, result);
3022 
3023  // Now emit the command output text from the command we just executed
3024  if ((result.Succeeded() &&
3025  io_handler.GetFlags().Test(eHandleCommandFlagPrintResult)) ||
3026  io_handler.GetFlags().Test(eHandleCommandFlagPrintErrors)) {
3027  // Display any STDOUT/STDERR _prior_ to emitting the command result text
3028  GetProcessOutput();
3029 
3030  if (!result.GetImmediateOutputStream()) {
3031  llvm::StringRef output = result.GetOutputData();
3032  PrintCommandOutput(*io_handler.GetOutputStreamFileSP(), output);
3033  }
3034 
3035  // Now emit the command error text from the command we just executed
3036  if (!result.GetImmediateErrorStream()) {
3037  llvm::StringRef error = result.GetErrorData();
3039  }
3040  }
3041 
3043 
3044  switch (result.GetStatus()) {
3045  case eReturnStatusInvalid:
3048  case eReturnStatusStarted:
3049  break;
3050 
3053  if (io_handler.GetFlags().Test(eHandleCommandFlagStopOnContinue))
3054  io_handler.SetIsDone(true);
3055  break;
3056 
3057  case eReturnStatusFailed:
3059  if (io_handler.GetFlags().Test(eHandleCommandFlagStopOnError)) {
3061  io_handler.SetIsDone(true);
3062  }
3063  break;
3064 
3065  case eReturnStatusQuit:
3067  io_handler.SetIsDone(true);
3068  break;
3069  }
3070 
3071  // Finally, if we're going to stop on crash, check that here:
3073  result.GetDidChangeProcessState() &&
3074  io_handler.GetFlags().Test(eHandleCommandFlagStopOnCrash) &&
3076  io_handler.SetIsDone(true);
3078  }
3079 }
3080 
3083  Process *process = exe_ctx.GetProcessPtr();
3084 
3085  if (InterruptCommand())
3086  return true;
3087 
3088  if (process) {
3089  StateType state = process->GetState();
3090  if (StateIsRunningState(state)) {
3091  process->Halt();
3092  return true; // Don't do any updating when we are running
3093  }
3094  }
3095 
3096  ScriptInterpreter *script_interpreter =
3098  if (script_interpreter) {
3099  if (script_interpreter->Interrupt())
3100  return true;
3101  }
3102  return false;
3103 }
3104 
3106  CommandReturnObject &result, llvm::Optional<std::string> output_file) {
3107  if (output_file == llvm::None || output_file->empty()) {
3108  std::string now = llvm::to_string(std::chrono::system_clock::now());
3109  std::replace(now.begin(), now.end(), ' ', '_');
3110  const std::string file_name = "lldb_session_" + now + ".log";
3111 
3112  FileSpec save_location = GetSaveSessionDirectory();
3113 
3114  if (!save_location)
3115  save_location = HostInfo::GetGlobalTempDir();
3116 
3117  FileSystem::Instance().Resolve(save_location);
3118  save_location.AppendPathComponent(file_name);
3119  output_file = save_location.GetPath();
3120  }
3121 
3122  auto error_out = [&](llvm::StringRef error_message, std::string description) {
3124  error_message, output_file, description);
3125  result.AppendErrorWithFormatv(
3126  "Failed to save session's transcripts to {0}!", *output_file);
3127  return false;
3128  };
3129 
3133 
3134  auto opened_file = FileSystem::Instance().Open(FileSpec(*output_file), flags);
3135 
3136  if (!opened_file)
3137  return error_out("Unable to create file",
3138  llvm::toString(opened_file.takeError()));
3139 
3140  FileUP file = std::move(opened_file.get());
3141 
3142  size_t byte_size = m_transcript_stream.GetSize();
3143 
3144  Status error = file->Write(m_transcript_stream.GetData(), byte_size);
3145 
3146  if (error.Fail() || byte_size != m_transcript_stream.GetSize())
3147  return error_out("Unable to write to destination file",
3148  "Bytes written do not match transcript size.");
3149 
3151  result.AppendMessageWithFormat("Session's transcripts saved to %s\n",
3152  output_file->c_str());
3153 
3154  return true;
3155 }
3156 
3158  if (m_command_source_dirs.empty())
3159  return {};
3160  return m_command_source_dirs.back();
3161 }
3162 
3164  const char *prompt, IOHandlerDelegate &delegate, void *baton) {
3165  Debugger &debugger = GetDebugger();
3166  IOHandlerSP io_handler_sp(
3168  "lldb", // Name of input reader for history
3169  llvm::StringRef(prompt), // Prompt
3170  llvm::StringRef(), // Continuation prompt
3171  true, // Get multiple lines
3172  debugger.GetUseColor(),
3173  0, // Don't show line numbers
3174  delegate, // IOHandlerDelegate
3175  nullptr)); // FileShadowCollector
3176 
3177  if (io_handler_sp) {
3178  io_handler_sp->SetUserData(baton);
3179  debugger.RunIOHandlerAsync(io_handler_sp);
3180  }
3181 }
3182 
3184  const char *prompt, IOHandlerDelegate &delegate, void *baton) {
3185  Debugger &debugger = GetDebugger();
3186  IOHandlerSP io_handler_sp(
3188  "lldb-python", // Name of input reader for history
3189  llvm::StringRef(prompt), // Prompt
3190  llvm::StringRef(), // Continuation prompt
3191  true, // Get multiple lines
3192  debugger.GetUseColor(),
3193  0, // Don't show line numbers
3194  delegate, // IOHandlerDelegate
3195  nullptr)); // FileShadowCollector
3196 
3197  if (io_handler_sp) {
3198  io_handler_sp->SetUserData(baton);
3199  debugger.RunIOHandlerAsync(io_handler_sp);
3200  }
3201 }
3202 
3205 }
3206 
3207 lldb::IOHandlerSP
3208 CommandInterpreter::GetIOHandler(bool force_create,
3209  CommandInterpreterRunOptions *options) {
3210  // Always re-create the IOHandlerEditline in case the input changed. The old
3211  // instance might have had a non-interactive input and now it does or vice
3212  // versa.
3213  if (force_create || !m_command_io_handler_sp) {
3214  // Always re-create the IOHandlerEditline in case the input changed. The
3215  // old instance might have had a non-interactive input and now it does or
3216  // vice versa.
3217  uint32_t flags = 0;
3218 
3219  if (options) {
3220  if (options->m_stop_on_continue == eLazyBoolYes)
3221  flags |= eHandleCommandFlagStopOnContinue;
3222  if (options->m_stop_on_error == eLazyBoolYes)
3223  flags |= eHandleCommandFlagStopOnError;
3224  if (options->m_stop_on_crash == eLazyBoolYes)
3225  flags |= eHandleCommandFlagStopOnCrash;
3226  if (options->m_echo_commands != eLazyBoolNo)
3227  flags |= eHandleCommandFlagEchoCommand;
3228  if (options->m_echo_comment_commands != eLazyBoolNo)
3229  flags |= eHandleCommandFlagEchoCommentCommand;
3230  if (options->m_print_results != eLazyBoolNo)
3231  flags |= eHandleCommandFlagPrintResult;
3232  if (options->m_print_errors != eLazyBoolNo)
3233  flags |= eHandleCommandFlagPrintErrors;
3234  } else {
3235  flags = eHandleCommandFlagEchoCommand | eHandleCommandFlagPrintResult |
3236  eHandleCommandFlagPrintErrors;
3237  }
3238 
3239  m_command_io_handler_sp = std::make_shared<IOHandlerEditline>(
3242  m_debugger.GetErrorStreamSP(), flags, "lldb", m_debugger.GetPrompt(),
3243  llvm::StringRef(), // Continuation prompt
3244  false, // Don't enable multiple line input, just single line commands
3246  0, // Don't show line numbers
3247  *this, // IOHandlerDelegate
3248  GetDebugger().GetInputRecorder());
3249  }
3250  return m_command_io_handler_sp;
3251 }
3252 
3254  CommandInterpreterRunOptions &options) {
3255  // Always re-create the command interpreter when we run it in case any file
3256  // handles have changed.
3257  bool force_create = true;
3258  m_debugger.RunIOHandlerAsync(GetIOHandler(force_create, &options));
3260 
3261  if (options.GetAutoHandleEvents())
3263 
3264  if (options.GetSpawnThread()) {
3266  } else {
3268 
3269  if (options.GetAutoHandleEvents())
3271  }
3272 
3273  return m_result;
3274 }
3275 
3276 CommandObject *
3278  CommandReturnObject &result) {
3279  std::string scratch_command(command_line); // working copy so we don't modify
3280  // command_line unless we succeed
3281  CommandObject *cmd_obj = nullptr;
3282  StreamString revised_command_line;
3283  bool wants_raw_input = false;
3284  std::string next_word;
3285  StringList matches;
3286  bool done = false;
3287  while (!done) {
3288  char quote_char = '\0';
3289  std::string suffix;
3290  ExtractCommand(scratch_command, next_word, suffix, quote_char);
3291  if (cmd_obj == nullptr) {
3292  std::string full_name;
3293  bool is_alias = GetAliasFullName(next_word, full_name);
3294  cmd_obj = GetCommandObject(next_word, &matches);
3295  bool is_real_command =
3296  (!is_alias) || (cmd_obj != nullptr && !cmd_obj->IsAlias());
3297  if (!is_real_command) {
3298  matches.Clear();
3299  std::string alias_result;
3300  cmd_obj =
3301  BuildAliasResult(full_name, scratch_command, alias_result, result);
3302  revised_command_line.Printf("%s", alias_result.c_str());
3303  if (cmd_obj) {
3304  wants_raw_input = cmd_obj->WantsRawCommandString();
3305  }
3306  } else {
3307  if (cmd_obj) {
3308  llvm::StringRef cmd_name = cmd_obj->GetCommandName();
3309  revised_command_line.Printf("%s", cmd_name.str().c_str());
3310  wants_raw_input = cmd_obj->WantsRawCommandString();
3311  } else {
3312  revised_command_line.Printf("%s", next_word.c_str());
3313  }
3314  }
3315  } else {
3316  if (cmd_obj->IsMultiwordObject()) {
3317  CommandObject *sub_cmd_obj =
3318  cmd_obj->GetSubcommandObject(next_word.c_str());
3319  if (sub_cmd_obj) {
3320  // The subcommand's name includes the parent command's name, so
3321  // restart rather than append to the revised_command_line.
3322  llvm::StringRef sub_cmd_name = sub_cmd_obj->GetCommandName();
3323  revised_command_line.Clear();
3324  revised_command_line.Printf("%s", sub_cmd_name.str().c_str());
3325  cmd_obj = sub_cmd_obj;
3326  wants_raw_input = cmd_obj->WantsRawCommandString();
3327  } else {
3328  if (quote_char)
3329  revised_command_line.Printf(" %c%s%s%c", quote_char,
3330  next_word.c_str(), suffix.c_str(),
3331  quote_char);
3332  else
3333  revised_command_line.Printf(" %s%s", next_word.c_str(),
3334  suffix.c_str());
3335  done = true;
3336  }
3337  } else {
3338  if (quote_char)
3339  revised_command_line.Printf(" %c%s%s%c", quote_char,
3340  next_word.c_str(), suffix.c_str(),
3341  quote_char);
3342  else
3343  revised_command_line.Printf(" %s%s", next_word.c_str(),
3344  suffix.c_str());
3345  done = true;
3346  }
3347  }
3348 
3349  if (cmd_obj == nullptr) {
3350  const size_t num_matches = matches.GetSize();
3351  if (matches.GetSize() > 1) {
3352  StreamString error_msg;
3353  error_msg.Printf("Ambiguous command '%s'. Possible matches:\n",
3354  next_word.c_str());
3355 
3356  for (uint32_t i = 0; i < num_matches; ++i) {
3357  error_msg.Printf("\t%s\n", matches.GetStringAtIndex(i));
3358  }
3359  result.AppendRawError(error_msg.GetString());
3360  } else {
3361  // We didn't have only one match, otherwise we wouldn't get here.
3362  lldbassert(num_matches == 0);
3363  result.AppendErrorWithFormat("'%s' is not a valid command.\n",
3364  next_word.c_str());
3365  }
3366  return nullptr;
3367  }
3368 
3369  if (cmd_obj->IsMultiwordObject()) {
3370  if (!suffix.empty()) {
3371  result.AppendErrorWithFormat(
3372  "command '%s' did not recognize '%s%s%s' as valid (subcommand "
3373  "might be invalid).\n",
3374  cmd_obj->GetCommandName().str().c_str(),
3375  next_word.empty() ? "" : next_word.c_str(),
3376  next_word.empty() ? " -- " : " ", suffix.c_str());
3377  return nullptr;
3378  }
3379  } else {
3380  // If we found a normal command, we are done
3381  done = true;
3382  if (!suffix.empty()) {
3383  switch (suffix[0]) {
3384  case '/':
3385  // GDB format suffixes
3386  {
3387  Options *command_options = cmd_obj->GetOptions();
3388  if (command_options &&
3389  command_options->SupportsLongOption("gdb-format")) {
3390  std::string gdb_format_option("--gdb-format=");
3391  gdb_format_option += (suffix.c_str() + 1);
3392 
3393  std::string cmd = std::string(revised_command_line.GetString());
3394  size_t arg_terminator_idx = FindArgumentTerminator(cmd);
3395  if (arg_terminator_idx != std::string::npos) {
3396  // Insert the gdb format option before the "--" that terminates
3397  // options
3398  gdb_format_option.append(1, ' ');
3399  cmd.insert(arg_terminator_idx, gdb_format_option);
3400  revised_command_line.Clear();
3401  revised_command_line.PutCString(cmd);
3402  } else
3403  revised_command_line.Printf(" %s", gdb_format_option.c_str());
3404 
3405  if (wants_raw_input &&
3406  FindArgumentTerminator(cmd) == std::string::npos)
3407  revised_command_line.PutCString(" --");
3408  } else {
3409  result.AppendErrorWithFormat(
3410  "the '%s' command doesn't support the --gdb-format option\n",
3411  cmd_obj->GetCommandName().str().c_str());
3412  return nullptr;
3413  }
3414  }
3415  break;
3416 
3417  default:
3418  result.AppendErrorWithFormat(
3419  "unknown command shorthand suffix: '%s'\n", suffix.c_str());
3420  return nullptr;
3421  }
3422  }
3423  }
3424  if (scratch_command.empty())
3425  done = true;
3426  }
3427 
3428  if (!scratch_command.empty())
3429  revised_command_line.Printf(" %s", scratch_command.c_str());
3430 
3431  if (cmd_obj != nullptr)
3432  command_line = std::string(revised_command_line.GetString());
3433 
3434  return cmd_obj;
3435 }
lldb_private::toString
const char * toString(AppleArm64ExceptionClass EC)
Definition: AppleArm64ExceptionClass.h:38
lldb_private::CommandInterpreter::GetPromptOnQuit
bool GetPromptOnQuit() const
Definition: CommandInterpreter.cpp:141
lldb_private::CommandInterpreter::VerifyUserMultiwordCmdPath
CommandObjectMultiword * VerifyUserMultiwordCmdPath(Args &path, bool leaf_is_command, Status &result)
Look up the command pointed to by path encoded in the arguments of the incoming command object.
lldb_private::CommandInterpreter::eCommandTypesUserDef
@ eCommandTypesUserDef
Definition: CommandInterpreter.h:235
lldb_private::Stream::IndentLess
void IndentLess(unsigned amount=2)
Decrement the current indentation level.
Definition: Stream.cpp:171
CommandObjectQuit.h
lldb_private::Broadcaster::CheckInWithManager
void CheckInWithManager()
Definition: Broadcaster.cpp:48
lldb::eExpressionThreadVanished
@ eExpressionThreadVanished
Definition: lldb-enumerations.h:280
lldb_private::FileSystem::Open
int Open(const char *path, int flags, int mode)
Wraps ::open in a platform-independent way.
Definition: FileSystemPosix.cpp:79
lldb_private::ExecutionContext
Definition: ExecutionContext.h:292
lldb_private::Debugger::GetIOHandlerCommandPrefix
const char * GetIOHandlerCommandPrefix()
Definition: Debugger.cpp:949
lldb_private::CommandObjectMultiword::GetSubcommandDictionary
CommandObject::CommandMap & GetSubcommandDictionary()
Definition: CommandObjectMultiword.h:73
lldb_private::CommandInterpreter::IOHandlerInputComplete
void IOHandlerInputComplete(IOHandler &io_handler, std::string &line) override
Called when a line or lines have been retrieved.
lldb_private::Debugger::RunIOHandlerSync
void RunIOHandlerSync(const lldb::IOHandlerSP &reader_sp)
Run the given IO handler and block until it's complete.
Definition: Debugger.cpp:896
lldb_private::CommandInterpreter::m_comment_char
char m_comment_char
Definition: CommandInterpreter.h:696
LLDB_SCOPED_TIMERF
#define LLDB_SCOPED_TIMERF(...)
Definition: Timer.h:86
lldb_private::CommandInterpreterRunResult::SetResult
void SetResult(lldb::CommandInterpreterResult result)
Definition: CommandInterpreter.h:51
lldb_private::CommandInterpreter::SetSaveSessionDirectory
void SetSaveSessionDirectory(llvm::StringRef path)
Definition: CommandInterpreter.cpp:168
lldb_private::Debugger::GetSelectedExecutionContext
ExecutionContext GetSelectedExecutionContext()
Definition: Debugger.cpp:840
lldb_private::StringList::Clear
void Clear()
Definition: StringList.cpp:99
lldb_private::CommandHistory::GetSize
size_t GetSize() const
Definition: CommandHistory.cpp:16
CommandObjectLanguage.h
lldb_private::CommandReturnObject::GetStatus
lldb::ReturnStatus GetStatus()
Definition: CommandReturnObject.cpp:123
lldb_private::CommandObjectMultiwordTarget
Definition: CommandObjectTarget.h:18
lldb_private::CommandInterpreter::RestoreExecutionContext
void RestoreExecutionContext()
lldb::eExpressionResultUnavailable
@ eExpressionResultUnavailable
Definition: lldb-enumerations.h:278
lldb_private::CommandObjectMultiword::GetAsMultiwordCommand
CommandObjectMultiword * GetAsMultiwordCommand() override
Definition: CommandObjectMultiword.h:33
lldb::eReturnStatusSuccessContinuingResult
@ eReturnStatusSuccessContinuingResult
Definition: lldb-enumerations.h:263
lldb_private::CommandObject::Execute
virtual bool Execute(const char *args_string, CommandReturnObject &result)=0
lldb_private::EvaluateExpressionOptions::SetTimeout
void SetTimeout(const Timeout< std::micro > &timeout)
Definition: Target.h:326
CommandObjectWatchpoint.h
lldb_private::CommandInterpreter::m_alias_dict
CommandObject::CommandMap m_alias_dict
Definition: CommandInterpreter.h:688
lldb_private::LanguageSet::GetSingularLanguage
llvm::Optional< lldb::LanguageType > GetSingularLanguage()
If the set contains a single language only, return it.
Definition: TypeSystem.cpp:27
lldb_private::Debugger::GetAutoConfirm
bool GetAutoConfirm() const
Definition: Debugger.cpp:241
lldb_private::CommandInterpreter::GetCommandObjectForCommand
CommandObject * GetCommandObjectForCommand(llvm::StringRef &command_line)
lldb_private::CommandInterpreter::SourceInitFile
void SourceInitFile(FileSpec file, CommandReturnObject &result)
lldb_private::CommandInterpreter::m_debugger
Debugger & m_debugger
Definition: CommandInterpreter.h:676
lldb_private::CommandInterpreter::GetCommandPrefix
const char * GetCommandPrefix()
CommandObjectDisassemble.h
lldb::eExpressionStoppedForDebug
@ eExpressionStoppedForDebug
Definition: lldb-enumerations.h:279
lldb_private::CompletionRequest::GetParsedLine
const Args & GetParsedLine() const
Definition: CompletionRequest.h:134
lldb_private::CommandInterpreter::HandleCommand
bool HandleCommand(const char *command_line, LazyBool add_to_history, const ExecutionContext &override_context, CommandReturnObject &result)
lldb_private::CommandInterpreter::RemoveAlias
bool RemoveAlias(llvm::StringRef alias_name)
Host.h
lldb_private::IOHandler::Type::PythonCode
@ PythonCode
lldb_private::CommandInterpreter::m_user_dict
CommandObject::CommandMap m_user_dict
Definition: CommandInterpreter.h:689
lldb_private::CommandInterpreter::GetSynchronous
bool GetSynchronous()
lldb_private::CommandInterpreterRunOptions::GetAutoHandleEvents
bool GetAutoHandleEvents() const
Definition: CommandInterpreter.h:169
lldb_private::CommandInterpreter::GetOptionArgumentPosition
int GetOptionArgumentPosition(const char *in_string)
Picks the number out of a string of the form "%NNN", otherwise return 0.
lldb_private::CommandInterpreter::GetProcessOutput
void GetProcessOutput()
lldb_private::File::OpenOptions
OpenOptions
Definition: File.h:48
lldb_private::CommandInterpreter::GetHelp
void GetHelp(CommandReturnObject &result, uint32_t types=eCommandTypesAllThem)
lldb::ExpressionResults
ExpressionResults
The results of expression evaluation.
Definition: lldb-enumerations.h:270
lldb_private::OptionParser::eNoArgument
@ eNoArgument
Definition: OptionParser.h:35
lldb_private::Debugger::GetDummyTarget
Target & GetDummyTarget()
Definition: Debugger.h:384
lldb_private::CommandInterpreter::m_command_io_handler_sp
lldb::IOHandlerSP m_command_io_handler_sp
Definition: CommandInterpreter.h:695
lldb_private::CommandObjectTrace
Definition: CommandObjectTrace.h:16
LIBLLDB_LOG_COMMANDS
#define LIBLLDB_LOG_COMMANDS
Definition: Logging.h:32
lldb_private::CommandObject::HelpTextContainsWord
bool HelpTextContainsWord(llvm::StringRef search_word, bool search_short_help=true, bool search_long_help=true, bool search_syntax=true, bool search_options=true)
Definition: CommandObject.cpp:306
lldb_private::CommandInterpreterRunOptions::m_stop_on_continue
LazyBool m_stop_on_continue
Definition: CommandInterpreter.h:183
lldb_private::CommandInterpreter::GetAliasFullName
bool GetAliasFullName(llvm::StringRef cmd, std::string &full_name) const
lldb_private::CommandInterpreter::SetEchoCommands
void SetEchoCommands(bool enable)
Definition: CommandInterpreter.cpp:179
lldb_private::CommandObjectStats
Definition: CommandObjectStats.h:15
lldb_private::eLazyBoolYes
@ eLazyBoolYes
Definition: lldb-private-enumerations.h:115
lldb_private::CommandInterpreter::CommandHandlingState::eInterrupted
@ eInterrupted
lldb_private::Scalar
Definition: Scalar.h:34
LLDB_LOGF
#define LLDB_LOGF(log,...)
Definition: Log.h:249
lldb_private::CommandInterpreterRunResult
Definition: CommandInterpreter.h:34
lldb_private::Process
Definition: Process.h:340
lldb_private::StringList::AppendString
void AppendString(const std::string &s)
Definition: StringList.cpp:43
lldb_private::CommandObjectHelp
Definition: CommandObjectHelp.h:20
CommandObjectVersion.h
lldb_private::CommandInterpreter::HasCommands
bool HasCommands() const
lldb_private::Broadcaster::SetEventName
void SetEventName(uint32_t event_mask, const char *name)
Set the name for an event bit.
Definition: Broadcaster.h:337
FileCache.h
lldb_private::CommandInterpreterRunOptions::GetStopOnError
bool GetStopOnError() const
Definition: CommandInterpreter.h:125
lldb_private::Debugger::RunIOHandlerAsync
void RunIOHandlerAsync(const lldb::IOHandlerSP &reader_sp, bool cancel_top_handler=true)
Run the given IO handler and return immediately.
Definition: Debugger.cpp:961
lldb_private::CommandInterpreter::m_iohandler_nesting_level
int m_iohandler_nesting_level
Definition: CommandInterpreter.h:670
lldb_private::EvaluateExpressionOptions
Definition: Target.h:258
lldb_private::CommandInterpreterRunOptions::GetAddToHistory
bool GetAddToHistory() const
Definition: CommandInterpreter.h:163
lldb_private::CommandReturnObject::AppendRawError
void AppendRawError(llvm::StringRef in_string)
Definition: CommandReturnObject.cpp:115
lldb_private::CommandInterpreter::RemoveUser
bool RemoveUser(llvm::StringRef alias_name)
lldb_private::Debugger::StopEventHandlerThread
void StopEventHandlerThread()
Definition: Debugger.cpp:1607
lldb_private::CommandObjectType
Definition: CommandObjectType.h:16
lldb_private::CommandHistory::IsEmpty
bool IsEmpty() const
Definition: CommandHistory.cpp:21
lldb_private::Debugger::StartEventHandlerThread
bool StartEventHandlerThread()
Definition: Debugger.cpp:1567
lldb_private::Args::Clear
void Clear()
Clear the arguments.
Definition: Args.cpp:374
CommandObjectMemory.h
lldb::LanguageType
LanguageType
Programming language type.
Definition: lldb-enumerations.h:436
lldb_private::Debugger::RunIOHandlers
void RunIOHandlers()
Definition: Debugger.cpp:871
lldb_private::Flags
Definition: Flags.h:22
lldb_private::CommandReturnObject::GetOutputData
llvm::StringRef GetOutputData()
Definition: CommandReturnObject.h:31
lldb_private::CommandInterpreter::GetCommandObject
CommandObject * GetCommandObject(llvm::StringRef cmd, StringList *matches=nullptr, StringList *descriptions=nullptr) const
lldb_private::CommandObjectDisassemble
Definition: CommandObjectDisassemble.h:20
lldb::eExpressionSetupError
@ eExpressionSetupError
Definition: lldb-enumerations.h:272
lldb::StopReason
StopReason
Thread stop reasons.
Definition: lldb-enumerations.h:239
Reproducer.h
lldb_private::FileSystem::GetHomeDirectory
bool GetHomeDirectory(llvm::SmallVectorImpl< char > &path) const
Get the user home directory.
Definition: common/FileSystem.cpp:363
lldb_private::Debugger::StartIOHandlerThread
bool StartIOHandlerThread()
Definition: Debugger.cpp:1624
lldb_private::StateIsRunningState
bool StateIsRunningState(lldb::StateType state)
Check if a state represents a state where the process or thread is running.
Definition: State.cpp:68
lldb_private::CommandObjectScript
Definition: CommandObjectScript.h:16
lldb_private::CommandObjectMultiwordFrame
Definition: CommandObjectFrame.h:18
lldb_private::CommandInterpreter::GetLLDBCommandsFromIOHandler
void GetLLDBCommandsFromIOHandler(const char *prompt, IOHandlerDelegate &delegate, void *baton=nullptr)
lldb_private::CommandInterpreter::OutputHelpText
void OutputHelpText(Stream &stream, llvm::StringRef command_word, llvm::StringRef separator, llvm::StringRef help_text, uint32_t max_word_len)
lldb_private::ConstString::AsCString
const char * AsCString(const char *value_if_empty=nullptr) const
Get the string value as a C string.
Definition: ConstString.h:193
lldb_private::ScriptInterpreter::Interrupt
virtual bool Interrupt()
Definition: ScriptInterpreter.h:153
lldb::eStopReasonException
@ eStopReasonException
Definition: lldb-enumerations.h:246
lldb_private::CommandInterpreter::GetPlatform
lldb::PlatformSP GetPlatform(bool prefer_target_platform)
lldb_private::Flags::Test
bool Test(ValueType bit) const
Test a single flag bit.
Definition: Flags.h:96
lldb_private::CommandInterpreter::eCommandTypesAliases
@ eCommandTypesAliases
Definition: CommandInterpreter.h:237
lldb_private::CommandInterpreter::eBroadcastBitThreadShouldExit
@ eBroadcastBitThreadShouldExit
Definition: CommandInterpreter.h:219
lldb_private::CommandInterpreter::AddCommand
bool AddCommand(llvm::StringRef name, const lldb::CommandObjectSP &cmd_sp, bool can_replace)
CommandObjectBreakpoint.h
lldb_private::CommandInterpreter::m_skip_app_init_files
bool m_skip_app_init_files
Definition: CommandInterpreter.h:683
lldb_private::CommandInterpreter::m_synchronous_execution
bool m_synchronous_execution
Definition: CommandInterpreter.h:681
lldb_private::CommandObjectReproducer
Definition: CommandObjectReproducer.h:18
lldb_private::CommandObject::GetSubcommandObject
virtual CommandObject * GetSubcommandObject(llvm::StringRef sub_cmd, StringList *matches=nullptr)
Definition: CommandObject.h:170
lldb_private::CommandInterpreterRunOptions::m_echo_comment_commands
LazyBool m_echo_comment_commands
Definition: CommandInterpreter.h:187
lldb_private::Debugger::GetOutputStreamSP
lldb::StreamFileSP GetOutputStreamSP()
Definition: Debugger.h:163
lldb_private::Stream
Definition: Stream.h:28
lldb_private::CompletionRequest::AppendEmptyArgument
void AppendEmptyArgument()
Adds an empty argument at the end of the argument list and moves the cursor to this new argument.
Definition: CompletionRequest.h:150
lldb_private::Args
Definition: Args.h:33
lldb_private::Process::Halt
Status Halt(bool clear_thread_plans=false, bool use_run_lock=true)
Halts a running process.
Definition: Process.cpp:3088
lldb_private::CommandInterpreter::GetIOHandler
lldb::IOHandlerSP GetIOHandler(bool force_create=false, CommandInterpreterRunOptions *options=nullptr)
Language.h
lldb::eReturnStatusInvalid
@ eReturnStatusInvalid
Definition: lldb-enumerations.h:259
lldb_private::CommandInterpreter::GetStopCmdSourceOnError
bool GetStopCmdSourceOnError() const
Definition: CommandInterpreter.cpp:224
lldb_private::CommandInterpreter::SourceInitFileHome
void SourceInitFileHome(CommandReturnObject &result, bool is_repl=false)
lldb_private::CommandInterpreter::OverrideExecutionContext
void OverrideExecutionContext(const ExecutionContext &override_context)
lldb::eExpressionTimedOut
@ eExpressionTimedOut
Definition: lldb-enumerations.h:277
lldb_private::LazyBool
LazyBool
Definition: lldb-private-enumerations.h:115
lldb::eCommandInterpreterResultSuccess
@ eCommandInterpreterResultSuccess
Command interpreter finished successfully.
Definition: lldb-enumerations.h:1124
lldb_private::CommandInterpreterRunOptions::m_stop_on_error
LazyBool m_stop_on_error
Definition: CommandInterpreter.h:184
CommandObjectExpression.h
lldb_private::CommandInterpreter::GetPythonCommandsFromIOHandler
void GetPythonCommandsFromIOHandler(const char *prompt, IOHandlerDelegate &delegate, void *baton=nullptr)
lldb_private::CommandInterpreter::ProcessEmbeddedScriptCommands
const char * ProcessEmbeddedScriptCommands(const char *arg)
Definition: CommandInterpreter.cpp:484
CommandReturnObject.h
lldb_private::FileSpec::CopyByRemovingLastPathComponent
FileSpec CopyByRemovingLastPathComponent() const
Definition: FileSpec.cpp:406
lldb_private::CommandInterpreter::SetPromptOnQuit
void SetPromptOnQuit(bool enable)
Definition: CommandInterpreter.cpp:147
Debugger.h
lldb_private::CommandInterpreterRunOptions
Definition: CommandInterpreter.h:59
lldb_private::Target
Definition: Target.h:450
lldb_private::CommandReturnObject::AppendErrorWithFormatv
void AppendErrorWithFormatv(const char *format, Args &&... args)
Definition: CommandReturnObject.h:129
lldb_private::Debugger::GetScriptInterpreter
ScriptInterpreter * GetScriptInterpreter(bool can_create=true, llvm::Optional< lldb::ScriptLanguage > language={})
Definition: Debugger.cpp:1275
lldb_private::CommandObjectExpression
Definition: CommandObjectExpression.h:22
lldb_private::CommandInterpreter::m_command_source_flags
std::vector< uint32_t > m_command_source_flags
Definition: CommandInterpreter.h:708
lldb_private::CommandInterpreter::RemoveUserMultiword
bool RemoveUserMultiword(llvm::StringRef multiword_name)
CommandObjectTrace.h
lldb_private::StreamString::GetString
llvm::StringRef GetString() const
Definition: StreamString.cpp:51
lldb_private::CommandInterpreter::RunCommandInterpreter
CommandInterpreterRunResult RunCommandInterpreter(CommandInterpreterRunOptions &options)
lldb_private::Process::GetState
lldb::StateType GetState()
Get accessor for the current process state.
Definition: Process.cpp:1295
lldb_private::CommandInterpreter::GetSaveSessionDirectory
FileSpec GetSaveSessionDirectory() const
Definition: CommandInterpreter.cpp:163
lldb_private::CommandInterpreter::AllowExitCodeOnQuit
void AllowExitCodeOnQuit(bool allow)
Specify if the command interpreter should allow that the user can specify a custom exit code when cal...
Definition: CommandInterpreter.cpp:195
Process.h
lldb_private::CommandInterpreter::eBroadcastBitQuitCommandReceived
@ eBroadcastBitQuitCommandReceived
Definition: CommandInterpreter.h:221
lldb_private::CommandInterpreter::GetSpaceReplPrompts
bool GetSpaceReplPrompts() const
Definition: CommandInterpreter.cpp:230
lldb_private::StringList::GetSize
size_t GetSize() const
Definition: StringList.cpp:68
CommandObjectRegister.h
lldb::eReturnStatusSuccessFinishNoResult
@ eReturnStatusSuccessFinishNoResult
Definition: lldb-enumerations.h:260
lldb_private::CommandInterpreter::CommandHandlingState::eIdle
@ eIdle
lldb::eStateStopped
@ eStateStopped
Process or thread is stopped and can be examined.
Definition: lldb-enumerations.h:84
lldb_private::IOHandlerDelegate::Completion
Completion
Definition: IOHandler.h:197
lldb_private::Properties
Definition: UserSettingsController.h:33
lldb_private::Target::GetPlatform
lldb::PlatformSP GetPlatform()
Definition: Target.h:1341
lldb_private::File::eOpenOptionTruncate
@ eOpenOptionTruncate
Definition: File.h:55
lldb_private::File::eOpenOptionCanCreate
@ eOpenOptionCanCreate
Definition: File.h:54
lldb_private::FileSpec
Definition: FileSpec.h:56
lldb_private::CommandObjectMultiword
Definition: CommandObjectMultiword.h:19
error
static llvm::raw_ostream & error(Stream &strm)
Definition: CommandReturnObject.cpp:17
Options.h
lldb_private::CommandInterpreter::GetUserCommandObject
CommandObject * GetUserCommandObject(llvm::StringRef cmd, StringList *matches=nullptr, StringList *descriptions=nullptr) const
InitFileWarning
static constexpr const char * InitFileWarning
Definition: CommandInterpreter.cpp:91
lldb_private::StreamString::GetSize
size_t GetSize() const
Definition: StreamString.cpp:38
CommandObjectFrame.h
lldb_private::CommandObjectMultiwordBreakpoint
Definition: CommandObjectBreakpoint.h:19
TargetList.h
lldb_private::CommandObject::GetAsMultiwordCommand
virtual CommandObjectMultiword * GetAsMultiwordCommand()
Definition: CommandObject.h:152
lldb_private::PlatformList::GetSelectedPlatform
lldb::PlatformSP GetSelectedPlatform()
Select the active platform.
Definition: Platform.h:984
lldb_private::Options
Definition: Options.h:57
lldb_private::StringList::GetStringAtIndex
const char * GetStringAtIndex(size_t idx) const
Definition: StringList.cpp:80
lldb_private::CommandObjectApropos
Definition: CommandObjectApropos.h:19
CommandObjectGUI.h
lldb_private::CommandCompletions::eSourceFileCompletion
@ eSourceFileCompletion
Definition: CommandCompletions.h:29
lldb::eStopReasonProcessorTrace
@ eStopReasonProcessorTrace
Definition: lldb-enumerations.h:251
lldb_private::CommandInterpreter::HandleCompletion
void HandleCompletion(CompletionRequest &request)
lldb_private::Stream::Indent
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition: Stream.cpp:130
lldb_private::CommandInterpreter::InterruptCommand
bool InterruptCommand()
lldb_private::IOHandlerConfirm::GetResponse
bool GetResponse() const
Definition: IOHandler.h:457
lldb_private::CommandInterpreter::GetUserCommands
const CommandObject::CommandMap & GetUserCommands() const
Definition: CommandInterpreter.h:552
CommandObjectPlugin.h
lldb_private::CommandInterpreter::RemoveCommand
bool RemoveCommand(llvm::StringRef cmd)
lldb_private::CommandReturnObject::GetInteractive
bool GetInteractive() const
Definition: CommandReturnObject.cpp:156
Log.h
lldb_private::CommandObjectMultiwordProcess
Definition: CommandObjectProcess.h:18
Args.h
lldb_private::CommandInterpreter::IOHandlerInterrupt
bool IOHandlerInterrupt(IOHandler &io_handler) override
lldb_private::Debugger::GetOutputFile
File & GetOutputFile()
Definition: Debugger.h:169
lldb_private::CommandInterpreter::AddAlias
CommandAlias * AddAlias(llvm::StringRef alias_name, lldb::CommandObjectSP &command_obj_sp, llvm::StringRef args_string=llvm::StringRef())
lldb_private::CommandInterpreterRunOptions::SetStopOnContinue
void SetStopOnContinue(bool stop_on_continue)
Definition: CommandInterpreter.h:121
lldb_private::CommandObjectLanguage
Definition: CommandObjectLanguage.h:15
lldb_private::CommandObjectQuit
Definition: CommandObjectQuit.h:18
lldb_private::CommandInterpreter::m_command_history
CommandHistory m_command_history
Definition: CommandInterpreter.h:692
lldb_private::Args::SetArguments
void SetArguments(size_t argc, const char **argv)
Sets the argument vector value, optionally copying all arguments into an internal buffer.
Definition: Args.cpp:353
UnixSignals.h
lldb_private::CommandObject::GetRepeatCommand
virtual const char * GetRepeatCommand(Args &current_command_args, uint32_t index)
Get the command that appropriate for a "repeat" of the current command.
Definition: CommandObject.h:289
lldb::eExpressionDiscarded
@ eExpressionDiscarded
Definition: lldb-enumerations.h:274
lldb_private::CommandReturnObject::SetStatus
void SetStatus(lldb::ReturnStatus status)
Definition: CommandReturnObject.cpp:121
lldb_private::CommandInterpreter::SetQuitExitCode
LLVM_NODISCARD bool SetQuitExitCode(int exit_code)
Sets the exit code for the quit command.
Definition: CommandInterpreter.cpp:201
lldb_private::CommandInterpreter::Confirm
bool Confirm(llvm::StringRef message, bool default_answer)
lldb_private::IOHandler::GetFlags
Flags & GetFlags()
Definition: IOHandler.h:143
lldb_private::CommandInterpreter::GetQuitExitCode
int GetQuitExitCode(bool &exited) const
Returns the exit code that the user has specified when running the 'quit' command.
Definition: CommandInterpreter.cpp:208
lldb_private::CompletionMode::RewriteLine
@ RewriteLine
The full line has been rewritten by the completion.
lldb::eReturnStatusStarted
@ eReturnStatusStarted
Definition: lldb-enumerations.h:264
lldb_private::StreamString::Clear
void Clear()
Definition: StreamString.cpp:31
lldb_private::StreamString::GetData
const char * GetData() const
Definition: StreamString.h:43
lldb::eExpressionCompleted
@ eExpressionCompleted
Definition: lldb-enumerations.h:271
lldb_private::CommandReturnObject::GetImmediateErrorStream
lldb::StreamSP GetImmediateErrorStream()
Definition: CommandReturnObject.h:95
lldb_private::IOHandler::GetIsInteractive
bool GetIsInteractive()
Check if the input is being supplied interactively by a user.
Definition: IOHandler.cpp:112
lldb_private::CommandInterpreterRunOptions::GetStopOnContinue
bool GetStopOnContinue() const
Definition: CommandInterpreter.h:119
lldb_private::Status::SetErrorStringWithFormat
int SetErrorStringWithFormat(const char *format,...) __attribute__((format(printf
Set the current error string to a formatted error string.
Definition: Status.cpp:256
lldb_private::OptionValueProperties
Definition: OptionValueProperties.h:23
lldb::eStopReasonInstrumentation
@ eStopReasonInstrumentation
Definition: lldb-enumerations.h:250
lldb_private::CommandInterpreterRunOptions::GetPrintResults
bool GetPrintResults() const
Definition: CommandInterpreter.h:151
lldb_private::IOHandlerConfirm
Definition: IOHandler.h:450
lldb_private::CommandReturnObject::GetOutputStream
Stream & GetOutputStream()
Definition: CommandReturnObject.h:45
lldb_private::CommandInterpreter::GetEchoCommentCommands
bool GetEchoCommentCommands() const
Definition: CommandInterpreter.cpp:184
lldb_private::Debugger::GetTerminalWidth
uint32_t GetTerminalWidth() const
Definition: Debugger.cpp:318
lldb_private::CommandInterpreter::LoadCommandDictionary
void LoadCommandDictionary()
Definition: CommandInterpreter.cpp:500
lldb_private::CommandInterpreter::SourceInitFileCwd
void SourceInitFileCwd(CommandReturnObject &result)
Property.h
lldb_private::StringList
Definition: StringList.h:25
lldb_private::ConstString
Definition: ConstString.h:40
lldb_private::CommandInterpreter::HasUserMultiwordCommands
bool HasUserMultiwordCommands() const
lldb_private::CommandInterpreter::Initialize
void Initialize()
Definition: CommandInterpreter.cpp:242
lldb_private::OptionParser::eOptionalArgument
@ eOptionalArgument
Definition: OptionParser.h:35
lldb_private::StreamString
Definition: StreamString.h:23
lldb_private::CommandObject::CommandMap
std::map< std::string, lldb::CommandObjectSP > CommandMap
Definition: CommandObject.h:110
lldb_private::CommandInterpreter::ResolveCommand
void ResolveCommand(const char *command_line, CommandReturnObject &result)
Definition: CommandInterpreter.cpp:215
lldb_private::CommandObjectGUI
Definition: CommandObjectGUI.h:18
lldb_private::IOHandler
Definition: IOHandler.h:46
lldb_private::Args::entries
llvm::ArrayRef< ArgEntry > entries() const
Definition: Args.h:130
lldb_private::CommandObjectPlugin
Definition: CommandObjectPlugin.h:16
lldb_private::CommandObject::GetCommandName
llvm::StringRef GetCommandName() const
Definition: CommandObject.cpp:80
Timer.h
lldb_private::CommandInterpreter::GetEchoCommands
bool GetEchoCommands() const
Definition: CommandInterpreter.cpp:173
lldb_private::CommandObjectVersion
Definition: CommandObjectVersion.h:18
lldb_private::CommandHistory::g_repeat_char
static const char g_repeat_char
Definition: CommandHistory.h:46
lldb_private::EvaluateExpressionOptions::SetTryAllThreads
void SetTryAllThreads(bool try_others=true)
Definition: Target.h:338
lldb_private::GetLogIfAllCategoriesSet
Log * GetLogIfAllCategoriesSet(uint32_t mask)
Definition: Logging.cpp:58
lldb_private::CommandObject::GetOptions
virtual Options * GetOptions()
Definition: CommandObject.cpp:98
lldb_private::CommandInterpreter::m_command_dict
CommandObject::CommandMap m_command_dict
Definition: CommandInterpreter.h:684
Editline.h
lldb_private::CommandInterpreter::PreprocessCommand
Status PreprocessCommand(std::string &command)
lldb_private::CommandReturnObject::GetImmediateOutputStream
lldb::StreamSP GetImmediateOutputStream()
Definition: CommandReturnObject.h:91
lldb_private::Debugger::GetInputFileSP
lldb::FileSP GetInputFileSP()
Definition: Debugger.h:161
lldb_private::CommandInterpreterRunOptions::m_echo_commands
LazyBool m_echo_commands
Definition: CommandInterpreter.h:186
lldb_private::CommandInterpreter
Definition: CommandInterpreter.h:214
lldb_private::Broadcaster::Event
friend class Event
Definition: Broadcaster.h:244
LLDB_SCOPED_TIMER
#define LLDB_SCOPED_TIMER()
Definition: Timer.h:83
lldb_private::CommandInterpreter::AliasExists
bool AliasExists(llvm::StringRef cmd) const
Determine whether an alias command with this name exists.
lldb_private::CommandObjectMultiwordCommands
Definition: CommandObjectCommands.h:19
lldb::eReturnStatusFailed
@ eReturnStatusFailed
Definition: lldb-enumerations.h:265
CommandObjectRegexCommand.h
lldb_private::CommandInterpreterRunResult::IncrementNumberOfErrors
void IncrementNumberOfErrors()
Definition: CommandInterpreter.h:49
lldb_private::CommandInterpreter::AddUserCommand
Status AddUserCommand(llvm::StringRef name, const lldb::CommandObjectSP &cmd_sp, bool can_replace)
lldb_private::EventDataBytes
Definition: Event.h:56
lldb_private::File::eOpenOptionReadOnly
@ eOpenOptionReadOnly
Definition: File.h:49
lldb_private::Debugger
Definition: Debugger.h:70
CommandObjectThread.h
HostInfo.h
lldb_private::eLoadCWDlldbinitWarn
@ eLoadCWDlldbinitWarn
Definition: Target.h:57
lldb_private::CommandInterpreter::HasAliases
bool HasAliases() const
lldb_private::CommandInterpreter::CommandExists
bool CommandExists(llvm::StringRef cmd) const
Determine whether a root level, built-in command with this name exists.
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:40
lldb_private::CompletionRequest::AddCompletions
void AddCompletions(const StringList &completions)
Adds multiple possible completion strings.
Definition: CompletionRequest.h:196
lldb_private::FileSystem::Resolve
void Resolve(llvm::SmallVectorImpl< char > &path)
Resolve path to make it canonical.
Definition: common/FileSystem.cpp:255
lldb_private::eLoadCWDlldbinitTrue
@ eLoadCWDlldbinitTrue
Definition: Target.h:55
lldb_private::CommandInterpreter::WasInterrupted
bool WasInterrupted() const
lldb_private::EvaluateExpressionOptions::SetUnwindOnError
void SetUnwindOnError(bool unwind=false)
Definition: Target.h:305
lldb_private::EvaluateExpressionOptions::SetKeepInMemory
void SetKeepInMemory(bool keep=true)
Definition: Target.h:315
CommandObjectReproducer.h
lldb::eReturnStatusSuccessContinuingNoResult
@ eReturnStatusSuccessContinuingNoResult
Definition: lldb-enumerations.h:262
Thread.h
lldb_private::CommandInterpreter::m_result
CommandInterpreterRunResult m_result
Definition: CommandInterpreter.h:709
lldb_private::Stream::PutChar
size_t PutChar(char ch)
Definition: Stream.cpp:104
lldb_private::CommandAlias::SetHelp
void SetHelp(llvm::StringRef str) override
Definition: CommandAlias.cpp:221
lldb_private::CommandInterpreterRunResult::IsResult
bool IsResult(lldb::CommandInterpreterResult result)
Definition: CommandInterpreter.h:42
lldb::eExpressionInterrupted
@ eExpressionInterrupted
Definition: lldb-enumerations.h:275
lldb_private::Debugger::FlushProcessOutput
void FlushProcessOutput(Process &process, bool flush_stdout, bool flush_stderr)
Definition: Debugger.cpp:1345
k_white_space
static const char * k_white_space
Definition: CommandInterpreter.cpp:89
lldb_private::CommandInterpreterRunOptions::m_print_results
LazyBool m_print_results
Definition: CommandInterpreter.h:188
lldb_private::CommandInterpreterRunOptions::GetSpawnThread
bool GetSpawnThread() const
Definition: CommandInterpreter.h:177
OptionValueProperties.h
lldb_private::CommandObjectLog
Definition: CommandObjectLog.h:18
lldb_private::CommandInterpreter::m_command_source_dirs
std::vector< FileSpec > m_command_source_dirs
A stack of directory paths.
Definition: CommandInterpreter.h:707
lldb_private::CommandObjectRegexCommand
Definition: CommandObjectRegexCommand.h:22
lldb_private::CommandInterpreter::m_command_state
std::atomic< CommandHandlingState > m_command_state
Definition: CommandInterpreter.h:667
lldb_private::Options::SupportsLongOption
bool SupportsLongOption(const char *long_option)
Definition: Options.cpp:325
lldb_private::Language::GetLanguagesSupportingREPLs
static LanguageSet GetLanguagesSupportingREPLs()
Definition: Language.cpp:366
lldb::eExpressionHitBreakpoint
@ eExpressionHitBreakpoint
Definition: lldb-enumerations.h:276
lldb_private::CommandInterpreter::HandleCompletionMatches
void HandleCompletionMatches(CompletionRequest &request)
lldb_private::CommandObject
Definition: CommandObject.h:67
lldb_private::CommandAlias
Definition: CommandAlias.h:20
lldb_private::EvaluateExpressionOptions::SetIgnoreBreakpoints
void SetIgnoreBreakpoints(bool ignore=false)
Definition: Target.h:309
lldb_private::OptionArgVector
std::vector< std::tuple< std::string, int, std::string > > OptionArgVector
Definition: Options.h:26
lldb_private::CommandAlias::SetHelpLong
void SetHelpLong(llvm::StringRef str) override
Definition: CommandAlias.cpp:226
lldb_private::CommandObject::IsAlias
virtual bool IsAlias()
Definition: CommandObject.h:154
StreamFile.h
lldb_private::IOHandler::SetIsDone
virtual void SetIsDone(bool b)
Definition: IOHandler.h:90
CommandObjectSession.h
lldbassert
#define lldbassert(x)
Definition: LLDBAssert.h:15
lldb_private::CommandObjectMultiwordThread
Definition: CommandObjectThread.h:16
lldb_private::CommandInterpreter::BuildAliasResult
CommandObject * BuildAliasResult(llvm::StringRef alias_name, std::string &raw_input_string, std::string &alias_result, CommandReturnObject &result)
lldb_private::Broadcaster::BroadcastEvent
void BroadcastEvent(lldb::EventSP &event_sp)
Broadcast an event which has no associated data.
Definition: Broadcaster.h:262
lldb_private::CommandObjectPlatform
Definition: CommandObjectPlatform.h:18
lldb_private::CommandInterpreter::FindCommandsForApropos
void FindCommandsForApropos(llvm::StringRef word, StringList &commands_found, StringList &commands_help, bool search_builtin_commands, bool search_user_commands, bool search_alias_commands, bool search_user_mw_commands)
lldb::eStopReasonSignal
@ eStopReasonSignal
Definition: lldb-enumerations.h:245
lldb_private::Debugger::IsTopIOHandler
bool IsTopIOHandler(const lldb::IOHandlerSP &reader_sp)
Definition: Debugger.cpp:930
lldb_private::File::eOpenOptionWriteOnly
@ eOpenOptionWriteOnly
Definition: File.h:50
lldb_private::CommandInterpreter::PrintCommandOutput
void PrintCommandOutput(Stream &stream, llvm::StringRef str)
lldb_private::File::Printf
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: File.cpp:209
lldb_private::AddNamesMatchingPartialString
int AddNamesMatchingPartialString(const std::map< std::string, ValueType > &in_map, llvm::StringRef cmd_str, StringList &matches, StringList *descriptions=nullptr)
Definition: CommandObject.h:35
lldb_private::CommandInterpreter::UserCommandExists
bool UserCommandExists(llvm::StringRef cmd) const
Determine whether a root-level user command with this name exists.
lldb_private::Status
Definition: Status.h:44
lldb_private::Args::GetArgumentAtIndex
const char * GetArgumentAtIndex(size_t idx) const
Gets the NULL terminated C string argument pointer for the argument at index idx.
Definition: Args.cpp:259
lldb_private::TargetProperties::GetLoadCWDlldbinitFile
LoadCWDlldbinitFile GetLoadCWDlldbinitFile() const
Definition: Target.cpp:4224
lldb_private::CommandInterpreter::ResolveCommandImpl
CommandObject * ResolveCommandImpl(std::string &command_line, CommandReturnObject &result)
lldb_private::CommandObjectMultiword::GetSubcommandSPExact
lldb::CommandObjectSP GetSubcommandSPExact(llvm::StringRef sub_cmd) override
Definition: CommandObjectMultiword.cpp:30
lldb::eLanguageTypeUnknown
@ eLanguageTypeUnknown
Unknown or invalid language value.
Definition: lldb-enumerations.h:437
lldb_private::CommandReturnObject
Definition: CommandReturnObject.h:25
lldb_private::CommandInterpreterRunOptions::SetSilent
void SetSilent(bool silent)
Definition: CommandInterpreter.h:105
lldb_private::CommandInterpreter::UserMultiwordCommandExists
bool UserMultiwordCommandExists(llvm::StringRef cmd) const
Determine whether a root-level user multiword command with this name exists.
message
message(FATAL_ERROR "invalid libipt include path provided") endif() include_directories($
Definition: Plugins/Trace/intel-pt/CMakeLists.txt:6
uint32_t
lldb_private::eLazyBoolNo
@ eLazyBoolNo
Definition: lldb-private-enumerations.h:115
lldb::eCommandInterpreterResultCommandError
@ eCommandInterpreterResultCommandError
Stopped because the corresponding option was set and a command returned an error.
Definition: lldb-enumerations.h:1130
lldb_private::EvaluateExpressionOptions::SetCoerceToId
void SetCoerceToId(bool coerce=true)
Definition: Target.h:301
lldb_private::CommandInterpreter::GetDebugger
Debugger & GetDebugger()
Definition: CommandInterpreter.h:436
lldb_private::CommandInterpreter::m_skip_lldbinit_files
bool m_skip_lldbinit_files
Definition: CommandInterpreter.h:682
lldb_private::CommandInterpreter::SetBatchCommandMode
bool SetBatchCommandMode(bool value)
Definition: CommandInterpreter.h:491
lldb_private::CommandInterpreterRunOptions::GetEchoCommands
bool GetEchoCommands() const
Definition: CommandInterpreter.h:137
lldb_private::Stream::IndentMore
void IndentMore(unsigned amount=2)
Increment the current indentation level.
Definition: Stream.cpp:168
lldb::eReturnStatusSuccessFinishResult
@ eReturnStatusSuccessFinishResult
Definition: lldb-enumerations.h:261
lldb_private::CommandObject::IsMultiwordObject
virtual bool IsMultiwordObject()
Definition: CommandObject.h:146
lldb_private::CommandReturnObject::GetErrorData
llvm::StringRef GetErrorData()
Definition: CommandReturnObject.h:38
lldb_private::CommandInterpreter::GetUserMultiwordCommands
const CommandObject::CommandMap & GetUserMultiwordCommands() const
Definition: CommandInterpreter.h:556
lldb_private::CommandInterpreter::eCommandTypesUserMW
@ eCommandTypesUserMW
Definition: CommandInterpreter.h:236
lldb_private::CommandInterpreter::SetEchoCommentCommands
void SetEchoCommentCommands(bool enable)
Definition: CommandInterpreter.cpp:190
lldb_private::Debugger::GetErrorStreamSP
lldb::StreamFileSP GetErrorStreamSP()
Definition: Debugger.h:165
lldb_private::CommandInterpreter::GetSaveSessionOnQuit
bool GetSaveSessionOnQuit() const
Definition: CommandInterpreter.cpp:152
lldb_private::CommandInterpreter::HasAliasOptions
bool HasAliasOptions() const
lldb_private::Debugger::GetPlatformList
PlatformList & GetPlatformList()
Definition: Debugger.h:225
lldb_private::CommandInterpreter::HandleCommandsFromFile
void HandleCommandsFromFile(FileSpec &file, const ExecutionContext &context, const CommandInterpreterRunOptions &options, CommandReturnObject &result)
Execute a list of commands from a file.
lldb_private::Target::EvaluateExpression
lldb::ExpressionResults EvaluateExpression(llvm::StringRef expression, ExecutionContextScope *exe_scope, lldb::ValueObjectSP &result_valobj_sp, const EvaluateExpressionOptions &options=EvaluateExpressionOptions(), std::string *fixed_expression=nullptr, ValueObject *ctx_obj=nullptr)
Definition: Target.cpp:2384
lldb_private::FindLongestCommandWord
size_t FindLongestCommandWord(std::map< std::string, ValueType > &dict)
Definition: CommandObject.h:55
lldb_private::CommandObject::HandleCompletion
virtual void HandleCompletion(CompletionRequest &request)
This default version handles calling option argument completions and then calls HandleArgumentComplet...
Definition: CommandObject.cpp:273
CommandObjectApropos.h
lldb_private::Stream::EOL
size_t EOL()
Output and End of Line character to the stream.
Definition: Stream.cpp:128
lldb_private::CommandInterpreter::IsActive
bool IsActive()
lldb_private::CommandInterpreterRunOptions::m_print_errors
LazyBool m_print_errors
Definition: CommandInterpreter.h:189
lldb_private::CommandInterpreter::DidProcessStopAbnormally
bool DidProcessStopAbnormally() const
lldb_private::Args::Unshift
void Unshift(llvm::StringRef arg_str, char quote_char='\0')
Inserts a class owned copy of arg_str at the beginning of the argument vector.
Definition: Args.cpp:289
CommandObjectScript.h
lldb_private::CommandReturnObject::AppendMessageWithFormat
void AppendMessageWithFormat(const char *format,...) __attribute__((format(printf
Definition: CommandReturnObject.cpp:64
lldb_private::Status::SetErrorString
void SetErrorString(llvm::StringRef err_str)
Set the current error string to err_str.
Definition: Status.cpp:242
lldb_private::CommandInterpreter::m_repeat_command
std::string m_repeat_command
Definition: CommandInterpreter.h:693
lldb_private::CompletionRequest::ShiftArguments
void ShiftArguments()
Drops the first argument from the argument list.
Definition: CompletionRequest.h:143
CommandObjectTarget.h
lldb_private::CommandInterpreter::EchoCommandNonInteractive
bool EchoCommandNonInteractive(llvm::StringRef line, const Flags &io_handler_flags) const
lldb_private::CommandInterpreter::m_allow_exit_code
bool m_allow_exit_code
Definition: CommandInterpreter.h:715
lldb_private::StringList::DeleteStringAtIndex
void DeleteStringAtIndex(size_t id)
Definition: StringList.cpp:141
lldb_private::CommandInterpreter::Clear
void Clear()
Definition: CommandInterpreter.cpp:480
lldb_private::eLoadCWDlldbinitFalse
@ eLoadCWDlldbinitFalse
Definition: Target.h:56
lldb_private::CommandHistory::GetStringAtIndex
llvm::StringRef GetStringAtIndex(size_t idx) const
Definition: CommandHistory.cpp:60
lldb_private::CommandObject::SetSyntax
void SetSyntax(llvm::StringRef str)
Definition: CommandObject.cpp:94
lldb_private::CommandInterpreter::eCommandTypesHidden
@ eCommandTypesHidden
Definition: CommandInterpreter.h:238
StopInfo.h
lldb_private::CommandObjectMultiwordWatchpoint
Definition: CommandObjectWatchpoint.h:19
lldb_private::CommandInterpreterRunOptions::GetStopOnCrash
bool GetStopOnCrash() const
Definition: CommandInterpreter.h:131
lldb_private::CommandReturnObject::Succeeded
bool Succeeded()
Definition: CommandReturnObject.cpp:125
CommandObjectSettings.h
lldb_private::CommandInterpreter::FinishHandlingCommand
void FinishHandlingCommand()
PluginManager.h
lldb_private::CommandInterpreter::GetRepeatPreviousCommand
bool GetRepeatPreviousCommand() const
Definition: CommandInterpreter.cpp:236
lldb_private::CommandInterpreter::HasUserCommands
bool HasUserCommands() const
lldb::eCommandInterpreterResultInferiorCrash
@ eCommandInterpreterResultInferiorCrash
Stopped because the corresponding option was set and the inferior crashed.
Definition: lldb-enumerations.h:1127
lldb_private::ScriptInterpreter
Definition: ScriptInterpreter.h:126
LLDB_LOG
#define LLDB_LOG(log,...)
The LLDB_LOG* macros defined below are the way to emit log messages.
Definition: Log.h:242
lldb_private::CommandInterpreterRunOptions::m_add_to_history
LazyBool m_add_to_history
Definition: CommandInterpreter.h:190
lldb_private::Stream::Printf
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:107
lldb_private::CommandInterpreter::BuildAliasCommandArgs
void BuildAliasCommandArgs(CommandObject *alias_cmd_obj, const char *alias_name, Args &cmd_args, std::string &raw_input_string, CommandReturnObject &result)
lldb_private::Debugger::GetUseColor
bool GetUseColor() const
Definition: Debugger.cpp:343
lldb_private::FileSystem::Instance
static FileSystem & Instance()
Definition: common/FileSystem.cpp:45
lldb_private::Target::GetGlobalProperties
static TargetProperties & GetGlobalProperties()
Definition: Target.cpp:2762
lldb_private::CommandReturnObject::AppendErrorWithFormat
void AppendErrorWithFormat(const char *format,...) __attribute__((format(printf
Definition: CommandReturnObject.cpp:46
lldb_private::CommandInterpreter::GetCommandNamesMatchingPartialString
int GetCommandNamesMatchingPartialString(const char *cmd_cstr, bool include_aliases, StringList &matches, StringList &descriptions)
lldb_private::IOHandlerDelegate
A delegate class for use with IOHandler subclasses.
Definition: IOHandler.h:195
lldb_private::CompletionRequest::GetCursorIndex
size_t GetCursorIndex() const
Definition: CompletionRequest.h:156
lldb_private::FileSpec::AppendPathComponent
void AppendPathComponent(llvm::StringRef component)
Definition: FileSpec.cpp:435
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
CommandObjectProcess.h
lldb_private::CommandObjectSession
Definition: CommandObjectSession.h:16
lldb_private::CommandInterpreter::GetAlias
const CommandAlias * GetAlias(llvm::StringRef alias_name) const
lldb_private::eLazyBoolCalculate
@ eLazyBoolCalculate
Definition: lldb-private-enumerations.h:115
lldb_private::CommandAlias::GetOptionArguments
OptionArgVectorSP GetOptionArguments() const
Definition: CommandAlias.h:64
lldb_private::CommandInterpreter::UpdatePrompt
void UpdatePrompt(llvm::StringRef prompt)
lldb_private::CommandInterpreter::CommandHandlingState::eInProgress
@ eInProgress
lldb_private::Debugger::GetAsyncExecution
bool GetAsyncExecution()
Definition: Debugger.cpp:803
lldb_private::CommandInterpreter::m_command_source_depth
uint32_t m_command_source_depth
Definition: CommandInterpreter.h:704
lldb_private::CommandInterpreter::m_transcript_stream
StreamString m_transcript_stream
Definition: CommandInterpreter.h:717
CommandObjectCommands.h
lldb_private::CommandObjectMultiwordSettings
Definition: CommandObjectSettings.h:18
lldb_private::CommandInterpreter::m_quit_exit_code
llvm::Optional< int > m_quit_exit_code
Definition: CommandInterpreter.h:713
lldb_private::CompletionRequest::AddCompletion
void AddCompletion(llvm::StringRef completion, llvm::StringRef description="", CompletionMode mode=CompletionMode::Normal)
Adds a possible completion string.
Definition: CompletionRequest.h:167
lldb_private::IOHandler::Type::CommandInterpreter
@ CommandInterpreter
lldb_private::CommandInterpreter::GetExpandRegexAliases
bool GetExpandRegexAliases() const
Definition: CommandInterpreter.cpp:135
lldb_private::Status::Clear
void Clear()
Clear the object state.
Definition: Status.cpp:168
lldb_private::Stream::Write
size_t Write(const void *src, size_t src_len)
Output character bytes to the stream.
Definition: Stream.h:101
CommandInterpreter.h
lldb_private::CommandInterpreter::GetExecutionContext
ExecutionContext GetExecutionContext() const
lldb::eReturnStatusQuit
@ eReturnStatusQuit
Definition: lldb-enumerations.h:266
lldb_private::Debugger::SetAsyncExecution
void SetAsyncExecution(bool async)
Definition: Debugger.cpp:807
State.h
lldb_private::CommandObjectMemory
Definition: CommandObjectMemory.h:16
lldb_private::LanguageSet
A SmallBitVector that represents a set of source languages (lldb::LanguageType).
Definition: TypeSystem.h:40
CommandObjectStats.h
lldb_private::CommandInterpreter::GetCurrentSourceDir
FileSpec GetCurrentSourceDir()
lldb_private::CommandInterpreter::m_overriden_exe_contexts
std::stack< ExecutionContext > m_overriden_exe_contexts
Definition: CommandInterpreter.h:680
lldb_private::Properties::m_collection_sp
lldb::OptionValuePropertiesSP m_collection_sp
Definition: UserSettingsController.h:86
lldb::eExpressionParseError
@ eExpressionParseError
Definition: lldb-enumerations.h:273
lldb::StateType
StateType
Process and Thread States.
Definition: lldb-enumerations.h:73
Stream.h
lldb_private::Log
Definition: Log.h:49
lldb_private::Stream::PutCString
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:63
lldb_private::IOHandler::Type::CommandList
@ CommandList
llvm::SmallVectorImpl
Definition: Disassembler.h:42
lldb_private::CommandInterpreter::GetCommandSPExact
lldb::CommandObjectSP GetCommandSPExact(llvm::StringRef cmd, bool include_aliases=false) const
lldb_private::CommandInterpreterRunOptions::SetStopOnError
void SetStopOnError(bool stop_on_error)
Definition: CommandInterpreter.h:127
CommandObjectLog.h
lldb_private::CommandInterpreter::OutputFormattedHelpText
void OutputFormattedHelpText(Stream &strm, llvm::StringRef prefix, llvm::StringRef help_text)
lldb_private::CommandInterpreter::eCommandTypesBuiltin
@ eCommandTypesBuiltin
Definition: CommandInterpreter.h:234
lldb_private::Language::GetNameForLanguageType
static const char * GetNameForLanguageType(lldb::LanguageType language)
Definition: Language.cpp:217
lldb_private::CommandInterpreter::SaveTranscript
bool SaveTranscript(CommandReturnObject &result, llvm::Optional< std::string > output_file=llvm::None)
Save the current debugger session transcript to a file on disk.
lldb_private::CommandHistory::FindString
llvm::Optional< llvm::StringRef > FindString(llvm::StringRef input_str) const
Definition: CommandHistory.cpp:27
CommandObjectPlatform.h
lldb_private::Broadcaster
Definition: Broadcaster.h:242
lldb_private::LoadCWDlldbinitFile
LoadCWDlldbinitFile
Definition: Target.h:54
lldb_private::CommandInterpreter::m_user_mw_dict
CommandObject::CommandMap m_user_mw_dict
Definition: CommandInterpreter.h:691
lldb_private::FileSpec::GetPath
size_t GetPath(char *path, size_t max_path_length, bool denormalize=true) const
Extract the full path to the file.
Definition: FileSpec.cpp:348
lldb_private::CommandReturnObject::AppendError
void void AppendError(llvm::StringRef in_string)
Definition: CommandReturnObject.cpp:100
lldb_private::CommandInterpreter::SetSaveSessionOnQuit
void SetSaveSessionOnQuit(bool enable)
Definition: CommandInterpreter.cpp:158
lldb_private::repro::Reproducer::Instance
static Reproducer & Instance()
Definition: Reproducer.cpp:23
lldb_private::Debugger::GetPrompt
llvm::StringRef GetPrompt() const
Definition: Debugger.cpp:274
REGISTER_COMMAND_OBJECT
#define REGISTER_COMMAND_OBJECT(NAME, CLASS)
Definition: CommandInterpreter.cpp:497
lldb_private::Args::GetArgumentCount
size_t GetArgumentCount() const
Gets the number of arguments left in this command object.
Definition: Args.h:118
CommandObjectSource.h
lldb_private::CommandInterpreter::GetCommandSP
lldb::CommandObjectSP GetCommandSP(llvm::StringRef cmd, bool include_aliases=true, bool exact=true, StringList *matches=nullptr, StringList *descriptions=nullptr) const
lldb_private::CommandInterpreter::SetSynchronous
void SetSynchronous(bool value)
lldb_private::CommandInterpreterRunOptions::SetPrintErrors
void SetPrintErrors(bool print_errors)
Definition: CommandInterpreter.h:159
lldb_private::CommandInterpreter::GetAutoSuggestionForCommand
llvm::Optional< std::string > GetAutoSuggestionForCommand(llvm::StringRef line)
Returns the auto-suggestion string that should be added to the given command line.
lldb_private::CommandInterpreterRunOptions::m_stop_on_crash
LazyBool m_stop_on_crash
Definition: CommandInterpreter.h:185
lldb
Definition: SBAddress.h:15
File.h
lldb_private::CommandObjectMultiwordSource
Definition: CommandObjectSource.h:19
lldb_private::CommandObjectRegister
Definition: CommandObjectRegister.h:18
lldb_private::IOHandler::GetOutputStreamFileSP
lldb::StreamFileSP GetOutputStreamFileSP()
Definition: IOHandler.cpp:108
lldb_private::FileSpec::GetFilename
ConstString & GetFilename()
Filename string get accessor.
Definition: FileSpec.cpp:341
lldb_private::CommandReturnObject::AppendMessage
void AppendMessage(llvm::StringRef in_string)
Definition: CommandReturnObject.cpp:88
lldb_private::CommandObject::WantsRawCommandString
virtual bool WantsRawCommandString()=0
lldb_private::CommandInterpreter::eBroadcastBitResetPrompt
@ eBroadcastBitResetPrompt
Definition: CommandInterpreter.h:220
CommandCompletions.h
lldb_private::CommandHistory::AppendString
void AppendString(llvm::StringRef str, bool reject_if_dupe=true)
Definition: CommandHistory.cpp:78
lldb_private::Scalar::GetValue
void GetValue(Stream *s, bool show_type) const
Definition: Scalar.cpp:155
lldb_private::IOHandler::GetErrorStreamFileSP
lldb::StreamFileSP GetErrorStreamFileSP()
Definition: IOHandler.cpp:110
lldb_private::CommandObject::GetHelp
virtual llvm::StringRef GetHelp()
Definition: CommandObject.cpp:53
lldb_private::CommandInterpreter::StartHandlingCommand
void StartHandlingCommand()
lldb_private::CompletionRequest
Definition: CompletionRequest.h:100
CommandObjectHelp.h
lldb_private::CommandReturnObject::GetDidChangeProcessState
bool GetDidChangeProcessState()
Definition: CommandReturnObject.cpp:148
lldb_private::IOHandler::GetPrompt
virtual const char * GetPrompt()
Definition: IOHandler.h:102
lldb_private::OptionArgVectorSP
std::shared_ptr< OptionArgVector > OptionArgVectorSP
Definition: Options.h:29
lldb_private::CommandInterpreter::HandleCommands
void HandleCommands(const StringList &commands, const ExecutionContext &context, const CommandInterpreterRunOptions &options, CommandReturnObject &result)
Execute a list of commands in sequence.
lldb_private::IOHandlerEditline
Definition: IOHandler.h:332
lldb::eCommandInterpreterResultQuitRequested
@ eCommandInterpreterResultQuitRequested
Stopped because quit was requested.
Definition: lldb-enumerations.h:1132
lldb_private::CommandCompletions::eSymbolCompletion
@ eSymbolCompletion
Definition: CommandCompletions.h:32
CommandObjectType.h