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