1 //===-- CommandInterpreter.cpp ----------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include <string> 11 #include <vector> 12 13 #include <getopt.h> 14 #include <stdlib.h> 15 16 #include "CommandObjectScript.h" 17 #include "lldb/Interpreter/CommandObjectRegexCommand.h" 18 19 #include "../Commands/CommandObjectApropos.h" 20 #include "../Commands/CommandObjectArgs.h" 21 #include "../Commands/CommandObjectBreakpoint.h" 22 #include "../Commands/CommandObjectDisassemble.h" 23 #include "../Commands/CommandObjectExpression.h" 24 #include "../Commands/CommandObjectFrame.h" 25 #include "../Commands/CommandObjectHelp.h" 26 #include "../Commands/CommandObjectLog.h" 27 #include "../Commands/CommandObjectMemory.h" 28 #include "../Commands/CommandObjectPlatform.h" 29 #include "../Commands/CommandObjectProcess.h" 30 #include "../Commands/CommandObjectQuit.h" 31 #include "../Commands/CommandObjectRegister.h" 32 #include "../Commands/CommandObjectSettings.h" 33 #include "../Commands/CommandObjectSource.h" 34 #include "../Commands/CommandObjectCommands.h" 35 #include "../Commands/CommandObjectSyntax.h" 36 #include "../Commands/CommandObjectTarget.h" 37 #include "../Commands/CommandObjectThread.h" 38 #include "../Commands/CommandObjectType.h" 39 #include "../Commands/CommandObjectVersion.h" 40 #include "../Commands/CommandObjectWatchpoint.h" 41 42 #include "lldb/Interpreter/Args.h" 43 #include "lldb/Interpreter/Options.h" 44 #include "lldb/Core/Debugger.h" 45 #include "lldb/Core/InputReader.h" 46 #include "lldb/Core/Stream.h" 47 #include "lldb/Core/Timer.h" 48 #include "lldb/Host/Host.h" 49 #include "lldb/Target/Process.h" 50 #include "lldb/Target/Thread.h" 51 #include "lldb/Target/TargetList.h" 52 #include "lldb/Utility/CleanUp.h" 53 54 #include "lldb/Interpreter/CommandReturnObject.h" 55 #include "lldb/Interpreter/CommandInterpreter.h" 56 #include "lldb/Interpreter/ScriptInterpreterNone.h" 57 #include "lldb/Interpreter/ScriptInterpreterPython.h" 58 59 using namespace lldb; 60 using namespace lldb_private; 61 62 ConstString & 63 CommandInterpreter::GetStaticBroadcasterClass () 64 { 65 static ConstString class_name ("lldb.commandInterpreter"); 66 return class_name; 67 } 68 69 CommandInterpreter::CommandInterpreter 70 ( 71 Debugger &debugger, 72 ScriptLanguage script_language, 73 bool synchronous_execution 74 ) : 75 Broadcaster (&debugger, "lldb.command-interpreter"), 76 m_debugger (debugger), 77 m_synchronous_execution (synchronous_execution), 78 m_skip_lldbinit_files (false), 79 m_skip_app_init_files (false), 80 m_script_interpreter_ap (), 81 m_comment_char ('#'), 82 m_repeat_char ('!'), 83 m_batch_command_mode (false), 84 m_truncation_warning(eNoTruncation), 85 m_command_source_depth (0) 86 { 87 debugger.SetScriptLanguage (script_language); 88 SetEventName (eBroadcastBitThreadShouldExit, "thread-should-exit"); 89 SetEventName (eBroadcastBitResetPrompt, "reset-prompt"); 90 SetEventName (eBroadcastBitQuitCommandReceived, "quit"); 91 CheckInWithManager (); 92 } 93 94 void 95 CommandInterpreter::Initialize () 96 { 97 Timer scoped_timer (__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 98 99 CommandReturnObject result; 100 101 LoadCommandDictionary (); 102 103 // Set up some initial aliases. 104 CommandObjectSP cmd_obj_sp = GetCommandSPExact ("quit", false); 105 if (cmd_obj_sp) 106 { 107 AddAlias ("q", cmd_obj_sp); 108 AddAlias ("exit", cmd_obj_sp); 109 } 110 111 cmd_obj_sp = GetCommandSPExact ("process attach", false); 112 if (cmd_obj_sp) 113 { 114 AddAlias ("attach", cmd_obj_sp); 115 } 116 117 cmd_obj_sp = GetCommandSPExact ("process continue", false); 118 if (cmd_obj_sp) 119 { 120 AddAlias ("c", cmd_obj_sp); 121 AddAlias ("continue", cmd_obj_sp); 122 } 123 124 cmd_obj_sp = GetCommandSPExact ("_regexp-break",false); 125 if (cmd_obj_sp) 126 AddAlias ("b", cmd_obj_sp); 127 128 cmd_obj_sp = GetCommandSPExact ("thread backtrace", false); 129 if (cmd_obj_sp) 130 AddAlias ("bt", cmd_obj_sp); 131 132 cmd_obj_sp = GetCommandSPExact ("thread step-inst", false); 133 if (cmd_obj_sp) 134 { 135 AddAlias ("stepi", cmd_obj_sp); 136 AddAlias ("si", cmd_obj_sp); 137 } 138 139 cmd_obj_sp = GetCommandSPExact ("thread step-inst-over", false); 140 if (cmd_obj_sp) 141 { 142 AddAlias ("nexti", cmd_obj_sp); 143 AddAlias ("ni", cmd_obj_sp); 144 } 145 146 cmd_obj_sp = GetCommandSPExact ("thread step-in", false); 147 if (cmd_obj_sp) 148 { 149 AddAlias ("s", cmd_obj_sp); 150 AddAlias ("step", cmd_obj_sp); 151 } 152 153 cmd_obj_sp = GetCommandSPExact ("thread step-over", false); 154 if (cmd_obj_sp) 155 { 156 AddAlias ("n", cmd_obj_sp); 157 AddAlias ("next", cmd_obj_sp); 158 } 159 160 cmd_obj_sp = GetCommandSPExact ("thread step-out", false); 161 if (cmd_obj_sp) 162 { 163 AddAlias ("finish", cmd_obj_sp); 164 } 165 166 cmd_obj_sp = GetCommandSPExact ("frame select", false); 167 if (cmd_obj_sp) 168 { 169 AddAlias ("f", cmd_obj_sp); 170 } 171 172 cmd_obj_sp = GetCommandSPExact ("source list", false); 173 if (cmd_obj_sp) 174 { 175 AddAlias ("l", cmd_obj_sp); 176 AddAlias ("list", cmd_obj_sp); 177 } 178 179 cmd_obj_sp = GetCommandSPExact ("memory read", false); 180 if (cmd_obj_sp) 181 AddAlias ("x", cmd_obj_sp); 182 183 cmd_obj_sp = GetCommandSPExact ("_regexp-up", false); 184 if (cmd_obj_sp) 185 AddAlias ("up", cmd_obj_sp); 186 187 cmd_obj_sp = GetCommandSPExact ("_regexp-down", false); 188 if (cmd_obj_sp) 189 AddAlias ("down", cmd_obj_sp); 190 191 cmd_obj_sp = GetCommandSPExact ("_regexp-display", false); 192 if (cmd_obj_sp) 193 AddAlias ("display", cmd_obj_sp); 194 195 cmd_obj_sp = GetCommandSPExact ("disassemble", false); 196 if (cmd_obj_sp) 197 AddAlias ("dis", cmd_obj_sp); 198 199 cmd_obj_sp = GetCommandSPExact ("disassemble", false); 200 if (cmd_obj_sp) 201 AddAlias ("di", cmd_obj_sp); 202 203 204 205 cmd_obj_sp = GetCommandSPExact ("_regexp-undisplay", false); 206 if (cmd_obj_sp) 207 AddAlias ("undisplay", cmd_obj_sp); 208 209 cmd_obj_sp = GetCommandSPExact ("target create", false); 210 if (cmd_obj_sp) 211 AddAlias ("file", cmd_obj_sp); 212 213 cmd_obj_sp = GetCommandSPExact ("target modules", false); 214 if (cmd_obj_sp) 215 AddAlias ("image", cmd_obj_sp); 216 217 218 OptionArgVectorSP alias_arguments_vector_sp (new OptionArgVector); 219 220 cmd_obj_sp = GetCommandSPExact ("expression", false); 221 if (cmd_obj_sp) 222 { 223 AddAlias ("expr", cmd_obj_sp); 224 225 ProcessAliasOptionsArgs (cmd_obj_sp, "--", alias_arguments_vector_sp); 226 AddAlias ("p", cmd_obj_sp); 227 AddAlias ("print", cmd_obj_sp); 228 AddAlias ("call", cmd_obj_sp); 229 AddOrReplaceAliasOptions ("p", alias_arguments_vector_sp); 230 AddOrReplaceAliasOptions ("print", alias_arguments_vector_sp); 231 AddOrReplaceAliasOptions ("call", alias_arguments_vector_sp); 232 233 alias_arguments_vector_sp.reset (new OptionArgVector); 234 ProcessAliasOptionsArgs (cmd_obj_sp, "-o --", alias_arguments_vector_sp); 235 AddAlias ("po", cmd_obj_sp); 236 AddOrReplaceAliasOptions ("po", alias_arguments_vector_sp); 237 } 238 239 cmd_obj_sp = GetCommandSPExact ("process kill", false); 240 if (cmd_obj_sp) 241 AddAlias ("kill", cmd_obj_sp); 242 243 cmd_obj_sp = GetCommandSPExact ("process launch", false); 244 if (cmd_obj_sp) 245 { 246 alias_arguments_vector_sp.reset (new OptionArgVector); 247 #if defined (__arm__) 248 ProcessAliasOptionsArgs (cmd_obj_sp, "--", alias_arguments_vector_sp); 249 #else 250 ProcessAliasOptionsArgs (cmd_obj_sp, "--shell=/bin/bash --", alias_arguments_vector_sp); 251 #endif 252 AddAlias ("r", cmd_obj_sp); 253 AddAlias ("run", cmd_obj_sp); 254 AddOrReplaceAliasOptions ("r", alias_arguments_vector_sp); 255 AddOrReplaceAliasOptions ("run", alias_arguments_vector_sp); 256 } 257 258 cmd_obj_sp = GetCommandSPExact ("target symbols add", false); 259 if (cmd_obj_sp) 260 { 261 AddAlias ("add-dsym", cmd_obj_sp); 262 } 263 264 cmd_obj_sp = GetCommandSPExact ("breakpoint set", false); 265 if (cmd_obj_sp) 266 { 267 alias_arguments_vector_sp.reset (new OptionArgVector); 268 ProcessAliasOptionsArgs (cmd_obj_sp, "--func-regex %1", alias_arguments_vector_sp); 269 AddAlias ("rb", cmd_obj_sp); 270 AddOrReplaceAliasOptions("rb", alias_arguments_vector_sp); 271 } 272 } 273 274 const char * 275 CommandInterpreter::ProcessEmbeddedScriptCommands (const char *arg) 276 { 277 // This function has not yet been implemented. 278 279 // Look for any embedded script command 280 // If found, 281 // get interpreter object from the command dictionary, 282 // call execute_one_command on it, 283 // get the results as a string, 284 // substitute that string for current stuff. 285 286 return arg; 287 } 288 289 290 void 291 CommandInterpreter::LoadCommandDictionary () 292 { 293 Timer scoped_timer (__PRETTY_FUNCTION__, __PRETTY_FUNCTION__); 294 295 // **** IMPORTANT **** IMPORTANT *** IMPORTANT *** **** IMPORTANT **** IMPORTANT *** IMPORTANT *** 296 // 297 // Command objects that are used as cross reference objects (i.e. they inherit from CommandObjectCrossref) 298 // *MUST* be created and put into the command dictionary *BEFORE* any multi-word commands (which may use 299 // the cross-referencing stuff) are created!!! 300 // 301 // **** IMPORTANT **** IMPORTANT *** IMPORTANT *** **** IMPORTANT **** IMPORTANT *** IMPORTANT *** 302 303 304 // Command objects that inherit from CommandObjectCrossref must be created before other command objects 305 // are created. This is so that when another command is created that needs to go into a crossref object, 306 // the crossref object exists and is ready to take the cross reference. Put the cross referencing command 307 // objects into the CommandDictionary now, so they are ready for use when the other commands get created. 308 309 // Non-CommandObjectCrossref commands can now be created. 310 311 lldb::ScriptLanguage script_language = m_debugger.GetScriptLanguage(); 312 313 m_command_dict["apropos"] = CommandObjectSP (new CommandObjectApropos (*this)); 314 m_command_dict["breakpoint"]= CommandObjectSP (new CommandObjectMultiwordBreakpoint (*this)); 315 //m_command_dict["call"] = CommandObjectSP (new CommandObjectCall (*this)); 316 m_command_dict["command"] = CommandObjectSP (new CommandObjectMultiwordCommands (*this)); 317 m_command_dict["disassemble"] = CommandObjectSP (new CommandObjectDisassemble (*this)); 318 m_command_dict["expression"]= CommandObjectSP (new CommandObjectExpression (*this)); 319 // m_command_dict["file"] = CommandObjectSP (new CommandObjectFile (*this)); 320 m_command_dict["frame"] = CommandObjectSP (new CommandObjectMultiwordFrame (*this)); 321 m_command_dict["help"] = CommandObjectSP (new CommandObjectHelp (*this)); 322 /// m_command_dict["image"] = CommandObjectSP (new CommandObjectImage (*this)); 323 m_command_dict["log"] = CommandObjectSP (new CommandObjectLog (*this)); 324 m_command_dict["memory"] = CommandObjectSP (new CommandObjectMemory (*this)); 325 m_command_dict["platform"] = CommandObjectSP (new CommandObjectPlatform (*this)); 326 m_command_dict["process"] = CommandObjectSP (new CommandObjectMultiwordProcess (*this)); 327 m_command_dict["quit"] = CommandObjectSP (new CommandObjectQuit (*this)); 328 m_command_dict["register"] = CommandObjectSP (new CommandObjectRegister (*this)); 329 m_command_dict["script"] = CommandObjectSP (new CommandObjectScript (*this, script_language)); 330 m_command_dict["settings"] = CommandObjectSP (new CommandObjectMultiwordSettings (*this)); 331 m_command_dict["source"] = CommandObjectSP (new CommandObjectMultiwordSource (*this)); 332 m_command_dict["target"] = CommandObjectSP (new CommandObjectMultiwordTarget (*this)); 333 m_command_dict["thread"] = CommandObjectSP (new CommandObjectMultiwordThread (*this)); 334 m_command_dict["type"] = CommandObjectSP (new CommandObjectType (*this)); 335 m_command_dict["version"] = CommandObjectSP (new CommandObjectVersion (*this)); 336 m_command_dict["watchpoint"]= CommandObjectSP (new CommandObjectMultiwordWatchpoint (*this)); 337 338 std::auto_ptr<CommandObjectRegexCommand> 339 break_regex_cmd_ap(new CommandObjectRegexCommand (*this, 340 "_regexp-break", 341 "Set a breakpoint using a regular expression to specify the location.", 342 "_regexp-break [<filename>:<linenum>]\n_regexp-break [<address>]\n_regexp-break <...>", 2)); 343 if (break_regex_cmd_ap.get()) 344 { 345 if (break_regex_cmd_ap->AddRegexCommand("^(.*[^[:space:]])[[:space:]]*:[[:space:]]*([[:digit:]]+)[[:space:]]*$", "breakpoint set --file '%1' --line %2") && 346 break_regex_cmd_ap->AddRegexCommand("^(0x[[:xdigit:]]+)[[:space:]]*$", "breakpoint set --address %1") && 347 break_regex_cmd_ap->AddRegexCommand("^[\"']?([-+]\\[.*\\])[\"']?[[:space:]]*$", "breakpoint set --name '%1'") && 348 break_regex_cmd_ap->AddRegexCommand("^$", "breakpoint list --full") && 349 break_regex_cmd_ap->AddRegexCommand("^(-.*)$", "breakpoint set %1") && 350 break_regex_cmd_ap->AddRegexCommand("^(.*[^[:space:]])`(.*[^[:space:]])[[:space:]]*$", "breakpoint set --name '%2' --shlib '%1'") && 351 break_regex_cmd_ap->AddRegexCommand("^(.*[^[:space:]])[[:space:]]*$", "breakpoint set --name '%1'")) 352 { 353 CommandObjectSP break_regex_cmd_sp(break_regex_cmd_ap.release()); 354 m_command_dict[break_regex_cmd_sp->GetCommandName ()] = break_regex_cmd_sp; 355 } 356 } 357 358 std::auto_ptr<CommandObjectRegexCommand> 359 down_regex_cmd_ap(new CommandObjectRegexCommand (*this, 360 "_regexp-down", 361 "Go down \"n\" frames in the stack (1 frame by default).", 362 "_regexp-down [n]", 2)); 363 if (down_regex_cmd_ap.get()) 364 { 365 if (down_regex_cmd_ap->AddRegexCommand("^$", "frame select -r -1") && 366 down_regex_cmd_ap->AddRegexCommand("^([0-9]+)$", "frame select -r -%1")) 367 { 368 CommandObjectSP down_regex_cmd_sp(down_regex_cmd_ap.release()); 369 m_command_dict[down_regex_cmd_sp->GetCommandName ()] = down_regex_cmd_sp; 370 } 371 } 372 373 std::auto_ptr<CommandObjectRegexCommand> 374 up_regex_cmd_ap(new CommandObjectRegexCommand (*this, 375 "_regexp-up", 376 "Go up \"n\" frames in the stack (1 frame by default).", 377 "_regexp-up [n]", 2)); 378 if (up_regex_cmd_ap.get()) 379 { 380 if (up_regex_cmd_ap->AddRegexCommand("^$", "frame select -r 1") && 381 up_regex_cmd_ap->AddRegexCommand("^([0-9]+)$", "frame select -r %1")) 382 { 383 CommandObjectSP up_regex_cmd_sp(up_regex_cmd_ap.release()); 384 m_command_dict[up_regex_cmd_sp->GetCommandName ()] = up_regex_cmd_sp; 385 } 386 } 387 388 std::auto_ptr<CommandObjectRegexCommand> 389 display_regex_cmd_ap(new CommandObjectRegexCommand (*this, 390 "_regexp-display", 391 "Add an expression evaluation stop-hook.", 392 "_regexp-display expression", 2)); 393 if (display_regex_cmd_ap.get()) 394 { 395 if (display_regex_cmd_ap->AddRegexCommand("^(.+)$", "target stop-hook add -o \"expr -- %1\"")) 396 { 397 CommandObjectSP display_regex_cmd_sp(display_regex_cmd_ap.release()); 398 m_command_dict[display_regex_cmd_sp->GetCommandName ()] = display_regex_cmd_sp; 399 } 400 } 401 402 std::auto_ptr<CommandObjectRegexCommand> 403 undisplay_regex_cmd_ap(new CommandObjectRegexCommand (*this, 404 "_regexp-undisplay", 405 "Remove an expression evaluation stop-hook.", 406 "_regexp-undisplay stop-hook-number", 2)); 407 if (undisplay_regex_cmd_ap.get()) 408 { 409 if (undisplay_regex_cmd_ap->AddRegexCommand("^([0-9]+)$", "target stop-hook delete %1")) 410 { 411 CommandObjectSP undisplay_regex_cmd_sp(undisplay_regex_cmd_ap.release()); 412 m_command_dict[undisplay_regex_cmd_sp->GetCommandName ()] = undisplay_regex_cmd_sp; 413 } 414 } 415 416 } 417 418 int 419 CommandInterpreter::GetCommandNamesMatchingPartialString (const char *cmd_str, bool include_aliases, 420 StringList &matches) 421 { 422 CommandObject::AddNamesMatchingPartialString (m_command_dict, cmd_str, matches); 423 424 if (include_aliases) 425 { 426 CommandObject::AddNamesMatchingPartialString (m_alias_dict, cmd_str, matches); 427 } 428 429 return matches.GetSize(); 430 } 431 432 CommandObjectSP 433 CommandInterpreter::GetCommandSP (const char *cmd_cstr, bool include_aliases, bool exact, StringList *matches) 434 { 435 CommandObject::CommandMap::iterator pos; 436 CommandObjectSP ret_val; 437 438 std::string cmd(cmd_cstr); 439 440 if (HasCommands()) 441 { 442 pos = m_command_dict.find(cmd); 443 if (pos != m_command_dict.end()) 444 ret_val = pos->second; 445 } 446 447 if (include_aliases && HasAliases()) 448 { 449 pos = m_alias_dict.find(cmd); 450 if (pos != m_alias_dict.end()) 451 ret_val = pos->second; 452 } 453 454 if (HasUserCommands()) 455 { 456 pos = m_user_dict.find(cmd); 457 if (pos != m_user_dict.end()) 458 ret_val = pos->second; 459 } 460 461 if (!exact && !ret_val) 462 { 463 // We will only get into here if we didn't find any exact matches. 464 465 CommandObjectSP user_match_sp, alias_match_sp, real_match_sp; 466 467 StringList local_matches; 468 if (matches == NULL) 469 matches = &local_matches; 470 471 unsigned int num_cmd_matches = 0; 472 unsigned int num_alias_matches = 0; 473 unsigned int num_user_matches = 0; 474 475 // Look through the command dictionaries one by one, and if we get only one match from any of 476 // them in toto, then return that, otherwise return an empty CommandObjectSP and the list of matches. 477 478 if (HasCommands()) 479 { 480 num_cmd_matches = CommandObject::AddNamesMatchingPartialString (m_command_dict, cmd_cstr, *matches); 481 } 482 483 if (num_cmd_matches == 1) 484 { 485 cmd.assign(matches->GetStringAtIndex(0)); 486 pos = m_command_dict.find(cmd); 487 if (pos != m_command_dict.end()) 488 real_match_sp = pos->second; 489 } 490 491 if (include_aliases && HasAliases()) 492 { 493 num_alias_matches = CommandObject::AddNamesMatchingPartialString (m_alias_dict, cmd_cstr, *matches); 494 495 } 496 497 if (num_alias_matches == 1) 498 { 499 cmd.assign(matches->GetStringAtIndex (num_cmd_matches)); 500 pos = m_alias_dict.find(cmd); 501 if (pos != m_alias_dict.end()) 502 alias_match_sp = pos->second; 503 } 504 505 if (HasUserCommands()) 506 { 507 num_user_matches = CommandObject::AddNamesMatchingPartialString (m_user_dict, cmd_cstr, *matches); 508 } 509 510 if (num_user_matches == 1) 511 { 512 cmd.assign (matches->GetStringAtIndex (num_cmd_matches + num_alias_matches)); 513 514 pos = m_user_dict.find (cmd); 515 if (pos != m_user_dict.end()) 516 user_match_sp = pos->second; 517 } 518 519 // If we got exactly one match, return that, otherwise return the match list. 520 521 if (num_user_matches + num_cmd_matches + num_alias_matches == 1) 522 { 523 if (num_cmd_matches) 524 return real_match_sp; 525 else if (num_alias_matches) 526 return alias_match_sp; 527 else 528 return user_match_sp; 529 } 530 } 531 else if (matches && ret_val) 532 { 533 matches->AppendString (cmd_cstr); 534 } 535 536 537 return ret_val; 538 } 539 540 bool 541 CommandInterpreter::AddCommand (const char *name, const lldb::CommandObjectSP &cmd_sp, bool can_replace) 542 { 543 if (name && name[0]) 544 { 545 std::string name_sstr(name); 546 if (!can_replace) 547 { 548 if (m_command_dict.find (name_sstr) != m_command_dict.end()) 549 return false; 550 } 551 m_command_dict[name_sstr] = cmd_sp; 552 return true; 553 } 554 return false; 555 } 556 557 bool 558 CommandInterpreter::AddUserCommand (std::string name, 559 const lldb::CommandObjectSP &cmd_sp, 560 bool can_replace) 561 { 562 if (!name.empty()) 563 { 564 565 const char* name_cstr = name.c_str(); 566 567 // do not allow replacement of internal commands 568 if (CommandExists(name_cstr)) 569 return false; 570 571 if (can_replace == false && UserCommandExists(name_cstr)) 572 return false; 573 574 m_user_dict[name] = cmd_sp; 575 return true; 576 } 577 return false; 578 } 579 580 CommandObjectSP 581 CommandInterpreter::GetCommandSPExact (const char *cmd_cstr, bool include_aliases) 582 { 583 Args cmd_words (cmd_cstr); // Break up the command string into words, in case it's a multi-word command. 584 CommandObjectSP ret_val; // Possibly empty return value. 585 586 if (cmd_cstr == NULL) 587 return ret_val; 588 589 if (cmd_words.GetArgumentCount() == 1) 590 return GetCommandSP(cmd_cstr, include_aliases, true, NULL); 591 else 592 { 593 // We have a multi-word command (seemingly), so we need to do more work. 594 // First, get the cmd_obj_sp for the first word in the command. 595 CommandObjectSP cmd_obj_sp = GetCommandSP (cmd_words.GetArgumentAtIndex (0), include_aliases, true, NULL); 596 if (cmd_obj_sp.get() != NULL) 597 { 598 // Loop through the rest of the words in the command (everything passed in was supposed to be part of a 599 // command name), and find the appropriate sub-command SP for each command word.... 600 size_t end = cmd_words.GetArgumentCount(); 601 for (size_t j= 1; j < end; ++j) 602 { 603 if (cmd_obj_sp->IsMultiwordObject()) 604 { 605 cmd_obj_sp = ((CommandObjectMultiword *) cmd_obj_sp.get())->GetSubcommandSP 606 (cmd_words.GetArgumentAtIndex (j)); 607 if (cmd_obj_sp.get() == NULL) 608 // The sub-command name was invalid. Fail and return the empty 'ret_val'. 609 return ret_val; 610 } 611 else 612 // We have more words in the command name, but we don't have a multiword object. Fail and return 613 // empty 'ret_val'. 614 return ret_val; 615 } 616 // We successfully looped through all the command words and got valid command objects for them. Assign the 617 // last object retrieved to 'ret_val'. 618 ret_val = cmd_obj_sp; 619 } 620 } 621 return ret_val; 622 } 623 624 CommandObject * 625 CommandInterpreter::GetCommandObjectExact (const char *cmd_cstr, bool include_aliases) 626 { 627 return GetCommandSPExact (cmd_cstr, include_aliases).get(); 628 } 629 630 CommandObject * 631 CommandInterpreter::GetCommandObject (const char *cmd_cstr, StringList *matches) 632 { 633 CommandObject *command_obj = GetCommandSP (cmd_cstr, false, true, matches).get(); 634 635 // If we didn't find an exact match to the command string in the commands, look in 636 // the aliases. 637 638 if (command_obj == NULL) 639 { 640 command_obj = GetCommandSP (cmd_cstr, true, true, matches).get(); 641 } 642 643 // Finally, if there wasn't an exact match among the aliases, look for an inexact match 644 // in both the commands and the aliases. 645 646 if (command_obj == NULL) 647 command_obj = GetCommandSP(cmd_cstr, true, false, matches).get(); 648 649 return command_obj; 650 } 651 652 bool 653 CommandInterpreter::CommandExists (const char *cmd) 654 { 655 return m_command_dict.find(cmd) != m_command_dict.end(); 656 } 657 658 bool 659 CommandInterpreter::ProcessAliasOptionsArgs (lldb::CommandObjectSP &cmd_obj_sp, 660 const char *options_args, 661 OptionArgVectorSP &option_arg_vector_sp) 662 { 663 bool success = true; 664 OptionArgVector *option_arg_vector = option_arg_vector_sp.get(); 665 666 if (!options_args || (strlen (options_args) < 1)) 667 return true; 668 669 std::string options_string (options_args); 670 Args args (options_args); 671 CommandReturnObject result; 672 // Check to see if the command being aliased can take any command options. 673 Options *options = cmd_obj_sp->GetOptions (); 674 if (options) 675 { 676 // See if any options were specified as part of the alias; if so, handle them appropriately. 677 options->NotifyOptionParsingStarting (); 678 args.Unshift ("dummy_arg"); 679 args.ParseAliasOptions (*options, result, option_arg_vector, options_string); 680 args.Shift (); 681 if (result.Succeeded()) 682 options->VerifyPartialOptions (result); 683 if (!result.Succeeded() && result.GetStatus() != lldb::eReturnStatusStarted) 684 { 685 result.AppendError ("Unable to create requested alias.\n"); 686 return false; 687 } 688 } 689 690 if (!options_string.empty()) 691 { 692 if (cmd_obj_sp->WantsRawCommandString ()) 693 option_arg_vector->push_back (OptionArgPair ("<argument>", 694 OptionArgValue (-1, 695 options_string))); 696 else 697 { 698 int argc = args.GetArgumentCount(); 699 for (size_t i = 0; i < argc; ++i) 700 if (strcmp (args.GetArgumentAtIndex (i), "") != 0) 701 option_arg_vector->push_back 702 (OptionArgPair ("<argument>", 703 OptionArgValue (-1, 704 std::string (args.GetArgumentAtIndex (i))))); 705 } 706 } 707 708 return success; 709 } 710 711 bool 712 CommandInterpreter::AliasExists (const char *cmd) 713 { 714 return m_alias_dict.find(cmd) != m_alias_dict.end(); 715 } 716 717 bool 718 CommandInterpreter::UserCommandExists (const char *cmd) 719 { 720 return m_user_dict.find(cmd) != m_user_dict.end(); 721 } 722 723 void 724 CommandInterpreter::AddAlias (const char *alias_name, CommandObjectSP& command_obj_sp) 725 { 726 command_obj_sp->SetIsAlias (true); 727 m_alias_dict[alias_name] = command_obj_sp; 728 } 729 730 bool 731 CommandInterpreter::RemoveAlias (const char *alias_name) 732 { 733 CommandObject::CommandMap::iterator pos = m_alias_dict.find(alias_name); 734 if (pos != m_alias_dict.end()) 735 { 736 m_alias_dict.erase(pos); 737 return true; 738 } 739 return false; 740 } 741 bool 742 CommandInterpreter::RemoveUser (const char *alias_name) 743 { 744 CommandObject::CommandMap::iterator pos = m_user_dict.find(alias_name); 745 if (pos != m_user_dict.end()) 746 { 747 m_user_dict.erase(pos); 748 return true; 749 } 750 return false; 751 } 752 753 void 754 CommandInterpreter::GetAliasHelp (const char *alias_name, const char *command_name, StreamString &help_string) 755 { 756 help_string.Printf ("'%s", command_name); 757 OptionArgVectorSP option_arg_vector_sp = GetAliasOptions (alias_name); 758 759 if (option_arg_vector_sp) 760 { 761 OptionArgVector *options = option_arg_vector_sp.get(); 762 for (int i = 0; i < options->size(); ++i) 763 { 764 OptionArgPair cur_option = (*options)[i]; 765 std::string opt = cur_option.first; 766 OptionArgValue value_pair = cur_option.second; 767 std::string value = value_pair.second; 768 if (opt.compare("<argument>") == 0) 769 { 770 help_string.Printf (" %s", value.c_str()); 771 } 772 else 773 { 774 help_string.Printf (" %s", opt.c_str()); 775 if ((value.compare ("<no-argument>") != 0) 776 && (value.compare ("<need-argument") != 0)) 777 { 778 help_string.Printf (" %s", value.c_str()); 779 } 780 } 781 } 782 } 783 784 help_string.Printf ("'"); 785 } 786 787 size_t 788 CommandInterpreter::FindLongestCommandWord (CommandObject::CommandMap &dict) 789 { 790 CommandObject::CommandMap::const_iterator pos; 791 CommandObject::CommandMap::const_iterator end = dict.end(); 792 size_t max_len = 0; 793 794 for (pos = dict.begin(); pos != end; ++pos) 795 { 796 size_t len = pos->first.size(); 797 if (max_len < len) 798 max_len = len; 799 } 800 return max_len; 801 } 802 803 void 804 CommandInterpreter::GetHelp (CommandReturnObject &result, 805 uint32_t cmd_types) 806 { 807 CommandObject::CommandMap::const_iterator pos; 808 uint32_t max_len = FindLongestCommandWord (m_command_dict); 809 810 if ( (cmd_types & eCommandTypesBuiltin) == eCommandTypesBuiltin ) 811 { 812 813 result.AppendMessage("The following is a list of built-in, permanent debugger commands:"); 814 result.AppendMessage(""); 815 816 for (pos = m_command_dict.begin(); pos != m_command_dict.end(); ++pos) 817 { 818 OutputFormattedHelpText (result.GetOutputStream(), pos->first.c_str(), "--", pos->second->GetHelp(), 819 max_len); 820 } 821 result.AppendMessage(""); 822 823 } 824 825 if (!m_alias_dict.empty() && ( (cmd_types & eCommandTypesAliases) == eCommandTypesAliases )) 826 { 827 result.AppendMessage("The following is a list of your current command abbreviations " 828 "(see 'help command alias' for more info):"); 829 result.AppendMessage(""); 830 max_len = FindLongestCommandWord (m_alias_dict); 831 832 for (pos = m_alias_dict.begin(); pos != m_alias_dict.end(); ++pos) 833 { 834 StreamString sstr; 835 StreamString translation_and_help; 836 std::string entry_name = pos->first; 837 std::string second_entry = pos->second.get()->GetCommandName(); 838 GetAliasHelp (pos->first.c_str(), pos->second->GetCommandName(), sstr); 839 840 translation_and_help.Printf ("(%s) %s", sstr.GetData(), pos->second->GetHelp()); 841 OutputFormattedHelpText (result.GetOutputStream(), pos->first.c_str(), "--", 842 translation_and_help.GetData(), max_len); 843 } 844 result.AppendMessage(""); 845 } 846 847 if (!m_user_dict.empty() && ( (cmd_types & eCommandTypesUserDef) == eCommandTypesUserDef )) 848 { 849 result.AppendMessage ("The following is a list of your current user-defined commands:"); 850 result.AppendMessage(""); 851 max_len = FindLongestCommandWord (m_user_dict); 852 for (pos = m_user_dict.begin(); pos != m_user_dict.end(); ++pos) 853 { 854 OutputFormattedHelpText (result.GetOutputStream(), pos->first.c_str(), "--", pos->second->GetHelp(), 855 max_len); 856 } 857 result.AppendMessage(""); 858 } 859 860 result.AppendMessage("For more information on any particular command, try 'help <command-name>'."); 861 } 862 863 CommandObject * 864 CommandInterpreter::GetCommandObjectForCommand (std::string &command_string) 865 { 866 // This function finds the final, lowest-level, alias-resolved command object whose 'Execute' function will 867 // eventually be invoked by the given command line. 868 869 CommandObject *cmd_obj = NULL; 870 std::string white_space (" \t\v"); 871 size_t start = command_string.find_first_not_of (white_space); 872 size_t end = 0; 873 bool done = false; 874 while (!done) 875 { 876 if (start != std::string::npos) 877 { 878 // Get the next word from command_string. 879 end = command_string.find_first_of (white_space, start); 880 if (end == std::string::npos) 881 end = command_string.size(); 882 std::string cmd_word = command_string.substr (start, end - start); 883 884 if (cmd_obj == NULL) 885 // Since cmd_obj is NULL we are on our first time through this loop. Check to see if cmd_word is a valid 886 // command or alias. 887 cmd_obj = GetCommandObject (cmd_word.c_str()); 888 else if (cmd_obj->IsMultiwordObject ()) 889 { 890 // Our current object is a multi-word object; see if the cmd_word is a valid sub-command for our object. 891 CommandObject *sub_cmd_obj = 892 ((CommandObjectMultiword *) cmd_obj)->GetSubcommandObject (cmd_word.c_str()); 893 if (sub_cmd_obj) 894 cmd_obj = sub_cmd_obj; 895 else // cmd_word was not a valid sub-command word, so we are donee 896 done = true; 897 } 898 else 899 // We have a cmd_obj and it is not a multi-word object, so we are done. 900 done = true; 901 902 // If we didn't find a valid command object, or our command object is not a multi-word object, or 903 // we are at the end of the command_string, then we are done. Otherwise, find the start of the 904 // next word. 905 906 if (!cmd_obj || !cmd_obj->IsMultiwordObject() || end >= command_string.size()) 907 done = true; 908 else 909 start = command_string.find_first_not_of (white_space, end); 910 } 911 else 912 // Unable to find any more words. 913 done = true; 914 } 915 916 if (end == command_string.size()) 917 command_string.clear(); 918 else 919 command_string = command_string.substr(end); 920 921 return cmd_obj; 922 } 923 924 static const char *k_white_space = " \t\v"; 925 static const char *k_valid_command_chars = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789-_"; 926 static void 927 StripLeadingSpaces (std::string &s) 928 { 929 if (!s.empty()) 930 { 931 size_t pos = s.find_first_not_of (k_white_space); 932 if (pos == std::string::npos) 933 s.clear(); 934 else if (pos == 0) 935 return; 936 s.erase (0, pos); 937 } 938 } 939 940 static size_t 941 FindArgumentTerminator (const std::string &s) 942 { 943 const size_t s_len = s.size(); 944 size_t offset = 0; 945 while (offset < s_len) 946 { 947 size_t pos = s.find ("--", offset); 948 if (pos == std::string::npos) 949 break; 950 if (pos > 0) 951 { 952 if (isspace(s[pos-1])) 953 { 954 // Check if the string ends "\s--" (where \s is a space character) 955 // or if we have "\s--\s". 956 if ((pos + 2 >= s_len) || isspace(s[pos+2])) 957 { 958 return pos; 959 } 960 } 961 } 962 offset = pos + 2; 963 } 964 return std::string::npos; 965 } 966 967 static bool 968 ExtractCommand (std::string &command_string, std::string &command, std::string &suffix, char "e_char) 969 { 970 command.clear(); 971 suffix.clear(); 972 StripLeadingSpaces (command_string); 973 974 bool result = false; 975 quote_char = '\0'; 976 977 if (!command_string.empty()) 978 { 979 const char first_char = command_string[0]; 980 if (first_char == '\'' || first_char == '"') 981 { 982 quote_char = first_char; 983 const size_t end_quote_pos = command_string.find (quote_char, 1); 984 if (end_quote_pos == std::string::npos) 985 { 986 command.swap (command_string); 987 command_string.erase (); 988 } 989 else 990 { 991 command.assign (command_string, 1, end_quote_pos - 1); 992 if (end_quote_pos + 1 < command_string.size()) 993 command_string.erase (0, command_string.find_first_not_of (k_white_space, end_quote_pos + 1)); 994 else 995 command_string.erase (); 996 } 997 } 998 else 999 { 1000 const size_t first_space_pos = command_string.find_first_of (k_white_space); 1001 if (first_space_pos == std::string::npos) 1002 { 1003 command.swap (command_string); 1004 command_string.erase(); 1005 } 1006 else 1007 { 1008 command.assign (command_string, 0, first_space_pos); 1009 command_string.erase(0, command_string.find_first_not_of (k_white_space, first_space_pos)); 1010 } 1011 } 1012 result = true; 1013 } 1014 1015 1016 if (!command.empty()) 1017 { 1018 // actual commands can't start with '-' or '_' 1019 if (command[0] != '-' && command[0] != '_') 1020 { 1021 size_t pos = command.find_first_not_of(k_valid_command_chars); 1022 if (pos > 0 && pos != std::string::npos) 1023 { 1024 suffix.assign (command.begin() + pos, command.end()); 1025 command.erase (pos); 1026 } 1027 } 1028 } 1029 1030 return result; 1031 } 1032 1033 CommandObject * 1034 CommandInterpreter::BuildAliasResult (const char *alias_name, 1035 std::string &raw_input_string, 1036 std::string &alias_result, 1037 CommandReturnObject &result) 1038 { 1039 CommandObject *alias_cmd_obj = NULL; 1040 Args cmd_args (raw_input_string.c_str()); 1041 alias_cmd_obj = GetCommandObject (alias_name); 1042 StreamString result_str; 1043 1044 if (alias_cmd_obj) 1045 { 1046 std::string alias_name_str = alias_name; 1047 if ((cmd_args.GetArgumentCount() == 0) 1048 || (alias_name_str.compare (cmd_args.GetArgumentAtIndex(0)) != 0)) 1049 cmd_args.Unshift (alias_name); 1050 1051 result_str.Printf ("%s", alias_cmd_obj->GetCommandName ()); 1052 OptionArgVectorSP option_arg_vector_sp = GetAliasOptions (alias_name); 1053 1054 if (option_arg_vector_sp.get()) 1055 { 1056 OptionArgVector *option_arg_vector = option_arg_vector_sp.get(); 1057 1058 for (int i = 0; i < option_arg_vector->size(); ++i) 1059 { 1060 OptionArgPair option_pair = (*option_arg_vector)[i]; 1061 OptionArgValue value_pair = option_pair.second; 1062 int value_type = value_pair.first; 1063 std::string option = option_pair.first; 1064 std::string value = value_pair.second; 1065 if (option.compare ("<argument>") == 0) 1066 result_str.Printf (" %s", value.c_str()); 1067 else 1068 { 1069 result_str.Printf (" %s", option.c_str()); 1070 if (value_type != optional_argument) 1071 result_str.Printf (" "); 1072 if (value.compare ("<no_argument>") != 0) 1073 { 1074 int index = GetOptionArgumentPosition (value.c_str()); 1075 if (index == 0) 1076 result_str.Printf ("%s", value.c_str()); 1077 else if (index >= cmd_args.GetArgumentCount()) 1078 { 1079 1080 result.AppendErrorWithFormat 1081 ("Not enough arguments provided; you need at least %d arguments to use this alias.\n", 1082 index); 1083 result.SetStatus (eReturnStatusFailed); 1084 return alias_cmd_obj; 1085 } 1086 else 1087 { 1088 size_t strpos = raw_input_string.find (cmd_args.GetArgumentAtIndex (index)); 1089 if (strpos != std::string::npos) 1090 raw_input_string = raw_input_string.erase (strpos, 1091 strlen (cmd_args.GetArgumentAtIndex (index))); 1092 result_str.Printf ("%s", cmd_args.GetArgumentAtIndex (index)); 1093 } 1094 } 1095 } 1096 } 1097 } 1098 1099 alias_result = result_str.GetData(); 1100 } 1101 return alias_cmd_obj; 1102 } 1103 1104 Error 1105 CommandInterpreter::PreprocessCommand (std::string &command) 1106 { 1107 // The command preprocessor needs to do things to the command 1108 // line before any parsing of arguments or anything else is done. 1109 // The only current stuff that gets proprocessed is anyting enclosed 1110 // in backtick ('`') characters is evaluated as an expression and 1111 // the result of the expression must be a scalar that can be substituted 1112 // into the command. An example would be: 1113 // (lldb) memory read `$rsp + 20` 1114 Error error; // Error for any expressions that might not evaluate 1115 size_t start_backtick; 1116 size_t pos = 0; 1117 while ((start_backtick = command.find ('`', pos)) != std::string::npos) 1118 { 1119 if (start_backtick > 0 && command[start_backtick-1] == '\\') 1120 { 1121 // The backtick was preceeded by a '\' character, remove the slash 1122 // and don't treat the backtick as the start of an expression 1123 command.erase(start_backtick-1, 1); 1124 // No need to add one to start_backtick since we just deleted a char 1125 pos = start_backtick; 1126 } 1127 else 1128 { 1129 const size_t expr_content_start = start_backtick + 1; 1130 const size_t end_backtick = command.find ('`', expr_content_start); 1131 if (end_backtick == std::string::npos) 1132 return error; 1133 else if (end_backtick == expr_content_start) 1134 { 1135 // Empty expression (two backticks in a row) 1136 command.erase (start_backtick, 2); 1137 } 1138 else 1139 { 1140 std::string expr_str (command, expr_content_start, end_backtick - expr_content_start); 1141 1142 ExecutionContext exe_ctx(GetExecutionContext()); 1143 Target *target = exe_ctx.GetTargetPtr(); 1144 // Get a dummy target to allow for calculator mode while processing backticks. 1145 // This also helps break the infinite loop caused when target is null. 1146 if (!target) 1147 target = Host::GetDummyTarget(GetDebugger()).get(); 1148 if (target) 1149 { 1150 const bool coerce_to_id = false; 1151 const bool unwind_on_error = true; 1152 const bool keep_in_memory = false; 1153 ValueObjectSP expr_result_valobj_sp; 1154 ExecutionResults expr_result = target->EvaluateExpression (expr_str.c_str(), 1155 exe_ctx.GetFramePtr(), 1156 eExecutionPolicyOnlyWhenNeeded, 1157 coerce_to_id, 1158 unwind_on_error, 1159 keep_in_memory, 1160 eNoDynamicValues, 1161 expr_result_valobj_sp, 1162 0 /* no timeout */); 1163 if (expr_result == eExecutionCompleted) 1164 { 1165 Scalar scalar; 1166 if (expr_result_valobj_sp->ResolveValue (scalar)) 1167 { 1168 command.erase (start_backtick, end_backtick - start_backtick + 1); 1169 StreamString value_strm; 1170 const bool show_type = false; 1171 scalar.GetValue (&value_strm, show_type); 1172 size_t value_string_size = value_strm.GetSize(); 1173 if (value_string_size) 1174 { 1175 command.insert (start_backtick, value_strm.GetData(), value_string_size); 1176 pos = start_backtick + value_string_size; 1177 continue; 1178 } 1179 else 1180 { 1181 error.SetErrorStringWithFormat("expression value didn't result in a scalar value for the expression '%s'", expr_str.c_str()); 1182 } 1183 } 1184 else 1185 { 1186 error.SetErrorStringWithFormat("expression value didn't result in a scalar value for the expression '%s'", expr_str.c_str()); 1187 } 1188 } 1189 else 1190 { 1191 if (expr_result_valobj_sp) 1192 error = expr_result_valobj_sp->GetError(); 1193 if (error.Success()) 1194 { 1195 1196 switch (expr_result) 1197 { 1198 case eExecutionSetupError: 1199 error.SetErrorStringWithFormat("expression setup error for the expression '%s'", expr_str.c_str()); 1200 break; 1201 case eExecutionCompleted: 1202 break; 1203 case eExecutionDiscarded: 1204 error.SetErrorStringWithFormat("expression discarded for the expression '%s'", expr_str.c_str()); 1205 break; 1206 case eExecutionInterrupted: 1207 error.SetErrorStringWithFormat("expression interrupted for the expression '%s'", expr_str.c_str()); 1208 break; 1209 case eExecutionTimedOut: 1210 error.SetErrorStringWithFormat("expression timed out for the expression '%s'", expr_str.c_str()); 1211 break; 1212 } 1213 } 1214 } 1215 } 1216 } 1217 if (error.Fail()) 1218 break; 1219 } 1220 } 1221 return error; 1222 } 1223 1224 1225 bool 1226 CommandInterpreter::HandleCommand (const char *command_line, 1227 LazyBool lazy_add_to_history, 1228 CommandReturnObject &result, 1229 ExecutionContext *override_context, 1230 bool repeat_on_empty_command, 1231 bool no_context_switching) 1232 1233 { 1234 1235 bool done = false; 1236 CommandObject *cmd_obj = NULL; 1237 bool wants_raw_input = false; 1238 std::string command_string (command_line); 1239 std::string original_command_string (command_line); 1240 1241 LogSP log (lldb_private::GetLogIfAllCategoriesSet (LIBLLDB_LOG_COMMANDS)); 1242 Host::SetCrashDescriptionWithFormat ("HandleCommand(command = \"%s\")", command_line); 1243 1244 // Make a scoped cleanup object that will clear the crash description string 1245 // on exit of this function. 1246 lldb_utility::CleanUp <const char *> crash_description_cleanup(NULL, Host::SetCrashDescription); 1247 1248 if (log) 1249 log->Printf ("Processing command: %s", command_line); 1250 1251 Timer scoped_timer (__PRETTY_FUNCTION__, "Handling command: %s.", command_line); 1252 1253 if (!no_context_switching) 1254 UpdateExecutionContext (override_context); 1255 1256 // <rdar://problem/11328896> 1257 bool add_to_history; 1258 if (lazy_add_to_history == eLazyBoolCalculate) 1259 add_to_history = (m_command_source_depth == 0); 1260 else 1261 add_to_history = (lazy_add_to_history == eLazyBoolYes); 1262 1263 bool empty_command = false; 1264 bool comment_command = false; 1265 if (command_string.empty()) 1266 empty_command = true; 1267 else 1268 { 1269 const char *k_space_characters = "\t\n\v\f\r "; 1270 1271 size_t non_space = command_string.find_first_not_of (k_space_characters); 1272 // Check for empty line or comment line (lines whose first 1273 // non-space character is the comment character for this interpreter) 1274 if (non_space == std::string::npos) 1275 empty_command = true; 1276 else if (command_string[non_space] == m_comment_char) 1277 comment_command = true; 1278 else if (command_string[non_space] == m_repeat_char) 1279 { 1280 const char *history_string = FindHistoryString (command_string.c_str() + non_space); 1281 if (history_string == NULL) 1282 { 1283 result.AppendErrorWithFormat ("Could not find entry: %s in history", command_string.c_str()); 1284 result.SetStatus(eReturnStatusFailed); 1285 return false; 1286 } 1287 add_to_history = false; 1288 command_string = history_string; 1289 original_command_string = history_string; 1290 } 1291 } 1292 1293 if (empty_command) 1294 { 1295 if (repeat_on_empty_command) 1296 { 1297 if (m_command_history.empty()) 1298 { 1299 result.AppendError ("empty command"); 1300 result.SetStatus(eReturnStatusFailed); 1301 return false; 1302 } 1303 else 1304 { 1305 command_line = m_repeat_command.c_str(); 1306 command_string = command_line; 1307 original_command_string = command_line; 1308 if (m_repeat_command.empty()) 1309 { 1310 result.AppendErrorWithFormat("No auto repeat.\n"); 1311 result.SetStatus (eReturnStatusFailed); 1312 return false; 1313 } 1314 } 1315 add_to_history = false; 1316 } 1317 else 1318 { 1319 result.SetStatus (eReturnStatusSuccessFinishNoResult); 1320 return true; 1321 } 1322 } 1323 else if (comment_command) 1324 { 1325 result.SetStatus (eReturnStatusSuccessFinishNoResult); 1326 return true; 1327 } 1328 1329 1330 Error error (PreprocessCommand (command_string)); 1331 1332 if (error.Fail()) 1333 { 1334 result.AppendError (error.AsCString()); 1335 result.SetStatus(eReturnStatusFailed); 1336 return false; 1337 } 1338 // Phase 1. 1339 1340 // Before we do ANY kind of argument processing, etc. we need to figure out what the real/final command object 1341 // is for the specified command, and whether or not it wants raw input. This gets complicated by the fact that 1342 // the user could have specified an alias, and in translating the alias there may also be command options and/or 1343 // even data (including raw text strings) that need to be found and inserted into the command line as part of 1344 // the translation. So this first step is plain look-up & replacement, resulting in three things: 1). the command 1345 // object whose Execute method will actually be called; 2). a revised command string, with all substitutions & 1346 // replacements taken care of; 3). whether or not the Execute function wants raw input or not. 1347 1348 StreamString revised_command_line; 1349 size_t actual_cmd_name_len = 0; 1350 std::string next_word; 1351 StringList matches; 1352 while (!done) 1353 { 1354 char quote_char = '\0'; 1355 std::string suffix; 1356 ExtractCommand (command_string, next_word, suffix, quote_char); 1357 if (cmd_obj == NULL) 1358 { 1359 if (AliasExists (next_word.c_str())) 1360 { 1361 std::string alias_result; 1362 cmd_obj = BuildAliasResult (next_word.c_str(), command_string, alias_result, result); 1363 revised_command_line.Printf ("%s", alias_result.c_str()); 1364 if (cmd_obj) 1365 { 1366 wants_raw_input = cmd_obj->WantsRawCommandString (); 1367 actual_cmd_name_len = strlen (cmd_obj->GetCommandName()); 1368 } 1369 } 1370 else 1371 { 1372 cmd_obj = GetCommandObject (next_word.c_str(), &matches); 1373 if (cmd_obj) 1374 { 1375 actual_cmd_name_len += next_word.length(); 1376 revised_command_line.Printf ("%s", next_word.c_str()); 1377 wants_raw_input = cmd_obj->WantsRawCommandString (); 1378 } 1379 else 1380 { 1381 revised_command_line.Printf ("%s", next_word.c_str()); 1382 } 1383 } 1384 } 1385 else 1386 { 1387 if (cmd_obj->IsMultiwordObject ()) 1388 { 1389 CommandObject *sub_cmd_obj = ((CommandObjectMultiword *) cmd_obj)->GetSubcommandObject (next_word.c_str()); 1390 if (sub_cmd_obj) 1391 { 1392 actual_cmd_name_len += next_word.length() + 1; 1393 revised_command_line.Printf (" %s", next_word.c_str()); 1394 cmd_obj = sub_cmd_obj; 1395 wants_raw_input = cmd_obj->WantsRawCommandString (); 1396 } 1397 else 1398 { 1399 if (quote_char) 1400 revised_command_line.Printf (" %c%s%s%c", quote_char, next_word.c_str(), suffix.c_str(), quote_char); 1401 else 1402 revised_command_line.Printf (" %s%s", next_word.c_str(), suffix.c_str()); 1403 done = true; 1404 } 1405 } 1406 else 1407 { 1408 if (quote_char) 1409 revised_command_line.Printf (" %c%s%s%c", quote_char, next_word.c_str(), suffix.c_str(), quote_char); 1410 else 1411 revised_command_line.Printf (" %s%s", next_word.c_str(), suffix.c_str()); 1412 done = true; 1413 } 1414 } 1415 1416 if (cmd_obj == NULL) 1417 { 1418 uint32_t num_matches = matches.GetSize(); 1419 if (matches.GetSize() > 1) { 1420 std::string error_msg; 1421 error_msg.assign ("Ambiguous command '"); 1422 error_msg.append(next_word.c_str()); 1423 error_msg.append ("'."); 1424 1425 error_msg.append (" Possible matches:"); 1426 1427 for (uint32_t i = 0; i < num_matches; ++i) { 1428 error_msg.append ("\n\t"); 1429 error_msg.append (matches.GetStringAtIndex(i)); 1430 } 1431 error_msg.append ("\n"); 1432 result.AppendRawError (error_msg.c_str(), error_msg.size()); 1433 } else { 1434 // We didn't have only one match, otherwise we wouldn't get here. 1435 assert(num_matches == 0); 1436 result.AppendErrorWithFormat ("'%s' is not a valid command.\n", next_word.c_str()); 1437 } 1438 result.SetStatus (eReturnStatusFailed); 1439 return false; 1440 } 1441 1442 if (cmd_obj->IsMultiwordObject ()) 1443 { 1444 if (!suffix.empty()) 1445 { 1446 1447 result.AppendErrorWithFormat ("multi-word commands ('%s') can't have shorthand suffixes: '%s'\n", 1448 next_word.c_str(), 1449 suffix.c_str()); 1450 result.SetStatus (eReturnStatusFailed); 1451 return false; 1452 } 1453 } 1454 else 1455 { 1456 // If we found a normal command, we are done 1457 done = true; 1458 if (!suffix.empty()) 1459 { 1460 switch (suffix[0]) 1461 { 1462 case '/': 1463 // GDB format suffixes 1464 { 1465 Options *command_options = cmd_obj->GetOptions(); 1466 if (command_options && command_options->SupportsLongOption("gdb-format")) 1467 { 1468 std::string gdb_format_option ("--gdb-format="); 1469 gdb_format_option += (suffix.c_str() + 1); 1470 1471 bool inserted = false; 1472 std::string &cmd = revised_command_line.GetString(); 1473 size_t arg_terminator_idx = FindArgumentTerminator (cmd); 1474 if (arg_terminator_idx != std::string::npos) 1475 { 1476 // Insert the gdb format option before the "--" that terminates options 1477 gdb_format_option.append(1,' '); 1478 cmd.insert(arg_terminator_idx, gdb_format_option); 1479 inserted = true; 1480 } 1481 1482 if (!inserted) 1483 revised_command_line.Printf (" %s", gdb_format_option.c_str()); 1484 1485 if (wants_raw_input && FindArgumentTerminator(cmd) == std::string::npos) 1486 revised_command_line.PutCString (" --"); 1487 } 1488 else 1489 { 1490 result.AppendErrorWithFormat ("the '%s' command doesn't support the --gdb-format option\n", 1491 cmd_obj->GetCommandName()); 1492 result.SetStatus (eReturnStatusFailed); 1493 return false; 1494 } 1495 } 1496 break; 1497 1498 default: 1499 result.AppendErrorWithFormat ("unknown command shorthand suffix: '%s'\n", 1500 suffix.c_str()); 1501 result.SetStatus (eReturnStatusFailed); 1502 return false; 1503 1504 } 1505 } 1506 } 1507 if (command_string.length() == 0) 1508 done = true; 1509 1510 } 1511 1512 if (!command_string.empty()) 1513 revised_command_line.Printf (" %s", command_string.c_str()); 1514 1515 // End of Phase 1. 1516 // At this point cmd_obj should contain the CommandObject whose Execute method will be called, if the command 1517 // specified was valid; revised_command_line contains the complete command line (including command name(s)), 1518 // fully translated with all substitutions & translations taken care of (still in raw text format); and 1519 // wants_raw_input specifies whether the Execute method expects raw input or not. 1520 1521 1522 if (log) 1523 { 1524 log->Printf ("HandleCommand, cmd_obj : '%s'", cmd_obj ? cmd_obj->GetCommandName() : "<not found>"); 1525 log->Printf ("HandleCommand, revised_command_line: '%s'", revised_command_line.GetData()); 1526 log->Printf ("HandleCommand, wants_raw_input:'%s'", wants_raw_input ? "True" : "False"); 1527 } 1528 1529 // Phase 2. 1530 // Take care of things like setting up the history command & calling the appropriate Execute method on the 1531 // CommandObject, with the appropriate arguments. 1532 1533 if (cmd_obj != NULL) 1534 { 1535 if (add_to_history) 1536 { 1537 Args command_args (revised_command_line.GetData()); 1538 const char *repeat_command = cmd_obj->GetRepeatCommand(command_args, 0); 1539 if (repeat_command != NULL) 1540 m_repeat_command.assign(repeat_command); 1541 else 1542 m_repeat_command.assign(original_command_string.c_str()); 1543 1544 // Don't keep pushing the same command onto the history... 1545 if (m_command_history.empty() || m_command_history.back() != original_command_string) 1546 m_command_history.push_back (original_command_string); 1547 } 1548 1549 command_string = revised_command_line.GetData(); 1550 std::string command_name (cmd_obj->GetCommandName()); 1551 std::string remainder; 1552 if (actual_cmd_name_len < command_string.length()) 1553 remainder = command_string.substr (actual_cmd_name_len); // Note: 'actual_cmd_name_len' may be considerably shorter 1554 // than cmd_obj->GetCommandName(), because name completion 1555 // allows users to enter short versions of the names, 1556 // e.g. 'br s' for 'breakpoint set'. 1557 1558 // Remove any initial spaces 1559 std::string white_space (" \t\v"); 1560 size_t pos = remainder.find_first_not_of (white_space); 1561 if (pos != 0 && pos != std::string::npos) 1562 remainder.erase(0, pos); 1563 1564 if (log) 1565 log->Printf ("HandleCommand, command line after removing command name(s): '%s'", remainder.c_str()); 1566 1567 cmd_obj->Execute (remainder.c_str(), result); 1568 } 1569 else 1570 { 1571 // We didn't find the first command object, so complete the first argument. 1572 Args command_args (revised_command_line.GetData()); 1573 StringList matches; 1574 int num_matches; 1575 int cursor_index = 0; 1576 int cursor_char_position = strlen (command_args.GetArgumentAtIndex(0)); 1577 bool word_complete; 1578 num_matches = HandleCompletionMatches (command_args, 1579 cursor_index, 1580 cursor_char_position, 1581 0, 1582 -1, 1583 word_complete, 1584 matches); 1585 1586 if (num_matches > 0) 1587 { 1588 std::string error_msg; 1589 error_msg.assign ("ambiguous command '"); 1590 error_msg.append(command_args.GetArgumentAtIndex(0)); 1591 error_msg.append ("'."); 1592 1593 error_msg.append (" Possible completions:"); 1594 for (int i = 0; i < num_matches; i++) 1595 { 1596 error_msg.append ("\n\t"); 1597 error_msg.append (matches.GetStringAtIndex (i)); 1598 } 1599 error_msg.append ("\n"); 1600 result.AppendRawError (error_msg.c_str(), error_msg.size()); 1601 } 1602 else 1603 result.AppendErrorWithFormat ("Unrecognized command '%s'.\n", command_args.GetArgumentAtIndex (0)); 1604 1605 result.SetStatus (eReturnStatusFailed); 1606 } 1607 1608 if (log) 1609 log->Printf ("HandleCommand, command %s", (result.Succeeded() ? "succeeded" : "did not succeed")); 1610 1611 return result.Succeeded(); 1612 } 1613 1614 int 1615 CommandInterpreter::HandleCompletionMatches (Args &parsed_line, 1616 int &cursor_index, 1617 int &cursor_char_position, 1618 int match_start_point, 1619 int max_return_elements, 1620 bool &word_complete, 1621 StringList &matches) 1622 { 1623 int num_command_matches = 0; 1624 bool look_for_subcommand = false; 1625 1626 // For any of the command completions a unique match will be a complete word. 1627 word_complete = true; 1628 1629 if (cursor_index == -1) 1630 { 1631 // We got nothing on the command line, so return the list of commands 1632 bool include_aliases = true; 1633 num_command_matches = GetCommandNamesMatchingPartialString ("", include_aliases, matches); 1634 } 1635 else if (cursor_index == 0) 1636 { 1637 // The cursor is in the first argument, so just do a lookup in the dictionary. 1638 CommandObject *cmd_obj = GetCommandObject (parsed_line.GetArgumentAtIndex(0), &matches); 1639 num_command_matches = matches.GetSize(); 1640 1641 if (num_command_matches == 1 1642 && cmd_obj && cmd_obj->IsMultiwordObject() 1643 && matches.GetStringAtIndex(0) != NULL 1644 && strcmp (parsed_line.GetArgumentAtIndex(0), matches.GetStringAtIndex(0)) == 0) 1645 { 1646 look_for_subcommand = true; 1647 num_command_matches = 0; 1648 matches.DeleteStringAtIndex(0); 1649 parsed_line.AppendArgument (""); 1650 cursor_index++; 1651 cursor_char_position = 0; 1652 } 1653 } 1654 1655 if (cursor_index > 0 || look_for_subcommand) 1656 { 1657 // We are completing further on into a commands arguments, so find the command and tell it 1658 // to complete the command. 1659 // First see if there is a matching initial command: 1660 CommandObject *command_object = GetCommandObject (parsed_line.GetArgumentAtIndex(0)); 1661 if (command_object == NULL) 1662 { 1663 return 0; 1664 } 1665 else 1666 { 1667 parsed_line.Shift(); 1668 cursor_index--; 1669 num_command_matches = command_object->HandleCompletion (parsed_line, 1670 cursor_index, 1671 cursor_char_position, 1672 match_start_point, 1673 max_return_elements, 1674 word_complete, 1675 matches); 1676 } 1677 } 1678 1679 return num_command_matches; 1680 1681 } 1682 1683 int 1684 CommandInterpreter::HandleCompletion (const char *current_line, 1685 const char *cursor, 1686 const char *last_char, 1687 int match_start_point, 1688 int max_return_elements, 1689 StringList &matches) 1690 { 1691 // We parse the argument up to the cursor, so the last argument in parsed_line is 1692 // the one containing the cursor, and the cursor is after the last character. 1693 1694 Args parsed_line(current_line, last_char - current_line); 1695 Args partial_parsed_line(current_line, cursor - current_line); 1696 1697 // Don't complete comments, and if the line we are completing is just the history repeat character, 1698 // substitute the appropriate history line. 1699 const char *first_arg = parsed_line.GetArgumentAtIndex(0); 1700 if (first_arg) 1701 { 1702 if (first_arg[0] == m_comment_char) 1703 return 0; 1704 else if (first_arg[0] == m_repeat_char) 1705 { 1706 const char *history_string = FindHistoryString (first_arg); 1707 if (history_string != NULL) 1708 { 1709 matches.Clear(); 1710 matches.InsertStringAtIndex(0, history_string); 1711 return -2; 1712 } 1713 else 1714 return 0; 1715 1716 } 1717 } 1718 1719 1720 int num_args = partial_parsed_line.GetArgumentCount(); 1721 int cursor_index = partial_parsed_line.GetArgumentCount() - 1; 1722 int cursor_char_position; 1723 1724 if (cursor_index == -1) 1725 cursor_char_position = 0; 1726 else 1727 cursor_char_position = strlen (partial_parsed_line.GetArgumentAtIndex(cursor_index)); 1728 1729 if (cursor > current_line && cursor[-1] == ' ') 1730 { 1731 // We are just after a space. If we are in an argument, then we will continue 1732 // parsing, but if we are between arguments, then we have to complete whatever the next 1733 // element would be. 1734 // We can distinguish the two cases because if we are in an argument (e.g. because the space is 1735 // protected by a quote) then the space will also be in the parsed argument... 1736 1737 const char *current_elem = partial_parsed_line.GetArgumentAtIndex(cursor_index); 1738 if (cursor_char_position == 0 || current_elem[cursor_char_position - 1] != ' ') 1739 { 1740 parsed_line.InsertArgumentAtIndex(cursor_index + 1, "", '"'); 1741 cursor_index++; 1742 cursor_char_position = 0; 1743 } 1744 } 1745 1746 int num_command_matches; 1747 1748 matches.Clear(); 1749 1750 // Only max_return_elements == -1 is supported at present: 1751 assert (max_return_elements == -1); 1752 bool word_complete; 1753 num_command_matches = HandleCompletionMatches (parsed_line, 1754 cursor_index, 1755 cursor_char_position, 1756 match_start_point, 1757 max_return_elements, 1758 word_complete, 1759 matches); 1760 1761 if (num_command_matches <= 0) 1762 return num_command_matches; 1763 1764 if (num_args == 0) 1765 { 1766 // If we got an empty string, insert nothing. 1767 matches.InsertStringAtIndex(0, ""); 1768 } 1769 else 1770 { 1771 // Now figure out if there is a common substring, and if so put that in element 0, otherwise 1772 // put an empty string in element 0. 1773 std::string command_partial_str; 1774 if (cursor_index >= 0) 1775 command_partial_str.assign(parsed_line.GetArgumentAtIndex(cursor_index), 1776 parsed_line.GetArgumentAtIndex(cursor_index) + cursor_char_position); 1777 1778 std::string common_prefix; 1779 matches.LongestCommonPrefix (common_prefix); 1780 int partial_name_len = command_partial_str.size(); 1781 1782 // If we matched a unique single command, add a space... 1783 // Only do this if the completer told us this was a complete word, however... 1784 if (num_command_matches == 1 && word_complete) 1785 { 1786 char quote_char = parsed_line.GetArgumentQuoteCharAtIndex(cursor_index); 1787 if (quote_char != '\0') 1788 common_prefix.push_back(quote_char); 1789 1790 common_prefix.push_back(' '); 1791 } 1792 common_prefix.erase (0, partial_name_len); 1793 matches.InsertStringAtIndex(0, common_prefix.c_str()); 1794 } 1795 return num_command_matches; 1796 } 1797 1798 1799 CommandInterpreter::~CommandInterpreter () 1800 { 1801 } 1802 1803 const char * 1804 CommandInterpreter::GetPrompt () 1805 { 1806 return m_debugger.GetPrompt(); 1807 } 1808 1809 void 1810 CommandInterpreter::SetPrompt (const char *new_prompt) 1811 { 1812 m_debugger.SetPrompt (new_prompt); 1813 } 1814 1815 size_t 1816 CommandInterpreter::GetConfirmationInputReaderCallback 1817 ( 1818 void *baton, 1819 InputReader &reader, 1820 lldb::InputReaderAction action, 1821 const char *bytes, 1822 size_t bytes_len 1823 ) 1824 { 1825 File &out_file = reader.GetDebugger().GetOutputFile(); 1826 bool *response_ptr = (bool *) baton; 1827 1828 switch (action) 1829 { 1830 case eInputReaderActivate: 1831 if (out_file.IsValid()) 1832 { 1833 if (reader.GetPrompt()) 1834 { 1835 out_file.Printf ("%s", reader.GetPrompt()); 1836 out_file.Flush (); 1837 } 1838 } 1839 break; 1840 1841 case eInputReaderDeactivate: 1842 break; 1843 1844 case eInputReaderReactivate: 1845 if (out_file.IsValid() && reader.GetPrompt()) 1846 { 1847 out_file.Printf ("%s", reader.GetPrompt()); 1848 out_file.Flush (); 1849 } 1850 break; 1851 1852 case eInputReaderAsynchronousOutputWritten: 1853 break; 1854 1855 case eInputReaderGotToken: 1856 if (bytes_len == 0) 1857 { 1858 reader.SetIsDone(true); 1859 } 1860 else if (bytes[0] == 'y' || bytes[0] == 'Y') 1861 { 1862 *response_ptr = true; 1863 reader.SetIsDone(true); 1864 } 1865 else if (bytes[0] == 'n' || bytes[0] == 'N') 1866 { 1867 *response_ptr = false; 1868 reader.SetIsDone(true); 1869 } 1870 else 1871 { 1872 if (out_file.IsValid() && !reader.IsDone() && reader.GetPrompt()) 1873 { 1874 out_file.Printf ("Please answer \"y\" or \"n\".\n%s", reader.GetPrompt()); 1875 out_file.Flush (); 1876 } 1877 } 1878 break; 1879 1880 case eInputReaderInterrupt: 1881 case eInputReaderEndOfFile: 1882 *response_ptr = false; // Assume ^C or ^D means cancel the proposed action 1883 reader.SetIsDone (true); 1884 break; 1885 1886 case eInputReaderDone: 1887 break; 1888 } 1889 1890 return bytes_len; 1891 1892 } 1893 1894 bool 1895 CommandInterpreter::Confirm (const char *message, bool default_answer) 1896 { 1897 // Check AutoConfirm first: 1898 if (m_debugger.GetAutoConfirm()) 1899 return default_answer; 1900 1901 InputReaderSP reader_sp (new InputReader(GetDebugger())); 1902 bool response = default_answer; 1903 if (reader_sp) 1904 { 1905 std::string prompt(message); 1906 prompt.append(": ["); 1907 if (default_answer) 1908 prompt.append ("Y/n] "); 1909 else 1910 prompt.append ("y/N] "); 1911 1912 Error err (reader_sp->Initialize (CommandInterpreter::GetConfirmationInputReaderCallback, 1913 &response, // baton 1914 eInputReaderGranularityLine, // token size, to pass to callback function 1915 NULL, // end token 1916 prompt.c_str(), // prompt 1917 true)); // echo input 1918 if (err.Success()) 1919 { 1920 GetDebugger().PushInputReader (reader_sp); 1921 } 1922 reader_sp->WaitOnReaderIsDone(); 1923 } 1924 return response; 1925 } 1926 1927 1928 void 1929 CommandInterpreter::CrossRegisterCommand (const char * dest_cmd, const char * object_type) 1930 { 1931 CommandObjectSP cmd_obj_sp = GetCommandSPExact (dest_cmd, true); 1932 1933 if (cmd_obj_sp) 1934 { 1935 CommandObject *cmd_obj = cmd_obj_sp.get(); 1936 if (cmd_obj->IsCrossRefObject ()) 1937 cmd_obj->AddObject (object_type); 1938 } 1939 } 1940 1941 OptionArgVectorSP 1942 CommandInterpreter::GetAliasOptions (const char *alias_name) 1943 { 1944 OptionArgMap::iterator pos; 1945 OptionArgVectorSP ret_val; 1946 1947 std::string alias (alias_name); 1948 1949 if (HasAliasOptions()) 1950 { 1951 pos = m_alias_options.find (alias); 1952 if (pos != m_alias_options.end()) 1953 ret_val = pos->second; 1954 } 1955 1956 return ret_val; 1957 } 1958 1959 void 1960 CommandInterpreter::RemoveAliasOptions (const char *alias_name) 1961 { 1962 OptionArgMap::iterator pos = m_alias_options.find(alias_name); 1963 if (pos != m_alias_options.end()) 1964 { 1965 m_alias_options.erase (pos); 1966 } 1967 } 1968 1969 void 1970 CommandInterpreter::AddOrReplaceAliasOptions (const char *alias_name, OptionArgVectorSP &option_arg_vector_sp) 1971 { 1972 m_alias_options[alias_name] = option_arg_vector_sp; 1973 } 1974 1975 bool 1976 CommandInterpreter::HasCommands () 1977 { 1978 return (!m_command_dict.empty()); 1979 } 1980 1981 bool 1982 CommandInterpreter::HasAliases () 1983 { 1984 return (!m_alias_dict.empty()); 1985 } 1986 1987 bool 1988 CommandInterpreter::HasUserCommands () 1989 { 1990 return (!m_user_dict.empty()); 1991 } 1992 1993 bool 1994 CommandInterpreter::HasAliasOptions () 1995 { 1996 return (!m_alias_options.empty()); 1997 } 1998 1999 void 2000 CommandInterpreter::BuildAliasCommandArgs (CommandObject *alias_cmd_obj, 2001 const char *alias_name, 2002 Args &cmd_args, 2003 std::string &raw_input_string, 2004 CommandReturnObject &result) 2005 { 2006 OptionArgVectorSP option_arg_vector_sp = GetAliasOptions (alias_name); 2007 2008 bool wants_raw_input = alias_cmd_obj->WantsRawCommandString(); 2009 2010 // Make sure that the alias name is the 0th element in cmd_args 2011 std::string alias_name_str = alias_name; 2012 if (alias_name_str.compare (cmd_args.GetArgumentAtIndex(0)) != 0) 2013 cmd_args.Unshift (alias_name); 2014 2015 Args new_args (alias_cmd_obj->GetCommandName()); 2016 if (new_args.GetArgumentCount() == 2) 2017 new_args.Shift(); 2018 2019 if (option_arg_vector_sp.get()) 2020 { 2021 if (wants_raw_input) 2022 { 2023 // We have a command that both has command options and takes raw input. Make *sure* it has a 2024 // " -- " in the right place in the raw_input_string. 2025 size_t pos = raw_input_string.find(" -- "); 2026 if (pos == std::string::npos) 2027 { 2028 // None found; assume it goes at the beginning of the raw input string 2029 raw_input_string.insert (0, " -- "); 2030 } 2031 } 2032 2033 OptionArgVector *option_arg_vector = option_arg_vector_sp.get(); 2034 int old_size = cmd_args.GetArgumentCount(); 2035 std::vector<bool> used (old_size + 1, false); 2036 2037 used[0] = true; 2038 2039 for (int i = 0; i < option_arg_vector->size(); ++i) 2040 { 2041 OptionArgPair option_pair = (*option_arg_vector)[i]; 2042 OptionArgValue value_pair = option_pair.second; 2043 int value_type = value_pair.first; 2044 std::string option = option_pair.first; 2045 std::string value = value_pair.second; 2046 if (option.compare ("<argument>") == 0) 2047 { 2048 if (!wants_raw_input 2049 || (value.compare("--") != 0)) // Since we inserted this above, make sure we don't insert it twice 2050 new_args.AppendArgument (value.c_str()); 2051 } 2052 else 2053 { 2054 if (value_type != optional_argument) 2055 new_args.AppendArgument (option.c_str()); 2056 if (value.compare ("<no-argument>") != 0) 2057 { 2058 int index = GetOptionArgumentPosition (value.c_str()); 2059 if (index == 0) 2060 { 2061 // value was NOT a positional argument; must be a real value 2062 if (value_type != optional_argument) 2063 new_args.AppendArgument (value.c_str()); 2064 else 2065 { 2066 char buffer[255]; 2067 ::snprintf (buffer, sizeof (buffer), "%s%s", option.c_str(), value.c_str()); 2068 new_args.AppendArgument (buffer); 2069 } 2070 2071 } 2072 else if (index >= cmd_args.GetArgumentCount()) 2073 { 2074 result.AppendErrorWithFormat 2075 ("Not enough arguments provided; you need at least %d arguments to use this alias.\n", 2076 index); 2077 result.SetStatus (eReturnStatusFailed); 2078 return; 2079 } 2080 else 2081 { 2082 // Find and remove cmd_args.GetArgumentAtIndex(i) from raw_input_string 2083 size_t strpos = raw_input_string.find (cmd_args.GetArgumentAtIndex (index)); 2084 if (strpos != std::string::npos) 2085 { 2086 raw_input_string = raw_input_string.erase (strpos, strlen (cmd_args.GetArgumentAtIndex (index))); 2087 } 2088 2089 if (value_type != optional_argument) 2090 new_args.AppendArgument (cmd_args.GetArgumentAtIndex (index)); 2091 else 2092 { 2093 char buffer[255]; 2094 ::snprintf (buffer, sizeof(buffer), "%s%s", option.c_str(), 2095 cmd_args.GetArgumentAtIndex (index)); 2096 new_args.AppendArgument (buffer); 2097 } 2098 used[index] = true; 2099 } 2100 } 2101 } 2102 } 2103 2104 for (int j = 0; j < cmd_args.GetArgumentCount(); ++j) 2105 { 2106 if (!used[j] && !wants_raw_input) 2107 new_args.AppendArgument (cmd_args.GetArgumentAtIndex (j)); 2108 } 2109 2110 cmd_args.Clear(); 2111 cmd_args.SetArguments (new_args.GetArgumentCount(), (const char **) new_args.GetArgumentVector()); 2112 } 2113 else 2114 { 2115 result.SetStatus (eReturnStatusSuccessFinishNoResult); 2116 // This alias was not created with any options; nothing further needs to be done, unless it is a command that 2117 // wants raw input, in which case we need to clear the rest of the data from cmd_args, since its in the raw 2118 // input string. 2119 if (wants_raw_input) 2120 { 2121 cmd_args.Clear(); 2122 cmd_args.SetArguments (new_args.GetArgumentCount(), (const char **) new_args.GetArgumentVector()); 2123 } 2124 return; 2125 } 2126 2127 result.SetStatus (eReturnStatusSuccessFinishNoResult); 2128 return; 2129 } 2130 2131 2132 int 2133 CommandInterpreter::GetOptionArgumentPosition (const char *in_string) 2134 { 2135 int position = 0; // Any string that isn't an argument position, i.e. '%' followed by an integer, gets a position 2136 // of zero. 2137 2138 char *cptr = (char *) in_string; 2139 2140 // Does it start with '%' 2141 if (cptr[0] == '%') 2142 { 2143 ++cptr; 2144 2145 // Is the rest of it entirely digits? 2146 if (isdigit (cptr[0])) 2147 { 2148 const char *start = cptr; 2149 while (isdigit (cptr[0])) 2150 ++cptr; 2151 2152 // We've gotten to the end of the digits; are we at the end of the string? 2153 if (cptr[0] == '\0') 2154 position = atoi (start); 2155 } 2156 } 2157 2158 return position; 2159 } 2160 2161 void 2162 CommandInterpreter::SourceInitFile (bool in_cwd, CommandReturnObject &result) 2163 { 2164 FileSpec init_file; 2165 if (in_cwd) 2166 { 2167 // In the current working directory we don't load any program specific 2168 // .lldbinit files, we only look for a "./.lldbinit" file. 2169 if (m_skip_lldbinit_files) 2170 return; 2171 2172 init_file.SetFile ("./.lldbinit", true); 2173 } 2174 else 2175 { 2176 // If we aren't looking in the current working directory we are looking 2177 // in the home directory. We will first see if there is an application 2178 // specific ".lldbinit" file whose name is "~/.lldbinit" followed by a 2179 // "-" and the name of the program. If this file doesn't exist, we fall 2180 // back to just the "~/.lldbinit" file. We also obey any requests to not 2181 // load the init files. 2182 const char *init_file_path = "~/.lldbinit"; 2183 2184 if (m_skip_app_init_files == false) 2185 { 2186 FileSpec program_file_spec (Host::GetProgramFileSpec()); 2187 const char *program_name = program_file_spec.GetFilename().AsCString(); 2188 2189 if (program_name) 2190 { 2191 char program_init_file_name[PATH_MAX]; 2192 ::snprintf (program_init_file_name, sizeof(program_init_file_name), "%s-%s", init_file_path, program_name); 2193 init_file.SetFile (program_init_file_name, true); 2194 if (!init_file.Exists()) 2195 init_file.Clear(); 2196 } 2197 } 2198 2199 if (!init_file && !m_skip_lldbinit_files) 2200 init_file.SetFile (init_file_path, true); 2201 } 2202 2203 // If the file exists, tell HandleCommand to 'source' it; this will do the actual broadcasting 2204 // of the commands back to any appropriate listener (see CommandObjectSource::Execute for more details). 2205 2206 if (init_file.Exists()) 2207 { 2208 ExecutionContext *exe_ctx = NULL; // We don't have any context yet. 2209 bool stop_on_continue = true; 2210 bool stop_on_error = false; 2211 bool echo_commands = false; 2212 bool print_results = false; 2213 2214 HandleCommandsFromFile (init_file, exe_ctx, stop_on_continue, stop_on_error, echo_commands, print_results, eLazyBoolNo, result); 2215 } 2216 else 2217 { 2218 // nothing to be done if the file doesn't exist 2219 result.SetStatus(eReturnStatusSuccessFinishNoResult); 2220 } 2221 } 2222 2223 PlatformSP 2224 CommandInterpreter::GetPlatform (bool prefer_target_platform) 2225 { 2226 PlatformSP platform_sp; 2227 if (prefer_target_platform) 2228 { 2229 ExecutionContext exe_ctx(GetExecutionContext()); 2230 Target *target = exe_ctx.GetTargetPtr(); 2231 if (target) 2232 platform_sp = target->GetPlatform(); 2233 } 2234 2235 if (!platform_sp) 2236 platform_sp = m_debugger.GetPlatformList().GetSelectedPlatform(); 2237 return platform_sp; 2238 } 2239 2240 void 2241 CommandInterpreter::HandleCommands (const StringList &commands, 2242 ExecutionContext *override_context, 2243 bool stop_on_continue, 2244 bool stop_on_error, 2245 bool echo_commands, 2246 bool print_results, 2247 LazyBool add_to_history, 2248 CommandReturnObject &result) 2249 { 2250 size_t num_lines = commands.GetSize(); 2251 2252 // If we are going to continue past a "continue" then we need to run the commands synchronously. 2253 // Make sure you reset this value anywhere you return from the function. 2254 2255 bool old_async_execution = m_debugger.GetAsyncExecution(); 2256 2257 // If we've been given an execution context, set it at the start, but don't keep resetting it or we will 2258 // cause series of commands that change the context, then do an operation that relies on that context to fail. 2259 2260 if (override_context != NULL) 2261 UpdateExecutionContext (override_context); 2262 2263 if (!stop_on_continue) 2264 { 2265 m_debugger.SetAsyncExecution (false); 2266 } 2267 2268 for (int idx = 0; idx < num_lines; idx++) 2269 { 2270 const char *cmd = commands.GetStringAtIndex(idx); 2271 if (cmd[0] == '\0') 2272 continue; 2273 2274 if (echo_commands) 2275 { 2276 result.AppendMessageWithFormat ("%s %s\n", 2277 GetPrompt(), 2278 cmd); 2279 } 2280 2281 CommandReturnObject tmp_result; 2282 // If override_context is not NULL, pass no_context_switching = true for 2283 // HandleCommand() since we updated our context already. 2284 bool success = HandleCommand(cmd, add_to_history, tmp_result, 2285 NULL, /* override_context */ 2286 true, /* repeat_on_empty_command */ 2287 override_context != NULL /* no_context_switching */); 2288 2289 if (print_results) 2290 { 2291 if (tmp_result.Succeeded()) 2292 result.AppendMessageWithFormat("%s", tmp_result.GetOutputData()); 2293 } 2294 2295 if (!success || !tmp_result.Succeeded()) 2296 { 2297 const char *error_msg = tmp_result.GetErrorData(); 2298 if (error_msg == NULL || error_msg[0] == '\0') 2299 error_msg = "<unknown error>.\n"; 2300 if (stop_on_error) 2301 { 2302 result.AppendErrorWithFormat("Aborting reading of commands after command #%d: '%s' failed with %s", 2303 idx, cmd, error_msg); 2304 result.SetStatus (eReturnStatusFailed); 2305 m_debugger.SetAsyncExecution (old_async_execution); 2306 return; 2307 } 2308 else if (print_results) 2309 { 2310 result.AppendMessageWithFormat ("Command #%d '%s' failed with %s", 2311 idx + 1, 2312 cmd, 2313 error_msg); 2314 } 2315 } 2316 2317 if (result.GetImmediateOutputStream()) 2318 result.GetImmediateOutputStream()->Flush(); 2319 2320 if (result.GetImmediateErrorStream()) 2321 result.GetImmediateErrorStream()->Flush(); 2322 2323 // N.B. Can't depend on DidChangeProcessState, because the state coming into the command execution 2324 // could be running (for instance in Breakpoint Commands. 2325 // So we check the return value to see if it is has running in it. 2326 if ((tmp_result.GetStatus() == eReturnStatusSuccessContinuingNoResult) 2327 || (tmp_result.GetStatus() == eReturnStatusSuccessContinuingResult)) 2328 { 2329 if (stop_on_continue) 2330 { 2331 // If we caused the target to proceed, and we're going to stop in that case, set the 2332 // status in our real result before returning. This is an error if the continue was not the 2333 // last command in the set of commands to be run. 2334 if (idx != num_lines - 1) 2335 result.AppendErrorWithFormat("Aborting reading of commands after command #%d: '%s' continued the target.\n", 2336 idx + 1, cmd); 2337 else 2338 result.AppendMessageWithFormat ("Command #%d '%s' continued the target.\n", idx + 1, cmd); 2339 2340 result.SetStatus(tmp_result.GetStatus()); 2341 m_debugger.SetAsyncExecution (old_async_execution); 2342 2343 return; 2344 } 2345 } 2346 2347 } 2348 2349 result.SetStatus (eReturnStatusSuccessFinishResult); 2350 m_debugger.SetAsyncExecution (old_async_execution); 2351 2352 return; 2353 } 2354 2355 void 2356 CommandInterpreter::HandleCommandsFromFile (FileSpec &cmd_file, 2357 ExecutionContext *context, 2358 bool stop_on_continue, 2359 bool stop_on_error, 2360 bool echo_command, 2361 bool print_result, 2362 LazyBool add_to_history, 2363 CommandReturnObject &result) 2364 { 2365 if (cmd_file.Exists()) 2366 { 2367 bool success; 2368 StringList commands; 2369 success = commands.ReadFileLines(cmd_file); 2370 if (!success) 2371 { 2372 result.AppendErrorWithFormat ("Error reading commands from file: %s.\n", cmd_file.GetFilename().AsCString()); 2373 result.SetStatus (eReturnStatusFailed); 2374 return; 2375 } 2376 m_command_source_depth++; 2377 HandleCommands (commands, context, stop_on_continue, stop_on_error, echo_command, print_result, add_to_history, result); 2378 m_command_source_depth--; 2379 } 2380 else 2381 { 2382 result.AppendErrorWithFormat ("Error reading commands from file %s - file not found.\n", 2383 cmd_file.GetFilename().AsCString()); 2384 result.SetStatus (eReturnStatusFailed); 2385 return; 2386 } 2387 } 2388 2389 ScriptInterpreter * 2390 CommandInterpreter::GetScriptInterpreter () 2391 { 2392 // <rdar://problem/11751427> 2393 // we need to protect the initialization of the script interpreter 2394 // otherwise we could end up with two threads both trying to create 2395 // their instance of it, and for some languages (e.g. Python) 2396 // this is a bulletproof recipe for disaster! 2397 // this needs to be a function-level static because multiple Debugger instances living in the same process 2398 // still need to be isolated and not try to initialize Python concurrently 2399 static Mutex g_interpreter_mutex(Mutex::eMutexTypeRecursive); 2400 Mutex::Locker interpreter_lock(g_interpreter_mutex); 2401 2402 if (m_script_interpreter_ap.get() != NULL) 2403 return m_script_interpreter_ap.get(); 2404 2405 lldb::ScriptLanguage script_lang = GetDebugger().GetScriptLanguage(); 2406 switch (script_lang) 2407 { 2408 case eScriptLanguagePython: 2409 #ifndef LLDB_DISABLE_PYTHON 2410 m_script_interpreter_ap.reset (new ScriptInterpreterPython (*this)); 2411 break; 2412 #else 2413 // Fall through to the None case when python is disabled 2414 #endif 2415 case eScriptLanguageNone: 2416 m_script_interpreter_ap.reset (new ScriptInterpreterNone (*this)); 2417 break; 2418 default: 2419 break; 2420 }; 2421 2422 return m_script_interpreter_ap.get(); 2423 } 2424 2425 2426 2427 bool 2428 CommandInterpreter::GetSynchronous () 2429 { 2430 return m_synchronous_execution; 2431 } 2432 2433 void 2434 CommandInterpreter::SetSynchronous (bool value) 2435 { 2436 m_synchronous_execution = value; 2437 } 2438 2439 void 2440 CommandInterpreter::OutputFormattedHelpText (Stream &strm, 2441 const char *word_text, 2442 const char *separator, 2443 const char *help_text, 2444 uint32_t max_word_len) 2445 { 2446 const uint32_t max_columns = m_debugger.GetTerminalWidth(); 2447 2448 int indent_size = max_word_len + strlen (separator) + 2; 2449 2450 strm.IndentMore (indent_size); 2451 2452 StreamString text_strm; 2453 text_strm.Printf ("%-*s %s %s", max_word_len, word_text, separator, help_text); 2454 2455 size_t len = text_strm.GetSize(); 2456 const char *text = text_strm.GetData(); 2457 if (text[len - 1] == '\n') 2458 { 2459 text_strm.EOL(); 2460 len = text_strm.GetSize(); 2461 } 2462 2463 if (len < max_columns) 2464 { 2465 // Output it as a single line. 2466 strm.Printf ("%s", text); 2467 } 2468 else 2469 { 2470 // We need to break it up into multiple lines. 2471 bool first_line = true; 2472 int text_width; 2473 int start = 0; 2474 int end = start; 2475 int final_end = strlen (text); 2476 int sub_len; 2477 2478 while (end < final_end) 2479 { 2480 if (first_line) 2481 text_width = max_columns - 1; 2482 else 2483 text_width = max_columns - indent_size - 1; 2484 2485 // Don't start the 'text' on a space, since we're already outputting the indentation. 2486 if (!first_line) 2487 { 2488 while ((start < final_end) && (text[start] == ' ')) 2489 start++; 2490 } 2491 2492 end = start + text_width; 2493 if (end > final_end) 2494 end = final_end; 2495 else 2496 { 2497 // If we're not at the end of the text, make sure we break the line on white space. 2498 while (end > start 2499 && text[end] != ' ' && text[end] != '\t' && text[end] != '\n') 2500 end--; 2501 assert (end > 0); 2502 } 2503 2504 sub_len = end - start; 2505 if (start != 0) 2506 strm.EOL(); 2507 if (!first_line) 2508 strm.Indent(); 2509 else 2510 first_line = false; 2511 assert (start <= final_end); 2512 assert (start + sub_len <= final_end); 2513 if (sub_len > 0) 2514 strm.Write (text + start, sub_len); 2515 start = end + 1; 2516 } 2517 } 2518 strm.EOL(); 2519 strm.IndentLess(indent_size); 2520 } 2521 2522 void 2523 CommandInterpreter::OutputHelpText (Stream &strm, 2524 const char *word_text, 2525 const char *separator, 2526 const char *help_text, 2527 uint32_t max_word_len) 2528 { 2529 int indent_size = max_word_len + strlen (separator) + 2; 2530 2531 strm.IndentMore (indent_size); 2532 2533 StreamString text_strm; 2534 text_strm.Printf ("%-*s %s %s", max_word_len, word_text, separator, help_text); 2535 2536 const uint32_t max_columns = m_debugger.GetTerminalWidth(); 2537 2538 size_t len = text_strm.GetSize(); 2539 const char *text = text_strm.GetData(); 2540 2541 uint32_t chars_left = max_columns; 2542 2543 for (uint32_t i = 0; i < len; i++) 2544 { 2545 if ((text[i] == ' ' && ::strchr((text+i+1), ' ') && chars_left < ::strchr((text+i+1), ' ')-(text+i)) || text[i] == '\n') 2546 { 2547 chars_left = max_columns - indent_size; 2548 strm.EOL(); 2549 strm.Indent(); 2550 } 2551 else 2552 { 2553 strm.PutChar(text[i]); 2554 chars_left--; 2555 } 2556 2557 } 2558 2559 strm.EOL(); 2560 strm.IndentLess(indent_size); 2561 } 2562 2563 void 2564 CommandInterpreter::AproposAllSubCommands (CommandObject *cmd_obj, const char *prefix, const char *search_word, 2565 StringList &commands_found, StringList &commands_help) 2566 { 2567 CommandObject::CommandMap::const_iterator pos; 2568 CommandObject::CommandMap sub_cmd_dict = ((CommandObjectMultiword *) cmd_obj)->m_subcommand_dict; 2569 CommandObject *sub_cmd_obj; 2570 2571 for (pos = sub_cmd_dict.begin(); pos != sub_cmd_dict.end(); ++pos) 2572 { 2573 const char * command_name = pos->first.c_str(); 2574 sub_cmd_obj = pos->second.get(); 2575 StreamString complete_command_name; 2576 2577 complete_command_name.Printf ("%s %s", prefix, command_name); 2578 2579 if (sub_cmd_obj->HelpTextContainsWord (search_word)) 2580 { 2581 commands_found.AppendString (complete_command_name.GetData()); 2582 commands_help.AppendString (sub_cmd_obj->GetHelp()); 2583 } 2584 2585 if (sub_cmd_obj->IsMultiwordObject()) 2586 AproposAllSubCommands (sub_cmd_obj, complete_command_name.GetData(), search_word, commands_found, 2587 commands_help); 2588 } 2589 2590 } 2591 2592 void 2593 CommandInterpreter::FindCommandsForApropos (const char *search_word, StringList &commands_found, 2594 StringList &commands_help) 2595 { 2596 CommandObject::CommandMap::const_iterator pos; 2597 2598 for (pos = m_command_dict.begin(); pos != m_command_dict.end(); ++pos) 2599 { 2600 const char *command_name = pos->first.c_str(); 2601 CommandObject *cmd_obj = pos->second.get(); 2602 2603 if (cmd_obj->HelpTextContainsWord (search_word)) 2604 { 2605 commands_found.AppendString (command_name); 2606 commands_help.AppendString (cmd_obj->GetHelp()); 2607 } 2608 2609 if (cmd_obj->IsMultiwordObject()) 2610 AproposAllSubCommands (cmd_obj, command_name, search_word, commands_found, commands_help); 2611 2612 } 2613 } 2614 2615 2616 void 2617 CommandInterpreter::UpdateExecutionContext (ExecutionContext *override_context) 2618 { 2619 if (override_context != NULL) 2620 { 2621 m_exe_ctx_ref = *override_context; 2622 } 2623 else 2624 { 2625 const bool adopt_selected = true; 2626 m_exe_ctx_ref.SetTargetPtr (m_debugger.GetSelectedTarget().get(), adopt_selected); 2627 } 2628 } 2629 2630 void 2631 CommandInterpreter::DumpHistory (Stream &stream, uint32_t count) const 2632 { 2633 DumpHistory (stream, 0, count - 1); 2634 } 2635 2636 void 2637 CommandInterpreter::DumpHistory (Stream &stream, uint32_t start, uint32_t end) const 2638 { 2639 const size_t last_idx = std::min<size_t>(m_command_history.size(), end + 1); 2640 for (size_t i = start; i < last_idx; i++) 2641 { 2642 if (!m_command_history[i].empty()) 2643 { 2644 stream.Indent(); 2645 stream.Printf ("%4zu: %s\n", i, m_command_history[i].c_str()); 2646 } 2647 } 2648 } 2649 2650 const char * 2651 CommandInterpreter::FindHistoryString (const char *input_str) const 2652 { 2653 if (input_str[0] != m_repeat_char) 2654 return NULL; 2655 if (input_str[1] == '-') 2656 { 2657 bool success; 2658 uint32_t idx = Args::StringToUInt32 (input_str+2, 0, 0, &success); 2659 if (!success) 2660 return NULL; 2661 if (idx > m_command_history.size()) 2662 return NULL; 2663 idx = m_command_history.size() - idx; 2664 return m_command_history[idx].c_str(); 2665 2666 } 2667 else if (input_str[1] == m_repeat_char) 2668 { 2669 if (m_command_history.empty()) 2670 return NULL; 2671 else 2672 return m_command_history.back().c_str(); 2673 } 2674 else 2675 { 2676 bool success; 2677 uint32_t idx = Args::StringToUInt32 (input_str+1, 0, 0, &success); 2678 if (!success) 2679 return NULL; 2680 if (idx >= m_command_history.size()) 2681 return NULL; 2682 return m_command_history[idx].c_str(); 2683 } 2684 } 2685